sepa_file_parser 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e40fc8a0165c3f5b1aba430178939203b07da1a0b6f21b91e48423ffb4bcb1b0
-  data.tar.gz: d37ea47f3cbe7a854e7b9f0ac2d3d016118e9dbf5303d87bf7d07ca220899b54
+  metadata.gz: 2538b348949805e79a4612d486d7c983b1254981b9d265cf95377b9f65f1ff84
+  data.tar.gz: f8b3f1f5c088107de2da1dc8342c7971eae4442b4902eeb6368d9e4ab69354ea
 SHA512:
-  metadata.gz: '02799607e177916a7a18302cee158c19761b5192bf5aaf783df67d975a43c96511aedf7179bd83a7441ad2049e95a8f436d3b2d56ab9850fe5d6b1b7ed4204d4'
-  data.tar.gz: a2b9649705ecf4c765cf4dd58cf151206034fd73f9d5f76877c7b36ccf46af95fa9477c7f207d051a5c7b9c766c0e60d0f86005c2510b20cbc405ba561694c8c
+  metadata.gz: 391584744f49b0e6e9dad59e8ea63d24a67c0970ea93adee87535d8084abcdd6df619d310cd30bf2cbbe0cc586e09d152686b791bd79dc23d27bc1e18ed39d85
+  data.tar.gz: 2f33ab86d70d63bd5a6b1af0f4a1257b07ae46a29ba7e8ce2c110e452faa59dc7a94b861b401240d05d7f21f85a2c94af9f29351a8a7678d980d26969c0f8567

data/lib/sepa_file_parser/camt052/report.rb

@@ -26,6 +26,10 @@ module SepaFileParser
         @entries ||= xml_data.xpath('Ntry').map{ |x| SepaFileParser::Entry.new(x) }
       end
 
+      def electronic_sequence_number
+        @electronic_sequence_number ||= xml_data.xpath('ElctrncSeqNb/text()').text
+      end
+
       def legal_sequence_number
         @legal_sequence_number ||= xml_data.xpath('LglSeqNb/text()').text
       end

data/lib/sepa_file_parser/general/account.rb

@@ -13,6 +13,7 @@ module SepaFileParser
         ].reject(&:empty?).first.to_s,
         bank_name: xml_data.xpath('Svcr/FinInstnId/Nm/text()').text,
         currency:  xml_data.xpath('Ccy/text()').text,
+        owner:     SepaFileParser::Owner.new(xml_data.xpath('Ownr'))
       )
     end
 
@@ -25,12 +26,13 @@ module SepaFileParser
       )
     end
 
-    def initialize(iban: nil, other_id: nil, bic:, bank_name:, currency:)
+    def initialize(iban: nil, other_id: nil, bic:, bank_name:, currency:, owner: nil)
       @iban      = iban
       @other_id  = other_id
       @bic       = bic
       @bank_name = bank_name
       @currency  = currency
+      @owner     = owner
     end
 
     # @return [String]
@@ -62,5 +64,9 @@ module SepaFileParser
     def currency
       @currency.to_s
     end
+
+    def owner
+      @owner
+    end
   end
 end

data/lib/sepa_file_parser/general/bank_transaction_code.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class BankTransactionCode
+
+    attr_reader :xml_data
+
+    def initialize(xml_data)
+      @xml_data = xml_data
+    end
+
+    def domain_code # May be missing
+      @domain_code ||= xml_data.xpath('Domn/Cd/text()').text
+    end
+
+    def family_code # May be missing
+      @family_code ||= xml_data.xpath('Domn/Fmly/Cd/text()').text
+    end
+
+    def sub_family_code # May be missing
+      @sub_family_code ||= xml_data.xpath('Domn/Fmly/SubFmlyCd/text()').text
+    end
+  end
+end

data/lib/sepa_file_parser/general/batch_detail.rb

@@ -7,6 +7,20 @@ module SepaFileParser
 
     def initialize(xml_data)
       @xml_data = xml_data
+      @amount = xml_data.xpath('TtlAmt/text()').text
+    end
+
+    def total_amount
+      SepaFileParser::Misc.to_amount(@amount)
+    end
+
+    def total_amount_in_cents
+      SepaFileParser::Misc.to_amount_in_cents(@amount)
+    end
+
+    # @return [String]
+    def currency
+      @currency ||= xml_data.xpath('TtlAmt/@Ccy').text
     end
 
     def payment_information_identification
