Sha256: eb7c375a02bcb50548aff9847b0fba11663264f695e9dd7beb7234b85b0d6541
Contents?: true
Size: 1.18 KB
Versions: 4
Compression:
Stored size: 1.18 KB
Contents
# frozen_string_literal: true
module MediaWiktory::Wikipedia
module Modules
# Enumerate all global groups.
#
# 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.
#
module Globalgroups
# What pieces of information to include.
#
# @param values [Array<String>] Allowed values: "rights".
# @return [self]
def prop(*values)
values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" }
end
# @private
def _prop(value)
defined?(super) && super || ["rights"].include?(value.to_s) && merge(ggpprop: value.to_s, replace: false)
end
end
end
end
Version data entries
4 entries across 4 versions & 1 rubygems