issuer_response_codes 0.3.7 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bc4e1b8a160a64776abb07ddfc9e6e303d1f416016913facecee904bb5a4930
-  data.tar.gz: 6bcded80e49b8d7b61500ae22cdc8e990b3fb5366385d4cb4bc0734f541cf445
+  metadata.gz: 57404d70d3b177d54e041082138e0f1da68ece526c641996261937c29eb3b963
+  data.tar.gz: 347d34412b0c749eeea51a2d9024ccd2a6136fa98e8b74803113e7a9c45ebc65
 SHA512:
-  metadata.gz: 3883cab065670e35974a7125b78dff2bf12656693f5480f1c8e2799e040ea66be1823190d235f994953f22850a25c32d50d82501e0880f976543ac9401abe74f
-  data.tar.gz: 48c676af13dad28573a02b635e48c002933d4b71f9bcf6adecf39d840f52c2b3bebe6e19b1189440b685b31e10cfb2da3b929c3c230d054a6050efa9cb6fb9c0
+  metadata.gz: aaf9ece885f836b2bf9966273ac29f0eec1627f2d0f553e71208bc8867c9dcfae18576035618cafb3e7142940faf5e090376a6df1bec8b1a30fb0db4a9c3f825
+  data.tar.gz: 2dc3085345ebd7b9643171c92924607d1666c490fea2396b3381a709390b1714b7e41705eac30021c988eaac57613981c1207894d0aa1ed77a24c7ed0c71e63f

data/.github/workflows/ci.yml

@@ -13,7 +13,7 @@ jobs:
       CI: true
     strategy:
       matrix:
-        ruby-version: ['3.1', '3.2', '3.3', '3.4']
+        ruby-version: ['3.2', '3.3', '3.4']
     steps:
       - name: Checkout code
         uses: actions/checkout@v3

data/.rubocop.yml

@@ -1,5 +1,33 @@
 inherit_gem:
-  rubocop-espago: rubocop.yml
+  rubocop-espago: sorbet.yml
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.2
+
+Sorbet/EnforceSignatures:
+  Enabled: false
+
+Layout/LeadingCommentSpace:
+  Enabled: false
+
+Sorbet/HasSigil:
+  AutoCorrect: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Lint/EmptyWhen:
+  Enabled: false
+
+Style/ArrayFirstLast:
+  Enabled: false
+
+Style/FetchEnvVar:
+  Enabled: false
+
+Sorbet/ForbidSig:
+  Enabled: false
+
+Style/ImplicitRuntimeError:
+  Enabled: false
+

data/.ruby-version

@@ -1 +1 @@
-3.4.3
+3.4.4

data/CHANGELOG.md

@@ -5,9 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.9] - 2025.06.25
+
+- Add sorbet
+- Remove support for Ruby 3.1 and 3.2
+- Add `IssuerResponseCodes::Code#behaviour_code`
+
+## [0.3.8] - 2025.05.05
+
+Add `cs`, `sk`, `hu` translations.
+
 ## [0.3.7] - 2025.04.28
 
