minfraud 1.0.3 → 1.4.0

data/lib/minfraud/components/payment.rb

@@ -1,39 +1,184 @@
+# 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,
+        :tsys,
+        :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

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Minfraud
+  module Components
+    module Report
+      # Contains the fields used in the Report Transaction API.
+      #
+      # @see https://dev.maxmind.com/minfraud/report-transaction/
+      class Transaction < Base
+        include ::Minfraud::Enum
+
+        # 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
+        #
+        # @return [Symbol, nil]
+        enum_accessor :tag, [:chargeback, :not_fraud, :spam_or_abuse, :suspected_fraud]
+
+        # A string which is provided by your payment processor indicating the
+        # reason for the chargeback.
+        #
+        # @return [String, nil]
+        attr_accessor :chargeback_code
+
+        # 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
+
+        # 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
+
+        # 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
+
+        # 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
+
+        # @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]
+          @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,14 +1,23 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # Shipping corresponds to the shipping object of a minFraud request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Shipping_(/shipping)
     class Shipping < Addressable
       include ::Minfraud::Enum
-      # @attribute delivery_speed
-      # @return [String] The shipping delivery speed for the order. The valid values are:
+
+      # The shipping delivery speed for the order. Must be one of +:same_day+,
+      # +:overnight+, +:expedited+, or +:standard+.
+      #
+      # @!attribute delivery_speed
+      #
+      # @return [Symbol, nil]
       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
+      # @param params [Hash] Hash of parameters. Each key/value should
+      #   correspond to one of the available attributes.
       def initialize(params = {})
         self.delivery_speed = params[:delivery_speed]
         super

data/lib/minfraud/components/shopping_cart.rb

@@ -1,27 +1,34 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # ShoppingCart corresponds to the shopping_cart object of a minFraud
+    # request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Shopping_Cart_(/shoppingcart)
     class ShoppingCart < Base
-      # @attribute items
-      # @return [Array] An array of Minfraud::Components::ShoppingCartItem instances
-
+      # An array of Minfraud::Components::ShoppingCartItem instances.
+      #
+      # @return [Array<Minfraud::Components::ShoppingCartItem>]
       attr_accessor :items
-      # Creates Minfraud::Components::ShoppingCart instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::Components::ShoppingCart] ShoppingCart instance
-      def initialize(params = {})
+
+      # @param params [Array] Array of shopping cart items. You may provide
+      #   each item as either as Hash where each key is a symbol corresponding
+      #   to an item's field, or as a Minfraud:::Components::ShoppingCartItem
+      #   object.
+      def initialize(params = [])
         @items = params.map(&method(:resolve))
       end
 
-      # @return [Array] a JSON representation of Minfraud::Components::ShoppingCart items
-      def to_json
+      # A JSON representation of Minfraud::Components::ShoppingCart items.
+      #
+      # @return [Array]
+      def to_json(*_args)
         @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

data/lib/minfraud/components/shopping_cart_item.rb

@@ -1,33 +1,62 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # ShoppingCartItem corresponds to objects in the shopping_cart object
+    # of a minFraud request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Shopping_Cart_Item
     class ShoppingCartItem < Base
-      # @attribute category
-      # @return [String] The category of the item
+      include Minfraud::Validates
+
+      # The category of the item. This can also be a hashed value; see link.
+      #
+      # @see https://dev.maxmind.com/minfraud/#cart-hashing
+      #
+      # @return [String, nil]
       attr_accessor :category
 
-      # @attribute item_id
-      # @return [String] The internal ID of the item
+      # The internal ID of the item. This can also be a hashed value; see link.
+      #
+      # @see https://dev.maxmind.com/minfraud/#cart-hashing
+      #
+      # @return [String, nil]
       attr_accessor :item_id
 
-      # @attribute quantity
-      # @return [Integer] The quantity of the item in the shopping cart
+      # The quantity of the item in the shopping cart. The value must be at
+      # least 0, at most 10^13-1, and have no fractional part.
+      #
+      # @return [Integer, nil]
       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
+      # The per-unit price of this item in the shopping cart. This should use
+      # the same currency as the order currency. The value must be at least 0
+      # and at most 1e14 - 1.
+      #
+      # @return [Float, nil]
       attr_accessor :price
 
-      # Creates Minfraud::Components::ShoppingCartItem instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::Components::ShoppingCartItem] ShoppingCartItem instance
+      # @param params [Hash] Hash of parameters. Each key/value should
+      #   correspond to one of the available attributes.
       def initialize(params = {})
         @category = params[:category]
         @item_id  = params[:item_id]
         @quantity = params[:quantity]
         @price    = params[:price]
+
+        validate
+      end
+
+      private
+
+      def validate
+        return if !Minfraud.enable_validation
+
+        validate_string('category', 255, @category)
+        validate_string('item_id', 255, @item_id)
+        validate_nonnegative_integer('quantity', @quantity)
+        validate_nonnegative_number('price', @price)
       end
     end
   end
 end
-
-

data/lib/minfraud/enum.rb

@@ -1,19 +1,30 @@
+# frozen_string_literal: true
+
 module Minfraud
+  # Enum provides helpers for working with attributes with enumerated types.
   module Enum
     def self.included(base)
       base.extend(ClassMethods)
     end
 
+    # ClassMethods provides helpers for working with attributes with enumerated
+    # types.
     module ClassMethods
-      # Returns a hash with in the following format: attribute_name => permitted_values
-      # @return [Hash] mapping
+      # Returns a hash in the following format: attribute_name =>
+      # permitted_values
+      #
+      # @return [Hash]
       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
+      # Create a set of methods for enum-like behavior of the attribute.
+      #
+      # @param attribute [Symbol] The attribute name.
+      #
+      # @param assignable_values [Array] The set of permitted values.
+      #
+      # @return [nil]
       def enum_accessor(attribute, assignable_values)
         mapping[attribute] = assignable_values.map(&:intern)
 
@@ -21,13 +32,16 @@ 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)
+            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
+
+        nil
       end
     end
   end