sepa_file_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5233f32c897d7e33ce7a00b1213f4933fed2c6d9d3c47d2c4367268e21f5dccd
+  data.tar.gz: 5562ca231c07df7848143dfa5f0d7b1dde9fc81ebf866ad18eb55b346596bf04
+SHA512:
+  metadata.gz: b151cf8b849f21e33e01d4c2b85268c150cf010ab0c62a5743dd9ef004ebac010b5f46f237d6b9c3ad5764aa26ca6eeda27a1bb6fe45349fa810259e560baa2f
+  data.tar.gz: b7557e088a656bc18f892f008e7aba228efbdc60a0da2b998735c9db0d7935b9babecbf25679618d60683f64cf1a318807c0c3045c3abf1804eb908fabc423ab

data/lib/sepa_file_parser/camt052/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Camt052
+    class Base
+      attr_reader :group_header, :reports, :xml_data
+
+      def initialize(xml_data)
+        @xml_data = xml_data
+        # BkToCstmrAccptRpt = Bank to Customer Account Report
+        grphdr = xml_data.xpath('BkToCstmrAcctRpt/GrpHdr')
+        @group_header = SepaFileParser::GroupHeader.new(grphdr)
+        reports = xml_data.xpath('BkToCstmrAcctRpt/Rpt')
+        @reports = reports.map{ |x| Report.new(x) }
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/camt052/report.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Camt052
+    class Report
+
+      attr_reader :xml_data
+
+      def initialize(xml_data)
+        @xml_data = xml_data
+      end
+
+      def identification
+        @identification ||= xml_data.xpath('Id/text()').text
+      end
+
+      def generation_date
+        @generation_date ||= Time.parse(xml_data.xpath('CreDtTm/text()').text)
+      end
+
+      def account
+        @account ||= SepaFileParser::Account.from_camt_data(xml_data.xpath('Acct').first)
+      end
+
+      def entries
+        @entries ||= xml_data.xpath('Ntry').map{ |x| SepaFileParser::Entry.new(x) }
+      end
+
+      def legal_sequence_number
+        @legal_sequence_number ||= xml_data.xpath('LglSeqNb/text()').text
+      end
+
+      def from_date_time
+        @from_date_time ||= (x = xml_data.xpath('FrToDt/FrDtTm')).empty? ? nil : Time.parse(x.first.content)
+      end
+
+      def to_date_time
+        @to_date_time ||= (x = xml_data.xpath('FrToDt/ToDtTm')).empty? ? nil : Time.parse(x.first.content)
+      end
+
+      def opening_balance
+        @opening_balance ||= begin
+          bal = xml_data.xpath('Bal/Tp//Cd[contains(text(), "PRCD")]').first.ancestors('Bal')
+          date = bal.xpath('Dt/Dt/text()').text
+          credit = bal.xpath('CdtDbtInd/text()').text == 'CRDT'
+          currency = bal.xpath('Amt').attribute('Ccy').value
+          SepaFileParser::AccountBalance.new bal.xpath('Amt/text()').text, currency, date, credit
+        end
+      end
+      alias_method :opening_or_intermediary_balance, :opening_balance
+
+      def closing_balance
+        @closing_balance ||= begin
+          bal = xml_data.xpath('Bal/Tp//Cd[contains(text(), "CLBD")]').first.ancestors('Bal')
+          date = bal.xpath('Dt/Dt/text()').text
+          credit = bal.xpath('CdtDbtInd/text()').text == 'CRDT'
+          currency = bal.xpath('Amt').attribute('Ccy').value
+          SepaFileParser::AccountBalance.new bal.xpath('Amt/text()').text, currency, date, credit
+        end
+      end
+      alias_method :closing_or_intermediary_balance, :closing_balance
+
+
+      def source
+        xml_data.to_s
+      end
+
+      def self.parse(xml)
+        self.new Nokogiri::XML(xml).xpath('Report')
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/camt053/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Camt053
+    class Base
+      attr_reader :group_header, :statements, :xml_data
+
+      def initialize(xml_data)
+        @xml_data = xml_data
+
+        grphdr = xml_data.xpath('BkToCstmrStmt/GrpHdr')
+        @group_header = GroupHeader.new(grphdr)
+        statements = xml_data.xpath('BkToCstmrStmt/Stmt')
+        @statements = statements.map{ |x| Statement.new(x) }
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/camt053/statement.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Camt053
+    class Statement
+
+      attr_reader :xml_data
+
+      def initialize(xml_data)
+        @xml_data = xml_data
+      end
+
+      def identification
+        @identification ||= xml_data.xpath('Id/text()').text
+      end
+
+      def generation_date
+        @generation_date ||= Time.parse(xml_data.xpath('CreDtTm/text()').text)
+      end
+
+      def from_date_time
+        @from_date_time ||= (x = xml_data.xpath('FrToDt/FrDtTm')).empty? ? nil : Time.parse(x.first.content)
+      end
+
+      def to_date_time
+        @to_date_time ||= (x = xml_data.xpath('FrToDt/ToDtTm')).empty? ? nil : Time.parse(x.first.content)
+      end
+
+      def account
+        @account ||= SepaFileParser::Account.from_camt_data(xml_data.xpath('Acct').first)
+      end
+
+      def entries
+        @entries ||= xml_data.xpath('Ntry').map{ |x| Entry.new(x) }
+      end
+
+      def legal_sequence_number
+        @legal_sequence_number ||= xml_data.xpath('LglSeqNb/text()').text
+      end
+
+      def electronic_sequence_number
+        @electronic_sequence_number ||= xml_data.xpath('ElctrncSeqNb/text()').text
+      end
+
+      def opening_balance
+        @opening_balance ||= begin
+          bal = xml_data.xpath('Bal/Tp//Cd[contains(text(), "OPBD") or contains(text(), "PRCD")]').first.ancestors('Bal')
+          date = bal.xpath('Dt/Dt/text()').text
+          credit = bal.xpath('CdtDbtInd/text()').text == 'CRDT'
+          currency = bal.xpath('Amt').attribute('Ccy').value
+          AccountBalance.new bal.xpath('Amt/text()').text, currency, date, credit
+        end
+      end
+
+      def closing_balance
+        @closing_balance ||= begin
+          bal = xml_data.xpath('Bal/Tp//Cd[contains(text(), "CLBD")]').first.ancestors('Bal')
+          date = bal.xpath('Dt/Dt/text()').text
+          credit = bal.xpath('CdtDbtInd/text()').text == 'CRDT'
+          currency = bal.xpath('Amt').attribute('Ccy').value
+          AccountBalance.new bal.xpath('Amt/text()').text, currency, date, credit
+        end
+      end
+      alias_method :closing_or_intermediary_balance, :closing_balance
+
+      def source
+        xml_data.to_s
+      end
+
+      def self.parse(xml)
+        self.new Nokogiri::XML(xml).xpath('Stmt')
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/camt054/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Camt054
+    class Base
+      attr_reader :group_header, :notifications, :xml_data
+
+      def initialize(xml_data)
+        @xml_data = xml_data
+
+        grphdr = xml_data.xpath('BkToCstmrDbtCdtNtfctn/GrpHdr')
+        @group_header = GroupHeader.new(grphdr)
+        notifications = xml_data.xpath('BkToCstmrDbtCdtNtfctn/Ntfctn')
+        @notifications = notifications.map{ |x| Notification.new(x) }
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/camt054/notification.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Camt054
+    class Notification
+
+      attr_reader :xml_data
+
+      def initialize(xml_data)
+        @xml_data = xml_data
+      end
+
+      # @return [String]
+      def identification
+        @identification ||= xml_data.xpath('Id/text()').text
+      end
+
+      # @return [Time]
+      def generation_date
+        @generation_date ||= Time.parse(xml_data.xpath('CreDtTm/text()').text)
+      end
+
+      # @return [Time, nil]
+      def from_date_time
+        @from_date_time ||= (x = xml_data.xpath('FrToDt/FrDtTm')).empty? ? nil : Time.parse(x.first.content)
+      end
+
+      # @return [Time, nil]
+      def to_date_time
+        @to_date_time ||= (x = xml_data.xpath('FrToDt/ToDtTm')).empty? ? nil : Time.parse(x.first.content)
+      end
+
+      # @return [Account]
+      def account
+        @account ||= SepaFileParser::Account.from_camt_data(xml_data.xpath('Acct').first)
+      end
+
+      # @return [Array<Entry>]
+      def entries
+        @entries ||= xml_data.xpath('Ntry').map{ |x| Entry.new(x) }
+      end
+
+      # @return [String]
+      def source
+        xml_data.to_s
+      end
+
+      # @return [SepaFileParser::Camt054::Notification]
+      def self.parse(xml)
+        self.new Nokogiri::XML(xml).xpath('Ntfctn')
+      end
+    end
+  end
+end

