Sha256: d99a889e04b98f0cf2d927da45f3742414267823f090998387e9a17a5b67e78f

Contents?: true

Size: 897 Bytes

Versions: 4

Compression:

Stored size: 897 Bytes

Contents

# frozen_string_literal: true

module MediaWiktory::Wikipedia
  module Actions
    # Check a username against AntiSpoof's normalisation checks.
    #
    # Usage:
    #
    # ```ruby
    # api.antispoof.username(value).perform # returns string with raw output
    # # or
    # api.antispoof.username(value).response # returns output parsed and wrapped into Response object
    # ```
    #
    # See {Base} for generic explanation of working with MediaWiki actions and
    # {MediaWiktory::Wikipedia::Response} for working with action responses.
    #
    # All action's parameters are documented as its public methods, see below.
    #
    class Antispoof < MediaWiktory::Wikipedia::Actions::Get

      # The username to check against AntiSpoof.
      #
      # @param value [String]
      # @return [self]
      def username(value)
        merge(username: value.to_s)
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
mediawiktory-0.1.3 lib/mediawiktory/wikipedia/actions/antispoof.rb
mediawiktory-0.1.2 lib/mediawiktory/wikipedia/actions/antispoof.rb
mediawiktory-0.1.1 lib/mediawiktory/wikipedia/actions/antispoof.rb
mediawiktory-0.1.0 lib/mediawiktory/wikipedia/actions/antispoof.rb