cmxl 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afe5eaa1a3c99146e56b607756e95dd8bcf51685e68664030b7c404be70807cd
-  data.tar.gz: da2779f99da9caa20e48ec6fefd1beb0b399e5643f2491c30df1f3dbb6b32c8c
+  metadata.gz: 4a9d2c6d5faed6e357abd5459811d43764a89448fc46763993938b1519b17a2a
+  data.tar.gz: 3861abc066158de7c4468d9df01a57331d1913b1d84645b7618f2d146c419a47
 SHA512:
-  metadata.gz: fc07aeb371d965613da239f77c5eb392f3d0d24c45978446b2658de88a3962a1caef0b620bf20424fd68712b78e25e5301d0a543f9cae02ad4e3a082e9e704f0
-  data.tar.gz: d88efb472d1df7a613651af9c71b81953a5ad32f4fc09caeea3d6f51e2e5c88a6dda5b69e7bbadfcfc4a6fd1a68b6e040ba88452dc0b0499005f635a33e6a04f
+  metadata.gz: 716ee9967921b4539174032223aae5eb996ada741c2181b556e7bb8ec5355668aedd8167ba564836ee73a8a8fa7256d83a74c4f6d8309496cde600c7d631b66c
+  data.tar.gz: 4395610ac7de16b264b309940eda9a2727cfce3c49f8cf051b91f4ab0f8f0486c2caf0528a8efd995fd327f31ccefc288a860f8e458b6ba7b0f1ffe7be85939e

data/.travis.yml

@@ -6,8 +6,11 @@ rvm:
   - 2.4.3
   - 2.5.0
   - jruby-9.1.10.0
-before_install:
-  gem update --system
+before_install: if [[ `ruby -v` =~ 2.2.8 ]];
+  then gem update --system 2.7.8;
+  else gem update --system;
+  fi
+
 after_success:
   - bundle exec codeclimate-test-reporter
 addons:

data/CHANGELOG.mdown

@@ -1,35 +1,45 @@
+# 1.3.0
+
+- [FEATURE] adds MT942 compatibility
+
 # 1.2.0
