issuer_response_codes 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37ba4c8ea618ac92cad2812d33718b65dc667a9cd33c74f9022682490c6c262a
-  data.tar.gz: ce06e7107a1138c0c681a78bf03e8336eaa5ef9745c58c9781dedf221e1b9c14
+  metadata.gz: 78eac7a89806d60339f0ef7f789ed08b60a6fb675e651e620cd51e3de49dbcfe
+  data.tar.gz: 6b48a34c1925e916cc67a6c29cc4857104e7e34081588f49035294024b383d8c
 SHA512:
-  metadata.gz: fc4cc8e087f2c0b4d44a14de3cb4ba06b171880fe0a77ed65677fea7d8b26ebbb4a6ec3e53e55ca41ff3c71e131cc59c4f00a3f66356a97f24fd995bc098c5fd
-  data.tar.gz: dde8649dc04e1243d070774403c28697b4e0cdd33ebbc8f8b37f8ed6cafbe16b134fdb9c38cc54c96863bcdc7b33c94357360d4b846ea8eae30973e8cee62454
+  metadata.gz: bce421e3c6b41c00929a3bd71756b28d4002707dbc4ff2bc65c284a2055fe548b5b855492d7dbfbffdc9651b2527f7d903d6c654bca7327556ca2792899226db
+  data.tar.gz: 73cc431569db42ccae5f0c899858af55eb04719964525f8b648c759fac085e2e5f23f2475ecce812c421ff1f833dcf20de28fb97412587f23be11533ba5b6593

data/.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: CI Ruby
+
+on:
+  push:
+    branches: [ 'main' ]
+  pull_request:
+    branches: [ 'main' ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run unit tests
+        run: bundle exec rake test
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Lint
+        run: bundle exec rubocop --parallel --color

data/.rubocop.yml

@@ -1,78 +1,5 @@
-Style/StringLiterals:
-  Enabled: false
-
-Style/SingleArgumentDig:
-  Enabled: false
-
-Layout/LineLength:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/MethodCallWithArgsParentheses:
-  Enabled: false
-
-Style/ModuleFunction:
-  EnforcedStyle: 'extend_self'
-
-Style/MissingElse:
-  Enabled: false
-
-Lint/NumberConversion:
-  Enabled: false
-
-Lint/ConstantResolution:
-  Enabled: false
-
-Style/RescueStandardError:
-  Enabled: false
-
-Style/FormatStringToken:
-  Enabled: false
-
-Style/FormatString:
-  Enabled: false
-
-Style/DocumentationMethod:
-  Enabled: false
-
-Style/Copyright:
-  Enabled: false
-
-Style/StringHashKeys:
-  Enabled: false
-
-Style/InlineComment:
-  Enabled: false
-
-Layout/FirstHashElementLineBreak:
-  Enabled: false
-
-Layout/FirstMethodArgumentLineBreak:
-  Enabled: false
-
-Style/ConstantVisibility:
-  Enabled: false
-
-Layout/FirstArrayElementLineBreak:
-  Enabled: false
-
-Layout/MultilineMethodArgumentLineBreaks:
-  Enabled: false
-
-Layout/MultilineAssignmentLayout:
-  Enabled: false
-
-Bundler/GemComment:
-  Enabled: false
+inherit_gem:
+  rubocop-espago: rubocop.yml
 
 AllCops:
-  EnabledByDefault: true
-  Exclude:
-    - 'bin/*'
-    - 'spec/**/*'
-    - 'test/**/*'
+  TargetRubyVersion: 3.0

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+3.1.4

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+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.0]
+
+[Diff](https://github.com/espago/issuer_response_codes/compare/v0.3.0...espago:issuer_response_codes:v0.2.5)
+
+This release adds support for Ruby 3.1 and 3.2 and full translations for brand new languages: `:es, :fi, :fr, :hr, :it, :nl, :pt`.

data/Gemfile

@@ -1,6 +1,14 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+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 'solargraph', '~> 0.49' # language server

data/Gemfile.lock

@@ -1,84 +1,97 @@
 PATH
   remote: .
   specs:
-    issuer_response_codes (0.2.5)
+    issuer_response_codes (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.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)
+    benchmark (0.2.1)
+    debug (1.6.3)
+      irb (>= 1.3.6)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
     e2mmap (0.1.0)
-    jaro_winkler (1.5.4)
-    kramdown (2.3.1)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    jaro_winkler (1.5.6)
+    json (2.6.3)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    mini_portile2 (2.5.3)
-    minitest (5.14.4)
-    nokogiri (1.11.7)
-      mini_portile2 (~> 2.5.0)
+    language_server-protocol (3.17.0.3)
+    mini_portile2 (2.8.4)
+    minitest (5.18.1)
+    nokogiri (1.15.3)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    racc (1.5.2)
-    rainbow (3.0.0)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (2.1.1)
-    reverse_markdown (2.0.0)
+    rbs (2.8.4)
+    regexp_parser (2.8.1)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.5)
-    rubocop (1.18.2)
+    rubocop (1.54.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    solargraph (0.42.3)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-espago (1.0.3)
+      rubocop
+    ruby-progressbar (1.13.0)
+    solargraph (0.49.0)
       backport (~> 1.2)
       benchmark
-      bundler (>= 1.17.2)
+      bundler (~> 2.0)
       diff-lcs (~> 1.4)
       e2mmap
       jaro_winkler (~> 1.5)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.1)
       parser (~> 3.0)
