mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Find all pages that use the given image title.
+    #
+    # 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 Imageusage
+
+      # Title to search. Cannot be used together with iupageid.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(iutitle: value.to_s)
+      end
+
+      # Page ID to search. Cannot be used together with iutitle.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def pageid(value)
+        merge(iupageid: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(iucontinue: value.to_s)
+      end
+
+      # The namespace to enumerate.
+      #
+      # @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(iunamespace: value.to_s, replace: false)
+      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(iudir: value.to_s)
+      end
+
+      # How to filter for redirects. If set to nonredirects when iuredirect is enabled, this is only applied to the second level.
+      #
+      # @param value [String] One of "all", "redirects", "nonredirects".
+      # @return [self]
+      def filterredir(value)
+        _filterredir(value) or fail ArgumentError, "Unknown value for filterredir: #{value}"
+      end
+
+      # @private
+      def _filterredir(value)
+        defined?(super) && super || ["all", "redirects", "nonredirects"].include?(value.to_s) && merge(iufilterredir: value.to_s)
+      end
+
+      # How many total pages to return. If iuredirect is enabled, the limit applies to each level separately (which means up to 2 * iulimit results may be returned).
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(iulimit: value.to_s)
+      end
+
+      # If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.
+      #
+      # @return [self]
+      def redirect()
+        merge(iuredirect: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get basic page information.
+    #
+    # 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 Info
+
+      # Which additional properties to get:
+      #
+      # @param values [Array<String>] Allowed values: "protection" (List the protection level of each page), "talkid" (The page ID of the talk page for each non-talk page), "watched" (List the watched status of each page), "watchers" (The number of watchers, if allowed), "visitingwatchers" (The number of watchers of each page who have visited recent edits to that page, if allowed), "notificationtimestamp" (The watchlist notification timestamp of each page), "subjectid" (The page ID of the parent page for each talk page), "url" (Gives a full URL, an edit URL, and the canonical URL for each page), "readable" (Whether the user can read this page), "preload" (Gives the text returned by EditFormPreloadText), "displaytitle" (Gives the manner in which the page title is actually displayed).
+      # @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 || ["protection", "talkid", "watched", "watchers", "visitingwatchers", "notificationtimestamp", "subjectid", "url", "readable", "preload", "displaytitle"].include?(value.to_s) && merge(inprop: value.to_s, replace: false)
+      end
+
+      # Test whether the current user can perform certain actions on the page.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def testactions(*values)
+        values.inject(self) { |res, val| res._testactions(val) }
+      end
+
+      # @private
+      def _testactions(value)
+        merge(intestactions: value.to_s, replace: false)
+      end
+
+      # Use action=query&meta=tokens instead.
+      #
+      # @param values [Array<String>] Allowed values: "edit", "delete", "protect", "move", "block", "unblock", "email", "import", "watch".
+      # @return [self]
+      def token(*values)
+        values.inject(self) { |res, val| res._token(val) or fail ArgumentError, "Unknown value for token: #{val}" }
+      end
+
+      # @private
+      def _token(value)
+        defined?(super) && super || ["edit", "delete", "protect", "move", "block", "unblock", "email", "import", "watch"].include?(value.to_s) && merge(intoken: value.to_s, replace: false)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(incontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Find all pages that link to the given interwiki link.
+    #
+    # 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 Iwbacklinks
+
+      # Prefix for the interwiki.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(iwblprefix: value.to_s)
+      end
+
+      # Interwiki link to search for. Must be used with iwblblprefix.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(iwbltitle: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(iwblcontinue: value.to_s)
+      end
+
+      # How many total pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(iwbllimit: value.to_s)
+      end
+
+      # Which properties to get:
+      #
+      # @param values [Array<String>] Allowed values: "iwprefix" (Adds the prefix of the interwiki), "iwtitle" (Adds the title of the interwiki).
+      # @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 || ["iwprefix", "iwtitle"].include?(value.to_s) && merge(iwblprop: value.to_s, replace: false)
+      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(iwbldir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns all interwiki links from 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 Iwlinks
+
+      # Which additional properties to get for each interlanguage link:
+      #
+      # @param values [Array<String>] Allowed values: "url" (Adds the full URL).
+      # @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(iwprop: value.to_s, replace: false)
+      end
+
+      # Only return interwiki links with this prefix.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(iwprefix: value.to_s)
+      end
+
+      # Interwiki link to search for. Must be used with iwprefix.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(iwtitle: 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(iwdir: value.to_s)
+      end
+
+      # How many interwiki links to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(iwlimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(iwcontinue: value.to_s)
+      end
+
+      # Whether to get the full URL (cannot be used with iwprop).
+      #
+      # @return [self]
+      def url()
+        merge(iwurl: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Output data in JSON 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 Json
+
+      # If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.
+      #
+      # @param value [String]
+      # @return [self]
+      def callback(value)
+        merge(callback: value.to_s)
+      end
+
+      # If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.
+      #
+      # @return [self]
+      def utf8()
+        merge(utf8: 'true')
+      end
+
+      # If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.
+      #
+      # @return [self]
+      def ascii()
+        merge(ascii: 'true')
+      end
+
+      # Output formatting:
+      #
+      # @param value [String] One of "1" (Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.)), "2" (Experimental modern format. Details may change!), "latest" (Use the latest format (currently 2), may change without warning).
+      # @return [self]
+      def formatversion(value)
+        _formatversion(value) or fail ArgumentError, "Unknown value for formatversion: #{value}"
+      end
+
+      # @private
+      def _formatversion(value)
+        defined?(super) && super || ["1", "2", "latest"].include?(value.to_s) && merge(formatversion: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Output data in JSON 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 Jsonfm
+
+      # Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.
+      #
+      # @return [self]
+      def wrappedhtml()
+        merge(wrappedhtml: 'true')
+      end
+
+      # If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.
+      #
+      # @param value [String]
+      # @return [self]
+      def callback(value)
+        merge(callback: value.to_s)
+      end
+
+      # If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.
+      #
+      # @return [self]
+      def utf8()
+        merge(utf8: 'true')
+      end
+
+      # If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.
+      #
+      # @return [self]
+      def ascii()
+        merge(ascii: 'true')
+      end
+
+      # Output formatting:
+      #
+      # @param value [String] One of "1" (Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.)), "2" (Experimental modern format. Details may change!), "latest" (Use the latest format (currently 2), may change without warning).
+      # @return [self]
+      def formatversion(value)
+        _formatversion(value) or fail ArgumentError, "Unknown value for formatversion: #{value}"
+      end
+
+      # @private
+      def _formatversion(value)
+        defined?(super) && super || ["1", "2", "latest"].include?(value.to_s) && merge(formatversion: value.to_s)
+      end
+    end
+  end
+end