issuer_response_codes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7dbb167d16f432e8a8113006dc1d2591b05c96ed6141fc0c1532c9b1e241ebf
+  data.tar.gz: 3b5101d1027157edad887ee134551adffbd8a79210f238230d98091fd2b817df
+SHA512:
+  metadata.gz: 1b4d8a1836429d54ee6ed64f408f3fa6c108047f8266e1f91253e362e7234805ff27f66ccd0ea953cdfe0124f6ec30b903ec74eec4a280e843aef4b0273578b8
+  data.tar.gz: 1fb3f071324d4cdd7d1d63272ac82c86258f4509ba4cf2bf45cdb3245f85bd44ef7ae3ab70036213487dba5f4cbb1da0385ccb1ff9469e7eef185beb73baf396

data/.byebug_history

@@ -0,0 +1,38 @@
+c
+scope.empty?
+scope
+path
+scope
+default_path_array
+default
+exit
+c
+locale_hash.dig(*[:issuer_response_codes, :targeted, :merchant, :"04"])
+locale_hash.dig()
+full_path_array
+result
+c
+ IssuerResponseCodes::LOCALE_LIBRARY.locale[:da]
+ IssuerResponseCodes::LOCALE_LIBRARY.locale
+ IssuerResponseCodes::LOCALE_LIBRARY
+c
+hash
+c
+hash
+c
+exit
+c
+name
+::YAML.load_file("lib/locale/#{name}.yml")
+c
+hash
+exit
+c
+locale_hash.symbolize_keys
+locale_hash
+exit
+ IssuerResponseCodes::LOCALE_LIBRARY
+LOCALE_LIBRARY
+c
+YAML.load_file('lib/locale/da.yml')
+YAML.load_file('locale/da.yml')

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,75 @@
+Style/StringLiterals:
+  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
+
+AllCops:
+  EnabledByDefault: true
+  Exclude:
+    - 'bin/*'
+    - 'spec/**/*'
+    - 'test/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/.vscode/extensions.json

@@ -0,0 +1,12 @@
+{
+  "recommendations": [
+    "codezombiech.gitignore",
+    "yzhang.markdown-all-in-one",
+    "rebornix.ruby",
+    "misogi.ruby-rubocop",
+    "wingrunr21.vscode-ruby",
+    "redhat.vscode-yaml",
+    "castwide.solargraph",
+    "streetsidesoftware.code-spell-checker"
+  ]
+}

