minfraud 1.0.1 → 1.2.0

data/lib/minfraud/components/billing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
     class Billing < Addressable; end

data/lib/minfraud/components/credit_card.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
     class CreditCard < Base
@@ -18,10 +20,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 +47,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,16 @@
+# frozen_string_literal: true
+
+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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
     class Device < Base
@@ -14,6 +16,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 +32,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/email.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
     class Email < Base

data/lib/minfraud/components/event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
     class Event < Base
@@ -16,14 +18,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

data/lib/minfraud/components/order.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
     class Order < Base
@@ -37,7 +39,8 @@ module Minfraud
       # Creates Minfraud::Components::Order instance
       # @param  [Hash] params hash of parameters
       # @return [Minfraud::Components::Order] an Order instance
-      def initialize (params = {})
+      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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
     class Payment < Base
@@ -5,26 +7,148 @@ 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,
+        :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,
+        :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
+      # @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
+      # @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

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

@@ -1,13 +1,11 @@
+# frozen_string_literal: true
+
 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:
-      #    => same_day
-      #    => overnight
-      #    => expedited
-      #    => standard
       enum_accessor :delivery_speed, [:same_day, :overnight, :expedited, :standard]
 
       # Creates Minfraud::Components::Shipping instance

data/lib/minfraud/components/shopping_cart.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
     class ShoppingCart < Base
@@ -5,6 +7,7 @@ module Minfraud
       # @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
@@ -13,7 +16,7 @@ module Minfraud
       end
 
       # @return [Array] a JSON representation of Minfraud::Components::ShoppingCart items
-      def to_json
+      def to_json(*_args)
         @items.map(&:to_json)
       end
 

data/lib/minfraud/components/shopping_cart_item.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
     class ShoppingCartItem < Base
@@ -29,5 +31,3 @@ module Minfraud
     end
   end
 end
-
-

data/lib/minfraud/enum.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Enum
     def self.included(base)
@@ -21,11 +23,12 @@ module Minfraud
           define_method("#{attribute}_values") { mapping[attribute] }
         end
 
-        self.class_eval do
-          define_method("#{attribute}") { instance_variable_get("@#{attribute}") }
+        class_eval do
+          define_method(attribute.to_s) { 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&.intern)
+            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