mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Log out and clear session data.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.logout.perform # returns string with raw output
+    # # or
+    # api.logout.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 Logout < MediaWiktory::Wikipedia::Actions::Get
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Perform management tasks relating to change tags.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.managetags.operation(value).perform # returns string with raw output
+    # # or
+    # api.managetags.operation(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 Managetags < MediaWiktory::Wikipedia::Actions::Post
+
+      # Which operation to perform:
+      #
+      # @param value [String] One of "create" (Create a new change tag for manual use), "delete" (Remove a change tag from the database, including removing the tag from all revisions, recent change entries and log entries on which it is used), "activate" (Activate a change tag, allowing users to apply it manually), "deactivate" (Deactivate a change tag, preventing users from applying it manually).
+      # @return [self]
+      def operation(value)
+        _operation(value) or fail ArgumentError, "Unknown value for operation: #{value}"
+      end
+
+      # @private
+      def _operation(value)
+        defined?(super) && super || ["create", "delete", "activate", "deactivate"].include?(value.to_s) && merge(operation: value.to_s)
+      end
+
+      # Tag to create, delete, activate or deactivate. For tag creation, the tag must not exist. For tag deletion, the tag must exist. For tag activation, the tag must exist and not be in use by an extension. For tag deactivation, the tag must be currently active and manually defined.
+      #
+      # @param value [String]
+      # @return [self]
+      def tag(value)
+        merge(tag: value.to_s)
+      end
+
+      # An optional reason for creating, deleting, activating or deactivating the tag.
+      #
+      # @param value [String]
+      # @return [self]
+      def reason(value)
+        merge(reason: value.to_s)
+      end
+
+      # Whether to ignore any warnings that are issued during the operation.
+      #
+      # @return [self]
+      def ignorewarnings()
+        merge(ignorewarnings: 'true')
+      end
+
+      # Change tags to apply to the entry in the tag management log.
+      #
+      # @param values [Array<String>] Allowed values: "ProveIt edit", "WPCleaner", "huggle", "large plot addition".
+      # @return [self]
+      def tags(*values)
+        values.inject(self) { |res, val| res._tags(val) or fail ArgumentError, "Unknown value for tags: #{val}" }
+      end
+
+      # @private
+      def _tags(value)
+        defined?(super) && super || ["ProveIt edit", "WPCleaner", "huggle", "large plot addition"].include?(value.to_s) && merge(tags: value.to_s, replace: false)
+      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/massmessage.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Send a message to a list of pages.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.massmessage.spamlist(value).perform # returns string with raw output
+    # # or
+    # api.massmessage.spamlist(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 Massmessage < MediaWiktory::Wikipedia::Actions::Post
+
+      # Page containing list of pages to leave a message on.
+      #
+      # @param value [String]
+      # @return [self]
+      def spamlist(value)
+        merge(spamlist: value.to_s)
+      end
+
+      # Subject line of the message.
+      #
+      # @param value [String]
+      # @return [self]
+      def subject(value)
+        merge(subject: value.to_s)
+      end
+
+      # Message body text.
+      #
+      # @param value [String]
+      # @return [self]
+      def message(value)
+        merge(message: 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/mergehistory.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Merge page histories.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.mergehistory.from(value).perform # returns string with raw output
+    # # or
+    # api.mergehistory.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 Mergehistory < MediaWiktory::Wikipedia::Actions::Post
+
+      # Title of the page from which history will be merged. Cannot be used together with fromid.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(from: value.to_s)
+      end
+
+      # Page ID of the page from which history will be merged. Cannot be used together with from.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def fromid(value)
+        merge(fromid: value.to_s)
+      end
+
+      # Title of the page to which history will be merged. Cannot be used together with toid.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(to: value.to_s)
+      end
+
+      # Page ID of the page to which history will be merged. Cannot be used together with to.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def toid(value)
+        merge(toid: value.to_s)
+      end
+
+      # Timestamp up to which revisions will be moved from the source page's history to the destination page's history. If omitted, the entire page history of the source page will be merged into the destination page.
+      #
+      # @param value [Time]
+      # @return [self]
+      def timestamp(value)
+        merge(timestamp: value.iso8601)
+      end
+
+      # Reason for the history merge.
+      #
+      # @param value [String]
+      # @return [self]
+      def reason(value)
+        merge(reason: 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/mobileview.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Returns data needed for mobile views.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.mobileview.page(value).perform # returns string with raw output
+    # # or
+    # api.mobileview.page(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 Mobileview < MediaWiktory::Wikipedia::Actions::Get
+
+      # Title of page to process.
+      #
+      # @param value [String]
+      # @return [self]
+      def page(value)
+        merge(page: value.to_s)
+      end
+
+      # Whether redirects should be followed.
+      #
+      # @param value [String] One of "yes", "no".
+      # @return [self]
+      def redirect(value)
+        _redirect(value) or fail ArgumentError, "Unknown value for redirect: #{value}"
+      end
+
+      # @private
+      def _redirect(value)
+        defined?(super) && super || ["yes", "no"].include?(value.to_s) && merge(redirect: value.to_s)
+      end
+
+      # Pipe-separated list of section numbers for which to return text. "all" can be used to return for all. Ranges in format "1-4" mean get sections 1,2,3,4. Ranges without second number, e.g. "1-" means get all until the end. "references" can be used to specify that all sections containing references should be returned.
+      #
+      # @param value [String]
+      # @return [self]
+      def sections(value)
+        merge(sections: value.to_s)
+      end
+
+      # Which information to get:
+      #
+      # @param values [Array<String>] Allowed values: "text" (HTML of selected sections), "sections" (Information about all sections on the page), "normalizedtitle" (Normalized page title), "lastmodified" (ISO 8601 timestamp for when the page was last modified, e.g. "2014-04-13T22:42:14Z"), "lastmodifiedby" (Information about the user who modified the page last), "revision" (Return the current revision ID of the page), "protection" (Information about protection level), "editable" (Whether the current user can edit this page. This includes all factors for logged-in users but not blocked status for anons), "languagecount" (Number of languages that the page is available in), "hasvariants" (Whether or not the page is available in other language variants), "displaytitle" (The rendered title of the page, with {{DISPLAYTITLE}} and such applied), "pageprops" (Page properties).
+      # @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 || ["text", "sections", "normalizedtitle", "lastmodified", "lastmodifiedby", "revision", "protection", "editable", "languagecount", "hasvariants", "displaytitle", "pageprops"].include?(value.to_s) && merge(prop: value.to_s, replace: false)
+      end
+
+      # What information about sections to get.
+      #
+      # @param values [Array<String>] Allowed values: "toclevel", "level", "line", "number", "index", "fromtitle", "anchor".
+      # @return [self]
+      def sectionprop(*values)
+        values.inject(self) { |res, val| res._sectionprop(val) or fail ArgumentError, "Unknown value for sectionprop: #{val}" }
+      end
+
+      # @private
+      def _sectionprop(value)
+        defined?(super) && super || ["toclevel", "level", "line", "number", "index", "fromtitle", "anchor"].include?(value.to_s) && merge(sectionprop: value.to_s, replace: false)
+      end
+
+      # What page properties to return, a pipe ("|") separated list or "*" for all properties.
+      #
+      # @param value [String]
+      # @return [self]
+      def pageprops(value)
+        merge(pageprops: value.to_s)
+      end
+
+      # Convert content into this language variant.
+      #
+      # @param value [String]
+      # @return [self]
+      def variant(value)
+        merge(variant: value.to_s)
+      end
+
+      # Return HTML without images.
+      #
+      # @return [self]
+      def noimages()
+        merge(noimages: 'true')
+      end
+
+      # Don't include headings in output.
+      #
+      # @return [self]
+      def noheadings()
+        merge(noheadings: 'true')
+      end
+
+      # Don't transform HTML into mobile-specific version.
+      #
+      # @return [self]
+      def notransform()
+        merge(notransform: 'true')
+      end
+
+      # Return only requested sections even with prop=sections.
+      #
+      # @return [self]
+      def onlyrequestedsections()
+        merge(onlyrequestedsections: 'true')
+      end
+
+      # Pretend all text result is one string, and return the substring starting at this point.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def offset(value)
+        merge(offset: value.to_s)
+      end
+
+      # Pretend all text result is one string, and limit result to this length.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def maxlen(value)
+        merge(maxlen: value.to_s)
+      end
+
+      # Request a specific revision.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def revision(value)
+        merge(revision: value.to_s)
+      end
+
+      # Maximum thumbnail height.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def thumbheight(value)
+        merge(thumbheight: value.to_s)
+      end
+
+      # Maximum thumbnail width.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def thumbwidth(value)
+        merge(thumbwidth: value.to_s)
+      end
+
+      # Maximum thumbnail dimensions.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def thumbsize(value)
+        merge(thumbsize: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Move a page.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.move.from(value).perform # returns string with raw output
+    # # or
+    # api.move.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 Move < MediaWiktory::Wikipedia::Actions::Post
+
+      # Title of the page to rename. Cannot be used together with fromid.
+      #
+      # @param value [String]
+      # @return [self]
+      def from(value)
+        merge(from: value.to_s)
+      end
+
+      # Page ID of the page to rename. Cannot be used together with from.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def fromid(value)
+        merge(fromid: value.to_s)
+      end
+
+      # Title to rename the page to.
+      #
+      # @param value [String]
+      # @return [self]
+      def to(value)
+        merge(to: value.to_s)
+      end
+
+      # Reason for the rename.
+      #
+      # @param value [String]
+      # @return [self]
+      def reason(value)
+        merge(reason: value.to_s)
+      end
+
+      # Rename the talk page, if it exists.
+      #
+      # @return [self]
+      def movetalk()
+        merge(movetalk: 'true')
+      end
+
+      # Rename subpages, if applicable.
+      #
+      # @return [self]
+      def movesubpages()
+        merge(movesubpages: 'true')
+      end
+
+      # Don't create a redirect.
+      #
+      # @return [self]
+      def noredirect()
+        merge(noredirect: 'true')
+      end
+
+      # Add the page and the redirect to the current user's watchlist.
+      #
+      # @return [self]
+      def watch()
+        merge(watch: 'true')
+      end
+
+      # Remove the page and the redirect from the current user's watchlist.
+      #
+      # @return [self]
+      def unwatch()
+        merge(unwatch: 'true')
+      end
+
+      # Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.
+      #
+      # @param value [String] One of "watch", "unwatch", "preferences", "nochange".
+      # @return [self]
+      def watchlist(value)
+        _watchlist(value) or fail ArgumentError, "Unknown value for watchlist: #{value}"
+      end
+
+      # @private
+      def _watchlist(value)
+        defined?(super) && super || ["watch", "unwatch", "preferences", "nochange"].include?(value.to_s) && merge(watchlist: value.to_s)
+      end
+
+      # Ignore any warnings.
+      #
+      # @return [self]
+      def ignorewarnings()
+        merge(ignorewarnings: 'true')
+      end
+
+      # Change tags to apply to the entry in the move log and to the null revision on the destination page.
+      #
+      # @param values [Array<String>] Allowed values: "ProveIt edit", "WPCleaner", "huggle", "large plot addition".
+      # @return [self]
+      def tags(*values)
+        values.inject(self) { |res, val| res._tags(val) or fail ArgumentError, "Unknown value for tags: #{val}" }
+      end
+
+      # @private
+      def _tags(value)
+        defined?(super) && super || ["ProveIt edit", "WPCleaner", "huggle", "large plot addition"].include?(value.to_s) && merge(tags: value.to_s, replace: false)
+      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