Skip to content

Latest commit

 

History

History
55 lines (44 loc) · 1.82 KB

readme.md

File metadata and controls

55 lines (44 loc) · 1.82 KB

CamtParser

Ruby CI

CamtParser is a Ruby Gem which does some basic parsing of camt052, camt053, and camt054 files into an object structure for easier usability instead of having to use an XML parser all the time. Keep in mind that this might not include a complete parsing of camt specification. Fields that we did not need for our use-cases are simply ignored for now.

Getting started

  1. add the Gem to the Gemfile
gem 'camt_parser'
  1. Require the Gem at any point before using it
  2. Use it!

Example for camt053

camt = CamtParser::File.parse path_to_file
puts camt.group_header.creation_date_time
camt.statements.each do |statement|
  puts statement.account.iban
  statement.entries.each do |entry|
    # Access individual entries/bank transfers
    puts entry.amount
    entry.transactions.each do |transaction|
      puts transaction.debitor
    end
  end
end

Please check the code for fields not mentioned here. Also check the code for camt052 and camt054.

Registering new namespaces

In case you have to parse a namespace which is generally compatible with any of the camt parsers, it is possible to register additional namespaces, without requiring a change to this gem.

# Registering a new camt052 namespace
CamtParser::Xml.register('<your namespace>', :camt052)
# Registering a new camt053 namespace
CamtParser::Xml.register('<your namespace>', :camt053)
# Registering a new camt054 namespace
CamtParser::Xml.register('<your namespace>', :camt054)

Bugs and Contribution

For bugs and feature requests open an issue on Github. For code contributions fork the repo, make your changes and create a pull request.

License

LICENSE