mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Return ORES configuration and model data for this wiki.
+    #
+    # 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 Ores
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Return associated projects and assessments for the given pages.
+    #
+    # 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 Pageassessments
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(pacontinue: value.to_s)
+      end
+
+      # Limit for total number of projects returned (total for all pages).
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(palimit: value.to_s)
+      end
+
+      # Also return assessments by subprojects.
+      #
+      # @return [self]
+      def subprojects()
+        merge(pasubprojects: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns information about images on the page, such as thumbnail and presence of photos.
+    #
+    # 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 Pageimages
+
+      # Which information to return:
+      #
+      # @param values [Array<String>] Allowed values: "thumbnail" (URL and dimensions of thumbnail image associated with page, if any), "original" (URL and original dimensions of image associated with page, if any), "name" (Image title).
+      # @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 || ["thumbnail", "original", "name"].include?(value.to_s) && merge(piprop: value.to_s, replace: false)
+      end
+
+      # Maximum thumbnail dimension.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def thumbsize(value)
+        merge(pithumbsize: value.to_s)
+      end
+
+      # Properties of how many pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(pilimit: value.to_s)
+      end
+
+      # Limit page images to a certain license type
+      #
+      # @param value [String] One of "free", "any".
+      # @return [self]
+      def license(value)
+        _license(value) or fail ArgumentError, "Unknown value for license: #{value}"
+      end
+
+      # @private
+      def _license(value)
+        defined?(super) && super || ["free", "any"].include?(value.to_s) && merge(pilicense: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def continue(value)
+        merge(picontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all page property names in use on the wiki.
+    #
+    # 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 Pagepropnames
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(ppncontinue: value.to_s)
+      end
+
+      # The maximum number of names to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(ppnlimit: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get various page properties defined in the page content.
+    #
+    # 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 Pageprops
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(ppcontinue: value.to_s)
+      end
+
+      # Only list these page properties (action=query&list=pagepropnames returns page property names in use). Useful for checking whether pages use a certain page property.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def prop(*values)
+        values.inject(self) { |res, val| res._prop(val) }
+      end
+
+      # @private
+      def _prop(value)
+        merge(ppprop: value.to_s, replace: false)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all pages using a given page property.
+    #
+    # 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 Pageswithprop
+
+      # 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(pwppropname: value.to_s)
+      end
+
+      # Which pieces of information to include:
+      #
+      # @param values [Array<String>] Allowed values: "ids" (Adds the page ID), "title" (Adds the title and namespace ID of the page), "value" (Adds the value of the page property).
+      # @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", "value"].include?(value.to_s) && merge(pwpprop: value.to_s, replace: false)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(pwpcontinue: value.to_s)
+      end
+
+      # The maximum number of pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(pwplimit: 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(pwpdir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get terms associated with a page via an associated data item. On a wikibase entity page, the entity terms are used directly. Caveat: On a repo wiki, pageterms only works directly on entity pages, not on pages connected to an item. This may change in the future.
+    #
+    # 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 Pageterms
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def continue(value)
+        merge(wbptcontinue: value.to_s)
+      end
+
+      # The types of terms to get, e.g. 'description'. If not specified, all types are returned.
+      #
+      # @param values [Array<String>] Allowed values: "alias", "description", "label".
+      # @return [self]
+      def terms(*values)
+        values.inject(self) { |res, val| res._terms(val) or fail ArgumentError, "Unknown value for terms: #{val}" }
+      end
+
+      # @private
+      def _terms(value)
+        defined?(super) && super || ["alias", "description", "label"].include?(value.to_s) && merge(wbptterms: value.to_s, replace: false)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Shows per-page pageview data (the number of daily pageviews for each of the last pvipdays days). The result format is page title (with underscores) => date (Ymd) => count.
+    #
+    # 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 Pageviews
+
+      # 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(pvipmetric: value.to_s)
+      end
+
+      # The number of days to show.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def days(value)
+        merge(pvipdays: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(pvipcontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Output data in serialized PHP format.
+    #
+    # 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 Php
+
+      # Output formatting:
+      #
+      # @param value [String] One of "1" (Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.)), "2" (Experimental modern format. Details may change!), "latest" (Use the latest format (currently 2), may change without warning).
+      # @return [self]
+      def formatversion(value)
+        _formatversion(value) or fail ArgumentError, "Unknown value for formatversion: #{value}"
+      end
+
+      # @private
+      def _formatversion(value)
+        defined?(super) && super || ["1", "2", "latest"].include?(value.to_s) && merge(formatversion: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Output data in serialized PHP format (pretty-print in HTML).
+    #
+    # 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 Phpfm
+
+      # Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.
+      #
+      # @return [self]
+      def wrappedhtml()
+        merge(wrappedhtml: 'true')
+      end
+
+      # Output formatting:
+      #
+      # @param value [String] One of "1" (Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.)), "2" (Experimental modern format. Details may change!), "latest" (Use the latest format (currently 2), may change without warning).
+      # @return [self]
+      def formatversion(value)
+        _formatversion(value) or fail ArgumentError, "Unknown value for formatversion: #{value}"
+      end
+
+      # @private
+      def _formatversion(value)
+        defined?(super) && super || ["1", "2", "latest"].include?(value.to_s) && merge(formatversion: value.to_s)
+      end
+    end
+  end
+end