minfraud 1.0.3 → 1.4.0

data/lib/minfraud/components/base.rb

@@ -1,23 +1,47 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
-    # @note This class is used as a parent class for all other components
-    # @note It defines a method which is used for basic JSON representation of PORO objects
+    # This is a parent class for all components. It defines a method which is
+    # used for basic JSON representation of the component objects.
     class Base
-      # @return [Hash] a JSON representation of component attributes
-      def to_json
-        instance_variables.inject({}) { |mem, e| populate!(mem, e) }
+      # A JSON representation of component attributes.
+      #
+      # @return [Hash]
+      def to_json(*_args)
+        instance_variables.reduce({}) { |mem, e| populate!(mem, e) }
       end
 
       private
 
-      # @note   This method may modify passed hash. Non-existing instance variables are ignored
-      # @param  [Hash] hash an accumulator
-      # @param  [Symbol] v_sym an instance variable symbol
-      # @return [Hash] a hash containing a JSON representation of instance variable name and it's value
+      # Create a hash containing a JSON representation of instance variable
+      # name and its value.
+      #
+      # @param hash [Hash] An accumulator.
+      #
+      # @param v_sym [Symbol] An instance variable symbol.
+      #
+      # @return [Hash]
       def populate!(hash, v_sym)
-        return hash unless value = instance_variable_get(v_sym)
-        hash.merge!(v_sym.to_s.gsub(/@/, '') => value.to_s)
+        return hash unless (value = instance_variable_get(v_sym))
+
+        key = v_sym.to_s.gsub(/@/, '')
+        hash.merge!(key => represent(key, value))
       end
+
+      # Return the value according to the request format.
+      #
+      # @param key [Symbol] An instance variable symbol.
+      #
+      # @param value [Object] An instance variable value.
+      #
+      # @return [Object]
+      def represent(key, value)
+        BOOLS.include?(key) ? value : value.to_s
+      end
+
+      # Keys that have to remain boolean
+      BOOLS = %w[was_authorized is_gift has_gift_message].freeze
     end
   end
 end

data/lib/minfraud/components/billing.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # Billing corresponds to the billing object of a minFraud request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Billing_(/billing)
     class Billing < Addressable; end
   end
 end

data/lib/minfraud/components/credit_card.rb

@@ -1,42 +1,69 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # CreditCard corresponds to the credit_card object of a minFraud request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Credit_Card_(/creditcard)
     class CreditCard < Base
-      # @attribute issuer_id_number
-      # # @return [String] The issuer ID number for the credit card. This is the first 6 digits of the credit card number.
-      # It identifies the issuing bank
+      include Minfraud::Validates
+
+      # The issuer ID number for the credit card. This is the first 6 digits of
+      # the credit card number. It identifies the issuing bank.
+      #
+      # @return [String, nil]
       attr_accessor :issuer_id_number
 
-      # @attribute last_4_digits
-      # @return [String] The last four digits of the credit card number
+      # The last four digits of the credit card number.
+      #
+      # @return [String, nil]
       attr_accessor :last_4_digits
 
-      # @attribute bank_name
-      # @return [String] The name of the issuing bank as provided by the end user
+      # The name of the issuing bank as provided by the end user.
+      #
+      # @return [String, nil]
       attr_accessor :bank_name
 
-      # @attribute bank_phone_country_code
-      # @return [String] The phone country code for the issuing bank as provided by the end user
+      # The phone country code for the issuing bank as provided by the end
+      # user. If you provide this information then you must provide at least
+      # one digit.
+      #
+      # @return [String, nil]
       attr_accessor :bank_phone_country_code
 
-      # @attribute bank_phone_number
-      # @return [String] The phone number, without the country code, for the issuing bank as provided by the end user
+      # The phone number, without the country code, for the issuing bank as
+      # provided by the end user. Punctuation characters will be stripped.
+      # After stripping punctuation characters, the number must contain only
+      # digits.
+      #
+      # @return [String, nil]
       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.
