minfraud 1.1.0 → 1.5.0

data/lib/minfraud/components/event.rb

@@ -1,43 +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
+      # 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
+                    [
+                      :account_creation,
+                      :account_login,
+                      :email_change,
+                      :password_reset,
+                      :payout_change,
+                      :purchase,
+                      :recurring_purchase,
+                      :referral,
+                      :survey,
+                    ]
+
+      # @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,51 +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,9 +1,20 @@
+# 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,
         :affirm,
@@ -11,6 +22,8 @@ module Minfraud
         :altapay,
         :amazon_payments,
         :american_express_payment_gateway,
+        :apple_pay,
+        :aps_payments,
         :authorizenet,
         :balanced,
         :beanstream,
@@ -19,6 +32,7 @@ module Minfraud
         :bpoint,
         :braintree,
         :cardpay,
+        :cashfree,
         :ccavenue,
         :ccnow,
         :cetelem,
@@ -50,6 +64,7 @@ module Minfraud
         :epx,
         :eway,
         :exact,
+        :first_atlantic_commerce,
         :first_data,
         :g2a_pay,
         :global_payments,
@@ -62,6 +77,7 @@ module Minfraud
         :intuit_quickbooks_payments,
         :iugu,
         :klarna,
+        :komoju,
         :lemon_way,
         :mastercard_payment_gateway,
         :mercadopago,
@@ -89,6 +105,7 @@ module Minfraud
         :payplus,
         :paysafecard,
         :paystation,
+        :paytm,
         :paytrace,
         :paytrail,
         :payture,
@@ -103,6 +120,7 @@ module Minfraud
         :qiwi,
         :quickpay,
         :raberil,
+        :razorpay,
         :rede,
         :redpagos,
         :rewardspay,
@@ -116,9 +134,11 @@ module Minfraud
         :sps_decidir,
         :stripe,
         :synapsefi,
+        :systempay,
         :telerecargas,
         :towah,
         :transact_pro,
+        :tsys,
         :usa_epay,
         :vantiv,
         :verepay,
@@ -131,21 +151,36 @@ module Minfraud
         :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

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

@@ -3,65 +3,76 @@
 module Minfraud
   module Components
     module Report
-      # Contains all of the fields which are used in the report transaction API
+      # Contains the fields used in the Report Transaction API.
+      #
+      # @see https://dev.maxmind.com/minfraud/report-transaction/
       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".
+        # The IP address of the customer placing the order. This should be
+        # passed as a string like "152.216.7.110".
+        #
+        # @return [String, nil]
         attr_accessor :ip_address
 
+        # A symbol indicating the likelihood that a transaction may be
+        # fraudulent.
+        #
+        # This may be one of +:chargeback+, +:not_fraud+, +:spam_or_abuse+, or
+        # +:suspected_fraud+.
+        #
         # @!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.
+        #
+        # @return [Symbol, nil]
         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.
+        # A string which is provided by your payment processor indicating the
+        # reason for the chargeback.
+        #
+        # @return [String, nil]
         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.
+        # 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.
+        #
+        # @return [String, nil]
         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.
+        # 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.
+        #
+        # @return [String, nil]
         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.
+        # 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.
+        #
+        # @return [String, nil]
         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
+        # 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.
+        #
+        # @return [String, nil]
         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
+        # @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]
+          @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]
+          @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