cmxl 0.0.1

data/lib/cmxl/fields/statement_line.rb

@@ -0,0 +1,47 @@
+module Cmxl
+  module Fields
+    class StatementLine < Field
+      self.tag = 61
+      self.parser = /\A(?<date>\d{6})(?<entry_date>\d{4})?(?<funds_code>[a-zA-Z])(?<currency_letter>[a-zA-Z])\D?(?<amount>\d{1,12},\d{0,2})(?<swift_code>(?:N|F).{3})(?<reference>NONREF|.{0,16})(?:$|\/\/)(?<bank_reference>.*)/i
+
+      def credit?
+        self.data['funds_code'].to_s.upcase == 'C'
+      end
+
+      def debit?
+        !credit?
+      end
+
+      def sign
+        self.credit? ? 1 : -1
+      end
+
+      def amount
+        self.data['amount'].gsub(',','.').to_f * sign
+      end
+
+      def amount_in_cents
+        self.data['amount'].gsub(',', '').gsub('.','').to_i * sign
+      end
+
+      def date
+        to_date(self.data['date'])
+      end
+      def entry_date
+        to_date(self.data['entry_date'], self.date.year)
+      end
+
+      def to_h
+        super.merge({
+          'date' => date,
+          'entry_date' => entry_date,
+          'amount' => amount,
+          'amount_in_cents' => amount_in_cents,
+          'sign' => sign,
+          'debit' => debit?,
+          'credit' => credit?
+        })
+      end
+    end
+  end
+end

data/lib/cmxl/fields/statement_number.rb

@@ -0,0 +1,8 @@
+module Cmxl
+  module Fields
+    class StatementNumber < Field
+      self.tag = 28
+      self.parser = /(?<statement_number>\d{5})\/(?<sequence_number>\d{3,5})/
+    end
+  end
+end

data/lib/cmxl/statement.rb

@@ -0,0 +1,84 @@
+require 'digest/sha2'
+module Cmxl
+  class Statement
+    attr_accessor :source, :collection, :transactions, :fields, :lines
+
+    def initialize(source)
+      self.source = source
+      self.fields = []
+      self.lines = []
+      self.transactions = []
+      self.parse!
+    end
+
+    def parse!
+      # first we clean uo the source and make concat wraped lines
+      self.source.split("\n").each do |line|
+        if line.start_with?(':') || self.lines.last.nil?
+          self.lines << line.strip
+        else
+          self.lines.last << line.strip
+        end
+      end
+      # now we check each line. if it is part of a transaction we initate or update a transaction else we parse the field and add it to the fields collection
+      self.lines.each do |line|
+        if line.match(/\A:61:/)
+          self.transactions << Cmxl::Transaction.new(line)
+        elsif line.match(/\A:86:/) && !self.transactions.last.nil?
+          self.transactions.last.details = line
+        else
+          self.fields << Field.parse(line)
+        end
+      end
+    end
+
+    def sha
+     Digest::SHA2.new.update(self.source).to_s
+    end
+
+    def reference
+      self.field(20).reference
+    end
+
+    def generation_date
+      self.field(20).date
+    end
+
+    def account_identification
+      self.field(25)
+    end
+
+    def opening_balance
+      self.field(60, 'F')
+    end
+
+    def closing_balance
+      self.field(62, 'F')
+    end
+
+    def available_balance
+      self.field(64)
+    end
+
+    def to_h
+      {
+        'reference' => reference,
+        'sha' => sha,
+        'generation_date' => generation_date,
+        'account_identification' => account_identification,
+        'opening_balance' => opening_balance,
+        'closing_balance' => closing_balance,
+        'available_balance' => available_balance,
+        'transactions' => transactions
+      }
+    end
+    alias :to_hash :to_h
+    def to_json(*args)
+      to_h.to_json(*args)
+    end
+
+    def field(tag, modifier=nil)
+      self.fields.detect {|field| field.tag == tag.to_s && (modifier.nil? || field.modifier == modifier) }
+    end
+  end
+end

data/lib/cmxl/transaction.rb

