camt 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bfc23e67cc63e70b660a029d859f138f397427a
-  data.tar.gz: 3f1a661d0c80e14264b48198b3cb17bd953ec7ba
+  metadata.gz: fbf8cebe34c15ebcaee72f69f9d00fa5d42c7f71
+  data.tar.gz: 97458bfd5bbf68d50c1de444cf0bf3ce71261d3a
 SHA512:
-  metadata.gz: e6208aa0f98688518eb4f6b5b80192088eebbe2129204f5cc834d6017f2814b296356092f94492c50682a8d6b822712974f9f1ef16c1b9f72214b2683445ed88
-  data.tar.gz: 59d5e30cfbf93252e6f0b6996a0d0ffa429d6f068c776cd1334801f36a838f31b2125c997d85f8a0751c084afa143ce7014f89c39c6ddba7cec5ed3af2703e45
+  metadata.gz: 2040170ec53cd9887e563ccd81cfb45191a7ec27d78a8f7a0294175216e0ed9be9f591db7cfb0b3e8a9787d73fe91409c051b97098ec7cc33c5bb1736c06227a
+  data.tar.gz: 0dfebd812a609840381a6fe946188a746978630e0633365f8a388611e2c44951084fc6ce5cf5cbc0c8aa74a65d99e4fe8c9b5984ea3447b89958d5940527b889

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+ - 2.1.5

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in camt.gemspec
 gemspec
-
-# gem 'debugger'

data/README.md

