mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Enumerates pages that have changes pending review. _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 GOldreviewedpages
+
+      # Start listing at this timestamp.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(gorstart: value.iso8601)
+      end
+
+      # Stop listing at this timestamp.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(gorend: value.iso8601)
+      end
+
+      # In which direction to enumerate:
+      #
+      # @param value [String] One of "newer" (List oldest first. Note: orstart has to be before orend), "older" (List newest first (default). Note: orstart has to be later than orend).
+      # @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(gordir: value.to_s)
+      end
+
+      # Maximum character count change size.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def maxsize(value)
+        merge(gormaxsize: value.to_s)
+      end
+
+      # How to filter for pages on your watchlist.
+      #
+      # @param value [String] One of "watched", "all".
+      # @return [self]
+      def filterwatched(value)
+        _filterwatched(value) or fail ArgumentError, "Unknown value for filterwatched: #{value}"
+      end
+
+      # @private
+      def _filterwatched(value)
+        defined?(super) && super || ["watched", "all"].include?(value.to_s) && merge(gorfilterwatched: value.to_s)
+      end
+
+      # The namespaces to enumerate.
+      #
+      # @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(gornamespace: value.to_s, replace: false)
+      end
+
+      # Show pages only in the given category.
+      #
+      # @param value [String]
+      # @return [self]
+      def category(value)
+        merge(gorcategory: value.to_s)
+      end
+
+      # How to filter for redirects.
+      #
+      # @param value [String] One of "redirects", "nonredirects", "all".
+      # @return [self]
+      def filterredir(value)
+        _filterredir(value) or fail ArgumentError, "Unknown value for filterredir: #{value}"
+      end
+
+      # @private
+      def _filterredir(value)
+        defined?(super) && super || ["redirects", "nonredirects", "all"].include?(value.to_s) && merge(gorfilterredir: value.to_s)
+      end
+
+      # How many total pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gorlimit: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all pages using a given page property. _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 GPageswithprop
+
+      # Page property for which to enumerate pages (action=query&list=pagepropnames returns page property names in use).
+      #
+      # @param value [String]
+      # @return [self]
+      def propname(value)
+        merge(gpwppropname: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(gpwpcontinue: value.to_s)
+      end
+
+      # The maximum number of pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gpwplimit: value.to_s)
+      end
+
+      # In which direction to sort.
+      #
+      # @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(gpwpdir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Perform a prefix search for page titles. _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 GPrefixsearch
+
+      # Search string.
+      #
+      # @param value [String]
+      # @return [self]
+      def search(value)
+        merge(gpssearch: value.to_s)
+      end
+
+      # Namespaces to search.
+      #
+      # @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(gpsnamespace: value.to_s, replace: false)
+      end
+
+      # Maximum number of results to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gpslimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def offset(value)
+        merge(gpsoffset: value.to_s)
+      end
+
+      # Search profile to use.
+      #
+      # @param value [String] One of "strict" (Strict profile with few punctuation characters removed but diacritics and stress marks are kept), "normal" (Few punctuation characters, some diacritics and stopwords removed), "fuzzy" (Similar to normal with typo correction (two typos supported)), "fast-fuzzy" (Experimental fuzzy profile (may be removed at any time)), "classic" (Classic prefix, few punctuation characters and some diacritics removed).
+      # @return [self]
+      def profile(value)
+        _profile(value) or fail ArgumentError, "Unknown value for profile: #{value}"
+      end
+
+      # @private
+      def _profile(value)
+        defined?(super) && super || ["strict", "normal", "fuzzy", "fast-fuzzy", "classic"].include?(value.to_s) && merge(gpsprofile: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all pages associated with one or more projects. _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 GProjectpages
+
+      # Also return assessments for the pages returned.
+      #
+      # @return [self]
+      def assessments()
+        merge(gwppassessments: 'true')
+      end
+
+      # The projects to list pages for. If this parameter is omitted, all projects will be included.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def projects(*values)
+        values.inject(self) { |res, val| res._projects(val) }
+      end
+
+      # @private
+      def _projects(value)
+        merge(gwppprojects: value.to_s, replace: false)
+      end
+
+      # The maximum number of pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gwpplimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(gwppcontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all titles protected from creation. _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 GProtectedtitles
+
+      # Only list titles in these namespaces.
+      #
+      # @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(gptnamespace: value.to_s, replace: false)
+      end
+
+      # Only list titles with these protection levels.
+      #
+      # @param values [Array<String>] Allowed values: "autoconfirmed", "extendedconfirmed", "templateeditor", "sysop".
+      # @return [self]
+      def level(*values)
+        values.inject(self) { |res, val| res._level(val) or fail ArgumentError, "Unknown value for level: #{val}" }
+      end
+
+      # @private
+      def _level(value)
+        defined?(super) && super || ["autoconfirmed", "extendedconfirmed", "templateeditor", "sysop"].include?(value.to_s) && merge(gptlevel: value.to_s, replace: false)
+      end
+
+      # How many total pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gptlimit: value.to_s)
+      end
+
+      # In which direction to enumerate:
+      #
+      # @param value [String] One of "newer" (List oldest first. Note: ptstart has to be before ptend), "older" (List newest first (default). Note: ptstart has to be later than ptend).
+      # @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(gptdir: value.to_s)
+      end
+
+      # Start listing at this protection timestamp.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(gptstart: value.iso8601)
+      end
+
+      # Stop listing at this protection timestamp.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(gptend: value.iso8601)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(gptcontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get a list provided by a QueryPage-based special page. _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 GQuerypage
+
+      # The name of the special page. Note, this is case sensitive.
+      #
+      # @param value [String] One of "Ancientpages", "BrokenRedirects", "Deadendpages", "DoubleRedirects", "ListDuplicatedFiles", "Listredirects", "Lonelypages", "Longpages", "MediaStatistics", "Mostcategories", "Mostimages", "Mostinterwikis", "Mostlinkedcategories", "Mostlinkedtemplates", "Mostlinked", "Mostrevisions", "Fewestrevisions", "Shortpages", "Uncategorizedcategories", "Uncategorizedpages", "Uncategorizedimages", "Uncategorizedtemplates", "Unusedcategories", "Unusedimages", "Wantedcategories", "Wantedfiles", "Wantedpages", "Wantedtemplates", "Unwatchedpages", "Unusedtemplates", "Withoutinterwiki", "UnconnectedPages", "PagesWithBadges", "EntityUsage", "GadgetUsage", "MostGloballyLinkedFiles", "GloballyWantedFiles", "DisambiguationPages", "DisambiguationPageLinks".
+      # @return [self]
+      def page(value)
+        _page(value) or fail ArgumentError, "Unknown value for page: #{value}"
+      end
+
+      # @private
+      def _page(value)
+        defined?(super) && super || ["Ancientpages", "BrokenRedirects", "Deadendpages", "DoubleRedirects", "ListDuplicatedFiles", "Listredirects", "Lonelypages", "Longpages", "MediaStatistics", "Mostcategories", "Mostimages", "Mostinterwikis", "Mostlinkedcategories", "Mostlinkedtemplates", "Mostlinked", "Mostrevisions", "Fewestrevisions", "Shortpages", "Uncategorizedcategories", "Uncategorizedpages", "Uncategorizedimages", "Uncategorizedtemplates", "Unusedcategories", "Unusedimages", "Wantedcategories", "Wantedfiles", "Wantedpages", "Wantedtemplates", "Unwatchedpages", "Unusedtemplates", "Withoutinterwiki", "UnconnectedPages", "PagesWithBadges", "EntityUsage", "GadgetUsage", "MostGloballyLinkedFiles", "GloballyWantedFiles", "DisambiguationPages", "DisambiguationPageLinks"].include?(value.to_s) && merge(gqppage: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def offset(value)
+        merge(gqpoffset: value.to_s)
+      end
+
+      # Number of results to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gqplimit: value.to_s)
+      end
+    end
+  end
+end