cmxl 0.1.1 → 0.1.2

data/.travis.yml

@@ -3,4 +3,7 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.2
-  - jruby
+  - jruby
+addons:
+  code_climate:
+    repo_token: 149f0d20e17ace00c44be432a4194bc441ba805da89a7708fca0f4a2c3f2aed7

data/CHANGELOG.mdown

@@ -0,0 +1,3 @@
+# 0.1.2
+  
+  * [BUGFIX] fixed the statement details parser. It failed in case of empty values in the details

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
+gem "codeclimate-test-reporter", group: :test, require: nil
 # Specify your gem's dependencies in cmxl.gemspec
 gemspec

data/README.md

@@ -1,7 +1,7 @@
 # Cmxl - your friendly ruby MT940 parser
 
-At Railslove we build a lot of banking and payment applications and work on integrating applications with banks and banking functionality. 
-Our goal is to making it easy with what sometimes seems complicated. 
+At [Railslove](http://railslove.com) we build a lot of financial applications and work on integrating applications with banks and banking functionality. 
+Our goal is to make simple solutions for what often looks complicated.
 
 Cmxl is a friendly and extendible MT940 bank statement file parser that helps your extracting data from the bank statement files. 
 
@@ -15,9 +15,9 @@ At some point in the future MT940 file should be exchanged with newer XML docume
 
 ## Reqirements
 
-Cmxl is a pure ruby parser and has no gem dependencies. 
+Cmxl is a pure ruby parser and has no dependency on native extensions. 
 
-* Ruby 1.9.3 or newer
+* Ruby 1.9.3 or newer (jruby, etc.)
 
 ## Installation
 
@@ -48,13 +48,13 @@ Cmxl.config[:raise_line_format_errors] = true
 
 # Statment parsing:
 
-statements = Cmxl.parse(File.read('mt940.txt'), :encoding => 'ISO-8859-1') # parses the file and returns an array of statement objects
+statements = Cmxl.parse(File.read('mt940.txt'), :encoding => 'ISO-8859-1') # parses the file and returns an array of statement objects. Please note: if no encoding is given Cmxl tries to guess the encoding from the content and converts it to UTF-8. 
 statements.each do |s|
   puts s.reference
   puts s.generation_date
   puts s.opening_balance.amount
   puts s.closing_balance.amount
-  puts.sha # SHA of the statement source - could be used as an unique identifier
+  puts s.sha # SHA of the statement source - could be used as an unique identifier
   
   s.transactions.each do |t|
     puts t.information
@@ -76,18 +76,18 @@ end
 
 ```
 
-Every object responds to `to_h` and let's you easily convert the data to a hash. 
+Every object responds to `to_h` and let's you easily convert the data to a hash. Also every object responds to `to_json` which lets you easily represent the statements as JSON with your favorit JSON library.
 
 #### A note about encoding and file wirednesses
 
 You probably will encounter encoding issues (hey, you are building banking applications!). 
-We try to handle encoding and format wirednesses as much as possible.  
-If you have encoding issues you can pass encoding options to the `Cmxl.parse(<string>, <options hash>)` it accepts the same options as [String#encode](http://ruby-doc.org/core-2.1.3/String.html#method-i-encode)
+We try to handle encoding and format wirednesses as much as possible. If no encoding is passed we try to guess the encoding of the data and convert it to UTF8. 
+In the likely case that you encouter encoding issues you can pass encoding options to the `Cmxl.parse(<string>, <options hash>)` it accepts the same options as [String#encode](http://ruby-doc.org/core-2.1.3/String.html#method-i-encode) 
 If that fails try to motify the file before you pass it to the parser - and please create an issue.
 
 ### Custom field parsers
 
-Because a lot of banks implement the MT940 format slightly different one of the design goals of this library is to be able to customize the field parsers. 
+Because a lot of banks implement the MT940 format slightly different one of the design goals of this library is to be able to customize the individual field parsers. 
 Every line get parsed with a special parser. Here is how to write your own parser:
 
 ```ruby
@@ -120,10 +120,16 @@ If you have a file that can not be parsed please open an issue. We hope to build
 * collect MT940 files from different banks and use them as example for specs
 
 
+## Looking for other Banking and EBICS tools?
+
+Maybe these are also interesting for you.
+
+* [EPICS: Open Source SEPA EBICS client](https://railslove.github.io/epics/) full implementation to manage all the banking activities like direct debits, credits, etc. (SEPA Lastschrift, Überweisungen, etc.)
+* [EBICS::Box: out of the box solution to automate banking activities](http://www.railslove.com/ebics-box) - The missing API for your bank
+
 ## Contributing
 
-### Specs
-We use rspec to test Cmxl. Run `rake` to execute the whole test suite.
+Automated tests: We use rspec to test Cmxl. Simply run `rake` to execute the whole test suite.
 
 1. Fork it ( http://github.com/railslove/cmxl/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -139,10 +145,14 @@ other parsers:
 * [betterplace/mt940_parser](https://github.com/betterplace/mt940_parser)
 * [gmitrev/mt940parser](https://github.com/gmitrev/mt940parser)
 
+
 ## Stats
 
-[![Build Status](https://magnum.travis-ci.com/railslove/cmxl.svg?token=e6QUckhTMdWWujkwZNBD&branch=master)](https://magnum.travis-ci.com/railslove/cmxl)
+[![Build Status](https://travis-ci.org/railslove/cmxl.svg)](https://travis-ci.org/railslove/cmxl)
+[![Code Climate](https://codeclimate.com/github/railslove/cmxl/badges/gpa.svg)](https://codeclimate.com/github/railslove/cmxl)
+[![Test Coverage](https://codeclimate.com/github/railslove/cmxl/badges/coverage.svg)](https://codeclimate.com/github/railslove/cmxl)
+[![Gem Version](https://badge.fury.io/rb/cmxl.svg)](http://badge.fury.io/rb/cmxl)
 
 ------------
 
-2014 - built with love by [Railslove](http://railslove.com). We have built quite a number of FinTech products. If you need support we are happy to help. Please contact us at team@railslove.com.
+2014 - built with love by [Railslove](http://railslove.com) and released under the MIT-Licence. We have built quite a number of FinTech products. If you need support we are happy to help. Please contact us at team@railslove.com.

data/lib/cmxl/fields/statement_details.rb

@@ -6,7 +6,7 @@ module Cmxl
 
       def sub_fields
         @sub_fields ||= if self.data['details'] =~ /#{Regexp.escape(self.data['seperator'])}(\d{2})/
-            Hash[*self.data['details'].split(/#{Regexp.escape(self.data['seperator'])}(\d{2})/).reject(&:empty?)]
+            Hash[self.data['details'].scan(/#{Regexp.escape(self.data['seperator'])}(\d{2})([^#{Regexp.escape(self.data['seperator'])}]*)/)]
           else
             {}
           end
@@ -34,7 +34,7 @@ module Cmxl
       end
 
       def name
-        "#{self.sub_fields['32']}#{self.sub_fields['33']}"
+        [self.sub_fields['32'], self.sub_fields['33']].compact.join(" ")
       end
 
       def iban

data/lib/cmxl/statement.rb

@@ -44,7 +44,7 @@ module Cmxl
     # Public: SHA2 of the provided source
     # This is an experiment of trying to identify statements. The MT940 itself might not provide a unique identifier
     #
-    # Retruns the SHA2 of the source
+    # Returns the SHA2 of the source
     def sha
       Digest::SHA2.new.update(self.source).to_s
     end

data/lib/cmxl/version.rb

@@ -1,3 +1,3 @@
 module Cmxl
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/fields/statement_details_spec.rb

@@ -25,6 +25,7 @@ describe Cmxl::Fields::StatementDetails do
         "30" => "HYVEDEMMXXX",
         "31" => "HUkkbbbsssskcccccccccccccccx",
         "32" => "Peter Pan",
+        "99" => "",
         "34" => "171"
     }) }
     it { expect(subject.sepa).to eql({
@@ -34,7 +35,7 @@ describe Cmxl::Fields::StatementDetails do
           "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"}) }
+    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", "99" => ""}, '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?99?34171"}) }
     it { expect(subject.to_hash).to eql(subject.to_h) }
   end
 

data/spec/fixtures/lines/statement_details.txt

@@ -1 +1 @@
-:86:171?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
+:86:171?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?99?34171

data/spec/mt940_parsing_spec.rb

@@ -55,7 +55,7 @@ describe 'parsing a statement' do
     it { expect(subject.transactions.count).to eql(3) }
     it { expect(subject.transactions.first.description).to eql('Wyplata-(dysp/przel)') }
     it { expect(subject.transactions.first.information).to eql('0810600076000077777777777715617INFO INFO INFO INFO INFO INFO 1 ENDINFO INFO INFO INFO INFOINFO 2 ENDZAPLATA ZA FABRYKATY DO TUB - 200 S ZTUK, TRANZYSTORY-300 SZT GR544 I OPORNIKI-500 SZT GTX847 FAKTURA 333/2003.') }
-    it { expect(subject.transactions.first.name).to eql('HUTA SZKLA TOPIC ULPRZEMYSLOWA 67 32-669 WROCLAW') }
+    it { expect(subject.transactions.first.name).to eql('HUTA SZKLA TOPIC ULPRZEMY SLOWA 67 32-669 WROCLAW') }
     it { expect(subject.transactions.first.bic).to eql('10600076') }
     it { expect(subject.transactions.first.iban).to eql('PL08106000760000777777777777') }
     it { expect(subject.transactions.first.sepa).to eql({}) }

data/spec/spec_helper.rb

@@ -1,8 +1,12 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require 'cmxl'
 
+
 puts File.join(File.dirname(__FILE__), "support/**/*.rb").to_s
 Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f}
 

data/spec/transaction_spec.rb

@@ -12,7 +12,7 @@ describe Cmxl::Transaction do
     it { expect(subject.amount).to eql(1.62)}
     it { expect(subject.statement_line.amount).to eql(1.62)}
     it { expect(subject.amount_in_cents).to eql(162)}
-    it { expect(subject.to_h).to eql({"date"=>Date.new(2014,9,1), "sha" => "3c5e65aa3d3878b06b58b6f1ae2f3693004dfb04e3ab7119a1c1244e612293da", "entry_date"=>Date.new(2014,9,2), "funds_code"=>"D", "currency_letter"=>"R", "amount"=>1.62, "swift_code"=>"NTRF", "reference"=>"0000549855700010", "bank_reference"=>"025498557/000001", "amount_in_cents"=>162, "sign"=>-1, "debit"=>true, "credit"=>false, "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"}) }
+    it { expect(subject.to_h).to eql({"date"=>Date.new(2014,9,1), "sha" => "3c5e65aa3d3878b06b58b6f1ae2f3693004dfb04e3ab7119a1c1244e612293da", "entry_date"=>Date.new(2014,9,2), "funds_code"=>"D", "currency_letter"=>"R", "amount"=>1.62, "swift_code"=>"NTRF", "reference"=>"0000549855700010", "bank_reference"=>"025498557/000001", "amount_in_cents"=>162, "sign"=>-1, "debit"=>true, "credit"=>false, "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", "99" => "", "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?99?34171"}) }
   end
 
   context 'without details' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cmxl
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2015-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.mdown
 - Gemfile
 - LICENSE.txt
 - README.md