minfraud 1.1.0

data/lib/minfraud/components/order.rb

@@ -0,0 +1,52 @@
+module Minfraud
+  module Components
+    class Order < Base
+      # @attribute amount
+      # @return [Decimal] The total order amount for the transaction
+      attr_accessor :amount
+
+      # @attribute currency
+      # @return [String] The ISO 4217 currency code for the currency used in the transaction
+      attr_accessor :currency
+
+      # @attribute discount_code
+      # @return [String] The discount code applied to the transaction. If multiple discount codes are used,
+      # please separate them with a comma.
+      attr_accessor :discount_code
+
+      # @attribute affiliate_id
+      # @return [String] The ID of the affiliate where the order is coming from
+      attr_accessor :affiliate_id
+
+      # @attribute subaffiliate_id
+      # @return [String] The ID of the sub-affiliate where the order is coming from
+      attr_accessor :subaffiliate_id
+
+      # @attribute :referrer_uri
+      # @return [String] The URI of the referring site for this order
+      attr_accessor :referrer_uri
+
+      # @attribute :is_gift
+      # @return [Boolean] Whether order was marked as a gift by the purchaser
+      attr_accessor :is_gift
+
+      # @attribute :has_gift_message
+      # @return [Boolean] Whether the purchaser included a gift message
+      attr_accessor :has_gift_message
+
+      # Creates Minfraud::Components::Order instance
+      # @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]
+        @currency         = params[:currency]
+        @discount_code    = params[:discount_cide]
+        @referrer_uri     = params[:referrer_uri]
+        @is_gift          = params[:is_gift]
+      end
+    end
+  end
+end

data/lib/minfraud/components/payment.rb

@@ -0,0 +1,152 @@
+module Minfraud
+  module Components
+    class Payment < Base
+      include ::Minfraud::Enum
+      # @attribute processor
+      # @return [String] The payment processor used for the transaction
+      enum_accessor :processor, [
+        :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
+      # @return [Boolean] The authorization outcome from the payment processor. If the transaction has not yet been approved or denied, do not include this field
+      attr_accessor :was_authorized
+
+      # @attribute decline_code
+      # @return [String] The decline code as provided by your payment processor. If the transaction was not declined, do not include this field
+      attr_accessor :decline_code
+
+      # Creates Minfraud::Components::Payment instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::Payment] Payment instance
+      def initialize(params = {})
+        @was_authorized = params[:was_authorized]
+        @decline_code   = params[:decline_code]
+        self.processor  = params[:processor]
+      end
+    end
+  end
+end

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/components/shipping.rb

@@ -0,0 +1,18 @@
+module Minfraud
+  module Components
+    class Shipping < Addressable
+      include ::Minfraud::Enum
+      # @attribute delivery_speed
+      # @return [String] The shipping delivery speed for the order. The valid values are:
+      enum_accessor :delivery_speed, [:same_day, :overnight, :expedited, :standard]
+
+      # Creates Minfraud::Components::Shipping instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::Shipping] Shipping instance
+      def initialize(params = {})
+        self.delivery_speed = params[:delivery_speed]
+        super
+      end
+    end
+  end
+end

data/lib/minfraud/components/shopping_cart.rb

@@ -0,0 +1,30 @@
+module Minfraud
+  module Components
+    class ShoppingCart < Base
+      # @attribute items
+      # @return [Array] An array of Minfraud::Components::ShoppingCartItem instances
+
+      attr_accessor :items
+      # Creates Minfraud::Components::ShoppingCart instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::ShoppingCart] ShoppingCart instance
+      def initialize(params = {})
+        @items = params.map(&method(:resolve))
+      end
+
+      # @return [Array] a JSON representation of Minfraud::Components::ShoppingCart items
+      def to_json
+        @items.map(&:to_json)
+      end
+
+      private
+
+      # @param  [Hash] params hash of parameters for Minfraud::Components::ShoppingCartItem
+      # or Minfraud::Components::ShoppingCartItem instance
+      # @return [Minfraud::Components::ShoppingCart] ShoppingCart instance
+      def resolve(params)
+        params.is_a?(ShoppingCartItem) ? params : ShoppingCartItem.new(params)
+      end
+    end
+  end
+end

data/lib/minfraud/components/shopping_cart_item.rb

@@ -0,0 +1,33 @@
+module Minfraud
+  module Components
+    class ShoppingCartItem < Base
+      # @attribute category
+      # @return [String] The category of the item
+      attr_accessor :category
+
+      # @attribute item_id
+      # @return [String] The internal ID of the item
+      attr_accessor :item_id
+
+      # @attribute quantity
+      # @return [Integer] The quantity of the item in the shopping cart
+      attr_accessor :quantity
+
+      # @attribute price
+      # @return [Float] The per-unit price of this item in the shopping cart. This should use the same currency as the order currency
+      attr_accessor :price
+
+      # Creates Minfraud::Components::ShoppingCartItem instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::ShoppingCartItem] ShoppingCartItem instance
+      def initialize(params = {})
+        @category = params[:category]
+        @item_id  = params[:item_id]
+        @quantity = params[:quantity]
+        @price    = params[:price]
+      end
+    end
+  end
+end
+
+

data/lib/minfraud/enum.rb

@@ -0,0 +1,34 @@
+module Minfraud
+  module Enum
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Returns a hash with in the following format: attribute_name => permitted_values
+      # @return [Hash] mapping
+      def mapping
+        @mapping ||= {}
+      end
+
+      # Creates a set of methods for enum-like behaviour of the attribute
+      # @param [Symbol] attribute attribute name
+      # @param [Array] assignable_values a set of values which are permitted
+      def enum_accessor(attribute, assignable_values)
+        mapping[attribute] = assignable_values.map(&:intern)
+
+        self.class.instance_eval do
+          define_method("#{attribute}_values") { mapping[attribute] }
+        end
+
+        self.class_eval do
+          define_method("#{attribute}") { instance_variable_get("@#{attribute}") }
+          define_method "#{attribute}=" do |value|
+            raise NotEnumValueError,  'Value is not permitted' if value && !self.class.mapping[attribute].include?(value.intern)
+            instance_variable_set("@#{attribute}", value ? value.intern : nil)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minfraud/error_handler.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Minfraud
+  module ErrorHandler
+    class << self
+      # 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 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 not supplied a valid IPv4 or IPv6 address'
+        ],
+        IP_ADDRESS_REQUIRED: [
+          ClientError, 'You have not supplied an IP address which is a required field'
+        ],
+        IP_ADDRESS_RESERVED: [
+          ClientError, 'You have supplied an IP address which is reserved'
+        ],
+        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 account ID'
+        ],
+        LICENSE_KEY_REQUIRED: [
+          AuthorizationError, 'You have not supplied a license key'
+        ],
+        USER_ID_REQUIRED: [
+          AuthorizationError, 'You have not supplied a account id'
+        ],
+        INSUFFICIENT_FUNDS: [
+          ClientError, 'The license key you have provided does not have a sufficient funds to use this service'
+        ],
+        PERMISSION_REQUIRED: [
+          ClientError, 'You do not have permission to use this service'
+        ]
+      }.freeze
+    end
+  end
+end