Contents

# frozen_string_literal: true

module MediaWiktory::Wikipedia
  module Actions
    # Validate a password against the wiki's password policies.
    #
    # Usage:
    #
    # ```ruby
    # api.validatepassword.password(value).perform # returns string with raw output
    # # or
    # api.validatepassword.password(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 Validatepassword < MediaWiktory::Wikipedia::Actions::Post

      # Password to validate.
      #
      # @param value [String]
      # @return [self]
      def password(value)
        merge(password: value.to_s)
      end

      # User name, for use when testing account creation. The named user must not exist.
      #
      # @param value [String]
      # @return [self]
      def user(value)
        merge(user: value.to_s)
      end

      # Email address, for use when testing account creation.
      #
      # @param value [String]
      # @return [self]
      def email(value)
        merge(email: value.to_s)
      end

      # Real name, for use when testing account creation.
      #
      # @param value [String]
      # @return [self]
      def realname(value)
        merge(realname: 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/validatepassword.rb
mediawiktory-0.1.2	lib/mediawiktory/wikipedia/actions/validatepassword.rb
mediawiktory-0.1.1	lib/mediawiktory/wikipedia/actions/validatepassword.rb
mediawiktory-0.1.0	lib/mediawiktory/wikipedia/actions/validatepassword.rb