+      # A token uniquely identifying the card. The token should consist of
+      # non-space printable ASCII characters. If the token is all digits, it
+      # must be more than 19 characters long. The token must not be a primary
+      # account number (PAN) or a simple transformation of it. If you have a
+      # valid token that looks like a PAN but is not one, you may prefix that
+      # token with a fixed string, e.g., +token-+.
+      #
+      # @return [String, nil]
       attr_accessor :token
 
-      # @attribute avs_result
-      # @return [String] The address verification system (AVS) check result, as returned to you by the credit card processor
+      # The address verification system (AVS) check result, as returned to you
+      # by the credit card processor. The minFraud service supports the
+      # standard AVS codes.
+      #
+      # @return [String, nil]
       attr_accessor :avs_result
 
-      # @attribute cvv_result
-      # @return [String] The card verification value (CVV) code as provided by the payment processor
+      # The card verification value (CVV) code as provided by the payment
+      # processor.
+      #
+      # @return [String, nil]
       attr_accessor :cvv_result
 
-      # Creates Minfraud::Components::CreditCard instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::Components::CreditCard] a CreditCard instance
+      # @param params [Hash] Hash of parameters. Each key/value should
+      #   correspond to one of the available attributes.
       def initialize(params = {})
         @bank_phone_country_code = params[:bank_phone_country_code]
         @issuer_id_number        = params[:issuer_id_number]
@@ -46,6 +73,23 @@ module Minfraud
         @avs_result              = params[:avs_result]
         @cvv_result              = params[:cvv_result]
         @token                   = params[:token]
+
+        validate
+      end
+
+      private
+
+      def validate
+        return if !Minfraud.enable_validation
+
+        validate_telephone_country_code('bank_phone_country_code', @bank_phone_country_code)
+        validate_regex('issuer_id_number', /\A[0-9]{6}\z/, @issuer_id_number)
+        validate_regex('last_4_digits', /\A[0-9]{4}\z/, @last_4_digits)
+        validate_string('bank_name', 255, @bank_name)
+        validate_string('bank_phone_number', 255, @bank_phone_number)
+        validate_string('avs_result', 1, @avs_result)
+        validate_string('cvv_result', 1, @cvv_result)
+        validate_credit_card_token('token', @token)
       end
     end
   end

data/lib/minfraud/components/custom_inputs.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Minfraud
+  module Components
+    # CustomInputs corresponds to the custom_inputs object of a minFraud
+    # request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Custom_Inputs_(/custominputs)
+    class CustomInputs < Base
+      include Minfraud::Validates
+
+      # @param params [Hash] Each key/value should correspond to your defined
+      #   custom inputs.
+      def initialize(params = {})
+        params.each do |name, value|
+          instance_variable_set("@#{name}", value)
+
+          if Minfraud.enable_validation
+            validate_custom_input_value(name, value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minfraud/components/device.rb

@@ -1,26 +1,67 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # Device corresponds to the device object of a minFraud request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Device_(/device)
     class Device < Base
-      # @!attribute ip_address
-      # @return [String] The IP address associated with the device used by the customer in the transaction.
-      # The IP address must be in IPv4 or IPv6 presentation format
+      include Minfraud::Validates
+
+      # The IP address associated with the device used by the customer in the
+      # transaction. The IP address must be in IPv4 or IPv6 presentation
+      # format, i.e., dotted-quad notation or the IPv6 hexadecimal-colon
+      # notation.
+      #
+      # @return [String, nil]
       attr_accessor :ip_address
 
-      # @attribute user_agent
-      # @return [String] The HTTP "User-Agent" header of the browser used in the transaction
+      # The HTTP "User-Agent" header of the browser used in the transaction.
+      #
+      # @return [String, nil]
       attr_accessor :user_agent
 
-      # @attribute :accept_language
-      # @return [String] The HTTP "Accept-Language" header of the browser used in the transaction
+      # The HTTP "Accept-Language" header of the browser used in the
+      # transaction.
+      #
+      # @return [String, nil]
       attr_accessor :accept_language
 
-      # Creates Minfraud::Components::Device instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::Components::Device] a Device instance
+      # 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.
+      # The value must be at least 0 and at most 10^13-1.
+      #
+      # @return [Float, nil]
+      attr_accessor :session_age
+
+      # An ID that uniquely identifies a visitor's session on the site.
+      #
+      # @return [String, nil]
+      attr_accessor :session_id
+
+      # @param params [Hash] Hash of parameters. Each key/value should
+      #   correspond to one of the available attributes.
       def initialize(params = {})
         @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]
