minfraud 1.0.0 → 1.1.0

data/lib/minfraud.rb

@@ -5,15 +5,16 @@ 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/shopping_cart_item'
+require 'minfraud/components/report/transaction'
 require 'minfraud/components/shipping'
 require 'minfraud/components/shopping_cart'
-require 'minfraud/components/device'
+require 'minfraud/components/shopping_cart_item'
 require 'minfraud/resolver'
 require 'minfraud/version'
 require 'minfraud/errors'
@@ -22,11 +23,12 @@ 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 username that is used for authorization
+    # @return [String] MaxMind account ID that is used for authorization
     attr_accessor :user_id
 
     # @!attribute license_key
@@ -38,7 +40,7 @@ module Minfraud
       yield self
     end
 
-    # @return [Hash] with the current configuration
+    # @return [Hash] current Minfraud configuration
     def configuration
       {
         user_id:     @user_id,

data/lib/minfraud/assessments.rb

@@ -15,6 +15,10 @@ module Minfraud
     # @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
@@ -40,37 +44,52 @@ module Minfraud
     attr_accessor :shipping
 
     # @!attribute shopping_cart
-    # @return [Minfraud::Components::ShoppingCarat] ShoppingCart component
+    # @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)
-      resolver.assign(context: self, params: params)
+      @locales = params.delete('locales')
+      @locales = ['en'] if @locales.nil?
+
+      resolver.assign(self, params)
     end
 
-    # These methods correspond to the minFraud API endpoints and require the same set of params
-    # Raises an error in case of invalid response
-    # @return [Minfraud::HTTPService::Response] Wrapped minFraud response
-    %w(score insights factors).each do |endpoint|
-      define_method endpoint do
-        raw       = request.perform(verb: :post, endpoint: endpoint, body: request_body)
+    # @!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(
-          status:  raw.status.to_i,
-          body:    raw.body,
-          headers: raw.headers
+          endpoint: endpoint,
+          locales:  @locales,
+          status:   raw.status.to_i,
+          body:     raw.body,
+          headers:  raw.headers
         )
 
-        ::Minfraud::ErrorHandler.inspect(response)
+        ::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({}) { |mem, e| mem.merge!(e.to_s => send(e)&.to_json) }
+      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

data/lib/minfraud/components/account.rb

@@ -4,7 +4,7 @@ module Minfraud
       # @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
+      # 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
@@ -13,7 +13,7 @@ module Minfraud
 
       # Creates Minfraud::Components::Account instance
       # @param  [Hash] params hash of parameters
-      # @return [Minfraud::Components::Account] a Account instance
+      # @return [Minfraud::Components::Account] an Account instance
       def initialize(params = {})
         @user_id      = params[:user_id]
         @username_md5 = params[:username_md5]

data/lib/minfraud/components/addressable.rb

@@ -22,7 +22,7 @@ module Minfraud
       attr_accessor :address_2
 
       # @attribute city
-      # @return [String] The city of the user’s billing / shipping address
+      # @return [String] The city of the user's billing / shipping address
       attr_accessor :city
 
       # @attribute region
@@ -46,7 +46,7 @@ module Minfraud
       attr_accessor :phone_country_code
 
       # Creates Minfraud::Components::Addressable instance
-      # This class is used as a parent class for Billing and Shipping components
+      # @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 = {})

data/lib/minfraud/components/base.rb

@@ -1,13 +1,35 @@
 module Minfraud
   module Components
-    # Note: This class is used as a parent class for all other components
-    # It defines a method which is used for basic JSON representation of PORO objects
+    # @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| mem.merge!(e.to_s.gsub(/@/, '') => instance_variable_get(e).to_s) }
-          .delete_if { |_, v| v.empty? }
+        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/credit_card.rb

@@ -18,10 +18,14 @@ module Minfraud
       # @return [String] The phone country code for the issuing bank as provided by the end user
       attr_accessor :bank_phone_country_code
 
-      # @attribute phone_phone_number
+      # @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
@@ -41,6 +45,7 @@ module Minfraud
         @bank_phone_number       = params[:bank_phone_number]
         @avs_result              = params[:avs_result]
         @cvv_result              = params[:cvv_result]
+        @token                   = params[:token]
       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

@@ -14,6 +14,15 @@ module Minfraud
       # @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
@@ -21,6 +30,8 @@ module Minfraud
         @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

data/lib/minfraud/components/event.rb

@@ -16,14 +16,19 @@ module Minfraud
       attr_accessor :time
 
       # @attribute type
-      # @return [String] The type of event being scored. The valid types are:
-      #   => account_creation
-      #   => account_login
-      #   => purchase
-      #   => recurring_purchase
-      #   => referral
-      #   => survey
-      enum_accessor :type, [:account_creation, :account_login, :purchase, :recurring_purchase, :referral, :survey]
+      # @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
@@ -32,7 +37,7 @@ module Minfraud
         @transaction_id = params[:transaction_id]
         @shop_id        = params[:shop_id]
         @time           = params[:time]
-        @type           = params[:type]
+        self.type       = params[:type]
       end
     end
   end

