Module: Minfraud

Defined in:
lib/minfraud.rb,
lib/minfraud/enum.rb,
lib/minfraud/errors.rb,
lib/minfraud/report.rb,
lib/minfraud/version.rb,
lib/minfraud/resolver.rb,
lib/minfraud/validates.rb,
lib/minfraud/assessments.rb,
lib/minfraud/model/email.rb,
lib/minfraud/model/error.rb,
lib/minfraud/model/score.rb,
lib/minfraud/http_service.rb,
lib/minfraud/model/device.rb,
lib/minfraud/model/issuer.rb,
lib/minfraud/error_handler.rb,
lib/minfraud/model/address.rb,
lib/minfraud/model/factors.rb,
lib/minfraud/model/warning.rb,
lib/minfraud/model/abstract.rb,
lib/minfraud/model/insights.rb,
lib/minfraud/components/base.rb,
lib/minfraud/model/subscores.rb,
lib/minfraud/components/email.rb,
lib/minfraud/components/event.rb,
lib/minfraud/components/order.rb,
lib/minfraud/model/ip_address.rb,
lib/minfraud/components/device.rb,
lib/minfraud/model/credit_card.rb,
lib/minfraud/model/disposition.rb,
lib/minfraud/components/account.rb,
lib/minfraud/components/billing.rb,
lib/minfraud/components/payment.rb,
lib/minfraud/model/email_domain.rb,
lib/minfraud/components/shipping.rb,
lib/minfraud/http_service/request.rb,
lib/minfraud/model/ip_risk_reason.rb,
lib/minfraud/http_service/response.rb,
lib/minfraud/model/billing_address.rb,
lib/minfraud/model/geoip2_location.rb,
lib/minfraud/components/addressable.rb,
lib/minfraud/components/credit_card.rb,
lib/minfraud/model/score_ip_address.rb,
lib/minfraud/model/shipping_address.rb,
lib/minfraud/components/custom_inputs.rb,
lib/minfraud/components/shopping_cart.rb,
lib/minfraud/components/report/transaction.rb,
lib/minfraud/components/shopping_cart_item.rb

Overview

rubocop:disable Metrics/ModuleLength

Defined Under Namespace

Modules: Components, Enum, ErrorHandler, HTTPService, Model, Resolver Classes: Assessments, AuthorizationError, BaseError, ClientError, InvalidInputError, NotEnumValueError, Report, RequestFormatError, ServerError

Constant Summary collapse

VERSION =

The Gem version.

'1.5.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.account_id ⇒ Integer?

The MaxMind account ID that is used for authorization.

Returns:

  • (Integer, nil) 


39
40
41
 
# File 'lib/minfraud.rb', line 39

def 
  @account_id
end

.enable_validation ⇒ Boolean?

Enable client side validation. This is disabled by default.

Returns:

  • (Boolean, nil) 


44
45
46
 
# File 'lib/minfraud.rb', line 44

def enable_validation
  @enable_validation
end

.host ⇒ String?

The host to use when connecting to the web service.

Returns:

  • (String, nil) 


49
50
51
 
# File 'lib/minfraud.rb', line 49

def host
  @host
end

.license_key ⇒ String?

The MaxMind license key that is used for authorization.

Returns:

  • (String, nil) 


62
63
64
 
# File 'lib/minfraud.rb', line 62

def license_key
  @license_key
end

.user_id ⇒ Integer?

Deprecated.

Use account_id instead. This will be removed in the next major version.

The MaxMind account ID that is used for authorization.

Returns:

  • (Integer, nil) 


57
58
59
 
# File 'lib/minfraud.rb', line 57

def user_id
  @user_id
end

Class Method Details

.configuration ⇒ Hash

Deprecated.

This will be removed in the next major version.

The current Minfraud configuration.

Returns:

  • (Hash) 


82
83
84
85
86
87
 
# File 'lib/minfraud.rb', line 82

def configuration
  {
    user_id:     @user_id,
    license_key: @license_key
  }
end

.configure {|self| ... } ⇒ Object

Yield self to accept configuration settings.

Yields:

  • (self) 


70
71
72
73
74
75
 
# File 'lib/minfraud.rb', line 70

def configure
  yield self

  config      = Minfraud::HTTPService.configuration
  @connection = Faraday.new(config[:server], {}, &config[:middleware])
end