@@ -0,0 +1,91 @@
+module Cmxl
+  class Transaction
+    attr_accessor :statement_line, :details
+
+    def initialize(statement_line, details = nil)
+      self.statement_line = statement_line
+      self.details = details
+    end
+
+    def statement_line=(line)
+      @statement_line = Cmxl::Fields::StatementLine.parse(line) unless line.nil?
+    end
+
+    def details=(line)
+      @details = Cmxl::Fields::StatementDetails.parse(line) unless line.nil?
+    end
+
+    def debit?
+      self.statement_line.debit?
+    end
+    def credit?
+      self.statement_line.credit?
+    end
+    def amount
+      self.statement_line.amount
+    end
+    def sign
+      self.statement_line.sign
+    end
+    def funds_code
+      self.statement_line.funds_code
+    end
+    def amount_in_cents
+      self.statement_line.amount_in_cents
+    end
+    def date
+      self.statement_line.date
+    end
+    def entry_date
+      self.statement_line.entry_date
+    end
+    def funds_code
+      self.statement_line.funds_code
+    end
+    def currency_letter
+      self.statement_line.currency_letter
+    end
+    def swift_code
+      self.statement_line.swift_code
+    end
+    def reference
+      self.statement_line.reference
+    end
+    def bank_reference
+      self.statement_line.bank_reference
+    end
+    def description
+      self.details.description if self.details
+    end
+    def information
+      self.details.information if self.details
+    end
+    def bic
+      self.details.bic if self.details
+    end
+    def name
+      self.details.name if self.details
+    end
+    def iban
+      self.details.iban if self.details
+    end
+    def sepa
+      self.details.sepa if self.details
+    end
+    def sub_fields
+      self.details.sub_fields if self.details
+    end
+
+    def to_h
+      {}.tap do |h|
+        h.merge!(self.statement_line.to_h)
+        h.merge!(self.details.to_h) if self.details
+      end
+    end
+    alias :to_hash :to_h
+    def to_json(*args)
+      to_h.to_json(*args)
+    end
+  end
+
+end

data/lib/cmxl/version.rb

@@ -0,0 +1,3 @@
+module Cmxl
+  VERSION = "0.0.1"
+end

data/spec/fields/account_balance_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'date'
+describe Cmxl::Fields::AccountBalance do
+
+  context 'Credit' do
+    subject { Cmxl::Fields::AccountBalance.parse( fixture_line(:account_balance_credit) ) }
+
+    it { expect(subject.date).to eql(Date.new(2014,8,29)) }
+    it { expect(subject).to be_credit }
+    it { expect(subject).to_not be_debit }
+    it { expect(subject.currency).to eql('EUR') }
+
+    it { expect(subject.amount).to eql(147.64) }
+    it { expect(subject.amount_in_cents).to eql(14764) }
+    it { expect(subject.sign).to eql(1) }
+    it { expect(subject.to_h).to eql({
+        'date' =>Date.new(2014,8,29),
+        'funds_code' =>"C",
+        'credit' =>true,
+        'debit' =>false,
+        'currency' =>"EUR",
+        'amount' =>147.64,
+        'amount_in_cents' =>14764,
+        'sign' =>1
+    }) }
+  end
+
+  context 'Debit' do
+    subject { Cmxl::Fields::AccountBalance.parse( fixture_line(:account_balance_debit) ) }
+
+    it { expect(subject.date).to eql(Date.new(2014,8,29)) }
+    it { expect(subject).to_not be_credit }
+    it { expect(subject).to be_debit }
+    it { expect(subject.currency).to eql('EUR') }
+
+    it { expect(subject.amount).to eql(-147.64) }
+    it { expect(subject.amount_in_cents).to eql(-14764) }
+    it { expect(subject.sign).to eql(-1) }
+  end
+
+end

data/spec/fields/account_identification_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Cmxl::Fields::AccountIdentification do
+
+  context 'legacy data' do
+    subject { Cmxl::Fields::AccountBalance.parse( fixture_line(:account_identification_legacy) ) }
+
+    it { expect(subject.bank_code).to eql('70011110') }
+    it { expect(subject.account_number).to eql('4005287001') }
+    it { expect(subject.currency).to eql('EUR') }
+    it { expect(subject.country).to be_nil }
+
+  end
+
+  context 'iban' do
+    subject { Cmxl::Fields::AccountBalance.parse( fixture_line(:account_identification_iban) ) }
+    it { expect(subject.country).to eql('PL') }
+    it { expect(subject.ban).to eql('25106000760000888888888888') }
+    it { expect(subject.iban).to eql('PL25106000760000888888888888') }
+    it { expect(subject.bank_code).to be_nil }
+
+  end
+
+end

