sepa_reason_codes 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25bec6cda6527936ce1e2818c6b0526bd979ac721a4c7d516686c24fbffd685f
-  data.tar.gz: c39f9d2634c38f54f816e8f0fca87b19606c6588c7fc47184a6ac9d4bdf5f4e0
+  metadata.gz: f830e8f627a2444dd64acc97883e918b8245edabc1ca67c13a3624b0aa34b107
+  data.tar.gz: 9f02bcfc64d59b5874a4afba98c93150460632dbb940a044d623c28eff0789c9
 SHA512:
-  metadata.gz: 62cfaab2e911fa00bbde20e4166cccb5d3d89f59e3f5b4c1ec0955162495f8b4e01bf9dc9ba2acc78b42287f3656f57ff41bfa09c7840cd92c336aa3fc19485a
-  data.tar.gz: f767aa21959fed00112da2cd0eb3bb969b3c8614ef77d3332126254fae8bc841599f13ca2cf5e08c7693cc7b479fd94b87f6e8fbe55f33fa6327da56fa3943b6
+  metadata.gz: 12908a83f48931c05d8393f0c7db8bfe5fe4979aa83a24d47ccb6a99c066c6213c43fe75b9b713f7f96a931b4d73e23f09356d5769baa8ea8cdeae59c7067f38
+  data.tar.gz: 52a240de0c400b16070fb962083817c948aea6c62f890ba4c899bfb218f06ee54438a642bd415b8f9610e3cb8eef254a9f5aa3964aa1100c05714d7b3a1011df

data/.circleci/config.yml

@@ -28,7 +28,7 @@ jobs:
           name: Store bundle cache
           paths:
             - ./vendor/bundle
