mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all file usages, including non-existing. _Generator module: for fetching pages corresponding to request._
+    #
+    # 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 GAllfileusages
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(gafcontinue: value.to_s)
+      end
+
+      # The title of the file to start enumerating from.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(gaffrom: value.to_s)
+      end
+
+      # The title of the file to stop enumerating at.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(gafto: value.to_s)
+      end
+
+      # Search for all file titles that begin with this value.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(gafprefix: 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(gafunique: 'true')
+      end
+
+      # How many total items to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gaflimit: 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(gafdir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Enumerate all images sequentially. _Generator module: for fetching pages corresponding to request._
+    #
+    # 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 GAllimages
+
+      # 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(gaisort: 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(gaidir: 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(gaifrom: 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(gaito: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(gaicontinue: 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(gaistart: value.iso8601)
+      end
+
+      # The timestamp to end enumerating. Can only be used with aisort=timestamp.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(gaiend: value.iso8601)
+      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(gaiprefix: value.to_s)
+      end
+
+      # Limit to images with at least this many bytes.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def minsize(value)
+        merge(gaiminsize: value.to_s)
+      end
+
+      # Limit to images with at most this many bytes.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def maxsize(value)
+        merge(gaimaxsize: value.to_s)
+      end
+
+      # SHA1 hash of image. Overrides aisha1base36.
+      #
+      # @param value [String]
+      # @return [self]
+      def sha1(value)
+        merge(gaisha1: value.to_s)
+      end
+
+      # SHA1 hash of image in base 36 (used in MediaWiki).
+      #
+      # @param value [String]
+      # @return [self]
+      def sha1base36(value)
+        merge(gaisha1base36: 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(gaiuser: 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(gaifilterbots: 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(gaimime: value.to_s, replace: false)
+      end
+
+      # How many images in total to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gailimit: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Enumerate all links that point to a given namespace. _Generator module: for fetching pages corresponding to request._
+    #
+    # 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 GAlllinks
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(galcontinue: value.to_s)
+      end
+
+      # The title of the link to start enumerating from.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(galfrom: value.to_s)
+      end
+
+      # The title of the link to stop enumerating at.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(galto: value.to_s)
+      end
+
+      # Search for all linked titles that begin with this value.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(galprefix: 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(galunique: 'true')
+      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(galnamespace: value.to_s)
+      end
+
+      # How many total items to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gallimit: 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(galdir: value.to_s)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/modules/g-allpages.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Enumerate all pages sequentially in a given namespace. _Generator module: for fetching pages corresponding to request._
+    #
+    # 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 GAllpages
+
+      # The page title to start enumerating from.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(gapfrom: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(gapcontinue: value.to_s)
+      end
+
+      # The page title to stop enumerating at.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(gapto: value.to_s)
+      end
+
+      # Search for all page titles that begin with this value.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(gapprefix: value.to_s)
+      end
+
+      # The namespace to enumerate.
+      #
+      # @param value [String] One of "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 || ["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(gapnamespace: value.to_s)
+      end
+
+      # Which pages to list.
+      #
+      # @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(gapfilterredir: value.to_s)
+      end
+
+      # Limit to pages with at least this many bytes.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def minsize(value)
+        merge(gapminsize: value.to_s)
+      end
+
+      # Limit to pages with at most this many bytes.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def maxsize(value)
+        merge(gapmaxsize: value.to_s)
+      end
+
+      # Limit to protected pages only.
+      #
+      # @param values [Array<String>] Allowed values: "edit", "move", "upload".
+      # @return [self]
+      def prtype(*values)
+        values.inject(self) { |res, val| res._prtype(val) or fail ArgumentError, "Unknown value for prtype: #{val}" }
+      end
+
+      # @private
+      def _prtype(value)
+        defined?(super) && super || ["edit", "move", "upload"].include?(value.to_s) && merge(gapprtype: value.to_s, replace: false)
+      end
+
+      # Filter protections based on protection level (must be used with apprtype= parameter).
+      #
+      # @param values [Array<String>] Allowed values: "autoconfirmed", "extendedconfirmed", "templateeditor", "sysop".
+      # @return [self]
+      def prlevel(*values)
+        values.inject(self) { |res, val| res._prlevel(val) or fail ArgumentError, "Unknown value for prlevel: #{val}" }
+      end
+
+      # @private
+      def _prlevel(value)
+        defined?(super) && super || ["autoconfirmed", "extendedconfirmed", "templateeditor", "sysop"].include?(value.to_s) && merge(gapprlevel: value.to_s, replace: false)
+      end
+
+      # Filter protections based on cascadingness (ignored when apprtype isn't set).
+      #
+      # @param value [String] One of "cascading", "noncascading", "all".
+      # @return [self]
+      def prfiltercascade(value)
+        _prfiltercascade(value) or fail ArgumentError, "Unknown value for prfiltercascade: #{value}"
+      end
+
+      # @private
+      def _prfiltercascade(value)
+        defined?(super) && super || ["cascading", "noncascading", "all"].include?(value.to_s) && merge(gapprfiltercascade: value.to_s)
+      end
+
+      # How many total pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gaplimit: 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(gapdir: value.to_s)
+      end
+
+      # Filter based on whether a page has langlinks. Note that this may not consider langlinks added by extensions.
+      #
+      # @param value [String] One of "withlanglinks", "withoutlanglinks", "all".
+      # @return [self]
+      def filterlanglinks(value)
+        _filterlanglinks(value) or fail ArgumentError, "Unknown value for filterlanglinks: #{value}"
+      end
+
+      # @private
+      def _filterlanglinks(value)
+        defined?(super) && super || ["withlanglinks", "withoutlanglinks", "all"].include?(value.to_s) && merge(gapfilterlanglinks: value.to_s)
+      end
+
+      # Which protection expiry to filter the page on:
+      #
+      # @param value [String] One of "indefinite" (Get only pages with indefinite protection expiry), "definite" (Get only pages with a definite (specific) protection expiry), "all" (Get pages with any protections expiry).
+      # @return [self]
+      def prexpiry(value)
+        _prexpiry(value) or fail ArgumentError, "Unknown value for prexpiry: #{value}"
+      end
+
+      # @private
+      def _prexpiry(value)
+        defined?(super) && super || ["indefinite", "definite", "all"].include?(value.to_s) && merge(gapprexpiry: value.to_s)
+      end
+    end
+  end
+end