data/spec/fields/available_balance_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Cmxl::Fields::AvailableBalance do
+
+  subject { Cmxl::Fields::AvailableBalance.parse(fixture_line(:available_balance)) }
+
+  it { expect(subject.date).to eql(Date.new(2014,9,1)) }
+  it { expect(subject).to_not be_credit }
+  it { expect(subject).to be_debit }
+  it { expect(subject.currency).to eql('EUR') }
+
+  it { expect(subject.amount).to eql(-3.66) }
+  it { expect(subject.amount_in_cents).to eql(-366) }
+  it { expect(subject.sign).to eql(-1) }
+
+end

data/spec/fields/closing_balance_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Cmxl::Fields::ClosingBalance do
+
+  subject { Cmxl::Fields::ClosingBalance.parse(fixture_line(:closing_balance)) }
+
+  it { expect(subject.date).to eql(Date.new(2014,9,1)) }
+  it { expect(subject).to be_credit }
+  it { expect(subject).to_not be_debit }
+
+  it { expect(subject.amount).to eql(137.0) }
+  it { expect(subject.amount_in_cents).to eql(13700) }
+  it { expect(subject.sign).to eql(1) }
+
+end

data/spec/fields/reference_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Cmxl::Fields::Reference do
+
+  subject { Cmxl::Fields::Reference.parse(fixture_line(:reference)) }
+
+  it { expect(subject.reference).to eql('D140902049') }
+  it { expect(subject.date).to eql(Date.new(2014,9,2)) }
+  it { expect(subject.statement_identifier).to eql('D') }
+  it { expect(subject.additional_number).to eql('049') }
+  it { expect(subject.to_h).to eql({"statement_identifier"=>"D", "date"=> Date.new(2014,9,2), "additional_number"=>"049", "reference"=>"D140902049"}) }
+end

