mediawiktory 0.0.3 → 0.1.0

data/lib/mediawiktory/wikipedia/actions/cirrus-settings-dump.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Dump of CirrusSearch settings for this wiki.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.cirrus-settings-dump.perform # returns string with raw output
+    # # or
+    # api.cirrus-settings-dump.response # returns output parsed and wrapped into Mash-like object
+    # ```
+    #
+    # This action has no parameters.
+    #
+    # 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 CirrusSettingsDump < MediaWiktory::Wikipedia::Actions::Get
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Clears the hasmsg flag for the current user.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.clearhasmsg.perform # returns string with raw output
+    # # or
+    # api.clearhasmsg.response # returns output parsed and wrapped into Mash-like object
+    # ```
+    #
+    # This action has no parameters.
+    #
+    # 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 Clearhasmsg < MediaWiktory::Wikipedia::Actions::Post
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Log in to the wiki using the interactive flow.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.clientlogin.requests(value).perform # returns string with raw output
+    # # or
+    # api.clientlogin.requests(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 Clientlogin < MediaWiktory::Wikipedia::Actions::Post
+
+      # Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=login or from a previous response from this module.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def requests(*values)
+        values.inject(self) { |res, val| res._requests(val) }
+      end
+
+      # @private
+      def _requests(value)
+        merge(loginrequests: value.to_s, replace: false)
+      end
+
+      # Format to use for returning messages.
+      #
+      # @param value [String] One of "html", "wikitext", "raw", "none".
+      # @return [self]
+      def messageformat(value)
+        _messageformat(value) or fail ArgumentError, "Unknown value for messageformat: #{value}"
+      end
+
+      # @private
+      def _messageformat(value)
+        defined?(super) && super || ["html", "wikitext", "raw", "none"].include?(value.to_s) && merge(loginmessageformat: value.to_s)
+      end
+
+      # Merge field information for all authentication requests into one array.
+      #
+      # @return [self]
+      def mergerequestfields()
+        merge(loginmergerequestfields: 'true')
+      end
+
+      # Preserve state from a previous failed login attempt, if possible.
+      #
+      # @return [self]
+      def preservestate()
+        merge(loginpreservestate: 'true')
+      end
+
+      # Return URL for third-party authentication flows, must be absolute. Either this or logincontinue is required.
+      #
+      # @param value [String]
+      # @return [self]
+      def returnurl(value)
+        merge(loginreturnurl: value.to_s)
+      end
+
+      # This request is a continuation after an earlier UI or REDIRECT response. Either this or loginreturnurl is required.
+      #
+      # @return [self]
+      def continue()
+        merge(logincontinue: 'true')
+      end
+
+      # A "login" token retrieved from action=query&meta=tokens
+      #
+      # @param value [String]
+      # @return [self]
+      def token(value)
+        merge(logintoken: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Get the difference between 2 pages.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.compare.fromtitle(value).perform # returns string with raw output
+    # # or
+    # api.compare.fromtitle(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 Compare < MediaWiktory::Wikipedia::Actions::Get
+
+      # First title to compare.
+      #
+      # @param value [String]
+      # @return [self]
+      def fromtitle(value)
+        merge(fromtitle: value.to_s)
+      end
+
+      # First page ID to compare.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def fromid(value)
+        merge(fromid: value.to_s)
+      end
+
+      # First revision to compare.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def fromrev(value)
+        merge(fromrev: value.to_s)
+      end
+
+      # Second title to compare.
+      #
+      # @param value [String]
+      # @return [self]
+      def totitle(value)
+        merge(totitle: value.to_s)
+      end
+
+      # Second page ID to compare.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def toid(value)
+        merge(toid: value.to_s)
+      end
+
+      # Second revision to compare.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def torev(value)
+        merge(torev: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Create a new user account.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.createaccount.requests(value).perform # returns string with raw output
+    # # or
+    # api.createaccount.requests(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 Createaccount < MediaWiktory::Wikipedia::Actions::Post
+
+      # Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=create or from a previous response from this module.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def requests(*values)
+        values.inject(self) { |res, val| res._requests(val) }
+      end
+
+      # @private
+      def _requests(value)
+        merge(createrequests: value.to_s, replace: false)
+      end
+
+      # Format to use for returning messages.
+      #
+      # @param value [String] One of "html", "wikitext", "raw", "none".
+      # @return [self]
+      def messageformat(value)
+        _messageformat(value) or fail ArgumentError, "Unknown value for messageformat: #{value}"
+      end
+
+      # @private
+      def _messageformat(value)
+        defined?(super) && super || ["html", "wikitext", "raw", "none"].include?(value.to_s) && merge(createmessageformat: value.to_s)
+      end
+
+      # Merge field information for all authentication requests into one array.
+      #
+      # @return [self]
+      def mergerequestfields()
+        merge(createmergerequestfields: 'true')
+      end
+
+      # Preserve state from a previous failed login attempt, if possible.
+      #
+      # @return [self]
+      def preservestate()
+        merge(createpreservestate: 'true')
+      end
+
+      # Return URL for third-party authentication flows, must be absolute. Either this or createcontinue is required.
+      #
+      # @param value [String]
+      # @return [self]
+      def returnurl(value)
+        merge(createreturnurl: value.to_s)
+      end
+
+      # This request is a continuation after an earlier UI or REDIRECT response. Either this or createreturnurl is required.
+      #
+      # @return [self]
+      def continue()
+        merge(createcontinue: 'true')
+      end
+
+      # A "createaccount" token retrieved from action=query&meta=tokens
+      #
+      # @param value [String]
+      # @return [self]
+      def token(value)
+        merge(createtoken: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.cspreport.reportonly(value).perform # returns string with raw output
+    # # or
+    # api.cspreport.reportonly(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 Cspreport < MediaWiktory::Wikipedia::Actions::Post
+
+      # Mark as being a report from a monitoring policy, not an enforced policy
+      #
+      # @return [self]
+      def reportonly()
+        merge(reportonly: 'true')
+      end
+
+      # What generated the CSP header that triggered this report
+      #
+      # @param value [String]
+      # @return [self]
+      def source(value)
+        merge(source: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Fetch the Content Translation configuration json for the given language pair.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.cxconfiguration.from(value).perform # returns string with raw output
+    # # or
+    # api.cxconfiguration.from(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 Cxconfiguration < MediaWiktory::Wikipedia::Actions::Get
+
+      # 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
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Delete a draft translation created using the Content Translation extension.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.cxdelete.from(value).perform # returns string with raw output
+    # # or
+    # api.cxdelete.from(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 Cxdelete < MediaWiktory::Wikipedia::Actions::Post
+
+      # 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
+
+      # 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/cxpublish.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Save a page created using the Content Translation extension.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.cxpublish.title(value).perform # returns string with raw output
+    # # or
+    # api.cxpublish.title(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 Cxpublish < MediaWiktory::Wikipedia::Actions::Post
+
+      # The title of the page to perform actions on.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(title: value.to_s)
+      end
+
+      # The content to save.
+      #
+      # @param value [String]
+      # @return [self]
+      def html(value)
+        merge(html: 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 categories to put the published page in.
+      #
+      # @param value [String]
+      # @return [self]
+      def categories(value)
+        merge(categories: value.to_s)
+      end
+
+      # Captcha ID (when saving with a captcha response).
+      #
+      # @param value [String]
+      # @return [self]
+      def wpCaptchaId(value)
+        merge(wpCaptchaId: value.to_s)
+      end
+
+      # Answer to the captcha (when saving with a captcha response).
+      #
+      # @param value [String]
+      # @return [self]
+      def wpCaptchaWord(value)
+        merge(wpCaptchaWord: 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