Merge pull request #60 from maxmind/nlogan/8-digit-iin-2-digit-lastdigits

Add support for 8 digit IINs and 2 digit last_digits

Author: horgh

CHANGELOG.md

@@ -4,6 +4,21 @@
 
 * Adds the following new processor to `Minfraud::Components::Payment`:
   * `:windcave`
+* The `last_4_digits` input to `Minfraud::Components::CreditCard` has been
+  deprecated in favor of `last_digits` and will be removed in a future
+  release. `last_digits`/`last_4_digits` also now supports two digit values
+  in addition to the previous four digit values.
+* Eight digit `issuer_id_number` inputs are now supported by
+  `Minfraud::Components::CreditCard` in addition to the previously accepted
+  six digit `issuer_id_number`. In most cases, you should send the last four
+  digits for `last_digits`. If you send an `issuer_id_number` that contains
+  an eight digit IIN, and if the credit card brand is not one of the
+  following, you should send the last two digits for `last_digits`:
+  * `Discover`
+  * `JCB`
+  * `Mastercard`
+  * `UnionPay`
+  * `Visa`
 
 ## v2.0.0 (2021-12-06)
 

README.md

@@ -123,7 +123,7 @@ assessment = Minfraud::Assessments.new(
   },
   credit_card: {
     issuer_id_number:         '411111',
-    last_4_digits:            '7643',
+    last_digits:              '7643',
     bank_name:                'Bank of No Hope',
     bank_phone_country_code:  '1',
     bank_phone_number:        '123-456-1234',

lib/minfraud/components/credit_card.rb

@@ -8,16 +8,18 @@ module Components
     class CreditCard < Base
       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.
+      # The issuer ID number for the credit card. This is the first 6 or 8
+      # digits of the credit card number. It identifies the issuing bank.
       #
       # @return [String, nil]
       attr_accessor :issuer_id_number
 
-      # The last four digits of the credit card number.
+      # The last two or four digits of the credit card number.
+      #
+      # @see https://dev.maxmind.com/minfraud/api-documentation/requests?lang=en#schema--request--credit-card__last_digits
       #
       # @return [String, nil]
-      attr_accessor :last_4_digits
+      attr_accessor :last_digits
 
       # The name of the issuing bank as provided by the end user.
       #
@@ -72,12 +74,30 @@ class CreditCard < Base
       # @return [Boolean, nil]
       attr_accessor :was_3d_secure_successful
 
+      # Get the last digits of the credit card number.
+      #
+      # @deprecated Use {::last_digits} instead.
+      #
+      # @return [String, nil]
+      def last_4_digits
+        @last_digits
+      end
+
+      # Set the last digits of the credit card number.
+      #
+      # @deprecated Use {::last_digits} instead.
+      #
+      # @return [String, nil]
+      def last_4_digits=(last4)
+        @last_digits = last4
+      end
+
       # @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]
-        @last_4_digits            = params[:last_4_digits]
+        @last_digits              = params[:last_digits] || params[:last_4_digits]
         @bank_name                = params[:bank_name]
         @bank_phone_number        = params[:bank_phone_number]
         @avs_result               = params[:avs_result]
@@ -94,8 +114,8 @@ 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_regex('issuer_id_number', /\A(?:[0-9]{6}|[0-9]{8})\z/, @issuer_id_number)
+        validate_regex('last_digits', /\A(?:[0-9]{2}|[0-9]{4})\z/, @last_digits)
         validate_string('bank_name', 255, @bank_name)
         validate_string('bank_phone_number', 255, @bank_phone_number)
         validate_string('avs_result', 1, @avs_result)

spec/components/credit_card_spec.rb

@@ -16,6 +16,14 @@
       end.to raise_exception(Minfraud::InvalidInputError)
     end
 
+    it 'raises an exception for an invalid last_digits' do
+      expect do
+        Minfraud::Components::CreditCard.new(
+          last_digits: '6',
+        )
+      end.to raise_exception(Minfraud::InvalidInputError)
+    end
+
     it 'raises an exception for an invalid last_4_digits' do
       expect do
         Minfraud::Components::CreditCard.new(
@@ -40,19 +48,41 @@
       end.to raise_exception(Minfraud::InvalidInputError)
     end
 
-    it 'does not raise an exception for valid values' do
-      Minfraud::Components::CreditCard.new(
+    it 'does not raise an exception for valid values (deprecated last_4_digits)' do
+      @cc = Minfraud::Components::CreditCard.new(
         issuer_id_number:         '123456',
         last_4_digits:            '1234',
         token:                    'abcd',
         was_3d_secure_successful: true,
       )
+      expect(@cc.last_digits).to be(@cc.last_4_digits)
+      expect(@cc.last_digits).to be('1234')
+    end
+
+    it 'does not raise an exception for valid values (eight digit issuer_id_number)' do
+      Minfraud::Components::CreditCard.new(
+        issuer_id_number:         '12345678',
+        last_4_digits:            '1234',
+        token:                    'abcd',
+        was_3d_secure_successful: true,
+      )
+    end
+
+    it 'does not raise an exception for valid values (two digit last_digits)' do
+      @cc = Minfraud::Components::CreditCard.new(
+        issuer_id_number:         '12345678',
+        last_digits:              '34',
+        token:                    'abcd',
+        was_3d_secure_successful: true,
+      )
+      expect(@cc.last_digits).to be(@cc.last_4_digits)
+      expect(@cc.last_digits).to be('34')
     end
 
     it 'does not raise an exception for valid values (token is all digits)' do
       Minfraud::Components::CreditCard.new(
         issuer_id_number:         '123456',
-        last_4_digits:            '1234',
+        last_digits:              '1234',
         token:                    '1' * 20,
         was_3d_secure_successful: true,
       )