mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get all pages on the current user's watchlist.
+    #
+    # 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 Watchlistraw
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(wrcontinue: value.to_s)
+      end
+
+      # Only list pages in the given namespaces.
+      #
+      # @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(wrnamespace: value.to_s, replace: false)
+      end
+
+      # How many total results to return per request.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(wrlimit: value.to_s)
+      end
+
+      # Which additional properties to get:
+      #
+      # @param values [Array<String>] Allowed values: "changed" (Adds timestamp of when the user was last notified about the edit).
+      # @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 || ["changed"].include?(value.to_s) && merge(wrprop: value.to_s, replace: false)
+      end
+
+      # Only list items that meet these criteria.
+      #
+      # @param values [Array<String>] Allowed values: "changed", "!changed".
+      # @return [self]
+      def show(*values)
+        values.inject(self) { |res, val| res._show(val) or fail ArgumentError, "Unknown value for show: #{val}" }
+      end
+
+      # @private
+      def _show(value)
+        defined?(super) && super || ["changed", "!changed"].include?(value.to_s) && merge(wrshow: value.to_s, replace: false)
+      end
+
+      # Used along with wrtoken to access a different user's watchlist.
+      #
+      # @param value [String]
+      # @return [self]
+      def owner(value)
+        merge(wrowner: value.to_s)
+      end
+
+      # A security token (available in the user's preferences) to allow access to another user's watchlist.
+      #
+      # @param value [String]
+      # @return [self]
+      def token(value)
+        merge(wrtoken: value.to_s)
+      end
+
+      # The direction in which to list.
+      #
+      # @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(wrdir: value.to_s)
+      end
+
+      # Title (with namespace prefix) to begin enumerating from.
+      #
+      # @param value [String]
+      # @return [self]
+      def fromtitle(value)
+        merge(wrfromtitle: value.to_s)
+      end
+
+      # Title (with namespace prefix) to stop enumerating at.
+      #
+      # @param value [String]
+      # @return [self]
+      def totitle(value)
+        merge(wrtotitle: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns all entity IDs used in the given pages.
+    #
+    # 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 Wbentityusage
+
+      # Properties to add to the result.
+      #
+      # @param values [Array<String>] Allowed values: "url" (If enabled url of entity will be added).
+      # @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 || ["url"].include?(value.to_s) && merge(wbeuprop: value.to_s, replace: false)
+      end
+
+      # 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(wbeuaspect: value.to_s, replace: false)
+      end
+
+      # Only return page that used these entities.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def entities(*values)
+        values.inject(self) { |res, val| res._entities(val) }
+      end
+
+      # @private
+      def _entities(value)
+        merge(wbeuentities: value.to_s, replace: false)
+      end
+
+      # How many entity usages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(wbeulimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(wbeucontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns all pages that use the given entity IDs.
+    #
+    # 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 Wblistentityusage
+
+      # Properties to add to the result.
+      #
+      # @param values [Array<String>] Allowed values: "url" (If enabled the url of the entity will be added to the result).
+      # @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 || ["url"].include?(value.to_s) && merge(wbeuprop: value.to_s, replace: false)
+      end
+
+      # 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(wbeuaspect: 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(wbeuentities: value.to_s, replace: false)
+      end
+
+      # How many entity usages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(wbeulimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(wbeucontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get information about the Wikibase client and the associated Wikibase repository.
+    #
+    # 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 Wikibase
+
+      # Which properties to get:
+      #
+      # @param values [Array<String>] Allowed values: "url" ( Base URL, script path and article path of the Wikibase repository), "siteid" ( The siteid of this site).
+      # @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 || ["url", "siteid"].include?(value.to_s) && merge(wbprop: value.to_s, replace: false)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # 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.
+    #
+    module Wikisets
+
+      # The name of the wiki set to start from.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(wsfrom: value.to_s)
+      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]
+      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", "wikisincluded", "wikisnotincluded"].include?(value.to_s) && merge(wsprop: value.to_s, replace: false)
+      end
+
+      # How many wiki sets to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(wslimit: value.to_s)
+      end
+
+      # Order results by name.
+      #
+      # @return [self]
+      def orderbyname()
+        merge(wsorderbyname: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Output data in XML format.
+    #
+    # 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 Xml
+
+      # If specified, adds the named page as an XSL stylesheet. The value must be a title in the MediaWiki namespace ending in .xsl.
+      #
+      # @param value [String]
+      # @return [self]
+      def xslt(value)
+        merge(xslt: value.to_s)
+      end
+
+      # If specified, adds an XML namespace.
+      #
+      # @return [self]
+      def includexmlnamespace()
+        merge(includexmlnamespace: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Output data in XML format (pretty-print in HTML).
+    #
+    # 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 Xmlfm
+
+      # Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.
+      #
+      # @return [self]
+      def wrappedhtml()
+        merge(wrappedhtml: 'true')
+      end
+
+      # If specified, adds the named page as an XSL stylesheet. The value must be a title in the MediaWiki namespace ending in .xsl.
+      #
+      # @param value [String]
+      # @return [self]
+      def xslt(value)
+        merge(xslt: value.to_s)
+      end
+
+      # If specified, adds an XML namespace.
+      #
+      # @return [self]
+      def includexmlnamespace()
+        merge(includexmlnamespace: 'true')
+      end
+    end
+  end
+end