+
+        validate
+      end
+
+      private
+
+      def validate
+        return if !Minfraud.enable_validation
+
+        validate_ip('ip_address', @ip_address)
+        validate_string('user_agent', 512, @user_agent)
+        validate_string('accept_language', 255, @accept_language)
+        validate_nonnegative_number('session_age', @session_age)
+        validate_string('session_id', 255, @session_id)
       end
     end
   end

data/lib/minfraud/components/email.rb

@@ -1,20 +1,42 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # Email corresponds to the email object of a minFraud request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Email_(/email)
     class Email < Base
-      # @attribute address
-      # @return [String] This field must be either a valid email address or an MD5 of the email used in the transaction
+      include Minfraud::Validates
+
+      # This field must be either be a valid email address or an MD5 of the
+      # lowercased email used in the transaction. Important: if using the MD5
+      # hash, please be sure to convert the email address to lowercase before
+      # calculating its MD5 hash.
+      #
+      # @return [String, nil]
       attr_accessor :address
 
-      # @attribute domain
-      # @return [String] The domain of the email address used in the transaction
+      # The domain of the email address used in the transaction.
+      #
+      # @return [String, nil]
       attr_accessor :domain
 
-      # Creates Minfraud::Components::Email instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::Components::Email] an Email instance
+      # @param params [Hash] Hash of parameters. Each key/value should
+      #   correspond to one of the available attributes.
       def initialize(params = {})
         @address = params[:address]
         @domain  = params[:domain]
+
+        validate
+      end
+
+      private
+
+      def validate
+        return if !Minfraud.enable_validation
+
+        validate_email('email', @address)
+        validate_string('domain', 255, @domain)
       end
     end
   end

data/lib/minfraud/components/event.rb

@@ -1,32 +1,79 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # Event corresponds to the event object of a minFraud request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Event_(/event)
     class Event < Base
       include ::Minfraud::Enum
-      # @attribute transaction_id
-      # @return [String] Internal ID for the transaction. Used to locate a specific transaction in minFraud logs
+      include Minfraud::Validates
+
+      # Your internal ID for the transaction. MaxMind can use this to locate a
+      # specific transaction in logs, and it will also show up in email alerts
+      # and notifications from MaxMind to you. No specific format is required.
+      #
+      # @return [String, nil]
       attr_accessor :transaction_id
 
-      # @attribute shop_id
-      # @return [String] Internal ID for the shop, affiliate, or merchant this order is coming from
+      # Your internal ID for the shop, affiliate, or merchant this order is
+      # coming from. Required for minFraud users who are resellers, payment
+      # providers, gateways and affiliate networks. No specific format is
+      # required.
+      #
+      # @return [String, nil]
       attr_accessor :shop_id
 
-      # @attribute time
-      # @return [String] The date and time the event occurred. The string must be in the RFC 3339 date-time format.
-      # If this field is not in the request, the current time will be used
+      # The date and time the event occurred. The string must be in the RFC
+      # 3339 date-time format, e.g., "2012-04-12T23:20:50.52Z". The time must
+      # be within the past 10 years. If this field is not in the request, the
+      # current time will be used.
+      #
+      # @see https://tools.ietf.org/html/rfc3339
+      #
+      # @return [String, nil]
       attr_accessor :time
 
