mediawiktory 0.0.3 → 0.1.0

data/lib/mediawiktory/wikipedia/modules/usercontribs.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get all edits by a user.
+    #
+    # The "submodule" (MediaWiki API term) is included in action after setting some param, providing
+    # additional tweaking for this param. Example (for {MediaWiktory::Wikipedia::Actions::Query} and
+    # its submodules):
+    #
+    # ```ruby
+    # api.query             # returns Actions::Query
+    #    .prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
+    #    .limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL
+    # ```
+    #
+    # All submodule's parameters are documented as its public methods, see below.
+    #
+    module Usercontribs
+
+      # The maximum number of contributions to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(uclimit: value.to_s)
+      end
+
+      # The start timestamp to return from.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(ucstart: value.iso8601)
+      end
+
+      # The end timestamp to return to.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(ucend: value.iso8601)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(uccontinue: value.to_s)
+      end
+
+      # The users to retrieve contributions for. Cannot be used with ucuserids or ucuserprefix.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def user(*values)
+        values.inject(self) { |res, val| res._user(val) }
+      end
+
+      # @private
+      def _user(value)
+        merge(ucuser: value.to_s, replace: false)
+      end
+
+      # The user IDs to retrieve contributions for. Cannot be used with ucuser or ucuserprefix.
+      #
+      # @param values [Array<Integer>]
+      # @return [self]
+      def userids(*values)
+        values.inject(self) { |res, val| res._userids(val) }
+      end
+
+      # @private
+      def _userids(value)
+        merge(ucuserids: value.to_s, replace: false)
+      end
+
+      # Retrieve contributions for all users whose names begin with this value. Cannot be used with ucuser or ucuserids.
+      #
+      # @param value [String]
+      # @return [self]
+      def userprefix(value)
+        merge(ucuserprefix: value.to_s)
+      end
+
+      # In which direction to enumerate:
+      #
+      # @param value [String] One of "newer" (List oldest first. Note: ucstart has to be before ucend), "older" (List newest first (default). Note: ucstart has to be later than ucend).
+      # @return [self]
+      def dir(value)
+        _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
+      end
+
+      # @private
+      def _dir(value)
+        defined?(super) && super || ["newer", "older"].include?(value.to_s) && merge(ucdir: value.to_s)
+      end
+
+      # Only list contributions in these namespaces.
+      #
+      # @param values [Array<String>] Allowed values: "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303".
+      # @return [self]
+      def namespace(*values)
+        values.inject(self) { |res, val| res._namespace(val) or fail ArgumentError, "Unknown value for namespace: #{val}" }
+      end
+
+      # @private
+      def _namespace(value)
+        defined?(super) && super || ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303"].include?(value.to_s) && merge(ucnamespace: value.to_s, replace: false)
+      end
+
+      # Include additional pieces of information:
+      #
+      # @param values [Array<String>] Allowed values: "ids" (Adds the page ID and revision ID), "title" (Adds the title and namespace ID of the page), "timestamp" (Adds the timestamp of the edit), "comment" (Adds the comment of the edit), "parsedcomment" (Adds the parsed comment of the edit), "size" (Adds the new size of the edit), "sizediff" (Adds the size delta of the edit against its parent), "flags" (Adds flags of the edit), "patrolled" (Tags patrolled edits), "tags" (Lists tags for the edit).
+      # @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 || ["ids", "title", "timestamp", "comment", "parsedcomment", "size", "sizediff", "flags", "patrolled", "tags"].include?(value.to_s) && merge(ucprop: value.to_s, replace: false)
+      end
+
+      # Show only items that meet these criteria, e.g. non minor edits only: ucshow=!minor.
+      #
+      # @param values [Array<String>] Allowed values: "minor", "!minor", "patrolled", "!patrolled", "top", "!top", "new", "!new".
+      # @return [self]
+      def show(*values)
+        values.inject(self) { |res, val| res._show(val) or fail ArgumentError, "Unknown value for show: #{val}" }
+      end
+
+      # @private
+      def _show(value)
+        defined?(super) && super || ["minor", "!minor", "patrolled", "!patrolled", "top", "!top", "new", "!new"].include?(value.to_s) && merge(ucshow: value.to_s, replace: false)
+      end
+
+      # Only list revisions tagged with this tag.
+      #
+      # @param value [String]
+      # @return [self]
+      def tag(value)
+        merge(uctag: value.to_s)
+      end
+
+      # Only list changes which are the latest revision.
+      #
+      # @return [self]
+      def toponly()
+        merge(uctoponly: 'true')
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/modules/userinfo.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get information about the current user.
+    #
+    # The "submodule" (MediaWiki API term) is included in action after setting some param, providing
+    # additional tweaking for this param. Example (for {MediaWiktory::Wikipedia::Actions::Query} and
+    # its submodules):
+    #
+    # ```ruby
+    # api.query             # returns Actions::Query
+    #    .prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
+    #    .limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL
+    # ```
+    #
+    # All submodule's parameters are documented as its public methods, see below.
+    #
+    module Userinfo
+
+      # Which pieces of information to include:
+      #
+      # @param values [Array<String>] Allowed values: "blockinfo" (Tags if the current user is blocked, by whom, and for what reason), "hasmsg" (Adds a tag messages if the current user has pending messages), "groups" (Lists all the groups the current user belongs to), "groupmemberships" (Lists groups that the current user has been explicitly assigned to, including the expiry date of each group membership), "implicitgroups" (Lists all the groups the current user is automatically a member of), "rights" (Lists all the rights the current user has), "changeablegroups" (Lists the groups the current user can add to and remove from), "options" (Lists all preferences the current user has set), "preferencestoken" (Deprecated. Get a token to change current user's preferences), "editcount" (Adds the current user's edit count), "ratelimits" (Lists all rate limits applying to the current user), "email" (Adds the user's email address and email authentication date), "realname" (Adds the user's real name), "acceptlang" (Echoes the Accept-Language header sent by the client in a structured format), "registrationdate" (Adds the user's registration date), "unreadcount" (Adds the count of unread pages on the user's watchlist (maximum 999; returns 1000+ if more)), "centralids" (Adds the central IDs and attachment status for the user).
+      # @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 || ["blockinfo", "hasmsg", "groups", "groupmemberships", "implicitgroups", "rights", "changeablegroups", "options", "preferencestoken", "editcount", "ratelimits", "email", "realname", "acceptlang", "registrationdate", "unreadcount", "centralids"].include?(value.to_s) && merge(uiprop: value.to_s, replace: false)
+      end
+
+      # With uiprop=centralids, indicate whether the user is attached with the wiki identified by this ID.
+      #
+      # @param value [String]
+      # @return [self]
+      def attachedwiki(value)
+        merge(uiattachedwiki: value.to_s)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/modules/users.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get information about a list of users.
+    #
+    # The "submodule" (MediaWiki API term) is included in action after setting some param, providing
+    # additional tweaking for this param. Example (for {MediaWiktory::Wikipedia::Actions::Query} and
+    # its submodules):
+    #
+    # ```ruby
+    # api.query             # returns Actions::Query
+    #    .prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
+    #    .limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL
+    # ```
+    #
+    # All submodule's parameters are documented as its public methods, see below.
+    #
+    module Users
+
+      # Which pieces of information to include:
+      #
+      # @param values [Array<String>] Allowed values: "blockinfo" (Tags if the user is blocked, by whom, and for what reason), "groups" (Lists all the groups each user belongs to), "groupmemberships" (Lists groups that each user has been explicitly assigned to, including the expiry date of each group membership), "implicitgroups" (Lists all the groups a user is automatically a member of), "rights" (Lists all the rights each user has), "editcount" (Adds the user's edit count), "registration" (Adds the user's registration timestamp), "emailable" (Tags if the user can and wants to receive email through Special:Emailuser), "gender" (Tags the gender of the user. Returns "male", "female", or "unknown"), "centralids" (Adds the central IDs and attachment status for the user), "cancreate" (Indicates whether an account for valid but unregistered usernames can be created).
+      # @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 || ["blockinfo", "groups", "groupmemberships", "implicitgroups", "rights", "editcount", "registration", "emailable", "gender", "centralids", "cancreate"].include?(value.to_s) && merge(usprop: value.to_s, replace: false)
+      end
+
+      # With usprop=centralids, indicate whether the user is attached with the wiki identified by this ID.
+      #
+      # @param value [String]
+      # @return [self]
+      def attachedwiki(value)
+        merge(usattachedwiki: value.to_s)
+      end
+
+      # A list of users to obtain information for.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def users(*values)
+        values.inject(self) { |res, val| res._users(val) }
+      end
+
+      # @private
+      def _users(value)
+        merge(ususers: value.to_s, replace: false)
+      end
+
+      # A list of user IDs to obtain information for.
+      #
+      # @param values [Array<Integer>]
+      # @return [self]
+      def userids(*values)
+        values.inject(self) { |res, val| res._userids(val) }
+      end
+
+      # @private
+      def _userids(value)
+        merge(ususerids: value.to_s, replace: false)
+      end
+
+      # Use action=query&meta=tokens instead.
+      #
+      # @param values [Array<String>] Allowed values: "userrights".
+      # @return [self]
+      def token(*values)
+        values.inject(self) { |res, val| res._token(val) or fail ArgumentError, "Unknown value for token: #{val}" }
+      end
+
+      # @private
+      def _token(value)
+        defined?(super) && super || ["userrights"].include?(value.to_s) && merge(ustoken: value.to_s, replace: false)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/modules/videoinfo.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Extends imageinfo to include video source (derivatives) information
+    #
+    # The "submodule" (MediaWiki API term) is included in action after setting some param, providing
+    # additional tweaking for this param. Example (for {MediaWiktory::Wikipedia::Actions::Query} and
+    # its submodules):
+    #
+    # ```ruby
+    # api.query             # returns Actions::Query
+    #    .prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
+    #    .limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL
+    # ```
+    #
+    # All submodule's parameters are documented as its public methods, see below.
+    #
+    module Videoinfo
+
+      # Which file information to get:
+      #
+      # @param values [Array<String>] Allowed values: "timestamp" (Adds timestamp for the uploaded version), "user" (Adds the user who uploaded each file version), "userid" (Add the ID of the user that uploaded each file version), "comment" (Comment on the version), "parsedcomment" (Parse the comment on the version), "canonicaltitle" (Adds the canonical title of the file), "url" (Gives URL to the file and the description page), "size" (Adds the size of the file in bytes and the height, width and page count (if applicable)), "dimensions" (Alias for size), "sha1" (Adds SHA-1 hash for the file), "mime" (Adds MIME type of the file), "thumbmime" (Adds MIME type of the image thumbnail (requires url and param viurlwidth)), "mediatype" (Adds the media type of the file), "metadata" (Lists Exif metadata for the version of the file), "commonmetadata" (Lists file format generic metadata for the version of the file), "extmetadata" (Lists formatted metadata combined from multiple sources. Results are HTML formatted), "archivename" (Adds the filename of the archive version for non-latest versions), "bitdepth" (Adds the bit depth of the version), "uploadwarning" (Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core), "badfile" (Adds whether the file is on the MediaWiki:Bad image list), "derivatives" (Adds an array of the different format and quality versions of an audio or video file that are available), "timedtext" (Adds an array of the subtitles, captions and descriptions of an audio or video file that are available).
+      # @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 || ["timestamp", "user", "userid", "comment", "parsedcomment", "canonicaltitle", "url", "size", "dimensions", "sha1", "mime", "thumbmime", "mediatype", "metadata", "commonmetadata", "extmetadata", "archivename", "bitdepth", "uploadwarning", "badfile", "derivatives", "timedtext"].include?(value.to_s) && merge(viprop: value.to_s, replace: false)
+      end
+
+      # How many file revisions to return per file.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(vilimit: value.to_s)
+      end
+
+      # Timestamp to start listing from.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(vistart: value.iso8601)
+      end
+
+      # Timestamp to stop listing at.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(viend: value.iso8601)
+      end
+
+      # If viprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def urlwidth(value)
+        merge(viurlwidth: value.to_s)
+      end
+
+      # Similar to viurlwidth.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def urlheight(value)
+        merge(viurlheight: value.to_s)
+      end
+
+      # Version of metadata to use. If latest is specified, use latest version. Defaults to 1 for backwards compatibility.
+      #
+      # @param value [String]
+      # @return [self]
+      def metadataversion(value)
+        merge(vimetadataversion: value.to_s)
+      end
+
+      # What language to fetch extmetadata in. This affects both which translation to fetch, if multiple are available, as well as how things like numbers and various values are formatted.
+      #
+      # @param value [String]
+      # @return [self]
+      def extmetadatalanguage(value)
+        merge(viextmetadatalanguage: value.to_s)
+      end
+
+      # If translations for extmetadata property are available, fetch all of them.
+      #
+      # @return [self]
+      def extmetadatamultilang()
+        merge(viextmetadatamultilang: 'true')
+      end
+
+      # If specified and non-empty, only these keys will be returned for viprop=extmetadata.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def extmetadatafilter(*values)
+        values.inject(self) { |res, val| res._extmetadatafilter(val) }
+      end
+
+      # @private
+      def _extmetadatafilter(value)
+        merge(viextmetadatafilter: value.to_s, replace: false)
+      end
+
+      # A handler specific parameter string. For example, PDFs might use page15-100px. viurlwidth must be used and be consistent with viurlparam.
+      #
+      # @param value [String]
+      # @return [self]
+      def urlparam(value)
+        merge(viurlparam: value.to_s)
+      end
+
+      # If badfilecontexttitleprop=badfile is set, this is the page title used when evaluating the MediaWiki:Bad image list
+      #
+      # @param value [String]
+      # @return [self]
+      def badfilecontexttitle(value)
+        merge(vibadfilecontexttitle: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(vicontinue: value.to_s)
+      end
+
+      # Look only for files in the local repository.
+      #
+      # @param value [String]
+      # @return [self]
+      def localonly(value)
+        merge(vilocalonly: value.to_s)
+      end
+    end
+  end
+end

data/lib/mediawiktory/wikipedia/modules/watchlist.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get recent changes to pages in the current user's watchlist.
+    #
+    # The "submodule" (MediaWiki API term) is included in action after setting some param, providing
+    # additional tweaking for this param. Example (for {MediaWiktory::Wikipedia::Actions::Query} and
+    # its submodules):
+    #
+    # ```ruby
+    # api.query             # returns Actions::Query
+    #    .prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
+    #    .limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL
+    # ```
+    #
+    # All submodule's parameters are documented as its public methods, see below.
+    #
+    module Watchlist
+
+      # Include multiple revisions of the same page within given timeframe.
+      #
+      # @return [self]
+      def allrev()
+        merge(wlallrev: 'true')
+      end
+
+      # The timestamp to start enumerating from.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(wlstart: value.iso8601)
+      end
+
+      # The timestamp to end enumerating.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(wlend: value.iso8601)
+      end
+
+      # Filter changes to only the given namespaces.
+      #
+      # @param values [Array<String>] Allowed values: "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303".
+      # @return [self]
+      def namespace(*values)
+        values.inject(self) { |res, val| res._namespace(val) or fail ArgumentError, "Unknown value for namespace: #{val}" }
+      end
+
+      # @private
+      def _namespace(value)
+        defined?(super) && super || ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303"].include?(value.to_s) && merge(wlnamespace: value.to_s, replace: false)
+      end
+
+      # Only list changes by this user.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(wluser: value.to_s)
+      end
+
+      # Don't list changes by this user.
+      #
+      # @param value [String]
+      # @return [self]
+      def excludeuser(value)
+        merge(wlexcludeuser: value.to_s)
+      end
+
+      # In which direction to enumerate:
+      #
+      # @param value [String] One of "newer" (List oldest first. Note: wlstart has to be before wlend), "older" (List newest first (default). Note: wlstart has to be later than wlend).
+      # @return [self]
+      def dir(value)
+        _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
+      end
+
+      # @private
+      def _dir(value)
+        defined?(super) && super || ["newer", "older"].include?(value.to_s) && merge(wldir: value.to_s)
+      end
+
+      # How many total results to return per request.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(wllimit: value.to_s)
+      end
+
+      # Which additional properties to get:
+      #
+      # @param values [Array<String>] Allowed values: "ids" (Adds revision IDs and page IDs), "title" (Adds title of the page), "flags" (Adds flags for the edit), "user" (Adds the user who made the edit), "userid" (Adds user ID of whoever made the edit), "comment" (Adds comment of the edit), "parsedcomment" (Adds parsed comment of the edit), "timestamp" (Adds timestamp of the edit), "patrol" (Tags edits that are patrolled), "sizes" (Adds the old and new lengths of the page), "notificationtimestamp" (Adds timestamp of when the user was last notified about the edit), "loginfo" (Adds log information where appropriate).
+      # @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 || ["ids", "title", "flags", "user", "userid", "comment", "parsedcomment", "timestamp", "patrol", "sizes", "notificationtimestamp", "loginfo"].include?(value.to_s) && merge(wlprop: value.to_s, replace: false)
+      end
+
+      # Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set wlshow=minor|!anon.
+      #
+      # @param values [Array<String>] Allowed values: "minor", "!minor", "bot", "!bot", "anon", "!anon", "patrolled", "!patrolled", "unread", "!unread".
+      # @return [self]
+      def show(*values)
+        values.inject(self) { |res, val| res._show(val) or fail ArgumentError, "Unknown value for show: #{val}" }
+      end
+
+      # @private
+      def _show(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 type(*values)
+        values.inject(self) { |res, val| res._type(val) or fail ArgumentError, "Unknown value for type: #{val}" }
+      end
+
+      # @private
+      def _type(value)
+        defined?(super) && super || ["edit", "new", "log", "external", "categorize"].include?(value.to_s) && merge(wltype: value.to_s, replace: false)
+      end
+
+      # Used along with wltoken to access a different user's watchlist.
+      #
+      # @param value [String]
+      # @return [self]
+      def owner(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 token(value)
+        merge(wltoken: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(wlcontinue: value.to_s)
+      end
+    end
+  end
+end