minfraud 1.0.4 → 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

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,7 +44,7 @@ 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
@@ -48,6 +52,9 @@ module Minfraud
     # @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
 
@@ -60,12 +67,14 @@ module Minfraud
       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
 

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

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

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

@@ -17,7 +17,18 @@ module Minfraud
 
       # @attribute type
       # @return [String] The type of event being scored
-      enum_accessor :type, [:account_creation, :account_login, :purchase, :recurring_purchase, :referral, :survey]
+      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

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

data/lib/minfraud/components/report/transaction.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Minfraud
+  module Components
+    module Report
+      # Contains all of the fields which are used in the report transaction API
+      class Transaction < Base
+        include ::Minfraud::Enum
+
+        # @!attribute ip_address
+        # @return [String, nil] The IP address of the customer placing the order. This
+        #   should be passed as a string like "44.55.66.77" or "2001:db8::2:1".
+        attr_accessor :ip_address
+
+        # @!attribute tag
+        # This may be one of +:chargeback+, +:not_fraud+, +:spam_or_abuse+ or +:suspected_fraud+
+        # @return [Symbol, nil] A symbol indicating the likelihood that a transaction
+        #   may be fraudulent.
+        enum_accessor :tag, [:chargeback, :not_fraud, :spam_or_abuse, :suspected_fraud]
+
+        # @attribute chargeback_code
+        # @return [String, nil] A string which is provided by your payment processor
+        #   indicating the reason for the chargeback.
+        attr_accessor :chargeback_code
+
+        # @attribute maxmind_id
+        # @return [String, nil] A unique eight character string identifying a minFraud
+        #   Standard or Premium request. These IDs are returned in the maxmindID
+        #   field of a response for a successful minFraud request. This field is
+        #   not required, but you are encouraged to provide it, if possible.
+        attr_accessor :maxmind_id
+
+        # @attribute minfraud_id
+        # @return [String, nil] A UUID that identifies a minFraud Score, minFraud
+        #   Insights, or minFraud Factors request. This ID is returned at /id in
+        #   the response. This field is not required, but you are encouraged to
+        #   provide it if the request was made to one of these services.
+        attr_accessor :minfraud_id
+
+        # @attribute notes
+        # @return [String, nil] Your notes on the fraud tag associated with the
+        #   transaction. We manually review many reported transactions to improve
+        #   our scoring for you so any additional details to help us understand
+        #   context are helpful.
+        attr_accessor :notes
+
+        # @attribute transaction_id
+        # @return [String, nil] The transaction ID you originally passed to minFraud.
+        #   This field is not required, but you are encouraged to provide it or
+        #   the transaction's maxmind_id or minfraud_id
+        attr_accessor :transaction_id
+
+        # Creates Minfraud::Components::Report::Transaction instance
+        # @param  [Hash] params hash of parameters
+        # @return [Minfraud::Components::Report::Transaction] a Report::Transaction
+        #   instance
+        def initialize(params = {})
+          @ip_address = params[:ip_address]
+          @chargeback_code = params[:chargeback_code]
+          @maxmind_id = params[:maxmind_id]
+          @minfraud_id = params[:minfraud_id]
+          @notes = params[:notes]
+          @transaction_id = params[:transaction_id]
+          self.tag = params[:tag]
+        end
+      end
+    end
+  end
+end

data/lib/minfraud/error_handler.rb

@@ -1,45 +1,65 @@
+# frozen_string_literal: true
+
 module Minfraud
   module ErrorHandler
     class << self
-      # Returns a response if status code is 200, rises an error otherwise
+      # Returns a response if status code is 2xx, raises 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
+      def examine(response)
+        return response if response.status > 199 && response.status < 300
 
         raise *STATUS_CODES.fetch(response.code, [ServerError, 'Server error'])
       end
 
       # A hash that maps status codes returned by minFraud with errors & messages
       STATUS_CODES = {
-        IP_ADDRESS_INVALID:    [
-          ClientError, 'You have no supplied a valid IPv4 or IPv6 address'
+        IP_ADDRESS_INVALID: [
+          ClientError, 'You have not supplied a valid IPv4 or IPv6 address'
         ],
-        IP_ADDRESS_REQUIRED:   [
-          ClientError,  'You have not supplied an IP address which is required filed'
+        IP_ADDRESS_REQUIRED: [
+          ClientError, 'You have not supplied an IP address which is a required field'
         ],
-        IP_ADDRESS_RESERVED:   [
+        IP_ADDRESS_RESERVED: [
           ClientError, 'You have supplied an IP address which is reserved'
         ],
-        JSON_INVALID:          [
+        JSON_INVALID: [
           ClientError, 'JSON body cannot be decoded'
         ],
+        MAXMIND_ID_INVALID: [
+          ClientError, 'You have not supplied a valid maxmind_id'
+        ],
+        MINFRAUD_ID_INVALID: [
+          ClientError, 'You have not supplied a valid minfraud_id'
+        ],
+        PARAMETER_UNKNOWN: [
+          ClientError, 'You have supplied an unknown parameter'
+        ],
+        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:  [
+        LICENSE_KEY_REQUIRED: [
           AuthorizationError, 'You have not supplied a license key'
         ],
-        USER_ID_REQUIRED:      [
-          AuthorizationError, 'You have not supplied a user id'
+        USER_ID_REQUIRED: [
+          AuthorizationError, 'You have not supplied a account id'
         ],
-        INSUFFICIENT_FUNDS:    [
+        INSUFFICIENT_FUNDS: [
           ClientError, 'The license key you have provided does not have a sufficient funds to use this service'
         ],
-        PERMISSION_REQUIRED:   [
+        PERMISSION_REQUIRED: [
           ClientError, 'You do not have permission to use this service'
         ]
-      }
+      }.freeze
     end
   end
 end