-      # @attribute type
-      # @return [String] The type of event being scored
-      enum_accessor :type, [:account_creation, :account_login, :purchase, :recurring_purchase, :referral, :survey]
+      # The type of event being scored. This must be one of
+      # +:account_creation+, +:account_login+, +:email_change+,
+      # +:password_reset+, +:payout_change+, +:purchase+,
+      # +:recurring_purchase+, +:referral+, or +:survey+.
+      #
+      # @!attribute type
+      #
+      # @return [Symbol, nil]
+      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
-      # @return [Minfraud::Components::Event] an Event instance
+      # @param params [Hash] Hash of parameters. Each key/value should
+      #   correspond to one of the available attributes.
       def initialize(params = {})
         @transaction_id = params[:transaction_id]
         @shop_id        = params[:shop_id]
         @time           = params[:time]
         self.type       = params[:type]
+
+        validate
+      end
+
+      private
+
+      def validate
+        return if !Minfraud.enable_validation
+
+        validate_string('transaction_id', 255, @transaction_id)
+        validate_string('shop_id', 255, @shop_id)
+        validate_rfc3339('time', @time)
       end
     end
   end

data/lib/minfraud/components/order.rb

@@ -1,50 +1,88 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # Order corresponds to the order object of a minFraud request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Order_(/order)
     class Order < Base
-      # @attribute amount
-      # @return [Decimal] The total order amount for the transaction
+      include Minfraud::Validates
+
+      # The total order amount for the transaction before taxes and discounts.
+      # The value must be at least 0 and at most 1e14 - 1.
+      #
+      # @return [Float, nil]
       attr_accessor :amount
 
-      # @attribute currency
-      # @return [String] The ISO 4217 currency code for the currency used in the transaction
+      # The ISO 4217 currency code for the currency used in the transaction.
+      #
+      # @see https://en.wikipedia.org/wiki/ISO_4217
+      #
+      # @return [String, nil]
       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.
+      # The discount code applied to the transaction. If multiple discount
+      # codes are used, please separate them with a comma.
+      #
+      # @return [String, nil]
       attr_accessor :discount_code
 
-      # @attribute affiliate_id
-      # @return [String] The ID of the affiliate where the order is coming from
+      # The ID of the affiliate where the order is coming from. No specific
+      # format is required.
+      #
+      # @return [String, nil]
       attr_accessor :affiliate_id
 
-      # @attribute subaffiliate_id
-      # @return [String] The ID of the sub-affiliate where the order is coming from
+      # The ID of the sub-affiliate where the order is coming from. No specific
+      # format is required.
+      #
+      # @return [String, nil]
       attr_accessor :subaffiliate_id
 
-      # @attribute :referrer_uri
-      # @return [String] The URI of the referring site for this order
+      # The URI of the referring site for this order. Needs to be absolute and
+      # have a URI scheme such as +https://+.
+      #
+      # @return [String, nil]
       attr_accessor :referrer_uri
 
-      # @attribute :is_gift
-      # @return [Boolean] Whether order was marked as a gift by the purchaser
+      # Whether order was marked as a gift by the purchaser.
+      #
+      # @return [Boolean, nil]
       attr_accessor :is_gift
 
-      # @attribute :has_gift_message
-      # @return [Boolean] Whether the purchaser included a gift message
+      # Whether the purchaser included a gift message.
+      #
+      # @return [Boolean, nil]
       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 = {})
+      # @param params [Hash] Hash of parameters. Each key/value should
+      #   correspond to one of the available attributes.
+      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]
+        @discount_code    = params[:discount_code]
         @referrer_uri     = params[:referrer_uri]
         @is_gift          = params[:is_gift]
+
+        validate
+      end
+
+      private
+
+      def validate
+        return if !Minfraud.enable_validation
+
+        validate_nonnegative_number('amount', @amount)
+        validate_boolean('has_gift_message', @has_gift_message)
+        validate_string('affiliate_id', 255, @affiliate_id)
+        validate_string('subaffiliate_id', 255, @subaffiliate_id)
+        validate_regex('currency', /\A[A-Z]{3}\z/, @currency)
+        validate_string('discount_code', 255, @discount_code)
+        validate_uri('referrer_uri', @referrer_uri)
+        validate_boolean('is_gift', @is_gift)
       end
     end
   end