module MediaWiktory::Wikipedia::Modules::Wikisets
Enumerate all wiki sets.
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/wikisets.rb, line 38 def _prop(value) defined?(super) && super || ["type", "wikisincluded", "wikisnotincluded"].include?(value.to_s) && merge(wsprop: value.to_s, replace: false) end
The name of the wiki set to start from.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/wikisets.rb, line 25 def from(value) merge(wsfrom: value.to_s) end
How many wiki sets to return.
@param value [Integer, “max”] @return [self]
# File lib/mediawiktory/wikipedia/modules/wikisets.rb, line 46 def limit(value) merge(wslimit: value.to_s) end
Order results by name.
@return [self]
# File lib/mediawiktory/wikipedia/modules/wikisets.rb, line 53 def orderbyname() merge(wsorderbyname: 'true') end
What pieces of information to include.
@param values [Array<String>] Allowed values: “type” (Opt-in based (includes only specified wikis) or opt-out based (includes all wikis except specified)), “wikisincluded” (The wikis that are included in this wiki set), “wikisnotincluded” (The wikis that are not included in this wiki set). @return [self]
# File lib/mediawiktory/wikipedia/modules/wikisets.rb, line 33 def prop(*values) values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" } end