reality 0.1.0.alpha → 0.1.0.alpha2

data/lib/reality/describers/wikidata/actions/userrights.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Change a user's group membership.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.userrights.user(value).perform # returns string with raw output
-    # # or
-    # api.userrights.user(value).response # returns output parsed and wrapped into Response object
-    # ```
-    #
-    # See {Base} for generic explanation of working with MediaWiki actions and
-    # {Reality::Describers::Wikidata::Impl::Response} for working with action responses.
-    #
-    # All action's parameters are documented as its public methods, see below.
-    #
-    class Userrights < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # User name.
-      #
-      # @param value [String]
-      # @return [self]
-      def user(value)
-        merge(user: value.to_s)
-      end
-
-      # User ID.
-      #
-      # @param value [Integer]
-      # @return [self]
-      def userid(value)
-        merge(userid: value.to_s)
-      end
-
-      # Add the user to these groups, or if they are already a member, update the expiry of their membership in that group.
-      #
-      # @param values [Array<String>] Allowed values: "bot", "sysop", "bureaucrat", "steward", "accountcreator", "import", "transwiki", "ipblock-exempt", "oversight", "rollbacker", "propertycreator", "wikidata-staff", "flood", "translationadmin", "confirmed", "flow-bot", "checkuser".
-      # @return [self]
-      def add(*values)
-        values.inject(self) { |res, val| res._add(val) or fail ArgumentError, "Unknown value for add: #{val}" }
-      end
-
-      # @private
-      def _add(value)
-        defined?(super) && super || ["bot", "sysop", "bureaucrat", "steward", "accountcreator", "import", "transwiki", "ipblock-exempt", "oversight", "rollbacker", "propertycreator", "wikidata-staff", "flood", "translationadmin", "confirmed", "flow-bot", "checkuser"].include?(value.to_s) && merge(add: value.to_s, replace: false)
-      end
-
-      # Expiry timestamps. May be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). If only one timestamp is set, it will be used for all groups passed to the add parameter. Use infinite, indefinite, infinity, or never for a never-expiring user group.
-      #
-      # @param values [Array<String>]
-      # @return [self]
-      def expiry(*values)
-        values.inject(self) { |res, val| res._expiry(val) }
-      end
-
-      # @private
-      def _expiry(value)
-        merge(expiry: value.to_s, replace: false)
-      end
-
-      # Remove the user from these groups.
-      #
-      # @param values [Array<String>] Allowed values: "bot", "sysop", "bureaucrat", "steward", "accountcreator", "import", "transwiki", "ipblock-exempt", "oversight", "rollbacker", "propertycreator", "wikidata-staff", "flood", "translationadmin", "confirmed", "flow-bot", "checkuser".
-      # @return [self]
-      def remove(*values)
-        values.inject(self) { |res, val| res._remove(val) or fail ArgumentError, "Unknown value for remove: #{val}" }
-      end
-
-      # @private
-      def _remove(value)
-        defined?(super) && super || ["bot", "sysop", "bureaucrat", "steward", "accountcreator", "import", "transwiki", "ipblock-exempt", "oversight", "rollbacker", "propertycreator", "wikidata-staff", "flood", "translationadmin", "confirmed", "flow-bot", "checkuser"].include?(value.to_s) && merge(remove: value.to_s, replace: false)
-      end
-
-      # Reason for the change.
-      #
-      # @param value [String]
-      # @return [self]
-      def reason(value)
-        merge(reason: value.to_s)
-      end
-
-      # A "userrights" token retrieved from action=query&meta=tokens
-      #
-      # @param value [String]
-      # @return [self]
-      def token(value)
-        merge(token: value.to_s)
-      end
-
-      # Change tags to apply to the entry in the user rights log.
-      #
-      # @param values [Array<String>] Allowed values: "InfoboxExport gadget", "WE-Framework gadget".
-      # @return [self]
-      def tags(*values)
-        values.inject(self) { |res, val| res._tags(val) or fail ArgumentError, "Unknown value for tags: #{val}" }
-      end
-
-      # @private
-      def _tags(value)
-        defined?(super) && super || ["InfoboxExport gadget", "WE-Framework gadget"].include?(value.to_s) && merge(tags: value.to_s, replace: false)
-      end
-    end
-  end
-end

