mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Check which IP addresses are used by a given username or which usernames are used by a given IP address.
+    #
+    # 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 Checkuser
+
+      # Type of CheckUser request:
+      #
+      # @param value [String] One of "userips" (Get IP address of target user), "edits" (Get changes from target IP address or range), "ipusers" (Get users from target IP address or range).
+      # @return [self]
+      def request(value)
+        _request(value) or fail ArgumentError, "Unknown value for request: #{value}"
+      end
+
+      # @private
+      def _request(value)
+        defined?(super) && super || ["userips", "edits", "ipusers"].include?(value.to_s) && merge(curequest: value.to_s)
+      end
+
+      # Username, IP address, or CIDR range to check.
+      #
+      # @param value [String]
+      # @return [self]
+      def target(value)
+        merge(cutarget: value.to_s)
+      end
+
+      # Reason to check.
+      #
+      # @param value [String]
+      # @return [self]
+      def reason(value)
+        merge(cureason: value.to_s)
+      end
+
+      # Limit of rows.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(culimit: value.to_s)
+      end
+
+      # Time limit of user data (like "-2 weeks" or "2 weeks ago").
+      #
+      # @param value [String]
+      # @return [self]
+      def timecond(value)
+        merge(cutimecond: value.to_s)
+      end
+
+      # Use XFF data instead of IP address.
+      #
+      # @param value [String]
+      # @return [self]
+      def xff(value)
+        merge(cuxff: value.to_s)
+      end
+
+      # A "csrf" token retrieved from action=query&meta=tokens
+      #
+      # @param value [String]
+      # @return [self]
+      def token(value)
+        merge(cutoken: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get entries from the CheckUser log.
+    #
+    # 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 Checkuserlog
+
+      # Username of the CheckUser.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(culuser: value.to_s)
+      end
+
+      # Checked user, IP address, or CIDR range.
+      #
+      # @param value [String]
+      # @return [self]
+      def target(value)
+        merge(cultarget: value.to_s)
+      end
+
+      # Limit of rows.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(cullimit: value.to_s)
+      end
+
+      # In which direction to enumerate:
+      #
+      # @param value [String] One of "newer" (List oldest first. Note: culstart has to be before culend), "older" (List newest first (default). Note: culstart has to be later than culend).
+      # @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(culdir: value.to_s)
+      end
+
+      # The timestamp to start enumerating from.
+      #
+      # @param value [Time]
+      # @return [self]
+      def from(value)
+        merge(culfrom: value.iso8601)
+      end
+
+      # The timestamp to end enumerating.
+      #
+      # @param value [Time]
+      # @return [self]
+      def to(value)
+        merge(culto: value.iso8601)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(culcontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Query Content Translation database for translations.
+    #
+    # 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 Contenttranslation
+
+      # Translation ID.
+      #
+      # @param value [String]
+      # @return [self]
+      def translationid(value)
+        merge(translationid: value.to_s)
+      end
+
+      # The source language code.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(from: value.to_s)
+      end
+
+      # The target language code.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(to: value.to_s)
+      end
+
+      # The title of the source page.
+      #
+      # @param value [String]
+      # @return [self]
+      def sourcetitle(value)
+        merge(sourcetitle: value.to_s)
+      end
+
+      # The maximum number of translations to fetch.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(limit: value.to_s)
+      end
+
+      # Offset into result set (optional).
+      #
+      # @param value [String]
+      # @return [self]
+      def offset(value)
+        merge(offset: 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(type: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get the section-aligned parallel text for a given translation. See also list=cxpublishedtranslations. Dumps are provided in different formats for high volume access.
+    #
+    # 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 Contenttranslationcorpora
+
+      # ID of the translation.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def translationid(value)
+        merge(translationid: value.to_s)
+      end
+
+      # Whether to strip all HTML tags to return plaintext.
+      #
+      # @return [self]
+      def striphtml()
+        merge(striphtml: 'true')
+      end
+
+      # By default you will get all three of following if available: source text, machine translation and the postedited translation by the user. This parameter allows you not return some of these types.
+      #
+      # @param values [Array<String>] Allowed values: "source", "mt", "user".
+      # @return [self]
+      def types(*values)
+        values.inject(self) { |res, val| res._types(val) or fail ArgumentError, "Unknown value for types: #{val}" }
+      end
+
+      # @private
+      def _types(value)
+        defined?(super) && super || ["source", "mt", "user"].include?(value.to_s) && merge(types: value.to_s, replace: false)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Query Content Translation database for numbers of translations by period of time.
+    #
+    # 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 Contenttranslationlangtrend
+
+      # The source language code.
+      #
+      # @param value [String]
+      # @return [self]
+      def source(value)
+        merge(source: value.to_s)
+      end
+
+      # The target language code.
+      #
+      # @param value [String]
+      # @return [self]
+      def target(value)
+        merge(target: value.to_s)
+      end
+
+      # The interval for calculating the trend. Can be week or month.
+      #
+      # @param value [String] One of "week", "month".
+      # @return [self]
+      def interval(value)
+        _interval(value) or fail ArgumentError, "Unknown value for interval: #{value}"
+      end
+
+      # @private
+      def _interval(value)
+        defined?(super) && super || ["week", "month"].include?(value.to_s) && merge(interval: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get Content Translation statistics.
+    #
+    # 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 Contenttranslationstats
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get suggestion lists for Content Translation.
+    #
+    # 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 Contenttranslationsuggestions
+
+      # The source language code.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(from: value.to_s)
+      end
+
+      # The target language code.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(to: value.to_s)
+      end
+
+      # Return suggestions only from a particular list
+      #
+      # @param value [String]
+      # @return [self]
+      def listid(value)
+        merge(listid: value.to_s)
+      end
+
+      # The maximum number of translation suggestions to fetch.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(limit: value.to_s)
+      end
+
+      # Offset for paginated results.
+      #
+      # @param value [String]
+      # @return [self]
+      def offset(value)
+        merge(offset: 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(seed: value.to_s)
+      end
+    end
+  end
+end