Class: Minfraud::Assessments

Inherits:

Object

• Object
• Minfraud::Assessments

Includes:

HTTPService, Resolver

Defined in:

lib/minfraud/assessments.rb

Overview

Assessments is used to perform minFraud Score, Insights, and Factors requests.

See Also:

• https://dev.maxmind.com/minfraud/

Constant Summary

Constants included from HTTPService

HTTPService::DEFAULT_SERVER

Instance Attribute Summary

• #account ⇒ Minfraud::Components::Account^?

  The Account component.

• #billing ⇒ Minfraud::Components::Billing^?

  The Billing component.

• #credit_card ⇒ Minfraud::Components::CreditCard^?

  The CreditCard component.

• #custom_inputs ⇒ Minfraud::Components::CustomInputs^?

  The CustomInputs component.

• #device ⇒ Minfraud::Components::Device^?

  The Device component.

• #email ⇒ Minfraud::Components::Email^?

  The Email component.

• #event ⇒ Minfraud::Components::Event^?

  The Event component.

• #order ⇒ Minfraud::Components::Order^?

  The Order component.

• #payment ⇒ Minfraud::Components::Payment^?

  The Payment component.

• #shipping ⇒ Minfraud::Components::Shipping^?

  The Shipping component.

• #shopping_cart ⇒ Minfraud::Components::ShoppingCart^?

  The ShoppingCart component.

Instance Method Summary

• #factors ⇒ Minfraud::HTTPService::Response

  Perform a minFraud Factors request.

• #initialize(params = {}, resolver = ::Minfraud::Resolver) ⇒ Assessments constructor

  A new instance of Assessments.

• #insights ⇒ Minfraud::HTTPService::Response

  Perform a minFraud Insights request.

• #score ⇒ Minfraud::HTTPService::Response

  Perform a minFraud Score request.

Methods included from Resolver

assign

Methods included from HTTPService

configuration

Constructor Details

#initialize(params = {}, resolver = ::Minfraud::Resolver) ⇒ Assessments

Returns a new instance of Assessments.

Parameters:

• params (Hash) (defaults to: {}) —

  Hash of parameters. Each key is a symbol corresponding to one of the available component attributes. Values may be component objects or hashes that will be provided to the component constructors.

• resolver (Minfraud::Resolver) (defaults to: ::Minfraud::Resolver) —

  Resolver that maps parameters to components.

# File 'lib/minfraud/assessments.rb', line 74

def initialize(params = {}, resolver = ::Minfraud::Resolver)
  @locales = params.delete('locales')
  @locales = ['en'] if @locales.nil?

  resolver.assign(self, params)
end

Instance Attribute Details

#account ⇒ Minfraud::Components::Account^?

The Account component.

Returns:

• (Minfraud::Components::Account, nil)

# File 'lib/minfraud/assessments.rb', line 15

def account
  @account
end

#billing ⇒ Minfraud::Components::Billing^?

The Billing component.

Returns:

• (Minfraud::Components::Billing, nil)

# File 'lib/minfraud/assessments.rb', line 20

def billing
  @billing
end

#credit_card ⇒ Minfraud::Components::CreditCard^?

The CreditCard component.

Returns:

• (Minfraud::Components::CreditCard, nil)

# File 'lib/minfraud/assessments.rb', line 25

def credit_card
  @credit_card
end

#custom_inputs ⇒ Minfraud::Components::CustomInputs^?

The CustomInputs component.

Returns:

• (Minfraud::Components::CustomInputs, nil)

# File 'lib/minfraud/assessments.rb', line 30

def custom_inputs
  @custom_inputs
end

#device ⇒ Minfraud::Components::Device^?

The Device component.

Returns:

• (Minfraud::Components::Device, nil)

# File 'lib/minfraud/assessments.rb', line 35

def device
  @device
end

#email ⇒ Minfraud::Components::Email^?

The Email component.

Returns:

• (Minfraud::Components::Email, nil)

# File 'lib/minfraud/assessments.rb', line 40

def email
  @email
end

#event ⇒ Minfraud::Components::Event^?

The Event component.

Returns:

• (Minfraud::Components::Event, nil)

# File 'lib/minfraud/assessments.rb', line 45

def event
  @event
end

#order ⇒ Minfraud::Components::Order^?

The Order component.

Returns:

• (Minfraud::Components::Order, nil)

# File 'lib/minfraud/assessments.rb', line 50

def order
  @order
end

#payment ⇒ Minfraud::Components::Payment^?

The Payment component.

Returns:

• (Minfraud::Components::Payment, nil)

# File 'lib/minfraud/assessments.rb', line 55

def payment
  @payment
end

#shipping ⇒ Minfraud::Components::Shipping^?

The Shipping component.

Returns:

• (Minfraud::Components::Shipping, nil)

# File 'lib/minfraud/assessments.rb', line 60

def shipping
  @shipping
end

#shopping_cart ⇒ Minfraud::Components::ShoppingCart^?

The ShoppingCart component.

Returns:

• (Minfraud::Components::ShoppingCart, nil)

# File 'lib/minfraud/assessments.rb', line 65

def shopping_cart
  @shopping_cart
end

Instance Method Details

#factors ⇒ Minfraud::HTTPService::Response

Perform a minFraud Factors request.

Returns:

• (Minfraud::HTTPService::Response)

Raises:

• (Minfraud::AuthorizationError) —

  If there was an authentication problem.

• (Minfraud::ClientError) —

  If there was a critical problem with one of your inputs.

• (Minfraud::ServerError) —

  If the server reported an error of some kind.

# File 'lib/minfraud/assessments.rb', line 93

def factors
  perform_request(:factors)
end

#insights ⇒ Minfraud::HTTPService::Response

Perform a minFraud Insights request.

Returns:

• (Minfraud::HTTPService::Response)

Raises:

• (Minfraud::AuthorizationError) —

  If there was an authentication problem.

• (Minfraud::ClientError) —

  If there was a critical problem with one of your inputs.

• (Minfraud::ServerError) —

  If the server reported an error of some kind.

# File 'lib/minfraud/assessments.rb', line 109

def insights
  perform_request(:insights)
end

#score ⇒ Minfraud::HTTPService::Response

Perform a minFraud Score request.

Returns:

• (Minfraud::HTTPService::Response)

Raises:

• (Minfraud::AuthorizationError) —

  If there was an authentication problem.

• (Minfraud::ClientError) —

  If there was a critical problem with one of your inputs.

• (Minfraud::ServerError) —

  If the server reported an error of some kind.

# File 'lib/minfraud/assessments.rb', line 125

def score
  perform_request(:score)
end