-      reverse_markdown (>= 1.0.5, < 3)
-      rubocop (>= 0.52)
+      rbs (~> 2.0)
+      reverse_markdown (~> 2.0)
+      rubocop (~> 1.38)
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
-    thor (1.1.0)
-    tilt (2.0.10)
-    unicode-display_width (2.0.0)
-    yard (0.9.26)
+    thor (1.2.2)
+    tilt (2.2.0)
+    unicode-display_width (2.4.2)
+    yard (0.9.34)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
-  bundler-audit
-  byebug
+  bundler (~> 2.0)
+  debug (~> 1.6.3)
   issuer_response_codes!
   minitest (~> 5.0)
   rake (~> 12.0)
-  rubocop
-  solargraph
+  rubocop (~> 1.54)
+  rubocop-espago (~> 1.0)
+  solargraph (~> 0.49)
 
 BUNDLED WITH
-   2.1.4
+   2.4.17

data/README.md

@@ -4,12 +4,18 @@ This gem provides a quite comprehensive library of Issuer Response Code and 3D-S
 - Complete locales:
   - en
   - pl
+  - es
+  - fi
+  - fr
+  - hr
+  - it
+  - nl
+  - pt
 
 - Incomplete locales:
   - da
   - de
   - ee
-  - it
   - lt
   - lv
   - sv

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "issuer_response_codes"
+require 'bundler/setup'
+require 'issuer_response_codes'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,7 @@ require "issuer_response_codes"
 # require "pry"
 # Pry.start
 
-require "irb"
-IRB.start(__FILE__)
+include ::IssuerResponseCodes
+
+require 'irb'
+::IRB.start(__FILE__)

data/issuer_response_codes.gemspec

@@ -3,34 +3,28 @@
 require_relative 'lib/issuer_response_codes/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "issuer_response_codes"
+  spec.name          = 'issuer_response_codes'
   spec.version       = IssuerResponseCodes::VERSION
-  spec.authors       = ["Espago", "Mateusz Drewniak"]
-  spec.email         = ["m.drewniak@espago.com"]
+  spec.authors       = ['Espago', 'Mateusz Drewniak']
+  spec.email         = ['m.drewniak@espago.com']
 
-  spec.summary       = "Issuer Response Code descriptions for cardholders and merchants"
-  spec.description   = "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(">= 2.5")
+  spec.summary       = 'Issuer Response Code descriptions for cardholders and merchants'
+  spec.description   =
+    '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.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/espago/issuer_response_codes"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/espago/issuer_response_codes'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'bundler-audit'
-  spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'solargraph'
+  spec.require_paths = ['lib']
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/issuer_response_codes/code.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
 module IssuerResponseCodes
+  # ISO-8583 Response code.
   class Code
     attr_reader :id, :target, :locale, :fraud_notice
 
     NOT_PROVIDED = ::Object.new
 
+    # @param id [String]
+    # @param target [Symbol]
+    # @param locale [Symbol]
+    # @param fraud_notice [Boolean, Object]
     def initialize(id:, target: :merchant, locale: :en, fraud_notice: NOT_PROVIDED)
       @id = id
       @target = target
@@ -22,25 +27,35 @@ module IssuerResponseCodes
       @fraud_notice = target == :merchant
     end
 
+    # @return [String]
     def humanize
       "#{reason} #{behaviour}"
     end
-
     alias description humanize
 
+    # @return [String]
     def reason
-      LOCALE_LIBRARY.dig(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]
     def behaviour
