cmxl 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 037ec6226374da8a4c7f2f32109056c2bdf7219e8a1ef4d2cca79c5e644a0f77
-  data.tar.gz: 8d0f83fe9c414c0416f28383910b91d3d12dcd678664546596266c0e612084e6
+  metadata.gz: afe5eaa1a3c99146e56b607756e95dd8bcf51685e68664030b7c404be70807cd
+  data.tar.gz: da2779f99da9caa20e48ec6fefd1beb0b399e5643f2491c30df1f3dbb6b32c8c
 SHA512:
-  metadata.gz: de2ec010f0e1602366ac9149884b70feb00781a885bd9aee72adecfeeca3e5088f6943752aa9f1b29cf064f8323e55189295c37f82df427b6450ec67e349baf1
-  data.tar.gz: da503e542f541503bc43ea3b25e7e9bf3ef018f4fc34084b1272d1f3d55ad1ff0108d21079cb9819b1c19c853e1ad1ef84aa6af7bd092ecbff1946f3c535046c
+  metadata.gz: fc07aeb371d965613da239f77c5eb392f3d0d24c45978446b2658de88a3962a1caef0b620bf20424fd68712b78e25e5301d0a543f9cae02ad4e3a082e9e704f0
+  data.tar.gz: d88efb472d1df7a613651af9c71b81953a5ad32f4fc09caeea3d6f51e2e5c88a6dda5b69e7bbadfcfc4a6fd1a68b6e040ba88452dc0b0499005f635a33e6a04f

data/CHANGELOG.mdown

@@ -1,11 +1,17 @@
+# 1.2.0
+  * [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
 
 # 1.1.0
-  * [FEATURE] adds support for supplementary details in transactions (Field 61, Subfield 9) (#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)
+  * [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
 
@@ -16,8 +22,8 @@
   * MT942 support for field 13
 
 # 0.2.0
-  * added several balance related accessors (#7)
-  * configuration option for `statement separator` (#5)
+  * 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

data/README.md

@@ -42,12 +42,17 @@ Simple usage:
 ```ruby
 
 # Configuration:
-# Cmxl currently allows you to configure the statement divider - though the default should be good in most of the cases
-# and you can configure if line parsing errors should be raised
 
+# statement divider regex to split the individual statements in one file - the default is standard and should be good for most files
 Cmxl.config[:statement_separator] = /\n-.\n/m
+
+# do you want an error to be raised when a line can not be parsed? default is true
 Cmxl.config[:raise_line_format_errors] = true
 
+# try to stip the SWIFT header data. This strips everything until the actual first MT940 field. (if parsing fails try this!)
+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. 
@@ -87,6 +92,16 @@ We try to handle encoding and format wirednesses as much as possible. If no enco
 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 ....) 
+If your file comes with these headers try the `strip_headers` configuration option to strip data execpt the actual MT940 fields.
+
+```ruby
+Cmxl.config[:strip_headers] = true
+Cmxl.parse(...)
+```
+
 ### 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. 
@@ -120,6 +135,8 @@ If you have a file that can not be parsed please open an issue. We hope to build
 ## ToDo
 
 * collect MT940 files from different banks and use them as example for specs
+* support for Mt942
+* better header data handling
 
 
 ## Looking for other Banking and EBICS tools?

data/lib/cmxl.rb

@@ -10,7 +10,11 @@ module Cmxl
   def self.config
     @config
   end
-  @config = { :statement_separator => /\n-\s*\n/m, :raise_line_format_errors => true }
+  @config = {
+    :statement_separator => /\n-\s*\n/m,
+    :raise_line_format_errors => true,
+    :strip_headers => false
+  }
 
   # Public: Parse a MT940 string
   #
@@ -25,7 +29,6 @@ module Cmxl
   #
   # Returns an array of Statement objects
   def self.parse(data, options={})
-    options[:universal_newline] ||= true
     options[:statement_separator] ||= self.config[:statement_separator]
     # if no encoding is provided we try to guess using CharDet
     if options[:encoding].nil? && cd = CharDet.detect(data, silent: true)

data/lib/cmxl/statement.rb

@@ -13,6 +13,7 @@ module Cmxl
       self.source = source
       self.fields = []
       self.lines = []
+      self.strip_headers! if Cmxl.config[:strip_headers]
       self.parse!
     end
 
@@ -42,6 +43,13 @@ module Cmxl
       end
     end
 
+    def strip_headers!
+      self.source.gsub!(/\A.+?(?=^:)/m, '') # beginning: strip every line in the beginning that does not start with a :
+      self.source.gsub!(/^[^:]+\z/, '') # end: strip every line in the end that does not start with a :
+      self.source.strip!
+    end
+
+
     # Public: SHA2 of the provided source
     # This is an experiment of trying to identify statements. The MT940 itself might not provide a unique identifier
     #

data/lib/cmxl/version.rb

@@ -1,3 +1,3 @@
 module Cmxl
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/spec/fixtures/mt940-headers.txt

@@ -0,0 +1,11 @@
+{1:D02AASDISLNETAXXXXXXXXXXXXX}
+{2:E623XXXXXXXXAXXXN}
+{4:
+:20:MT940/78374
+:25:xxxxxxxxxxxxxx
+:28C:3/1
+:60F:C160201INR0,00
+:61:3622687806CR1368378,92NMSC37935531
+:86:-TX TRN-REF NO.1156ADS5601187 EUR 13456/TSV           
+:62F:C141387INR11 27421,94
+-}

data/spec/mt940_parsing_spec.rb

@@ -75,4 +75,16 @@ describe 'parsing a statement' do
       expect(subject.size).to eq(3)
     end
   end
+
+  describe 'MT940 with headers' do
+    before { Cmxl.config[:strip_headers] = true }
+    after { Cmxl.config[:strip_headers] = false }
+    subject { Cmxl.parse(mt940_file('mt940-headers')) }
+
+    it { expect(subject.count).to eql(1) }
+
+    it 'parses the statement without problems' do
+      expect(subject[0].transactions.count).to eql(1)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmxl
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Michael Bumann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-24 00:00:00.000000000 Z
+date: 2018-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -154,6 +154,7 @@ files:
 - spec/fixtures/lines/statement_supplementary_complex.txt
 - spec/fixtures/lines/statement_supplementary_plain.txt
 - spec/fixtures/mt940-deutsche_bank.txt
+- spec/fixtures/mt940-headers.txt
 - spec/fixtures/mt940-iso8859-1.txt
 - spec/fixtures/mt940-with-detailed-end-balance.txt
 - spec/fixtures/mt940.txt
@@ -219,6 +220,7 @@ test_files:
 - spec/fixtures/lines/statement_supplementary_complex.txt
 - spec/fixtures/lines/statement_supplementary_plain.txt
 - spec/fixtures/mt940-deutsche_bank.txt
+- spec/fixtures/mt940-headers.txt
 - spec/fixtures/mt940-iso8859-1.txt
 - spec/fixtures/mt940-with-detailed-end-balance.txt
 - spec/fixtures/mt940.txt