mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Enumerate all pages sequentially in 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 Allpages
+
+      # The page title to start enumerating from.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(apfrom: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(apcontinue: value.to_s)
+      end
+
+      # The page title to stop enumerating at.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(apto: value.to_s)
+      end
+
+      # Search for all page titles that begin with this value.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(apprefix: 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(apnamespace: 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(apfilterredir: value.to_s)
+      end
+
+      # Limit to pages with at least this many bytes.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def minsize(value)
+        merge(apminsize: value.to_s)
+      end
+
+      # Limit to pages with at most this many bytes.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def maxsize(value)
+        merge(apmaxsize: 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(apprtype: 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(apprlevel: 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(apprfiltercascade: value.to_s)
+      end
+
+      # How many total pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(aplimit: 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(apdir: 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(apfilterlanglinks: 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(apprexpiry: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all redirects to a 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 Allredirects
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(arcontinue: value.to_s)
+      end
+
+      # The title of the redirect to start enumerating from.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(arfrom: value.to_s)
+      end
+
+      # The title of the redirect to stop enumerating at.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(arto: value.to_s)
+      end
+
+      # Search for all target pages that begin with this value.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(arprefix: value.to_s)
+      end
+
+      # Only show distinct target pages. Cannot be used with arprop=ids|fragment|interwiki. When used as a generator, yields target pages instead of source pages.
+      #
+      # @return [self]
+      def unique()
+        merge(arunique: 'true')
+      end
+
+      # Which pieces of information to include:
+      #
+      # @param values [Array<String>] Allowed values: "ids" (Adds the page ID of the redirecting page (cannot be used with arunique)), "title" (Adds the title of the redirect), "fragment" (Adds the fragment from the redirect, if any (cannot be used with arunique)), "interwiki" (Adds the interwiki prefix from the redirect, if any (cannot be used with arunique)).
+      # @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", "fragment", "interwiki"].include?(value.to_s) && merge(arprop: 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(arnamespace: value.to_s)
+      end
+
+      # How many total items to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(arlimit: 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(ardir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all revisions.
+    #
+    # 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 Allrevisions
+
+      # Which properties to get for each revision:
+      #
+      # @param values [Array<String>] Allowed values: "ids" (The ID of the revision), "flags" (Revision flags (minor)), "timestamp" (The timestamp of the revision), "user" (User that made the revision), "userid" (User ID of the revision creator), "size" (Length (bytes) of the revision), "sha1" (SHA-1 (base 16) of the revision), "contentmodel" (Content model ID of the revision), "comment" (Comment by the user for the revision), "parsedcomment" (Parsed comment by the user for the revision), "content" (Text of the revision), "tags" (Tags for the revision), "parsetree" (The XML parse tree of revision content (requires content model wikitext)).
+      # @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", "flags", "timestamp", "user", "userid", "size", "sha1", "contentmodel", "comment", "parsedcomment", "content", "tags", "parsetree"].include?(value.to_s) && merge(arvprop: value.to_s, replace: false)
+      end
+
+      # Limit how many revisions will be returned.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(arvlimit: value.to_s)
+      end
+
+      # Expand templates in revision content (requires arvprop=content).
+      #
+      # @return [self]
+      def expandtemplates()
+        merge(arvexpandtemplates: 'true')
+      end
+
+      # Generate XML parse tree for revision content (requires arvprop=content; replaced by arvprop=parsetree).
+      #
+      # @return [self]
+      def generatexml()
+        merge(arvgeneratexml: 'true')
+      end
+
+      # Parse revision content (requires arvprop=content). For performance reasons, if this option is used, arvlimit is enforced to 1.
+      #
+      # @return [self]
+      def parse()
+        merge(arvparse: 'true')
+      end
+
+      # Only retrieve the content of this section number.
+      #
+      # @param value [String]
+      # @return [self]
+      def section(value)
+        merge(arvsection: value.to_s)
+      end
+
+      # Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.
+      #
+      # @param value [String]
+      # @return [self]
+      def diffto(value)
+        merge(arvdiffto: value.to_s)
+      end
+
+      # Text to diff each revision to. Only diffs a limited number of revisions. Overrides arvdiffto. If arvsection is set, only that section will be diffed against this text.
+      #
+      # @param value [String]
+      # @return [self]
+      def difftotext(value)
+        merge(arvdifftotext: value.to_s)
+      end
+
+      # Perform a pre-save transform on the text before diffing it. Only valid when used with arvdifftotext.
+      #
+      # @return [self]
+      def difftotextpst()
+        merge(arvdifftotextpst: 'true')
+      end
+
+      # Serialization format used for arvdifftotext and expected for output of content.
+      #
+      # @param value [String] One of "application/json", "text/x-wiki", "text/javascript", "text/css", "text/plain".
+      # @return [self]
+      def contentformat(value)
+        _contentformat(value) or fail ArgumentError, "Unknown value for contentformat: #{value}"
+      end
+
+      # @private
+      def _contentformat(value)
+        defined?(super) && super || ["application/json", "text/x-wiki", "text/javascript", "text/css", "text/plain"].include?(value.to_s) && merge(arvcontentformat: value.to_s)
+      end
+
+      # Only list revisions by this user.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(arvuser: value.to_s)
+      end
+
+      # Only list pages in this namespace.
+      #
+      # @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(arvnamespace: value.to_s, replace: false)
+      end
+
+      # The timestamp to start enumerating from.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(arvstart: value.iso8601)
+      end
+
+      # The timestamp to stop enumerating at.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(arvend: value.iso8601)
+      end
+
+      # In which direction to enumerate:
+      #
+      # @param value [String] One of "newer" (List oldest first. Note: arvstart has to be before arvend), "older" (List newest first (default). Note: arvstart has to be later than arvend).
+      # @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(arvdir: value.to_s)
+      end
+
+      # Don't list revisions by this user.
+      #
+      # @param value [String]
+      # @return [self]
+      def excludeuser(value)
+        merge(arvexcludeuser: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(arvcontinue: value.to_s)
+      end
+
+      # When being used as a generator, generate titles rather than revision IDs.
+      #
+      # @return [self]
+      def generatetitles()
+        merge(arvgeneratetitles: 'true')
+      end
+    end
+  end
+end