-Update the 82 issuer response code to be suitable for Mastercard.
+Update the `82` issuer response code to be suitable for Mastercard.
 
 [Diff](https://github.com/espago/issuer_response_codes/compare/v0.3.6...espago:issuer_response_codes:v0.3.7)
 

data/Gemfile

@@ -5,9 +5,12 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in issuer_response_codes.gemspec
 gemspec
 
-gem 'bundler', '~> 2.0' # library manager
-gem 'debug', '~> 1.6.3' # debugger
-gem 'minitest', '~> 5.0' # test framework
-gem 'rake', '~> 12.0' # automation
-gem 'rubocop', '~> 1.54' # linter
-gem 'rubocop-espago', '~> 1.0' # linter config
+gem 'bundler', '~> 2.6' # library manager
+gem 'byebug', '~> 12.0' # debugger
+gem 'minitest', '~> 5.25' # test framework
+gem 'rake', '~> 12.3' # automation
+gem 'rubocop', '~> 1.77' # linter
+gem 'rubocop-espago', '~> 1.1' # linter config
+gem 'rubocop-sorbet', '~> 0.10' # linter config for sorbet
+gem 'sorbet', '~> 0.5' # static typechecker
+gem 'tapioca', '~> 0.17', require: false # RBI generator

data/Gemfile.lock

@@ -1,45 +1,40 @@
 PATH
   remote: .
   specs:
-    issuer_response_codes (0.3.7)
+    issuer_response_codes (0.3.9)
+      sorbet-runtime (~> 0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.3)
-    date (3.4.1)
-    debug (1.6.3)
-      irb (>= 1.3.6)
-      reline (>= 0.3.1)
-    io-console (0.8.0)
-    irb (1.15.2)
-      pp (>= 0.6.0)
-      rdoc (>= 4.0.0)
-      reline (>= 0.4.2)
-    json (2.11.3)
-    language_server-protocol (3.17.0.4)
+    benchmark (0.4.1)
+    byebug (12.0.0)
+    erubi (1.13.1)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
+    logger (1.7.0)
     minitest (5.25.5)
+    netrc (0.11.0)
     parallel (1.27.0)
     parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
-    pp (0.6.2)
-      prettyprint
-    prettyprint (0.2.0)
     prism (1.4.0)
-    psych (5.2.3)
-      date
-      stringio
     racc (1.8.1)
     rainbow (3.1.1)
     rake (12.3.3)
-    rdoc (6.13.1)
-      psych (>= 4.0.0)
+    rbi (0.3.6)
+      prism (~> 1.0)
+      rbs (>= 3.4.4)
+    rbs (4.0.0.dev.4)
+      logger
+      prism (>= 1.3.0)
     regexp_parser (2.10.0)
-    reline (0.6.1)
-      io-console (~> 0.5)
-    rubocop (1.75.3)
+    require-hooks (0.2.2)
+    rexml (3.4.1)
+    rubocop (1.77.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -47,31 +42,69 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.44.0, < 2.0)
+      rubocop-ast (>= 1.45.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.44.1)
+    rubocop-ast (1.45.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-espago (1.1.8)
       rubocop
+    rubocop-sorbet (0.10.5)
+      lint_roller
+      rubocop (>= 1.75.2)
     ruby-progressbar (1.13.0)
-    stringio (3.1.7)
+    sorbet (0.5.12201)
+      sorbet-static (= 0.5.12201)
+    sorbet-runtime (0.5.12201)
+    sorbet-static (0.5.12201-universal-darwin)
+    sorbet-static (0.5.12201-x86_64-linux)
+    sorbet-static-and-runtime (0.5.12201)
+      sorbet (= 0.5.12201)
+      sorbet-runtime (= 0.5.12201)
+    spoom (1.7.4)
+      erubi (>= 1.10.0)
+      prism (>= 0.28.0)
+      rbi (>= 0.3.3)
+      rbs (>= 4.0.0.dev.4)
+      rexml (>= 3.2.6)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
+    tapioca (0.17.4)
+      benchmark
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (>= 0.3.1)
+      require-hooks (>= 0.2.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.7.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.3.2)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
+    yard (0.9.37)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
 
 PLATFORMS
-  ruby
+  arm64-darwin-24
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 2.0)
-  debug (~> 1.6.3)
+  bundler (~> 2.6)
+  byebug (~> 12.0)
   issuer_response_codes!
-  minitest (~> 5.0)
-  rake (~> 12.0)
-  rubocop (~> 1.54)
-  rubocop-espago (~> 1.0)
+  minitest (~> 5.25)
+  rake (~> 12.3)
+  rubocop (~> 1.77)
+  rubocop-espago (~> 1.1)
+  rubocop-sorbet (~> 0.10)
+  sorbet (~> 0.5)
+  tapioca (~> 0.17)
 
 BUNDLED WITH
-   2.6.8
+   2.6.9

data/README.md

@@ -12,6 +12,11 @@ This gem provides a quite comprehensive library of Issuer Response Code and 3D-S
   - it
   - nl
   - pt
+  - uk
+  - ja
+  - cs
+  - sk
+  - hu
 
 - Incomplete locales:
   - da

data/bin/tapioca

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

data/bin/test

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle exec rubocop
+bundle exec rake test

data/issuer_response_codes.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
     'A simple Ruby gem which provides Issuer Response Code descriptions and suggestions for cardholders and merchants'
   spec.homepage      = 'https://github.com/espago/issuer_response_codes'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.2')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/espago/issuer_response_codes'
@@ -27,4 +27,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
   spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.add_dependency 'sorbet-runtime', '~> 0.5'
 end

data/lib/issuer_response_codes/code/behaviour/dsl.rb

@@ -0,0 +1,45 @@
+# typed: true
+# frozen_string_literal: true
+
+module IssuerResponseCodes
+  class Code
+    class Behaviour # rubocop:disable Style/StaticClass,Style/Documentation
+      @map = {} #: Hash[String, Symbol]
+
+      class << self
+        #: (Array[String]) -> void
+        def abort_behaviour(codes)
+          behaviour(:abort, codes)
+        end
+
+        #: (Array[String]) -> void
+        def retry_later_behaviour(codes)
+          behaviour(:retry_later, codes)
+        end
+
+        #: (Array[String]) -> void
+        def sca_required_behaviour(codes)
+          behaviour(:sca_required, codes)
+        end
+
+        #: (Array[String]) -> void
+        def invalid_card_behaviour(codes)
+          behaviour(:invalid_card, codes)
+        end
+
+        #: (Array[String]) -> void
+        def invalid_amount_behaviour(codes)
+          behaviour(:invalid_amount, codes)
+        end
+
+        #: (Symbol, Array[String]) -> void
+        def behaviour(type, codes)
+          codes.each do |code|
+            @map[code] = type
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/issuer_response_codes/code/behaviour.rb

@@ -0,0 +1,25 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative 'behaviour/dsl'
+
+module IssuerResponseCodes
+  class Code
+    # Defines behaviour codes for issuer response codes
+    class Behaviour
+      class << self
+        #: (String) -> Symbol
+        def [](code)
+          @map.fetch(code, :retry)
+        end
+
+      end
+
+      abort_behaviour %w[46 R0 R1 R3 B1A B04 B14 B15 B41 B43 B54 B65]
+      retry_later_behaviour %w[22 24 25 26 81 84 00 E3 E4 E5 Q2 91]
+      sca_required_behaviour %w[1A 65 O5]
+      invalid_card_behaviour %w[04 07 12 14 15 41 43 57]
+      invalid_amount_behaviour %w[61 13]
+    end
+  end
+end

data/lib/issuer_response_codes/code.rb

@@ -1,18 +1,27 @@
+# typed: true
 # frozen_string_literal: true
 
+require_relative 'code/behaviour'
+
 module IssuerResponseCodes
   # ISO-8583 Response code.
   class Code
-    attr_reader :id, :target, :locale, :fraud_notice
+    #: String
+    attr_reader :id
+    #: Symbol
+    attr_reader :target
+    #: Symbol
+    attr_reader :locale
+    #: bool
+    attr_reader :fraud_notice
+
+    FRAUDULENT_IDS = %w[04 B04 07 12 14 B14 15 B15 41 B41 43 B43 54 B54 57 59 63 R0 R1 R3].to_set #: Set[String]
 
-    NOT_PROVIDED = ::Object.new
+    NOT_PROVIDED = ::Object.new #: as untyped
 
-    # @param id [String]
-    # @param target [Symbol]
-    # @param locale [Symbol]
-    # @param fraud_notice [Boolean, Object]
+    #: (id: String | Symbol, ?target: Symbol, ?locale: Symbol, ?fraud_notice: bool) -> void
     def initialize(id:, target: :merchant, locale: :en, fraud_notice: NOT_PROVIDED)
-      @id = id
+      @id = id.to_s
       @target = target
       @locale = locale
 
@@ -24,37 +33,47 @@ module IssuerResponseCodes
         return
       end
 
-      @fraud_notice = target == :merchant
+      @fraud_notice = target == :merchant #: bool
     end
 
-    # @return [String]
+    #: -> String
     def humanize
       "#{reason} #{behaviour}"
     end
     alias description humanize
 
-    # @return [String]
+    #: -> String
     def reason
-      LOCALE_LIBRARY[path:    id,
-                     scope:   "issuer_response_codes.targeted.#{target}",
-                     locale:  locale,
-                     default: :unknown]
+      LOCALE_LIBRARY[
+        path:    id,
+        scope:   "issuer_response_codes.targeted.#{target}",
+        locale:  locale,
+        default: :unknown,
+      ]
     end
 
-    # @return [String]
+    #: -> String
     def behaviour
-      behaviour_str = LOCALE_LIBRARY[path:    id,
-                                     scope:   'issuer_response_codes.behaviour',
-                                     locale:  locale,
-                                     default: :unknown]
+      behaviour_str = LOCALE_LIBRARY[
+        path:    id,
+        scope:   'issuer_response_codes.behaviour',
+        locale:  locale,
+        default: :unknown,
+      ]
+
       return behaviour_str unless fraud_notice && fraudulent_code?
 
       "#{behaviour_str} #{LOCALE_LIBRARY[path: 'issuer_response_codes.fraud_notice']}"
     end
 
-    # @return [Boolean]
+    #: -> Symbol
+    def behaviour_code
+      Behaviour[id]
+    end
+
+    #: -> bool
     def fraudulent_code?
-      @fraudulent_code ||= LOCALE_LIBRARY[path: id, scope: 'issuer_response_codes.fraudulent_codes', locale: locale]
+      FRAUDULENT_IDS.include?(id)
     end
 
   end

data/lib/issuer_response_codes/context.rb

@@ -1,17 +1,21 @@
+# typed: true
 # frozen_string_literal: true
 
 module IssuerResponseCodes
   # Context stores default settings for retrieving codes.
   class Context
-    attr_reader :default_target, :default_locale, :fraud_notice_by_default
+    #: Symbol
+    attr_reader :default_target
+    #: Symbol
+    attr_reader :default_locale
+    #: bool
+    attr_reader :fraud_notice_by_default
 
-    NOT_PROVIDED = ::Object.new
+    NOT_PROVIDED = ::Object.new #: as untyped
 
-    # @param default_target [Symbol]
-    # @param default_locale [Symbol]
-    # @param fraud_notice_by_default [Boolean, Object]
     # @raise [IllegalLocale]
     # @raise [IllegalTarget]
+    #: (?default_target: Symbol, ?default_locale: Symbol, ?fraud_notice_by_default: bool) -> void
     def initialize(default_target: :merchant, default_locale: :en, fraud_notice_by_default: NOT_PROVIDED)
       @default_target = default_target
       @default_locale = default_locale
@@ -27,20 +31,12 @@ module IssuerResponseCodes
       @fraud_notice_by_default = default_target == :merchant
     end
 
-    # @param id [String, Symbol]
-    # @param target [Symbol]
-    # @param locale [Symbol]
-    # @param fraud_notice [Boolean, Object]
-    # @return [Code]
+    #: (id: String | Symbol, ?target: Symbol, ?locale: Symbol, ?fraud_notice: bool) -> Code
     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
 
-    # @param id [String, Symbol]
-    # @param target [Symbol]
-    # @param locale [Symbol]
-    # @param fraud_notice [Boolean, Object]
-    # @return [TdsCode]
+    #: (id: String | Symbol, ?target: Symbol, ?locale: Symbol, ?fraud_notice: bool) -> TdsCode
     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

data/lib/issuer_response_codes/locale_library.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'yaml'
@@ -7,6 +8,7 @@ module IssuerResponseCodes
   class LocaleLibrary
     attr_reader :locale_hash
 
+    #: -> void
     def initialize
       @locale_hash = {}
 
@@ -15,20 +17,14 @@ module IssuerResponseCodes
       end
     end
 
-    # @param path [String]
-    # @param locale [Symbol]
-    # @param scope [String]
-    # @param default [Symbol, String, nil]
-    # @return [String, Hash, nil]
+    #: (path: String | Symbol, ?locale: Symbol, ?scope: String, ?default: Symbol | String?) -> untyped
     def dig(path:, locale: :en, scope: '', default: nil)
       __dig__(path: path, locale: locale, scope: scope, default: default)
     end
     alias [] dig
 
-    # @param locale [Symbol]
-    # @return [Hash{SYmbol => Hash{Symbol => Object}}]
+    #: (?locale: Symbol) -> Hash[Symbol, Hash[Symbol, untyped]]
     def issuer_response_codes(locale: :en)
-      fraudulent_codes = locale_hash.dig(locale, :issuer_response_codes, :fraudulent_codes)
       behaviours = locale_hash.dig(locale, :issuer_response_codes, :behaviour)
       cardholder_reasons = locale_hash.dig(locale, :issuer_response_codes, :targeted, :cardholder)
       merchant_reasons = locale_hash.dig(locale, :issuer_response_codes, :targeted, :merchant)
@@ -40,16 +36,14 @@ module IssuerResponseCodes
             merchant_reason:   merchant_reason,
             cardholder_reason: cardholder_reasons[code],
             behaviour:         behaviours[code],
-            fraudulent:        fraudulent_codes[code] == true,
+            fraudulent:        Code::FRAUDULENT_IDS.include?(code.to_s),
           },
         ]
       end
     end
 
