mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all categories the pages belong to. _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 GCategories
+
+      # Which kind of categories to show.
+      #
+      # @param values [Array<String>] Allowed values: "hidden", "!hidden".
+      # @return [self]
+      def show(*values)
+        values.inject(self) { |res, val| res._show(val) or fail ArgumentError, "Unknown value for show: #{val}" }
+      end
+
+      # @private
+      def _show(value)
+        defined?(super) && super || ["hidden", "!hidden"].include?(value.to_s) && merge(gclshow: value.to_s, replace: false)
+      end
+
+      # How many categories to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gcllimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(gclcontinue: value.to_s)
+      end
+
+      # Only list these categories. Useful for checking whether a certain page is in a certain category.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def categories(*values)
+        values.inject(self) { |res, val| res._categories(val) }
+      end
+
+      # @private
+      def _categories(value)
+        merge(gclcategories: 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(gcldir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all pages in a given category. _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 GCategorymembers
+
+      # Which category to enumerate (required). Must include the Category: prefix. Cannot be used together with cmpageid.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(gcmtitle: value.to_s)
+      end
+
+      # Page ID of the category to enumerate. Cannot be used together with cmtitle.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def pageid(value)
+        merge(gcmpageid: value.to_s)
+      end
+
+      # Only include pages in these namespaces. Note that cmtype=subcat or cmtype=file may be used instead of cmnamespace=14 or 6.
+      #
+      # @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(gcmnamespace: value.to_s, replace: false)
+      end
+
+      # Which type of category members to include. Ignored when cmsort=timestamp is set.
+      #
+      # @param values [Array<String>] Allowed values: "page", "subcat", "file".
+      # @return [self]
+      def type(*values)
+        values.inject(self) { |res, val| res._type(val) or fail ArgumentError, "Unknown value for type: #{val}" }
+      end
+
+      # @private
+      def _type(value)
+        defined?(super) && super || ["page", "subcat", "file"].include?(value.to_s) && merge(gcmtype: value.to_s, replace: false)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(gcmcontinue: value.to_s)
+      end
+
+      # The maximum number of pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gcmlimit: value.to_s)
+      end
+
+      # Property to sort by.
+      #
+      # @param value [String] One of "sortkey", "timestamp".
+      # @return [self]
+      def sort(value)
+        _sort(value) or fail ArgumentError, "Unknown value for sort: #{value}"
+      end
+
+      # @private
+      def _sort(value)
+        defined?(super) && super || ["sortkey", "timestamp"].include?(value.to_s) && merge(gcmsort: value.to_s)
+      end
+
+      # In which direction to sort.
+      #
+      # @param value [String] One of "asc", "desc", "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 || ["asc", "desc", "ascending", "descending", "newer", "older"].include?(value.to_s) && merge(gcmdir: value.to_s)
+      end
+
+      # Timestamp to start listing from. Can only be used with cmsort=timestamp.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(gcmstart: value.iso8601)
+      end
+
+      # Timestamp to end listing at. Can only be used with cmsort=timestamp.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(gcmend: value.iso8601)
+      end
+
+      # Sortkey to start listing from, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.
+      #
+      # @param value [String]
+      # @return [self]
+      def starthexsortkey(value)
+        merge(gcmstarthexsortkey: value.to_s)
+      end
+
+      # Sortkey to end listing at, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.
+      #
+      # @param value [String]
+      # @return [self]
+      def endhexsortkey(value)
+        merge(gcmendhexsortkey: value.to_s)
+      end
+
+      # Sortkey prefix to start listing from. Can only be used with cmsort=sortkey. Overrides cmstarthexsortkey.
+      #
+      # @param value [String]
+      # @return [self]
+      def startsortkeyprefix(value)
+        merge(gcmstartsortkeyprefix: value.to_s)
+      end
+
+      # Sortkey prefix to end listing before (not at; if this value occurs it will not be included!). Can only be used with cmsort=sortkey. Overrides cmendhexsortkey.
+      #
+      # @param value [String]
+      # @return [self]
+      def endsortkeyprefix(value)
+        merge(gcmendsortkeyprefix: value.to_s)
+      end
+
+      # Use cmstarthexsortkey instead.
+      #
+      # @param value [String]
+      # @return [self]
+      def startsortkey(value)
+        merge(gcmstartsortkey: value.to_s)
+      end
+
+      # Use cmendhexsortkey instead.
+      #
+      # @param value [String]
+      # @return [self]
+      def endsortkey(value)
+        merge(gcmendsortkey: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Query Content Translation database for translations. _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 GContenttranslation
+
+      # Translation ID.
+      #
+      # @param value [String]
+      # @return [self]
+      def translationid(value)
+        merge(gtranslationid: value.to_s)
+      end
+
+      # The source language code.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(gfrom: value.to_s)
+      end
+
+      # The target language code.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(gto: value.to_s)
+      end
+
+      # The title of the source page.
+      #
+      # @param value [String]
+      # @return [self]
+      def sourcetitle(value)
+        merge(gsourcetitle: value.to_s)
+      end
+
+      # The maximum number of translations to fetch.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(glimit: value.to_s)
+      end
+
+      # Offset into result set (optional).
+      #
+      # @param value [String]
+      # @return [self]
+      def offset(value)
+        merge(goffset: value.to_s)
+      end
+
+      # State of the translation.
+      #
+      # @param value [String] One of "draft", "published".
+      # @return [self]
+      def type(value)
+        _type(value) or fail ArgumentError, "Unknown value for type: #{value}"
+      end
+
+      # @private
+      def _type(value)
+        defined?(super) && super || ["draft", "published"].include?(value.to_s) && merge(gtype: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get suggestion lists for Content Translation. _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 GContenttranslationsuggestions
+
+      # The source language code.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(gfrom: value.to_s)
+      end
+
+      # The target language code.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(gto: value.to_s)
+      end
+
+      # Return suggestions only from a particular list
+      #
+      # @param value [String]
+      # @return [self]
+      def listid(value)
+        merge(glistid: value.to_s)
+      end
+
+      # The maximum number of translation suggestions to fetch.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(glimit: value.to_s)
+      end
+
+      # Offset for paginated results.
+      #
+      # @param value [String]
+      # @return [self]
+      def offset(value)
+        merge(goffset: value.to_s)
+      end
+
+      # By default suggestions are returned in random order. If you wish to return each suggestion only once when using limit and offset, you must specify a seed for all the requests.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def seed(value)
+        merge(gseed: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get deleted revision information. _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 GDeletedrevisions
+
+      # Limit how many revisions will be returned.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gdrvlimit: value.to_s)
+      end
+
+      # Expand templates in revision content (requires drvprop=content).
+      #
+      # @return [self]
+      def expandtemplates()
+        merge(gdrvexpandtemplates: 'true')
+      end
+
+      # Generate XML parse tree for revision content (requires drvprop=content; replaced by drvprop=parsetree).
+      #
+      # @return [self]
+      def generatexml()
+        merge(gdrvgeneratexml: 'true')
+      end
+
+      # Parse revision content (requires drvprop=content). For performance reasons, if this option is used, drvlimit is enforced to 1.
+      #
+      # @return [self]
+      def parse()
+        merge(gdrvparse: 'true')
+      end
+
+      # Only retrieve the content of this section number.
+      #
+      # @param value [String]
+      # @return [self]
+      def section(value)
+        merge(gdrvsection: 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(gdrvdiffto: value.to_s)
+      end
+
+      # Text to diff each revision to. Only diffs a limited number of revisions. Overrides drvdiffto. If drvsection is set, only that section will be diffed against this text.
+      #
+      # @param value [String]
+      # @return [self]
+      def difftotext(value)
+        merge(gdrvdifftotext: value.to_s)
+      end
+
+      # Perform a pre-save transform on the text before diffing it. Only valid when used with drvdifftotext.
+      #
+      # @return [self]
+      def difftotextpst()
+        merge(gdrvdifftotextpst: 'true')
+      end
+
+      # Serialization format used for drvdifftotext 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(gdrvcontentformat: value.to_s)
+      end
+
+      # The timestamp to start enumerating from. Ignored when processing a list of revision IDs.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(gdrvstart: value.iso8601)
+      end
+
+      # The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(gdrvend: value.iso8601)
+      end
+
+      # In which direction to enumerate:
+      #
+      # @param value [String] One of "newer" (List oldest first. Note: drvstart has to be before drvend), "older" (List newest first (default). Note: drvstart has to be later than drvend).
+      # @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(gdrvdir: value.to_s)
+      end
+
+      # Only list revisions tagged with this tag.
+      #
+      # @param value [String]
+      # @return [self]
+      def tag(value)
+        merge(gdrvtag: value.to_s)
+      end
+
+      # Only list revisions by this user.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(gdrvuser: value.to_s)
+      end
+
+      # Don't list revisions by this user.
+      #
+      # @param value [String]
+      # @return [self]
+      def excludeuser(value)
+        merge(gdrvexcludeuser: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(gdrvcontinue: value.to_s)
+      end
+    end
+  end
+end