minfraud 1.0.2 → 1.3.0

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

data/lib/minfraud/components/payment.rb

@@ -1,39 +1,183 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # Payment corresponds to the payment object of a minFraud request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Payment_(/payment)
     class Payment < Base
       include ::Minfraud::Enum
-      # @attribute processor
-      # @return [String] The payment processor used for the transaction
+      include Minfraud::Validates
+
+      # The payment processor used for the transaction. The value is one
+      # listed as a valid value, as a symbol.
+      #
+      # @!attribute processor
+      #
+      # @return [Symbol, nil]
       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
+      # The authorization outcome from the payment processor. If the
+      # transaction has not yet been approved or denied, do not include this
+      # field.
+      #
+      # @return [Boolean, nil]
       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
+      # The decline code as provided by your payment processor. If the
+      # transaction was not declined, do not include this field.
+      #
+      # @return [String, nil]
       attr_accessor :decline_code
 
-      # Creates Minfraud::Components::Payment instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::Components::Payment] Payment instance
+      # @param params [Hash] Hash of parameters. Each key/value should
+      #   correspond to one of the available attributes.
       def initialize(params = {})
         @was_authorized = params[:was_authorized]
         @decline_code   = params[:decline_code]
         self.processor  = params[:processor]
+
+        validate
+      end
+
+      private
+
+      def validate
+        return if !Minfraud.enable_validation
+
+        validate_boolean('was_authorized', @was_authorized)
+        validate_string('decline_code', 255, @decline_code)
       end
     end
   end