data/lib/sepa_file_parser/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  module Errors
+    class BaseError < StandardError; end
+
+    class NamespaceAlreadyRegistered < BaseError; end
+    class NotXMLError < BaseError; end
+    class UnsupportedParserClass < BaseError; end
+    class UnsupportedNamespaceError < BaseError; end
+  end
+end

data/lib/sepa_file_parser/file.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class File
+    def self.parse(path)
+      data = ::File.read(path)
+      SepaFileParser::String.parse(data)
+    end
+  end
+end

data/lib/sepa_file_parser/general/account.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class Account
+
+    def self.from_camt_data(xml_data)
+      self.new(
+        iban:      xml_data.xpath('Id/IBAN/text()').text,
+        other_id:  xml_data.xpath('Id/Othr/Id/text()').text,
+        bic:       [
+          xml_data.xpath('Svcr/FinInstnId/BIC/text()').text,
+          xml_data.xpath('Svcr/FinInstnId/BICFI/text()').text,
+        ].reject(&:empty?).first.to_s,
+        bank_name: xml_data.xpath('Svcr/FinInstnId/Nm/text()').text,
+        currency:  xml_data.xpath('Ccy/text()').text,
+      )
+    end
+
+    def self.from_pain_data(xml_data, currency, context)
+      self.new(
+        iban:      xml_data.xpath("#{context}Acct/Id/IBAN/text()").text,
+        bic:       xml_data.xpath("#{context}Agt/FinInstnId/BIC/text()").text,
+        bank_name: xml_data.xpath("#{context}/Nm/text()").text,
+        currency:  currency,
+      )
+    end
+
+    def initialize(iban: nil, other_id: nil, bic:, bank_name:, currency:)
+      @iban      = iban
+      @other_id  = other_id
+      @bic       = bic
+      @bank_name = bank_name
+      @currency  = currency
+    end
+
+    # @return [String]
+    def iban
+      @iban.to_s
+    end
+
+    # @return [String]
+    def other_id
+      @other_id.to_s
+    end
+
+    # @return [String]
+    def account_number
+      iban != '' ? iban : other_id
+    end
+
+    # @return [String]
+    def bic
+      @bic.to_s
+    end
+
+    # @return [String]
+    def bank_name
+      @bank_name.to_s
+    end
+
+    # @return [String]
+    def currency
+      @currency.to_s
+    end
+  end
+end

