mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all globally blocked IP addresses.
+    #
+    # 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 Globalblocks
+
+      # The timestamp to start enumerating from.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(bgstart: value.iso8601)
+      end
+
+      # The timestamp to stop enumerating at.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(bgend: value.iso8601)
+      end
+
+      # In which direction to enumerate:
+      #
+      # @param value [String] One of "newer" (List oldest first. Note: bgstart has to be before bgend), "older" (List newest first (default). Note: bgstart has to be later than bgend).
+      # @return [self]
+      def dir(value)
+        _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
+      end
+
+      # @private
+      def _dir(value)
+        defined?(super) && super || ["newer", "older"].include?(value.to_s) && merge(bgdir: value.to_s)
+      end
+
+      # Pipe-separated list of block IDs to list.
+      #
+      # @param values [Array<Integer>]
+      # @return [self]
+      def ids(*values)
+        values.inject(self) { |res, val| res._ids(val) }
+      end
+
+      # @private
+      def _ids(value)
+        merge(bgids: value.to_s, replace: false)
+      end
+
+      # Pipe-separated list of IP addresses to search for.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def addresses(*values)
+        values.inject(self) { |res, val| res._addresses(val) }
+      end
+
+      # @private
+      def _addresses(value)
+        merge(bgaddresses: value.to_s, replace: false)
+      end
+
+      # Get all blocks applying to this IP address or CIDR range, including range blocks. Cannot be used together with bgaddresses. CIDR ranges broader than /16 are not accepted.
+      #
+      # @param value [String]
+      # @return [self]
+      def ip(value)
+        merge(bgip: value.to_s)
+      end
+
+      # The maximum amount of blocks to list.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(bglimit: value.to_s)
+      end
+
+      # Which properties to get.
+      #
+      # @param values [Array<String>] Allowed values: "id", "address", "by", "timestamp", "expiry", "reason", "range".
+      # @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", "address", "by", "timestamp", "expiry", "reason", "range"].include?(value.to_s) && merge(bgprop: value.to_s, replace: false)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Enumerate all global groups.
+    #
+    # 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 Globalgroups
+
+      # What pieces of information to include.
+      #
+      # @param values [Array<String>] Allowed values: "rights".
+      # @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 || ["rights"].include?(value.to_s) && merge(ggpprop: value.to_s, replace: false)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns global image usage for a certain image.
+    #
+    # 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 Globalusage
+
+      # Which properties to return:
+      #
+      # @param values [Array<String>] Allowed values: "url" (Adds url), "pageid" (Adds page ID), "namespace" (Adds namespace ID).
+      # @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", "pageid", "namespace"].include?(value.to_s) && merge(guprop: value.to_s, replace: false)
+      end
+
+      # How many links to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gulimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(gucontinue: value.to_s)
+      end
+
+      # Filter local usage of the file.
+      #
+      # @return [self]
+      def filterlocal()
+        merge(gufilterlocal: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Show information about a global user.
+    #
+    # 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 Globaluserinfo
+
+      # User to get information about. Defaults to the current user.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(guiuser: value.to_s)
+      end
+
+      # Which properties to get:
+      #
+      # @param values [Array<String>] Allowed values: "groups" (Get a list of global groups this user belongs to), "rights" (Get a list of global rights this user has), "merged" (Get a list of merged accounts), "unattached" (Get a list of unattached accounts), "editcount" (Get the user's global edit count).
+      # @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 || ["groups", "rights", "merged", "unattached", "editcount"].include?(value.to_s) && merge(guiprop: value.to_s, replace: false)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns file information and upload history.
+    #
+    # 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 Imageinfo
+
+      # 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), "thumbmime" (Adds MIME type of the image thumbnail (requires url and param iiurlwidth)), "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), "archivename" (Adds the filename of the archive version for non-latest versions), "bitdepth" (Adds the bit depth of the version), "uploadwarning" (Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core), "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", "thumbmime", "mediatype", "metadata", "commonmetadata", "extmetadata", "archivename", "bitdepth", "uploadwarning", "badfile"].include?(value.to_s) && merge(iiprop: value.to_s, replace: false)
+      end
+
+      # How many file revisions to return per file.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(iilimit: value.to_s)
+      end
+
+      # Timestamp to start listing from.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(iistart: value.iso8601)
+      end
+
+      # Timestamp to stop listing at.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(iiend: value.iso8601)
+      end
+
+      # If iiprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def urlwidth(value)
+        merge(iiurlwidth: value.to_s)
+      end
+
+      # Similar to iiurlwidth.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def urlheight(value)
+        merge(iiurlheight: value.to_s)
+      end
+
+      # Version of metadata to use. If latest is specified, use latest version. Defaults to 1 for backwards compatibility.
+      #
+      # @param value [String]
+      # @return [self]
+      def metadataversion(value)
+        merge(iimetadataversion: value.to_s)
+      end
+
+      # What language to fetch extmetadata in. This affects both which translation to fetch, if multiple are available, as well as how things like numbers and various values are formatted.
+      #
+      # @param value [String]
+      # @return [self]
+      def extmetadatalanguage(value)
+        merge(iiextmetadatalanguage: value.to_s)
+      end
+
+      # If translations for extmetadata property are available, fetch all of them.
+      #
+      # @return [self]
+      def extmetadatamultilang()
+        merge(iiextmetadatamultilang: 'true')
+      end
+
+      # If specified and non-empty, only these keys will be returned for iiprop=extmetadata.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def extmetadatafilter(*values)
+        values.inject(self) { |res, val| res._extmetadatafilter(val) }
+      end
+
+      # @private
+      def _extmetadatafilter(value)
+        merge(iiextmetadatafilter: value.to_s, replace: false)
+      end
+
+      # A handler specific parameter string. For example, PDFs might use page15-100px. iiurlwidth must be used and be consistent with iiurlparam.
+      #
+      # @param value [String]
+      # @return [self]
+      def urlparam(value)
+        merge(iiurlparam: value.to_s)
+      end
+
+      # If badfilecontexttitleprop=badfile is set, this is the page title used when evaluating the MediaWiki:Bad image list
+      #
+      # @param value [String]
+      # @return [self]
+      def badfilecontexttitle(value)
+        merge(iibadfilecontexttitle: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(iicontinue: value.to_s)
+      end
+
+      # Look only for files in the local repository.
+      #
+      # @return [self]
+      def localonly()
+        merge(iilocalonly: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns all files contained on 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 Images
+
+      # How many files to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(imlimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(imcontinue: value.to_s)
+      end
+
+      # Only list these files. Useful for checking whether a certain page has a certain file.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def images(*values)
+        values.inject(self) { |res, val| res._images(val) }
+      end
+
+      # @private
+      def _images(value)
+        merge(imimages: 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(imdir: value.to_s)
+      end
+    end
+  end
+end