reality 0.1.0.alpha → 0.1.0.alpha2

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

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Patrol a page or revision.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.patrol.rcid(value).perform # returns string with raw output
-    # # or
-    # api.patrol.rcid(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 Patrol < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Recentchanges ID to patrol.
-      #
-      # @param value [Integer]
-      # @return [self]
-      def rcid(value)
-        merge(rcid: value.to_s)
-      end
-
-      # Revision ID to patrol.
-      #
-      # @param value [Integer]
-      # @return [self]
-      def revid(value)
-        merge(revid: value.to_s)
-      end
-
-      # Change tags to apply to the entry in the patrol 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
-
-      # A "patrol" 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/reality/describers/wikidata/actions/protect.rb

@@ -1,121 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Change the protection level of a page.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.protect.title(value).perform # returns string with raw output
-    # # or
-    # api.protect.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 Protect < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Title of the page to (un)protect. Cannot be used together with pageid.
-      #
-      # @param value [String]
-      # @return [self]
-      def title(value)
-        merge(title: value.to_s)
-      end
-
-      # ID of the page to (un)protect. Cannot be used together with title.
-      #
-      # @param value [Integer]
-      # @return [self]
-      def pageid(value)
-        merge(pageid: value.to_s)
-      end
-
-      # List of protection levels, formatted action=level (e.g. edit=sysop). A level of all means everyone is allowed to take the action, i.e. no restriction.
-      #
-      # @param values [Array<String>]
-      # @return [self]
-      def protections(*values)
-        values.inject(self) { |res, val| res._protections(val) }
-      end
-
-      # @private
-      def _protections(value)
-        merge(protections: value.to_s, replace: false)
-      end
-
-      # Expiry timestamps. If only one timestamp is set, it'll be used for all protections. Use infinite, indefinite, infinity, or never, for a never-expiring protection.
-      #
-      # @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
-
-      # Reason for (un)protecting.
-      #
-      # @param value [String]
-      # @return [self]
-      def reason(value)
-        merge(reason: value.to_s)
-      end
-
-      # Change tags to apply to the entry in the protection 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
-
-      # Enable cascading protection (i.e. protect transcluded templates and images used in this page). Ignored if none of the given protection levels support cascading.
-      #
-      # @return [self]
-      def cascade()
-        merge(cascade: 'true')
-      end
-
-      # If set, add the page being (un)protected to the current user's watchlist.
-      #
-      # @return [self]
-      def watch()
-        merge(watch: 'true')
-      end
-
-      # Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.
-      #
-      # @param value [String] One of "watch", "unwatch", "preferences", "nochange".
-      # @return [self]
-      def watchlist(value)
-        _watchlist(value) or fail ArgumentError, "Unknown value for watchlist: #{value}"
-      end
-
-      # @private
-      def _watchlist(value)
-        defined?(super) && super || ["watch", "unwatch", "preferences", "nochange"].include?(value.to_s) && merge(watchlist: 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/reality/describers/wikidata/actions/purge.rb

@@ -1,152 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Purge the cache for the given titles.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.purge.forcelinkupdate(value).perform # returns string with raw output
-    # # or
-    # api.purge.forcelinkupdate(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 Purge < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Update the links tables.
-      #
-      # @return [self]
-      def forcelinkupdate()
-        merge(forcelinkupdate: 'true')
-      end
-
-      # Update the links table, and update the links tables for any page that uses this page as a template.
-      #
-      # @return [self]
-      def forcerecursivelinkupdate()
-        merge(forcerecursivelinkupdate: '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
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Remove authentication data for the current user.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.removeauthenticationdata.request(value).perform # returns string with raw output
-    # # or
-    # api.removeauthenticationdata.request(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 Removeauthenticationdata < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Use this authentication request, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=remove.
-      #
-      # @param value [String]
-      # @return [self]
-      def request(value)
-        merge(request: 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/reality/describers/wikidata/actions/resetpassword.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Send a password reset email to a user.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.resetpassword.user(value).perform # returns string with raw output
-    # # or
-    # api.resetpassword.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 Resetpassword < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # User being reset.
-      #
-      # @param value [String]
-      # @return [self]
-      def user(value)
-        merge(user: value.to_s)
-      end
-
-      # Email address of the user being reset.
-      #
-      # @param value [String]
-      # @return [self]
-      def email(value)
-        merge(email: 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/reality/describers/wikidata/actions/revisiondelete.rb

@@ -1,125 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Delete and undelete revisions.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.revisiondelete.type(value).perform # returns string with raw output
-    # # or
-    # api.revisiondelete.type(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 Revisiondelete < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Type of revision deletion being performed.
-      #
-      # @param value [String] One of "revision", "archive", "oldimage", "filearchive", "logging".
-      # @return [self]
-      def type(value)
-        _type(value) or fail ArgumentError, "Unknown value for type: #{value}"
-      end
-
-      # @private
-      def _type(value)
-        defined?(super) && super || ["revision", "archive", "oldimage", "filearchive", "logging"].include?(value.to_s) && merge(type: value.to_s)
-      end
-
-      # Page title for the revision deletion, if required for the type.
-      #
-      # @param value [String]
-      # @return [self]
-      def target(value)
-        merge(target: value.to_s)
-      end
-
-      # Identifiers for the revisions to be deleted.
-      #
-      # @param values [Array<String>]
-      # @return [self]
-      def ids(*values)
-        values.inject(self) { |res, val| res._ids(val) }
-      end
-
-      # @private
-      def _ids(value)
-        merge(ids: value.to_s, replace: false)
-      end
-
-      # What to hide for each revision.
-      #
-      # @param values [Array<String>] Allowed values: "content", "comment", "user".
-      # @return [self]
-      def hide(*values)
-        values.inject(self) { |res, val| res._hide(val) or fail ArgumentError, "Unknown value for hide: #{val}" }
-      end
-
-      # @private
-      def _hide(value)
-        defined?(super) && super || ["content", "comment", "user"].include?(value.to_s) && merge(hide: value.to_s, replace: false)
-      end
-
-      # What to unhide for each revision.
-      #
-      # @param values [Array<String>] Allowed values: "content", "comment", "user".
-      # @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 || ["content", "comment", "user"].include?(value.to_s) && merge(show: value.to_s, replace: false)
-      end
-
-      # Whether to suppress data from administrators as well as others.
-      #
-      # @param value [String] One of "yes", "no", "nochange".
-      # @return [self]
-      def suppress(value)
-        _suppress(value) or fail ArgumentError, "Unknown value for suppress: #{value}"
-      end
-
-      # @private
-      def _suppress(value)
-        defined?(super) && super || ["yes", "no", "nochange"].include?(value.to_s) && merge(suppress: value.to_s)
-      end
-
-      # Reason for the deletion or undeletion.
-      #
-      # @param value [String]
-      # @return [self]
-      def reason(value)
-        merge(reason: value.to_s)
-      end
-
-      # Tags to apply to the entry in the deletion 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
-
-      # 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