mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Find all pages that link to the given language link.
+    #
+    # 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 Langbacklinks
+
+      # Language for the language link.
+      #
+      # @param value [String]
+      # @return [self]
+      def lang(value)
+        merge(lbllang: value.to_s)
+      end
+
+      # Language link to search for. Must be used with lbllang.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(lbltitle: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(lblcontinue: value.to_s)
+      end
+
+      # How many total pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(lbllimit: value.to_s)
+      end
+
+      # Which properties to get:
+      #
+      # @param values [Array<String>] Allowed values: "lllang" (Adds the language code of the language link), "lltitle" (Adds the title of the language link).
+      # @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 || ["lllang", "lltitle"].include?(value.to_s) && merge(lblprop: value.to_s, replace: false)
+      end
+
+      # The direction in which to list.
+      #
+      # @param value [String] One of "ascending", "descending".
+      # @return [self]
+      def dir(value)
+        _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
+      end
+
+      # @private
+      def _dir(value)
+        defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(lbldir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns all interlanguage links from the given pages.
+    #
+    # 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 Langlinks
+
+      # Which additional properties to get for each interlanguage link:
+      #
+      # @param values [Array<String>] Allowed values: "url" (Adds the full URL), "langname" (Adds the localised language name (best effort). Use llinlanguagecode to control the language), "autonym" (Adds the native language name).
+      # @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 || ["url", "langname", "autonym"].include?(value.to_s) && merge(llprop: value.to_s, replace: false)
+      end
+
+      # Only return language links with this language code.
+      #
+      # @param value [String]
+      # @return [self]
+      def lang(value)
+        merge(lllang: value.to_s)
+      end
+
+      # Link to search for. Must be used with lllang.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(lltitle: value.to_s)
+      end
+
+      # The direction in which to list.
+      #
+      # @param value [String] One of "ascending", "descending".
+      # @return [self]
+      def dir(value)
+        _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
+      end
+
+      # @private
+      def _dir(value)
+        defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(lldir: value.to_s)
+      end
+
+      # Language code for localised language names.
+      #
+      # @param value [String]
+      # @return [self]
+      def inlanguagecode(value)
+        merge(llinlanguagecode: value.to_s)
+      end
+
+      # How many langlinks to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(lllimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(llcontinue: value.to_s)
+      end
+
+      # Whether to get the full URL (cannot be used with llprop).
+      #
+      # @return [self]
+      def url()
+        merge(llurl: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns all links from the given pages.
+    #
+    # 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 Links
+
+      # Show links in these namespaces only.
+      #
+      # @param values [Array<String>] Allowed values: "-2", "-1", "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 || ["-2", "-1", "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(plnamespace: value.to_s, replace: false)
+      end
+
+      # How many links to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(pllimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(plcontinue: value.to_s)
+      end
+
+      # Only list links to these titles. Useful for checking whether a certain page links to a certain title.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def titles(*values)
+        values.inject(self) { |res, val| res._titles(val) }
+      end
+
+      # @private
+      def _titles(value)
+        merge(pltitles: value.to_s, replace: false)
+      end
+
+      # The direction in which to list.
+      #
+      # @param value [String] One of "ascending", "descending".
+      # @return [self]
+      def dir(value)
+        _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
+      end
+
+      # @private
+      def _dir(value)
+        defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(pldir: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Find all pages that link to the given pages.
+    #
+    # 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 Linkshere
+
+      # Which properties to get:
+      #
+      # @param values [Array<String>] Allowed values: "pageid" (Page ID of each page), "title" (Title of each page), "redirect" (Flag if the page is a redirect).
+      # @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 || ["pageid", "title", "redirect"].include?(value.to_s) && merge(lhprop: value.to_s, replace: false)
+      end
+
+      # Only include pages 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(lhnamespace: value.to_s, replace: false)
+      end
+
+      # Show only items that meet these criteria:
+      #
+      # @param values [Array<String>] Allowed values: "redirect" (Only show redirects), "!redirect" (Only show non-redirects).
+      # @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 || ["redirect", "!redirect"].include?(value.to_s) && merge(lhshow: value.to_s, replace: false)
+      end
+
+      # How many to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(lhlimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(lhcontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get events from logs.
+    #
+    # 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 Logevents
+
+      # Which properties to get:
+      #
+      # @param values [Array<String>] Allowed values: "ids" (Adds the ID of the log event), "title" (Adds the title of the page for the log event), "type" (Adds the type of log event), "user" (Adds the user responsible for the log event), "userid" (Adds the user ID who was responsible for the log event), "timestamp" (Adds the timestamp for the log event), "comment" (Adds the comment of the log event), "parsedcomment" (Adds the parsed comment of the log event), "details" (Lists additional details about the log event), "tags" (Lists tags for the log event).
+      # @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", "type", "user", "userid", "timestamp", "comment", "parsedcomment", "details", "tags"].include?(value.to_s) && merge(leprop: value.to_s, replace: false)
+      end
+
+      # Filter log entries to only this type.
+      #
+      # @param value [String] One of "spamblacklist", "titleblacklist", "gblblock", "renameuser", "globalauth", "gblrights", "gblrename", "abusefilter", "massmessage", "pagetriage-curation", "pagetriage-deletion", "institution", "course", "student", "online", "campus", "instructor", "thanks", "usermerge", "block", "protect", "rights", "delete", "upload", "move", "import", "patrol", "merge", "suppress", "tag", "managetags", "contentmodel", "review", "stable", "timedmediahandler", "newusers".
+      # @return [self]
+      def type(value)
+        _type(value) or fail ArgumentError, "Unknown value for type: #{value}"
+      end
+
+      # @private
+      def _type(value)
+        defined?(super) && super || ["spamblacklist", "titleblacklist", "gblblock", "renameuser", "globalauth", "gblrights", "gblrename", "abusefilter", "massmessage", "pagetriage-curation", "pagetriage-deletion", "institution", "course", "student", "online", "campus", "instructor", "thanks", "usermerge", "block", "protect", "rights", "delete", "upload", "move", "import", "patrol", "merge", "suppress", "tag", "managetags", "contentmodel", "review", "stable", "timedmediahandler", "newusers"].include?(value.to_s) && merge(letype: value.to_s)
+      end
+
+      # Filter log actions to only this action. Overrides letype. In the list of possible values, values with the asterisk wildcard such as action/* can have different strings after the slash (/).
+      #
+      # @param value [String] One of "gblblock/gblock", "gblblock/gblock2", "gblblock/gunblock", "gblblock/modify", "globalauth/delete", "globalauth/lock", "globalauth/unlock", "globalauth/hide", "globalauth/unhide", "globalauth/lockandhid", "globalauth/setstatus", "suppress/setstatus", "suppress/cadelete", "gblrights/usergroups", "gblrights/groupperms", "gblrights/groupprms2", "gblrights/groupprms3", "suppress/hide-afl", "suppress/unhide-afl", "usermerge/mergeuser", "usermerge/deleteuser", "rights/erevoke", "spamblacklist/*", "titleblacklist/*", "gblblock/whitelist", "gblblock/dwhitelist", "renameuser/renameuser", "gblrights/grouprename", "gblrename/rename", "gblrename/promote", "gblrename/merge", "gblrights/newset", "gblrights/setrename", "gblrights/setnewtype", "gblrights/setchange", "gblrights/deleteset", "abusefilter/modify", "abusefilter/hit", "massmessage/*", "massmessage/send", "massmessage/failure", "massmessage/skipoptout", "massmessage/skipnouser", "massmessage/skipbadns", "pagetriage-curation/reviewed", "pagetriage-curation/unreviewed", "pagetriage-curation/tag", "pagetriage-curation/delete", "pagetriage-deletion/delete", "institution/*", "course/*", "student/*", "student/add", "student/remove", "online/*", "online/add", "online/remove", "campus/*", "campus/add", "campus/remove", "instructor/*", "instructor/add", "instructor/remove", "eparticle/*", "thanks/*", "block/block", "block/reblock", "block/unblock", "contentmodel/change", "contentmodel/new", "delete/delete", "delete/delete_redir", "delete/event", "delete/restore", "delete/revision", "import/interwiki", "import/upload", "managetags/activate", "managetags/create", "managetags/deactivate", "managetags/delete", "merge/merge", "move/move", "move/move_redir", "patrol/patrol", "patrol/autopatrol", "protect/modify", "protect/move_prot", "protect/protect", "protect/unprotect", "rights/autopromote", "rights/rights", "suppress/block", "suppress/delete", "suppress/event", "suppress/reblock", "suppress/revision", "tag/update", "upload/overwrite", "upload/revert", "upload/upload", "review/approve", "review/approve2", "review/approve-i", "review/approve2-i", "review/approve-a", "review/approve2-a", "review/approve-ia", "review/approve2-ia", "review/unapprove", "review/unapprove2", "stable/config", "stable/modify", "stable/reset", "stable/move_stable", "timedmediahandler/resettranscode", "newusers/newusers", "newusers/create", "newusers/create2", "newusers/byemail", "newusers/autocreate".
+      # @return [self]
+      def action(value)
+        _action(value) or fail ArgumentError, "Unknown value for action: #{value}"
+      end
+
+      # @private
+      def _action(value)
+        defined?(super) && super || ["gblblock/gblock", "gblblock/gblock2", "gblblock/gunblock", "gblblock/modify", "globalauth/delete", "globalauth/lock", "globalauth/unlock", "globalauth/hide", "globalauth/unhide", "globalauth/lockandhid", "globalauth/setstatus", "suppress/setstatus", "suppress/cadelete", "gblrights/usergroups", "gblrights/groupperms", "gblrights/groupprms2", "gblrights/groupprms3", "suppress/hide-afl", "suppress/unhide-afl", "usermerge/mergeuser", "usermerge/deleteuser", "rights/erevoke", "spamblacklist/*", "titleblacklist/*", "gblblock/whitelist", "gblblock/dwhitelist", "renameuser/renameuser", "gblrights/grouprename", "gblrename/rename", "gblrename/promote", "gblrename/merge", "gblrights/newset", "gblrights/setrename", "gblrights/setnewtype", "gblrights/setchange", "gblrights/deleteset", "abusefilter/modify", "abusefilter/hit", "massmessage/*", "massmessage/send", "massmessage/failure", "massmessage/skipoptout", "massmessage/skipnouser", "massmessage/skipbadns", "pagetriage-curation/reviewed", "pagetriage-curation/unreviewed", "pagetriage-curation/tag", "pagetriage-curation/delete", "pagetriage-deletion/delete", "institution/*", "course/*", "student/*", "student/add", "student/remove", "online/*", "online/add", "online/remove", "campus/*", "campus/add", "campus/remove", "instructor/*", "instructor/add", "instructor/remove", "eparticle/*", "thanks/*", "block/block", "block/reblock", "block/unblock", "contentmodel/change", "contentmodel/new", "delete/delete", "delete/delete_redir", "delete/event", "delete/restore", "delete/revision", "import/interwiki", "import/upload", "managetags/activate", "managetags/create", "managetags/deactivate", "managetags/delete", "merge/merge", "move/move", "move/move_redir", "patrol/patrol", "patrol/autopatrol", "protect/modify", "protect/move_prot", "protect/protect", "protect/unprotect", "rights/autopromote", "rights/rights", "suppress/block", "suppress/delete", "suppress/event", "suppress/reblock", "suppress/revision", "tag/update", "upload/overwrite", "upload/revert", "upload/upload", "review/approve", "review/approve2", "review/approve-i", "review/approve2-i", "review/approve-a", "review/approve2-a", "review/approve-ia", "review/approve2-ia", "review/unapprove", "review/unapprove2", "stable/config", "stable/modify", "stable/reset", "stable/move_stable", "timedmediahandler/resettranscode", "newusers/newusers", "newusers/create", "newusers/create2", "newusers/byemail", "newusers/autocreate"].include?(value.to_s) && merge(leaction: value.to_s)
+      end
+
+      # The timestamp to start enumerating from.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(lestart: value.iso8601)
+      end
+
+      # The timestamp to end enumerating.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(leend: value.iso8601)
+      end
+
+      # In which direction to enumerate:
+      #
+      # @param value [String] One of "newer" (List oldest first. Note: lestart has to be before leend), "older" (List newest first (default). Note: lestart has to be later than leend).
+      # @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(ledir: value.to_s)
+      end
+
+      # Filter entries to those made by the given user.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(leuser: value.to_s)
+      end
+
+      # Filter entries to those related to a page.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(letitle: value.to_s)
+      end
+
+      # Filter entries to those in the given namespace.
+      #
+      # @param value [String] One of "-2", "-1", "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(value)
+        _namespace(value) or fail ArgumentError, "Unknown value for namespace: #{value}"
+      end
+
+      # @private
+      def _namespace(value)
+        defined?(super) && super || ["-2", "-1", "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(lenamespace: value.to_s)
+      end
+
+      # Disabled due to miser mode.
+      #
+      # @param value [String]
+      # @return [self]
+      def prefix(value)
+        merge(leprefix: value.to_s)
+      end
+
+      # Only list event entries tagged with this tag.
+      #
+      # @param value [String]
+      # @return [self]
+      def tag(value)
+        merge(letag: value.to_s)
+      end
+
+      # How many total event entries to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(lelimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(lecontinue: value.to_s)
+      end
+    end
+  end
+end