mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all file usages, including non-existing.
+    #
+    # 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 Allfileusages
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(afcontinue: value.to_s)
+      end
+
+      # The title of the file to start enumerating from.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(affrom: value.to_s)
+      end
+
+      # The title of the file to stop enumerating at.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(afto: value.to_s)
+      end
+
+      # Search for all file titles that begin with this value.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(afprefix: value.to_s)
+      end
+
+      # Only show distinct file titles. Cannot be used with afprop=ids. When used as a generator, yields target pages instead of source pages.
+      #
+      # @return [self]
+      def unique()
+        merge(afunique: 'true')
+      end
+
+      # Which pieces of information to include:
+      #
+      # @param values [Array<String>] Allowed values: "ids" (Adds the page IDs of the using pages (cannot be used with afunique)), "title" (Adds the title of the file).
+      # @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"].include?(value.to_s) && merge(afprop: value.to_s, replace: false)
+      end
+
+      # How many total items to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(aflimit: 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(afdir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Enumerate all images sequentially.
+    #
+    # 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 Allimages
+
+      # Property to sort by.
+      #
+      # @param value [String] One of "name", "timestamp".
+      # @return [self]
+      def sort(value)
+        _sort(value) or fail ArgumentError, "Unknown value for sort: #{value}"
+      end
+
+      # @private
+      def _sort(value)
+        defined?(super) && super || ["name", "timestamp"].include?(value.to_s) && merge(aisort: value.to_s)
+      end
+
+      # The direction in which to list.
+      #
+      # @param value [String] One of "ascending", "descending", "newer", "older".
+      # @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", "newer", "older"].include?(value.to_s) && merge(aidir: value.to_s)
+      end
+
+      # The image title to start enumerating from. Can only be used with aisort=name.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(aifrom: value.to_s)
+      end
+
+      # The image title to stop enumerating at. Can only be used with aisort=name.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(aito: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(aicontinue: value.to_s)
+      end
+
+      # The timestamp to start enumerating from. Can only be used with aisort=timestamp.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(aistart: value.iso8601)
+      end
+
+      # The timestamp to end enumerating. Can only be used with aisort=timestamp.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(aiend: value.iso8601)
+      end
+
+      # Which file information to get:
+      #
+      # @param values [Array<String>] Allowed values: "timestamp" (Adds timestamp for the uploaded version), "user" (Adds the user who uploaded each file version), "userid" (Add the ID of the user that uploaded each file version), "comment" (Comment on the version), "parsedcomment" (Parse the comment on the version), "canonicaltitle" (Adds the canonical title of the file), "url" (Gives URL to the file and the description page), "size" (Adds the size of the file in bytes and the height, width and page count (if applicable)), "dimensions" (Alias for size), "sha1" (Adds SHA-1 hash for the file), "mime" (Adds MIME type of the file), "mediatype" (Adds the media type of the file), "metadata" (Lists Exif metadata for the version of the file), "commonmetadata" (Lists file format generic metadata for the version of the file), "extmetadata" (Lists formatted metadata combined from multiple sources. Results are HTML formatted), "bitdepth" (Adds the bit depth of the version), "badfile" (Adds whether the file is on the MediaWiki:Bad image list).
+      # @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 || ["timestamp", "user", "userid", "comment", "parsedcomment", "canonicaltitle", "url", "size", "dimensions", "sha1", "mime", "mediatype", "metadata", "commonmetadata", "extmetadata", "bitdepth", "badfile"].include?(value.to_s) && merge(aiprop: value.to_s, replace: false)
+      end
+
+      # Search for all image titles that begin with this value. Can only be used with aisort=name.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(aiprefix: value.to_s)
+      end
+
+      # Limit to images with at least this many bytes.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def minsize(value)
+        merge(aiminsize: value.to_s)
+      end
+
+      # Limit to images with at most this many bytes.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def maxsize(value)
+        merge(aimaxsize: value.to_s)
+      end
+
+      # SHA1 hash of image. Overrides aisha1base36.
+      #
+      # @param value [String]
+      # @return [self]
+      def sha1(value)
+        merge(aisha1: value.to_s)
+      end
+
+      # SHA1 hash of image in base 36 (used in MediaWiki).
+      #
+      # @param value [String]
+      # @return [self]
+      def sha1base36(value)
+        merge(aisha1base36: value.to_s)
+      end
+
+      # Only return files uploaded by this user. Can only be used with aisort=timestamp. Cannot be used together with aifilterbots.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(aiuser: value.to_s)
+      end
+
+      # How to filter files uploaded by bots. Can only be used with aisort=timestamp. Cannot be used together with aiuser.
+      #
+      # @param value [String] One of "all", "bots", "nobots".
+      # @return [self]
+      def filterbots(value)
+        _filterbots(value) or fail ArgumentError, "Unknown value for filterbots: #{value}"
+      end
+
+      # @private
+      def _filterbots(value)
+        defined?(super) && super || ["all", "bots", "nobots"].include?(value.to_s) && merge(aifilterbots: value.to_s)
+      end
+
+      # Disabled due to miser mode.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def mime(*values)
+        values.inject(self) { |res, val| res._mime(val) }
+      end
+
+      # @private
+      def _mime(value)
+        merge(aimime: value.to_s, replace: false)
+      end
+
+      # How many images in total to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(ailimit: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Enumerate all links that point to a given namespace.
+    #
+    # 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 Alllinks
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(alcontinue: value.to_s)
+      end
+
+      # The title of the link to start enumerating from.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(alfrom: value.to_s)
+      end
+
+      # The title of the link to stop enumerating at.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(alto: value.to_s)
+      end
+
+      # Search for all linked titles that begin with this value.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(alprefix: value.to_s)
+      end
+
+      # Only show distinct linked titles. Cannot be used with alprop=ids. When used as a generator, yields target pages instead of source pages.
+      #
+      # @return [self]
+      def unique()
+        merge(alunique: 'true')
+      end
+
+      # Which pieces of information to include:
+      #
+      # @param values [Array<String>] Allowed values: "ids" (Adds the page ID of the linking page (cannot be used with alunique)), "title" (Adds the title of the link).
+      # @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"].include?(value.to_s) && merge(alprop: value.to_s, replace: false)
+      end
+
+      # The namespace to enumerate.
+      #
+      # @param value [String] One of "-2", "-1", "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(value)
+        _namespace(value) or fail ArgumentError, "Unknown value for namespace: #{value}"
+      end
+
+      # @private
+      def _namespace(value)
+        defined?(super) && super || ["-2", "-1", "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(alnamespace: value.to_s)
+      end
+
+      # How many total items to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(allimit: 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(aldir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Return messages from this site.
+    #
+    # 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 Allmessages
+
+      # Which messages to output. * (default) means all messages.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def messages(*values)
+        values.inject(self) { |res, val| res._messages(val) }
+      end
+
+      # @private
+      def _messages(value)
+        merge(ammessages: value.to_s, replace: false)
+      end
+
+      # Which properties to get.
+      #
+      # @param values [Array<String>] Allowed values: "default".
+      # @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 || ["default"].include?(value.to_s) && merge(amprop: value.to_s, replace: false)
+      end
+
+      # Set to enable parser, will preprocess the wikitext of message (substitute magic words, handle templates, etc.).
+      #
+      # @return [self]
+      def enableparser()
+        merge(amenableparser: 'true')
+      end
+
+      # If set, do not include the content of the messages in the output.
+      #
+      # @return [self]
+      def nocontent()
+        merge(amnocontent: 'true')
+      end
+
+      # Also include local messages, i.e. messages that don't exist in the software but do exist as in the MediaWiki namespace. This lists all MediaWiki-namespace pages, so it will also list those that aren't really messages such as Common.js.
+      #
+      # @return [self]
+      def includelocal()
+        merge(amincludelocal: 'true')
+      end
+
+      # Arguments to be substituted into message.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def args(*values)
+        values.inject(self) { |res, val| res._args(val) }
+      end
+
+      # @private
+      def _args(value)
+        merge(amargs: value.to_s, replace: false)
+      end
+
+      # Return only messages with names that contain this string.
+      #
+      # @param value [String]
+      # @return [self]
+      def filter(value)
+        merge(amfilter: value.to_s)
+      end
+
+      # Return only messages in this customisation state.
+      #
+      # @param value [String] One of "all", "modified", "unmodified".
+      # @return [self]
+      def customised(value)
+        _customised(value) or fail ArgumentError, "Unknown value for customised: #{value}"
+      end
+
+      # @private
+      def _customised(value)
+        defined?(super) && super || ["all", "modified", "unmodified"].include?(value.to_s) && merge(amcustomised: value.to_s)
+      end
+
+      # Return messages in this language.
+      #
+      # @param value [String]
+      # @return [self]
+      def lang(value)
+        merge(amlang: value.to_s)
+      end
+
+      # Return messages starting at this message.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(amfrom: value.to_s)
+      end
+
+      # Return messages ending at this message.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(amto: value.to_s)
+      end
+
+      # Page name to use as context when parsing message (for amenableparser option).
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(amtitle: value.to_s)
+      end
+
+      # Return messages with this prefix.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(amprefix: value.to_s)
+      end
+    end
+  end
+end