-  * [FEATURE] strips mt940 header if configured ([#9](https://github.com/railslove/cmxl/issues/9))
-    ```ruby
-      Cmxl.config[:strip_headers] = true
-    ```
+
+- [FEATURE] strips mt940 header if configured ([#9](https://github.com/railslove/cmxl/issues/9))
+  ```ruby
+    Cmxl.config[:strip_headers] = true
+  ```
 
 # 1.1.1
-  * [BUGFIX] prevents short bank references from swallowing supplementary details delimiter
+
+- [BUGFIX] prevents short bank references from swallowing supplementary details delimiter
 
 # 1.1.0
-  * [FEATURE] adds support for supplementary details in transactions (Field 61, Subfield 9) ([#18](https://github.com/railslove/cmxl/issues/18))
+
+- [FEATURE] adds support for supplementary details in transactions (Field 61, Subfield 9) ([#18](https://github.com/railslove/cmxl/issues/18))
 
 # 1.0.0
-  * [FEATURE] adds support for storno transactions ([#14](https://github.com/railslove/cmxl/issues/14))
-  * [NOTE] full backwards compatibility
-  * [NOTE] same as release 0.2.2, fixing versioning
+
+- [FEATURE] adds support for storno transactions ([#14](https://github.com/railslove/cmxl/issues/14))
+- [NOTE] full backwards compatibility
+- [NOTE] same as release 0.2.2, fixing versioning
 
 # 0.2.1
-  * addressing an bug that occoured for transactions submitted end of
-    but were fetched in the new year -> those ended up with the wrong year
-    on the entry date
-  * MT942 support for field 13
+
+- addressing an bug that occoured for transactions submitted end of
+  but were fetched in the new year -> those ended up with the wrong year
+  on the entry date
+- MT942 support for field 13
 
 # 0.2.0
-  * added several balance related accessors ([#7](https://github.com/railslove/cmxl/issues/7))
-  * configuration option for `statement separator` ([#5](https://github.com/railslove/cmxl/issues/5))
-  * improvement for general compatibility
+
+- added several balance related accessors ([#7](https://github.com/railslove/cmxl/issues/7))
+- configuration option for `statement separator` ([#5](https://github.com/railslove/cmxl/issues/5))
+- improvement for general compatibility
 
 # 0.1.3
 
-  * [BUGFIX] fixed the statement details parser. It failed in case of empty values in the SEPA details
+- [BUGFIX] fixed the statement details parser. It failed in case of empty values in the SEPA details
 
 # 0.1.2
 
-  * [BUGFIX] fixed the statement details parser. It failed in case of empty values in the sub fields
+- [BUGFIX] fixed the statement details parser. It failed in case of empty values in the sub fields

data/README.md

@@ -2,24 +2,24 @@
 
 # Cmxl - your friendly ruby MT940 parser
 
-At [Railslove](http://railslove.com) we build a lot of financial applications and work on integrating applications with banks and banking functionality. 
+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. 
+Cmxl is a friendly and extendible MT940 bank statement file parser that helps your extracting data from the bank statement files.
 
-## What is MT940?
+## What is MT940 & MT942?
 
-MT940 (MT = Message Type) is the SWIFT-Standard for the electronic transfer of bank statement files. 
-When integrating with banks you often get MT940 files as interface. 
+MT940 (MT = Message Type) is the SWIFT-Standard for the electronic transfer of bank statement files.
+When integrating with banks you often get MT940 or MT942 files as interface.
 For more information have a look at the different [SWIFT message types](http://en.wikipedia.org/wiki/SWIFT_message_types)
 
 At some point in the future MT940 file should be exchanged with newer XML documents - but banking institutions are slow so MT940 will stick around for a while.
 
 ## Reqirements
 
-Cmxl is a pure ruby parser and has no dependency on native extensions. 
+Cmxl is a pure ruby parser and has no dependency on native extensions.
 
-* Ruby 1.9.3 or newer (jruby, etc.)
+- Ruby 1.9.3 or newer (jruby, etc.)
 
 ## Installation
 
@@ -37,7 +37,7 @@ Or install it yourself as:
 
 ## Usage
 
-Simple usage: 
+Simple usage:
 
 ```ruby
 
@@ -55,14 +55,14 @@ Cmxl.config[:strip_headers] = true
 
 # Statment parsing:
 
-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 = 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 s.sha # SHA of the statement source - could be used as an unique identifier
-  
+
   s.transactions.each do |t|
     puts t.information
     puts t.description
@@ -87,14 +87,14 @@ Every object responds to `to_h` and let's you easily convert the data to a hash.
 
 #### 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 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) 
+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 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.
 
 ### MT940 SWIFT header data
 
-Cmxl currently does not support parsing of the SWIFT headers (like {1:F01AXISINBBA ....) 
+Cmxl currently does not support parsing of the SWIFT headers (like {1:F01AXISINBBA ....)
 If your file comes with these headers try the `strip_headers` configuration option to strip data execpt the actual MT940 fields.
 
 ```ruby
@@ -102,9 +102,31 @@ Cmxl.config[:strip_headers] = true
 Cmxl.parse(...)
 ```
 
+### MT942 data
+
+CMXL is now also capable of parsing MT942 data. Just pass the data and the parser will identify the type automatically.
+
+```ruby
+first_statement = Cmxl.parse(File.read('mt940.txt'), :encoding => 'ISO-8859-1').first
+puts first_statement.mt942?
+#=> false
+
+first_statement = Cmxl.parse(File.read('mt942.txt'), :encoding => 'ISO-8859-1').first
+puts first_statement.mt942?
+#=> true
+
+p first_statement.vmk_credit_summary.to_h
+#=> { type: 'credit', entries: 1, amount: 9792.0, currency: 'EUR' }
+
+p first_statement.vmk_dedit_summary.to_h
+#=> { type: 'debit', entries: 0, amount: 0.0, currency: 'EUR' }
+
+first_statement.transactions # same as for MT940
+```
+
 ### 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 individual 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
@@ -128,23 +150,20 @@ my_field_parser.data #=> {'world' => 'hello from mt940'} - data is the accessor
 
 ## Parsing issues? - please create an issue with your file
 
-The Mt940 format often looks different for the different banks and the different countries. Especially the not strict defined fields are often used for custom bank data. 
+The Mt940 format often looks different for the different banks and the different countries. Especially the not strict defined fields are often used for custom bank data.
 If you have a file that can not be parsed please open an issue. We hope to build a parser that handles most of the files.
 
-
 ## ToDo
 
-* collect MT940 files from different banks and use them as example for specs
-* support for Mt942
-* better header data handling
-
+- collect MT940 files from different banks and use them as example for specs
+- better header data handling
 
 ## 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
+- [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
 
@@ -161,9 +180,9 @@ Automated tests: We use rspec to test Cmxl. Simply run `rake` to execute the who
 Cmxl is inspired and borrows ideas from the `mt940_parser` by the great people at [betterplace](https://www.betterplace.org/).
 
 other parsers:
-* [betterplace/mt940_parser](https://github.com/betterplace/mt940_parser)
-* [gmitrev/mt940parser](https://github.com/gmitrev/mt940parser)
 
+- [betterplace/mt940_parser](https://github.com/betterplace/mt940_parser)
+- [gmitrev/mt940parser](https://github.com/gmitrev/mt940parser)
 
 ## Stats
 
@@ -172,6 +191,6 @@ other parsers:
 [![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) 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/cmxl.gemspec

@@ -1,30 +1,29 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cmxl/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "cmxl"
+  spec.name          = 'cmxl'
   spec.version       = Cmxl::VERSION
-  spec.authors       = ["Michael Bumann"]
-  spec.email         = ["michael@railslove.com"]
-  spec.summary       = %q{Cmxl is your friendly MT940 bank statement parser}
-  spec.description   = %q{Cmxl provides an friendly, extensible and customizable parser for the MT940 bank statement format.}
-  spec.homepage      = "https://github.com/railslove/cmxl"
-  spec.license       = "MIT"
+  spec.authors       = ['Michael Bumann']
+  spec.email         = ['michael@railslove.com']
+  spec.summary       = 'Cmxl is your friendly MT940 bank statement parser'
+  spec.description   = 'Cmxl provides an friendly, extensible and customizable parser for the MT940 bank statement format.'
+  spec.homepage      = 'https://github.com/railslove/cmxl'
+  spec.license       = 'MIT'
 
   spec.post_install_message = "Thanks for using Cmxl - your friendly MT940 parser!\nWe hope we can make dealing with MT940 files a bit more fun. :) \nPlease create an issue on github if anything is not as expected.\n\n"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", '~>3.0'
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~>3.0'
+  spec.add_development_dependency 'simplecov'
 
-  spec.add_dependency "rchardet19"
+  spec.add_dependency 'rchardet19'
 end

data/lib/cmxl.rb

@@ -1,6 +1,6 @@
-require "cmxl/version"
+require 'cmxl/version'
 
-require "rchardet19"
+require 'rchardet19'
 
 require 'cmxl/field'
 require 'cmxl/statement'
@@ -11,9 +11,9 @@ module Cmxl
     @config
   end
   @config = {
-    :statement_separator => /\n-\s*\n/m,
-    :raise_line_format_errors => true,
-    :strip_headers => false
+    statement_separator: /\n-\s*\n/m,
+    raise_line_format_errors: true,
+    strip_headers: false
   }
 
   # Public: Parse a MT940 string
@@ -28,8 +28,8 @@ module Cmxl
   # Cmxl.parse(mt940_string)
   #
   # Returns an array of Statement objects
-  def self.parse(data, options={})
-    options[:statement_separator] ||= self.config[:statement_separator]
+  def self.parse(data, options = {})
+    options[:statement_separator] ||= config[:statement_separator]
     # if no encoding is provided we try to guess using CharDet
     if options[:encoding].nil? && cd = CharDet.detect(data, silent: true)
       options[:encoding] = cd.encoding
@@ -38,9 +38,9 @@ module Cmxl
     if options[:encoding]
       data.encode!('UTF-8', options.delete(:encoding), options)
     else
-      data.encode!('UTF-8', options) if !options.empty?
+      data.encode!('UTF-8', options) unless options.empty?
     end
 
-    data.split(options[:statement_separator]).reject { |s| s.strip.empty? }.collect {|s| Cmxl::Statement.new(s.strip) }
+    data.split(options[:statement_separator]).reject { |s| s.strip.empty? }.collect { |s| Cmxl::Statement.new(s.strip) }
   end
 end

data/lib/cmxl/field.rb

@@ -2,13 +2,13 @@ require 'date'
 module Cmxl
   class Field
     class LineFormatError < StandardError; end
-    class Unknown < Field;
-      @parser= /(?<source>.*)/
+    class Unknown < Field
+      @parser = /(?<source>.*)/
       def to_h
         { tag: tag, modifier: modifier, source: source }
       end
     end
-    DATE = /(?<year>\d{0,2})(?<month>\d{2})(?<day>\d{2})/
+    DATE = /(?<year>\d{0,2})(?<month>\d{2})(?<day>\d{2})/.freeze
     attr_accessor :source, :modifier, :match, :data, :tag
 
     # The parser class variable is the registry of all available parser.
@@ -16,7 +16,9 @@ module Cmxl
     # When parsing a statment line we look for a matching entry or use the Unknown class as default
     @@parsers = {}
     @@parsers.default = Unknown
-    def self.parsers; @@parsers; end
+    def self.parsers
+      @@parsers
+    end
 
     # Class accessor for the parser
     # Every sub class should have its own parser (regex to parse a MT940 field/line)
@@ -30,8 +32,9 @@ module Cmxl
       @tag = tag.to_s
       @@parsers[tag.to_s] = self
     end
-    def self.tag
-      @tag
+
+    class << self
+      attr_reader :tag
     end
 
     # Public: Parses a statement line and initiates a matching Field class
@@ -44,23 +47,25 @@ module Cmxl
     # Cmxl::Field.parse(':60F:C031002PLN40000,00') #=> returns an AccountBalance instance
     #
     def self.parse(line)
-      if line.match(/\A:(\d{2,2})(\w)?:(.*)\z/m)
-        tag, modifier, content = $1, $2, $3.gsub(/\r/, '').gsub(/\n\z/, '') # remove trailing line break to prevent empty field parsing
+      if line =~ /\A:(\d{2,2})(\w)?:(.*)\z/m
+        tag = Regexp.last_match(1)
+        modifier = Regexp.last_match(2)
+        content = Regexp.last_match(3).delete("\r").gsub(/\n\z/, '') # remove trailing line break to prevent empty field parsing
         Field.parsers[tag.to_s].new(content, modifier, tag)
       else
         raise LineFormatError, "Wrong line format: #{line.dump}" if Cmxl.config[:raise_line_format_errors]
       end
     end
 
-    def initialize(source, modifier=nil, tag=nil)
+    def initialize(source, modifier = nil, tag = nil)
       self.tag = tag
       self.modifier = modifier
       self.source = source
       self.data = {}
 
       if self.match = self.source.match(self.class.parser)
-        self.match.names.each do |name|
-          self.data[name] = self.match[name]
+        match.names.each do |name|
+          data[name] = match[name]
         end
       end
     end
@@ -70,11 +75,13 @@ module Cmxl
     end
 
     def to_h
-      self.data.merge('tag' => self.tag)
+      data.merge('tag' => tag)
     end
+
     def to_hash
       to_h
     end
+
     def to_json(*args)
       to_h.to_json(*args)
     end
@@ -89,9 +96,9 @@ module Cmxl
     # to_date('0909', 2014)
     #
     # Retuns a date object or the provided date value if it is not parseable.
-    def to_date(date, year=nil)
+    def to_date(date, year = nil)
       if match = date.to_s.match(DATE)
-        year ||= "20#{match['year'] || Date.today.strftime("%y")}"
+        year ||= "20#{match['year'] || Date.today.strftime('%y')}"
         month = match['month']
         day = match['day']
         Date.new(year.to_i, month.to_i, day.to_i)
@@ -103,18 +110,18 @@ module Cmxl
     end
 
     def to_amount_in_cents(value)
-      value.gsub(/[,|\.](\d*)/) { $1.ljust(2, '0') }.to_i
+      value.gsub(/[,|\.](\d*)/) { Regexp.last_match(1).ljust(2, '0') }.to_i
     end
 
     def to_amount(value)
-      value.gsub(',','.').to_f
+      value.tr(',', '.').to_f
     end
 
     def method_missing(m, *value)
       if m =~ /=\z/
-        self.data[m] = value.first
+        data[m] = value.first
       else
-        self.data[m.to_s]
+        data[m.to_s]
       end
     end
   end