module Minfraud

Constants

VERSION

Public Class Methods

configure() { |self| ... } click to toggle source

May be used to configure using common block style:

“‘ruby Minfraud.configure do |c|

c.license_key = 'abcd1234'

end “‘

@param [Proc] is passed the Minfraud module as its argument @return [nil, ConfigurationError]

# File lib/minfraud/minfraud.rb, line 22
def self.configure
  yield self
  unless has_required_configuration?
    raise ConfigurationError, 'You must set license_key so MaxMind can identify you'
  end
end
has_required_configuration?() click to toggle source

@return [Boolean] service URI

# File lib/minfraud/minfraud.rb, line 67
def self.has_required_configuration?
  class_variable_defined?(:@@license_key)
end
license_key() click to toggle source

Module attribute getter for license_key This is the MaxMind API consumer’s license key. @return [String, nil] license key if set

# File lib/minfraud/minfraud.rb, line 32
def self.license_key
  class_variable_defined?(:@@license_key) ? @@license_key : nil
end
license_key=(key) click to toggle source

Module attribute setter for license_key This is the MaxMind API consumer’s license key. It is required for this gem to work. @param key [String] license key @return [String] license key

# File lib/minfraud/minfraud.rb, line 41
def self.license_key=(key)
  @@license_key = key
end
requested_type() click to toggle source

Module attribute getter for requested_type minFraud service level (standard/premium) @return [String, nil] service level if set

# File lib/minfraud/minfraud.rb, line 48
def self.requested_type
  class_variable_defined?(:@@requested_type) ? @@requested_type : nil
end
requested_type=(type) click to toggle source

Module attribute setter for requested_type Desired service level (standard/premium) @param type [String] service level @return [String] service level

# File lib/minfraud/minfraud.rb, line 56
def self.requested_type=(type)
  @@requested_type = type
end
uri() click to toggle source

MaxMind minFraud API service URI @return [URI::HTTPS] service uri

# File lib/minfraud/minfraud.rb, line 62
def self.uri
  @@uri ||= URI('https://minfraud.maxmind.com/app/ccv2r')
end