camt_parser 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df511d70f5657f1b4712fd29c91b4d790a8bbfb3
-  data.tar.gz: f633b2714129b84aa10a331fd44d599087e50beb
+  metadata.gz: 89b432e8beb46ea683a5d897d11a3e3f7a923c6b
+  data.tar.gz: c90fca06cf5c7c2758ff54de9b5621e4caefc561
 SHA512:
-  metadata.gz: ede5475f0e6d526394ab775be6419c239d3ff0cc1f4827ce31c6694230dc1a10306f1323e2f4497cef6922f1a2f493d37200afcbbe7a3a59f3acaab37a9eaefe
-  data.tar.gz: 8a1c6b1add697dc3dbe5976e150c0f6f7b7a0dbc123d7741ecf88711b47e2cf41b54d34d0e31fc114ec80c293ac950b5bea73e83036c456742a2086e182ee037
+  metadata.gz: 1975140e3c8293086a96811e6c63f0e2cfb32169866391ab0191cc96d0c71fecb5e66f35796830f481e43e8788dc0d85088b9e2c9a410d26ccbb7cd1415e2273
+  data.tar.gz: 6c9d7648926d601d6afb9982b9fb28a6f5af9b46c6f53139a8f1d4d00ad7c368c78ff76762a7244e84330e9230228d4814e9c45b72261644607b7161649cf5d1

data/lib/camt_parser/052/base.rb

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

data/lib/camt_parser/052/report.rb

@@ -0,0 +1,58 @@
+module CamtParser
+  module Format052
+    class Report
+      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 ||= CamtParser::Account.new(@xml_data.xpath('Acct').first)
+      end
+
+      def entries
+        @entries ||= @xml_data.xpath('Ntry').map{ |x| CamtParser::Entry.new(x) }
+      end
+
+      def legal_sequence_number
+        @legal_sequence_number ||= @xml_data.xpath('LglSeqNb/text()').text
+      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
+          currency = bal.xpath('Amt').attribute('Ccy').value
+          CamtParser::AccountBalance.new bal.xpath('Amt/text()').text, currency, date, true
+        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
+          currency = bal.xpath('Amt').attribute('Ccy').value
+          CamtParser::AccountBalance.new bal.xpath('Amt/text()').text, currency, date, true
+        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/camt_parser/053/base.rb

@@ -7,7 +7,7 @@ module CamtParser
         grphdr = xml_data.xpath('BkToCstmrStmt/GrpHdr')
         @group_header = GroupHeader.new(grphdr)
         statements = xml_data.xpath('BkToCstmrStmt/Stmt')
-        @statements   = statements.map{ |x| Statement.new(x) }
+        @statements = statements.map{ |x| Statement.new(x) }
       end
     end
   end

data/lib/camt_parser/053/statement.rb

@@ -1,76 +1,68 @@
-require 'time'
-require 'bigdecimal'
-
 module CamtParser
   module Format053
     class Statement
-      attr_reader :identification, :creation_date_time, :from_date_time, :to_date_time,
-                  :account, :entries
-
       def initialize(xml_data)
-        @identification             = (x = xml_data.xpath('Id')).empty? ? nil : x.first.content
-        @creation_date_time         = Time.parse(xml_data.xpath('CreDtTm').first.content)
-        @from_date_time             = (x = xml_data.xpath('FrToDt/FrDtTm')).empty? ? nil : Time.parse(x.first.content)
-        @to_date_time               = (x = xml_data.xpath('FrToDt/ToDtTm')).empty? ? nil : Time.parse(x.first.content)
-        @account                    = Account.new(xml_data.xpath('Acct').first)
-        @entries                    = xml_data.xpath('Ntry').map{ |x| Entry.new(x) }
+        @xml_data = xml_data
       end
-    end
 
-    class Entry
-      attr_reader :amount, :currency, :value_date, :debitor, :creditor, :remittance_information,
-                  :additional_information
+      def identification
+        @identification ||= @xml_data.xpath('Id/text()').text
+      end
 
