mediawiktory 0.0.3 → 0.1.0

data/lib/mediawiktory/wikipedia/modules/g-wblistentityusage.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns all pages that use the given entity IDs. _Generator module: for fetching pages corresponding to request._
+    #
+    # 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 GWblistentityusage
+
+      # Only return entity IDs that used this aspect.
+      #
+      # @param values [Array<String>] Allowed values: "S", "L", "T", "X", "O".
+      # @return [self]
+      def aspect(*values)
+        values.inject(self) { |res, val| res._aspect(val) or fail ArgumentError, "Unknown value for aspect: #{val}" }
+      end
+
+      # @private
+      def _aspect(value)
+        defined?(super) && super || ["S", "L", "T", "X", "O"].include?(value.to_s) && merge(gwbeuaspect: value.to_s, replace: false)
+      end
+
+      # Entities that have been used.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def entities(*values)
+        values.inject(self) { |res, val| res._entities(val) }
+      end
+
+      # @private
+      def _entities(value)
+        merge(gwbeuentities: value.to_s, replace: false)
+      end
+
+      # How many entity usages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gwbeulimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(gwbeucontinue: value.to_s)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/modules/gadgetcategories.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns a list of gadget categories.
+    #
+    # 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 Gadgetcategories
+
+      # What gadget category information to get:
+      #
+      # @param values [Array<String>] Allowed values: "name" (Internal category name), "title" (Category title), "members" (Number of gadgets in category).
+      # @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 || ["name", "title", "members"].include?(value.to_s) && merge(gcprop: value.to_s, replace: false)
+      end
+
+      # Names of categories to retrieve.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def names(*values)
+        values.inject(self) { |res, val| res._names(val) }
+      end
+
+      # @private
+      def _names(value)
+        merge(gcnames: value.to_s, replace: false)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/modules/gadgets.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns a list of gadgets used on this wiki.
+    #
+    # 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 Gadgets
+
+      # What gadget information to get:
+      #
+      # @param values [Array<String>] Allowed values: "id" (Internal gadget ID), "metadata" (The gadget metadata), "desc" (Gadget description transformed into HTML (can be slow, use only if really needed)).
+      # @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 || ["id", "metadata", "desc"].include?(value.to_s) && merge(gaprop: value.to_s, replace: false)
+      end
+
+      # Gadgets from what categories to retrieve.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def categories(*values)
+        values.inject(self) { |res, val| res._categories(val) }
+      end
+
+      # @private
+      def _categories(value)
+        merge(gacategories: value.to_s, replace: false)
+      end
+
+      # IDs of gadgets to retrieve.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def ids(*values)
+        values.inject(self) { |res, val| res._ids(val) }
+      end
+
+      # @private
+      def _ids(value)
+        merge(gaids: value.to_s, replace: false)
+      end
+
+      # List only gadgets allowed to current user.
+      #
+      # @return [self]
+      def allowedonly()
+        merge(gaallowedonly: 'true')
+      end
+
+      # List only gadgets enabled by current user.
+      #
+      # @return [self]
+      def enabledonly()
+        merge(gaenabledonly: 'true')
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/modules/geosearch.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns pages having coordinates that are located in a certain area.
+    #
+    # 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 Geosearch
+
+      # Coordinate around which to search.
+      #
+      # @param value [String]
+      # @return [self]
+      def coord(value)
+        merge(gscoord: value.to_s)
+      end
+
+      # Title of page around which to search.
+      #
+      # @param value [String]
+      # @return [self]
+      def page(value)
+        merge(gspage: value.to_s)
+      end
+
+      # Bounding box to search in: pipe (|) separated coordinates of top left and bottom right corners.
+      #
+      # @param value [String]
+      # @return [self]
+      def bbox(value)
+        merge(gsbbox: value.to_s)
+      end
+
+      # Search radius in meters.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def radius(value)
+        merge(gsradius: value.to_s)
+      end
+
+      # Restrict search to objects no larger than this, in meters.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def maxdim(value)
+        merge(gsmaxdim: value.to_s)
+      end
+
+      # Maximum number of pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gslimit: value.to_s)
+      end
+
+      # Globe to search on (by default "earth").
+      #
+      # @param value [String] One of "earth".
+      # @return [self]
+      def globe(value)
+        _globe(value) or fail ArgumentError, "Unknown value for globe: #{value}"
+      end
+
+      # @private
+      def _globe(value)
+        defined?(super) && super || ["earth"].include?(value.to_s) && merge(gsglobe: value.to_s)
+      end
+
+      # Namespaces to search.
+      #
+      # @param values [Array<String>] Allowed values: "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303".
+      # @return [self]
+      def namespace(*values)
+        values.inject(self) { |res, val| res._namespace(val) or fail ArgumentError, "Unknown value for namespace: #{val}" }
+      end
+
+      # @private
+      def _namespace(value)
+        defined?(super) && super || ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303"].include?(value.to_s) && merge(gsnamespace: value.to_s, replace: false)
+      end
+
+      # Which additional coordinate properties to return.
+      #
+      # @param values [Array<String>] Allowed values: "type", "name", "dim", "country", "region", "globe".
+      # @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 || ["type", "name", "dim", "country", "region", "globe"].include?(value.to_s) && merge(gsprop: value.to_s, replace: false)
+      end
+
+      # Whether to return only primary coordinates ("primary"), secondary ("secondary") or both ("all").
+      #
+      # @param value [String] One of "primary", "secondary", "all".
+      # @return [self]
+      def primary(value)
+        _primary(value) or fail ArgumentError, "Unknown value for primary: #{value}"
+      end
+
+      # @private
+      def _primary(value)
+        defined?(super) && super || ["primary", "secondary", "all"].include?(value.to_s) && merge(gsprimary: value.to_s)
+      end
+
+      # Whether debug information should be returned.
+      #
+      # @return [self]
+      def debug()
+        merge(gsdebug: 'true')
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/modules/gettingstartedgetpages.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # This API is for getting a list of one or more pages related to a particular GettingStarted task.
+    #
+    # 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 Gettingstartedgetpages
+
+      # Task name, generally either "copyedit" (copy-editing suggestions) or "morelike" (pages similar to the base page/excluded title)
+      #
+      # @param value [String]
+      # @return [self]
+      def taskname(value)
+        merge(gsgptaskname: value.to_s)
+      end
+
+      # Full title of a page to exclude from the list; also used as the base title for recommendations based on a given page
+      #
+      # @param value [String]
+      # @return [self]
+      def excludedtitle(value)
+        merge(gsgpexcludedtitle: value.to_s)
+      end
+
+      # Requested count; will attempt to fetch this exact number, but may fetch fewer if no more are found after multiple attempts
+      #
+      # @param value [Integer]
+      # @return [self]
+      def count(value)
+        merge(gsgpcount: value.to_s)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/modules/globalallusers.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Enumerate all global users.
+    #
+    # 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 Globalallusers
+
+      # The user name to start enumerating from.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(agufrom: value.to_s)
+      end
+
+      # The user name to stop enumerating at.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(aguto: value.to_s)
+      end
+
+      # Search for all users that begin with this value.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(aguprefix: value.to_s)
+      end
+
+      # Direction to sort in.
+      #
+      # @param value [String] One of "ascending", "descending".
+      # @return [self]
+      def dir(value)
+        _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
+      end
+
+      # @private
+      def _dir(value)
+        defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(agudir: value.to_s)
+      end
+
+      # Limit users to given global groups.
+      #
+      # @param values [Array<String>] Allowed values: "OTRS-member", "abusefilter-helper", "apihighlimits-requestor", "captcha-exempt", "delete-global", "founder", "global-bot", "global-flow-create", "global-interface-editor", "global-ipblock-exempt", "global-rollbacker", "global-sysop", "new-wikis-importer", "oathauth-tester", "ombudsman", "recursive-export", "staff", "steward", "sysadmin", "wmf-ops-monitoring", "wmf-researcher".
+      # @return [self]
+      def group(*values)
+        values.inject(self) { |res, val| res._group(val) or fail ArgumentError, "Unknown value for group: #{val}" }
+      end
+
+      # @private
+      def _group(value)
+        defined?(super) && super || ["OTRS-member", "abusefilter-helper", "apihighlimits-requestor", "captcha-exempt", "delete-global", "founder", "global-bot", "global-flow-create", "global-interface-editor", "global-ipblock-exempt", "global-rollbacker", "global-sysop", "new-wikis-importer", "oathauth-tester", "ombudsman", "recursive-export", "staff", "steward", "sysadmin", "wmf-ops-monitoring", "wmf-researcher"].include?(value.to_s) && merge(agugroup: value.to_s, replace: false)
+      end
+
+      # Exclude users in given global groups.
+      #
+      # @param values [Array<String>] Allowed values: "OTRS-member", "abusefilter-helper", "apihighlimits-requestor", "captcha-exempt", "delete-global", "founder", "global-bot", "global-flow-create", "global-interface-editor", "global-ipblock-exempt", "global-rollbacker", "global-sysop", "new-wikis-importer", "oathauth-tester", "ombudsman", "recursive-export", "staff", "steward", "sysadmin", "wmf-ops-monitoring", "wmf-researcher".
+      # @return [self]
+      def excludegroup(*values)
+        values.inject(self) { |res, val| res._excludegroup(val) or fail ArgumentError, "Unknown value for excludegroup: #{val}" }
+      end
+
+      # @private
+      def _excludegroup(value)
+        defined?(super) && super || ["OTRS-member", "abusefilter-helper", "apihighlimits-requestor", "captcha-exempt", "delete-global", "founder", "global-bot", "global-flow-create", "global-interface-editor", "global-ipblock-exempt", "global-rollbacker", "global-sysop", "new-wikis-importer", "oathauth-tester", "ombudsman", "recursive-export", "staff", "steward", "sysadmin", "wmf-ops-monitoring", "wmf-researcher"].include?(value.to_s) && merge(aguexcludegroup: value.to_s, replace: false)
+      end
+
+      # What pieces of information to include:
+      #
+      # @param values [Array<String>] Allowed values: "lockinfo" (Whether the user account is locked), "groups" (Lists global groups that the user is in. This uses more server resources and may return fewer results than the limit), "existslocally" (Adds the information if the user exists locally).
+      # @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 || ["lockinfo", "groups", "existslocally"].include?(value.to_s) && merge(aguprop: value.to_s, replace: false)
+      end
+
+      # How many total user names to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(agulimit: value.to_s)
+      end
+    end
+  end
+end