mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Remove a linked third-party account from the current user.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.unlinkaccount.request(value).perform # returns string with raw output
+    # # or
+    # api.unlinkaccount.request(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 Unlinkaccount < MediaWiktory::Wikipedia::Actions::Post
+
+      # Use this authentication request, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=unlink.
+      #
+      # @param value [String]
+      # @return [self]
+      def request(value)
+        merge(request: 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/upload.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Upload a file, or get the status of pending uploads.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.upload.filename(value).perform # returns string with raw output
+    # # or
+    # api.upload.filename(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 Upload < MediaWiktory::Wikipedia::Actions::Post
+
+      # Target filename.
+      #
+      # @param value [String]
+      # @return [self]
+      def filename(value)
+        merge(filename: value.to_s)
+      end
+
+      # Upload comment. Also used as the initial page text for new files if text is not specified.
+      #
+      # @param value [String]
+      # @return [self]
+      def comment(value)
+        merge(comment: value.to_s)
+      end
+
+      # Change tags to apply to the upload log entry and file page revision.
+      #
+      # @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
+
+      # Initial page text for new files.
+      #
+      # @param value [String]
+      # @return [self]
+      def text(value)
+        merge(text: value.to_s)
+      end
+
+      # Watch the page.
+      #
+      # @return [self]
+      def watch()
+        merge(watch: '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", "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", "preferences", "nochange"].include?(value.to_s) && merge(watchlist: value.to_s)
+      end
+
+      # Ignore any warnings.
+      #
+      # @return [self]
+      def ignorewarnings()
+        merge(ignorewarnings: 'true')
+      end
+
+      # File contents.
+      #
+      # @param value [String]
+      # @return [self]
+      def file(value)
+        merge(file: value.to_s)
+      end
+
+      # URL to fetch the file from.
+      #
+      # @param value [String]
+      # @return [self]
+      def url(value)
+        merge(url: value.to_s)
+      end
+
+      # Key that identifies a previous upload that was stashed temporarily.
+      #
+      # @param value [String]
+      # @return [self]
+      def filekey(value)
+        merge(filekey: value.to_s)
+      end
+
+      # Same as filekey, maintained for backward compatibility.
+      #
+      # @param value [String]
+      # @return [self]
+      def sessionkey(value)
+        merge(sessionkey: value.to_s)
+      end
+
+      # If set, the server will stash the file temporarily instead of adding it to the repository.
+      #
+      # @return [self]
+      def stash()
+        merge(stash: 'true')
+      end
+
+      # Filesize of entire upload.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def filesize(value)
+        merge(filesize: value.to_s)
+      end
+
+      # Offset of chunk in bytes.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def offset(value)
+        merge(offset: value.to_s)
+      end
+
+      # Chunk contents.
+      #
+      # @param value [String]
+      # @return [self]
+      def chunk(value)
+        merge(chunk: value.to_s)
+      end
+
+      # Make potentially large file operations asynchronous when possible.
+      #
+      # @return [self]
+      def async()
+        merge(async: 'true')
+      end
+
+      # Only fetch the upload status for the given file key.
+      #
+      # @return [self]
+      def checkstatus()
+        merge(checkstatus: 'true')
+      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/userrights.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Change a user's group membership.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.userrights.user(value).perform # returns string with raw output
+    # # or
+    # api.userrights.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 Userrights < MediaWiktory::Wikipedia::Actions::Post
+
+      # User name.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(user: value.to_s)
+      end
+
+      # User ID.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def userid(value)
+        merge(userid: value.to_s)
+      end
+
+      # Add the user to these groups, or if they are already a member, update the expiry of their membership in that group.
+      #
+      # @param values [Array<String>] Allowed values: "bot", "sysop", "bureaucrat", "reviewer", "steward", "accountcreator", "import", "transwiki", "ipblock-exempt", "oversight", "founder", "rollbacker", "autoreviewer", "researcher", "filemover", "checkuser", "templateeditor", "massmessage-sender", "extendedconfirmed", "extendedmover", "patroller", "abusefilter", "confirmed", "epcoordinator", "eponline", "epcampus", "epinstructor".
+      # @return [self]
+      def add(*values)
+        values.inject(self) { |res, val| res._add(val) or fail ArgumentError, "Unknown value for add: #{val}" }
+      end
+
+      # @private
+      def _add(value)
+        defined?(super) && super || ["bot", "sysop", "bureaucrat", "reviewer", "steward", "accountcreator", "import", "transwiki", "ipblock-exempt", "oversight", "founder", "rollbacker", "autoreviewer", "researcher", "filemover", "checkuser", "templateeditor", "massmessage-sender", "extendedconfirmed", "extendedmover", "patroller", "abusefilter", "confirmed", "epcoordinator", "eponline", "epcampus", "epinstructor"].include?(value.to_s) && merge(add: value.to_s, replace: false)
+      end
+
+      # Expiry timestamps. May be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). If only one timestamp is set, it will be used for all groups passed to the add parameter. Use infinite, indefinite, infinity, or never for a never-expiring user group.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def expiry(*values)
+        values.inject(self) { |res, val| res._expiry(val) }
+      end
+
+      # @private
+      def _expiry(value)
+        merge(expiry: value.to_s, replace: false)
+      end
+
+      # Remove the user from these groups.
+      #
+      # @param values [Array<String>] Allowed values: "bot", "sysop", "bureaucrat", "reviewer", "steward", "accountcreator", "import", "transwiki", "ipblock-exempt", "oversight", "founder", "rollbacker", "autoreviewer", "researcher", "filemover", "checkuser", "templateeditor", "massmessage-sender", "extendedconfirmed", "extendedmover", "patroller", "abusefilter", "confirmed", "epcoordinator", "eponline", "epcampus", "epinstructor".
+      # @return [self]
+      def remove(*values)
+        values.inject(self) { |res, val| res._remove(val) or fail ArgumentError, "Unknown value for remove: #{val}" }
+      end
+
+      # @private
+      def _remove(value)
+        defined?(super) && super || ["bot", "sysop", "bureaucrat", "reviewer", "steward", "accountcreator", "import", "transwiki", "ipblock-exempt", "oversight", "founder", "rollbacker", "autoreviewer", "researcher", "filemover", "checkuser", "templateeditor", "massmessage-sender", "extendedconfirmed", "extendedmover", "patroller", "abusefilter", "confirmed", "epcoordinator", "eponline", "epcampus", "epinstructor"].include?(value.to_s) && merge(remove: value.to_s, replace: false)
+      end
+
+      # Reason for the change.
+      #
+      # @param value [String]
+      # @return [self]
+      def reason(value)
+        merge(reason: value.to_s)
+      end
+
+      # A "userrights" token retrieved from action=query&meta=tokens
+      #
+      # @param value [String]
+      # @return [self]
+      def token(value)
+        merge(token: value.to_s)
+      end
+
+      # Change tags to apply to the entry in the user rights 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
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Validate a password against the wiki's password policies.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.validatepassword.password(value).perform # returns string with raw output
+    # # or
+    # api.validatepassword.password(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 Validatepassword < MediaWiktory::Wikipedia::Actions::Post
+
+      # Password to validate.
+      #
+      # @param value [String]
+      # @return [self]
+      def password(value)
+        merge(password: value.to_s)
+      end
+
+      # User name, for use when testing account creation. The named user must not exist.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(user: value.to_s)
+      end
+
+      # Email address, for use when testing account creation.
+      #
+      # @param value [String]
+      # @return [self]
+      def email(value)
+        merge(email: value.to_s)
+      end
+
+      # Real name, for use when testing account creation.
+      #
+      # @param value [String]
+      # @return [self]
+      def realname(value)
+        merge(realname: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Returns HTML5 for a page from the Parsoid service.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.visualeditor.page(value).perform # returns string with raw output
+    # # or
+    # api.visualeditor.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 Visualeditor < MediaWiktory::Wikipedia::Actions::Get
+
+      # The page to perform actions on.
+      #
+      # @param value [String]
+      # @return [self]
+      def page(value)
+        merge(page: value.to_s)
+      end
+
+      # 
+      #
+      # @param value [String] One of "json", "jsonfm".
+      # @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"].include?(value.to_s) && merge(format: value.to_s)
+      end
+
+      # Action to perform.
+      #
+      # @param value [String] One of "parse", "metadata", "wikitext", "parsefragment", "getlanglinks".
+      # @return [self]
+      def paction(value)
+        _paction(value) or fail ArgumentError, "Unknown value for paction: #{value}"
+      end
+
+      # @private
+      def _paction(value)
+        defined?(super) && super || ["parse", "metadata", "wikitext", "parsefragment", "getlanglinks"].include?(value.to_s) && merge(paction: value.to_s)
+      end
+
+      # Wikitext to send to Parsoid to convert to HTML (paction=parsefragment).
+      #
+      # @param value [String]
+      # @return [self]
+      def wikitext(value)
+        merge(wikitext: value.to_s)
+      end
+
+      # The section on which to act.
+      #
+      # @param value [String]
+      # @return [self]
+      def section(value)
+        merge(section: value.to_s)
+      end
+
+      # The revision number to use (defaults to latest revision).
+      #
+      # @param value [String]
+      # @return [self]
+      def oldid(value)
+        merge(oldid: value.to_s)
+      end
+
+      # Edit intro to add to notices.
+      #
+      # @param value [String]
+      # @return [self]
+      def editintro(value)
+        merge(editintro: value.to_s)
+      end
+
+      # Pre-save transform wikitext before sending it to Parsoid (paction=parsefragment).
+      #
+      # @return [self]
+      def pst()
+        merge(pst: 'true')
+      end
+    end
+  end
+end