-      def initialize(xml_data)
-        @amount     = BigDecimal.new(xml_data.xpath('Amt').first.content)
-        @currency   = xml_data.xpath('Amt/@Ccy').first.content
-        @debit      = xml_data.xpath('CdtDbtInd').first.content.upcase == 'DBIT'
-        @value_date = Date.parse(xml_data.xpath('ValDt/Dt').first.content)
-        @creditor   = Creditor.new(xml_data.xpath('NtryDtls'))
-        @debitor    = Debitor.new(xml_data.xpath('NtryDtls'))
-        @additional_information = xml_data.xpath('AddtlNtryInf').first.content
-        # Makes the assumption that only unstructured remittance information will be given
-        if (x = xml_data.xpath('NtryDtls/TxDtls/RmtInf/Ustrd')).empty?
-          @remittance_information = nil
-        else
-          @remittance_information = x.collect(&:content).join(' ')
-        end
+      def generation_date
+        @generation_date ||= Time.parse(@xml_data.xpath('CreDtTm/text()').text)
       end
 
-      def debit?
-        @debit
+      def from_date_time
+        @from_date_time ||= (x = @xml_data.xpath('FrToDt/FrDtTm')).empty? ? nil : Time.parse(x.first.content)
       end
-    end
 
-    class Account
-      attr_reader :iban, :bic, :bank_name
+      def to_date_time
+        @to_date_time ||= (x = @xml_data.xpath('FrToDt/ToDtTm')).empty? ? nil : Time.parse(x.first.content)
+      end
 
-      def initialize(xml_data)
-        @iban           = (x = xml_data.xpath('Id/IBAN')).empty? ? nil : x.first.content
-        @bic            = (x = xml_data.xpath('Svcr/FinInstnId/BIC')).empty? ? nil : x.first.content
-        @bank_name      = (x = xml_data.xpath('Svcr/FinInstnId/Nm')).empty? ? nil : x.first.content
+      def account
+        @account ||= Account.new(@xml_data.xpath('Acct').first)
       end
-    end
 
-    class Debitor
-      attr_reader :iban, :bic, :bank_name, :name
+      def entries
+        @entries ||= @xml_data.xpath('Ntry').map{ |x| Entry.new(x) }
+      end
 
-      def initialize(xml_data)
-        @name       = (x = xml_data.xpath('TxDtls/RltdPties/Dbtr/Nm')).empty? ? nil : x.first.content
-        @iban       = (x = xml_data.xpath('TxDtls/RltdPties/DbtrAcct/Id/IBAN')).empty? ? nil : x.first.content
-        @bic        = (x = xml_data.xpath('TxDtls/RltdAgts/DbtrAgt/FinInstnId/BIC')).empty? ? nil : x.first.content
-        @bank_name  = (x = xml_data.xpath('TxDtls/RltdAgts/DbtrAgt/FinInstnId/Nm')).empty? ? nil : x.first.content
+      def legal_sequence_number
+        @legal_sequence_number ||= @xml_data.xpath('LglSeqNb/text()').text
       end
-    end
 
-    class Creditor
-      attr_reader :iban, :bic, :bank_name, :name
+      def electronic_sequence_number
+        @electronic_sequence_number ||= @xml_data.xpath('ElctrncSeqNb/text()').text
+      end
 
-      def initialize(xml_data)
-        @name       = (x = xml_data.xpath('TxDtls/RltdPties/Cdtr/Nm')).empty? ? nil : x.first.content
-        @iban       = (x = xml_data.xpath('TxDtls/RltdPties/CdtrAcct/Id/IBAN')).empty? ? nil : x.first.content
-        @bic        = (x = xml_data.xpath('TxDtls/RltdAgts/CdtrAgt/FinInstnId/BIC')).empty? ? nil : x.first.content
-        @bank_name  = (x = xml_data.xpath('TxDtls/RltdAgts/CdtrAgt/FinInstnId/Nm')).empty? ? nil : x.first.content
+      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
+          currency = bal.xpath('Amt').attribute('Ccy').value
+          AccountBalance.new bal.xpath('Amt/text()').text, currency, date, true
+        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
+          currency = bal.xpath('Amt').attribute('Ccy').value
+          AccountBalance.new bal.xpath('Amt/text()').text, currency, date, true
+        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

data/lib/camt_parser/errors.rb

@@ -0,0 +1,6 @@
+module CamtParser
+  module Errors
+    class UnsupportedNamespaceError < StandardError
+    end
+  end
+end

data/lib/camt_parser/file.rb

@@ -1,17 +1,8 @@
 module CamtParser
   class File
     def self.parse(path)
