module MediaWiktory::Wikipedia::Modules::Abuselog
Show events that were caught by one of the abuse filters.
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
@private
# File lib/mediawiktory/wikipedia/modules/abuselog.rb, line 46 def _dir(value) defined?(super) && super || ["newer", "older"].include?(value.to_s) && merge(afldir: value.to_s) end
@private
# File lib/mediawiktory/wikipedia/modules/abuselog.rb, line 75 def _filter(value) merge(aflfilter: value.to_s, replace: false) end
@private
# File lib/mediawiktory/wikipedia/modules/abuselog.rb, line 96 def _prop(value) defined?(super) && super || ["ids", "filter", "user", "ip", "title", "action", "details", "result", "timestamp", "hidden", "revid"].include?(value.to_s) && merge(aflprop: value.to_s, replace: false) end
In which direction to enumerate:
@param value [String] One of “newer” (List oldest first. Note: aflstart has to be before aflend), “older” (List newest first (default). Note: aflstart has to be later than aflend). @return [self]
# File lib/mediawiktory/wikipedia/modules/abuselog.rb, line 41 def dir(value) _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}" end
The timestamp to stop enumerating at.
@param value [Time] @return [self]
# File lib/mediawiktory/wikipedia/modules/abuselog.rb, line 33 def end(value) merge(aflend: value.iso8601) end
Show only entries that were caught by a given filter ID.
@param values [Array<String>] @return [self]
# File lib/mediawiktory/wikipedia/modules/abuselog.rb, line 70 def filter(*values) values.inject(self) { |res, val| res._filter(val) } end
The maximum amount of entries to list.
@param value [Integer, “max”] @return [self]
# File lib/mediawiktory/wikipedia/modules/abuselog.rb, line 83 def limit(value) merge(afllimit: value.to_s) end
Which properties to get.
@param values [Array<String>] Allowed values: “ids”, “filter”, “user”, “ip”, “title”, “action”, “details”, “result”, “timestamp”, “hidden”, “revid”. @return [self]
# File lib/mediawiktory/wikipedia/modules/abuselog.rb, line 91 def prop(*values) values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" } end
The timestamp to start enumerating from.
@param value [Time] @return [self]
# File lib/mediawiktory/wikipedia/modules/abuselog.rb, line 25 def start(value) merge(aflstart: value.iso8601) end
Show only entries occurring on a given page.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/abuselog.rb, line 62 def title(value) merge(afltitle: value.to_s) end
Show only entries done by a given user or IP address.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/abuselog.rb, line 54 def user(value) merge(afluser: value.to_s) end