mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all blocked users and IP addresses.
+    #
+    # 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 Blocks
+
+      # The timestamp to start enumerating from.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(bkstart: value.iso8601)
+      end
+
+      # The timestamp to stop enumerating at.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(bkend: value.iso8601)
+      end
+
+      # In which direction to enumerate:
+      #
+      # @param value [String] One of "newer" (List oldest first. Note: bkstart has to be before bkend), "older" (List newest first (default). Note: bkstart has to be later than bkend).
+      # @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(bkdir: value.to_s)
+      end
+
+      # List of block IDs to list (optional).
+      #
+      # @param values [Array<Integer>]
+      # @return [self]
+      def ids(*values)
+        values.inject(self) { |res, val| res._ids(val) }
+      end
+
+      # @private
+      def _ids(value)
+        merge(bkids: value.to_s, replace: false)
+      end
+
+      # List of users to search for (optional).
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def users(*values)
+        values.inject(self) { |res, val| res._users(val) }
+      end
+
+      # @private
+      def _users(value)
+        merge(bkusers: value.to_s, replace: false)
+      end
+
+      # Get all blocks applying to this IP address or CIDR range, including range blocks. Cannot be used together with bkusers. CIDR ranges broader than IPv4/16 or IPv6/19 are not accepted.
+      #
+      # @param value [String]
+      # @return [self]
+      def ip(value)
+        merge(bkip: value.to_s)
+      end
+
+      # The maximum number of blocks to list.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(bklimit: value.to_s)
+      end
+
+      # Which properties to get:
+      #
+      # @param values [Array<String>] Allowed values: "id" (Adds the ID of the block), "user" (Adds the username of the blocked user), "userid" (Adds the user ID of the blocked user), "by" (Adds the username of the blocking user), "byid" (Adds the user ID of the blocking user), "timestamp" (Adds the timestamp of when the block was given), "expiry" (Adds the timestamp of when the block expires), "reason" (Adds the reason given for the block), "range" (Adds the range of IP addresses affected by the block), "flags" (Tags the ban with (autoblock, anononly, etc.)).
+      # @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 || ["id", "user", "userid", "by", "byid", "timestamp", "expiry", "reason", "range", "flags"].include?(value.to_s) && merge(bkprop: value.to_s, replace: false)
+      end
+
+      # Show only items that meet these criteria. For example, to see only indefinite blocks on IP addresses, set bkshow=ip|!temp.
+      #
+      # @param values [Array<String>] Allowed values: "account", "!account", "temp", "!temp", "ip", "!ip", "range", "!range".
+      # @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 || ["account", "!account", "temp", "!temp", "ip", "!ip", "range", "!range"].include?(value.to_s) && merge(bkshow: value.to_s, replace: false)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(bkcontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all categories the pages belong to.
+    #
+    # 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 Categories
+
+      # Which additional properties to get for each category:
+      #
+      # @param values [Array<String>] Allowed values: "sortkey" (Adds the sortkey (hexadecimal string) and sortkey prefix (human-readable part) for the category), "timestamp" (Adds timestamp of when the category was added), "hidden" (Tags categories that are hidden with __HIDDENCAT__).
+      # @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 || ["sortkey", "timestamp", "hidden"].include?(value.to_s) && merge(clprop: value.to_s, replace: false)
+      end
+
+      # 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(clshow: value.to_s, replace: false)
+      end
+
+      # How many categories to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(cllimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(clcontinue: 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(clcategories: 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(cldir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns information about the given categories.
+    #
+    # 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 Categoryinfo
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(cicontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # List all pages in a given category.
+    #
+    # 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 Categorymembers
+
+      # 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(cmtitle: 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(cmpageid: 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), "sortkey" (Adds the sortkey used for sorting in the category (hexadecimal string)), "sortkeyprefix" (Adds the sortkey prefix used for sorting in the category (human-readable part of the sortkey)), "type" (Adds the type that the page has been categorised as (page, subcat or file)), "timestamp" (Adds the timestamp of when the page was included).
+      # @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", "sortkey", "sortkeyprefix", "type", "timestamp"].include?(value.to_s) && merge(cmprop: value.to_s, replace: false)
+      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(cmnamespace: 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(cmtype: value.to_s, replace: false)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(cmcontinue: value.to_s)
+      end
+
+      # The maximum number of pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(cmlimit: 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(cmsort: 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(cmdir: 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(cmstart: value.iso8601)
+      end
+
+      # Timestamp to end listing at. Can only be used with cmsort=timestamp.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(cmend: 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(cmstarthexsortkey: 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(cmendhexsortkey: 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(cmstartsortkeyprefix: 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(cmendsortkeyprefix: value.to_s)
+      end
+
+      # Use cmstarthexsortkey instead.
+      #
+      # @param value [String]
+      # @return [self]
+      def startsortkey(value)
+        merge(cmstartsortkey: value.to_s)
+      end
+
+      # Use cmendhexsortkey instead.
+      #
+      # @param value [String]
+      # @return [self]
+      def endsortkey(value)
+        merge(cmendsortkey: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get a log of campaign configuration changes.
+    #
+    # 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 Centralnoticelogs
+
+      # Campaign name (optional). Separate multiple values with a "|" (vertical bar).
+      #
+      # @param value [String]
+      # @return [self]
+      def campaign(value)
+        merge(campaign: value.to_s)
+      end
+
+      # Username (optional).
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(user: value.to_s)
+      end
+
+      # Maximum rows to return (optional).
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(limit: value.to_s)
+      end
+
+      # Offset into result set (optional).
+      #
+      # @param value [Integer]
+      # @return [self]
+      def offset(value)
+        merge(offset: value.to_s)
+      end
+
+      # Start time of range (optional).
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(start: value.iso8601)
+      end
+
+      # End time of range (optional).
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(end: value.iso8601)
+      end
+    end
+  end
+end