-      f = ::File.open(path)
-      doc = Nokogiri::XML(f)
-      f.close
-
-      case doc.namespaces["xmlns"]
-      when "urn:iso:std:iso:20022:tech:xsd:camt.053.001.02"
-        doc.remove_namespaces!
-        return CamtParser::Format053::Base.new(doc.xpath("Document"))
-      else
-        raise "unknown or unsupported namespace: #{doc.namespaces["xlmns"]}"
-      end
+      data = ::File.read(path)
+      CamtParser::String.parse(data)
     end
   end
 end

data/lib/camt_parser/general/account.rb

@@ -0,0 +1,19 @@
+module CamtParser
+  class Account
+    def initialize(xml_data)
+      @xml_data = xml_data
+    end
+
+    def iban
+      @iban ||= @xml_data.xpath('Id/IBAN/text()').text
+    end
+
+    def bic
+      @bic ||= @xml_data.xpath('Svcr/FinInstnId/BIC/text()').text
+    end
+
+    def bank_name
+      @bank_name ||= @xml_data.xpath('Svcr/FinInstnId/Nm/text()').text
+    end
+  end
+end

data/lib/camt_parser/general/account_balance.rb

@@ -0,0 +1,43 @@
+module CamtParser
+  class AccountBalance
+
+    def initialize(amount, currency, date, credit = false)
+      @amount = amount
+      @currency = currency
+      @date = date
+      @credit = credit
+    end
+
+    def currency
+      @currency
+    end
+
+    def date
+      Date.parse @date
+    end
+
+    def sign
+      credit? ? 1 : -1
+    end
+
+    def credit?
+      @credit
+    end
+
+    def amount
+      CamtParser::Misc.to_amount(@amount)
+    end
+
+    def amount_in_cents
+      CamtParser::Misc.to_amount_in_cents(@amount)
+    end
+
+    def to_h
+      {
+        'amount' => amount,
+        'amount_in_cents' => amount_in_cents,
+        'sign' => sign
+      }
+    end
+  end
+end

data/lib/camt_parser/general/creditor.rb

@@ -0,0 +1,23 @@
+module CamtParser
+  class Creditor
+    def initialize(xml_data)
+      @xml_data = xml_data
+    end
+
+    def name
+      @name ||= @xml_data.xpath('TxDtls/RltdPties/Cdtr/Nm/text()').text
+    end
+
+    def iban
+      @iban ||= @xml_data.xpath('TxDtls/RltdPties/CdtrAcct/Id/IBAN/text()').text
+    end
+
+    def bic
+      @bic ||= @xml_data.xpath('TxDtls/RltdAgts/CdtrAgt/FinInstnId/BIC/text()').text
+    end
+
+    def bank_name
+      @bank_name ||= @xml_data.xpath('TxDtls/RltdAgts/CdtrAgt/FinInstnId/Nm/text()').text
+    end
+  end
+end

data/lib/camt_parser/general/debitor.rb

@@ -0,0 +1,23 @@
+module CamtParser
+  class Debitor
+    def initialize(xml_data)
+      @xml_data = xml_data
+    end
+
+    def name
+      @name ||= @xml_data.xpath('TxDtls/RltdPties/Dbtr/Nm/text()').text
+    end
+
+    def iban
+      @iban ||= @xml_data.xpath('TxDtls/RltdPties/DbtrAcct/Id/IBAN/text()').text
+    end
+
+    def bic
+      @bic ||= @xml_data.xpath('TxDtls/RltdAgts/DbtrAgt/FinInstnId/BIC/text()').text
+    end
+
+    def bank_name
+      @bank_name ||= @xml_data.xpath('TxDtls/RltdAgts/DbtrAgt/FinInstnId/Nm/text()').text
+    end
+  end
+end

data/lib/camt_parser/general/entry.rb

