Class: MediaWiktory::Wikipedia::Actions::Oathvalidate

Inherits:
Post
  • Object
show all
Defined in:
lib/mediawiktory/wikipedia/actions/oathvalidate.rb

Overview

Validate a two-factor authentication (OATH) token.

Usage:

api.oathvalidate.user(value).perform # returns string with raw output
# or
api.oathvalidate.user(value).response # returns output parsed and wrapped into Response object

See Base for generic explanation of working with MediaWiki actions and Response for working with action responses.

All action's parameters are documented as its public methods, see below.

Instance Method Summary collapse

Methods inherited from Post

#perform

Methods inherited from Base

#inspect, #merge, #name, #perform, #response, #to_h, #to_param, #to_url

Methods included from GlobalParams

#assert, #assertuser, #centralauthtoken, #curtimestamp, #errorformat, #errorlang, #errorsuselocal, #format, #maxage, #maxlag, #origin, #requestid, #responselanginfo, #servedby, #smaxage, #uselang

Instance Method Details

#token(value) ⇒ self

A "csrf" token retrieved from action=query&meta=tokens

Parameters:

  • value (String)

Returns:

  • (self) 


42
43
44
 
# File 'lib/mediawiktory/wikipedia/actions/oathvalidate.rb', line 42

def token(value)
  merge(token: value.to_s)
end

#totp(value) ⇒ self

Two-factor authentication (OATH) token.

Parameters:

  • value (String)

Returns:

  • (self) 


34
35
36
 
# File 'lib/mediawiktory/wikipedia/actions/oathvalidate.rb', line 34

def totp(value)
  merge(totp: value.to_s)
end

#user(value) ⇒ self

User to validate token for. Defaults to the current user.

Parameters:

  • value (String)

Returns:

  • (self) 


26
27
28
 
# File 'lib/mediawiktory/wikipedia/actions/oathvalidate.rb', line 26

def user(value)
  merge(user: value.to_s)
end