mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Returns all redirects 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 Redirects
+
+      # Which properties to get:
+      #
+      # @param values [Array<String>] Allowed values: "pageid" (Page ID of each redirect), "title" (Title of each redirect), "fragment" (Fragment of each redirect, if any).
+      # @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", "fragment"].include?(value.to_s) && merge(rdprop: 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(rdnamespace: value.to_s, replace: false)
+      end
+
+      # Show only items that meet these criteria:
+      #
+      # @param values [Array<String>] Allowed values: "fragment" (Only show redirects with a fragment), "!fragment" (Only show redirects without a fragment).
+      # @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 || ["fragment", "!fragment"].include?(value.to_s) && merge(rdshow: value.to_s, replace: false)
+      end
+
+      # How many redirects to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(rdlimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(rdcontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Return a data representation of references associated with 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 References
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(rfcontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Get revision 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 Revisions
+
+      # Which properties to get for each revision:
+      #
+      # @param values [Array<String>] Allowed values: "ids" (The ID of the revision), "flags" (Revision flags (minor)), "timestamp" (The timestamp of the revision), "user" (User that made the revision), "userid" (User ID of the revision creator), "size" (Length (bytes) of the revision), "sha1" (SHA-1 (base 16) of the revision), "contentmodel" (Content model ID of the revision), "comment" (Comment by the user for the revision), "parsedcomment" (Parsed comment by the user for the revision), "content" (Text of the revision), "tags" (Tags for the revision), "parsetree" (The XML parse tree of revision content (requires content model wikitext)), "flagged" (Flagged status of the revision).
+      # @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", "flags", "timestamp", "user", "userid", "size", "sha1", "contentmodel", "comment", "parsedcomment", "content", "tags", "parsetree", "flagged"].include?(value.to_s) && merge(rvprop: value.to_s, replace: false)
+      end
+
+      # Limit how many revisions will be returned.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(rvlimit: value.to_s)
+      end
+
+      # Expand templates in revision content (requires rvprop=content).
+      #
+      # @return [self]
+      def expandtemplates()
+        merge(rvexpandtemplates: 'true')
+      end
+
+      # Generate XML parse tree for revision content (requires rvprop=content; replaced by rvprop=parsetree).
+      #
+      # @return [self]
+      def generatexml()
+        merge(rvgeneratexml: 'true')
+      end
+
+      # Parse revision content (requires rvprop=content). For performance reasons, if this option is used, rvlimit is enforced to 1.
+      #
+      # @return [self]
+      def parse()
+        merge(rvparse: 'true')
+      end
+
+      # Only retrieve the content of this section number.
+      #
+      # @param value [String]
+      # @return [self]
+      def section(value)
+        merge(rvsection: value.to_s)
+      end
+
+      # Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.
+      #
+      # @param value [String]
+      # @return [self]
+      def diffto(value)
+        merge(rvdiffto: value.to_s)
+      end
+
+      # Text to diff each revision to. Only diffs a limited number of revisions. Overrides rvdiffto. If rvsection is set, only that section will be diffed against this text.
+      #
+      # @param value [String]
+      # @return [self]
+      def difftotext(value)
+        merge(rvdifftotext: value.to_s)
+      end
+
+      # Perform a pre-save transform on the text before diffing it. Only valid when used with rvdifftotext.
+      #
+      # @return [self]
+      def difftotextpst()
+        merge(rvdifftotextpst: 'true')
+      end
+
+      # Serialization format used for rvdifftotext and expected for output of content.
+      #
+      # @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(rvcontentformat: value.to_s)
+      end
+
+      # From which revision ID to start enumeration.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def startid(value)
+        merge(rvstartid: value.to_s)
+      end
+
+      # Stop revision enumeration on this revision ID.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def endid(value)
+        merge(rvendid: value.to_s)
+      end
+
+      # From which revision timestamp to start enumeration.
+      #
+      # @param value [Time]
+      # @return [self]
+      def start(value)
+        merge(rvstart: value.iso8601)
+      end
+
+      # Enumerate up to this timestamp.
+      #
+      # @param value [Time]
+      # @return [self]
+      def end(value)
+        merge(rvend: value.iso8601)
+      end
+
+      # In which direction to enumerate:
+      #
+      # @param value [String] One of "newer" (List oldest first. Note: rvstart has to be before rvend), "older" (List newest first (default). Note: rvstart has to be later than rvend).
+      # @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(rvdir: value.to_s)
+      end
+
+      # Only include revisions made by user.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(rvuser: value.to_s)
+      end
+
+      # Exclude revisions made by user.
+      #
+      # @param value [String]
+      # @return [self]
+      def excludeuser(value)
+        merge(rvexcludeuser: value.to_s)
+      end
+
+      # Only list revisions tagged with this tag.
+      #
+      # @param value [String]
+      # @return [self]
+      def tag(value)
+        merge(rvtag: value.to_s)
+      end
+
+      # Which tokens to obtain for each revision.
+      #
+      # @param values [Array<String>] Allowed values: "rollback".
+      # @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 || ["rollback"].include?(value.to_s) && merge(rvtoken: value.to_s, replace: false)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [String]
+      # @return [self]
+      def continue(value)
+        merge(rvcontinue: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Perform a full text search.
+    #
+    # 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 Search
+
+      # Search for page titles or content matching this value. You can use the search string to invoke special search features, depending on what the wiki's search backend implements.
+      #
+      # @param value [String]
+      # @return [self]
+      def search(value)
+        merge(srsearch: value.to_s)
+      end
+
+      # Search only within 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(srnamespace: value.to_s, replace: false)
+      end
+
+      # How many total pages to return.
+      #
+      # @param value [Integer, "max"]
+      # @return [self]
+      def limit(value)
+        merge(srlimit: value.to_s)
+      end
+
+      # When more results are available, use this to continue.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def offset(value)
+        merge(sroffset: value.to_s)
+      end
+
+      # Query independent profile to use (affects ranking algorithm).
+      #
+      # @param value [String] One of "classic" (Ranking based on the number of incoming links, some templates, article language and recency (templates/language/recency may not be activated on this wiki)), "classic_noboostlinks" (Ranking based on some templates, article language and recency when activated on this wiki), "empty" (Ranking based solely on query dependent features (for debug only)), "wsum_inclinks" (Weighted sum based on incoming links), "wsum_inclinks_pv" (Weighted sum based on incoming links and weekly pageviews), "popular_inclinks_pv" (Ranking based primarily on page views), "popular_inclinks" (Ranking based primarily on incoming link counts).
+      # @return [self]
+      def qiprofile(value)
+        _qiprofile(value) or fail ArgumentError, "Unknown value for qiprofile: #{value}"
+      end
+
+      # @private
+      def _qiprofile(value)
+        defined?(super) && super || ["classic", "classic_noboostlinks", "empty", "wsum_inclinks", "wsum_inclinks_pv", "popular_inclinks_pv", "popular_inclinks"].include?(value.to_s) && merge(srqiprofile: value.to_s)
+      end
+
+      # Which type of search to perform.
+      #
+      # @param value [String] One of "title", "text", "nearmatch".
+      # @return [self]
+      def what(value)
+        _what(value) or fail ArgumentError, "Unknown value for what: #{value}"
+      end
+
+      # @private
+      def _what(value)
+        defined?(super) && super || ["title", "text", "nearmatch"].include?(value.to_s) && merge(srwhat: value.to_s)
+      end
+
+      # Which metadata to return.
+      #
+      # @param values [Array<String>] Allowed values: "totalhits", "suggestion", "rewrittenquery".
+      # @return [self]
+      def info(*values)
+        values.inject(self) { |res, val| res._info(val) or fail ArgumentError, "Unknown value for info: #{val}" }
+      end
+
+      # @private
+      def _info(value)
+        defined?(super) && super || ["totalhits", "suggestion", "rewrittenquery"].include?(value.to_s) && merge(srinfo: value.to_s, replace: false)
+      end
+
+      # Which properties to return:
+      #
+      # @param values [Array<String>] Allowed values: "size" (Adds the size of the page in bytes), "wordcount" (Adds the word count of the page), "timestamp" (Adds the timestamp of when the page was last edited), "snippet" (Adds a parsed snippet of the page), "titlesnippet" (Adds a parsed snippet of the page title), "redirecttitle" (Adds the title of the matching redirect), "redirectsnippet" (Adds a parsed snippet of the redirect title), "sectiontitle" (Adds the title of the matching section), "sectionsnippet" (Adds a parsed snippet of the matching section title), "isfilematch" (Adds a boolean indicating if the search matched file content), "categorysnippet" (Adds a parsed snippet of the matching category), "score" (Deprecated and ignored), "hasrelated" (Deprecated and ignored).
+      # @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 || ["size", "wordcount", "timestamp", "snippet", "titlesnippet", "redirecttitle", "redirectsnippet", "sectiontitle", "sectionsnippet", "isfilematch", "categorysnippet", "score", "hasrelated"].include?(value.to_s) && merge(srprop: value.to_s, replace: false)
+      end
+
+      # Include interwiki results in the search, if available.
+      #
+      # @return [self]
+      def interwiki()
+        merge(srinterwiki: 'true')
+      end
+
+      # Enable internal query rewriting. Some search backends can rewrite the query into one its thinks gives better results, such as correcting spelling errors.
+      #
+      # @return [self]
+      def enablerewrites()
+        merge(srenablerewrites: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Modules
+    # Return general information about the site.
+    #
+    # 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 Siteinfo
+
+      # Which information to get:
+      #
+      # @param values [Array<String>] Allowed values: "general" (Overall system information), "namespaces" (List of registered namespaces and their canonical names), "namespacealiases" (List of registered namespace aliases), "specialpagealiases" (List of special page aliases), "magicwords" (List of magic words and their aliases), "interwikimap" (Returns interwiki map (optionally filtered, optionally localised by using siinlanguagecode)), "dbrepllag" (Returns database server with the highest replication lag), "statistics" (Returns site statistics), "usergroups" (Returns user groups and the associated permissions), "libraries" (Returns libraries installed on the wiki), "extensions" (Returns extensions installed on the wiki), "fileextensions" (Returns list of file extensions (file types) allowed to be uploaded), "rightsinfo" (Returns wiki rights (license) information if available), "restrictions" (Returns information on available restriction (protection) types), "languages" (Returns a list of languages MediaWiki supports (optionally localised by using siinlanguagecode)), "languagevariants" (Returns a list of language codes for which LanguageConverter is enabled, and the variants supported for each), "skins" (Returns a list of all enabled skins (optionally localised by using siinlanguagecode, otherwise in the content language)), "extensiontags" (Returns a list of parser extension tags), "functionhooks" (Returns a list of parser function hooks), "showhooks" (Returns a list of all subscribed hooks (contents of $wgHooks)), "variables" (Returns a list of variable IDs), "protocols" (Returns a list of protocols that are allowed in external links), "defaultoptions" (Returns the default values for user preferences), "uploaddialog" (Returns the upload dialog configuration).
+      # @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 || ["general", "namespaces", "namespacealiases", "specialpagealiases", "magicwords", "interwikimap", "dbrepllag", "statistics", "usergroups", "libraries", "extensions", "fileextensions", "rightsinfo", "restrictions", "languages", "languagevariants", "skins", "extensiontags", "functionhooks", "showhooks", "variables", "protocols", "defaultoptions", "uploaddialog"].include?(value.to_s) && merge(siprop: value.to_s, replace: false)
+      end
+
+      # Return only local or only nonlocal entries of the interwiki map.
+      #
+      # @param value [String] One of "local", "!local".
+      # @return [self]
+      def filteriw(value)
+        _filteriw(value) or fail ArgumentError, "Unknown value for filteriw: #{value}"
+      end
+
+      # @private
+      def _filteriw(value)
+        defined?(super) && super || ["local", "!local"].include?(value.to_s) && merge(sifilteriw: value.to_s)
+      end
+
+      # List all database servers, not just the one lagging the most.
+      #
+      # @return [self]
+      def showalldb()
+        merge(sishowalldb: 'true')
+      end
+
+      # Lists the number of users in user groups.
+      #
+      # @return [self]
+      def numberingroup()
+        merge(sinumberingroup: 'true')
+      end
+
+      # Language code for localised language names (best effort) and skin names.
+      #
+      # @param value [String]
+      # @return [self]
+      def inlanguagecode(value)
+        merge(siinlanguagecode: value.to_s)
+      end
+    end
+  end
+end