issuer_response_codes 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f30e5afe484a09019488f8e4de8d67f26cdde55a35ee0fc129227f726f7b78b6
-  data.tar.gz: 05d1504748e11ac63423f3107281f746455ff04dc282707d2797c04f1943ac11
+  metadata.gz: 0fdf114e3233ad8d9aa121a2c12bc2819e9c110c6671a4e364ae00f5a69987e9
+  data.tar.gz: 9e22b8b8973d9577b47623b921ef0e2b2ea470b8175861b836656ec57fe35aac
 SHA512:
-  metadata.gz: b91d8309622bdd9f4efea3b50372719b3ccca9cb5b610f3c8dc5da4c0de1175ad72793779d395c74dd6f2b127e1ce88ac1804c537c792a30d2357af4248b88da
-  data.tar.gz: 13ab508736d7f06877966cfa1a9f84a35e35be8f940678f93b10624e3bfe0e4cc03c1b7bdc65d74817b66ccc89890db6d520518ddbfae54d43a6d3792db9ef43
+  metadata.gz: 238de0b95f1203dc1d93855c8badca49bd5792e3ad43c3ffb7d7df078cae4c68bf7bd28ae77204ffdf733d671a4c873e1e43a574169ce9185e720bdc26be44fc
+  data.tar.gz: 5d537189d5e4c074ec9fd4b4cbce724f97b9c2d64697a103be37fa1d348ff469d92fd697fe3b3dcaab3b34eca21ff7486ae880a0310297e1f08e1dd5fe7944df

data/Gemfile.lock

@@ -1,27 +1,28 @@
 PATH
   remote: .
   specs:
-    issuer_response_codes (0.1.3)
+    issuer_response_codes (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    backport (1.1.2)
+    backport (1.2.0)
     benchmark (0.1.1)
     bundler-audit (0.8.0)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
     byebug (11.1.3)
+    diff-lcs (1.4.4)
     e2mmap (0.1.0)
     jaro_winkler (1.5.4)
     kramdown (2.3.1)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    mini_portile2 (2.5.1)
+    mini_portile2 (2.5.3)
     minitest (5.14.4)
-    nokogiri (1.11.3)
+    nokogiri (1.11.7)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
     parallel (1.20.1)
@@ -34,22 +35,23 @@ GEM
     reverse_markdown (2.0.0)
       nokogiri
     rexml (3.2.5)
-    rubocop (1.14.0)
+    rubocop (1.18.2)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.5.0, < 2.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.5.0)
+    rubocop-ast (1.7.0)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
-    solargraph (0.40.4)
-      backport (~> 1.1)
+    solargraph (0.42.3)
+      backport (~> 1.2)
       benchmark
       bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
       e2mmap
       jaro_winkler (~> 1.5)
       kramdown (~> 2.3)

data/README.md

@@ -1,9 +1,9 @@
 # IssuerResponseCodes
 
-This gem provides a quite comprehensive library of Issuer Response Code descriptions (for both cardholders and merchants) with suggested actions in 7 languages:
+This gem provides a quite comprehensive library of Issuer Response Code and 3D-Secure Status Code descriptions (for both cardholders and merchants) with suggested actions in 7 languages:
 - Complete locales:
-    - en
-    - pl
+  - en
+  - pl
 
 - Incomplete locales:
   - da
@@ -59,11 +59,22 @@ def response_code_description
     ::ISSUER_RESPONSE_CODES.code(id: '43', locale: :pl).description
     #=> "Karta oznaczona jako skradziona. Skontaktuj się z Twoim bankiem w celu wyjaśnienia przyczyny problemu."
 end
+
+def tds_code_description
+    ::ISSUER_RESPONSE_CODES.tds_code(id: '09').description
+    #=> "Security failure"
+
+    ::ISSUER_RESPONSE_CODES.tds_code(id: '09', target: :cardholder).description
+    #=> "Card authentication failed"
+
+    ::ISSUER_RESPONSE_CODES.tds_code(id: '09', locale: :pl).description
+    #=> "Niepowodzenie autoryzacji karty"
+end
 ```
 
 ## Usage
 
-This gem provides an easy way of handling Issuer Response Codes. Whether you need detailed descriptions, short reasons or suggestions of what to do when a certain Code appeared, we've got you covered. Certain more explicit codes like `Stolen card' are masked behind more generic terms when you choose to target cardholders.
+This gem provides an easy way of handling Issuer Response Codes and 3D-Secure Status Codes. Whether you need detailed descriptions, short reasons or suggestions of what to do when a certain Code appeared, we've got you covered. Certain more explicit codes like `Stolen card' are masked behind more generic terms when you choose to target cardholders.
 
 ### IssuerResponseCodes::Code
 #### Creation options
