minfraud 1.1.0

data/lib/minfraud.rb

@@ -0,0 +1,51 @@
+require 'minfraud'
+require 'minfraud/enum'
+require 'minfraud/components/base'
+require 'minfraud/components/account'
+require 'minfraud/components/addressable'
+require 'minfraud/components/billing'
+require 'minfraud/components/credit_card'
+require 'minfraud/components/custom_inputs'
+require 'minfraud/components/device'
+require 'minfraud/components/email'
+require 'minfraud/components/event'
+require 'minfraud/components/order'
+require 'minfraud/components/payment'
+require 'minfraud/components/report/transaction'
+require 'minfraud/components/shipping'
+require 'minfraud/components/shopping_cart'
+require 'minfraud/components/shopping_cart_item'
+require 'minfraud/resolver'
+require 'minfraud/version'
+require 'minfraud/errors'
+require 'minfraud/http_service'
+require 'minfraud/http_service/request'
+require 'minfraud/http_service/response'
+require 'minfraud/error_handler'
+require 'minfraud/assessments'
+require 'minfraud/report'
+
+module Minfraud
+  class << self
+    # @!attribute user_id
+    # @return [String] MaxMind account ID that is used for authorization
+    attr_accessor :user_id
+
+    # @!attribute license_key
+    # @return [String] MaxMind license key that is used for authorization
+    attr_accessor :license_key
+
+    # @yield [self] to accept configuration settings
+    def configure
+      yield self
+    end
+
+    # @return [Hash] current Minfraud configuration
+    def configuration
+      {
+        user_id:     @user_id,
+        license_key: @license_key
+      }
+    end
+  end
+end

data/lib/minfraud/assessments.rb

@@ -0,0 +1,101 @@
+module Minfraud
+  class Assessments
+    include ::Minfraud::HTTPService
+    include ::Minfraud::Resolver
+
+    # @attribute account
+    # @return [Minfraud::Components::Account] Account component
+    attr_accessor :account
+
+    # @attribute billing
+    # @return [Minfraud::Components::Billing] Billing component
+    attr_accessor :billing
+
+    # @attribute credit_card
+    # @return [Minfraud::Components::CreditCard] CreditCard component
+    attr_accessor :credit_card
+
+    # @attribute custom_inputs
+    # @return [Minfraud::Components::CustomInputs] CustomInputs component
+    attr_accessor :custom_inputs
+
+    # @attribute device
+    # @return [Minfraud::Components::Device] Device component
+    attr_accessor :device
+
+    # @attribute email
+    # @return [Minfraud::Components::Email] Email component
+    attr_accessor :email
+
+    # @attribute event
+    # @return [Minfraud::Components::Event] Event component
+    attr_accessor :event
+
+    # @attribute order
+    # @return [Minfraud::Components::Order] Order component
+    attr_accessor :order
+
+    # @attribute payment
+    # @return [Minfraud::Components::Payment] Payment component
+    attr_accessor :payment
+
+    # @!attribute shipping
+    # @return [Minfraud::Components::Shipping] Shipping component
+    attr_accessor :shipping
+
+    # @!attribute shopping_cart
+    # @return [Minfraud::Components::ShoppingCart] ShoppingCart component
+    attr_accessor :shopping_cart
+
+    # @param  [Hash] params hash of parameters
+    # @param  [Minfraud::Resolver] resolver resolver that maps params to components
+    # @note In case when params is a Hash of components it just assigns them to the corresponding instance variables
+    # @return [Minfraud::Assessments] Assessments instance
+    def initialize(params = {}, resolver = ::Minfraud::Resolver)
+      @locales = params.delete('locales')
+      @locales = ['en'] if @locales.nil?
+
+      resolver.assign(self, params)
+    end
+
+    # @!macro [attach] define
+    #   @method $1
+    #   Makes a request to minFraud $1 endpoint.
+    #   Raises an error in case of invalid response
+    #   @return [Minfraud::HTTPService::Response] Wrapped minFraud response
+    def self.define(endpoint)
+      define_method(endpoint) do
+        raw       = request.perform(verb: :post, endpoint: endpoint.to_s, body: request_body)
+        response  = ::Minfraud::HTTPService::Response.new(
+          endpoint: endpoint,
+          locales:  @locales,
+          status:   raw.status.to_i,
+          body:     raw.body,
+          headers:  raw.headers
+        )
+
+        ::Minfraud::ErrorHandler.examine(response)
+      end
+    end
+
+    define :score
+    define :insights
+    define :factors
+
+    private
+    # Creates a unified request body from components converted to JSON
+    # @return [Hash] Request body
+    def request_body
+      MAPPING.keys.inject({}) do |mem, e|
+        next mem unless value = send(e)
+        mem.merge!(e.to_s => value.to_json)
+      end
+    end
+
+    # Creates memoized Minfraud::HTTPService::Request instance
+    # @return [Minfraud::HTTPService::Request] Request instance based on configuration params
+    def request
+      @request ||= Request.new(::Minfraud::HTTPService.configuration)
+    end
+  end
+end

data/lib/minfraud/components/account.rb

