reality 0.1.0.alpha → 0.1.0.alpha2

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

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Block a user.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.block.user(value).perform # returns string with raw output
-    # # or
-    # api.block.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 Block < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Username, IP address, or IP address range to block. Cannot be used together with userid
-      #
-      # @param value [String]
-      # @return [self]
-      def user(value)
-        merge(user: value.to_s)
-      end
-
-      # User ID to block. Cannot be used together with user.
-      #
-      # @param value [Integer]
-      # @return [self]
-      def userid(value)
-        merge(userid: value.to_s)
-      end
-
-      # Expiry time. May be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). If set to infinite, indefinite, or never, the block will never expire.
-      #
-      # @param value [String]
-      # @return [self]
-      def expiry(value)
-        merge(expiry: value.to_s)
-      end
-
-      # Reason for block.
-      #
-      # @param value [String]
-      # @return [self]
-      def reason(value)
-        merge(reason: value.to_s)
-      end
-
-      # Block anonymous users only (i.e. disable anonymous edits for this IP address).
-      #
-      # @return [self]
-      def anononly()
-        merge(anononly: 'true')
-      end
-
-      # Prevent account creation.
-      #
-      # @return [self]
-      def nocreate()
-        merge(nocreate: 'true')
-      end
-
-      # Automatically block the last used IP address, and any subsequent IP addresses they try to login from.
-      #
-      # @return [self]
-      def autoblock()
-        merge(autoblock: 'true')
-      end
-
-      # Prevent user from sending email through the wiki. (Requires the blockemail right).
-      #
-      # @return [self]
-      def noemail()
-        merge(noemail: 'true')
-      end
-
-      # Hide the username from the block log. (Requires the hideuser right).
-      #
-      # @return [self]
-      def hidename()
-        merge(hidename: 'true')
-      end
-
-      # Allow the user to edit their own talk page (depends on $wgBlockAllowsUTEdit).
-      #
-      # @return [self]
-      def allowusertalk()
-        merge(allowusertalk: 'true')
-      end
-
-      # If the user is already blocked, overwrite the existing block.
-      #
-      # @return [self]
-      def reblock()
-        merge(reblock: 'true')
-      end
-
-      # Watch the user's or IP address's user and talk pages.
-      #
-      # @return [self]
-      def watchuser()
-        merge(watchuser: 'true')
-      end
-
-      # Change tags to apply to the entry in the block 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

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Receive a bounce email and process it to handle the failing recipient.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.bouncehandler.email(value).perform # returns string with raw output
-    # # or
-    # api.bouncehandler.email(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 Bouncehandler < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # The bounced email.
-      #
-      # @param value [String]
-      # @return [self]
-      def email(value)
-        merge(email: value.to_s)
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Internal module for the CategoryTree extension.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.categorytree.category(value).perform # returns string with raw output
-    # # or
-    # api.categorytree.category(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 Categorytree < Reality::Describers::Wikidata::Impl::Actions::Get
-
-      # Title in the category namespace, prefix will be ignored if given.
-      #
-      # @param value [String]
-      # @return [self]
-      def category(value)
-        merge(category: value.to_s)
-      end
-
-      # Options for the CategoryTree constructor as a JSON object. The depth option defaults to 1.
-      #
-      # @param value [String]
-      # @return [self]
-      def options(value)
-        merge(options: value.to_s)
-      end
-    end
-  end
-end

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

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Fetch a centralauthtoken for making an authenticated request to an attached wiki.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.centralauthtoken.perform # returns string with raw output
-    # # or
-    # api.centralauthtoken.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 Centralauthtoken < Reality::Describers::Wikidata::Impl::Actions::Get
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Get data needed to choose a banner for a given project and language
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.centralnoticechoicedata.project(value).perform # returns string with raw output
-    # # or
-    # api.centralnoticechoicedata.project(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 Centralnoticechoicedata < Reality::Describers::Wikidata::Impl::Actions::Get
-
-      # The project to get banner choice data for.
-      #
-      # @param value [String]
-      # @return [self]
-      def project(value)
-        merge(project: value.to_s)
-      end
-
-      # The language to get banner choice data for.
-      #
-      # @param value [String]
-      # @return [self]
-      def language(value)
-        merge(language: value.to_s)
-      end
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Get all configuration settings for a campaign.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.centralnoticequerycampaign.campaign(value).perform # returns string with raw output
-    # # or
-    # api.centralnoticequerycampaign.campaign(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 Centralnoticequerycampaign < Reality::Describers::Wikidata::Impl::Actions::Get
-
-      # Campaign name. Separate multiple values with a "|" (vertical bar).
-      #
-      # @param value [String]
-      # @return [self]
-      def campaign(value)
-        merge(campaign: value.to_s)
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Change authentication data for the current user.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.changeauthenticationdata.request(value).perform # returns string with raw output
-    # # or
-    # api.changeauthenticationdata.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 Changeauthenticationdata < Reality::Describers::Wikidata::Impl::Actions::Post
-
-      # Use this authentication request, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=change.
-      #
-      # @param value [String]
-      # @return [self]
-      def request(value)
-        merge(changeauthrequest: value.to_s)
-      end
-
-      # A "csrf" token retrieved from action=query&meta=tokens
-      #
-      # @param value [String]
-      # @return [self]
-      def token(value)
-        merge(changeauthtoken: value.to_s)
-      end
-    end
-  end
-end

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

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Check the validity of a token from action=query&meta=tokens.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.checktoken.type(value).perform # returns string with raw output
-    # # or
-    # api.checktoken.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 Checktoken < Reality::Describers::Wikidata::Impl::Actions::Get
-
-      # Type of token being tested.
-      #
-      # @param value [String] One of "createaccount", "csrf", "deleteglobalaccount", "login", "patrol", "rollback", "setglobalaccountstatus", "userrights", "watch".
-      # @return [self]
-      def type(value)
-        _type(value) or fail ArgumentError, "Unknown value for type: #{value}"
-      end
-
-      # @private
-      def _type(value)
-        defined?(super) && super || ["createaccount", "csrf", "deleteglobalaccount", "login", "patrol", "rollback", "setglobalaccountstatus", "userrights", "watch"].include?(value.to_s) && merge(type: value.to_s)
-      end
-
-      # Token to test.
-      #
-      # @param value [String]
-      # @return [self]
-      def token(value)
-        merge(token: value.to_s)
-      end
-
-      # Maximum allowed age of the token, in seconds.
-      #
-      # @param value [Integer]
-      # @return [self]
-      def maxtokenage(value)
-        merge(maxtokenage: value.to_s)
-      end
-    end
-  end
-end

data/lib/reality/describers/wikidata/actions/cirrus-config-dump.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Dump of CirrusSearch configuration.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.cirrus-config-dump.perform # returns string with raw output
-    # # or
-    # api.cirrus-config-dump.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 CirrusConfigDump < Reality::Describers::Wikidata::Impl::Actions::Get
-    end
-  end
-end

data/lib/reality/describers/wikidata/actions/cirrus-mapping-dump.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Reality::Describers::Wikidata::Impl
-  module Actions
-    # Dump of CirrusSearch mapping for this wiki.
-    #
-    # Usage:
-    #
-    # ```ruby
-    # api.cirrus-mapping-dump.perform # returns string with raw output
-    # # or
-    # api.cirrus-mapping-dump.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 CirrusMappingDump < Reality::Describers::Wikidata::Impl::Actions::Get
-    end
-  end
-end