@@ -135,7 +146,7 @@ code.reason #=> "Karta utraciła ważność."
 
 #### Methods
 
-##### Reason
+##### reason
 
 The `reason` method returns a relatively short description of the main reason why the Issuer Response Code appeared in the first place.
 
@@ -150,7 +161,7 @@ code = ::IssuerResponseCodes::Code.new(id: '59')
 code.reason #=> "Your bank has declined this transaction"
 ```
 
-##### Behaviour
+##### behaviour
 
 The `behaviour` method returns a suggestion of what to do when the Issuer Response Code appeared. Mainly for cardholders.
 
@@ -165,9 +176,9 @@ code = ::IssuerResponseCodes::Code.new(id: '59')
 code.behaviour #=> "Please contact your card issuer to get more details and try again later."
 ```
 
-##### Description
+##### description
 
-The `description` method is a combination of both the `reason` and `behaviour` of a Issuer Response Code
+The `description` method (aliased as `humanize`) is a combination of both the `reason` and `behaviour` of a Issuer Response Code
 
 ```ruby
 code = ::IssuerResponseCodes::Code.new(id: '14')
@@ -180,6 +191,91 @@ code = ::IssuerResponseCodes::Code.new(id: '59')
 code.description #=> "Your bank has declined this transaction. Please contact your card issuer to get more details and try again later."
 ```
 
+##### fraudulent_code?
+
+The `fraudulent_code?` method returns `true` when the Code indicates fraud.
+
+```ruby
+code = ::IssuerResponseCodes::Code.new(id: '14')
+code.fraudulent_code? #=> false
+
+code = ::IssuerResponseCodes::Code.new(id: '04')
+code.fraudulent_code? #=> true
+
+code = ::IssuerResponseCodes::Code.new(id: '43')
+code.fraudulent_code? #=> true
+```
+
+### IssuerResponseCodes::TdsCode
+#### Creation options
+
+##### Targets
+
+You can choose the main target of these descriptions (certain details are hidden for cardholders)
+
+```ruby
+# Default values are as follows:
+# target: :merchant, locale: :en
+
+# fraud_notice is set to true by default when target = :merchant
+code = ::IssuerResponseCodes::TdsCode.new(id: '11')
+code.reason #=> "Suspected fraud"
+
+code = ::IssuerResponseCodes::TdsCode.new(id: '11', target: :merchant)
+code.reason #=> "Suspected fraud"
+
+# fraud_notice is set to false by default when target = :cardholder
+code = ::IssuerResponseCodes::TdsCode.new(id: '11', target: :cardholder)
+code.reason #=> "Card authentication failed"
+```
+
+##### Locale
+
+The default locale is `:en`. There are 7 in total: `%i[en pl da ee lt lv sv]`. Only the first two are complete, the rest are partially in English.
+
+```ruby
+code = ::IssuerResponseCodes::TdsCode.new(id: '11')
+code.reason #=> "Suspected fraud"
+
+code = ::IssuerResponseCodes::TdsCode.new(id: '11', locale: :en)
+code.reason #=> "Suspected fraud"
+
+code = ::IssuerResponseCodes::TdsCode.new(id: '11', locale: :pl)
+code.reason #=> "Podejrzenie oszustwa"
+```
+
+#### Methods
+
+##### description/reason
+
+The `description` (also aliased as `reason`) method returns a relatively short description of the main reason why the Issuer Response Code appeared in the first place.
+
+```ruby
+code = ::IssuerResponseCodes::TdsCode.new(id: '08')
+code.description #=> "No Card record"
+
+code = ::IssuerResponseCodes::TdsCode.new(id: '22')
+code.description #=> "ACS technical issue"
+
+code = ::IssuerResponseCodes::TdsCode.new(id: '26')
+code.description #=> "Authentication attempted but not performed by the cardholder"
+```
+
+##### fraudulent_code?
+
+The `fraudulent_code?` method returns `true` when the TdsCode indicates fraud.
+
+```ruby
+code = ::IssuerResponseCodes::TdsCode.new(id: '11')
+code.fraudulent_code? #=> true
+
+code = ::IssuerResponseCodes::TdsCode.new(id: '22')
+code.fraudulent_code? #=> false
+
+code = ::IssuerResponseCodes::TdsCode.new(id: '26')
+code.fraudulent_code? #=> false
+```
+
 ### Custom default configuration
 
 You can make use of the `Context` class to easily create your own default configurations. Contexts work as proxies which create codes for you.
