Class: MediaWiktory::Wikipedia::Actions::Validatepassword

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

Overview

Validate a password against the wiki's password policies.

Usage:

api.validatepassword.password(value).perform # returns string with raw output
# or
api.validatepassword.password(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

#email(value) ⇒ self

Email address, for use when testing account creation.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#password(value) ⇒ self

Password to validate.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#realname(value) ⇒ self

Real name, for use when testing account creation.

Parameters:

  • value (String)

Returns:

  • (self) 


50
51
52
 
# File 'lib/mediawiktory/wikipedia/actions/validatepassword.rb', line 50

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

#user(value) ⇒ self

User name, for use when testing account creation. The named user must not exist.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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