@@ -2,18 +2,33 @@
 
 This gem is based on the Python implementation by Therp (https://code.launchpad.net/~therp-nl/banking-addons) (camt.py). It is still far from supporting the full CAMT.053 specification, but it does provide the most important transaction information.
 
+[![Build Status](https://travis-ci.org/moiristo/camt.svg)](https://travis-ci.org/moiristo/camt)
+
 ## Installation
 
-Add to your Gemfile: gem 'camt', github: 'moiristo/camt'
+Add to your Gemfile:
+
+    gem "camt"
+
+## Configuration
+
+You need to set your default country code.
+
+    Camt.configure do |config|
+      config.default_country_code = "NL"
+    end
 
 ## Usage
 
-* Parse a CAMT file:
-  * camt = Camt::File.parse 'camt.xml'
-* Get information:
-  * puts camt.messages.inspect
-  * puts camt.statements.inspect
-  * puts camt.transactions.inspect
+Parse a CAMT file:
+
+    camt = Camt::File.parse 'camt.xml'
+
+Get information:
+
+    puts camt.messages.inspect
+    puts camt.statements.inspect
+    puts camt.transactions.inspect
 
 ## TODO
 

data/Rakefile

@@ -1,10 +1,8 @@
 require "bundler/gem_tasks"
-require 'rake/testtask'
 
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
+task :default => [:spec]
 
-task :default => :test
+desc 'run Rspec specs'
+task :spec do
+  sh 'rspec spec'
+end

data/camt.gemspec

@@ -19,7 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "nokogiri"
+  spec.add_dependency "activesupport"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/camt.rb

@@ -1,10 +1,17 @@
 require 'nokogiri'
 require 'time'
+require 'bigdecimal'
+
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/configurable'
 
 require 'camt/version'
-require 'camt/object_extension'
 require 'camt/file'
 require 'camt/parser'
+require 'camt/amount'
+require 'camt/statement'
+require 'camt/transaction'
 
 module Camt
 
@@ -13,26 +20,6 @@ module Camt
   Message = Struct.new(:group_header, :statements)
   GroupHeader = Struct.new(:message_id, :created_at, :recipient, :pagination, :additional_info)
 
-  Statement = Struct.new(
-    :id,
-    :date,
-    :created_at,
-    :local_account,
-    :local_currency,
-    :start_balance,
-    :end_balance,
-    :electronic_sequence_number,
-    :transactions
-  )
-
-  Transaction = Struct.new(
-    :execution_date,
-    :effective_date,
-    :transfer_type,
-    :transferred_amount,
-    :transaction_details
-  )
-
   Reasons = {
     'EN' => {
       'AC01' => "Account identifier incorrect (i.e. invalid IBAN)",
@@ -97,4 +84,10 @@ module Camt
     }
   }
 
+  include ActiveSupport::Configurable
+
+  def self.configure
+    yield config
+  end
+
 end

data/lib/camt/amount.rb

@@ -0,0 +1,22 @@
+module Camt
+  class Amount
+
+    attr_reader :node
+
+    def initialize(xml_node)
+      @node = xml_node
+    end
+
+    def value
+      sign * BigDecimal.new(node.at('./Amt').text)
+    end
+
+    def sign
+      node.at('./CdtDbtInd').text == 'DBIT' ? -1 : 1
+    end
+
+    def currency
+      node.at('./Amt').attribute('Ccy').value
+    end
+  end
+end

data/lib/camt/file.rb

@@ -3,21 +3,26 @@ module Camt
     attr_accessor :code, :country_code, :name
     attr_accessor :doc, :ns
 
+    delegate :errors, :to => :doc
+
     def self.parse file
-      Camt::File.new Nokogiri::XML ::File.read(file)
+      Camt::File.new(Nokogiri::XML(::File.read(file)))
     end
 
-    def initialize doc, options = { code: 'CAMT', country_code: 'NL', name: 'Generic CAMT Format' }
+    def initialize(doc, options = {})
       self.code = options[:code] || 'CAMT'
-      self.country_code = options[:country_code] || 'NL'
+      self.country_code = options[:country_code] || Camt.config.default_country_code || raise(ArgumentError.new("No country_code given and no default_country_code configured."))
       self.name = options[:name] || 'Generic CAMT Format'
 
       self.doc = doc
       self.ns = doc.namespaces['xmlns']
 
-      check_version
+      check_version if valid?
     end
 
+    def valid?
+      doc.errors.empty?
+    end
 
     def check_version
       # Sanity check the document's namespace
@@ -44,4 +49,4 @@ module Camt
     end
 
   end
-end
+end

data/lib/camt/parser.rb

@@ -3,136 +3,13 @@ module Camt
 
     attr_accessor :file
 
-    def get_balance_type_node node, balance_type
-      # :param node: BkToCstmrStmt/Stmt/Bal node
-      # :param balance type: one of 'OPBD', 'PRCD', 'ITBD', 'CLBD'
-      return node.at("./Bal/Tp/CdOrPrtry/Cd[text()='#{balance_type}']/../../..")
-    end
-
-    def parse_amount(node)
-      # Parse an element that contains both Amount and CreditDebitIndicator
-      #
-      # :return: signed amount
-      # :returntype: float
-
-      sign = node.at('./CdtDbtInd').text == 'DBIT' ? -1 : 1
-      return sign * node.at('./Amt').text.to_f
-    end
-
-    def get_start_balance(node)
-      # Find the (only) balance node with code OpeningBalance, or
-      # the only one with code 'PreviousClosingBalance'
-      # or the first balance node with code InterimBalance in
-      # the case of preceeding pagination.
-      #
-      # :param node: BkToCstmrStmt/Stmt/Bal node
-      balance_type_node = nil
-      ['OPBD', 'PRCD', 'ITBD'].detect{|code| balance_type_node = get_balance_type_node(node, code) }
-      parse_amount balance_type_node
-    end
-
-    def get_end_balance(node)
-      # Find the (only) balance node with code ClosingBalance, or
-      # the second (and last) balance node with code InterimBalance in
-      # the case of continued pagination.
-      #
-      # :param node: BkToCstmrStmt/Stmt/Bal node
-      balance_type_node = nil
-      ['CLBD', 'ITBD'].detect{|code| balance_type_node = get_balance_type_node(node, code) }
-      parse_amount balance_type_node
-    end
-
-    def parse_Stmt node
+    def parse_Stmt(node)
       # Parse a single Stmt node.
       #
       # Be sure to craft a unique, but short enough statement identifier,
       # as it is used as the basis of the generated move lines' names
       # which overflow when using the full IBAN and CAMT statement id.
-
-      statement = Statement.new
-
-      statement.id = node.at('./Id').text
-      statement.electronic_sequence_number = node.at('./ElctrncSeqNb').text
-      statement.created_at = Time.parse(node.at('./CreDtTm').text)
-      statement.local_account = node.at('./Acct/Id').text.strip
-      statement.local_currency = node.at('./Acct/Ccy').text
-      statement.date = Time.parse(node.at('./Ntry[1]/ValDt/Dt | ./Ntry[1]/ValDt/DtTm').text)
-      statement.start_balance = get_start_balance(node)
-      statement.end_balance = get_end_balance(node)
-      statement.transactions = node.xpath('./Ntry').map{ |node| parse_Ntry(node) }
-
-      statement
-    end
-
-    def get_transfer_type node
-      # Map properietary codes from BkTxCd/Prtry/Cd.
-      # :param node: BkTxCd/Prtry node
-      { proprietary_code: node.at('./Cd').text, proprietary_issuer: node.at('./Issr').text } if node
-    end
-
-    def parse_Ntry node
-      # :param node: Ntry node
-
-      transaction = Transaction.new
-      transaction.execution_date      = node.at('./BookgDt/Dt | ./BookgDt/DtTm').text
-      transaction.effective_date      = node.at('./ValDt/Dt | ./ValDt/DtTm').text
-      transaction.transfer_type       = get_transfer_type(node.at('./BkTxCd/Prtry'))
-      transaction.transferred_amount  = parse_amount(node)
-      transaction.transaction_details = node.xpath('.//NtryDtls//TxDtls').map{ |node| parse_TxDtls(node) }
-
-      transaction
-    end
-
-    def get_party_values node
-      # Determine to get either the debtor or creditor party node
-      # and extract the available data from it
-      values = {}
-
-      party_type = node.at('../../CdtDbtInd').text == 'CRDT' ? 'Dbtr' : 'Cdtr'
-
-      party_node = node.at("./RltdPties/#{party_type}")
-      account_node = node.at("./RltdPties/#{party_type}Acct/Id")
-      bic_node = node.at("./RltdAgts/#{party_type}Agt/FinInstnId/BIC")
-
-      if party_node
-        values[:remote_owner] = party_node.at('./Nm').try(:text)
-        values[:remote_owner_country] = party_node.at('./PstlAdr/Ctry').try(:text)
-        values[:remote_owner_address] = party_node.at('./PstlAdr/AdrLine').try(:text)
-      end
-
-      if account_node
-        values[:remote_account] = account_node.at('./IBAN').try(:text)
-        values[:remote_account] ||= account_node.at('./Othr/Id').try(:text)
-        values[:remote_bank_bic] = bic_node.text if bic_node
-      end
-
-      return values
-    end
-
-    def parse_TxDtls node
-      # Parse a single TxDtls node
-      transaction_details = {}
-
-      if (unstructured = node.xpath('./RmtInf/Ustrd')).any?
-        transaction_details[:messages] = unstructured.map(&:text)
-      end
-
-      if (structured = node.xpath('./RmtInf/Strd/CdtrRefInf/Ref | ./Refs/EndToEndId')).any?
-        transaction_details[:references] = structured.map(&:text)
-      end
-
-      if mandate_identifier = node.at('./Refs/MndtId').try(:text)
-        transaction_details[:mandate_identifier] = mandate_identifier
-      end
-
-      if reason = node.at('./RtrInf/Rsn/Cd').try(:text)
-        reason_language = Camt::Reasons.keys.include?(file.country_code) ? file.country_code : 'EN'
-        transaction_details[:reason] = { code: reason, description: Camt::Reasons[reason_language][reason] }
-      end
-
-      transaction_details[:party] = get_party_values node
-
-      transaction_details
+      Statement.new(node, file.country_code)
     end
 
     def parse_message node
@@ -171,4 +48,4 @@ module Camt
     end
 
   end
-end
+end

data/lib/camt/statement.rb

@@ -0,0 +1,86 @@
+module Camt
+  class Statement
+
+    attr_reader :node, :country_code
+
+    def initialize(xml_node, country_code)
+      @node = xml_node
+      @country_code = country_code
+    end
+
+    def id
+      @id ||= node.at('./Id').text
+    end
+
+    def electronic_sequence_number
+      @electronic_sequence_number ||= node.at('./ElctrncSeqNb').text
+    end
+
+    def created_at
+      @created_at ||= Time.parse(node.at('./CreDtTm').text)
+    end
+
+    def local_account
+      @local_account ||= node.at('./Acct/Id').text.strip
+    end
+
+    alias_method :iban, :local_account
+
+    def local_currency
+      @local_currency ||= node.at('./Acct/Ccy').try(:text) ||
+          node.at('./Bal/Amt').attribute("Ccy").value
+    end
+
+    def date
+      @date ||= Date.parse(node.at('./Ntry[1]/ValDt/Dt | ./Ntry[1]/ValDt/DtTm').text)
+    end
+
+    def start_balance
+      @start_balance ||= get_start_balance
+    end
+
+    def end_balance
+      @end_balance ||= get_end_balance
+    end
+
+    def transactions
+      @transactions ||= node.xpath('./Ntry').map { |node| parse_Ntry(node) }
+    end
+
+    private
+
+    def get_balance_type_node node, balance_type
+      # :param node: BkToCstmrStmt/Stmt/Bal node
+      # :param balance type: one of 'OPBD', 'PRCD', 'ITBD', 'CLBD'
+      node.at("./Bal/Tp/CdOrPrtry/Cd[text()='#{balance_type}']/../../..")
+    end
+
+    def get_start_balance
+      # Find the (only) balance node with code OpeningBalance, or
+      # the only one with code 'PreviousClosingBalance'
+      # or the first balance node with code InterimBalance in
+      # the case of preceeding pagination.
+      #
+      # :param node: BkToCstmrStmt/Stmt/Bal node
+      balance_type_node = nil
+      ['OPBD', 'PRCD', 'ITBD'].detect{|code| balance_type_node = get_balance_type_node(node, code) }
+      Amount.new(balance_type_node).value
+    end
+
+    def get_end_balance
+      # Find the (only) balance node with code ClosingBalance (Closing Booked), or
+      # the second (and last) balance node with code InterimBalance (Interim Booked) in
+      # the case of continued pagination. Use ClosingAvailable otherwise.
+      #
+      # :param node: BkToCstmrStmt/Stmt/Bal node
+      balance_type_node = nil
+      ['CLBD', 'ITBD', 'CLAV'].detect{|code| balance_type_node = get_balance_type_node(node, code) }
+      Amount.new(balance_type_node).value if balance_type_node
+    end
+
+    def parse_Ntry(node)
+      # :param node: Ntry node
+      Transaction.new(node, country_code)
+    end
+  end
+end