@@ -198,6 +294,9 @@ code = ISSUER_RESPONSE_CODES.code(id: '43')
 code.reason #=> "Bank odrzucił autoryzację."
 code.behaviour #=> "Skontaktuj się z Twoim bankiem w celu wyjaśnienia przyczyny problemu. UWAGA: Nie należy powtarzać obciążeń dla tej karty! Może to zostać uznane za próbę oszustwa!"
 
+tds_code = ISSUER_RESPONSE_CODES.tds_code(id: '11')
+tds_code.reason #=> "Niepowodzenie autoryzacji karty"
+
 # these can always be overridden
 code = ISSUER_RESPONSE_CODES.code(id: '43', locale: :en, target: :merchant, fraud_notice: false)
 code.reason #=> "Stolen card."

data/lib/issuer_response_codes.rb

@@ -4,6 +4,7 @@ require "issuer_response_codes/version"
 require "issuer_response_codes/locale_library"
 require "issuer_response_codes/context"
 require "issuer_response_codes/code"
+require "issuer_response_codes/tds_code"
 
 module IssuerResponseCodes
   class IllegalTarget < StandardError; end

data/lib/issuer_response_codes/code.rb

@@ -32,9 +32,15 @@ module IssuerResponseCodes
       LOCALE_LIBRARY.dig(path: id, scope: "issuer_response_codes.targeted.#{target}", locale: locale, default: :unknown)
     end
 
+    def fraudulent_code?
+      @fraudulent_code ||= LOCALE_LIBRARY.dig(path: id, scope: "issuer_response_codes.fraudulent_codes", locale: locale)
+    end
+
     def behaviour
-      fraud_notice_str = fraud_notice ? LOCALE_LIBRARY.dig(path: 'issuer_response_codes.fraud_notice') : ''
-      LOCALE_LIBRARY.dig(path: id, substitute: fraud_notice_str, scope: "issuer_response_codes.behaviour", locale: locale, default: :unknown)
+      behaviour_str = LOCALE_LIBRARY.dig(path: id, scope: "issuer_response_codes.behaviour", locale: locale, default: :unknown)
+      return behaviour_str unless fraud_notice && fraudulent_code?
+
+      "#{behaviour_str} #{LOCALE_LIBRARY.dig(path: 'issuer_response_codes.fraud_notice')}"
     end
   end
 end

data/lib/issuer_response_codes/context.rb

@@ -24,5 +24,9 @@ module IssuerResponseCodes
     def code(id:, target: default_target, locale: default_locale, fraud_notice: fraud_notice_by_default)
       Code.new(id: id, target: target, locale: locale, fraud_notice: fraud_notice)
     end
+
+    def tds_code(id:, target: default_target, locale: default_locale, fraud_notice: fraud_notice_by_default)
+      TdsCode.new(id: id, target: target, locale: locale, fraud_notice: fraud_notice)
+    end
   end
 end

data/lib/issuer_response_codes/locale_library.rb

@@ -18,6 +18,7 @@ module IssuerResponseCodes
     def dig(path:, locale: :en, scope: '', default: nil, substitute: '')
       result = __dig__(path: path, locale: locale, scope: scope, default: default)
       return result unless result
+      return result unless result.is_a? ::String
 
       result.gsub(/%{substitute}/, substitute)
     end

