mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Returns a watchlist feed.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.feedwatchlist.feedformat(value).perform # returns string with raw output
+    # # or
+    # api.feedwatchlist.feedformat(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 Feedwatchlist < MediaWiktory::Wikipedia::Actions::Get
+
+      # The format of the feed.
+      #
+      # @param value [String] One of "rss", "atom".
+      # @return [self]
+      def feedformat(value)
+        _feedformat(value) or fail ArgumentError, "Unknown value for feedformat: #{value}"
+      end
+
+      # @private
+      def _feedformat(value)
+        defined?(super) && super || ["rss", "atom"].include?(value.to_s) && merge(feedformat: value.to_s)
+      end
+
+      # List pages modified within this many hours from now.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def hours(value)
+        merge(hours: value.to_s)
+      end
+
+      # Link directly to changed sections if possible.
+      #
+      # @return [self]
+      def linktosections()
+        merge(linktosections: 'true')
+      end
+
+      # Include multiple revisions of the same page within given timeframe.
+      #
+      # @return [self]
+      def allrev()
+        merge(allrev: 'true')
+      end
+
+      # Used along with token to access a different user's watchlist.
+      #
+      # @param value [String]
+      # @return [self]
+      def wlowner(value)
+        merge(wlowner: value.to_s)
+      end
+
+      # A security token (available in the user's preferences) to allow access to another user's watchlist.
+      #
+      # @param value [String]
+      # @return [self]
+      def wltoken(value)
+        merge(wltoken: value.to_s)
+      end
+
+      # Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set show=minor|!anon.
+      #
+      # @param values [Array<String>] Allowed values: "minor", "!minor", "bot", "!bot", "anon", "!anon", "patrolled", "!patrolled", "unread", "!unread".
+      # @return [self]
+      def wlshow(*values)
+        values.inject(self) { |res, val| res._wlshow(val) or fail ArgumentError, "Unknown value for wlshow: #{val}" }
+      end
+
+      # @private
+      def _wlshow(value)
+        defined?(super) && super || ["minor", "!minor", "bot", "!bot", "anon", "!anon", "patrolled", "!patrolled", "unread", "!unread"].include?(value.to_s) && merge(wlshow: value.to_s, replace: false)
+      end
+
+      # Which types of changes to show:
+      #
+      # @param values [Array<String>] Allowed values: "edit" (Regular page edits), "new" (Page creations), "log" (Log entries), "external" (External changes), "categorize" (Category membership changes).
+      # @return [self]
+      def wltype(*values)
+        values.inject(self) { |res, val| res._wltype(val) or fail ArgumentError, "Unknown value for wltype: #{val}" }
+      end
+
+      # @private
+      def _wltype(value)
+        defined?(super) && super || ["edit", "new", "log", "external", "categorize"].include?(value.to_s) && merge(wltype: value.to_s, replace: false)
+      end
+
+      # Don't list changes by this user.
+      #
+      # @param value [String]
+      # @return [self]
+      def wlexcludeuser(value)
+        merge(wlexcludeuser: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Revert a file to an old version.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.filerevert.filename(value).perform # returns string with raw output
+    # # or
+    # api.filerevert.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 Filerevert < MediaWiktory::Wikipedia::Actions::Post
+
+      # Target filename, without the File: prefix.
+      #
+      # @param value [String]
+      # @return [self]
+      def filename(value)
+        merge(filename: value.to_s)
+      end
+
+      # Upload comment.
+      #
+      # @param value [String]
+      # @return [self]
+      def comment(value)
+        merge(comment: value.to_s)
+      end
+
+      # Archive name of the revision to revert to.
+      #
+      # @param value [String]
+      # @return [self]
+      def archivename(value)
+        merge(archivename: 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/flagconfig.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Get basic information about review flag configuration for this site.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.flagconfig.perform # returns string with raw output
+    # # or
+    # api.flagconfig.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 Flagconfig < MediaWiktory::Wikipedia::Actions::Get
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Globally block or unblock a user.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.globalblock.target(value).perform # returns string with raw output
+    # # or
+    # api.globalblock.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 Globalblock < MediaWiktory::Wikipedia::Actions::Post
+
+      # The target IP address.
+      #
+      # @param value [String]
+      # @return [self]
+      def target(value)
+        merge(target: value.to_s)
+      end
+
+      # If specified, will block or reblock the user. Determines how long the block will last for, e.g. "5 months" or "2 weeks". If set to "infinite" or "indefinite" the block will never expire.
+      #
+      # @param value [String]
+      # @return [self]
+      def expiry(value)
+        merge(expiry: value.to_s)
+      end
+
+      # If specified, will unblock the user.
+      #
+      # @return [self]
+      def unblock()
+        merge(unblock: 'true')
+      end
+
+      # The reason for blocking/unblocking.
+      #
+      # @param value [String]
+      # @return [self]
+      def reason(value)
+        merge(reason: value.to_s)
+      end
+
+      # Specify this if the block should only affect logged-out users.
+      #
+      # @return [self]
+      def anononly()
+        merge(anononly: 'true')
+      end
+
+      # Specify this if the existing block on the target should be modified
+      #
+      # @return [self]
+      def modify()
+        merge(modify: '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/globaluserrights.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Add/remove a user to/from global groups.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.globaluserrights.user(value).perform # returns string with raw output
+    # # or
+    # api.globaluserrights.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 Globaluserrights < MediaWiktory::Wikipedia::Actions::Post
+
+      # Global user name.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(user: value.to_s)
+      end
+
+      # Global user ID.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def userid(value)
+        merge(userid: value.to_s)
+      end
+
+      # Add the user to these global groups.
+      #
+      # @param values [Array<String>] Allowed values: "OTRS-member", "abusefilter-helper", "apihighlimits-requestor", "captcha-exempt", "delete-global", "founder", "global-bot", "global-flow-create", "global-interface-editor", "global-ipblock-exempt", "global-rollbacker", "global-sysop", "new-wikis-importer", "oathauth-tester", "ombudsman", "recursive-export", "staff", "steward", "sysadmin", "wmf-ops-monitoring", "wmf-researcher".
+      # @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 || ["OTRS-member", "abusefilter-helper", "apihighlimits-requestor", "captcha-exempt", "delete-global", "founder", "global-bot", "global-flow-create", "global-interface-editor", "global-ipblock-exempt", "global-rollbacker", "global-sysop", "new-wikis-importer", "oathauth-tester", "ombudsman", "recursive-export", "staff", "steward", "sysadmin", "wmf-ops-monitoring", "wmf-researcher"].include?(value.to_s) && merge(add: value.to_s, replace: false)
+      end
+
+      # Remove the user from these global groups.
+      #
+      # @param values [Array<String>] Allowed values: "OTRS-member", "abusefilter-helper", "apihighlimits-requestor", "captcha-exempt", "delete-global", "founder", "global-bot", "global-flow-create", "global-interface-editor", "global-ipblock-exempt", "global-rollbacker", "global-sysop", "new-wikis-importer", "oathauth-tester", "ombudsman", "recursive-export", "staff", "steward", "sysadmin", "wmf-ops-monitoring", "wmf-researcher".
+      # @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 || ["OTRS-member", "abusefilter-helper", "apihighlimits-requestor", "captcha-exempt", "delete-global", "founder", "global-bot", "global-flow-create", "global-interface-editor", "global-ipblock-exempt", "global-rollbacker", "global-sysop", "new-wikis-importer", "oathauth-tester", "ombudsman", "recursive-export", "staff", "steward", "sysadmin", "wmf-ops-monitoring", "wmf-researcher"].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
+
+      # This parameter is currently unused.
+      #
+      # @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/graph.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Access graph tag functionality.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.graph.hash(value).perform # returns string with raw output
+    # # or
+    # api.graph.hash(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 Graph < MediaWiktory::Wikipedia::Actions::Get
+
+      # Hash value of the graph
+      #
+      # @param value [String]
+      # @return [self]
+      def hash(value)
+        merge(hash: value.to_s)
+      end
+
+      # Title of the article with the graph
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(title: value.to_s)
+      end
+
+      # Text of the graph to be converted to JSON. Must be posted and used without title and hash parameters
+      #
+      # @param value [String]
+      # @return [self]
+      def text(value)
+        merge(text: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Display help for the specified modules.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.help.modules(value).perform # returns string with raw output
+    # # or
+    # api.help.modules(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 Help < MediaWiktory::Wikipedia::Actions::Get
+
+      # Modules to display help for (values of the action and format parameters, or main). Can specify submodules with a +.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def modules(*values)
+        values.inject(self) { |res, val| res._modules(val) }
+      end
+
+      # @private
+      def _modules(value)
+        merge(modules: value.to_s, replace: false)
+      end
+
+      # Include help for submodules of the named module.
+      #
+      # @return [self]
+      def submodules()
+        merge(submodules: 'true')
+      end
+
+      # Include help for submodules recursively.
+      #
+      # @return [self]
+      def recursivesubmodules()
+        merge(recursivesubmodules: 'true')
+      end
+
+      # Wrap the output in a standard API response structure.
+      #
+      # @return [self]
+      def wrap()
+        merge(wrap: 'true')
+      end
+
+      # Include a table of contents in the HTML output.
+      #
+      # @return [self]
+      def toc()
+        merge(toc: 'true')
+      end
+    end
+  end
+end