mediawiktory 0.0.3 → 0.1.0

data/lib/mediawiktory/wikipedia/actions/oathvalidate.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Validate a two-factor authentication (OATH) token.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.oathvalidate.user(value).perform # returns string with raw output
+    # # or
+    # api.oathvalidate.user(value).response # returns output parsed and wrapped into Response object
+    # ```
+    #
+    # See {Base} for generic explanation of working with MediaWiki actions and
+    # {MediaWiktory::Wikipedia::Response} for working with action responses.
+    #
+    # All action's parameters are documented as its public methods, see below.
+    #
+    class Oathvalidate < MediaWiktory::Wikipedia::Actions::Post
+
+      # User to validate token for. Defaults to the current user.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(user: value.to_s)
+      end
+
+      # Two-factor authentication (OATH) token.
+      #
+      # @param value [String]
+      # @return [self]
+      def totp(value)
+        merge(totp: value.to_s)
+      end
+
+      # A "csrf" token retrieved from action=query&meta=tokens
+      #
+      # @param value [String]
+      # @return [self]
+      def token(value)
+        merge(token: value.to_s)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/actions/opensearch.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Search the wiki using the OpenSearch protocol.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.opensearch.search(value).perform # returns string with raw output
+    # # or
+    # api.opensearch.search(value).response # returns output parsed and wrapped into Response object
+    # ```
+    #
+    # See {Base} for generic explanation of working with MediaWiki actions and
+    # {MediaWiktory::Wikipedia::Response} for working with action responses.
+    #
+    # All action's parameters are documented as its public methods, see below.
+    #
+    class Opensearch < MediaWiktory::Wikipedia::Actions::Get
+
+      # Search string.
+      #
+      # @param value [String]
+      # @return [self]
+      def search(value)
+        merge(search: 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(namespace: value.to_s, replace: false)
+      end
+
+      # Maximum number of results to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(limit: 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(profile: value.to_s)
+      end
+
+      # Do nothing if $wgEnableOpenSearchSuggest is false.
+      #
+      # @return [self]
+      def suggest()
+        merge(suggest: 'true')
+      end
+
+      # How to handle redirects:
+      #
+      # @param value [String] One of "return" (Return the redirect itself), "resolve" (Return the target page. May return fewer than limit results).
+      # @return [self]
+      def redirects(value)
+        _redirects(value) or fail ArgumentError, "Unknown value for redirects: #{value}"
+      end
+
+      # @private
+      def _redirects(value)
+        defined?(super) && super || ["return", "resolve"].include?(value.to_s) && merge(redirects: value.to_s)
+      end
+
+      # The format of the output.
+      #
+      # @param value [String] One of "json", "jsonfm", "xml", "xmlfm".
+      # @return [self]
+      def format(value)
+        _format(value) or fail ArgumentError, "Unknown value for format: #{value}"
+      end
+
+      # @private
+      def _format(value)
+        defined?(super) && super || ["json", "jsonfm", "xml", "xmlfm"].include?(value.to_s) && merge(format: value.to_s)
+      end
+
+      # If warnings are raised with format=json, return an API error instead of ignoring them.
+      #
+      # @return [self]
+      def warningsaserror()
+        merge(warningsaserror: 'true')
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/actions/options.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Change preferences of the current user.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.options.reset(value).perform # returns string with raw output
+    # # or
+    # api.options.reset(value).response # returns output parsed and wrapped into Response object
+    # ```
+    #
+    # See {Base} for generic explanation of working with MediaWiki actions and
+    # {MediaWiktory::Wikipedia::Response} for working with action responses.
+    #
+    # All action's parameters are documented as its public methods, see below.
+    #
+    class Options < MediaWiktory::Wikipedia::Actions::Post
+
+      # Resets preferences to the site defaults.
+      #
+      # @return [self]
+      def reset()
+        merge(reset: 'true')
+      end
+
+      # List of types of options to reset when the reset option is set.
+      #
+      # @param values [Array<String>] Allowed values: "registered", "registered-multiselect", "registered-checkmatrix", "userjs", "special", "unused", "all".
+      # @return [self]
+      def resetkinds(*values)
+        values.inject(self) { |res, val| res._resetkinds(val) or fail ArgumentError, "Unknown value for resetkinds: #{val}" }
+      end
+
+      # @private
+      def _resetkinds(value)
+        defined?(super) && super || ["registered", "registered-multiselect", "registered-checkmatrix", "userjs", "special", "unused", "all"].include?(value.to_s) && merge(resetkinds: value.to_s, replace: false)
+      end
+
+      # List of changes, formatted name=value (e.g. skin=vector). If no value is given (not even an equals sign), e.g., optionname|otheroption|..., the option will be reset to its default value. If any value passed contains the pipe character (|), use the alternative multiple-value separator for correct operation.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def change(*values)
+        values.inject(self) { |res, val| res._change(val) }
+      end
+
+      # @private
+      def _change(value)
+        merge(change: value.to_s, replace: false)
+      end
+
+      # The name of the option that should be set to the value given by optionvalue.
+      #
+      # @param value [String]
+      # @return [self]
+      def optionname(value)
+        merge(optionname: value.to_s)
+      end
+
+      # The value for the option specified by optionname.
+      #
+      # @param value [String]
+      # @return [self]
+      def optionvalue(value)
+        merge(optionvalue: value.to_s)
+      end
+
+      # A "csrf" token retrieved from action=query&meta=tokens
+      #
+      # @param value [String]
+      # @return [self]
+      def token(value)
+        merge(token: value.to_s)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/actions/pagetriageaction.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Mark an article as reviewed or unreviewed.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.pagetriageaction.pageid(value).perform # returns string with raw output
+    # # or
+    # api.pagetriageaction.pageid(value).response # returns output parsed and wrapped into Response object
+    # ```
+    #
+    # See {Base} for generic explanation of working with MediaWiki actions and
+    # {MediaWiktory::Wikipedia::Response} for working with action responses.
+    #
+    # All action's parameters are documented as its public methods, see below.
+    #
+    class Pagetriageaction < MediaWiktory::Wikipedia::Actions::Post
+
+      # The article for which to be marked as reviewed or unreviewed.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def pageid(value)
+        merge(pageid: value.to_s)
+      end
+
+      # Whether the article is reviewed.
+      #
+      # @param value [String] One of "1", "0".
+      # @return [self]
+      def reviewed(value)
+        _reviewed(value) or fail ArgumentError, "Unknown value for reviewed: #{value}"
+      end
+
+      # @private
+      def _reviewed(value)
+        defined?(super) && super || ["1", "0"].include?(value.to_s) && merge(reviewed: value.to_s)
+      end
+
+      # A "csrf" token retrieved from action=query&meta=tokens
+      #
+      # @param value [String]
+      # @return [self]
+      def token(value)
+        merge(token: value.to_s)
+      end
+
+      # Personal note to page creators from reviewers.
+      #
+      # @param value [String]
+      # @return [self]
+      def note(value)
+        merge(note: value.to_s)
+      end
+
+      # Whether to skip notification.
+      #
+      # @return [self]
+      def skipnotif()
+        merge(skipnotif: 'true')
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/actions/pagetriagelist.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Get a list of page IDs for building a PageTriage queue.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.pagetriagelist.page_id(value).perform # returns string with raw output
+    # # or
+    # api.pagetriagelist.page_id(value).response # returns output parsed and wrapped into Response object
+    # ```
+    #
+    # See {Base} for generic explanation of working with MediaWiki actions and
+    # {MediaWiktory::Wikipedia::Response} for working with action responses.
+    #
+    # All action's parameters are documented as its public methods, see below.
+    #
+    class Pagetriagelist < MediaWiktory::Wikipedia::Actions::Get
+
+      # Return data for the specified page IDs, ignoring other parameters.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def page_id(value)
+        merge(page_id: value.to_s)
+      end
+
+      # Whether to show only bot edits.
+      #
+      # @return [self]
+      def showbots()
+        merge(showbots: 'true')
+      end
+
+      # Whether to include redirects.
+      #
+      # @return [self]
+      def showredirs()
+        merge(showredirs: 'true')
+      end
+
+      # Whether to include reviewed.
+      #
+      # @return [self]
+      def showreviewed()
+        merge(showreviewed: 'true')
+      end
+
+      # Whether to include unreviewed.
+      #
+      # @return [self]
+      def showunreviewed()
+        merge(showunreviewed: 'true')
+      end
+
+      # Whether to include "proposed for deleted".
+      #
+      # @return [self]
+      def showdeleted()
+        merge(showdeleted: 'true')
+      end
+
+      # The maximum number of results to return.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def limit(value)
+        merge(limit: value.to_s)
+      end
+
+      # Timestamp to start from.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def offset(value)
+        merge(offset: value.to_s)
+      end
+
+      # Page ID to start from (requires offset param to be passed as well).
+      #
+      # @param value [Integer]
+      # @return [self]
+      def pageoffset(value)
+        merge(pageoffset: value.to_s)
+      end
+
+      # The direction the list should be sorted in - oldestfirst or newestfirst.
+      #
+      # @param value [String]
+      # @return [self]
+      def dir(value)
+        merge(dir: value.to_s)
+      end
+
+      # What namespace to pull pages from.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def namespace(value)
+        merge(namespace: value.to_s)
+      end
+
+      # Whether to show only pages with no category.
+      #
+      # @return [self]
+      def no_category()
+        merge(no_category: 'true')
+      end
+
+      # Whether to show only pages with no inbound links.
+      #
+      # @return [self]
+      def no_inbound_links()
+        merge(no_inbound_links: 'true')
+      end
+
+      # Whether to show only pages created by non auto confirmed users.
+      #
+      # @return [self]
+      def non_autoconfirmed_users()
+        merge(non_autoconfirmed_users: 'true')
+      end
+
+      # Whether to show only pages created by blocked users.
+      #
+      # @return [self]
+      def blocked_users()
+        merge(blocked_users: 'true')
+      end
+
+      # Show only pages created by username.
+      #
+      # @param value [String]
+      # @return [self]
+      def username(value)
+        merge(username: value.to_s)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/actions/pagetriagestats.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Get the stats for page triage.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.pagetriagestats.namespace(value).perform # returns string with raw output
+    # # or
+    # api.pagetriagestats.namespace(value).response # returns output parsed and wrapped into Response object
+    # ```
+    #
+    # See {Base} for generic explanation of working with MediaWiki actions and
+    # {MediaWiktory::Wikipedia::Response} for working with action responses.
+    #
+    # All action's parameters are documented as its public methods, see below.
+    #
+    class Pagetriagestats < MediaWiktory::Wikipedia::Actions::Get
+
+      # What namespace to pull stats from.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def namespace(value)
+        merge(namespace: value.to_s)
+      end
+
+      # Whether to include redirects.
+      #
+      # @return [self]
+      def showredirs()
+        merge(showredirs: 'true')
+      end
+
+      # Whether to include reviewed.
+      #
+      # @return [self]
+      def showreviewed()
+        merge(showreviewed: 'true')
+      end
+
+      # Whether to include unreviewed.
+      #
+      # @return [self]
+      def showunreviewed()
+        merge(showunreviewed: 'true')
+      end
+
+      # Whether to include "proposed for deleted".
+      #
+      # @return [self]
+      def showdeleted()
+        merge(showdeleted: 'true')
+      end
+    end
+  end
+end