mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # This module allows to save draft translations by section to save bandwidth and to collect parallel corpora.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.cxsave.from(value).perform # returns string with raw output
+    # # or
+    # api.cxsave.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 Cxsave < 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
+
+      # The title of the page to perform actions on.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(title: value.to_s)
+      end
+
+      # JSON-encoded section data. Each section is an object and has the following keys: content, sectionId, sequenceId, sequenceId, origin
+      #
+      # @param value [String]
+      # @return [self]
+      def content(value)
+        merge(content: value.to_s)
+      end
+
+      # The revision of the source page.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def sourcerevision(value)
+        merge(sourcerevision: value.to_s)
+      end
+
+      # Information about translation completion (progress). JSON with the keys any, human, mt and mtSectionsCount. The keys' values are percentages.
+      #
+      # @param value [String]
+      # @return [self]
+      def progress(value)
+        merge(progress: 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/cxsuggestionlist.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Manage the suggestion lists. Add suggestions to lists and remove them.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.cxsuggestionlist.listname(value).perform # returns string with raw output
+    # # or
+    # api.cxsuggestionlist.listname(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 Cxsuggestionlist < MediaWiktory::Wikipedia::Actions::Post
+
+      # Suggestion list name.
+      #
+      # @param value [String]
+      # @return [self]
+      def listname(value)
+        merge(listname: value.to_s)
+      end
+
+      # Action to be performed on the list.
+      #
+      # @param value [String] One of "add", "remove".
+      # @return [self]
+      def listaction(value)
+        _listaction(value) or fail ArgumentError, "Unknown value for listaction: #{value}"
+      end
+
+      # @private
+      def _listaction(value)
+        defined?(super) && super || ["add", "remove"].include?(value.to_s) && merge(listaction: value.to_s)
+      end
+
+      # Page titles.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def titles(*values)
+        values.inject(self) { |res, val| res._titles(val) }
+      end
+
+      # @private
+      def _titles(value)
+        merge(titles: value.to_s, replace: false)
+      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
+
+      # 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/cxtoken.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Get JWT tokens to authenticate with cxserver.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.cxtoken.token(value).perform # returns string with raw output
+    # # or
+    # api.cxtoken.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 Cxtoken < 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
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Delete a page.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.delete.title(value).perform # returns string with raw output
+    # # or
+    # api.delete.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 Delete < MediaWiktory::Wikipedia::Actions::Post
+
+      # Title of the page to delete. 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 delete. Cannot be used together with title.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def pageid(value)
+        merge(pageid: value.to_s)
+      end
+
+      # Reason for the deletion. If not set, an automatically generated reason will be used.
+      #
+      # @param value [String]
+      # @return [self]
+      def reason(value)
+        merge(reason: value.to_s)
+      end
+
+      # Change tags to apply to the entry in the deletion 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
+
+      # Add the page to the current user's watchlist.
+      #
+      # @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", "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
+
+      # Remove the page from the current user's watchlist.
+      #
+      # @return [self]
+      def unwatch()
+        merge(unwatch: 'true')
+      end
+
+      # The name of the old image to delete as provided by action=query&prop=imageinfo&iiprop=archivename.
+      #
+      # @param value [String]
+      # @return [self]
+      def oldimage(value)
+        merge(oldimage: 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/deleteeducation.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Delete Education Program objects.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.deleteeducation.ids(value).perform # returns string with raw output
+    # # or
+    # api.deleteeducation.ids(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 Deleteeducation < MediaWiktory::Wikipedia::Actions::Post
+
+      # The IDs of the objects to delete.
+      #
+      # @param values [Array<Integer>]
+      # @return [self]
+      def ids(*values)
+        values.inject(self) { |res, val| res._ids(val) }
+      end
+
+      # @private
+      def _ids(value)
+        merge(ids: value.to_s, replace: false)
+      end
+
+      # Type of object to delete.
+      #
+      # @param value [String] One of "org", "course".
+      # @return [self]
+      def type(value)
+        _type(value) or fail ArgumentError, "Unknown value for type: #{value}"
+      end
+
+      # @private
+      def _type(value)
+        defined?(super) && super || ["org", "course"].include?(value.to_s) && merge(type: value.to_s)
+      end
+
+      # Reason for this deletion, for the log.
+      #
+      # @param value [String]
+      # @return [self]
+      def comment(value)
+        merge(comment: 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/deleteglobalaccount.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Delete a global user.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.deleteglobalaccount.user(value).perform # returns string with raw output
+    # # or
+    # api.deleteglobalaccount.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 Deleteglobalaccount < MediaWiktory::Wikipedia::Actions::Post
+
+      # User to delete.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(user: value.to_s)
+      end
+
+      # Reason for deleting the user.
+      #
+      # @param value [String]
+      # @return [self]
+      def reason(value)
+        merge(reason: value.to_s)
+      end
+
+      # A "deleteglobalaccount" 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/echomarkread.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Mark notifications as read for the current user.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.echomarkread.list(value).perform # returns string with raw output
+    # # or
+    # api.echomarkread.list(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 Echomarkread < MediaWiktory::Wikipedia::Actions::Post
+
+      # A list of notification IDs to mark as read.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def list(*values)
+        values.inject(self) { |res, val| res._list(val) }
+      end
+
+      # @private
+      def _list(value)
+        merge(list: value.to_s, replace: false)
+      end
+
+      # A list of notification IDs to mark as unread.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def unreadlist(*values)
+        values.inject(self) { |res, val| res._unreadlist(val) }
+      end
+
+      # @private
+      def _unreadlist(value)
+        merge(unreadlist: value.to_s, replace: false)
+      end
+
+      # If set, marks all of a user's notifications as read.
+      #
+      # @return [self]
+      def all()
+        merge(all: 'true')
+      end
+
+      # A list of sections to mark as read.
+      #
+      # @param values [Array<String>] Allowed values: "alert", "message".
+      # @return [self]
+      def sections(*values)
+        values.inject(self) { |res, val| res._sections(val) or fail ArgumentError, "Unknown value for sections: #{val}" }
+      end
+
+      # @private
+      def _sections(value)
+        defined?(super) && super || ["alert", "message"].include?(value.to_s) && merge(sections: 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