minfraud 1.0.3 → 1.4.0

data/lib/minfraud/model/score.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+require 'minfraud/model/disposition'
+require 'minfraud/model/score_ip_address'
+require 'minfraud/model/warning'
+
+module Minfraud
+  module Model
+    # Model of the Score response.
+    class Score < Abstract
+      # An object containing the disposition set by custom rules.
+      #
+      # @return [Minfraud::Model::Disposition]
+      attr_reader :disposition
+
+      # The approximate US dollar value of the funds remaining on your MaxMind
+      # account.
+      #
+      # @return [Float]
+      attr_reader :funds_remaining
+
+      # This is a UUID that identifies the minFraud request. Please use this ID
+      # in bug reports or support requests to MaxMind so that we can easily
+      # identify a particular request.
+      #
+      # @return [String]
+      attr_reader :id
+
+      # An object containing the IP risk for the transaction.
+      #
+      # @return [Minfraud::Model::ScoreIPAddress]
+      attr_reader :ip_address
+
+      # The approximate number of queries remaining for this service before
+      # your account runs out of funds.
+      #
+      # @return [Integer]
+      attr_reader :queries_remaining
+
+      # This property contains the risk score, from 0.01 to 99. A higher score
+      # indicates a higher risk of fraud. For example, a score of 20 indicates
+      # a 20% chance that a transaction is fraudulent. We never return a risk
+      # score of 0, since all transactions have the possibility of being
+      # fraudulent. Likewise we never return a risk score of 100.
+      #
+      # @return [Float]
+      attr_reader :risk_score
+
+      # This array contains objects detailing issues with the request that was
+      # sent, such as invalid or unknown inputs. It is highly recommended that
+      # you check this array for issues when integrating the web service.
+      #
+      # @return [Array<Minfraud::Model::Warning>]
+      attr_reader :warnings
+
+      # @!visibility private
+      def initialize(record, _locales)
+        super(record)
+
+        @disposition       = Minfraud::Model::Disposition.new(get('disposition'))
+        @funds_remaining   = get('funds_remaining')
+        @id                = get('id')
+        @ip_address        = Minfraud::Model::ScoreIPAddress.new(get('ip_address'))
+        @queries_remaining = get('queries_remaining')
+        @risk_score        = get('risk_score')
+        @warnings          = []
+        if record && record.key?('warnings')
+          record['warnings'].each do |w|
+            @warnings << Minfraud::Model::Warning.new(w)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minfraud/model/score_ip_address.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+
+module Minfraud
+  module Model
+    # Model containing the IP address's risk for the Score response.
+    class ScoreIPAddress < Abstract
+      # This field contains the risk associated with the IP address. The value
+      # ranges from 0.01 to 99. A higher score indicates a higher risk.
+      #
+      # @return [Float]
+      attr_reader :risk
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @risk = get('risk')
+      end
+    end
+  end
+end

data/lib/minfraud/model/shipping_address.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/address'
+
+module Minfraud
+  module Model
+    # Model containing information about the shipping address.
+    class ShippingAddress < Address
+      # The distance in kilometers from the shipping address to billing
+      # address.
+      #
+      # @return [Integer, nil]
+      attr_reader :distance_to_billing_address
+
+      # This field is true if the shipping address is an address associated
+      # with fraudulent transactions. The field is false when the address is
+      # not associated with increased risk. The key will only be present when a
+      # shipping address is provided.
+      attr_reader :is_high_risk
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @distance_to_billing_address = get('distance_to_billing_address')
+        @is_high_risk                = get('is_high_risk')
+      end
+    end
+  end
+end