@@ -0,0 +1,111 @@
+module CamtParser
+  class Entry
+    def initialize(xml_data)
+      @xml_data = xml_data
+      @amount = @xml_data.xpath('Amt/text()').text
+    end
+
+    def amount
+      CamtParser::Misc.to_amount(@amount)
+    end
+
+    def amount_in_cents
+      CamtParser::Misc.to_amount_in_cents(@amount)
+    end
+
+    def currency
+      @currency ||= @xml_data.xpath('Amt/@Ccy').text
+    end
+
+    def debit
+      @debit ||= @xml_data.xpath('CdtDbtInd/text()').text.upcase == 'DBIT'
+    end
+
+    def value_date
+      @value_date ||= Date.parse(@xml_data.xpath('ValDt/Dt/text()').text)
+    end
+
+    def booking_date
+      @booking_date ||= Date.parse(@xml_data.xpath('BookgDt/Dt/text()').text)
+    end
+
+    def creditor
+      @creditor ||= CamtParser::Creditor.new(@xml_data.xpath('NtryDtls'))
+    end
+
+    def credit?
+      !debit
+    end
+
+    def debitor
+      @debitor ||= CamtParser::Debitor.new(@xml_data.xpath('NtryDtls'))
+    end
+
+    def debit?
+      debit
+    end
+
+    def sign
+      credit? ? 1 : -1
+    end
+
+    def additional_information
+      @additional_information ||= @xml_data.xpath('AddtlNtryInf/text()').text
+    end
+    alias_method :description, :additional_information
+
+    def remittance_information
+      @remittance_information ||= begin
+        if (x = @xml_data.xpath('NtryDtls/TxDtls/RmtInf/Ustrd')).empty?
+          nil
+        else
+          x.collect(&:content).join(' ')
+        end
+      end
+    end
+
+    def name
+      credit? ? debitor.name : creditor.name
+    end
+
+    def iban
+      credit? ? debitor.iban : creditor.iban
+    end
+
+    def bic
+      credit? ? debitor.bic : creditor.bic
+    end
+
+    def swift_code
+      @swift_code ||= @xml_data.xpath('NtryDtls/TxDtls/BkTxCd/Prtry/Cd/text()').text.split('+')[0]
+    end
+
+    def reference
+      @reference ||= @xml_data.xpath('NtryDtls/TxDtls/Refs/InstrId/text()').text
+    end
+
+    def bank_reference # May be missing
+      @bank_reference ||= @xml_data.xpath('NtryDtls/TxDtls/Refs/AcctSvcrRef/text()').text
+    end
+
+    def end_to_end_reference # May be missing
+      @end_to_end_reference ||= @xml_data.xpath('NtryDtls/TxDtls/Refs/EndToEndId/text()').text
+    end
+
+    def mandate_reference # May be missing
+      @mandate_reference ||= @xml_data.xpath('NtryDtls/TxDtls/Refs/MndtId/text()').text
+    end
+
+    def transaction_id # May be missing
+      @transaction_id ||= @xml_data.xpath('NtryDtls/TxDtls/Refs/TxId/text()').text
+    end
+
+    def creditor_identifier # May be missing
+      @creditor_identifier ||= @xml_data.xpath('NtryDtls/TxDtls/RltdPties/Cdtr/Id/PrvtId/Othr/Id/text()').text
+    end
+
+    def payment_information # May be missing
+      @payment_information ||= @xml_data.xpath('NtryDtls/TxDtls/Refs/PmtInfId/text()').text
+    end
+  end
+end

data/lib/camt_parser/general/group_header.rb

@@ -0,0 +1,27 @@
+require 'time'
+
+module CamtParser
+  class GroupHeader
+    attr_reader :message_id, :creation_date_time, :additional_information, :message_pagination
+
+    def initialize(xml_data)
+      @message_id             = xml_data.xpath('MsgId/text()').text
+      @creation_date_time     = Time.parse(xml_data.xpath('CreDtTm/text()').text)
+      @message_pagination     = (x = xml_data.xpath('MsgPgntn')).empty? ? nil : MessagePagination.new(x)
+      @additional_information = xml_data.xpath('AddtlInf/text()').text
+    end
+  end
+
+  class MessagePagination
+    attr_reader :page_number
+
+    def initialize(xml_data)
+      @page_number         = xml_data.xpath('PgNb/text()').text.to_i
+      @last_page_indicator = xml_data.xpath('LastPgInd/text()').text == 'true'
+    end
+
+    def last_page?
+      @last_page_indicator
+    end
+  end
+end

data/lib/camt_parser/misc.rb

@@ -0,0 +1,13 @@
+module CamtParser
+  class Misc
+    class << self
+      def to_amount_in_cents(value)
+        value.gsub(/[,|\.](\d*)/) { $1.ljust(2, '0') }.to_i
+      end
+
+      def to_amount(value)
+        BigDecimal.new value.gsub(',', '.')
+      end
+    end
+  end
+end

