mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Mark notifications as seen for the current user.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.echomarkseen.token(value).perform # returns string with raw output
+    # # or
+    # api.echomarkseen.token(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 Echomarkseen < MediaWiktory::Wikipedia::Actions::Post
+
+      # A "csrf" token retrieved from action=query&meta=tokens
+      #
+      # @param value [String]
+      # @return [self]
+      def token(value)
+        merge(token: value.to_s)
+      end
+
+      # Type of notifications to mark as seen: 'alert', 'message' or 'all'.
+      #
+      # @param value [String] One of "alert", "message", "all".
+      # @return [self]
+      def type(value)
+        _type(value) or fail ArgumentError, "Unknown value for type: #{value}"
+      end
+
+      # @private
+      def _type(value)
+        defined?(super) && super || ["alert", "message", "all"].include?(value.to_s) && merge(type: value.to_s)
+      end
+
+      # Timestamp format to use for output, 'ISO_8601' or 'MW'.  'MW' is deprecated here, so all clients should switch to 'ISO_8601'.  This parameter will be removed, and 'ISO_8601' will become the only output format.
+      #
+      # @param value [String] One of "ISO_8601", "MW".
+      # @return [self]
+      def timestampFormat(value)
+        _timestampFormat(value) or fail ArgumentError, "Unknown value for timestampFormat: #{value}"
+      end
+
+      # @private
+      def _timestampFormat(value)
+        defined?(super) && super || ["ISO_8601", "MW"].include?(value.to_s) && merge(timestampFormat: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,266 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Create and edit pages.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.edit.title(value).perform # returns string with raw output
+    # # or
+    # api.edit.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 Edit < MediaWiktory::Wikipedia::Actions::Post
+
+      # Title of the page to edit. Cannot be used together with pageid.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(title: value.to_s)
+      end
+
+      # Page ID of the page to edit. Cannot be used together with title.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def pageid(value)
+        merge(pageid: value.to_s)
+      end
+
+      # Section number. 0 for the top section, new for a new section.
+      #
+      # @param value [String]
+      # @return [self]
+      def section(value)
+        merge(section: value.to_s)
+      end
+
+      # The title for a new section.
+      #
+      # @param value [String]
+      # @return [self]
+      def sectiontitle(value)
+        merge(sectiontitle: value.to_s)
+      end
+
+      # Page content.
+      #
+      # @param value [String]
+      # @return [self]
+      def text(value)
+        merge(text: value.to_s)
+      end
+
+      # Edit summary. Also section title when section=new and sectiontitle is not set.
+      #
+      # @param value [String]
+      # @return [self]
+      def summary(value)
+        merge(summary: value.to_s)
+      end
+
+      # Change tags to apply to the 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
+
+      # Minor edit.
+      #
+      # @return [self]
+      def minor()
+        merge(minor: 'true')
+      end
+
+      # Non-minor edit.
+      #
+      # @return [self]
+      def notminor()
+        merge(notminor: 'true')
+      end
+
+      # Mark this edit as a bot edit.
+      #
+      # @return [self]
+      def bot()
+        merge(bot: 'true')
+      end
+
+      # Timestamp of the base revision, used to detect edit conflicts. May be obtained through action=query&prop=revisions&rvprop=timestamp.
+      #
+      # @param value [Time]
+      # @return [self]
+      def basetimestamp(value)
+        merge(basetimestamp: value.iso8601)
+      end
+
+      # Timestamp when the editing process began, used to detect edit conflicts. An appropriate value may be obtained using curtimestamp when beginning the edit process (e.g. when loading the page content to edit).
+      #
+      # @param value [Time]
+      # @return [self]
+      def starttimestamp(value)
+        merge(starttimestamp: value.iso8601)
+      end
+
+      # Override any errors about the page having been deleted in the meantime.
+      #
+      # @return [self]
+      def recreate()
+        merge(recreate: 'true')
+      end
+
+      # Don't edit the page if it exists already.
+      #
+      # @return [self]
+      def createonly()
+        merge(createonly: 'true')
+      end
+
+      # Throw an error if the page doesn't exist.
+      #
+      # @return [self]
+      def nocreate()
+        merge(nocreate: 'true')
+      end
+
+      # Add the page to the current user's watchlist.
+      #
+      # @return [self]
+      def watch()
+        merge(watch: 'true')
+      end
+
+      # Remove the page 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
+
+      # The MD5 hash of the text parameter, or the prependtext and appendtext parameters concatenated. If set, the edit won't be done unless the hash is correct.
+      #
+      # @param value [String]
+      # @return [self]
+      def md5(value)
+        merge(md5: value.to_s)
+      end
+
+      # Add this text to the beginning of the page. Overrides text.
+      #
+      # @param value [String]
+      # @return [self]
+      def prependtext(value)
+        merge(prependtext: value.to_s)
+      end
+
+      # Add this text to the end of the page. Overrides text.
+      #
+      # @param value [String]
+      # @return [self]
+      def appendtext(value)
+        merge(appendtext: value.to_s)
+      end
+
+      # Undo this revision. Overrides text, prependtext and appendtext.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def undo(value)
+        merge(undo: value.to_s)
+      end
+
+      # Undo all revisions from undo to this one. If not set, just undo one revision.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def undoafter(value)
+        merge(undoafter: value.to_s)
+      end
+
+      # Automatically resolve redirects.
+      #
+      # @return [self]
+      def redirect()
+        merge(redirect: 'true')
+      end
+
+      # Content serialization format used for the input text.
+      #
+      # @param value [String] One of "application/json", "text/x-wiki", "text/javascript", "text/css", "text/plain".
+      # @return [self]
+      def contentformat(value)
+        _contentformat(value) or fail ArgumentError, "Unknown value for contentformat: #{value}"
+      end
+
+      # @private
+      def _contentformat(value)
+        defined?(super) && super || ["application/json", "text/x-wiki", "text/javascript", "text/css", "text/plain"].include?(value.to_s) && merge(contentformat: value.to_s)
+      end
+
+      # Content model of the new content.
+      #
+      # @param value [String] One of "GadgetDefinition", "SecurePoll", "MassMessageListContent", "JsonSchema", "wikitext", "javascript", "json", "css", "text", "Scribunto".
+      # @return [self]
+      def contentmodel(value)
+        _contentmodel(value) or fail ArgumentError, "Unknown value for contentmodel: #{value}"
+      end
+
+      # @private
+      def _contentmodel(value)
+        defined?(super) && super || ["GadgetDefinition", "SecurePoll", "MassMessageListContent", "JsonSchema", "wikitext", "javascript", "json", "css", "text", "Scribunto"].include?(value.to_s) && merge(contentmodel: 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
+
+      # Answer to the CAPTCHA
+      #
+      # @param value [String]
+      # @return [self]
+      def captchaword(value)
+        merge(captchaword: value.to_s)
+      end
+
+      # CAPTCHA ID from previous request
+      #
+      # @param value [String]
+      # @return [self]
+      def captchaid(value)
+        merge(captchaid: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Edit a mass message delivery list.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.editmassmessagelist.spamlist(value).perform # returns string with raw output
+    # # or
+    # api.editmassmessagelist.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 Editmassmessagelist < MediaWiktory::Wikipedia::Actions::Post
+
+      # Title of the delivery list to update.
+      #
+      # @param value [String]
+      # @return [self]
+      def spamlist(value)
+        merge(spamlist: value.to_s)
+      end
+
+      # Titles to add to the list.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def add(*values)
+        values.inject(self) { |res, val| res._add(val) }
+      end
+
+      # @private
+      def _add(value)
+        merge(add: value.to_s, replace: false)
+      end
+
+      # Titles to remove from the list.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def remove(*values)
+        values.inject(self) { |res, val| res._remove(val) }
+      end
+
+      # @private
+      def _remove(value)
+        merge(remove: 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/emailuser.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Email a user.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.emailuser.target(value).perform # returns string with raw output
+    # # or
+    # api.emailuser.target(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 Emailuser < MediaWiktory::Wikipedia::Actions::Post
+
+      # User to send email to.
+      #
+      # @param value [String]
+      # @return [self]
+      def target(value)
+        merge(target: value.to_s)
+      end
+
+      # Subject header.
+      #
+      # @param value [String]
+      # @return [self]
+      def subject(value)
+        merge(subject: value.to_s)
+      end
+
+      # Mail body.
+      #
+      # @param value [String]
+      # @return [self]
+      def text(value)
+        merge(text: value.to_s)
+      end
+
+      # Send a copy of this mail to me.
+      #
+      # @return [self]
+      def ccme()
+        merge(ccme: '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