data/lib/reality/describers/wikidata/actions/validatepassword.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Validate a password against the wiki's password policies.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.validatepassword.password(value).perform # returns string with raw output
-    # # or
-    # api.validatepassword.password(value).response # returns output parsed and wrapped into Response object
-    # ```
-    #
-    # See {Base} for generic explanation of working with MediaWiki actions and
-    # {Reality::Describers::Wikidata::Impl::Response} for working with action responses.
-    #
-    # All action's parameters are documented as its public methods, see below.
-    #
-    class Validatepassword < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Password to validate.
-      #
-      # @param value [String]
-      # @return [self]
-      def password(value)
-        merge(password: value.to_s)
-      end
-
-      # User name, for use when testing account creation. The named user must not exist.
-      #
-      # @param value [String]
-      # @return [self]
-      def user(value)
-        merge(user: value.to_s)
-      end
-
-      # Email address, for use when testing account creation.
-      #
-      # @param value [String]
-      # @return [self]
-      def email(value)
-        merge(email: value.to_s)
-      end
-
-      # Real name, for use when testing account creation.
-      #
-      # @param value [String]
-      # @return [self]
-      def realname(value)
-        merge(realname: value.to_s)
-      end
-    end
-  end
-end

data/lib/reality/describers/wikidata/actions/visualeditor.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Returns HTML5 for a page from the Parsoid service.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.visualeditor.page(value).perform # returns string with raw output
-    # # or
-    # api.visualeditor.page(value).response # returns output parsed and wrapped into Response object
-    # ```
-    #
-    # See {Base} for generic explanation of working with MediaWiki actions and
-    # {Reality::Describers::Wikidata::Impl::Response} for working with action responses.
-    #
-    # All action's parameters are documented as its public methods, see below.
-    #
-    class Visualeditor < Reality::Describers::Wikidata::Impl::Actions::Get
-
-      # The page to perform actions on.
-      #
-      # @param value [String]
-      # @return [self]
-      def page(value)
-        merge(page: value.to_s)
-      end
-
-      # 
-      #
-      # @param value [String] One of "json", "jsonfm".
-      # @return [self]
-      def format(value)
-        _format(value) or fail ArgumentError, "Unknown value for format: #{value}"
-      end
-
-      # @private
-      def _format(value)
-        defined?(super) && super || ["json", "jsonfm"].include?(value.to_s) && merge(format: value.to_s)
-      end
-
-      # Action to perform.
-      #
-      # @param value [String] One of "parse", "metadata", "wikitext", "parsefragment", "getlanglinks".
-      # @return [self]
-      def paction(value)
-        _paction(value) or fail ArgumentError, "Unknown value for paction: #{value}"
-      end
-
-      # @private
-      def _paction(value)
-        defined?(super) && super || ["parse", "metadata", "wikitext", "parsefragment", "getlanglinks"].include?(value.to_s) && merge(paction: value.to_s)
-      end
-
-      # Wikitext to send to Parsoid to convert to HTML (paction=parsefragment).
-      #
-      # @param value [String]
-      # @return [self]
-      def wikitext(value)
-        merge(wikitext: value.to_s)
-      end
-
-      # The section on which to act.
-      #
-      # @param value [String]
-      # @return [self]
-      def section(value)
-        merge(section: value.to_s)
-      end
-
-      # The revision number to use (defaults to latest revision).
-      #
-      # @param value [String]
-      # @return [self]
-      def oldid(value)
-        merge(oldid: value.to_s)
-      end
-
-      # Edit intro to add to notices.
-      #
-      # @param value [String]
-      # @return [self]
-      def editintro(value)
-        merge(editintro: value.to_s)
-      end
-
-      # Pre-save transform wikitext before sending it to Parsoid (paction=parsefragment).
-      #
-      # @return [self]
-      def pst()
-        merge(pst: 'true')
-      end
-    end
-  end
-end

data/lib/reality/describers/wikidata/actions/visualeditoredit.rb