@@ -0,0 +1,23 @@
+module Minfraud
+  module Components
+    class Account < Base
+      # @attribute user_id
+      # @return [String] A unique user ID associated with the end-user in your system.
+      # If your system allows the login name for the account to be changed, this should not be the login name for the account,
+      # but rather should be an internal ID that does not change. This is not your MaxMind user ID.
+      attr_accessor :user_id
+
+      # @attribute username_md5
+      # @return [String] An MD5 hash as a hexadecimal string of the username or login name associated with the account
+      attr_accessor :username_md5
+
+      # Creates Minfraud::Components::Account instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::Account] an Account instance
+      def initialize(params = {})
+        @user_id      = params[:user_id]
+        @username_md5 = params[:username_md5]
+      end
+    end
+  end
+end

data/lib/minfraud/components/addressable.rb

@@ -0,0 +1,67 @@
+module Minfraud
+  module Components
+    class Addressable < Base
+      # @attribute first_name
+      # @return [String] The first name of the end user as provided in their billing / shipping information
+      attr_accessor :first_name
+
+      # @attribute last_name
+      # @return [String] The last name of the end user as provided in their billing / shipping information
+      attr_accessor :last_name
+
+      # @attribute company
+      # @return [String] The company of the end user as provided in their billing / shipping information
+      attr_accessor :company
+
+      # @attribute address
+      # @return [String] The first line of the user’s billing / shipping address
+      attr_accessor :address
+
+      # @attribute address_2
+      # @return [String] The second line of the user’s billing / shipping address
+      attr_accessor :address_2
+
+      # @attribute city
+      # @return [String] The city of the user's billing / shipping address
+      attr_accessor :city
+
+      # @attribute region
+      # @return [String] The ISO 3166-2 subdivision code for the user’s billing / shipping address
+      attr_accessor :region
+
+      # @attribute country
+      # @return [String] The two character ISO 3166-1 alpha-2 country code of the user’s billing / shipping address
+      attr_accessor :country
+
+      # @attribute postal
+      # @return [String] The postal code of the user’s billing / shipping address
+      attr_accessor :postal
+
+      # @attribute phone_number
+      # @return [String] The phone number without the country code for the user’s billing / shipping address
+      attr_accessor :phone_number
+
+      # @attribute phone_country_code
+      # @return [String] The country code for phone number associated with the user’s billing / shipping address
+      attr_accessor :phone_country_code
+
+      # Creates Minfraud::Components::Addressable instance
+      # @note This class is used as a parent class for Billing and Shipping components
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::Addressable] an Addressable instance
+      def initialize(params = {})
+        @first_name         = params[:first_name]
+        @last_name          = params[:last_name]
+        @company            = params[:company]
+        @address            = params[:address]
+        @address_2          = params[:address_2]
+        @city               = params[:city]
+        @region             = params[:region]
+        @country            = params[:country]
+        @postal             = params[:postal]
+        @phone_number       = params[:phone_number]
+        @phone_country_code = params[:phone_country_code]
+      end
+    end
+  end
+end

data/lib/minfraud/components/base.rb

@@ -0,0 +1,35 @@
+module Minfraud
+  module Components
+    # @note This class is used as a parent class for all other components
+    # @note It defines a method which is used for basic JSON representation of PORO objects
+    class Base
+      # @return [Hash] a JSON representation of component attributes
+      def to_json
+        instance_variables.inject({}) { |mem, e| populate!(mem, e) }
+      end
+
+      private
+
+      # @note   This method may modify passed hash. Non-existing instance variables are ignored
+      # @param  [Hash] hash an accumulator
+      # @param  [Symbol] v_sym an instance variable symbol
+      # @return [Hash] a hash containing a JSON representation of instance variable name and it's value
+      def populate!(hash, v_sym)
+        return hash unless value = instance_variable_get(v_sym)
+
+        key = v_sym.to_s.gsub(/@/, '')
+        hash.merge!(key => represent(key, value))
+      end
+
+      # param [Symbol] key instance variable symbol
+      # param [Object] value instance variable value
+      # @return [Object] value representation according to the request format
+      def represent(key, value)
+        BOOLS.include?(key) ? value : value.to_s
+      end
+
+      # Keys that have to remain boolean
+      BOOLS = %w(was_authorized is_gift has_gift_message)
+    end
+  end
+end

data/lib/minfraud/components/billing.rb

@@ -0,0 +1,5 @@
+module Minfraud
+  module Components
+    class Billing < Addressable; end
+  end
+end

data/lib/minfraud/components/credit_card.rb

