reality 0.1.0.alpha → 0.1.0.alpha2

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

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Undo the last edit to the page.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.rollback.title(value).perform # returns string with raw output
-    # # or
-    # api.rollback.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 Rollback < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Title of the page to roll back. Cannot be used together with pageid.
-      #
-      # @param value [String]
-      # @return [self]
-      def title(value)
-        merge(title: value.to_s)
-      end
-
-      # Page ID of the page to roll back. Cannot be used together with title.
-      #
-      # @param value [Integer]
-      # @return [self]
-      def pageid(value)
-        merge(pageid: value.to_s)
-      end
-
-      # Tags to apply to the rollback.
-      #
-      # @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
-
-      # Name of the user whose edits are to be rolled back.
-      #
-      # @param value [String]
-      # @return [self]
-      def user(value)
-        merge(user: value.to_s)
-      end
-
-      # Custom edit summary. If empty, default summary will be used.
-      #
-      # @param value [String]
-      # @return [self]
-      def summary(value)
-        merge(summary: value.to_s)
-      end
-
-      # Mark the reverted edits and the revert as bot edits.
-      #
-      # @return [self]
-      def markbot()
-        merge(markbot: '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 "rollback" 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/rsd.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Export an RSD (Really Simple Discovery) schema.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.rsd.perform # returns string with raw output
-    # # or
-    # api.rsd.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
-    # {Reality::Describers::Wikidata::Impl::Response} for working with action responses.
-    #
-    # All action's parameters are documented as its public methods, see below.
-    #
-    class Rsd < Reality::Describers::Wikidata::Impl::Actions::Get
-    end
-  end
-end

data/lib/reality/describers/wikidata/actions/sanitize-mapdata.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Performs data validation for Kartographer extension
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.sanitize-mapdata.title(value).perform # returns string with raw output
-    # # or
-    # api.sanitize-mapdata.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 SanitizeMapdata < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Title of page on which this GeoJSON is supposed to be located. If no title is provided, a dummy one will be used.
-      #
-      # @param value [String]
-      # @return [self]
-      def title(value)
-        merge(title: value.to_s)
-      end
-
-      # GeoJSON to sanitize
-      #
-      # @param value [String]
-      # @return [self]
-      def text(value)
-        merge(text: value.to_s)
-      end
-    end
-  end
-end

data/lib/reality/describers/wikidata/actions/scribunto-console.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Internal module for servicing XHR requests from the Scribunto console.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.scribunto-console.title(value).perform # returns string with raw output
-    # # or
-    # api.scribunto-console.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 ScribuntoConsole < Reality::Describers::Wikidata::Impl::Actions::Get
-
-      # The title of the module to test.
-      #
-      # @param value [String]
-      # @return [self]
-      def title(value)
-        merge(title: value.to_s)
-      end
-
-      # The new content of the module.
-      #
-      # @param value [String]
-      # @return [self]
-      def content(value)
-        merge(content: value.to_s)
-      end
-
-      # Session token.
-      #
-      # @param value [Integer]
-      # @return [self]
-      def session(value)
-        merge(session: value.to_s)
-      end
-
-      # The next line to evaluate as a script.
-      #
-      # @param value [String]
-      # @return [self]
-      def question(value)
-        merge(question: value.to_s)
-      end
-
-      # Set to clear the current session state.
-      #
-      # @return [self]
-      def clear()
-        merge(clear: 'true')
-      end
-    end
-  end
-end

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

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Search translations.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.searchtranslations.service(value).perform # returns string with raw output
-    # # or
-    # api.searchtranslations.service(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 Searchtranslations < Reality::Describers::Wikidata::Impl::Actions::Get
-
-      # Which of the available translation services to use.
-      #
-      # @param value [String] One of "eqiad", "codfw".
-      # @return [self]
-      def service(value)
-        _service(value) or fail ArgumentError, "Unknown value for service: #{value}"
-      end
-
-      # @private
-      def _service(value)
-        defined?(super) && super || ["eqiad", "codfw"].include?(value.to_s) && merge(service: value.to_s)
-      end
-
-      # The string to search for.
-      #
-      # @param value [String]
-      # @return [self]
-      def query(value)
-        merge(query: value.to_s)
-      end
-
-      # The language code of the source text.
-      #
-      # @param value [String]
-      # @return [self]
-      def sourcelanguage(value)
-        merge(sourcelanguage: value.to_s)
-      end
-
-      # The language code to search string for.
-      #
-      # @param value [String]
-      # @return [self]
-      def language(value)
-        merge(language: value.to_s)
-      end
-
-      # The group ID to search string in.
-      #
-      # @param value [String]
-      # @return [self]
-      def group(value)
-        merge(group: value.to_s)
-      end
-
-      # Message translation status filter.
-      #
-      # @param value [String] One of "translated", "fuzzy", "untranslated".
-      # @return [self]
-      def filter(value)
-        _filter(value) or fail ArgumentError, "Unknown value for filter: #{value}"
-      end
-
-      # @private
-      def _filter(value)
-        defined?(super) && super || ["translated", "fuzzy", "untranslated"].include?(value.to_s) && merge(filter: value.to_s)
-      end
-
-      # Match any/all search words.
-      #
-      # @param value [String]
-      # @return [self]
-      def match(value)
-        merge(match: value.to_s)
-      end
-
-      # Case (in)sensitive search.
-      #
-      # @param value [String]
-      # @return [self]
-      def case(value)
-        merge(case: value.to_s)
-      end
-
-      # Offset for the translations.
-      #
-      # @param value [Integer]
-      # @return [self]
-      def offset(value)
-        merge(offset: value.to_s)
-      end
-
-      # Size of the result.
-      #
-      # @param value [Integer]
-      # @return [self]
-      def limit(value)
-        merge(limit: value.to_s)
-      end
-    end
-  end
-end

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

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Set a global user's status.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.setglobalaccountstatus.user(value).perform # returns string with raw output
-    # # or
-    # api.setglobalaccountstatus.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 Setglobalaccountstatus < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # User to change the status of.
-      #
-      # @param value [String]
-      # @return [self]
-      def user(value)
-        merge(user: value.to_s)
-      end
-
-      # Change whether this user is locked or not.
-      #
-      # @param value [String] One of "lock", "unlock".
-      # @return [self]
-      def locked(value)
-        _locked(value) or fail ArgumentError, "Unknown value for locked: #{value}"
-      end
-
-      # @private
-      def _locked(value)
-        defined?(super) && super || ["lock", "unlock"].include?(value.to_s) && merge(locked: value.to_s)
-      end
-
-      # Change whether this user is not hidden, hidden from lists, or suppressed.
-      #
-      # @param value [String] One of "lists", "suppressed".
-      # @return [self]
-      def hidden(value)
-        _hidden(value) or fail ArgumentError, "Unknown value for hidden: #{value}"
-      end
-
-      # @private
-      def _hidden(value)
-        defined?(super) && super || ["lists", "suppressed"].include?(value.to_s) && merge(hidden: value.to_s)
-      end
-
-      # Reason for changing the user's status.
-      #
-      # @param value [String]
-      # @return [self]
-      def reason(value)
-        merge(reason: value.to_s)
-      end
-
-      # Optional MD5 of the expected current <username>:<hidden>:<locked>, to detect edit conflicts. Set <locked> to 1 for locked, 0 for unlocked.
-      #
-      # @param value [String]
-      # @return [self]
-      def statecheck(value)
-        merge(statecheck: value.to_s)
-      end
-
-      # A "setglobalaccountstatus" 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/setnotificationtimestamp.rb

@@ -1,177 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Update the notification timestamp for watched pages.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.setnotificationtimestamp.entirewatchlist(value).perform # returns string with raw output
-    # # or
-    # api.setnotificationtimestamp.entirewatchlist(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 Setnotificationtimestamp < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Work on all watched pages.
-      #
-      # @return [self]
-      def entirewatchlist()
-        merge(entirewatchlist: 'true')
-      end
-
-      # Timestamp to which to set the notification timestamp.
-      #
-      # @param value [Time]
-      # @return [self]
-      def timestamp(value)
-        merge(timestamp: value.iso8601)
-      end
-
-      # Revision to set the notification timestamp to (one page only).
-      #
-      # @param value [Integer]
-      # @return [self]
-      def torevid(value)
-        merge(torevid: value.to_s)
-      end
-
-      # Revision to set the notification timestamp newer than (one page only).
-      #
-      # @param value [Integer]
-      # @return [self]
-      def newerthanrevid(value)
-        merge(newerthanrevid: value.to_s)
-      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 "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