data/lib/sepa_file_parser/general/account_balance.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class AccountBalance
+
+    # @param amount [String]
+    # @param currency [String]
+    # @param date [String]
+    # @param  credit [Boolean]
+    def initialize(amount, currency, date, credit = false)
+      @amount = amount
+      @currency = currency
+      @date = date
+      @credit = credit
+    end
+
+    # @return [String]
+    def currency
+      @currency
+    end
+
+    # @return [Date]
+    def date
+      Date.parse @date
+    end
+
+    # @return [Integer] either 1 or -1
+    def sign
+      credit? ? 1 : -1
+    end
+
+    # @return [Boolean]
+    def credit?
+      @credit
+    end
+
+    # @return [BigDecimal]
+    def amount
+      SepaFileParser::Misc.to_amount(@amount)
+    end
+
+    # @return [Integer]
+    def amount_in_cents
+      SepaFileParser::Misc.to_amount_in_cents(@amount)
+    end
+
+    # @return [BigDecimal]
+    def signed_amount
+      amount * sign
+    end
+
+    # @return [Hash{String => BigDecimal, Integer}]
+    def to_h
+      {
+        'amount' => amount,
+        'amount_in_cents' => amount_in_cents,
+        'sign' => sign
+      }
+    end
+  end
+end

data/lib/sepa_file_parser/general/batch_detail.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class BatchDetail
+
+    attr_reader :xml_data
+
+    def initialize(xml_data)
+      @xml_data = xml_data
+    end
+
+    def payment_information_identification
+      @payment_information_identification ||= xml_data.xpath('PmtInfId/text()').text
+    end
+
+    def msg_id # may be missing
+      @msg_id ||= xml_data.xpath('MsgId/text()').text
+    end
+
+    def number_of_transactions
+      @number_of_transactions ||= xml_data.xpath('NbOfTxs/text()').text
+    end
+  end  
+end