data/lib/minfraud/model/subscores.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+
+module Minfraud
+  module Model
+    # Subscores for components that are used in calculating the riskScore.
+    class Subscores < Abstract
+      # The risk associated with the AVS result. If present, this is a value in
+      # the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :avs_result
+
+      # The risk associated with the billing address. If present, this is a
+      # value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :billing_address
+
+      # The risk associated with the distance between the billing address and
+      # the location for the given IP address. If present, this is a value in
+      # the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :billing_address_distance_to_ip_location
+
+      # The risk associated with the browser attributes such as the User-Agent
+      # and Accept-Language. If present, this is a value in the range 0.01 to
+      # 99.
+      #
+      # @return [Float, nil]
+      attr_reader :browser
+
+      # Individualized risk of chargeback for the given IP address given for
+      # your account and any shop ID passed. This is only available to users
+      # sending chargeback data to MaxMind. If present, this is a value in the
+      # range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :chargeback
+
+      # The risk associated with the country the transaction originated from.
+      # If present, this is a value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :country
+
+      # The risk associated with the combination of IP country, card issuer
+      # country, billing country, and shipping country. If present, this is a
+      # value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :country_mismatch
+
+      # The risk associated with the CVV result. If present, this is a value in
+      # the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :cvv_result
+
+      # The risk associated with the device. If present, this is a value in the
+      # range of 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :device
+
+      # The risk associated with the particular email address. If present, this
+      # is a value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :email_address
+
+      # The general risk associated with the email domain. If present, this is
+      # a value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :email_domain
+
+      # The risk associated with the email address local part (the part of
+      # the email address before the @ symbol). If present, this is a value
+      # in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :email_local_part
+
+      # The risk associated with the issuer ID number on the email domain. If
+      # present, this is a value in the range 0.01 to 99.
+      #
+      # Deprecated effective August 29, 2019. This subscore will default to 1
+      # and will be removed in a future release. The user tenure on email is
+      # reflected in the /subscores/email_address output.
+      #
+      # @return [Float, nil]
+      attr_reader :email_tenure
+
+      # The risk associated with the issuer ID number on the IP address. If
+      # present, this is a value in the range 0.01 to 99.
+      #
+      # Deprecated effective August 29, 2019. This subscore will default to 1
+      # and will be removed in a future release. The IP tenure is reflected in
+      # the overall risk score.
+      #
+      # @return [Float, nil]
+      attr_reader :ip_tenure
+
+      # The risk associated with the particular issuer ID number (IIN) given
+      # the billing location and the history of usage of the IIN on your
+      # account and shop ID. If present, this is a value in the range 0.01 to
+      # 99.
+      #
+      # @return [Float, nil]
+      attr_reader :issuer_id_number
+
+      # The risk associated with the particular order amount for your account
+      # and shop ID. If present, this is a value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :order_amount
+
+      # The risk associated with the particular phone number. If present, this
+      # is a value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :phone_number
+
+      # The risk associated with the shipping address. If present, this is a
+      # value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :shipping_address
+
+      # The risk associated with the distance between the shipping address and
+      # the IP location for the given IP address. If present, this is a value
+      # in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :shipping_address_distance_to_ip_location
+
+      # The risk associated with the local time of day of the transaction in
+      # the IP address location. If present, this is a value in the range 0.01
+      # to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :time_of_day
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @avs_result                               = get('avs_result')
+        @billing_address                          = get('billing_address')
+        @billing_address_distance_to_ip_location  = get(
+          'billing_address_distance_to_ip_location'
+        )
+        @browser                                  = get('browser')
+        @chargeback                               = get('chargeback')
+        @country                                  = get('country')
+        @country_mismatch                         = get('country_mismatch')
+        @cvv_result                               = get('cvv_result')
+        @device                                   = get('device')
+        @email_address                            = get('email_address')
+        @email_domain                             = get('email_domain')
+        @email_local_part                         = get('email_local_part')
+        @email_tenure                             = get('email_tenure')
+        @ip_tenure                                = get('ip_tenure')
+        @issuer_id_number                         = get('issuer_id_number')
+        @order_amount                             = get('order_amount')
+        @phone_number                             = get('phone_number')
+        @shipping_address                         = get('shipping_address')
+        @shipping_address_distance_to_ip_location = get(
+          'shipping_address_distance_to_ip_location'
+        )
+        @time_of_day                              = get('time_of_day')
+      end
+    end
+  end
+end

data/lib/minfraud/model/warning.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+
+module Minfraud
+  module Model
+    # Warning about the minFraud request.
+    #
+    # Although more codes may be added in the future, the current warning codes
+    # are:
+    #
+    # * BILLING_CITY_NOT_FOUND - the billing city could not be found in our
+    #   database.
+    # * BILLING_COUNTRY_MISSING - billing address information was provided
+    #   without providing a billing country.
+    # * BILLING_COUNTRY_NOT_FOUND - the billing country could not be found in
+    #   our database.
+    # * BILLING_POSTAL_NOT_FOUND - the billing postal could not be found in our
+    #   database.
+    # * INPUT_INVALID - the value associated with the key does not meet the
+    #   required constraints, e.g., "United States" in a field that requires a
+    #   two-letter country code.
+    # * INPUT_UNKNOWN - an unknown key was encountered in the request body.
+    # * IP_ADDRESS_NOT_FOUND - the IP address could not be geolocated.
+    # * SHIPPING_COUNTRY_MISSING - shipping address information was provided
+    #   without providing a shipping country.
+    # * SHIPPING_CITY_NOT_FOUND - the shipping city could not be found in our
+    #   database.
+    # * SHIPPING_COUNTRY_NOT_FOUND - the shipping country could not be found in
+    #   our database.
+    # * SHIPPING_POSTAL_NOT_FOUND - the shipping postal could not be found in
+    #   our database.
+    class Warning < Abstract
+      # This value is a machine-readable code identifying the warning.
+      #
+      # @return [String]
+      attr_reader :code
+
+      # This property provides a human-readable explanation of the warning. The
+      # description may change at any time and should not be matched against.
+      #
+      # @return [String]
+      attr_reader :warning
+
+      # A JSON Pointer to the input field that the warning is associated with.
+      # For instance, if the warning was about the billing city, this would be
+      # '/billing/city'. If it was for the price in the second shopping cart
+      # item, it would be '/shopping_cart/1/price'.
+      #
+      # @return [String, nil]
+      attr_reader :input_pointer
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @code          = get('code')
+        @warning       = get('warning')
+        @input_pointer = get('input_pointer')
+      end
+    end
+  end
+end