-    # @param locale [Symbol]
-    # @return [Hash{Symbol => Hash{Symbol => Object}}]
+    #: (?locale: Symbol) -> Hash[Symbol, Hash[Symbol, untyped]]
     def tds_codes(locale: :en)
-      fraudulent_codes = locale_hash.dig(locale, :tds_status_codes, :fraudulent_codes)
       behaviours = locale_hash.dig(locale, :tds_status_codes, :behaviour)
       cardholder_reasons = locale_hash.dig(locale, :tds_status_codes, :targeted, :cardholder)
       merchant_reasons = locale_hash.dig(locale, :tds_status_codes, :targeted, :merchant)
@@ -61,7 +55,7 @@ module IssuerResponseCodes
             merchant_reason:   merchant_reason,
             cardholder_reason: cardholder_reasons[code],
             behaviour:         behaviours[code],
-            fraudulent:        fraudulent_codes[code] == true,
+            fraudulent:        TdsCode::FRAUDULENT_IDS.include?(code.to_s),
           },
         ]
       end
@@ -69,11 +63,7 @@ module IssuerResponseCodes
 
     private
 
-    # @param path [String]
-    # @param locale [Symbol]
-    # @param scope [String]
-    # @param default [Symbol, String, nil]
-    # @return [String, Hash, nil]
+    #: (path: String | Symbol, ?locale: Symbol, ?scope: String, ?default: Symbol | String?) -> untyped
     def __dig__(path:, locale: :en, scope: '', default: nil)
       result = dig_provided_path(path, scope, locale)
       return result if result || !default
