mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns all files contained on the given pages. _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 GImages
+
+      # How many files to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gimlimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(gimcontinue: 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(gimimages: 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(gimdir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Find all pages that use the given image title. _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 GImageusage
+
+      # Title to search. Cannot be used together with iupageid.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(giutitle: value.to_s)
+      end
+
+      # Page ID to search. Cannot be used together with iutitle.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def pageid(value)
+        merge(giupageid: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(giucontinue: value.to_s)
+      end
+
+      # The namespace 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(giunamespace: 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(giudir: value.to_s)
+      end
+
+      # How to filter for redirects. If set to nonredirects when iuredirect is enabled, this is only applied to the second level.
+      #
+      # @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(giufilterredir: value.to_s)
+      end
+
+      # How many total pages to return. If iuredirect is enabled, the limit applies to each level separately (which means up to 2 * iulimit results may be returned).
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(giulimit: value.to_s)
+      end
+
+      # If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.
+      #
+      # @return [self]
+      def redirect()
+        merge(giuredirect: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Find all pages that link to the given interwiki link. _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 GIwbacklinks
+
+      # Prefix for the interwiki.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(giwblprefix: value.to_s)
+      end
+
+      # Interwiki link to search for. Must be used with iwblblprefix.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(giwbltitle: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(giwblcontinue: value.to_s)
+      end
+
+      # How many total pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(giwbllimit: 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(giwbldir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Find all pages that link to the given language link. _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 GLangbacklinks
+
+      # Language for the language link.
+      #
+      # @param value [String]
+      # @return [self]
+      def lang(value)
+        merge(glbllang: value.to_s)
+      end
+
+      # Language link to search for. Must be used with lbllang.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(glbltitle: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(glblcontinue: value.to_s)
+      end
+
+      # How many total pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(glbllimit: 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(glbldir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns all links from the given pages. _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 GLinks
+
+      # Show links in these namespaces only.
+      #
+      # @param values [Array<String>] Allowed values: "-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(*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 || ["-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(gplnamespace: value.to_s, replace: false)
+      end
+
+      # How many links to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gpllimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(gplcontinue: value.to_s)
+      end
+
+      # Only list links to these titles. Useful for checking whether a certain page links to a certain title.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def titles(*values)
+        values.inject(self) { |res, val| res._titles(val) }
+      end
+
+      # @private
+      def _titles(value)
+        merge(gpltitles: 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(gpldir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Find all pages that link to the given pages. _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 GLinkshere
+
+      # Only include pages 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(glhnamespace: value.to_s, replace: false)
+      end
+
+      # Show only items that meet these criteria:
+      #
+      # @param values [Array<String>] Allowed values: "redirect" (Only show redirects), "!redirect" (Only show non-redirects).
+      # @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 || ["redirect", "!redirect"].include?(value.to_s) && merge(glhshow: value.to_s, replace: false)
+      end
+
+      # How many to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(glhlimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(glhcontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Lists the most viewed pages (based on last day's pageview count). _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 GMostviewed
+
+      # The metric to use for counting views. Depending on what backend is used, not all metrics might be supported. You can use the siteinfo API (action=query&meta=siteinfo) to check, under pageviewservice-supported-metrics / <module name>
+      #
+      # @param value [String] One of "pageviews" (Plain pageviews).
+      # @return [self]
+      def metric(value)
+        _metric(value) or fail ArgumentError, "Unknown value for metric: #{value}"
+      end
+
+      # @private
+      def _metric(value)
+        defined?(super) && super || ["pageviews"].include?(value.to_s) && merge(gpvimmetric: value.to_s)
+      end
+
+      # The number of pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(gpvimlimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def offset(value)
+        merge(gpvimoffset: value.to_s)
+      end
+    end
+  end
+end