module MediaWiktory::Wikipedia::Modules::Checkuser

Check which IP addresses are used by a given username or which usernames are used by a given IP address.

The “submodule” (MediaWiki API term) is included in action after setting some param, providing additional tweaking for this param. Example (for {MediaWiktory::Wikipedia::Actions::Query} and its submodules):

“`ruby api.query # returns Actions::Query

.prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
.limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL

“`

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

Public Instance Methods

_request(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/checkuser.rb, line 30
def _request(value)
  defined?(super) && super || ["userips", "edits", "ipusers"].include?(value.to_s) && merge(curequest: value.to_s)
end
limit(value) click to toggle source

Limit of rows.

@param value [Integer, “max”] @return [self]

# File lib/mediawiktory/wikipedia/modules/checkuser.rb, line 54
def limit(value)
  merge(culimit: value.to_s)
end
reason(value) click to toggle source

Reason to check.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/checkuser.rb, line 46
def reason(value)
  merge(cureason: value.to_s)
end
request(value) click to toggle source

Type of CheckUser request:

@param value [String] One of “userips” (Get IP address of target user), “edits” (Get changes from target IP address or range), “ipusers” (Get users from target IP address or range). @return [self]

# File lib/mediawiktory/wikipedia/modules/checkuser.rb, line 25
def request(value)
  _request(value) or fail ArgumentError, "Unknown value for request: #{value}"
end
target(value) click to toggle source

Username, IP address, or CIDR range to check.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/checkuser.rb, line 38
def target(value)
  merge(cutarget: value.to_s)
end
timecond(value) click to toggle source

Time limit of user data (like “-2 weeks” or “2 weeks ago”).

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/checkuser.rb, line 62
def timecond(value)
  merge(cutimecond: value.to_s)
end
token(value) click to toggle source

A “csrf” token retrieved from action=query&meta=tokens

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/checkuser.rb, line 78
def token(value)
  merge(cutoken: value.to_s)
end
xff(value) click to toggle source

Use XFF data instead of IP address.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/checkuser.rb, line 70
def xff(value)
  merge(cuxff: value.to_s)
end