data/spec/fields/statement_details_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Cmxl::Fields::StatementDetails do
+
+  context 'sepa' do
+    subject { Cmxl::Fields::StatementDetails.parse(fixture_line(:statement_details)) }
+
+    it { expect(subject.transaction_code).to eql('171') }
+    it { expect(subject.seperator).to eql('?') }
+    it { expect(subject.description).to eql('SEPA LASTSCHRIFT KUNDE') }
+    it { expect(subject.information).to eql('EREF+TRX-0A4A47C3-F846-4729-8A1B-5DF620FMREF+CAC97D2144174318AC18D9BF815BD4FBCRED+DE98ZZZ09999999999SVWZ+FOO TRX-0A4A47C3-F846-4729-8A1B-5DF620F') }
+    it { expect(subject.bic).to eql('HYVEDEMMXXX' ) }
+    it { expect(subject.name).to eql('Peter Pan') }
+    it { expect(subject.iban).to eql('HUkkbbbsssskcccccccccccccccx') }
+    it { expect(subject.sub_fields).to eql({
+        "00" => "SEPA LASTSCHRIFT KUNDE",
+        "10" => "281",
+        "20" => "EREF+TRX-0A4A47C3-F846-4729",
+        "21" => "-8A1B-5DF620F",
+        "22" => "MREF+CAC97D2144174318AC18D9",
+        "23" => "BF815BD4FB",
+        "24" => "CRED+DE98ZZZ09999999999",
+        "25" => "SVWZ+FOO TRX-0A4A47C3-F84",
+        "26" => "6-4729-8A1B-5DF620F",
+        "30" => "HYVEDEMMXXX",
+        "31" => "HUkkbbbsssskcccccccccccccccx",
+        "32" => "Peter Pan",
+        "34" => "171"
+    }) }
+    it { expect(subject.sepa).to eql({
+          "CRED" => "DE98ZZZ09999999999",
+          "EREF" => "TRX-0A4A47C3-F846-4729-8A1B-5DF620F",
+          "MREF" => "CAC97D2144174318AC18D9BF815BD4FB",
+          "SVWZ" => "FOO TRX-0A4A47C3-F846-4729-8A1B-5DF620F"
+    }) }
+
+    it { expect(subject.to_h).to eql({'bic'=>"HYVEDEMMXXX", 'iban'=>"HUkkbbbsssskcccccccccccccccx", 'name' => "Peter Pan", 'sepa' => {"EREF"=>"TRX-0A4A47C3-F846-4729-8A1B-5DF620F", "MREF"=>"CAC97D2144174318AC18D9BF815BD4FB", "CRED"=>"DE98ZZZ09999999999", "SVWZ"=>"FOO TRX-0A4A47C3-F846-4729-8A1B-5DF620F"}, 'information' => "EREF+TRX-0A4A47C3-F846-4729-8A1B-5DF620FMREF+CAC97D2144174318AC18D9BF815BD4FBCRED+DE98ZZZ09999999999SVWZ+FOO TRX-0A4A47C3-F846-4729-8A1B-5DF620F", 'description' => "SEPA LASTSCHRIFT KUNDE", 'sub_fields' => {"00"=>"SEPA LASTSCHRIFT KUNDE", "10"=>"281", "20"=>"EREF+TRX-0A4A47C3-F846-4729", "21"=>"-8A1B-5DF620F", "22"=>"MREF+CAC97D2144174318AC18D9", "23"=>"BF815BD4FB", "24"=>"CRED+DE98ZZZ09999999999", "25"=>"SVWZ+FOO TRX-0A4A47C3-F84", "26"=>"6-4729-8A1B-5DF620F", "30"=>"HYVEDEMMXXX", "31"=>"HUkkbbbsssskcccccccccccccccx", "32"=>"Peter Pan", "34"=>"171"}, 'transaction_code' => "171", 'details' => "?00SEPA LASTSCHRIFT KUNDE?10281?20EREF+TRX-0A4A47C3-F846-4729?21-8A1B-5DF620F?22MREF+CAC97D2144174318AC18D9?23BF815BD4FB?24CRED+DE98ZZZ09999999999?25SVWZ+FOO TRX-0A4A47C3-F84?266-4729-8A1B-5DF620F?30HYVEDEMMXXX?31HUkkbbbsssskcccccccccccccccx?32Peter Pan?34171"}) }
+  end
+
+end

data/spec/fields/statement_number_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Cmxl::Fields::StatementNumber do
+
+  subject { Cmxl::Fields::StatementNumber.parse(fixture_line(:statement_number)) }
+
+  it { expect(subject.statement_number).to eql('00035') }
+  it { expect(subject.sequence_number).to eql('001') }
+
+end

data/spec/fields/statment_line_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Cmxl::Fields::StatementLine do
+
+  subject { Cmxl::Fields::StatementLine.parse(fixture_line(:statement_line)) }
+
+  it { expect(subject.date).to eql(Date.new(2014,9,1)) }
+  it { expect(subject.entry_date).to eql(Date.new(2014,9,2)) }
+  it { expect(subject.funds_code).to eql('D') }
+  it { expect(subject.currency_letter).to eql('R') }
+  it { expect(subject.amount).to eql(-1.62) }
+  it { expect(subject.amount_in_cents).to eql(-162) }
+  it { expect(subject.swift_code).to eql('NTRF') }
+  it { expect(subject.reference).to eql('0000549855700010') }
+  it { expect(subject.bank_reference).to eql('025498557/000001') }
+  it { expect(subject).to_not be_credit }
+  it { expect(subject).to be_debit }
+  it { expect(subject.sign).to eql(-1) }
+end

data/spec/fields/unknown_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe 'Unknwn fields' do
+
+  subject { Cmxl::Field.parse(':42F:C140908EUR000000000136,02') }
+  it { expect(subject.tag).to eql('42') }
+  it { expect(subject.source).to eql('C140908EUR000000000136,02') }
+  it { expect(subject.to_h).to eql({tag: '42', modifier: 'F', source: 'C140908EUR000000000136,02'}) }
+end

data/spec/fixtures/lines/account_balance_credit.txt

@@ -0,0 +1 @@
+:60F:C140829EUR000000000147,64