reality 0.1.0.alpha → 0.1.0.alpha2

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

@@ -1,131 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Move a page.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.move.from(value).perform # returns string with raw output
-    # # or
-    # api.move.from(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 Move < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Title of the page to rename. Cannot be used together with fromid.
-      #
-      # @param value [String]
-      # @return [self]
-      def from(value)
-        merge(from: value.to_s)
-      end
-
-      # Page ID of the page to rename. Cannot be used together with from.
-      #
-      # @param value [Integer]
-      # @return [self]
-      def fromid(value)
-        merge(fromid: value.to_s)
-      end
-
-      # Title to rename the page to.
-      #
-      # @param value [String]
-      # @return [self]
-      def to(value)
-        merge(to: value.to_s)
-      end
-
-      # Reason for the rename.
-      #
-      # @param value [String]
-      # @return [self]
-      def reason(value)
-        merge(reason: value.to_s)
-      end
-
-      # Rename the talk page, if it exists.
-      #
-      # @return [self]
-      def movetalk()
-        merge(movetalk: 'true')
-      end
-
-      # Rename subpages, if applicable.
-      #
-      # @return [self]
-      def movesubpages()
-        merge(movesubpages: 'true')
-      end
-
-      # Don't create a redirect.
-      #
-      # @return [self]
-      def noredirect()
-        merge(noredirect: 'true')
-      end
-
-      # Add the page and the redirect to the current user's watchlist.
-      #
-      # @return [self]
-      def watch()
-        merge(watch: 'true')
-      end
-
-      # Remove the page and the redirect from the current user's watchlist.
-      #
-      # @return [self]
-      def unwatch()
-        merge(unwatch: '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
-
-      # Ignore any warnings.
-      #
-      # @return [self]
-      def ignorewarnings()
-        merge(ignorewarnings: 'true')
-      end
-
-      # Change tags to apply to the entry in the move log and to the null revision on the destination page.
-      #
-      # @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

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

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Validate a two-factor authentication (OATH) token.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.oathvalidate.user(value).perform # returns string with raw output
-    # # or
-    # api.oathvalidate.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 Oathvalidate < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # User to validate token for. Defaults to the current user.
-      #
-      # @param value [String]
-      # @return [self]
-      def user(value)
-        merge(user: value.to_s)
-      end
-
-      # Two-factor authentication (OATH) token.
-      #
-      # @param value [String]
-      # @return [self]
-      def totp(value)
-        merge(totp: 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/opensearch.rb

@@ -1,92 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Search the wiki using the OpenSearch protocol.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.opensearch.search(value).perform # returns string with raw output
-    # # or
-    # api.opensearch.search(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 Opensearch < Reality::Describers::Wikidata::Impl::Actions::Get
-
-      # Search string.
-      #
-      # @param value [String]
-      # @return [self]
-      def search(value)
-        merge(search: value.to_s)
-      end
-
-      # Namespaces to search.
-      #
-      # @param values [Array<String>] Allowed values: "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "120", "121", "122", "123", "828", "829", "1198", "1199", "2300", "2301", "2302", "2303", "2600".
-      # @return [self]
-      def namespace(*values)
-        values.inject(self) { |res, val| res._namespace(val) or fail ArgumentError, "Unknown value for namespace: #{val}" }
-      end
-
-      # @private
-      def _namespace(value)
-        defined?(super) && super || ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "120", "121", "122", "123", "828", "829", "1198", "1199", "2300", "2301", "2302", "2303", "2600"].include?(value.to_s) && merge(namespace: value.to_s, replace: false)
-      end
-
-      # Maximum number of results to return.
-      #
-      # @param value [Integer, "max"]
-      # @return [self]
-      def limit(value)
-        merge(limit: value.to_s)
-      end
-
-      # Do nothing if $wgEnableOpenSearchSuggest is false.
-      #
-      # @return [self]
-      def suggest()
-        merge(suggest: 'true')
-      end
-
-      # How to handle redirects:
-      #
-      # @param value [String] One of "return" (Return the redirect itself), "resolve" (Return the target page. May return fewer than limit results).
-      # @return [self]
-      def redirects(value)
-        _redirects(value) or fail ArgumentError, "Unknown value for redirects: #{value}"
-      end
-
-      # @private
-      def _redirects(value)
-        defined?(super) && super || ["return", "resolve"].include?(value.to_s) && merge(redirects: value.to_s)
-      end
-
-      # The format of the output.
-      #
-      # @param value [String] One of "json", "jsonfm", "xml", "xmlfm".
-      # @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", "xml", "xmlfm"].include?(value.to_s) && merge(format: value.to_s)
-      end
-
-      # If warnings are raised with format=json, return an API error instead of ignoring them.
-      #
-      # @return [self]
-      def warningsaserror()
-        merge(warningsaserror: 'true')
-      end
-    end
-  end
-end

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

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Change preferences of the current user.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.options.reset(value).perform # returns string with raw output
-    # # or
-    # api.options.reset(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 Options < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Resets preferences to the site defaults.
-      #
-      # @return [self]
-      def reset()
-        merge(reset: 'true')
-      end
-
-      # List of types of options to reset when the reset option is set.
-      #
-      # @param values [Array<String>] Allowed values: "registered", "registered-multiselect", "registered-checkmatrix", "userjs", "special", "unused", "all".
-      # @return [self]
-      def resetkinds(*values)
-        values.inject(self) { |res, val| res._resetkinds(val) or fail ArgumentError, "Unknown value for resetkinds: #{val}" }
-      end
-
-      # @private
-      def _resetkinds(value)
-        defined?(super) && super || ["registered", "registered-multiselect", "registered-checkmatrix", "userjs", "special", "unused", "all"].include?(value.to_s) && merge(resetkinds: value.to_s, replace: false)
-      end
-
-      # List of changes, formatted name=value (e.g. skin=vector). If no value is given (not even an equals sign), e.g., optionname|otheroption|..., the option will be reset to its default value. If any value passed contains the pipe character (|), use the alternative multiple-value separator for correct operation.
-      #
-      # @param values [Array<String>]
-      # @return [self]
-      def change(*values)
-        values.inject(self) { |res, val| res._change(val) }
-      end
-
-      # @private
-      def _change(value)
-        merge(change: value.to_s, replace: false)
-      end
-
-      # The name of the option that should be set to the value given by optionvalue.
-      #
-      # @param value [String]
-      # @return [self]
-      def optionname(value)
-        merge(optionname: value.to_s)
-      end
-
-      # The value for the option specified by optionname.
-      #
-      # @param value [String]
-      # @return [self]
-      def optionvalue(value)
-        merge(optionvalue: 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/paraminfo.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Obtain information about API modules.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.paraminfo.modules(value).perform # returns string with raw output
-    # # or
-    # api.paraminfo.modules(value).response # returns output parsed and wrapped into Response object
-    # ```
-    #
-    # See {Base} for generic explanation of working with MediaWiki actions and
-    # {Reality::Describers::Wikidata::Impl::Response} for working with action responses.
-    #
-    # All action's parameters are documented as its public methods, see below.
-    #
-    class Paraminfo < Reality::Describers::Wikidata::Impl::Actions::Get
-
-      # List of module names (values of the action and format parameters, or main). Can specify submodules with a +, or all submodules with +*, or all submodules recursively with +**.
-      #
-      # @param values [Array<String>]
-      # @return [self]
-      def modules(*values)
-        values.inject(self) { |res, val| res._modules(val) }
-      end
-
-      # @private
-      def _modules(value)
-        merge(modules: value.to_s, replace: false)
-      end
-
-      # Format of help strings.
-      #
-      # @param value [String] One of "html", "wikitext", "raw", "none".
-      # @return [self]
-      def helpformat(value)
-        _helpformat(value) or fail ArgumentError, "Unknown value for helpformat: #{value}"
-      end
-
-      # @private
-      def _helpformat(value)
-        defined?(super) && super || ["html", "wikitext", "raw", "none"].include?(value.to_s) && merge(helpformat: value.to_s)
-      end
-
-      # List of query module names (value of prop, meta or list parameter). Use modules=query+foo instead of querymodules=foo.
-      #
-      # @param values [Array<String>] Allowed values: "abusefilters", "abuselog", "allcategories", "alldeletedrevisions", "allfileusages", "allimages", "alllinks", "allmessages", "allpages", "allredirects", "allrevisions", "alltransclusions", "allusers", "authmanagerinfo", "babel", "backlinks", "betafeatures", "blocks", "categories", "categoryinfo", "categorymembers", "centralnoticelogs", "checkuser", "checkuserlog", "contributors", "coordinates", "deletedrevisions", "deletedrevs", "duplicatefiles", "embeddedin", "extlinks", "extracts", "exturlusage", "featureusage", "filearchive", "filerepoinfo", "fileusage", "flowinfo", "gadgetcategories", "gadgets", "geosearch", "globalallusers", "globalblocks", "globalgroups", "globalusage", "globaluserinfo", "imageinfo", "images", "imageusage", "info", "iwbacklinks", "iwlinks", "langbacklinks", "langlinks", "languagestats", "links", "linkshere", "logevents", "mapdata", "messagecollection", "messagegroups", "messagegroupstats", "messagetranslations", "mmsites", "mostviewed", "mystashedfiles", "notifications", "oath", "ores", "pageimages", "pagepropnames", "pageprops", "pageswithprop", "pageterms", "pageviews", "prefixsearch", "protectedtitles", "querypage", "random", "recentchanges", "redirects", "references", "revisions", "search", "siteinfo", "siteviews", "stashimageinfo", "tags", "templates", "tokens", "transcludedin", "transcodestatus", "unreadnotificationpages", "usercontribs", "userinfo", "users", "videoinfo", "watchlist", "watchlistraw", "wbentityusage", "wblistentityusage", "wbsearch", "wbsubscribers", "wikibase", "wikisets".
-      # @return [self]
-      def querymodules(*values)
-        values.inject(self) { |res, val| res._querymodules(val) or fail ArgumentError, "Unknown value for querymodules: #{val}" }
-      end
-
-      # @private
-      def _querymodules(value)
-        defined?(super) && super || ["abusefilters", "abuselog", "allcategories", "alldeletedrevisions", "allfileusages", "allimages", "alllinks", "allmessages", "allpages", "allredirects", "allrevisions", "alltransclusions", "allusers", "authmanagerinfo", "babel", "backlinks", "betafeatures", "blocks", "categories", "categoryinfo", "categorymembers", "centralnoticelogs", "checkuser", "checkuserlog", "contributors", "coordinates", "deletedrevisions", "deletedrevs", "duplicatefiles", "embeddedin", "extlinks", "extracts", "exturlusage", "featureusage", "filearchive", "filerepoinfo", "fileusage", "flowinfo", "gadgetcategories", "gadgets", "geosearch", "globalallusers", "globalblocks", "globalgroups", "globalusage", "globaluserinfo", "imageinfo", "images", "imageusage", "info", "iwbacklinks", "iwlinks", "langbacklinks", "langlinks", "languagestats", "links", "linkshere", "logevents", "mapdata", "messagecollection", "messagegroups", "messagegroupstats", "messagetranslations", "mmsites", "mostviewed", "mystashedfiles", "notifications", "oath", "ores", "pageimages", "pagepropnames", "pageprops", "pageswithprop", "pageterms", "pageviews", "prefixsearch", "protectedtitles", "querypage", "random", "recentchanges", "redirects", "references", "revisions", "search", "siteinfo", "siteviews", "stashimageinfo", "tags", "templates", "tokens", "transcludedin", "transcodestatus", "unreadnotificationpages", "usercontribs", "userinfo", "users", "videoinfo", "watchlist", "watchlistraw", "wbentityusage", "wblistentityusage", "wbsearch", "wbsubscribers", "wikibase", "wikisets"].include?(value.to_s) && merge(querymodules: value.to_s, replace: false)
-      end
-
-      # Get information about the main (top-level) module as well. Use modules=main instead.
-      #
-      # @param value [String]
-      # @return [self]
-      def mainmodule(value)
-        merge(mainmodule: value.to_s)
-      end
-
-      # Get information about the pageset module (providing titles= and friends) as well.
-      #
-      # @param value [String]
-      # @return [self]
-      def pagesetmodule(value)
-        merge(pagesetmodule: value.to_s)
-      end
-
-      # List of format module names (value of format parameter). Use modules instead.
-      #
-      # @param values [Array<String>] Allowed values: "json", "jsonfm", "none", "php", "phpfm", "rawfm", "xml", "xmlfm".
-      # @return [self]
-      def formatmodules(*values)
-        values.inject(self) { |res, val| res._formatmodules(val) or fail ArgumentError, "Unknown value for formatmodules: #{val}" }
-      end
-
-      # @private
-      def _formatmodules(value)
-        defined?(super) && super || ["json", "jsonfm", "none", "php", "phpfm", "rawfm", "xml", "xmlfm"].include?(value.to_s) && merge(formatmodules: value.to_s, replace: false)
-      end
-    end
-  end
-end

data/lib/reality/describers/wikidata/actions/parsoid-batch.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # 
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.parsoid-batch.batch(value).perform # returns string with raw output
-    # # or
-    # api.parsoid-batch.batch(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 ParsoidBatch < Reality::Describers::Wikidata::Impl::Actions::Get
-
-      # 
-      #
-      # @param value [String]
-      # @return [self]
-      def batch(value)
-        merge(batch: value.to_s)
-      end
-    end
-  end
-end