@@ -16,6 +30,7 @@ module SepaFileParser
     def msg_id # may be missing
       @msg_id ||= xml_data.xpath('MsgId/text()').text
     end
+    alias_method :message_id, :msg_id # same like in transaction.rb
 
     def number_of_transactions
       @number_of_transactions ||= xml_data.xpath('NbOfTxs/text()').text

data/lib/sepa_file_parser/general/creditor_reference_information.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class CreditorReferenceInformation
+
+    attr_reader :xml_data
+
+    def initialize(xml_data)
+      @xml_data = xml_data
+    end
+
+    def creditor_reference
+      @creditor_reference ||= xml_data.xpath('Ref/text()').text
+    end
+
+    def code_or_proprietary
+      @code_or_proprietary ||= [
+        xml_data.xpath('Tp/CdOrPrtry/Cd/text()').text,
+        xml_data.xpath('Tp/CdOrPrtry/Prtry/text()').text,
+      ].reject(&:empty?).first.to_s
+    end
+  end  
+end

data/lib/sepa_file_parser/general/entry.rb

@@ -100,11 +100,24 @@ module SepaFileParser
     end
     # @return [SepaFileParser::BatchDetail, nil]
     def batch_detail
-      @batch_detail ||= xml_data.xpath('NtryDtls/Btch').empty? ? nil : SepaFileParser::BatchDetail.new(@xml_data.xpath('NtryDtls/Btch'))
+      @batch_detail ||= xml_data.xpath('NtryDtls/Btch').empty? ? nil : parse_batch_detail
+    end
+
+    # @return [SepaFileParser::BankTransactionCode, nil]
+    def bank_transaction_code
+      @bank_transaction_code ||= xml_data.xpath('BkTxCd').empty? ? nil : parse_bank_trx_code
     end
 
     private
 
+    def parse_batch_detail
+      SepaFileParser::BatchDetail.new(xml_data.xpath('NtryDtls/Btch'))
+    end
+
+    def parse_bank_trx_code
+      SepaFileParser::BankTransactionCode.new(xml_data.xpath('BkTxCd'))
+    end
+
     def parse_transactions
       transaction_details = xml_data.xpath('NtryDtls/TxDtls')
 

data/lib/sepa_file_parser/general/owner.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+
+  class Owner
+
+    attr_reader :xml_data
+
+    def initialize(xml_data)
+      @xml_data = xml_data
+    end
+
+    # @return [String]
+    def name
+      @name ||= xml_data.xpath('Nm/text()').text
+    end
+
+    # @return [SepaFileParser::PostalAddress, nil]
+    def postal_address # May be missing
+      postal_address = xml_data.xpath('PstlAdr')
+
+      return nil if postal_address == nil || postal_address.empty?
+
+      @address ||= SepaFileParser::PostalAddress.new(postal_address)
+    end
+  end
+end

data/lib/sepa_file_parser/general/return_information.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class ReturnInformation
+
+    attr_reader :xml_data
+
+    def initialize(xml_data)
+      @xml_data = xml_data
+    end
+
+    def additional_information # May be missing
+      @additional_information ||= xml_data.xpath('AddtlInf/text()').text
+    end
+
+    def reason_code
+      @reason_code ||= xml_data.xpath('Rsn/Cd/text()').text
+    end
+  end
+end

data/lib/sepa_file_parser/general/transaction.rb

@@ -72,6 +72,10 @@ module SepaFileParser
       credit? ? 1 : -1
     end
 
+    def additional_remittance_information # May be missing
+      @additional_remittance_information ||= xml_data.xpath('RmtInf/Strd/AddtlRmtInf/text()').text
+    end
+
     def remittance_information
       @remittance_information ||= begin
         if (x = xml_data.xpath('RmtInf/Ustrd')).empty?
@@ -115,7 +119,15 @@ module SepaFileParser
     end
 
     def creditor_reference # May be missing
-      @creditor_reference ||= xml_data.xpath('RmtInf/Strd/CdtrRefInf/Ref/text()').text
+      @creditor_reference ||= creditor_reference_information.creditor_reference
+    end
+
+    def creditor_reference_information
+      if xml_data.xpath('RmtInf/Strd/CdtrRefInf').empty?
+        return nil
+      end
+
+      @creditor_reference_information ||= parse_creditor_reference_information
     end
 
     def message_id # May be missing
@@ -137,12 +149,26 @@ module SepaFileParser
       @payment_information ||= xml_data.xpath('Refs/PmtInfId/text()').text
     end
 