data/lib/issuer_response_codes/tds_code.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module IssuerResponseCodes
+  class TdsCode
+    attr_reader :id, :target, :locale, :fraud_notice
+
+    NOT_PROVIDED = ::Object.new
+
+    def initialize(id:, target: :merchant, locale: :en, fraud_notice: NOT_PROVIDED)
+      @id = id
+      @target = target
+      @locale = locale
+
+      raise IllegalLocale, "No such locale: #{locale.inspect}" unless AVAILABLE_LOCALES.include?(locale)
+      raise IllegalTarget, "No such target: #{target.inspect}" unless AVAILABLE_TARGETS.include?(target)
+
+      if fraud_notice != NOT_PROVIDED
+        @fraud_notice = fraud_notice
+        return
+      end
+
+      @fraud_notice = target == :merchant
+    end
+
+    def reason
+      LOCALE_LIBRARY.dig(path: id, scope: "tds_status_codes.targeted.#{target}", locale: locale, default: :unknown)
+    end
+
+    alias humanize reason
+    alias description reason
+
+    def fraudulent_code?
+      @fraudulent_code ||= LOCALE_LIBRARY.dig(path: id, scope: "tds_status_codes.fraudulent_codes", locale: locale)
+    end
+  end
+end

data/lib/issuer_response_codes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IssuerResponseCodes
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/lib/locale/da.yml

@@ -1,41 +1,88 @@
 da:
-  issuer_response_code: &issuer_response_code
-    '00': "En fejl opstod. Transaktionen blev afvist af Elavon på grund af ikke-understøttet korttype eller forkerte kortdata, intet svar fra udsteder / bank eller inaktiv Merchant-konto."
-    '05': "Banken har afvist transaktionen på grund af sikkerhedskontrol (brugt kort understøtter ikke tilbagebetalinger eller betaling uden CVV-kode), midlerne er blevet frosset eller grænsen overskredet, eller kortet understøtter ikke MOTO / internet-transaktioner."
-    '13': "MOTO / eCommerce betalinger på kort er inaktive eller beløbsgrænse overstiger."
-    '14': "Ugyldigt kortnummer."
-    'N7': "Negative CVV / CVC resultater."
-    '51': "Ikke nok penge."
-    '54': "Udgået kort."
-    '57': "Banken har afvist transaktionen, da dette kreditkort ikke kan bruges til denne type transaktion (e-handel, MOTO eller tilbagevendende)."
-    '61': "Banken har afvist transaktionen."
-    '82': "Negative CVV / CVC resultater."
-    # incomplete translations
-    unknown: "Unknown reason."
-    '01': "Authorization Error."
-    '02': "Authorization Error."
-    '03': "Authorization Error."
-    '12': "No privileges to execute this transaction for your card."
-    '30': "Your bank has declined this transaction"
-    '58': "Your bank has declined this transaction as this credit card cannot be used for this type of transaction (eccommerce, MOTO or recurring)."
-    '59': "Your bank has declined this transaction"
-    '62': "Your card can be not supported due to restrictions placed on the card or Seller country exclusion (imposition an embargo), or bank blocked a card eg. due to unacceptable debit balance."
-    '65': "Activity count limit exceeded."
-    '75': "Invalid activity count limit exceeded."
-    '78': "Inactive card."
-    '91': "Temporary issuer error."
-    '92': "Temporary issuer error."
-    '94': "Temporary issuer error."
-    '96': "Temporary issuer error."
-    '98': "Temporary issuer error."
-    'E3': "Transaction not executed due to a 3D-Secure error."
-    'E4': "Transaction not executed due to a negative 3D-Secure confirmation from your bank."
-    'E5': "Temporary 3D-Secure error."
-    'R0': "Refused by Issuer because Customer requested stop of specific recurring payments."
-    'R1': "Refused by Issuer because Customer requested stop of all recurring payments."
+  tds_status_codes:
+    fraudulent_codes:
+      '09': true
+      '10': true
+      '11': true
+    universal: &universal_tds_status_codes
+      unknown: "Unknown reason."
+      '01': Card authentication failed
+      '02': Unknown Device
+      '03': Unsupported Device
+      '04': Exceeds authentication frequency limit
+      '05': Expired card
+      '06': Invalid card number
+      '07': Invalid transaction
+      '08': No Card record
+      '12': Transaction not permitted to cardholder
+      '13': Cardholder not enrolled in service
+      '14': Transaction timed out at the ACS
+      '15': Low confidence
+      '16': Medium confidence
+      '17': High confidence
+      '18': Very High confidence
+      '19': Exceeds ACS maximum challenges
+      '20': Non-Payment transaction not supported
+      '21': 3RI transaction not supported
+      '22': ACS technical issue
+      '23': Decoupled Authentication required by ACS but not requested by 3DS Requestor
+      '24': 3DS Requestor Decoupled Max Expiry Time exceeded
+      '25': Decoupled Authentication was provided insufficient time to authenticate cardholder. ACS will not make attempt
+      '26': Authentication attempted but not performed by the cardholder
+
+    targeted:
+      cardholder:
+        <<: *universal_tds_status_codes
+        '09': Card authentication failed # Security failure
+        '10': Card authentication failed # Stolen card
+        '11': Card authentication failed # Suspected fraud
+      merchant:
+        <<: *universal_tds_status_codes
+        '09': Security failure
+        '10': Stolen card
+        '11': Suspected fraud
   issuer_response_codes:
     suggestion: 'Suggestion'
     fraud_notice: 'IMPORTANT NOTICE: It is forbidden to retry transactions that ended with this code. It may be recognized as a fraud attempt!'