@@ -1,164 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.visualeditoredit.paction(value).perform # returns string with raw output
-    # # or
-    # api.visualeditoredit.paction(value).response # returns output parsed and wrapped into Response object
-    # ```
-    #
-    # See {Base} for generic explanation of working with MediaWiki actions and
-    # {Reality::Describers::Wikidata::Impl::Response} for working with action responses.
-    #
-    # All action's parameters are documented as its public methods, see below.
-    #
-    class Visualeditoredit < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Action to perform.
-      #
-      # @param value [String] One of "serialize", "serializeforcache", "diff", "save".
-      # @return [self]
-      def paction(value)
-        _paction(value) or fail ArgumentError, "Unknown value for paction: #{value}"
-      end
-
-      # @private
-      def _paction(value)
-        defined?(super) && super || ["serialize", "serializeforcache", "diff", "save"].include?(value.to_s) && merge(paction: value.to_s)
-      end
-
-      # The page to perform actions on.
-      #
-      # @param value [String]
-      # @return [self]
-      def page(value)
-        merge(page: 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
-
-      # 
-      #
-      # @param value [String]
-      # @return [self]
-      def wikitext(value)
-        merge(wikitext: value.to_s)
-      end
-
-      # The section on which to act.
-      #
-      # @param value [String]
-      # @return [self]
-      def section(value)
-        merge(section: value.to_s)
-      end
-
-      # Title for new section.
-      #
-      # @param value [String]
-      # @return [self]
-      def sectiontitle(value)
-        merge(sectiontitle: value.to_s)
-      end
-
-      # When saving, set this to the timestamp of the revision that was edited. Used to detect edit conflicts.
-      #
-      # @param value [String]
-      # @return [self]
-      def basetimestamp(value)
-        merge(basetimestamp: value.to_s)
-      end
-
-      # When saving, set this to the timestamp of when the page was loaded. Used to detect edit conflicts.
-      #
-      # @param value [String]
-      # @return [self]
-      def starttimestamp(value)
-        merge(starttimestamp: value.to_s)
-      end
-
-      # The revision number to use. Defaults to latest revision. Use 0 for a new page.
-      #
-      # @param value [String]
-      # @return [self]
-      def oldid(value)
-        merge(oldid: value.to_s)
-      end
-
-      # Flag for minor edit.
-      #
-      # @param value [String]
-      # @return [self]
-      def minor(value)
-        merge(minor: value.to_s)
-      end
-
-      # 
-      #
-      # @param value [String]
-      # @return [self]
-      def watch(value)
-        merge(watch: value.to_s)
-      end
-
-      # HTML to send to Parsoid in exchange for wikitext.
-      #
-      # @param value [String]
-      # @return [self]
-      def html(value)
-        merge(html: value.to_s)
-      end
-
-      # ETag to send.
-      #
-      # @param value [String]
-      # @return [self]
-      def etag(value)
-        merge(etag: value.to_s)
-      end
-
-      # Edit summary.
-      #
-      # @param value [String]
-      # @return [self]
-      def summary(value)
-        merge(summary: value.to_s)
-      end
-
-      # Captcha ID (when saving with a captcha response).
-      #
-      # @param value [String]
-      # @return [self]
-      def captchaid(value)
-        merge(captchaid: value.to_s)
-      end
-
-      # Answer to the captcha (when saving with a captcha response).
-      #
-      # @param value [String]
-      # @return [self]
-      def captchaword(value)
-        merge(captchaword: value.to_s)
-      end
-
-      # Use the result of a previous serializeforcache request with this key. Overrides html.
-      #
-      # @param value [String]
-      # @return [self]
-      def cachekey(value)
-        merge(cachekey: value.to_s)
-      end
-    end
-  end
-end

data/lib/reality/describers/wikidata/actions/watch.rb

@@ -1,161 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Add or remove pages from the current user's watchlist.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.watch.title(value).perform # returns string with raw output
-    # # or
-    # api.watch.title(value).response # returns output parsed and wrapped into Response object
-    # ```
-    #
-    # See {Base} for generic explanation of working with MediaWiki actions and
-    # {Reality::Describers::Wikidata::Impl::Response} for working with action responses.
-    #
-    # All action's parameters are documented as its public methods, see below.
-    #
-    class Watch < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # The page to (un)watch. Use titles instead.
-      #
-      # @param value [String]
-      # @return [self]
-      def title(value)
-        merge(title: value.to_s)
-      end
-
-      # If set the page will be unwatched rather than watched.
-      #
-      # @return [self]
-      def unwatch()
-        merge(unwatch: 'true')
-      end
-
-      # When more results are available, use this to continue.
-      #
-      # @param value [String]
-      # @return [self]
-      def continue(value)
-        merge(continue: value.to_s)
-      end
-
-      # A list of titles to work on.
-      #
-      # @param values [Array<String>]
-      # @return [self]
-      def titles(*values)
-        values.inject(self) { |res, val| res._titles(val) }
-      end
-
-      # @private
-      def _titles(value)
-        merge(titles: value.to_s, replace: false)
-      end
-
-      # A list of page IDs to work on.
-      #
-      # @param values [Array<Integer>]
-      # @return [self]
-      def pageids(*values)
-        values.inject(self) { |res, val| res._pageids(val) }
-      end
-
-      # @private
-      def _pageids(value)
-        merge(pageids: value.to_s, replace: false)
-      end
-
-      # A list of revision IDs to work on.
-      #
-      # @param values [Array<Integer>]
-      # @return [self]
-      def revids(*values)
-        values.inject(self) { |res, val| res._revids(val) }
-      end
-
-      # @private
-      def _revids(value)
-        merge(revids: value.to_s, replace: false)
-      end
-
-      # Get the list of pages to work on by executing the specified query module.
-      #
-      # @param value [Symbol] Selecting an option includes tweaking methods from corresponding module:
-      #   * `:allcategories` - {Reality::Describers::Wikidata::Impl::Modules::Allcategories} Enumerate all categories.
-      #   * `:alldeletedrevisions` - {Reality::Describers::Wikidata::Impl::Modules::Alldeletedrevisions} List all deleted revisions by a user or in a namespace.
-      #   * `:allfileusages` - {Reality::Describers::Wikidata::Impl::Modules::Allfileusages} List all file usages, including non-existing.
-      #   * `:allimages` - {Reality::Describers::Wikidata::Impl::Modules::Allimages} Enumerate all images sequentially.
-      #   * `:alllinks` - {Reality::Describers::Wikidata::Impl::Modules::Alllinks} Enumerate all links that point to a given namespace.
-      #   * `:allpages` - {Reality::Describers::Wikidata::Impl::Modules::Allpages} Enumerate all pages sequentially in a given namespace.
-      #   * `:allredirects` - {Reality::Describers::Wikidata::Impl::Modules::Allredirects} List all redirects to a namespace.
-      #   * `:allrevisions` - {Reality::Describers::Wikidata::Impl::Modules::Allrevisions} List all revisions.
-      #   * `:alltransclusions` - {Reality::Describers::Wikidata::Impl::Modules::Alltransclusions} List all transclusions (pages embedded using {{x}}), including non-existing.
-      #   * `:backlinks` - {Reality::Describers::Wikidata::Impl::Modules::Backlinks} Find all pages that link to the given page.
-      #   * `:categories` - {Reality::Describers::Wikidata::Impl::Modules::Categories} List all categories the pages belong to.
-      #   * `:categorymembers` - {Reality::Describers::Wikidata::Impl::Modules::Categorymembers} List all pages in a given category.
-      #   * `:deletedrevisions` - {Reality::Describers::Wikidata::Impl::Modules::Deletedrevisions} Get deleted revision information.
-      #   * `:duplicatefiles` - {Reality::Describers::Wikidata::Impl::Modules::Duplicatefiles} List all files that are duplicates of the given files based on hash values.
-      #   * `:embeddedin` - {Reality::Describers::Wikidata::Impl::Modules::Embeddedin} Find all pages that embed (transclude) the given title.
-      #   * `:exturlusage` - {Reality::Describers::Wikidata::Impl::Modules::Exturlusage} Enumerate pages that contain a given URL.
-      #   * `:fileusage` - {Reality::Describers::Wikidata::Impl::Modules::Fileusage} Find all pages that use the given files.
-      #   * `:geosearch` - {Reality::Describers::Wikidata::Impl::Modules::Geosearch} Returns pages having coordinates that are located in a certain area.
-      #   * `:images` - {Reality::Describers::Wikidata::Impl::Modules::Images} Returns all files contained on the given pages.
-      #   * `:imageusage` - {Reality::Describers::Wikidata::Impl::Modules::Imageusage} Find all pages that use the given image title.
-      #   * `:iwbacklinks` - {Reality::Describers::Wikidata::Impl::Modules::Iwbacklinks} Find all pages that link to the given interwiki link.
-      #   * `:langbacklinks` - {Reality::Describers::Wikidata::Impl::Modules::Langbacklinks} Find all pages that link to the given language link.
-      #   * `:links` - {Reality::Describers::Wikidata::Impl::Modules::Links} Returns all links from the given pages.
-      #   * `:linkshere` - {Reality::Describers::Wikidata::Impl::Modules::Linkshere} Find all pages that link to the given pages.
-      #   * `:messagecollection` - {Reality::Describers::Wikidata::Impl::Modules::Messagecollection} Query MessageCollection about translations.
-      #   * `:mostviewed` - {Reality::Describers::Wikidata::Impl::Modules::Mostviewed} Lists the most viewed pages (based on last day's pageview count).
-      #   * `:pageswithprop` - {Reality::Describers::Wikidata::Impl::Modules::Pageswithprop} List all pages using a given page property.
-      #   * `:prefixsearch` - {Reality::Describers::Wikidata::Impl::Modules::Prefixsearch} Perform a prefix search for page titles.
-      #   * `:protectedtitles` - {Reality::Describers::Wikidata::Impl::Modules::Protectedtitles} List all titles protected from creation.
-      #   * `:querypage` - {Reality::Describers::Wikidata::Impl::Modules::Querypage} Get a list provided by a QueryPage-based special page.
-      #   * `:random` - {Reality::Describers::Wikidata::Impl::Modules::Random} Get a set of random pages.
-      #   * `:recentchanges` - {Reality::Describers::Wikidata::Impl::Modules::Recentchanges} Enumerate recent changes.
-      #   * `:redirects` - {Reality::Describers::Wikidata::Impl::Modules::Redirects} Returns all redirects to the given pages.
-      #   * `:revisions` - {Reality::Describers::Wikidata::Impl::Modules::Revisions} Get revision information.
-      #   * `:search` - {Reality::Describers::Wikidata::Impl::Modules::Search} Perform a full text search.
-      #   * `:templates` - {Reality::Describers::Wikidata::Impl::Modules::Templates} Returns all pages transcluded on the given pages.
-      #   * `:transcludedin` - {Reality::Describers::Wikidata::Impl::Modules::Transcludedin} Find all pages that transclude the given pages.
-      #   * `:watchlist` - {Reality::Describers::Wikidata::Impl::Modules::Watchlist} Get recent changes to pages in the current user's watchlist.
-      #   * `:watchlistraw` - {Reality::Describers::Wikidata::Impl::Modules::Watchlistraw} Get all pages on the current user's watchlist.
-      #   * `:wblistentityusage` - {Reality::Describers::Wikidata::Impl::Modules::Wblistentityusage} Returns all pages that use the given entity IDs.
-      #   * `:wbsearch` - {Reality::Describers::Wikidata::Impl::Modules::Wbsearch} Searches for entities using labels and aliases. This can be used as a generator for other queries. Returns the matched term that should be displayed.
-      # @return [self]
-      def generator(value)
-        _generator(value) or fail ArgumentError, "Unknown value for generator: #{value}"
-      end
-
-      # @private
-      def _generator(value)
-        defined?(super) && super || [:allcategories, :alldeletedrevisions, :allfileusages, :allimages, :alllinks, :allpages, :allredirects, :allrevisions, :alltransclusions, :backlinks, :categories, :categorymembers, :deletedrevisions, :duplicatefiles, :embeddedin, :exturlusage, :fileusage, :geosearch, :images, :imageusage, :iwbacklinks, :langbacklinks, :links, :linkshere, :messagecollection, :mostviewed, :pageswithprop, :prefixsearch, :protectedtitles, :querypage, :random, :recentchanges, :redirects, :revisions, :search, :templates, :transcludedin, :watchlist, :watchlistraw, :wblistentityusage, :wbsearch].include?(value.to_sym) && merge(generator: value.to_s).submodule({allcategories: Modules::Allcategories, alldeletedrevisions: Modules::Alldeletedrevisions, allfileusages: Modules::Allfileusages, allimages: Modules::Allimages, alllinks: Modules::Alllinks, allpages: Modules::Allpages, allredirects: Modules::Allredirects, allrevisions: Modules::Allrevisions, alltransclusions: Modules::Alltransclusions, backlinks: Modules::Backlinks, categories: Modules::Categories, categorymembers: Modules::Categorymembers, deletedrevisions: Modules::Deletedrevisions, duplicatefiles: Modules::Duplicatefiles, embeddedin: Modules::Embeddedin, exturlusage: Modules::Exturlusage, fileusage: Modules::Fileusage, geosearch: Modules::Geosearch, images: Modules::Images, imageusage: Modules::Imageusage, iwbacklinks: Modules::Iwbacklinks, langbacklinks: Modules::Langbacklinks, links: Modules::Links, linkshere: Modules::Linkshere, messagecollection: Modules::Messagecollection, mostviewed: Modules::Mostviewed, pageswithprop: Modules::Pageswithprop, prefixsearch: Modules::Prefixsearch, protectedtitles: Modules::Protectedtitles, querypage: Modules::Querypage, random: Modules::Random, recentchanges: Modules::Recentchanges, redirects: Modules::Redirects, revisions: Modules::Revisions, search: Modules::Search, templates: Modules::Templates, transcludedin: Modules::Transcludedin, watchlist: Modules::Watchlist, watchlistraw: Modules::Watchlistraw, wblistentityusage: Modules::Wblistentityusage, wbsearch: Modules::Wbsearch}[value.to_sym])
-      end
-
-      # Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.
-      #
-      # @return [self]
-      def redirects()
-        merge(redirects: 'true')
-      end
-
-      # Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz and zh.
-      #
-      # @return [self]
-      def converttitles()
-        merge(converttitles: 'true')
-      end
-
-      # A "watch" token retrieved from action=query&meta=tokens
-      #
-      # @param value [String]
-      # @return [self]
-      def token(value)
-        merge(token: value.to_s)
-      end
-    end
-  end
-end