data/lib/minfraud/report.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Minfraud
+  # Report is used to perform minFraud Report Transaction API requests.
+  #
+  # @see https://dev.maxmind.com/minfraud/report-transaction/
+  class Report
+    include ::Minfraud::HTTPService
+
+    # The Report::Transaction component.
+    #
+    # @return [Minfraud::Components::Report::Transaction, nil]
+    attr_accessor :transaction
+
+    # @param params [Hash] Hash of parameters. The only supported key is
+    #   +:transaction+, which should have a
+    #   +Minfraud::Components::Report::Transaction+ as its value.
+    def initialize(params = {})
+      @transaction = params[:transaction]
+    end
+
+    # Perform a request to the minFraud Report Transaction API.
+    #
+    # @return [nil]
+    #
+    # @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 report_transaction
+      raw = request.perform(
+        verb:     :post,
+        endpoint: 'transactions/report',
+        body:     @transaction.to_json,
+      )
+
+      response = ::Minfraud::HTTPService::Response.new(
+        status:  raw.status.to_i,
+        body:    raw.body,
+        headers: raw.headers
+      )
+
+      ::Minfraud::ErrorHandler.examine(response)
+
+      nil
+    end
+
+    private
+
+    def request
+      @request ||= Request.new(::Minfraud::HTTPService.configuration)
+    end
+  end
+end

data/lib/minfraud/resolver.rb

@@ -1,10 +1,18 @@
+# frozen_string_literal: true
+
 module Minfraud
+  # Resolver provides functionality for setting component attributes.
   module Resolver
     class << self
-      # @param  [Object] context an object for variable assignment
-      # @param  [Hash] params a hash of parameters
-      # @return [Array] a list of supplied params
-      # @note Raises RequestFormatError once unpermitted key is met
+      # Set keys on the context based on the provided parameters.
+      #
+      # @param context [Object] An object for variable assignment.
+      #
+      # @param params [Hash] A hash of parameters.
+      #
+      # @return [Array]
+      #
+      # @raise [Minfraud::RequestFormatError] If an unexpected key is found.
       def assign(context, params)
         Array(params).each do |key, value|
           raise RequestFormatError, "#{key} does not belong to request document format" unless MAPPING[key]
@@ -15,18 +23,19 @@ module Minfraud
       end
     end
 
-    # Mapping between components & minFraud request keys
+    # @!visibility private
     MAPPING = {
-      account:            ::Minfraud::Components::Account,
-      billing:            ::Minfraud::Components::Billing,
-      credit_card:        ::Minfraud::Components::CreditCard,
-      device:             ::Minfraud::Components::Device,
-      email:              ::Minfraud::Components::Email,
-      event:              ::Minfraud::Components::Event,
-      order:              ::Minfraud::Components::Order,
-      payment:            ::Minfraud::Components::Payment,
-      shipping:           ::Minfraud::Components::Shipping,
-      shopping_cart:      ::Minfraud::Components::ShoppingCart
-    }
+      account:       ::Minfraud::Components::Account,
+      billing:       ::Minfraud::Components::Billing,
+      credit_card:   ::Minfraud::Components::CreditCard,
+      custom_inputs: ::Minfraud::Components::CustomInputs,
+      device:        ::Minfraud::Components::Device,
+      email:         ::Minfraud::Components::Email,
+      event:         ::Minfraud::Components::Event,
+      order:         ::Minfraud::Components::Order,
+      payment:       ::Minfraud::Components::Payment,
+      shipping:      ::Minfraud::Components::Shipping,
+      shopping_cart: ::Minfraud::Components::ShoppingCart,
+    }.freeze
   end
 end