Class: MediaWiktory::Wikipedia::Actions::Unblock

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

Overview

Unblock a user.

Usage:

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

#id(value) ⇒ self

ID of the block to unblock (obtained through list=blocks). Cannot be used together with user or userid.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

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

#reason(value) ⇒ self

Reason for unblock.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#tags(*values) ⇒ self

Change tags to apply to the entry in the block log.

Parameters:

  • values (Array<String>) —

    Allowed values: "ProveIt edit", "WPCleaner", "huggle", "large plot addition".

Returns:

  • (self) 


58
59
60
 
# File 'lib/mediawiktory/wikipedia/actions/unblock.rb', line 58

def tags(*values)
  values.inject(self) { |res, val| res._tags(val) or fail ArgumentError, "Unknown value for tags: #{val}" }
end

#token(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


71
72
73
 
# File 'lib/mediawiktory/wikipedia/actions/unblock.rb', line 71

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

#user(value) ⇒ self

Username, IP address or IP address range to unblock. Cannot be used together with id or userid.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#userid(value) ⇒ self

User ID to unblock. Cannot be used together with id or user.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

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