minfraud 1.0.3 → 1.4.0

data/lib/minfraud/error_handler.rb

@@ -1,37 +1,64 @@
+# frozen_string_literal: true
+
 module Minfraud
+  # ErrorHandler provides a method to raise exceptions on errors.
   module ErrorHandler
     class << self
-      # Returns a response if status code is 200, rises an error otherwise
-      # @param [Minfraud::HTTPService::Response] response
-      # @return [Minfraud::HTTPService::Response] if status code is 200
-      def inspect(response)
-        return response if response.status == 200
+      # Return the response if the HTTP status code is 2xx. Otherwise raise
+      # an error.
+      #
+      # @param response [Minfraud::HTTPService::Response]
+      #
+      # @return [Minfraud::HTTPService::Response]
+      #
+      # @raise [Minfraud::AuthorizationError] If there was an authentication
+      #   problem.
+      #
+      # @raise [Minfraud::ClientError] If there was a critical problem with one
+      #   of your inputs.
+      #
+      # @raise [Minfraud::ServerError] If the server reported an error of some
+      #   kind.
+      def examine(response)
+        return response if response.status > 199 && response.status < 300
 
-        raise *STATUS_CODES.fetch(response.code, [ServerError, 'Server error'])
+        raise(*STATUS_CODES.fetch(response.code, [ServerError, 'Server error']))
       end
 