data/.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "cSpell.words": [
+    "Espago",
+    "autorun",
+    "bindir",
+    "byebug",
+    "doesnt",
+    "rubygems",
+    "solargraph"
+  ]
+}

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in issuer_response_codes.gemspec
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    issuer_response_codes (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    backport (1.1.2)
+    benchmark (0.1.1)
+    bundler-audit (0.8.0)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    byebug (11.1.3)
+    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)
+    minitest (5.14.4)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    reverse_markdown (2.0.0)
+      nokogiri
+    rexml (3.2.5)
+    rubocop (1.14.0)
+      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)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    solargraph (0.40.4)
+      backport (~> 1.1)
+      benchmark
+      bundler (>= 1.17.2)
+      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)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  bundler-audit
+  byebug
+  issuer_response_codes!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rubocop
+  solargraph
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Espago
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Espago
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,221 @@
+# IssuerResponseCodes
+
+This gem provides a quite comprehensive library of Issuer Response Code descriptions (for both cardholders and merchants) with suggested actions in 7 languages:
+- Complete locales:
+    - en
+    - pl
+
+- Incomplete locales:
+  - da
+  - ee
+  - lt
+  - lv
+  - sv
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'issuer_response_codes'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install issuer_response_codes
+
+### Rails
+
+For Rails projects, we highly encourage you to create a brand new initializer like `config/initializers/issuer_response_codes.rb`. You can then define your own context with the desired default options like so:
+
+```ruby
+# config/initializers/issuer_response_codes.rb
+# frozen_string_literal: true
+
+ISSUER_RESPONSE_CODES = ::IssuerResponseCodes::Context.new(
+    default_target: :merchant,
+    default_locale: :en,
+    fraud_notice_by_default: false # decide whether fraud attempt warnings/notices should
+                                   # be added to code descriptions by default
+)
+```
+
+Afterwards, all Issuer Response Codes you create using this context as a proxy will use these settings by default (You can always override them).
+
+```ruby
+# app/models/some_model.rb
+
+def response_code_description
+    ::ISSUER_RESPONSE_CODES.code(id: '43').description
+    #=> "Stolen card. Please contact your card issuer to get more details and try again later."
+
+    ::ISSUER_RESPONSE_CODES.code(id: '43', fraud_notice: true).description
+    #=>  "Stolen card. Please contact your card issuer to get more details and try again later. IMPORTANT NOTICE: It is forbidden to retry transactions that ended with this code. It may be recognized as a fraud attempt!"
+
+    ::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
+```
+
+## 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.
+
+### IssuerResponseCodes::Code
+#### 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: true
+
+# fraud_notice is set to true by default when target = :merchant
+code = ::IssuerResponseCodes::Code.new(id: '43')
+code.reason #=> "Stolen card."
+code.behaviour #=> "Please contact your card issuer to get more details and try again later. IMPORTANT NOTICE: It is forbidden to retry transactions that ended with this code. It may be recognized as a fraud attempt!"
+
+code = ::IssuerResponseCodes::Code.new(id: '43', target: :merchant)
+code.reason #=> "Stolen card."
+code.behaviour #=> "Please contact your card issuer to get more details and try again later. IMPORTANT NOTICE: It is forbidden to retry transactions that ended with this code. It may be recognized as a fraud attempt!"
+
+# fraud_notice is set to false by default when target = :cardholder
+code = ::IssuerResponseCodes::Code.new(id: '43', target: :cardholder)
+code.reason #=> "Your bank has declined this transaction."
+code.behaviour #=> "Please contact your card issuer to get more details and try again later."
+```
+
+##### Fraud notice
+
+Certain Issuer Response Codes may signify that the transaction may be viewed as a fraud attempt. As such this gem provides appropriate warnings. You can manually decide whether these warnings/notices should be added to descriptions or behaviour suggestions generated by this gem.
+
+By default descriptions targeted at merchants have these warnings, while those targeted at cardholders omit them.
+
+```ruby
+code = ::IssuerResponseCodes::Code.new(id: '43', target: :merchant)
+code.behaviour #=> "Please contact your card issuer to get more details and try again later. IMPORTANT NOTICE: It is forbidden to retry transactions that ended with this code. It may be recognized as a fraud attempt!"
+
+# fraud_notice is set to false by default when target = :cardholder
+code = ::IssuerResponseCodes::Code.new(id: '43', target: :cardholder)
+code.behaviour #=> "Please contact your card issuer to get more details and try again later."
+```
+
+This however can be overridden by explicitly passing the `fraud_notice` keyword parameter
+
+```ruby
+# default options can be overridden
+code = ::IssuerResponseCodes::Code.new(id: '43', target: :merchant, fraud_notice: false)
+code.behaviour #=> "Please contact your card issuer to get more details and try again later."
+
+# fraud_notice is set to false by default when target = :cardholder
+code = ::IssuerResponseCodes::Code.new(id: '43', target: :cardholder, fraud_notice: true)
+code.behaviour #=> "Please contact your card issuer to get more details and try again later. IMPORTANT NOTICE: It is forbidden to retry transactions that ended with this code. It may be recognized as a fraud attempt!"
+```
+
+##### 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::Code.new(id: '54')
+code.reason #=> "Expired card."
+
+code = ::IssuerResponseCodes::Code.new(id: '54', locale: :en)
+code.reason #=> "Expired card."
+
+code = ::IssuerResponseCodes::Code.new(id: '54', locale: :pl)
+code.reason #=> "Karta utraciła ważność."
+```
+
+#### Methods
+
+##### Reason
+
+The `reason` method returns a relatively short description of the main reason why the Issuer Response Code appeared in the first place.
+
+```ruby
+code = ::IssuerResponseCodes::Code.new(id: '14')
+code.reason #=> "Invalid card number."
+
+code = ::IssuerResponseCodes::Code.new(id: '51')
+code.reason #=> "Insufficient funds."
+
+code = ::IssuerResponseCodes::Code.new(id: '59')
+code.reason #=> "Your bank has declined this transaction"
+```
+
+##### Behaviour
+
+The `behaviour` method returns a suggestion of what to do when the Issuer Response Code appeared. Mainly for cardholders.
+
+```ruby
+code = ::IssuerResponseCodes::Code.new(id: '14')
+code.behaviour #=> "Check entered data and try again."
+
+code = ::IssuerResponseCodes::Code.new(id: '51')
+code.behaviour #=> "Please check funds on your account and try again later."
+
+code = ::IssuerResponseCodes::Code.new(id: '59')
+code.behaviour #=> "Please contact your card issuer to get more details and try again later."
+```
+
+##### Description
+
+The `description` method is a combination of both the `reason` and `behaviour` of a Issuer Response Code
+
+```ruby
+code = ::IssuerResponseCodes::Code.new(id: '14')
+code.description #=> "Invalid card number. Check entered data and try again."
+
+code = ::IssuerResponseCodes::Code.new(id: '51')
+code.description #=> "Insufficient funds. Please check funds on your account and try again later."
+
+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."
+```
+
+### 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.
+
+```ruby
+# non-standard default configuration
+ISSUER_RESPONSE_CODES = ::IssuerResponseCodes::Context.new(
+    default_target: :cardholder,
+    default_locale: :pl,
+    fraud_notice_by_default: true  # decide whether fraud attempt warnings/notices should
+                                   # be added to code descriptions by default
+)
+
+# now just use this object as a proxy
+code = ISSUER_RESPONSE_CODE.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!"
+
+# these can always be overridden
+code = ISSUER_RESPONSE_CODE.code(id: '43', locale: :en, target: :merchant, fraud_notice: false)
+code.reason #=> "Stolen card."
+code.behaviour #=> "Please contact your card issuer to get more details and try again later."
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/espago/issuer_response_codes.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).