mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Add tags to an article.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.pagetriagetagging.pageid(value).perform # returns string with raw output
+    # # or
+    # api.pagetriagetagging.pageid(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 Pagetriagetagging < MediaWiktory::Wikipedia::Actions::Post
+
+      # The article for which to be tagged.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def pageid(value)
+        merge(pageid: 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
+
+      # The tagging text to be added to the top of an article.
+      #
+      # @param value [String]
+      # @return [self]
+      def top(value)
+        merge(top: value.to_s)
+      end
+
+      # The tagging text to be added to the bottom of an article.
+      #
+      # @param value [String]
+      # @return [self]
+      def bottom(value)
+        merge(bottom: value.to_s)
+      end
+
+      # Whether or not the tagging is for a deletion nomination.
+      #
+      # @return [self]
+      def deletion()
+        merge(deletion: 'true')
+      end
+
+      # Personal note to page creators from reviewers.
+      #
+      # @param value [String]
+      # @return [self]
+      def note(value)
+        merge(note: value.to_s)
+      end
+
+      # Pipe-separated list of tags.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def taglist(*values)
+        values.inject(self) { |res, val| res._taglist(val) }
+      end
+
+      # @private
+      def _taglist(value)
+        merge(taglist: value.to_s, replace: false)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Fetch templates that are used within the PageTriage application.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.pagetriagetemplate.view(value).perform # returns string with raw output
+    # # or
+    # api.pagetriagetemplate.view(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 Pagetriagetemplate < MediaWiktory::Wikipedia::Actions::Get
+
+      # The PageTriage view for which you need the templates.
+      #
+      # @param value [String]
+      # @return [self]
+      def view(value)
+        merge(view: value.to_s)
+      end
+
+      # The template to fetch. Separate multiple with the | character.
+      #
+      # @param value [String]
+      # @return [self]
+      def template(value)
+        merge(template: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Obtain information about API modules.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.paraminfo.modules(value).perform # returns string with raw output
+    # # or
+    # api.paraminfo.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 Paraminfo < MediaWiktory::Wikipedia::Actions::Get
+
+      # List of module names (values of the action and format parameters, or main). Can specify submodules with a +, or all submodules with +*, or all submodules recursively with +**.
+      #
+      # @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
+
+      # Format of help strings.
+      #
+      # @param value [String] One of "html", "wikitext", "raw", "none".
+      # @return [self]
+      def helpformat(value)
+        _helpformat(value) or fail ArgumentError, "Unknown value for helpformat: #{value}"
+      end
+
+      # @private
+      def _helpformat(value)
+        defined?(super) && super || ["html", "wikitext", "raw", "none"].include?(value.to_s) && merge(helpformat: value.to_s)
+      end
+
+      # List of query module names (value of prop, meta or list parameter). Use modules=query+foo instead of querymodules=foo.
+      #
+      # @param values [Array<String>] Allowed values: "abusefilters", "abuselog", "allcategories", "alldeletedrevisions", "allfileusages", "allimages", "alllinks", "allmessages", "allpages", "allredirects", "allrevisions", "alltransclusions", "allusers", "authmanagerinfo", "babel", "backlinks", "betafeatures", "blocks", "categories", "categoryinfo", "categorymembers", "centralnoticelogs", "checkuser", "checkuserlog", "contenttranslation", "contenttranslationcorpora", "contenttranslationlangtrend", "contenttranslationstats", "contenttranslationsuggestions", "contributors", "coordinates", "cxpublishedtranslations", "cxtranslatorstats", "deletedrevisions", "deletedrevs", "duplicatefiles", "embeddedin", "extlinks", "extracts", "exturlusage", "featureusage", "filearchive", "filerepoinfo", "fileusage", "flagged", "gadgetcategories", "gadgets", "geosearch", "gettingstartedgetpages", "globalallusers", "globalblocks", "globalgroups", "globalusage", "globaluserinfo", "imageinfo", "images", "imageusage", "info", "iwbacklinks", "iwlinks", "langbacklinks", "langlinks", "links", "linkshere", "logevents", "mapdata", "mmsites", "mostviewed", "mystashedfiles", "notifications", "oath", "oldreviewedpages", "ores", "pageassessments", "pageimages", "pagepropnames", "pageprops", "pageswithprop", "pageterms", "pageviews", "prefixsearch", "projectpages", "projects", "protectedtitles", "querypage", "random", "recentchanges", "redirects", "references", "revisions", "search", "siteinfo", "siteviews", "stashimageinfo", "tags", "templates", "tokens", "transcludedin", "transcodestatus", "unreadnotificationpages", "usercontribs", "userinfo", "users", "videoinfo", "watchlist", "watchlistraw", "wbentityusage", "wblistentityusage", "wikibase", "wikisets".
+      # @return [self]
+      def querymodules(*values)
+        values.inject(self) { |res, val| res._querymodules(val) or fail ArgumentError, "Unknown value for querymodules: #{val}" }
+      end
+
+      # @private
+      def _querymodules(value)
+        defined?(super) && super || ["abusefilters", "abuselog", "allcategories", "alldeletedrevisions", "allfileusages", "allimages", "alllinks", "allmessages", "allpages", "allredirects", "allrevisions", "alltransclusions", "allusers", "authmanagerinfo", "babel", "backlinks", "betafeatures", "blocks", "categories", "categoryinfo", "categorymembers", "centralnoticelogs", "checkuser", "checkuserlog", "contenttranslation", "contenttranslationcorpora", "contenttranslationlangtrend", "contenttranslationstats", "contenttranslationsuggestions", "contributors", "coordinates", "cxpublishedtranslations", "cxtranslatorstats", "deletedrevisions", "deletedrevs", "duplicatefiles", "embeddedin", "extlinks", "extracts", "exturlusage", "featureusage", "filearchive", "filerepoinfo", "fileusage", "flagged", "gadgetcategories", "gadgets", "geosearch", "gettingstartedgetpages", "globalallusers", "globalblocks", "globalgroups", "globalusage", "globaluserinfo", "imageinfo", "images", "imageusage", "info", "iwbacklinks", "iwlinks", "langbacklinks", "langlinks", "links", "linkshere", "logevents", "mapdata", "mmsites", "mostviewed", "mystashedfiles", "notifications", "oath", "oldreviewedpages", "ores", "pageassessments", "pageimages", "pagepropnames", "pageprops", "pageswithprop", "pageterms", "pageviews", "prefixsearch", "projectpages", "projects", "protectedtitles", "querypage", "random", "recentchanges", "redirects", "references", "revisions", "search", "siteinfo", "siteviews", "stashimageinfo", "tags", "templates", "tokens", "transcludedin", "transcodestatus", "unreadnotificationpages", "usercontribs", "userinfo", "users", "videoinfo", "watchlist", "watchlistraw", "wbentityusage", "wblistentityusage", "wikibase", "wikisets"].include?(value.to_s) && merge(querymodules: value.to_s, replace: false)
+      end
+
+      # Get information about the main (top-level) module as well. Use modules=main instead.
+      #
+      # @param value [String]
+      # @return [self]
+      def mainmodule(value)
+        merge(mainmodule: value.to_s)
+      end
+
+      # Get information about the pageset module (providing titles= and friends) as well.
+      #
+      # @param value [String]
+      # @return [self]
+      def pagesetmodule(value)
+        merge(pagesetmodule: value.to_s)
+      end
+
+      # List of format module names (value of format parameter). Use modules instead.
+      #
+      # @param values [Array<String>] Allowed values: "json", "jsonfm", "none", "php", "phpfm", "rawfm", "xml", "xmlfm".
+      # @return [self]
+      def formatmodules(*values)
+        values.inject(self) { |res, val| res._formatmodules(val) or fail ArgumentError, "Unknown value for formatmodules: #{val}" }
+      end
+
+      # @private
+      def _formatmodules(value)
+        defined?(super) && super || ["json", "jsonfm", "none", "php", "phpfm", "rawfm", "xml", "xmlfm"].include?(value.to_s) && merge(formatmodules: value.to_s, replace: false)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,286 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Parses content and returns parser output.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.parse.title(value).perform # returns string with raw output
+    # # or
+    # api.parse.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 Parse < MediaWiktory::Wikipedia::Actions::Get
+
+      # Title of page the text belongs to. If omitted, contentmodel must be specified, and API will be used as the title.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(title: value.to_s)
+      end
+
+      # Text to parse. Use title or contentmodel to control the content model.
+      #
+      # @param value [String]
+      # @return [self]
+      def text(value)
+        merge(text: value.to_s)
+      end
+
+      # Summary to parse.
+      #
+      # @param value [String]
+      # @return [self]
+      def summary(value)
+        merge(summary: value.to_s)
+      end
+
+      # Parse the content of this page. Cannot be used together with text and title.
+      #
+      # @param value [String]
+      # @return [self]
+      def page(value)
+        merge(page: value.to_s)
+      end
+
+      # Parse the content of this page. Overrides page.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def pageid(value)
+        merge(pageid: value.to_s)
+      end
+
+      # If page or pageid is set to a redirect, resolve it.
+      #
+      # @return [self]
+      def redirects()
+        merge(redirects: 'true')
+      end
+
+      # Parse the content of this revision. Overrides page and pageid.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def oldid(value)
+        merge(oldid: value.to_s)
+      end
+
+      # Which pieces of information to get:
+      #
+      # @param values [Array<String>] Allowed values: "text" (Gives the parsed text of the wikitext), "langlinks" (Gives the language links in the parsed wikitext), "categories" (Gives the categories in the parsed wikitext), "categorieshtml" (Gives the HTML version of the categories), "links" (Gives the internal links in the parsed wikitext), "templates" (Gives the templates in the parsed wikitext), "images" (Gives the images in the parsed wikitext), "externallinks" (Gives the external links in the parsed wikitext), "sections" (Gives the sections in the parsed wikitext), "revid" (Adds the revision ID of the parsed page), "displaytitle" (Adds the title of the parsed wikitext), "headitems" (Deprecated. Gives items to put in the <head> of the page), "headhtml" (Gives parsed <head> of the page), "modules" (Gives the ResourceLoader modules used on the page. To load, use mw.loader.using(). Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules), "jsconfigvars" (Gives the JavaScript configuration variables specific to the page. To apply, use mw.config.set()), "encodedjsconfigvars" (Gives the JavaScript configuration variables specific to the page as a JSON string), "indicators" (Gives the HTML of page status indicators used on the page), "iwlinks" (Gives interwiki links in the parsed wikitext), "wikitext" (Gives the original wikitext that was parsed), "properties" (Gives various properties defined in the parsed wikitext), "limitreportdata" (Gives the limit report in a structured way. Gives no data, when disablelimitreport is set), "limitreporthtml" (Gives the HTML version of the limit report. Gives no data, when disablelimitreport is set), "parsetree" (The XML parse tree of revision content (requires content model wikitext)), "parsewarnings" (Gives the warnings that occurred while parsing content).
+      # @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 || ["text", "langlinks", "categories", "categorieshtml", "links", "templates", "images", "externallinks", "sections", "revid", "displaytitle", "headitems", "headhtml", "modules", "jsconfigvars", "encodedjsconfigvars", "indicators", "iwlinks", "wikitext", "properties", "limitreportdata", "limitreporthtml", "parsetree", "parsewarnings"].include?(value.to_s) && merge(prop: value.to_s, replace: false)
+      end
+
+      # Do a pre-save transform on the input before parsing it. Only valid when used with text.
+      #
+      # @return [self]
+      def pst()
+        merge(pst: 'true')
+      end
+
+      # Do a pre-save transform (PST) on the input, but don't parse it. Returns the same wikitext, after a PST has been applied. Only valid when used with text.
+      #
+      # @return [self]
+      def onlypst()
+        merge(onlypst: 'true')
+      end
+
+      # Includes language links supplied by extensions (for use with prop=langlinks).
+      #
+      # @return [self]
+      def effectivelanglinks()
+        merge(effectivelanglinks: 'true')
+      end
+
+      # Only parse the content of this section number.
+      #
+      # @param value [String]
+      # @return [self]
+      def section(value)
+        merge(section: value.to_s)
+      end
+
+      # New section title when section is new.
+      #
+      # @param value [String]
+      # @return [self]
+      def sectiontitle(value)
+        merge(sectiontitle: value.to_s)
+      end
+
+      # Use disablelimitreport instead.
+      #
+      # @return [self]
+      def disablepp()
+        merge(disablepp: 'true')
+      end
+
+      # Omit the limit report ("NewPP limit report") from the parser output.
+      #
+      # @return [self]
+      def disablelimitreport()
+        merge(disablelimitreport: 'true')
+      end
+
+      # Omit edit section links from the parser output.
+      #
+      # @return [self]
+      def disableeditsection()
+        merge(disableeditsection: 'true')
+      end
+
+      # Do not run HTML cleanup (e.g. tidy) on the parser output.
+      #
+      # @return [self]
+      def disabletidy()
+        merge(disabletidy: 'true')
+      end
+
+      # Generate XML parse tree (requires content model wikitext; replaced by prop=parsetree).
+      #
+      # @return [self]
+      def generatexml()
+        merge(generatexml: 'true')
+      end
+
+      # Parse in preview mode.
+      #
+      # @return [self]
+      def preview()
+        merge(preview: 'true')
+      end
+
+      # Parse in section preview mode (enables preview mode too).
+      #
+      # @return [self]
+      def sectionpreview()
+        merge(sectionpreview: 'true')
+      end
+
+      # Omit table of contents in output.
+      #
+      # @return [self]
+      def disabletoc()
+        merge(disabletoc: 'true')
+      end
+
+      # Content serialization format used for the input text. Only valid when used with text.
+      #
+      # @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(contentformat: value.to_s)
+      end
+
+      # Content model of the input text. If omitted, title must be specified, and default will be the model of the specified title. Only valid when used with text.
+      #
+      # @param value [String] One of "GadgetDefinition", "SecurePoll", "MassMessageListContent", "JsonSchema", "wikitext", "javascript", "json", "css", "text", "Scribunto".
+      # @return [self]
+      def contentmodel(value)
+        _contentmodel(value) or fail ArgumentError, "Unknown value for contentmodel: #{value}"
+      end
+
+      # @private
+      def _contentmodel(value)
+        defined?(super) && super || ["GadgetDefinition", "SecurePoll", "MassMessageListContent", "JsonSchema", "wikitext", "javascript", "json", "css", "text", "Scribunto"].include?(value.to_s) && merge(contentmodel: value.to_s)
+      end
+
+      # Return parse output in a format suitable for mobile devices.
+      #
+      # @return [self]
+      def mobileformat()
+        merge(mobileformat: 'true')
+      end
+
+      # Disable images in mobile output.
+      #
+      # @return [self]
+      def noimages()
+        merge(noimages: 'true')
+      end
+
+      # Apply mobile main page transformations.
+      #
+      # @return [self]
+      def mainpage()
+        merge(mainpage: 'true')
+      end
+
+      # Template sandbox prefix, as with Special:TemplateSandbox.
+      #
+      # @param values [Array<String>]
+      # @return [self]
+      def templatesandboxprefix(*values)
+        values.inject(self) { |res, val| res._templatesandboxprefix(val) }
+      end
+
+      # @private
+      def _templatesandboxprefix(value)
+        merge(templatesandboxprefix: value.to_s, replace: false)
+      end
+
+      # Parse the page using templatesandboxtext in place of the contents of the page named here.
+      #
+      # @param value [String]
+      # @return [self]
+      def templatesandboxtitle(value)
+        merge(templatesandboxtitle: value.to_s)
+      end
+
+      # Parse the page using this page content in place of the page named by templatesandboxtitle.
+      #
+      # @param value [String]
+      # @return [self]
+      def templatesandboxtext(value)
+        merge(templatesandboxtext: value.to_s)
+      end
+
+      # Content model of templatesandboxtext.
+      #
+      # @param value [String] One of "GadgetDefinition", "SecurePoll", "MassMessageListContent", "JsonSchema", "wikitext", "javascript", "json", "css", "text", "Scribunto".
+      # @return [self]
+      def templatesandboxcontentmodel(value)
+        _templatesandboxcontentmodel(value) or fail ArgumentError, "Unknown value for templatesandboxcontentmodel: #{value}"
+      end
+
+      # @private
+      def _templatesandboxcontentmodel(value)
+        defined?(super) && super || ["GadgetDefinition", "SecurePoll", "MassMessageListContent", "JsonSchema", "wikitext", "javascript", "json", "css", "text", "Scribunto"].include?(value.to_s) && merge(templatesandboxcontentmodel: value.to_s)
+      end
+
+      # Content format of templatesandboxtext.
+      #
+      # @param value [String] One of "application/json", "text/x-wiki", "text/javascript", "text/css", "text/plain".
+      # @return [self]
+      def templatesandboxcontentformat(value)
+        _templatesandboxcontentformat(value) or fail ArgumentError, "Unknown value for templatesandboxcontentformat: #{value}"
+      end
+
+      # @private
+      def _templatesandboxcontentformat(value)
+        defined?(super) && super || ["application/json", "text/x-wiki", "text/javascript", "text/css", "text/plain"].include?(value.to_s) && merge(templatesandboxcontentformat: value.to_s)
+      end
+    end
+  end
+end