+    fraudulent_codes:
+      '04': true
+      '07': true
+      '41': true
+      '43': true
+    universal: &issuer_response_code
+      '00': "En fejl opstod. Transaktionen blev afvist af Elavon på grund af ikke-understøttet korttype eller forkerte kortdata, intet svar fra udsteder / bank eller inaktiv Merchant-konto."
+      '05': "Banken har afvist transaktionen på grund af sikkerhedskontrol (brugt kort understøtter ikke tilbagebetalinger eller betaling uden CVV-kode), midlerne er blevet frosset eller grænsen overskredet, eller kortet understøtter ikke MOTO / internet-transaktioner."
+      '13': "MOTO / eCommerce betalinger på kort er inaktive eller beløbsgrænse overstiger."
+      '14': "Ugyldigt kortnummer."
+      'N7': "Negative CVV / CVC resultater."
+      '51': "Ikke nok penge."
+      '54': "Udgået kort."
+      '57': "Banken har afvist transaktionen, da dette kreditkort ikke kan bruges til denne type transaktion (e-handel, MOTO eller tilbagevendende)."
+      '61': "Banken har afvist transaktionen."
+      '82': "Negative CVV / CVC resultater."
+      # incomplete translations
+      unknown: "Unknown reason."
+      '01': "Authorization Error."
+      '02': "Authorization Error."
+      '03': "Authorization Error."
+      '12': "No privileges to execute this transaction for your card."
+      '30': "Your bank has declined this transaction"
+      '58': "Your bank has declined this transaction as this credit card cannot be used for this type of transaction (eccommerce, MOTO or recurring)."
+      '59': "Your bank has declined this transaction"
+      '62': "Your card can be not supported due to restrictions placed on the card or Seller country exclusion (imposition an embargo), or bank blocked a card eg. due to unacceptable debit balance."
+      '65': "Activity count limit exceeded."
+      '75': "Invalid activity count limit exceeded."
+      '78': "Inactive card."
+      '91': "Temporary issuer error."
+      '92': "Temporary issuer error."
+      '94': "Temporary issuer error."
+      '96': "Temporary issuer error."
+      '98': "Temporary issuer error."
+      'E3': "Transaction not executed due to a 3D-Secure error."
+      'E4': "Transaction not executed due to a negative 3D-Secure confirmation from your bank."
+      'E5': "Temporary 3D-Secure error."
+      'R0': "Refused by Issuer because Customer requested stop of specific recurring payments."
+      'R1': "Refused by Issuer because Customer requested stop of all recurring payments."
     behaviour:
       '00': "Prøv igen senere, kontakt med sælger eller med Espago Support Team."
       '05': "Tjek venligst dine kortindstillinger for disse transaktionstyper eller brug et andet kort."
@@ -52,12 +99,12 @@ da:
       '01': "Please contact your card issuer."
       '02': "Please contact your card issuer."
       '03': "Please contact your card issuer and try again later."
-      '04': "Please contact your card issuer and try again later. %{substitute}"
-      '07': "Please contact your card issuer and try again later. %{substitute}"
+      '04': "Please contact your card issuer and try again later."
+      '07': "Please contact your card issuer and try again later."
       '12': "Please contact your card issuer to get more details and try again later."
       '30': "Please contact your card issuer to get more details and try again later."
-      '41': "Please contact your card issuer to get more details and try again later. %{substitute}"
-      '43': "Please contact your card issuer to get more details and try again later. %{substitute}"
+      '41': "Please contact your card issuer to get more details and try again later."
+      '43': "Please contact your card issuer to get more details and try again later."
       '58': "Please check your card settings for those transaction types or use another card."
       '59': "Please contact your card issuer to get more details and try again later."
       '62': "Please contact your bank."