-      # A hash that maps status codes returned by minFraud with errors & messages
+      # @!visibility private
       STATUS_CODES = {
-        IP_ADDRESS_INVALID:    [
-          ClientError, 'You have no supplied a valid IPv4 or IPv6 address'
+        JSON_INVALID:          [
+          ClientError, 'JSON body cannot be decoded'
         ],
-        IP_ADDRESS_REQUIRED:   [
-          ClientError,  'You have not supplied an IP address which is required filed'
+        MAXMIND_ID_INVALID:    [
+          ClientError, 'You have not supplied a valid maxmind_id'
         ],
-        IP_ADDRESS_RESERVED:   [
-          ClientError, 'You have supplied an IP address which is reserved'
+        MINFRAUD_ID_INVALID:   [
+          ClientError, 'You have not supplied a valid minfraud_id'
         ],
-        JSON_INVALID:          [
-          ClientError, 'JSON body cannot be decoded'
+        PARAMETER_UNKNOWN:     [
+          ClientError, 'You have supplied an unknown parameter'
+        ],
+        REQUEST_INVALID:       [
+          ClientError, 'The request did not contain any valid input values.'
+        ],
+        TAG_REQUIRED:          [
+          ClientError, 'You have not supplied a tag, which is a required field'
+        ],
+        TAG_INVALID:           [
+          ClientError, 'You have not supplied a valid tag'
+        ],
+        ACCOUNT_ID_REQUIRED:   [
+          AuthorizationError, 'You have not supplied a account ID'
         ],
         AUTHORIZATION_INVALID: [
-          AuthorizationError, 'Invalid license key and / or user id'
+          AuthorizationError, 'Invalid license key and / or account ID'
         ],
         LICENSE_KEY_REQUIRED:  [
           AuthorizationError, 'You have not supplied a license key'
         ],
         USER_ID_REQUIRED:      [
-          AuthorizationError, 'You have not supplied a user id'
+          AuthorizationError, 'You have not supplied a account id'
         ],
         INSUFFICIENT_FUNDS:    [
           ClientError, 'The license key you have provided does not have a sufficient funds to use this service'
@@ -39,7 +66,7 @@ module Minfraud
         PERMISSION_REQUIRED:   [
           ClientError, 'You do not have permission to use this service'
         ]
-      }
+      }.freeze
     end
   end
 end

data/lib/minfraud/errors.rb

@@ -1,10 +1,30 @@
+# frozen_string_literal: true
+
 module Minfraud
-  # A list of Minfraud custom errors
-  class BaseError          < StandardError; end
+  # The base error class for Minfraud exceptions.
+  class BaseError < StandardError; end
+
+  # An error indicating the input value is not valid.
+  class InvalidInputError < BaseError; end
 
+  # An error indicating the value is not valid for the enumerated type.
   class NotEnumValueError  < BaseError; end
+
+  # An error indicating the field is not recognized.
   class RequestFormatError < BaseError; end
+
+  # An error indicating minFraud cannot serve your request as there is a
+  # problem on the client side.
+  #
+  # For example, this may happen if there is a problem with the format or
+  # contents of your request, if you lack funds to use the service, or if you
+  # don't have permission to use the service.
   class ClientError        < BaseError; end
+
+  # An error indicating there is a problem with authorization or
+  # authentication.
   class AuthorizationError < BaseError; end
+
+  # An error indicating the server had an error handling the request.
   class ServerError        < BaseError; end
 end

data/lib/minfraud/http_service.rb

@@ -1,31 +1,45 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday_middleware'
 
 module Minfraud
+  # HTTPService holds the HTTP client configuration.
   module HTTPService
     class << self
-      # @return [Hash] default HTTPService configuration
+      # The default HTTPService configuration.
+      #
+      # @return [Hash]
       def configuration
+        server = DEFAULT_SERVER
+        if !Minfraud.host.nil?
+          server = "https://#{Minfraud.host}/minfraud/v2.0"
+        end
+
         {
           middleware: DEFAULT_MIDDLEWARE,
-          server:     DEFAULT_SERVER
+          server:     server,
         }
       end
     end
 
-    # Minfraud default middleware stack
-    DEFAULT_MIDDLEWARE = Proc.new do |builder|
+    # @!visibility private
+    DEFAULT_MIDDLEWARE = proc do |builder|
       builder.request    :json
 
-      builder.basic_auth *::Minfraud.configuration.values
+      account_id = Minfraud.account_id
+      account_id = Minfraud.user_id if account_id.nil?
+
+      builder.basic_auth account_id, Minfraud.license_key
 
-      builder.response   :mashify
       builder.response   :json, content_type: /\bjson$/
 
-      builder.adapter    Faraday.default_adapter
+      builder.adapter :net_http_persistent, pool_size: 5 do |http|
+        http.idle_timeout = 30
+      end
     end
 
-    # Minfraud default server
+    # Default base URL for minFraud.
     DEFAULT_SERVER = 'https://minfraud.maxmind.com/minfraud/v2.0'
   end
 end

data/lib/minfraud/http_service/request.rb

@@ -1,36 +1,37 @@
+# frozen_string_literal: true
+
 require 'faraday'
 
 module Minfraud
   module HTTPService
+    # Request performs HTTP requests.
     class Request
-      # @attribute middleware
-      # @return [Proc] A proc containing Faraday configuration
+      # A proc containing Faraday configuration.
+      #
+      # @return [Proc, nil]
       attr_reader :middleware
 
-      # @attribute server
-      # @return [String] an API endpoint
+      # The API endpoint.
+      #
+      # @return [String, nil]
       attr_reader :server
 
-      # Creates Minfraud::HTTPService::Request instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::HTTPService::Request] Request instance
+      # @param params [Hash] Hash of parameters. Each key/value should
+      #   correspond to one of the available attributes.
       def initialize(params = {})
         @middleware = params[:middleware]
         @server     = params[:server]
       end
 
-      # Performs an HTTP request to the specified endpoint with given body
-      # @param  [Hash] params hash of parameters.
-      # @return [Farday::Response] Faraday::Response instance
+      # Perform an HTTP request to the specified endpoint with given body.
+      #
+      # @param params [Hash] Hash of parameters, including +:verb+,
+      #   +:endpoint+, and +:body+.
+      #
+      # @return [Farday::Response]
       def perform(params)
-        adapter.send(*params.values_at(:verb, :endpoint, :body))
-      end
-
-      private
-      # Creates memoized Faraday::Connection instance
-      # @return [Faraday::Connection] Faraday::Connection instance
-      def adapter
-        @adapter ||= Faraday.new(server, {}, &middleware)
+        connection = Minfraud.connection
+        connection.send(*params.values_at(:verb, :endpoint, :body))
       end
     end
   end

data/lib/minfraud/http_service/response.rb

@@ -1,32 +1,69 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/error'
+require 'minfraud/model/factors'
+require 'minfraud/model/insights'
+require 'minfraud/model/score'
+
 module Minfraud
   module HTTPService
+    # Response class for HTTP requests.
     class Response
-      # @attribute status
-      # @return [Integer] HTTP response status
+      # HTTP response status.
+      #
+      # @return [Integer, nil]
       attr_reader :status
 
-      # @attribute body
-      # @return [Hash] HTTP response body
+      # HTTP response model.
+      #
+      # @return [Minfraud::Model::Score, Minfraud::Model::Insights,
+      #   Minfraud::Model::Factors, nil]
       attr_reader :body
 
-      # @attribute headers
-      # @return [Hash] HTTP response headers
+      # HTTP response headers.
+      #
+      # @return [Hash, nil]
       attr_reader :headers
 
-      # Creates Minfraud::HTTPService::Response instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::HTTPService::Response] Response instance
+      # @param params [Hash] Hash of parameters. +:status+, +:endpoint+,
+      #   +:body+, +:locales+, and +:headers+ are used.
       def initialize(params = {})
         @status  = params[:status]
-        @body    = params[:body]
+        @body    = make_body(
+          params[:endpoint],
+          params[:body],
+          params[:locales]
+        )
         @headers = params[:headers]
       end
 
-      # Returns minFraud specific response code
-      # @return [Symbol] minFraud specific request code
+      # Return the minFraud-specific response code.
+      #
+      # @return [Symbol, nil]
       def code
+        return nil if body.nil?
+
         body.code.intern if body.respond_to?(:code) && body.code
       end
+
+      private
+
+      def make_body(endpoint, body, locales)
+        if @status != 200
+          # Won't be a Hash when the body is not JSON.
+          return nil unless body.is_a?(Hash)
+
+          return Minfraud::Model::Error.new(body)
+        end
+
+        ENDPOINT_TO_CLASS[endpoint].new(body, locales)
+      end
+
+      ENDPOINT_TO_CLASS = {
+        factors:  Minfraud::Model::Factors,
+        insights: Minfraud::Model::Insights,
+        score:    Minfraud::Model::Score
+      }.freeze
     end
   end
 end

data/lib/minfraud/model/abstract.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Minfraud
+  module Model
+    # @!visibility private
+    class Abstract
+      def initialize(record)
+        @record = record
+      end
+
+      protected
+
+      def get(key)
+        return nil if @record.nil? || !@record.key?(key)
+
+        @record[key]
+      end
+    end
+  end
+end

data/lib/minfraud/model/address.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+
+module Minfraud
+  module Model
+    # Abstract model for a postal address.
+    class Address < Abstract
+      # The distance in kilometers from the address to the IP location.
+      #
+      # @return [Integer, nil]
+      attr_reader :distance_to_ip_location
+
+      # This property is true if the address is in the IP country. The property
+      # is false when the address is not in the IP country. If the address
+      # could not be parsed or was not provided or if the IP address could not
+      # be geolocated, the property will be nil.
+      #
+      # @return [Boolean, nil]
+      attr_reader :is_in_ip_country
+
+      # This property is true if the postal code provided with the address is
+      # in the city for the address. The property is false when the postal code
+      # is not in the city. If the address was not provided or could not be
+      # parsed, the property will be nil.
+      #
+      # @return [Boolean, nil]
+      attr_reader :is_postal_in_city
+
+      # The latitude associated with the address.
+      #
+      # @return [Float, nil]
+      attr_reader :latitude
+
+      # The longitude associated with the address.
+      #
+      # @return [Float, nil]
+      attr_reader :longitude
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @distance_to_ip_location = get('distance_to_ip_location')
+        @is_in_ip_country        = get('is_in_ip_country')
+        @is_postal_in_city       = get('is_postal_in_city')
+        @latitude                = get('latitude')
+        @longitude               = get('longitude')
+      end
+    end
+  end
+end

data/lib/minfraud/model/billing_address.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/address'
+
+module Minfraud
+  module Model
+    # Model containing information about the billing address.
+    class BillingAddress < Address
+    end
+  end
+end

data/lib/minfraud/model/credit_card.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+require 'minfraud/model/issuer'
+
+module Minfraud
+  module Model
+    # Model with details about the credit card used.
+    class CreditCard < Abstract
+      # The card brand, such as "Visa", "Discover", "American Express", etc.
+      #
+      # @return [String, nil]
+      attr_reader :brand
+
+      # This property contains the two letter ISO 3166-1 alpha-2 country code
+      # (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) associated with the
+      # location of the majority of customers using this credit card as
+      # determined by their billing address. In cases where the location of
+      # customers is highly mixed, this defaults to the country of the bank
+      # issuing the card.
+      #
+      # @return [String, nil]
+      attr_reader :country
+
+      # This property is true if the card is a business card.
+      #
+      # @return [Boolean, nil]
+      attr_reader :is_business
+
+      # This property is true if the country of the billing address matches the
+      # country of the majority of customers using this credit card. In cases
+      # where the location of customers is highly mixed, the match is to the
+      # country of the bank issuing the card.
+      #
+      # @return [Boolean, nil]
+      attr_reader :is_issued_in_billing_address_country
+
+      # This property is true if the card is a prepaid card.
+      #
+      # @return [Boolean, nil]
+      attr_reader :is_prepaid
+
+      # This property is true if the card is a virtual card.
+      #
+      # @return [Boolean, nil]
+      attr_reader :is_virtual
+
+      # An object containing information about the credit card issuer.
+      #
+      # @return [Minfraud::Model::Issuer]
+      attr_reader :issuer
+
+      # The card's type. The valid values are: charge, credit, debit.
+      #
+      # @return [String, nil]
+      attr_reader :type
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @brand                                = get('brand')
+        @country                              = get('country')
+        @is_business                          = get('is_business')
+        @is_issued_in_billing_address_country = get(
+          'is_issued_in_billing_address_country'
+        )
+        @is_prepaid                           = get('is_prepaid')
+        @is_virtual                           = get('is_virtual')
+        @issuer                               = Minfraud::Model::Issuer.new(get('issuer'))
+        @type                                 = get('type')
+      end
+    end
+  end
+end