@@ -0,0 +1,52 @@
+module Minfraud
+  module Components
+    class CreditCard < Base
+      # @attribute issuer_id_number
+      # # @return [String] The issuer ID number for the credit card. This is the first 6 digits of the credit card number.
+      # It identifies the issuing bank
+      attr_accessor :issuer_id_number
+
+      # @attribute last_4_digits
+      # @return [String] The last four digits of the credit card number
+      attr_accessor :last_4_digits
+
+      # @attribute bank_name
+      # @return [String] The name of the issuing bank as provided by the end user
+      attr_accessor :bank_name
+
+      # @attribute bank_phone_country_code
+      # @return [String] The phone country code for the issuing bank as provided by the end user
+      attr_accessor :bank_phone_country_code
+
+      # @attribute bank_phone_number
+      # @return [String] The phone number, without the country code, for the issuing bank as provided by the end user
+      attr_accessor :bank_phone_number
+
+      #@attribute token
+      #@return [String] A token uniquely identifying the card. The token should consist of non-space printable ASCII characters.
+      attr_accessor :token
+
+      # @attribute avs_result
+      # @return [String] The address verification system (AVS) check result, as returned to you by the credit card processor
+      attr_accessor :avs_result
+
+      # @attribute cvv_result
+      # @return [String] The card verification value (CVV) code as provided by the payment processor
+      attr_accessor :cvv_result
+
+      # Creates Minfraud::Components::CreditCard instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::CreditCard] a CreditCard instance
+      def initialize(params = {})
+        @bank_phone_country_code = params[:bank_phone_country_code]
+        @issuer_id_number        = params[:issuer_id_number]
+        @last_4_digits           = params[:last_4_digits]
+        @bank_name               = params[:bank_name]
+        @bank_phone_number       = params[:bank_phone_number]
+        @avs_result              = params[:avs_result]
+        @cvv_result              = params[:cvv_result]
+        @token                   = params[:token]
+      end
+    end
+  end
+end

data/lib/minfraud/components/custom_inputs.rb

@@ -0,0 +1,14 @@
+module Minfraud
+  module Components
+    class CustomInputs < Base
+      # Creates Minfraud::Components::CustomInputs instance
+      # @param  [Hash] params hash with keys that match your created custom input keys
+      # @return [Minfraud::Components::CustomInputs] a CustomInputs instance
+      def initialize(params = {})
+        params.each do |name, value|
+          instance_variable_set("@#{name}", value)
+        end
+      end
+    end
+  end
+end

data/lib/minfraud/components/device.rb

@@ -0,0 +1,38 @@
+module Minfraud
+  module Components
+    class Device < Base
+      # @!attribute ip_address
+      # @return [String] The IP address associated with the device used by the customer in the transaction.
+      # The IP address must be in IPv4 or IPv6 presentation format
+      attr_accessor :ip_address
+
+      # @attribute user_agent
+      # @return [String] The HTTP "User-Agent" header of the browser used in the transaction
+      attr_accessor :user_agent
+
+      # @attribute :accept_language
+      # @return [String] The HTTP "Accept-Language" header of the browser used in the transaction
+      attr_accessor :accept_language
+
+      # @attribute :session_age
+      # @return [Decimal] The number of seconds between the creation of the user’s session and the time of the transaction.
+      # Note that session_age is not the duration of the current visit, but the time since the start of the first visit.
+      attr_accessor :session_age
+
+      # @attribute :session_id
+      # @return [String] An ID that uniquely identifies a visitor’s session on the site.
+      attr_accessor :session_id
+
+      # Creates Minfraud::Components::Device instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::Device] a Device instance
+      def initialize(params = {})
+        @ip_address      = params[:ip_address]
+        @user_agent      = params[:user_agent]
+        @accept_language = params[:accept_language]
+        @session_age     = params[:session_age]
+        @session_id      = params[:session_id]
+      end
+    end
+  end
+end

data/lib/minfraud/components/email.rb

@@ -0,0 +1,21 @@
+module Minfraud
+  module Components
+    class Email < Base
+      # @attribute address
+      # @return [String] This field must be either a valid email address or an MD5 of the email used in the transaction
+      attr_accessor :address
+
+      # @attribute domain
+      # @return [String] The domain of the email address used in the transaction
+      attr_accessor :domain
+
+      # Creates Minfraud::Components::Email instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::Email] an Email instance
+      def initialize(params = {})
+        @address = params[:address]
+        @domain  = params[:domain]
+      end
+    end
+  end
+end

data/lib/minfraud/components/event.rb

@@ -0,0 +1,44 @@
+module Minfraud
+  module Components
+    class Event < Base
+      include ::Minfraud::Enum
+      # @attribute transaction_id
+      # @return [String] Internal ID for the transaction. Used to locate a specific transaction in minFraud logs
+      attr_accessor :transaction_id
+
+      # @attribute shop_id
+      # @return [String] Internal ID for the shop, affiliate, or merchant this order is coming from
+      attr_accessor :shop_id
+
+      # @attribute time
+      # @return [String] The date and time the event occurred. The string must be in the RFC 3339 date-time format.
+      # If this field is not in the request, the current time will be used
+      attr_accessor :time
+
+      # @attribute type
+      # @return [String] The type of event being scored
+      enum_accessor :type,
+        [
+          :account_creation,
+          :account_login,
+          :email_change,
+          :password_reset,
+          :payout_change,
+          :purchase,
+          :recurring_purchase,
+          :referral,
+          :survey,
+        ]
+
+      # Creates Minfraud::Components::Event instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::Event] an Event instance
+      def initialize(params = {})
+        @transaction_id = params[:transaction_id]
+        @shop_id        = params[:shop_id]
+        @time           = params[:time]
+        self.type       = params[:type]
+      end
+    end
+  end
+end