@@ -83,10 +73,6 @@ module IssuerResponseCodes
       dig_provided_path(default.to_s, scope, locale)
     end
 
-    # @param path [String]
-    # @param locale [Symbol]
-    # @param scope [String]
-    # @return [String, Hash, nil]
     def dig_provided_path(path, scope, locale)
       return if path.nil? || path.empty?
 
@@ -97,8 +83,7 @@ module IssuerResponseCodes
       locale_hash.dig(*full_path_array)
     end
 
-    # @param name [Symbol, String]
-    # @return [void]
+    #: (Symbol | String) -> void
     def load_locale(name)
       raw_hash = load_yaml(::File.join(::File.dirname(::File.expand_path(__FILE__)), "../locale/#{name}.yml"))
       name = name.to_sym
@@ -106,9 +91,8 @@ module IssuerResponseCodes
       @locale_hash[name] = raw_hash[name]
     end
 
-    if ::Psych::VERSION > '4'
-      # @param file_path [String]
-      # @return [Hash{Symbol => Object}]
+    if ::Psych::VERSION > T.unsafe('4') # rubocop:disable Sorbet/ForbidTUnsafe,Style/YodaCondition
+      #: (String) -> Hash[Symbol, untyped]
       def load_yaml(file_path)
         ::YAML.load_file(
           file_path,
@@ -117,8 +101,7 @@ module IssuerResponseCodes
         )
       end
     else
-      # @param file_path [String]
-      # @return [Hash{Symbol => Object}]
+      #: (String) -> Hash[Symbol, untyped]
       def load_yaml(file_path)
         ::YAML.load_file(
           file_path,