data/lib/sepa_file_parser/general/charges.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class Charges
+
+    attr_reader :xml_data
+
+    def initialize(xml_data)
+      @xml_data = xml_data
+      @total_charges_and_tax_amount = xml_data.xpath('TtlChrgsAndTaxAmt/text()').text
+    end
+
+    def total_charges_and_tax_amount
+      SepaFileParser::Misc.to_amount(@total_charges_and_tax_amount)
+    end
+
+    def total_charges_and_tax_amount_in_cents
+      SepaFileParser::Misc.to_amount_in_cents(@total_charges_and_tax_amount)
+    end
+
+    def records
+      @records ||= xml_data.xpath('Rcrd').map{ |x| SepaFileParser::Record.new(x) }
+    end
+  end
+end

data/lib/sepa_file_parser/general/creditor.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class Creditor
+
+    attr_reader :xml_data
+
+    def initialize(xml_data)
+      @xml_data = xml_data
+    end
+
+    def name
+      @name ||= [
+        xml_data.xpath('RltdPties/Cdtr/Nm/text()').text,
+        xml_data.xpath('RltdPties/Cdtr/Pty/Nm/text()').text,
+      ].reject(&:empty?).first.to_s
+    end
+
+    def iban
+      @iban ||= xml_data.xpath('RltdPties/CdtrAcct/Id/IBAN/text()').text
+    end
+
+    def bic
+      @bic ||= [
+        xml_data.xpath('RltdAgts/CdtrAgt/FinInstnId/BIC/text()').text,
+        xml_data.xpath('RltdAgts/CdtrAgt/FinInstnId/BICFI/text()').text,
+      ].reject(&:empty?).first.to_s
+    end
+
+    def bank_name
+      @bank_name ||= xml_data.xpath('RltdAgts/CdtrAgt/FinInstnId/Nm/text()').text
+    end
+
+    # @return [SepaFileParser::PostalAddress, nil]
+    def postal_address # May be missing
+      postal_address = [
+        xml_data.xpath('RltdPties/Cdtr/PstlAdr'),
+        xml_data.xpath('RltdPties/Cdtr/Pty/PstlAdr'),
+      ].reject(&:empty?).first
+
+      return nil if postal_address == nil || postal_address.empty?
+
+      @address ||= SepaFileParser::PostalAddress.new(postal_address)
+    end
+  end
+end

data/lib/sepa_file_parser/general/debitor.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class Debitor
+
+    attr_reader :xml_data
+
+    def initialize(xml_data)
+      @xml_data = xml_data
+    end
+
+    def name
+      @name ||= [
+        xml_data.xpath('RltdPties/Dbtr/Nm/text()').text,
+        xml_data.xpath('RltdPties/Dbtr/Pty/Nm/text()').text,
+      ].reject(&:empty?).first.to_s
+    end
+
+    def iban
+      @iban ||= xml_data.xpath('RltdPties/DbtrAcct/Id/IBAN/text()').text
+    end
+
+    def bic
+      @bic ||= [
+        xml_data.xpath('RltdAgts/DbtrAgt/FinInstnId/BIC/text()').text,
+        xml_data.xpath('RltdAgts/DbtrAgt/FinInstnId/BICFI/text()').text,
+      ].reject(&:empty?).first.to_s
+    end
+
+    def bank_name
+      @bank_name ||= xml_data.xpath('RltdAgts/DbtrAgt/FinInstnId/Nm/text()').text
+    end
+
+    # @return [SepaFileParser::PostalAddress, nil]
+    def postal_address # May be missing
+      postal_address = [
+        xml_data.xpath('RltdPties/Dbtr/PstlAdr'),
+        xml_data.xpath('RltdPties/Dbtr/Pty/PstlAdr'),
+      ].reject(&:empty?).first
+
+      return nil if postal_address == nil || postal_address.empty?
+
+      @address ||= SepaFileParser::PostalAddress.new(postal_address)
+    end
+  end
+end