-          key: hermes-dependencies
+          key: sepa-dependencies
 
       - run:
           name: Rubocop check

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sepa_reason_codes (1.0.0)
+    sepa_reason_codes (1.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,15 +1,18 @@
+[![Gem Version](https://badge.fury.io/rb/sepa_reason_codes.svg)](https://badge.fury.io/rb/sepa_reason_codes)
+[![CircleCI](https://circleci.com/gh/ramblingcode/sepa-reason-codes.svg?style=svg)](https://circleci.com/gh/ramblingcode/sepa-reason-codes)
+
 # SepaReasonCodes
 
-Welcome to SepaReasonCodes! 
+Welcome to SepaReasonCodes!
 
-This is a absolutely minimal gem to work with SEPA Reason Codes.
+It is a minimal Ruby gem to work with SEPA Reason Codes.
 
-`Reason Codes` are used in exception handling in SEPA Direct Debit (SDD). These codes
-indicates reasons for why a transaction failure has happened. You may use this codes if you are parsing bank statements or handling SEPA transactions.
+Reason Codes are used in exception handling in SEPA Direct Debit (SDD). These codes
+indicate reasons for why a transaction failure has happened. You may use these codes if you are parsing bank statements or handling SEPA transactions through an API of some kind of 3rd Party Payment Gateway.
 
-We have created a Ruby package where you may easily access and work with them.
+We have created SepaReasonCodes so you may easily access and work with them.
 
-If you want to know more about them, read more [here](https://www.europeanpaymentscouncil.eu/sites/default/files/kb/file/2018-09/EPC173-14%20v4.1%20Guidance%20on%20Reason%20Codes%20for%20SDD%20R-transactions.pdf)
+If you want to know more about Reason Codes, read [here](https://www.europeanpaymentscouncil.eu/sites/default/files/kb/file/2018-09/EPC173-14%20v4.1%20Guidance%20on%20Reason%20Codes%20for%20SDD%20R-transactions.pdf)
 
 ## Installation
 
@@ -29,7 +32,7 @@ Or install it yourself as:
 
 ## Usage
 
-No magic here! Just pass in the reason code and get back the struct with all required information.
+No magic here! Just pass in the reason code and get back the SepaReasonCodes::Code instance with all required information.
 
 ```ruby
 reason_code = SepaReasonCodes.find("AC01")
@@ -48,7 +51,18 @@ You can also retrieve all Reason Codes by doing:
 SepaReasonCodes.all
 ```
 
-which will return a collection of `ReasonCode` structs.
+which will return a collection of `SepaReasonCodes::Code`.
+
+Equality check has been overwritten and will be checked based on
+attribute values.
+
+```ruby
+reason_code = SepaReasonCodes::Code.find('AC01')
+other_same_reason_code_instance = SepaReasonCodes::Code.find('AC01')
+
+reason_code == other_same_reason_code_instance
+> true
+```
 
 ## Development
 

data/lib/reason_codes.yml

@@ -223,7 +223,7 @@ AM21:
   probable_status: declined
 ARDT:
   code: ARDT
-  iso_name: "-"
+  iso_name: Already returned transaction
   description: Transaction has already been returned
   probable_status: declined
 BE01:
@@ -694,7 +694,7 @@ FF10:
   probable_status: error
 FRAD:
   code: FRAD
-  iso_name: "-"
+  iso_name: Fraudulent Payment
   description: Payment is made with fraudulent intent.
   probable_status: declined
 ID01:
@@ -817,7 +817,7 @@ NOOR:
   probable_status: declined
 PART:
   code: PART
-  iso_name: "-"
+  iso_name: Parial Rejection
   description: Partial rejection of a bulk
   probable_status: declined
 PINL:
@@ -828,7 +828,7 @@ PINL:
   probable_status: declined
 PY01:
   code: PY01
-  iso_name: "-"
+  iso_name: Beneficiary or instructing bank not registered
   description: The transaction cannot be processed because the beneficiary and/or the instructing bank 
     is not registered with the EBA as a direct or indirect participant. (Initiator SEPA Clearer).
   probable_status: declined
@@ -903,7 +903,7 @@ RF01:
   probable_status: declined
 RJCT:
   code: RJCT
-  iso_name: "-"
+  iso_name: Complete Rejection of a bulk
   description: Complete rejection of a bulk
   probable_status: declined
 RR01:
@@ -1011,7 +1011,7 @@ TD03:
   probable_status: declined
 TECH:
   code: TECH
-  iso_name: "-"
+  iso_name: Erroneous credit transfer
   description: Technical problems resulting in erroneous credit transfer
   probable_status: declined
 TM01:
@@ -1036,7 +1036,7 @@ UPAY:
   probable_status: chargeback
 XD19:
   code: XD19
-  iso_name: "-"
+  iso_name: Iban check failed
   description: IBAN check according to ISO 13616 failed (e.g. (DebtorAccount or CreditorAccount are not correct.)
   probable_status: declined
 XD75:
@@ -1046,87 +1046,87 @@ XD75:
   probable_status: error
 XT13:
   code: XT13
-  iso_name: "-"
+  iso_name: Unsupported or missing field
   description: Transaction contains at least one unsupported field. 
     At least one mandatory field is not included in the transaction.
   probable_status: declined
 XT27:
   code: XT27
-  iso_name: "-"
+  iso_name: BIC is not available in SCL directory
   description: Transaction contains at least one element with a BIC that is not
     is available in the SCL directory.
   probable_status: declined
 XT33:
   code: XT33
-  iso_name: "-"
+  iso_name: Faulty format
   description: Content of at least one XML element does not have the required format.
     The faulty XML field is marked with the error code (Initiator SEPA Clearer).
   probable_status: declined
 XT43:
   code: XT43
-  iso_name: "-"
+  iso_name: Type of direct debit differs from the assignment of <Srvcld>
   description: Type of direct debit (CORE7B2B) differs from the assignment of the <Srvcld> 
     in the file header (Initiator SEPA Clearer).
   probable_status: declined
 XT53:
   code: XT53
-  iso_name: "-"
+  iso_name: Faulty Creditor Identifier
   description: Check of the Creditor Indentifier <CdtrSchmeld><Id> with regard to structure/check digit
     failed (initiator SEPA Clearer).
   probable_status: declined
 XT73:
   code: XT73
-  iso_name: "-"
+  iso_name: Invalid country code
   description: Both characters for the country code are not valid ISO or SEPA
     Country code (Initiator SEPA Clearer)
   probable_status: declined
 XT74:
   code: XT74
-  iso_name: "-"
+  iso_name: Faulty original transaction
   description: Faulty underlying original transaction (initiator other
     CSM). Further examination required
   probable_status: declined
 XT75:
   code: XT75
-  iso_name: "-"
+  iso_name: Incorrect status of original transaction
   description: Incorrect status of the underlying original transaction from
     the R message (initiator other CSM). No further actions necessary.
   probable_status: declined
 XT76:
   code: XT76
-  iso_name: "-"
+  iso_name: Invalid error code in Return/Refund
   description: Invalid error code in Return/Refund (Initiator SEPA Clearer)
   probable_status: declined
 XT77:
   code: XT77
-  iso_name: "-"
+  iso_name: <OrgnIIntrBkSttlmAmt> amount paid by other CSM not found or mismatched
   description: The originally commissioned amount <OrgnIIntrBkSttlmAmt> was paid by
     other CSM not found or does not match the amount of the original transaction about
   probable_status: declined
 XT78:
   code: XT78
-  iso_name: "-"
+  iso_name: Faulty or mismatching amount in either <OrgnlIntrBkSttlmAmt>, <CompstnAmt>, <ChrgsInf><Amt>
   description: 'pasc.004.001.01: The amount in <OrgnlIntrBkSttlmAmt> + <CompstnAmt>
     + <ChrgsInf><Amt> must result in the amount in <RtrdIntrBkSttlmAmt> if <CompstnAmt>
     and/or <ChrgsInf><Amt> available (initiator SEPA Clearer).'
   probable_status: declined
 XT79:
   code: XT79
-  iso_name: "-"
+  iso_name: Debtor is not allowed to receive direct debit
   description: The <DbtrAgt> is not allowed to receive direct debits. An
     indirect participants must be allowed to accept direct debits from the clearing system
     (initiator other CSM).
   probable_status: declined
 XT80:
   code: XT80
-  iso_name: "-"
+  iso_name: Creditor is not allowed to send direct debits
   description: The <CdtrAgt> is not allowed to send direct debits. An indirect
     Participant must be allowed to send direct debits to the clearing system
     (initiator other CSM).
   probable_status: declined
 XT81:
   code: XT81
-  iso_name: "-"
+  iso_name: SCT field is not permitted
   description: SCT XML field not permitted in CT service
   probable_status: declined
 XT85:
@@ -1136,7 +1136,7 @@ XT85:
   probable_status: declined
 XT87:
   code: XT87
-  iso_name: "-"
+  iso_name: Invalid SDD R-Msg
   description: SDD R-Msg not following same DP route/ sending DP not identical to
     Instructing / Instructed Agent of the original Transaction
   probable_status: declined
@@ -1147,7 +1147,7 @@ XT90:
   probable_status: declined
 XT99:
   code: XT99
-  iso_name: "-"
+  iso_name: Rejection by SEPA clearer
   description: Rejection of the bank transfer or direct debit or card collection from
     SEPA Clearer for other reasons.
   probable_status: declined

data/lib/sepa_reason_codes.rb

@@ -1,61 +1,61 @@
 # frozen_string_literal: true
 
 require 'sepa_reason_codes/version'
-require 'yaml'
+require 'sepa_reason_codes/code'
 
-# Usage:
-#
-# SepaReasonCodes.find('AC01')
-#
-# @returns ReasonCodeStruct{
-#   code: 'AC01',
-#   iso_name: '',
-#   description: '',
-#   probable_status: ''
-# }
+require 'yaml'
 
 module SepaReasonCodes
   class Error < StandardError; end
 
-  ParsedReasonCodes =
+  PARSED_REASON_CODES =
     YAML.load_file(File.join(__dir__, ['reason_codes.yml'])).freeze
 
-  ReasonCodeStruct =
-    Struct.new(:code, :iso_name, :description, :probable_status)
-
   # @param ~String~ Sepa Reason Code; Case insensitive
   # Read more at : https://www.hettwer-beratung.de/sepa-spezialwissen/sepa-reason-codes/
 
   # Parses lib/reason_codes.yml, retrieves and
-  # returns ReasonCode Struct with accessors
+  # returns SepaReasonCodes::Code with accessors
   # code, iso_name, description, probable_status
 
+  # Usage:
+  #
+  # SepaReasonCodes.find('AC01')
+  #
+  # @returns SepaReasonCodes::Code{
+  #   code: 'AC01',
+  #   iso_name: '...',
+  #   description: '...',
+  #   probable_status: '...'
+  # }
+
   def self.find(code)
-    reason_code =
-      ParsedReasonCodes.fetch(code&.upcase, nil)
+    reason_code_data = PARSED_REASON_CODES.fetch(code&.upcase, nil)
 
-    return unless reason_code
+    return unless reason_code_data
 
-    reason_code_struct(reason_code)
+    reason_code(reason_code_data)
   end
 
-  # @returns collection [reason_code]
+  # @returns collection [SepaReasonCodes::Code]
 
   def self.all
-    ParsedReasonCodes.values.map do |reason_code|
-      reason_code_struct(reason_code)
+    PARSED_REASON_CODES.values.map do |reason_code_data|
+      reason_code(reason_code_data)
     end
   end
 
-  def self.reason_code_struct(reason_code)
-    ReasonCodeStruct.new(
-      reason_code.fetch('code'),
-      reason_code.fetch('iso_name'),
-      reason_code.fetch('description'),
-      reason_code.fetch('probable_status')
+  # @api private
+
+  def self.reason_code(reason_code_data)
+    Code.new(
+      code: reason_code_data.fetch('code'),
+      iso_name: reason_code_data.fetch('iso_name'),
+      description: reason_code_data.fetch('description'),
+      probable_status: reason_code_data.fetch('probable_status')
     )
   end
 
-  private_constant :ParsedReasonCodes
-  private_class_method :reason_code_struct
+  private_constant :PARSED_REASON_CODES
+  private_class_method :reason_code
 end

data/lib/sepa_reason_codes/code.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SepaReasonCodes
+  class Code
+    ATTRS = %i[code iso_name description probable_status].freeze
+
+    attr_reader(*ATTRS)
+
+    def initialize(code:, iso_name:, description:, probable_status:)
+      @code = code
+      @iso_name = iso_name
+      @description = description
+      @probable_status = probable_status
+    end
+
+    def ==(other)
+      ATTRS.all? do |attribute|
+        other.public_send(attribute) == public_send(attribute)
+      end
+    end
+  end
+end

data/lib/sepa_reason_codes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SepaReasonCodes
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sepa_reason_codes
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Sahil Gadimbayli
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-29 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - hi@ramblingcode.dev
 executables: []
@@ -73,6 +73,7 @@ files:
 - bin/setup
 - lib/reason_codes.yml
 - lib/sepa_reason_codes.rb
+- lib/sepa_reason_codes/code.rb
 - lib/sepa_reason_codes/version.rb
 - sepa_reason_codes.gemspec
 homepage: https://github.com/ramblingcode/sepa-reason-codes
@@ -81,7 +82,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ramblingcode/sepa-reason-codes
   source_code_uri: https://github.com/ramblingcode/sepa-reason-codes
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,8 +97,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Minimal, plain old ruby gem to work with Sepa Reason Codes.
 test_files: []