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/phone.rb,
lib/minfraud/model/score.rb,
lib/minfraud/model/device.rb,
lib/minfraud/model/issuer.rb,
lib/minfraud/model/reason.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/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/model/risk_score_reason.rb,
lib/minfraud/components/custom_inputs.rb,
lib/minfraud/components/shopping_cart.rb,
lib/minfraud/model/email_domain_visit.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.

'2.9.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) 


41
42
43
 
# File 'lib/minfraud.rb', line 41

def 
  @account_id
end

.enable_validation ⇒ Boolean?

Enable client side validation. This is disabled by default.

Returns:

  • (Boolean, nil) 


46
47
48
 
# File 'lib/minfraud.rb', line 46

def enable_validation
  @enable_validation
end

.host ⇒ String?

The host to use when connecting to the web service. By default, the client connects to the production host. However, during testing and development, you can set this option to ‘sandbox.maxmind.com’ to use the Sandbox environment’s host. The sandbox allows you to experiment with the API without affecting your production data.

Returns:

  • (String, nil) 


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

def host
  @host
end

.license_key ⇒ String?

The MaxMind license key that is used for authorization.

Returns:

  • (String, nil) 


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

def license_key
  @license_key
end

Class Method Details

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

Yield self to accept configuration settings.

Yields:

  • (self) 


71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/minfraud.rb', line 71

def configure
  yield self

  pool_size        = 5
  # rubocop:disable ThreadSafety/ClassInstanceVariable
  # This is a false positive - this configuration is set during initialization
  host             = @host.nil? ? 'minfraud.maxmind.com' : @host
  @connection_pool = ConnectionPool.new(size: pool_size) do
    # rubocop:enable ThreadSafety/ClassInstanceVariable
    make_http_client.persistent("https://#{host}")
  end
end