data/lib/sepa_file_parser/general/entry.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module SepaFileParser
+  class Entry
+
+    attr_reader :xml_data
+
+    def initialize(xml_data)
+      @xml_data = xml_data
+      @amount = xml_data.xpath('Amt/text()').text
+    end
+
+    def amount
+      SepaFileParser::Misc.to_amount(@amount)
+    end
+
+    def amount_in_cents
+      SepaFileParser::Misc.to_amount_in_cents(@amount)
+    end
+
+    # @return [String]
+    def currency
+      @currency ||= xml_data.xpath('Amt/@Ccy').text
+    end
+
+    # @return [Boolean]
+    def debit
+      @debit ||= xml_data.xpath('CdtDbtInd/text()').text.upcase == 'DBIT'
+    end
+
+    # @return [Date]
+    def value_date
+      @value_date ||= ((date = xml_data.xpath('ValDt/Dt/text()').text).empty? ? nil : Date.parse(date))
+    end
+
+    # @return [Date]
+    def booking_date
+      @booking_date ||= ((date = xml_data.xpath('BookgDt/Dt/text()').text).empty? ? nil : Date.parse(date))
+    end
+
+    # @return [DateTime]
+    def value_datetime
+      @value_datetime ||= ((datetime = xml_data.xpath('ValDt/DtTm/text()').text).empty? ? nil : DateTime.parse(datetime))
+    end
+
+    # @return [DateTime]
+    def booking_datetime
+      @booking_datetime ||= ((datetime = xml_data.xpath('BookgDt/DtTm/text()').text).empty? ? nil : DateTime.parse(datetime))
+    end
+
+    # @return [String]
+    def bank_reference # May be missing
+      @bank_reference ||= xml_data.xpath('AcctSvcrRef/text()').text
+    end
+
+    # @return [Array<SepaFileParser::Transaction>]
+    def transactions
+      @transactions ||= parse_transactions
+    end
+
+    # @return [Boolean]
+    def credit?
+      !debit
+    end
+
+    # @return [Boolean]
+    def debit?
+      debit
+    end
+
+    # @return [Integer] either 1 or -1
+    def sign
+      credit? ? 1 : -1
+    end
+
+    # @return [Boolean]
+    def reversal?
+      @reversal ||= xml_data.xpath('RvslInd/text()').text.downcase == 'true'
+    end
+
+    # @return [Boolean]
+    def booked?
+      @booked ||= xml_data.xpath('Sts/text()').text.upcase == 'BOOK'
+    end
+
+    # @return [String]
+    def additional_information
+      @additional_information ||= xml_data.xpath('AddtlNtryInf/text()').text
+    end
+    alias_method :description, :additional_information
+
+    # @return [SepaFileParser::Charges]
+    def charges
+      @charges ||= SepaFileParser::Charges.new(xml_data.xpath('Chrgs'))
+    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'))
+    end
+
+    private
+
+    def parse_transactions
+      transaction_details = xml_data.xpath('NtryDtls/TxDtls')
+
+      amt = nil
+      ccy = nil
+
+      if transaction_details.length == 1
+        amt = xml_data.xpath('Amt/text()').text
+        ccy = xml_data.xpath('Amt/@Ccy').text
+      end
+
+      xml_data.xpath('NtryDtls/TxDtls').map { |x| Transaction.new(x, debit?, amt, ccy) }
+    end
+  end
+end