-      behaviour_str = LOCALE_LIBRARY.dig(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.dig(path: 'issuer_response_codes.fraud_notice')}"
+      "#{behaviour_str} #{LOCALE_LIBRARY[path: 'issuer_response_codes.fraud_notice']}"
     end
 
+    # @return [Boolean]
     def fraudulent_code?
-      @fraudulent_code ||= LOCALE_LIBRARY.dig(path: id, scope: "issuer_response_codes.fraudulent_codes", locale: locale)
+      @fraudulent_code ||= LOCALE_LIBRARY[path: id, scope: 'issuer_response_codes.fraudulent_codes', locale: locale]
     end
+
   end
 end

data/lib/issuer_response_codes/context.rb

@@ -1,11 +1,17 @@
 # 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
 
     NOT_PROVIDED = ::Object.new
 
+    # @param default_target [Symbol]
+    # @param default_locale [Symbol]
+    # @param fraud_notice_by_default [Boolean, Object]
+    # @raise [IllegalLocale]
+    # @raise [IllegalTarget]
     def initialize(default_target: :merchant, default_locale: :en, fraud_notice_by_default: NOT_PROVIDED)
       @default_target = default_target
       @default_locale = default_locale
@@ -21,10 +27,20 @@ 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]
     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]
     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

@@ -3,6 +3,7 @@
 require 'yaml'
 
 module IssuerResponseCodes
+  # Stores the translations of codes.
   class LocaleLibrary
     attr_reader :locale_hash
 
@@ -14,21 +15,25 @@ module IssuerResponseCodes
       end
     end
 
-    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)
+    # @param path [String]
+    # @param locale [Symbol]
+    # @param scope [String]
+    # @param default [Symbol, String, nil]
+    # @return [String, Hash, nil]
+    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}}]
     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)
 
-      merchant_reasons.map do |code, merchant_reason|
+      merchant_reasons.to_h do |code, merchant_reason|
         [
           code,
           {
@@ -38,16 +43,18 @@ module IssuerResponseCodes
             fraudulent: fraudulent_codes[code] == true
           }
         ]
-      end.to_h
+      end
     end
 
+    # @param locale [Symbol]
+    # @return [Hash{Symbol => Hash{Symbol => Object}}]
     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)
 
-      merchant_reasons.map do |code, merchant_reason|
+      merchant_reasons.to_h do |code, merchant_reason|
         [
           code,
           {
@@ -57,25 +64,16 @@ module IssuerResponseCodes
             fraudulent: fraudulent_codes[code] == true
           }
         ]
-      end.to_h
-    end
-
-    def self.symbolize_keys(hash)
-      h = hash.map do |k, v|
-        v_sym = if v.instance_of? Hash
-                  symbolize_keys(v)
-                else
-                  v
-                end
-
-        [k.to_sym, v_sym]
       end
-
-      h.to_h
     end
 
     private
 
+    # @param path [String]
+    # @param locale [Symbol]
+    # @param scope [String]
+    # @param default [Symbol, String, nil]
+    # @return [String, Hash, nil]
     def __dig__(path:, locale: :en, scope: '', default: nil)
       result = dig_provided_path(path, scope, locale)
       return result if result || !default
@@ -85,6 +83,10 @@ 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?
 
@@ -95,12 +97,35 @@ module IssuerResponseCodes
       locale_hash.dig(*full_path_array)
     end
 
+    # @param name [Symbol, String]
+    # @return [void]
     def load_locale(name)
-      name_str = name.to_s
+      raw_hash = load_yaml(::File.join(::File.dirname(::File.expand_path(__FILE__)), "../locale/#{name}.yml"))
+      name = name.to_sym
 
-      raw_hash = ::YAML.load_file(::File.join(::File.dirname(::File.expand_path(__FILE__)), "../locale/#{name_str}.yml"))[name_str]
-      single_locale_hash = self.class.symbolize_keys(raw_hash)
-      @locale_hash[name] = single_locale_hash
+      @locale_hash[name] = raw_hash[name]
     end
+
+    if ::Psych::VERSION > '4'
+      # @param file_path [String]
+      # @return [Hash{Symbol => Object}]
+      def load_yaml(file_path)
+        ::YAML.load_file(
+          file_path,
+          symbolize_names: true,
+          aliases: true
+        )
+      end
+    else
+      # @param file_path [String]
+      # @return [Hash{Symbol => Object}]
+      def load_yaml(file_path)
+        ::YAML.load_file(
+          file_path,
+          symbolize_names: true
+        )
+      end
+    end
+
   end
 end