minfraud 1.4.0 → 2.0.0

data/lib/minfraud/components/payment.rb

@@ -4,7 +4,7 @@ module Minfraud
   module Components
     # Payment corresponds to the payment object of a minFraud request.
     #
-    # @see https://dev.maxmind.com/minfraud/#Payment_(/payment)
+    # @see https://dev.maxmind.com/minfraud/api-documentation/requests?lang=en#schema--request--payment
     class Payment < Base
       include ::Minfraud::Enum
       include Minfraud::Validates
@@ -15,138 +15,157 @@ module Minfraud
       # @!attribute processor
       #
       # @return [Symbol, nil]
-      enum_accessor :processor, [
-        :adyen,
-        :affirm,
-        :afterpay,
-        :altapay,
-        :amazon_payments,
-        :american_express_payment_gateway,
-        :authorizenet,
-        :balanced,
-        :beanstream,
-        :bluepay,
-        :bluesnap,
-        :bpoint,
-        :braintree,
-        :cardpay,
-        :cashfree,
-        :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_atlantic_commerce,
-        :first_data,
-        :g2a_pay,
-        :global_payments,
-        :gocardless,
-        :heartland,
-        :hipay,
-        :ingenico,
-        :interac,
-        :internetsecure,
-        :intuit_quickbooks_payments,
-        :iugu,
-        :klarna,
-        :komoju,
-        :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,
-        :paytm,
-        :paytrace,
-        :paytrail,
-        :payture,
-        :payu,
-        :payulatam,
-        :payway,
-        :payza,
-        :pinpayments,
-        :posconnect,
-        :princeton_payment_solutions,
-        :psigate,
-        :qiwi,
-        :quickpay,
-        :raberil,
-        :razorpay,
-        :rede,
-        :redpagos,
-        :rewardspay,
-        :sagepay,
-        :securetrading,
-        :simplify_commerce,
-        :skrill,
-        :smartcoin,
-        :smartdebit,
-        :solidtrust_pay,
-        :sps_decidir,
-        :stripe,
-        :synapsefi,
-        :systempay,
-        :telerecargas,
-        :towah,
-        :transact_pro,
-        :tsys,
-        :usa_epay,
-        :vantiv,
-        :verepay,
-        :vericheck,
-        :vindicia,
-        :virtual_card_services,
-        :vme,
-        :vpos,
-        :wirecard,
-        :worldpay
+      enum_accessor :processor, %i[
+        adyen
+        affirm
+        afterpay
+        altapay
+        amazon_payments
+        american_express_payment_gateway
+        apple_pay
+        aps_payments
+        authorizenet
+        balanced
+        beanstream
+        bluepay
+        bluesnap
+        boacompra
+        boku
+        bpoint
+        braintree
+        cardknox
+        cardpay
+        cashfree
+        ccavenue
+        ccnow
+        cetelem
+        chase_paymentech
+        checkout_com
+        cielo
+        collector
+        commdoo
+        compropago
+        concept_payments
+        conekta
+        coregateway
+        creditguard
+        credorax
+        ct_payments
+        cuentadigital
+        curopayments
+        cybersource
+        dalenys
+        dalpay
+        datacap
+        datacash
+        dibs
+        digital_river
+        dlocal
+        dotpay
+        ebs
+        ecomm365
+        ecommpay
+        elavon
+        emerchantpay
+        epay
+        eprocessing_network
+        epx
+        eway
+        exact
+        first_atlantic_commerce
+        first_data
+        fiserv
+        g2a_pay
+        global_payments
+        gocardless
+        heartland
+        hipay
+        ingenico
+        interac
+        internetsecure
+        intuit_quickbooks_payments
+        iugu
+        klarna
+        komoju
+        lemon_way
+        mastercard_payment_gateway
+        mercadopago
+        mercanet
+        merchant_esolutions
+        mirjeh
+        mollie
+        moneris_solutions
+        neopay
+        neosurf
+        nmi
+        oceanpayment
+        oney
+        onpay
+        openbucks
+        openpaymx
+        optimal_payments
+        orangepay
+        other
+        pacnet_services
+        payeezy
+        payfast
+        paygate
+        paylike
+        payment_express
+        paymentwall
+        payone
+        paypal
+        payplus
+        paysafecard
+        paysera
+        paystation
+        paytm
+        paytrace
+        paytrail
+        payture
+        payu
+        payulatam
+        payvision
+        payway
+        payza
+        pinpayments
+        posconnect
+        princeton_payment_solutions
+        psigate
+        qiwi
+        quickpay
+        raberil
+        razorpay
+        rede
+        redpagos
+        rewardspay
+        safecharge
+        sagepay
+        securetrading
+        simplify_commerce
+        skrill
+        smartcoin
+        smartdebit
+        solidtrust_pay
+        sps_decidir
+        stripe
+        synapsefi
+        systempay
+        telerecargas
+        towah
+        transact_pro
+        trustly
+        tsys
+        usa_epay
+        vantiv
+        verepay
+        vericheck
+        vindicia
+        virtual_card_services
+        vme
+        vpos
+        wirecard
+        worldpay
       ]
 
       # The authorization outcome from the payment processor. If the

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

@@ -5,7 +5,7 @@ module Minfraud
     module Report
       # Contains the fields used in the Report Transaction API.
       #
-      # @see https://dev.maxmind.com/minfraud/report-transaction/
+      # @see https://dev.maxmind.com/minfraud/report-a-transaction?lang=en
       class Transaction < Base
         include ::Minfraud::Enum
 
@@ -24,7 +24,7 @@ module Minfraud
         # @!attribute tag
         #
         # @return [Symbol, nil]
-        enum_accessor :tag, [:chargeback, :not_fraud, :spam_or_abuse, :suspected_fraud]
+        enum_accessor :tag, %i[chargeback not_fraud spam_or_abuse suspected_fraud]
 
         # A string which is provided by your payment processor indicating the
         # reason for the chargeback.

data/lib/minfraud/components/shipping.rb

@@ -4,7 +4,7 @@ module Minfraud
   module Components
     # Shipping corresponds to the shipping object of a minFraud request.
     #
-    # @see https://dev.maxmind.com/minfraud/#Shipping_(/shipping)
+    # @see https://dev.maxmind.com/minfraud/api-documentation/requests?lang=en#schema--request--shipping
     class Shipping < Addressable
       include ::Minfraud::Enum
 
@@ -14,7 +14,7 @@ module Minfraud
       # @!attribute delivery_speed
       #
       # @return [Symbol, nil]
-      enum_accessor :delivery_speed, [:same_day, :overnight, :expedited, :standard]
+      enum_accessor :delivery_speed, %i[same_day overnight expedited standard]
 
       # @param params [Hash] Hash of parameters. Each key/value should
       #   correspond to one of the available attributes.

data/lib/minfraud/components/shopping_cart.rb

@@ -5,7 +5,7 @@ module Minfraud
     # ShoppingCart corresponds to the shopping_cart object of a minFraud
     # request.
     #
-    # @see https://dev.maxmind.com/minfraud/#Shopping_Cart_(/shoppingcart)
+    # @see https://dev.maxmind.com/minfraud/api-documentation/requests?lang=en#schema--request--shopping-cart
     class ShoppingCart < Base
       # An array of Minfraud::Components::ShoppingCartItem instances.
       #
@@ -13,7 +13,7 @@ module Minfraud
       attr_accessor :items
 
       # @param params [Array] Array of shopping cart items. You may provide
-      #   each item as either as Hash where each key is a symbol corresponding
+      #   each item as either a Hash where each key is a symbol corresponding
       #   to an item's field, or as a Minfraud:::Components::ShoppingCartItem
       #   object.
       def initialize(params = [])

data/lib/minfraud/components/shopping_cart_item.rb

@@ -5,20 +5,20 @@ module Minfraud
     # ShoppingCartItem corresponds to objects in the shopping_cart object
     # of a minFraud request.
     #
-    # @see https://dev.maxmind.com/minfraud/#Shopping_Cart_Item
+    # @see https://dev.maxmind.com/minfraud/api-documentation/requests?lang=en#schema--request--shopping-cart--item
     class ShoppingCartItem < Base
       include Minfraud::Validates
 
       # The category of the item. This can also be a hashed value; see link.
       #
-      # @see https://dev.maxmind.com/minfraud/#cart-hashing
+      # @see https://dev.maxmind.com/minfraud/api-documentation/requests?lang=en#schema--request--shopping-cart--item__category
       #
       # @return [String, nil]
       attr_accessor :category
 
       # The internal ID of the item. This can also be a hashed value; see link.
       #
-      # @see https://dev.maxmind.com/minfraud/#cart-hashing
+      # @see https://dev.maxmind.com/minfraud/api-documentation/requests?lang=en#schema--request--shopping-cart--item__item_id
       #
       # @return [String, nil]
       attr_accessor :item_id

data/lib/minfraud/http_service/response.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'minfraud/model/error'
 require 'minfraud/model/factors'
 require 'minfraud/model/insights'
@@ -9,32 +10,35 @@ module Minfraud
   module HTTPService
     # Response class for HTTP requests.
     class Response
-      # HTTP response status.
+      # Response HTTP status code.
       #
-      # @return [Integer, nil]
+      # @return [Fixnum, nil]
       attr_reader :status
 
-      # HTTP response model.
+      # Response model.
       #
       # @return [Minfraud::Model::Score, Minfraud::Model::Insights,
       #   Minfraud::Model::Factors, nil]
       attr_reader :body
 
-      # HTTP response headers.
+      # @param endpoint [Symbol, nil] endpoint name, like :score.
       #
-      # @return [Hash, nil]
-      attr_reader :headers
+      # @param locales [Array<String>, nil] locales, like ["en"].
+      #
+      # @param response [HTTP::Response] the response object.
+      #
+      # @param body [String] the response body.
+      #
+      # @raise [JSON::ParserError] if there was invalid JSON in the response.
+      def initialize(endpoint, locales, response, body)
+        @status = response.code
 
-      # @param params [Hash] Hash of parameters. +:status+, +:endpoint+,
-      #   +:body+, +:locales+, and +:headers+ are used.
-      def initialize(params = {})
-        @status  = params[:status]
-        @body    = make_body(
-          params[:endpoint],
-          params[:body],
-          params[:locales]
+        @body = make_body(
+          endpoint,
+          locales,
+          response,
+          body,
         )
-        @headers = params[:headers]
       end
 
       # Return the minFraud-specific response code.
@@ -48,15 +52,18 @@ module Minfraud
 
       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)
+      def make_body(endpoint, locales, response, body)
+        if !response.mime_type || !response.mime_type.match(/json/i)
+          return nil
+        end
+
+        h = JSON.parse(body)
 
-          return Minfraud::Model::Error.new(body)
+        if @status != 200
+          return Minfraud::Model::Error.new(h)
         end
 
-        ENDPOINT_TO_CLASS[endpoint].new(body, locales)
+        ENDPOINT_TO_CLASS[endpoint].new(h, locales)
       end
 
       ENDPOINT_TO_CLASS = {

data/lib/minfraud/model/device.rb

@@ -8,7 +8,7 @@ module Minfraud
     #
     # In order to receive device output from minFraud Insights or minFraud
     # Factors, you must be using the Device Tracking Add-on
-    # (https://dev.maxmind.com/minfraud/device/).
+    # (https://dev.maxmind.com/minfraud/track-devices?lang=en).
     class Device < Abstract
       # This number represents our confidence that the device_id refers to a
       # unique device as opposed to a cluster of similar devices. A confidence

data/lib/minfraud/model/disposition.rb

@@ -10,25 +10,32 @@ module Minfraud
     # rules.
     class Disposition < Abstract
       # The action to take on the transaction as defined by your custom rules.
-      # The current set of values are "accept", "manual_review", and "reject".
-      # If you do not have custom rules set up, this will be nil.
+      # The current set of values are "accept", "manual_review", "reject", and
+      # "test". If you do not have custom rules set up, this will be nil.
       #
       # @return [String, nil]
       attr_reader :action
 
       # The reason for the action. The current possible values are
-      # "custom_rule", "block_list", and "default". If you do not have custom
-      # rules set up, this will be nil.
+      # "custom_rule" and "default". If you do not have custom rules set up,
+      # this will be nil.
       #
       # @return [String, nil]
       attr_reader :reason
 
+      # The label of the custom rule that was triggered. If you do not have
+      # custom rules set up, the triggered custom rule does not have a label,
+      # or no custom rule was triggered, this will be nil.
+      # @return [String, nil]
+      attr_reader :rule_label
+
       # @!visibility private
       def initialize(record)
         super(record)
 
-        @action = get('action')
-        @reason = get('reason')
+        @action     = get('action')
+        @reason     = get('reason')
+        @rule_label = get('rule_label')
       end
     end
   end

data/lib/minfraud/model/ip_address.rb

@@ -2,6 +2,7 @@
 
 require 'maxmind/geoip2/model/insights'
 require 'minfraud/model/geoip2_location'
+require 'minfraud/model/ip_risk_reason'
 
 module Minfraud
   module Model
@@ -13,9 +14,20 @@ module Minfraud
       # @return [Float]
       attr_reader :risk
 
+      # This field contains IPRiskReason objects identifying the reasons why
+      # the IP address received the associated risk. This will be an empty
+      # array if there are no reasons.
+      #
+      # @return [Array<Minfraud::Model::IPRiskReason>]
+      attr_reader :risk_reasons
+
       # @!visibility private
       def initialize(record, locales)
-        super(record, locales)
+        if record
+          super(record, locales)
+        else
+          super({}, locales)
+        end
 
         if record
           @location = Minfraud::Model::GeoIP2Location.new(record.fetch('location', nil))
@@ -28,55 +40,19 @@ module Minfraud
           @risk = nil
         end
 
-        # Decorate objects with deprecated attributes and names for backwards
-        # compatibility. Do this here rather than with the overhead of
-        # subclasses/modules for them in the hope that one day we can delete
-        # them.
-
-        # These are named differently in maxmind-geoip2.
-        @country.define_singleton_method(:is_in_european_union) { in_european_union? }
-        @registered_country.define_singleton_method(:is_in_european_union) { in_european_union? }
-        @represented_country.define_singleton_method(:is_in_european_union) { in_european_union? }
-        @traits.define_singleton_method(:is_anonymous) { anonymous? }
-        @traits.define_singleton_method(:is_anonymous_vpn) { anonymous_vpn? }
-        @traits.define_singleton_method(:is_hosting_provider) { hosting_provider? }
-        @traits.define_singleton_method(:is_public_proxy) { public_proxy? }
-        @traits.define_singleton_method(:is_tor_exit_node) { tor_exit_node? }
-
-        # Mashify turned each language code into an attribute, but
-        # maxmind-geoip2 exposes the names as a hash.
-        LANGUAGE_CODES.each do |c|
-          if @city.names
-            @city.names.define_singleton_method(c) { fetch(c.to_s, nil) }
-          end
-          if @continent.names
-            @continent.names.define_singleton_method(c) { fetch(c.to_s, nil) }
-          end
-          if @country.names
-            @country.names.define_singleton_method(c) { fetch(c.to_s, nil) }
-          end
-          if @registered_country.names
-            @registered_country.names.define_singleton_method(c) { fetch(c.to_s, nil) }
-          end
-          if @represented_country.names
-            @represented_country.names.define_singleton_method(c) { fetch(c.to_s, nil) }
-          end
-          @subdivisions.each do |s|
-            if s.names
-              s.names.define_singleton_method(c) { fetch(c.to_s, nil) }
-            end
+        @risk_reasons = []
+        if record&.key?('risk_reasons')
+          record['risk_reasons'].each do |r|
+            @risk_reasons << Minfraud::Model::IPRiskReason.new(r)
           end
         end
 
-        # This attribute is deprecated.
-        @country.define_singleton_method(:is_high_risk) { get('is_high_risk') }
-
-        # These attributes are deprecated and aren't in maxmind-geoip2.
+        # These attributes are deprecated and aren't in maxmind-geoip2. The
+        # webservice still sends them as of writing, so we'd like to keep them
+        # for now as they could still be providing value.
         @traits.define_singleton_method(:is_anonymous_proxy) { get('is_anonymous_proxy') }
         @traits.define_singleton_method(:is_satellite_provider) { get('is_satellite_provider') }
       end
-
-      LANGUAGE_CODES = [:de, :en, :es, :fr, :ja, :'pt-BR', :ru, :'zh-CN'].freeze
     end
   end
 end

data/lib/minfraud/model/ip_risk_reason.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+
+module Minfraud
+  module Model
+    # Reason for the IP risk.
+    #
+    # This class provides both a machine-readable code and a human-readable
+    # explanation of the reason for the IP risk score.
+    #
+    # Although more codes may be added in the future, the current codes are:
+    #
+    # * ANONYMOUS_IP - The IP address belongs to an anonymous network. See the
+    #   object at ip_address.traits for more details.
+    # * BILLING_POSTAL_VELOCITY - Many different billing postal codes have been
+    #   seen on this IP address.
+    # * EMAIL_VELOCITY - Many different email addresses have been seen on this
+    #   IP address.
+    # * HIGH_RISK_DEVICE - A high risk device was seen on this IP address.
+    # * HIGH_RISK_EMAIL - A high risk email address was seen on this IP address
+    #   in your past transactions.
+    # * ISSUER_ID_NUMBER_VELOCITY - Many different issuer ID numbers have been
+    #   seen on this IP address.
+    # * MINFRAUD_NETWORK_ACTIVITY - Suspicious activity has been seen on this
+    #   IP address across minFraud customers.
+    class IPRiskReason < Abstract
+      # This value is a machine-readable code identifying the reason.
+      #
+      # @return [String, nil]
+      attr_reader :code
+
+      # This field provides a human-readable explanation of the reason. The
+      # text may change at any time and should not be matched against.
+      #
+      # @return [String, nil]
+      attr_reader :reason
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @code   = get('code')
+        @reason = get('reason')
+      end
+    end
+  end
+end

data/lib/minfraud/model/score.rb

@@ -65,7 +65,7 @@ module Minfraud
         @queries_remaining = get('queries_remaining')
         @risk_score        = get('risk_score')
         @warnings          = []
-        if record && record.key?('warnings')
+        if record&.key?('warnings')
           record['warnings'].each do |w|
             @warnings << Minfraud::Model::Warning.new(w)
           end