mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all files that are duplicates of the given files based on hash values.
+    #
+    # 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 Duplicatefiles
+
+      # How many duplicate files to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(dflimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(dfcontinue: 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(dfdir: value.to_s)
+      end
+
+      # Look only for files in the local repository.
+      #
+      # @return [self]
+      def localonly()
+        merge(dflocalonly: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Find all pages that embed (transclude) the given 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 Embeddedin
+
+      # Title to search. Cannot be used together with eipageid.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(eititle: value.to_s)
+      end
+
+      # Page ID to search. Cannot be used together with eititle.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def pageid(value)
+        merge(eipageid: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(eicontinue: 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(einamespace: 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(eidir: value.to_s)
+      end
+
+      # How to filter for redirects.
+      #
+      # @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(eifilterredir: value.to_s)
+      end
+
+      # How many total pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(eilimit: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns all external URLs (not interwikis) 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 Extlinks
+
+      # How many links to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(ellimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def offset(value)
+        merge(eloffset: value.to_s)
+      end
+
+      # Protocol of the URL. If empty and elquery is set, the protocol is http. Leave both this and elquery empty to list all external links.
+      #
+      # @param value [String] One of "bitcoin", "ftp", "ftps", "geo", "git", "gopher", "http", "https", "irc", "ircs", "magnet", "mailto", "mms", "news", "nntp", "redis", "sftp", "sip", "sips", "sms", "ssh", "svn", "tel", "telnet", "urn", "worldwind", "xmpp".
+      # @return [self]
+      def protocol(value)
+        _protocol(value) or fail ArgumentError, "Unknown value for protocol: #{value}"
+      end
+
+      # @private
+      def _protocol(value)
+        defined?(super) && super || ["bitcoin", "ftp", "ftps", "geo", "git", "gopher", "http", "https", "irc", "ircs", "magnet", "mailto", "mms", "news", "nntp", "redis", "sftp", "sip", "sips", "sms", "ssh", "svn", "tel", "telnet", "urn", "worldwind", "xmpp"].include?(value.to_s) && merge(elprotocol: value.to_s)
+      end
+
+      # Search string without protocol. Useful for checking whether a certain page contains a certain external url.
+      #
+      # @param value [String]
+      # @return [self]
+      def query(value)
+        merge(elquery: value.to_s)
+      end
+
+      # Expand protocol-relative URLs with the canonical protocol.
+      #
+      # @return [self]
+      def expandurl()
+        merge(elexpandurl: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns plain-text or limited HTML extracts of 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 Extracts
+
+      # How many characters to return. Actual text returned might be slightly longer.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def chars(value)
+        merge(exchars: value.to_s)
+      end
+
+      # How many sentences to return.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def sentences(value)
+        merge(exsentences: value.to_s)
+      end
+
+      # How many extracts to return. (Multiple extracts can only be returned if exintro is set to true.)
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(exlimit: value.to_s)
+      end
+
+      # Return only content before the first section.
+      #
+      # @return [self]
+      def intro()
+        merge(exintro: 'true')
+      end
+
+      # Return extracts as plain text instead of limited HTML.
+      #
+      # @return [self]
+      def plaintext()
+        merge(explaintext: 'true')
+      end
+
+      # How to format sections in plaintext mode:
+      #
+      # @param value [String] One of "plain" (No formatting), "wiki" (Wikitext-style formatting (== like this ==)), "raw" (This module's internal representation (section titles prefixed with <ASCII 1><ASCII 2><section level><ASCII 2><ASCII 1>)).
+      # @return [self]
+      def sectionformat(value)
+        _sectionformat(value) or fail ArgumentError, "Unknown value for sectionformat: #{value}"
+      end
+
+      # @private
+      def _sectionformat(value)
+        defined?(super) && super || ["plain", "wiki", "raw"].include?(value.to_s) && merge(exsectionformat: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def continue(value)
+        merge(excontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Enumerate pages that contain a given URL.
+    #
+    # 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 Exturlusage
+
+      # Which pieces of information to include:
+      #
+      # @param values [Array<String>] Allowed values: "ids" (Adds the ID of page), "title" (Adds the title and namespace ID of the page), "url" (Adds the URL used in the page).
+      # @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 || ["ids", "title", "url"].include?(value.to_s) && merge(euprop: value.to_s, replace: false)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def offset(value)
+        merge(euoffset: value.to_s)
+      end
+
+      # Protocol of the URL. If empty and euquery is set, the protocol is http. Leave both this and euquery empty to list all external links.
+      #
+      # @param value [String] One of "bitcoin", "ftp", "ftps", "geo", "git", "gopher", "http", "https", "irc", "ircs", "magnet", "mailto", "mms", "news", "nntp", "redis", "sftp", "sip", "sips", "sms", "ssh", "svn", "tel", "telnet", "urn", "worldwind", "xmpp".
+      # @return [self]
+      def protocol(value)
+        _protocol(value) or fail ArgumentError, "Unknown value for protocol: #{value}"
+      end
+
+      # @private
+      def _protocol(value)
+        defined?(super) && super || ["bitcoin", "ftp", "ftps", "geo", "git", "gopher", "http", "https", "irc", "ircs", "magnet", "mailto", "mms", "news", "nntp", "redis", "sftp", "sip", "sips", "sms", "ssh", "svn", "tel", "telnet", "urn", "worldwind", "xmpp"].include?(value.to_s) && merge(euprotocol: value.to_s)
+      end
+
+      # Search string without protocol. See Special:LinkSearch. Leave empty to list all external links.
+      #
+      # @param value [String]
+      # @return [self]
+      def query(value)
+        merge(euquery: value.to_s)
+      end
+
+      # The page namespaces 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(eunamespace: value.to_s, replace: false)
+      end
+
+      # How many pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(eulimit: value.to_s)
+      end
+
+      # Expand protocol-relative URLs with the canonical protocol.
+      #
+      # @return [self]
+      def expandurl()
+        merge(euexpandurl: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get a summary of logged API feature usages for a user agent.
+    #
+    # 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 Featureusage
+
+      # Start of date range to query.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(afustart: value.iso8601)
+      end
+
+      # End of date range to query.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(afuend: value.iso8601)
+      end
+
+      # User agent to query. If not specified, the agent in the request will be queried.
+      #
+      # @param value [String]
+      # @return [self]
+      def agent(value)
+        merge(afuagent: value.to_s)
+      end
+
+      # If specified, return details on only these features.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def features(*values)
+        values.inject(self) { |res, val| res._features(val) }
+      end
+
+      # @private
+      def _features(value)
+        merge(afufeatures: value.to_s, replace: false)
+      end
+    end
+  end
+end