mediawiktory 0.0.3 → 0.1.0

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Associate or disassociate a user as instructor or volunteer for a course.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.enlist.subaction(value).perform # returns string with raw output
+    # # or
+    # api.enlist.subaction(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 Enlist < MediaWiktory::Wikipedia::Actions::Post
+
+      # Specifies what you want to do with the instructor or volunteer.
+      #
+      # @param value [String] One of "add", "remove".
+      # @return [self]
+      def subaction(value)
+        _subaction(value) or fail ArgumentError, "Unknown value for subaction: #{value}"
+      end
+
+      # @private
+      def _subaction(value)
+        defined?(super) && super || ["add", "remove"].include?(value.to_s) && merge(subaction: value.to_s)
+      end
+
+      # The role to affect. "instructor" for instructor, "online" for online volunteer and "campus" for campus volunteer.
+      #
+      # @param value [String] One of "instructor", "online", "campus", "student".
+      # @return [self]
+      def role(value)
+        _role(value) or fail ArgumentError, "Unknown value for role: #{value}"
+      end
+
+      # @private
+      def _role(value)
+        defined?(super) && super || ["instructor", "online", "campus", "student"].include?(value.to_s) && merge(role: value.to_s)
+      end
+
+      # Name of the user to associate or disassociate.
+      #
+      # @param value [String]
+      # @return [self]
+      def username(value)
+        merge(username: value.to_s)
+      end
+
+      # ID of the user to associate or disassociate.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def userid(value)
+        merge(userid: value.to_s)
+      end
+
+      # The ID of the course.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def courseid(value)
+        merge(courseid: value.to_s)
+      end
+
+      # Reason for this deletion, for the log.
+      #
+      # @param value [String]
+      # @return [self]
+      def reason(value)
+        merge(reason: value.to_s)
+      end
+
+      # A "csrf" token retrieved from action=query&meta=tokens
+      #
+      # @param value [String]
+      # @return [self]
+      def token(value)
+        merge(token: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Expands all templates within wikitext.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.expandtemplates.title(value).perform # returns string with raw output
+    # # or
+    # api.expandtemplates.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 Expandtemplates < MediaWiktory::Wikipedia::Actions::Get
+
+      # Title of page.
+      #
+      # @param value [String]
+      # @return [self]
+      def title(value)
+        merge(title: value.to_s)
+      end
+
+      # Wikitext to convert.
+      #
+      # @param value [String]
+      # @return [self]
+      def text(value)
+        merge(text: value.to_s)
+      end
+
+      # Revision ID, for {{REVISIONID}} and similar variables.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def revid(value)
+        merge(revid: value.to_s)
+      end
+
+      # Which pieces of information to get.
+      #
+      # @param values [Array<String>] Allowed values: "wikitext" (The expanded wikitext), "categories" (Any categories present in the input that are not represented in the wikitext output), "properties" (Page properties defined by expanded magic words in the wikitext), "volatile" (Whether the output is volatile and should not be reused elsewhere within the page), "ttl" (The maximum time after which caches of the result should be invalidated), "modules" (Any ResourceLoader modules that parser functions have requested be added to the output. Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules), "jsconfigvars" (Gives the JavaScript configuration variables specific to the page), "encodedjsconfigvars" (Gives the JavaScript configuration variables specific to the page as a JSON string), "parsetree" (The XML parse tree of the input).
+      # @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 || ["wikitext", "categories", "properties", "volatile", "ttl", "modules", "jsconfigvars", "encodedjsconfigvars", "parsetree"].include?(value.to_s) && merge(prop: value.to_s, replace: false)
+      end
+
+      # Whether to include HTML comments in the output.
+      #
+      # @return [self]
+      def includecomments()
+        merge(includecomments: 'true')
+      end
+
+      # Generate XML parse tree (replaced by prop=parsetree).
+      #
+      # @return [self]
+      def generatexml()
+        merge(generatexml: '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

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Get a new FancyCaptcha.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.fancycaptchareload.perform # returns string with raw output
+    # # or
+    # api.fancycaptchareload.response # returns output parsed and wrapped into Mash-like object
+    # ```
+    #
+    # This action has no parameters.
+    #
+    # See {Base} for generic explanation of working with MediaWiki actions and
+    # {MediaWiktory::Wikipedia::Response} for working with action responses.
+    #
+    # All action's parameters are documented as its public methods, see below.
+    #
+    class Fancycaptchareload < MediaWiktory::Wikipedia::Actions::Get
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Returns a featured content feed.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.featuredfeed.feedformat(value).perform # returns string with raw output
+    # # or
+    # api.featuredfeed.feedformat(value).response # returns output parsed and wrapped into Response object
+    # ```
+    #
+    # See {Base} for generic explanation of working with MediaWiki actions and
+    # {MediaWiktory::Wikipedia::Response} for working with action responses.
+    #
+    # All action's parameters are documented as its public methods, see below.
+    #
+    class Featuredfeed < MediaWiktory::Wikipedia::Actions::Get
+
+      # The format of the feed.
+      #
+      # @param value [String] One of "rss", "atom".
+      # @return [self]
+      def feedformat(value)
+        _feedformat(value) or fail ArgumentError, "Unknown value for feedformat: #{value}"
+      end
+
+      # @private
+      def _feedformat(value)
+        defined?(super) && super || ["rss", "atom"].include?(value.to_s) && merge(feedformat: value.to_s)
+      end
+
+      # Feed name.
+      #
+      # @param value [String] One of "potd", "featured", "onthisday".
+      # @return [self]
+      def feed(value)
+        _feed(value) or fail ArgumentError, "Unknown value for feed: #{value}"
+      end
+
+      # @private
+      def _feed(value)
+        defined?(super) && super || ["potd", "featured", "onthisday"].include?(value.to_s) && merge(feed: value.to_s)
+      end
+
+      # Feed language code. Ignored by some feeds.
+      #
+      # @param value [String]
+      # @return [self]
+      def language(value)
+        merge(language: value.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Returns a user contributions feed.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.feedcontributions.feedformat(value).perform # returns string with raw output
+    # # or
+    # api.feedcontributions.feedformat(value).response # returns output parsed and wrapped into Response object
+    # ```
+    #
+    # See {Base} for generic explanation of working with MediaWiki actions and
+    # {MediaWiktory::Wikipedia::Response} for working with action responses.
+    #
+    # All action's parameters are documented as its public methods, see below.
+    #
+    class Feedcontributions < MediaWiktory::Wikipedia::Actions::Get
+
+      # The format of the feed.
+      #
+      # @param value [String] One of "rss", "atom".
+      # @return [self]
+      def feedformat(value)
+        _feedformat(value) or fail ArgumentError, "Unknown value for feedformat: #{value}"
+      end
+
+      # @private
+      def _feedformat(value)
+        defined?(super) && super || ["rss", "atom"].include?(value.to_s) && merge(feedformat: value.to_s)
+      end
+
+      # What users to get the contributions for.
+      #
+      # @param value [String]
+      # @return [self]
+      def user(value)
+        merge(user: value.to_s)
+      end
+
+      # Which namespace to filter the contributions by.
+      #
+      # @param value [String] One of "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 || ["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(namespace: value.to_s)
+      end
+
+      # From year (and earlier).
+      #
+      # @param value [Integer]
+      # @return [self]
+      def year(value)
+        merge(year: value.to_s)
+      end
+
+      # From month (and earlier).
+      #
+      # @param value [Integer]
+      # @return [self]
+      def month(value)
+        merge(month: value.to_s)
+      end
+
+      # Filter contributions that have these tags.
+      #
+      # @param values [Array<String>] Allowed values: "ProveIt edit", "WPCleaner", "huggle", "large plot addition", "Possible disruption", "Newer user possibly adding unreferenced or improperly referenced material", "possible vandalism", "contenttranslation-needcheck", "possible link spam", "wikilinks removed", "External Link added to disambiguation page", "canned edit summary", "new blank article", "extraneous markup", "de-userfying", "Possible self promotion in userspace", "discretionary sanctions alert", "image added to template", "nowiki added", "userspace spam", "changing height or weight", "possible libel or vandalism", "End of page text", "non-English content", "Extraneous formatting", "reverting anti-vandal bot", "Possible vandalism", "Removal of interwiki link", "Rapid reverts", "adding email address", "nonsense characters", "removal of copyvio templates", "bad external", "large unwikified new article", "removal of articles for deletion template", "Section blanking", "possible cut and paste move", "unusual redirect", "coi-spam", "autobiography", "repeating characters", "categories removed", "removal of Category:Living People", "very short new article", "reference list removal", "references removed", "image template removal", "shouting", "talk page blanking", "blanking", "removal of speedy deletion templates", "self-renaming and bad user talk moves", "mw-contentmodelchange", "massmessage-delivery", "visualeditor", "visualeditor-needcheck", "visualeditor-switched", "visualeditor-wikitext", "wikilove", "mobile edit", "mobile app edit", "mobile web edit", "HHVM", "contenttranslation", "OAuth CID: 115", "OAuth CID: 142", "OAuth CID: 144", "OAuth CID: 150", "OAuth CID: 151", "OAuth CID: 154", "OAuth CID: 159", "OAuth CID: 194", "OAuth CID: 206", "OAuth CID: 21", "OAuth CID: 211", "OAuth CID: 212", "OAuth CID: 218", "OAuth CID: 236", "OAuth CID: 239", "OAuth CID: 251", "OAuth CID: 252", "OAuth CID: 259", "OAuth CID: 261", "OAuth CID: 263", "OAuth CID: 274", "OAuth CID: 278", "OAuth CID: 285", "OAuth CID: 297", "OAuth CID: 306", "OAuth CID: 314", "OAuth CID: 320", "OAuth CID: 376", "OAuth CID: 410", "OAuth CID: 429", "OAuth CID: 473", "OAuth CID: 540", "OAuth CID: 542", "OAuth CID: 543", "OAuth CID: 563", "OAuth CID: 593", "OAuth CID: 60", "OAuth CID: 612", "OAuth CID: 628", "OAuth CID: 64", "OAuth CID: 651", "OAuth CID: 67", "OAuth CID: 670", "OAuth CID: 678", "OAuth CID: 679", "OAuth CID: 76", "OAuth CID: 817", "OAuth CID: 85", "OAuth CID: 99".
+      # @return [self]
+      def tagfilter(*values)
+        values.inject(self) { |res, val| res._tagfilter(val) or fail ArgumentError, "Unknown value for tagfilter: #{val}" }
+      end
+
+      # @private
+      def _tagfilter(value)
+        defined?(super) && super || ["ProveIt edit", "WPCleaner", "huggle", "large plot addition", "Possible disruption", "Newer user possibly adding unreferenced or improperly referenced material", "possible vandalism", "contenttranslation-needcheck", "possible link spam", "wikilinks removed", "External Link added to disambiguation page", "canned edit summary", "new blank article", "extraneous markup", "de-userfying", "Possible self promotion in userspace", "discretionary sanctions alert", "image added to template", "nowiki added", "userspace spam", "changing height or weight", "possible libel or vandalism", "End of page text", "non-English content", "Extraneous formatting", "reverting anti-vandal bot", "Possible vandalism", "Removal of interwiki link", "Rapid reverts", "adding email address", "nonsense characters", "removal of copyvio templates", "bad external", "large unwikified new article", "removal of articles for deletion template", "Section blanking", "possible cut and paste move", "unusual redirect", "coi-spam", "autobiography", "repeating characters", "categories removed", "removal of Category:Living People", "very short new article", "reference list removal", "references removed", "image template removal", "shouting", "talk page blanking", "blanking", "removal of speedy deletion templates", "self-renaming and bad user talk moves", "mw-contentmodelchange", "massmessage-delivery", "visualeditor", "visualeditor-needcheck", "visualeditor-switched", "visualeditor-wikitext", "wikilove", "mobile edit", "mobile app edit", "mobile web edit", "HHVM", "contenttranslation", "OAuth CID: 115", "OAuth CID: 142", "OAuth CID: 144", "OAuth CID: 150", "OAuth CID: 151", "OAuth CID: 154", "OAuth CID: 159", "OAuth CID: 194", "OAuth CID: 206", "OAuth CID: 21", "OAuth CID: 211", "OAuth CID: 212", "OAuth CID: 218", "OAuth CID: 236", "OAuth CID: 239", "OAuth CID: 251", "OAuth CID: 252", "OAuth CID: 259", "OAuth CID: 261", "OAuth CID: 263", "OAuth CID: 274", "OAuth CID: 278", "OAuth CID: 285", "OAuth CID: 297", "OAuth CID: 306", "OAuth CID: 314", "OAuth CID: 320", "OAuth CID: 376", "OAuth CID: 410", "OAuth CID: 429", "OAuth CID: 473", "OAuth CID: 540", "OAuth CID: 542", "OAuth CID: 543", "OAuth CID: 563", "OAuth CID: 593", "OAuth CID: 60", "OAuth CID: 612", "OAuth CID: 628", "OAuth CID: 64", "OAuth CID: 651", "OAuth CID: 67", "OAuth CID: 670", "OAuth CID: 678", "OAuth CID: 679", "OAuth CID: 76", "OAuth CID: 817", "OAuth CID: 85", "OAuth CID: 99"].include?(value.to_s) && merge(tagfilter: value.to_s, replace: false)
+      end
+
+      # Show only deleted contributions.
+      #
+      # @return [self]
+      def deletedonly()
+        merge(deletedonly: 'true')
+      end
+
+      # Only show edits that are the latest revisions.
+      #
+      # @return [self]
+      def toponly()
+        merge(toponly: 'true')
+      end
+
+      # Only show edits that are page creations.
+      #
+      # @return [self]
+      def newonly()
+        merge(newonly: 'true')
+      end
+
+      # Hide minor edits.
+      #
+      # @return [self]
+      def hideminor()
+        merge(hideminor: 'true')
+      end
+
+      # Disabled due to miser mode.
+      #
+      # @return [self]
+      def showsizediff()
+        merge(showsizediff: 'true')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module MediaWiktory::Wikipedia
+  module Actions
+    # Returns a recent changes feed.
+    #
+    # Usage:
+    #
+    # ```ruby
+    # api.feedrecentchanges.feedformat(value).perform # returns string with raw output
+    # # or
+    # api.feedrecentchanges.feedformat(value).response # returns output parsed and wrapped into Response object
+    # ```
+    #
+    # See {Base} for generic explanation of working with MediaWiki actions and
+    # {MediaWiktory::Wikipedia::Response} for working with action responses.
+    #
+    # All action's parameters are documented as its public methods, see below.
+    #
+    class Feedrecentchanges < MediaWiktory::Wikipedia::Actions::Get
+
+      # The format of the feed.
+      #
+      # @param value [String] One of "rss", "atom".
+      # @return [self]
+      def feedformat(value)
+        _feedformat(value) or fail ArgumentError, "Unknown value for feedformat: #{value}"
+      end
+
+      # @private
+      def _feedformat(value)
+        defined?(super) && super || ["rss", "atom"].include?(value.to_s) && merge(feedformat: value.to_s)
+      end
+
+      # Namespace to limit the results to.
+      #
+      # @param value [String] One of "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 || ["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(namespace: value.to_s)
+      end
+
+      # All namespaces but the selected one.
+      #
+      # @return [self]
+      def invert()
+        merge(invert: 'true')
+      end
+
+      # Include associated (talk or main) namespace.
+      #
+      # @return [self]
+      def associated()
+        merge(associated: 'true')
+      end
+
+      # Days to limit the results to.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def days(value)
+        merge(days: value.to_s)
+      end
+
+      # Maximum number of results to return.
+      #
+      # @param value [Integer]
+      # @return [self]
+      def limit(value)
+        merge(limit: value.to_s)
+      end
+
+      # Show changes since then.
+      #
+      # @param value [Time]
+      # @return [self]
+      def from(value)
+        merge(from: value.iso8601)
+      end
+
+      # Hide minor changes.
+      #
+      # @return [self]
+      def hideminor()
+        merge(hideminor: 'true')
+      end
+
+      # Hide changes made by bots.
+      #
+      # @return [self]
+      def hidebots()
+        merge(hidebots: 'true')
+      end
+
+      # Hide changes made by anonymous users.
+      #
+      # @return [self]
+      def hideanons()
+        merge(hideanons: 'true')
+      end
+
+      # Hide changes made by registered users.
+      #
+      # @return [self]
+      def hideliu()
+        merge(hideliu: 'true')
+      end
+
+      # Hide patrolled changes.
+      #
+      # @return [self]
+      def hidepatrolled()
+        merge(hidepatrolled: 'true')
+      end
+
+      # Hide changes made by the current user.
+      #
+      # @return [self]
+      def hidemyself()
+        merge(hidemyself: 'true')
+      end
+
+      # Hide category membership changes.
+      #
+      # @return [self]
+      def hidecategorization()
+        merge(hidecategorization: 'true')
+      end
+
+      # Filter by tag.
+      #
+      # @param value [String]
+      # @return [self]
+      def tagfilter(value)
+        merge(tagfilter: value.to_s)
+      end
+
+      # Show only changes on pages linked from this page.
+      #
+      # @param value [String]
+      # @return [self]
+      def target(value)
+        merge(target: value.to_s)
+      end
+
+      # Show changes on pages linked to the selected page instead.
+      #
+      # @return [self]
+      def showlinkedto()
+        merge(showlinkedto: 'true')
+      end
+    end
+  end
+end