data/lib/minfraud/components/order.rb

@@ -38,6 +38,7 @@ module Minfraud
       # @param  [Hash] params hash of parameters
       # @return [Minfraud::Components::Order] an Order instance
       def initialize (params = {})
+        @amount           = params[:amount]
         @has_gift_message = params[:has_gift_message]
         @affiliate_id     = params[:affiliate_id]
         @subaffiliate_id  = params[:subaffiliate_id]

data/lib/minfraud/components/payment.rb

@@ -5,18 +5,130 @@ module Minfraud
       # @attribute processor
       # @return [String] The payment processor used for the transaction
       enum_accessor :processor, [
-        :adyen, :altapay, :amazon_payments, :authorizenet, :balanced, :beanstream,
-        :bluepay, :braintree, :ccnow, :chase_paymentech, :cielo, :collector, :compropago,
-        :concept_payments, :conekta, :cuentadigital, :dalpay, :dibs, :digital_river, :ecomm365,
-        :elavon, :epay, :eprocessing_network, :eway, :first_data, :global_payments, :ingenico,
-        :internetsecure, :intuit_quickbooks_payments, :iugu, :mastercard_payment_gateway,
-        :mercadopago, :merchant_esolutions, :mirjeh, :mollie, :moneris_solutions, :nmi,
-        :openpaymx, :optimal_payments, :orangepay, :other, :pacnet_services, :payfast,
-        :paygate, :payone, :paypal, :payplus, :paystation, :paytrace, :paytrail, :payture,
-        :payu, :payulatam, :pinpayments, :princeton_payment_solutions, :psigate, :qiwi,
-        :quickpay, :raberil, :rede, :redpagos, :rewardspay, :sagepay, :simplify_commerce,
-        :skrill, :smartcoin, :sps_decidir, :stripe, :telerecargas, :towah, :usa_epay,
-        :verepay, :vindicia, :virtual_card_services, :vme, :worldpay
+        :adyen,
+        :affirm,
+        :afterpay,
+        :altapay,
+        :amazon_payments,
+        :american_express_payment_gateway,
+        :authorizenet,
+        :balanced,
+        :beanstream,
+        :bluepay,
+        :bluesnap,
+        :bpoint,
+        :braintree,
+        :cardpay,
+        :ccavenue,
+        :ccnow,
+        :cetelem,
+        :chase_paymentech,
+        :checkout_com,
+        :cielo,
+        :collector,
+        :commdoo,
+        :compropago,
+        :concept_payments,
+        :conekta,
+        :ct_payments,
+        :cuentadigital,
+        :curopayments,
+        :cybersource,
+        :dalenys,
+        :dalpay,
+        :datacash,
+        :dibs,
+        :digital_river,
+        :dotpay,
+        :ebs,
+        :ecomm365,
+        :ecommpay,
+        :elavon,
+        :emerchantpay,
+        :epay,
+        :eprocessing_network,
+        :epx,
+        :eway,
+        :exact,
+        :first_data,
+        :g2a_pay,
+        :global_payments,
+        :gocardless,
+        :heartland,
+        :hipay,
+        :ingenico,
+        :interac,
+        :internetsecure,
+        :intuit_quickbooks_payments,
+        :iugu,
+        :klarna,
+        :lemon_way,
+        :mastercard_payment_gateway,
+        :mercadopago,
+        :mercanet,
+        :merchant_esolutions,
+        :mirjeh,
+        :mollie,
+        :moneris_solutions,
+        :nmi,
+        :oceanpayment,
+        :oney,
+        :openpaymx,
+        :optimal_payments,
+        :orangepay,
+        :other,
+        :pacnet_services,
+        :payeezy,
+        :payfast,
+        :paygate,
+        :paylike,
+        :payment_express,
+        :paymentwall,
+        :payone,
+        :paypal,
+        :payplus,
+        :paysafecard,
+        :paystation,
+        :paytrace,
+        :paytrail,
+        :payture,
+        :payu,
+        :payulatam,
+        :payway,
+        :payza,
+        :pinpayments,
+        :posconnect,
+        :princeton_payment_solutions,
+        :psigate,
+        :qiwi,
+        :quickpay,
+        :raberil,
+        :rede,
+        :redpagos,
+        :rewardspay,
+        :sagepay,
+        :securetrading,
+        :simplify_commerce,
+        :skrill,
+        :smartcoin,
+        :smartdebit,
+        :solidtrust_pay,
+        :sps_decidir,
+        :stripe,
+        :synapsefi,
+        :telerecargas,
+        :towah,
+        :transact_pro,
+        :usa_epay,
+        :vantiv,
+        :verepay,
+        :vericheck,
+        :vindicia,
+        :virtual_card_services,
+        :vme,
+        :vpos,
+        :wirecard,
+        :worldpay
       ]
 
       # @attribute was_authorized
@@ -33,7 +145,7 @@ module Minfraud
       def initialize(params = {})
         @was_authorized = params[:was_authorized]
         @decline_code   = params[:decline_code]
-        @processor      = params[:processor]
+        self.processor  = params[:processor]
       end
     end
   end