data/lib/camt_parser/string.rb

@@ -0,0 +1,19 @@
+module CamtParser
+  class String
+    def self.parse(raw_camt)
+      doc = Nokogiri::XML raw_camt
+
+      namespaces = doc.namespaces['xmlns']
+      doc.remove_namespaces!
+
+      case namespaces
+      when 'urn:iso:std:iso:20022:tech:xsd:camt.052.001.02'
+        return CamtParser::Format052::Base.new(doc.xpath('Document'))
+      when 'urn:iso:std:iso:20022:tech:xsd:camt.053.001.02'
+        return CamtParser::Format053::Base.new(doc.xpath('Document'))
+      else
+        raise CamtParser::Errors::UnsupportedNamespaceError, namespaces
+      end
+    end
+  end
+end

data/lib/camt_parser/version.rb

@@ -1,3 +1,3 @@
 module CamtParser
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/lib/camt_parser.rb

@@ -1,9 +1,21 @@
 # encoding: utf-8
-
 require "nokogiri"
 
-require "camt_parser/version"
-require "camt_parser/053/group_header"
-require "camt_parser/053/statement"
-require "camt_parser/053/base"
-require "camt_parser/file"
+require "time"
+require "bigdecimal"
+
+require_relative "camt_parser/misc"
+require_relative "camt_parser/version"
+require_relative "camt_parser/errors"
+require_relative "camt_parser/general/account_balance"
+require_relative "camt_parser/general/creditor"
+require_relative "camt_parser/general/debitor"
+require_relative "camt_parser/general/entry"
+require_relative "camt_parser/general/account"
+require_relative "camt_parser/general/group_header"
+require_relative "camt_parser/052/report"
+require_relative "camt_parser/052/base"
+require_relative "camt_parser/053/statement"
+require_relative "camt_parser/053/base"
+require_relative "camt_parser/file"
+require_relative "camt_parser/string"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camt_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Tobias Schoknecht
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -70,16 +70,16 @@ dependencies:
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.6.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.6.2
+        version: '0'
 description: A parser for the Camt file format
 email:
 - tobias.schoknecht@barzahlen.de
@@ -88,10 +88,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/camt_parser.rb
+- lib/camt_parser/052/base.rb
+- lib/camt_parser/052/report.rb
 - lib/camt_parser/053/base.rb
-- lib/camt_parser/053/group_header.rb
 - lib/camt_parser/053/statement.rb
+- lib/camt_parser/errors.rb
 - lib/camt_parser/file.rb
+- lib/camt_parser/general/account.rb
+- lib/camt_parser/general/account_balance.rb
+- lib/camt_parser/general/creditor.rb
+- lib/camt_parser/general/debitor.rb
+- lib/camt_parser/general/entry.rb
+- lib/camt_parser/general/group_header.rb
+- lib/camt_parser/misc.rb
+- lib/camt_parser/string.rb
 - lib/camt_parser/version.rb
 homepage: https://github.com/Barzahlen/camt_parser
 licenses:
@@ -113,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Gem for parsing camt files into a speaking object.

data/lib/camt_parser/053/group_header.rb

@@ -1,29 +0,0 @@
-require 'time'
-
-module CamtParser
-  module Format053
-    class GroupHeader
-      attr_reader :message_id, :creation_date_time, :additional_information, :message_pagination
-
-      def initialize(xml_data)
-        @message_id             = xml_data.xpath('MsgId').first.content
-        @creation_date_time     = Time.parse(xml_data.xpath('CreDtTm').first.content)
-        @message_pagination     = (x = xml_data.xpath('MsgPgntn')).empty? ? nil : MessagePagination.new(x)
-        @additional_information = (x = xml_data.xpath('AddtlInf')).empty? ? nil : x.first.content
-      end
-    end
-
-    class MessagePagination
-      attr_reader :page_number
-
-      def initialize(xml_data)
-        @page_number         = xml_data.xpath('PgNb').first.content.to_i
-        @last_page_indicator = xml_data.xpath('LastPgInd').first.content == 'true'
-      end
-
-      def last_page?
-        @last_page_indicator
-      end
-    end
-  end
-end