Merge pull request #156 from maxmind/wstorey/eng-2870-eventparty-and-paymentmethod-minfraud-inputs-are-supported

Add /event/party, /payment/method, and new /event/type values

Author: oschwald

CHANGELOG.md

@@ -5,6 +5,14 @@
 * Added the processor `:securepay` to `Minfraud::Components::Payment`.
 * Ruby 3.2+ is now required. If you're using Ruby 3.0 or 3.1, please use
   version 2.8.0 of this gem.
+* Added `/event/type` values `:credit_application` and `:fund_transfer` to
+  `Minfraud::Components::Event`.
+* Added the input `/event/party`. This is the party submitting the
+  transaction. You may provide this using the `party` attribute on
+  `Minfraud::Components::Event`.
+* Added the input `/payment/method`. This is the payment method associated
+  with the transaction. You may provide this using the `method` attribute
+  on `Minfraud::Components::Payment`.
 
 ## v2.8.0 (2025-05-23)
 

README.md

@@ -86,6 +86,7 @@ assessment = Minfraud::Assessments.new(
     user_agent:      'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.89 Safari/537.36',
   },
   event: {
+    party:          :customer,
     transaction_id: 'txn3134133',
     shop_id:        's2123',
     time:           '2012-04-12T23:20:50+00:00',
@@ -127,6 +128,7 @@ assessment = Minfraud::Assessments.new(
     delivery_speed:     :same_day,
   },
   payment: {
+    method:         :card,
     processor:      :stripe,
     was_authorized: false,
     decline_code:   'invalid number',

lib/minfraud/components/event.rb

@@ -9,6 +9,18 @@ class Event < Base
       include ::Minfraud::Enum
       include Minfraud::Validates
 
+      # The party submitting the transaction. This must be one of +:agent+ or
+      # +:customer+.
+      #
+      # @!attribute party
+      #
+      # @return [Symbol, nil]
+      enum_accessor :party,
+                    %i[
+                      agent
+                      customer
+                    ]
+
       # 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.
@@ -35,9 +47,10 @@ class Event < Base
       attr_accessor :time
 
       # 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+.
+      # +:account_creation+, +:account_login+, +:credit_application+,
+      # +:email_change+, +:fund_transfer+, +:password_reset+,
+      # +:payout_change+, +:purchase+, +:recurring_purchase+, +:referral+,
+      # or +:survey+.
       #
       # @!attribute type
       #
@@ -46,7 +59,9 @@ class Event < Base
                     %i[
                       account_creation
                       account_login
+                      credit_application
                       email_change
+                      fund_transfer
                       password_reset
                       payout_change
                       purchase
@@ -58,6 +73,7 @@ class Event < Base
       # @param params [Hash] Hash of parameters. Each key/value should
       #   correspond to one of the available attributes.
       def initialize(params = {})
+        self.party      = params[:party]
         @transaction_id = params[:transaction_id]
         @shop_id        = params[:shop_id]
         @time           = params[:time]

lib/minfraud/components/payment.rb

@@ -9,6 +9,28 @@ class Payment < Base
       include ::Minfraud::Enum
       include Minfraud::Validates
 
+      # The payment method associated with the transaction. This must be one of
+      # +:bank_debit+, +:bank_redirect+, +:bank_transfer+, +:buy_now_pay_later+,
+      # +:card+, +:crypto+, +:digital_wallet+, +:gift_card+,
+      # +:real_time_payment+, or +:rewards+.
+      #
+      # @!attribute method
+      #
+      # @return [Symbol, nil]
+      enum_accessor :method,
+                    %i[
+                      bank_debit
+                      bank_redirect
+                      bank_transfer
+                      buy_now_pay_later
+                      card
+                      crypto
+                      digital_wallet
+                      gift_card
+                      real_time_payment
+                      rewards
+                    ]
+
       # The payment processor used for the transaction. The value is one
       # listed as a valid value, as a symbol.
       #
@@ -196,6 +218,7 @@ class Payment < Base
       def initialize(params = {})
         @was_authorized = params[:was_authorized]
         @decline_code   = params[:decline_code]
+        self.method     = params[:method]
         self.processor  = params[:processor]
 
         validate

spec/components/event_spec.rb

@@ -11,6 +11,14 @@
         end.to raise_exception(Minfraud::NotEnumValueError)
       end
     end
+
+    context 'with an invalid party' do
+      it 'raises an exception' do
+        expect do
+          described_class.new({ party: :invalid })
+        end.to raise_exception(Minfraud::NotEnumValueError)
+      end
+    end
   end
 
   describe 'validation' do
@@ -31,5 +39,29 @@
         time: '2020-08-28T14:00:00Z',
       )
     end
+
+    it 'accepts credit_application as a valid type' do
+      described_class.new(
+        type: :credit_application,
+      )
+    end
+
+    it 'accepts fund_transfer as a valid type' do
+      described_class.new(
+        type: :fund_transfer,
+      )
+    end
+
+    it 'accepts agent as a valid party' do
+      described_class.new(
+        party: :agent,
+      )
+    end
+
+    it 'accepts customer as a valid party' do
+      described_class.new(
+        party: :customer,
+      )
+    end
   end
 end

spec/components/payment_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Minfraud::Components::Payment do
+  describe '#initialize' do
+    context 'with an invalid processor' do
+      it 'raises an exception' do
+        expect do
+          described_class.new({ processor: :invalid_processor })
+        end.to raise_exception(Minfraud::NotEnumValueError)
+      end
+    end
+
+    context 'with an invalid method' do
+      it 'raises an exception' do
+        expect do
+          described_class.new({ method: :invalid_method })
+        end.to raise_exception(Minfraud::NotEnumValueError)
+      end
+    end
+  end
+
+  describe 'validation' do
+    before do
+      Minfraud.configure { |c| c.enable_validation = 1 }
+    end
+
+    it 'does not raise an exception for valid values' do
+      described_class.new(
+        processor:      :stripe,
+        method:         :card,
+        was_authorized: true,
+        decline_code:   'insufficient_funds',
+      )
+    end
+
+    it 'accepts bank_debit as a valid method' do
+      described_class.new(
+        method: :bank_debit,
+      )
+    end
+
+    it 'accepts digital_wallet as a valid method' do
+      described_class.new(
+        method: :digital_wallet,
+      )
+    end
+
+    it 'accepts buy_now_pay_later as a valid method' do
+      described_class.new(
+        method: :buy_now_pay_later,
+      )
+    end
+  end
+end