+    def uetr # May be missing
+      @uetr ||= xml_data.xpath('Refs/UETR/text()').text
+    end
+    alias_method :unique_e2e_reference, :uetr
+
     def additional_information # May be missing
       @addition_information ||= xml_data.xpath('AddtlTxInf/text()').text
     end
 
     def reason_code # May be missing
-      @reason_code ||= xml_data.xpath('RtrInf/Rsn/Cd/text()').text
+      @reason_code ||= parse_return_information.reason_code # For compatibility
+    end
+
+    def return_information
+      @return_information ||= parse_return_information
+    end
+
+    # @return [SepaFileParser::BankTransactionCode, nil]
+    def bank_transaction_code
+      @bank_transaction_code ||= xml_data.xpath('BkTxCd').empty? ? nil : parse_bank_trx_code
     end
 
     private
@@ -166,5 +192,17 @@ module SepaFileParser
         xml_data.xpath('AmtDtls//Amt/@Ccy').first.text
       end
     end
+
+    def parse_return_information
+      @return_information ||= ReturnInformation.new(xml_data.xpath('RtrInf'))
+    end
+
+    def parse_bank_trx_code
+      SepaFileParser::BankTransactionCode.new(xml_data.xpath('BkTxCd'))
+    end
+
+    def parse_creditor_reference_information
+      CreditorReferenceInformation.new(xml_data.xpath('RmtInf/Strd/CdtrRefInf'))
+    end
   end
 end

data/lib/sepa_file_parser/version.rb

@@ -2,6 +2,6 @@
 
 module SepaFileParser
 
-  VERSION = '0.9.0'
+  VERSION = '0.11.0'
 
 end

data/lib/sepa_file_parser.rb

@@ -8,12 +8,15 @@ require_relative 'sepa_file_parser/misc'
 require_relative 'sepa_file_parser/version'
 require_relative 'sepa_file_parser/errors'
 require_relative 'sepa_file_parser/general/account_balance'
+require_relative 'sepa_file_parser/general/bank_transaction_code'
 require_relative 'sepa_file_parser/general/creditor'
+require_relative 'sepa_file_parser/general/creditor_reference_information'
 require_relative 'sepa_file_parser/general/debitor'
 require_relative 'sepa_file_parser/general/entry'
 require_relative 'sepa_file_parser/general/record'
 require_relative 'sepa_file_parser/general/charges'
 require_relative 'sepa_file_parser/general/account'
+require_relative 'sepa_file_parser/general/owner'
 require_relative 'sepa_file_parser/general/batch_detail'
 require_relative 'sepa_file_parser/general/group_header'
 require_relative 'sepa_file_parser/general/pain_entry'
@@ -23,6 +26,7 @@ require_relative 'sepa_file_parser/general/type/builder'
 require_relative 'sepa_file_parser/general/type/code'
 require_relative 'sepa_file_parser/general/type/proprietary'
 require_relative 'sepa_file_parser/general/ultimate_debitor'
+require_relative 'sepa_file_parser/general/return_information'
 require_relative 'sepa_file_parser/camt052/report'
 require_relative 'sepa_file_parser/camt052/base'
 require_relative 'sepa_file_parser/camt053/statement'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sepa_file_parser
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Tobias Schoknecht
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 3.13.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 3.13.2
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
@@ -111,15 +111,19 @@ files:
 - lib/sepa_file_parser/file.rb
 - lib/sepa_file_parser/general/account.rb
 - lib/sepa_file_parser/general/account_balance.rb
+- lib/sepa_file_parser/general/bank_transaction_code.rb
 - lib/sepa_file_parser/general/batch_detail.rb
 - lib/sepa_file_parser/general/charges.rb
 - lib/sepa_file_parser/general/creditor.rb
+- lib/sepa_file_parser/general/creditor_reference_information.rb
 - lib/sepa_file_parser/general/debitor.rb
 - lib/sepa_file_parser/general/entry.rb
 - lib/sepa_file_parser/general/group_header.rb
+- lib/sepa_file_parser/general/owner.rb
 - lib/sepa_file_parser/general/pain_entry.rb
 - lib/sepa_file_parser/general/postal_address.rb
 - lib/sepa_file_parser/general/record.rb
+- lib/sepa_file_parser/general/return_information.rb
 - lib/sepa_file_parser/general/transaction.rb
 - lib/sepa_file_parser/general/type/builder.rb
 - lib/sepa_file_parser/general/type/code.rb
@@ -158,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Gem for parsing camt, pain, ... files into a speaking object.
 test_files: []