cmxl 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db1917122b50744544c13bdb1bcb82841df8f909
-  data.tar.gz: a7576890df969cc890c953d348a419bef20c3994
+  metadata.gz: 82b72d8655b552c6a10bae7df6882bf313ea472b
+  data.tar.gz: 630a7f8c31eee13bec9ca238ea492f0bad384515
 SHA512:
-  metadata.gz: 7d69bc9388edbea99a3746841df29df16cf6df0d7e523a8b4bee3e6c563b7554e83eecb0b9595022182bebdad171562a2f5eb118f0a67ab19647aab161ecb518
-  data.tar.gz: cbb697ecf01433464585ae77766c647f9cc8be0348bc20ab835c5ac5f84666eac7fc0c5f9cb54e09f0b984a6d87332aa03b97943ef1e69ec548e10bdf2ec9d6e
+  metadata.gz: dcfab68cd74b8c40ccd21799693f20be692ae3a38c2edfc02c06972ebd0148e06a91c3031d715fb5f97b6d8d923d7802db2763ee01d91e5ba34f3b201f678438
+  data.tar.gz: f7936f2ba25cd820f81241a46588ff03dd66f8cf9b3dd4165e9eb5c372eec020a0f82b0053d5a39756e1c554471299fd6879501663ff2e4343de115191374a2c

data/CHANGELOG.mdown

@@ -1,3 +1,6 @@
+# 1.1.0
+  * [FEATURE] adds support for supplementary details in transactions (Field 61, Subfield 9) (#18)
+
 # 1.0.0
   * [FEATURE] adds support for storno transactions (#14)
   * [NOTE] full backwards compatibility

data/lib/cmxl/field.rb

@@ -44,8 +44,8 @@ module Cmxl
     # Cmxl::Field.parse(':60F:C031002PLN40000,00') #=> returns an AccountBalance instance
     #
     def self.parse(line)
-      if line.match(/^:(\d{2,2})(\w)?:(.*)$/)
-        tag, modifier, content = $1, $2, $3
+      if line.match(/\A:(\d{2,2})(\w)?:(.*)\z/m)
+        tag, modifier, content = $1, $2, $3.gsub(/\r?\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]

data/lib/cmxl/fields/statement_details.rb

@@ -4,6 +4,13 @@ module Cmxl
       self.tag = 86
       self.parser = /(?<transaction_code>\w{3})(?<details>(?<seperator>.).*)/
 
+      class << self
+        def parse(line)
+          # remove line breaks as they are allowed via documentation but not needed for data-parsing
+          super line.gsub(/\n/, '')
+        end
+      end
+
       def sub_fields
         @sub_fields ||= if self.data['details'] =~ /#{Regexp.escape(self.data['seperator'])}(\d{2})/
             Hash[self.data['details'].scan(/#{Regexp.escape(self.data['seperator'])}(\d{2})([^#{Regexp.escape(self.data['seperator'])}]*)/)]

data/lib/cmxl/fields/transaction.rb

@@ -2,7 +2,7 @@ module Cmxl
   module Fields
     class Transaction < Field
       self.tag = 61
-      self.parser = /^(?<date>\d{6})(?<entry_date>\d{4})?(?<storno_flag>R?)(?<funds_code>[CD]{1})(?<currency_letter>[a-zA-Z])?(?<amount>\d{1,12},\d{0,2})(?<swift_code>(?:N|F).{3})(?<reference>NONREF|.{0,16})(?:$|\/\/)(?<bank_reference>.*)/i
+      self.parser = %r{^(?<date>\d{6})(?<entry_date>\d{4})?(?<storno_flag>R?)(?<funds_code>[CD]{1})(?<currency_letter>[a-zA-Z])?(?<amount>\d{1,12},\d{0,2})(?<swift_code>(?:N|F).{3})(?<reference>NONREF|.{0,16})((?:\/\/)(?<bank_reference>[^\n]*))?((?:[\n])?(?<supplementary>.{,34}))$}
 
       attr_accessor :details
 
@@ -68,6 +68,25 @@ module Cmxl
         end
       end
 
+      def supplementary
+        @supplementary ||= Cmxl::Fields::TransactionSupplementary.parse(data['supplementary'])
+      end
+
+      # Fields from supplementary
+
+      def initial_amount_in_cents
+        supplementary.initial_amount_in_cents
+      end
+      def initial_currency
+        supplementary.initial_currency
+      end
+      def charges_in_cents
+        supplementary.charges_in_cents
+      end
+      def charges_currency
+        supplementary.charges_currency
+      end
+
       # Fields from details
 
       def description
@@ -107,8 +126,11 @@ module Cmxl
           'swift_code' => swift_code,
           'reference' => reference,
           'bank_reference' => bank_reference,
-          'currency_letter' => currency_letter
-        }.merge(details ? details.to_h : {})
+          'currency_letter' => currency_letter,
+        }.tap do |h|
+          h.merge!(details.to_h) if details
+          h.merge!(supplementary.to_h) unless supplementary.source.empty?
+        end
       end
 
       def to_hash

data/lib/cmxl/fields/transaction_supplementary.rb

@@ -0,0 +1,53 @@
+module Cmxl
+  module Fields
+    class TransactionSupplementary < Field
+
+      attr_accessor :source, :initial, :charges
+
+      class << self
+        def parse(line)
+          initial = $1 if line.match(initial_parser)
+          charges = $1 if line.match(charges_parser)
+          new(line, initial, charges)
+        end
+
+        def initial_parser; %r{((?:\/OCMT\/)(?<initial>[a-zA-Z]{3}[\d,]{1,15}))} end
+        def charges_parser; %r{((?:\/CHGS\/)(?<charges>[a-zA-Z]{3}[\d,]{1,15}))} end
+      end
+
+
+      def initialize(line, initial, charges)
+        self.source = line
+        self.initial = initial
+        self.charges = charges
+      end
+
+      def initial_amount_in_cents
+        to_amount_in_cents(initial[3..-1]) if initial
+      end
+
+      def initial_currency
+        initial[0..2] if initial
+      end
+
+      def charges_in_cents
+        to_amount_in_cents(charges[3..-1]) if charges
+      end
+
+      def charges_currency
+        charges[0..2] if charges
+      end
+
+      def to_h
+        {
+          source: source,
+          initial_amount_in_cents: initial_amount_in_cents,
+          initial_currency: initial_currency,
+          charges_in_cents: charges_in_cents,
+          charges_currency: charges_currency,
+        }
+      end
+      alias_method :to_hash, :to_h
+    end
+  end
+end

data/lib/cmxl/statement.rb

@@ -23,17 +23,14 @@ module Cmxl
     # Internal: Parse a single MT940 statement and extract the line data
     #
     def parse!
-      # first we clean uo the source and make concat wraped lines (lines not starting with a ":")
-      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
-
       self.fields = []
-      lines.each do |line|
+
+      # split transactions, each transaction starts with a colon after a linebreak
+      # do not remove line breaks within transaction lines as they are used to determine field details
+      # e.g. :61:-supplementary
+      source.split("\n:").each(&:strip!).each do |line|
+        line = ":#{line}" unless line =~ %r{^:} # prepend lost : via split
+
         if line.match(/\A:86:/)
           if field = fields.last
             field.add_meta_data(line)
@@ -43,21 +40,6 @@ module Cmxl
           self.fields << field unless field.nil?
         end
       end
-
-      # puts "Fixed Fields"
-      # puts fields.inspect
-      #
-      # # Now we check each line for its content ans structure it for further use. 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
-      #     field = Field.parse(line)
-      #     self.fields << field unless field.nil?
-      #   end
-      # end
     end
 
     # Public: SHA2 of the provided source

data/lib/cmxl/version.rb

@@ -1,3 +1,3 @@
 module Cmxl
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/fields/transaction_spec.rb

@@ -3,6 +3,9 @@ require 'spec_helper'
 describe Cmxl::Fields::Transaction do
   subject(:debit_transaction) { Cmxl::Fields::Transaction.parse(fixture.first) }
   subject(:storno_credit_transaction) { Cmxl::Fields::Transaction.parse(fixture.last) }
+  subject(:ocmt_transaction) { Cmxl::Fields::Transaction.parse(fixture_line(:statement_ocmt)) }
+  subject(:ocmt_cghs_transaction) { Cmxl::Fields::Transaction.parse(fixture_line(:statement_ocmt_chgs)) }
+  subject(:supplementary_transaction) { Cmxl::Fields::Transaction.parse(fixture_line(:statement_supplementary_plain)) }
 
   let(:fixture) { fixture_line(:statement_line).split(/\n/) }
 
@@ -38,4 +41,27 @@ describe Cmxl::Fields::Transaction do
     it { expect(storno_credit_transaction).to be_storno }
     it { expect(storno_credit_transaction.sign).to eql(1) }
   end
+
+  context 'statement with initial amount and currency' do
+    it { expect(ocmt_transaction.initial_amount_in_cents).to eql(4711) }
+    it { expect(ocmt_transaction.initial_currency).to eql('CAD') }
+  end
+
+  context 'statement with initial amount and currency and also charges' do
+    it { expect(ocmt_cghs_transaction.initial_amount_in_cents).to eql(4711) }
+    it { expect(ocmt_cghs_transaction.initial_currency).to eql('CAD') }
+
+    it { expect(ocmt_cghs_transaction.charges_in_cents).to eql(123) }
+    it { expect(ocmt_cghs_transaction.charges_currency).to eql('EUR') }
+  end
+
+  context 'statement with plain supplementary' do
+    it { expect(supplementary_transaction.initial_amount_in_cents).to eql(nil) }
+    it { expect(supplementary_transaction.initial_currency).to eql(nil) }
+
+    it { expect(supplementary_transaction.charges_in_cents).to eql(nil) }
+    it { expect(supplementary_transaction.charges_currency).to eql(nil) }
+
+    it { expect(supplementary_transaction.supplementary.source).to eql('Card Transaction') }
+  end
 end

data/spec/fields/transaction_supplementary_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Cmxl::Fields::TransactionSupplementary do
+  let(:fixture) { 'Card Transaction/OCMT/CAD47,11/CHGS/EUR123,45' }
+  subject(:supplementary) { described_class.parse(fixture) }
+
+  it { expect(supplementary.initial_amount_in_cents).to eql(4711) }
+  it { expect(supplementary.initial_currency).to eql('CAD') }
+
+  it { expect(supplementary.charges_in_cents).to eql(12345) }
+  it { expect(supplementary.charges_currency).to eql('EUR') }
+
+  describe '.to_h' do
+    it 'returns expected hash' do
+      expect(supplementary.to_h).to eql({
+        source: 'Card Transaction/OCMT/CAD47,11/CHGS/EUR123,45',
+        initial_amount_in_cents: 4711,
+        initial_currency: 'CAD',
+        charges_in_cents: 12345,
+        charges_currency: 'EUR'
+      })
+    end
+  end
+end

data/spec/fixtures/lines/statement_ocmt.txt

@@ -0,0 +1,2 @@
+:61:1804090409DR000000000012,34NTRF0000549855700010//025498557/000001
+/OCMT/CAD47,11

data/spec/fixtures/lines/statement_ocmt_chgs.txt

@@ -0,0 +1,2 @@
+:61:1804090409DR000000000056,78NTRF0000549855700010//025498557/000001
+/OCMT/CAD47,11/CHGS/EUR1,23

data/spec/fixtures/lines/statement_supplementary_plain.txt

@@ -0,0 +1,2 @@
+:61:0306280628D21,00FMSCNONREF//98327000090031789
+Card Transaction

data/spec/fixtures/mt940-deutsche_bank.txt

@@ -3,6 +3,7 @@
 :28:27/01
 :60F:C131016DEM84349,74
 :61:131017D6800,NCHK16703074
+/OCMT/CAD47,11
 :86:999PN5477SCHECK-NR. 0000016703074
 :61:131017D620,3NSTON
 :86:999PN0911DAUERAUFTR.NR. 14
@@ -66,5 +67,5 @@ STORY-?26300 SZT GR544 I OPORNIKI-5?2700 SZT GTX847 FAKTURA 333/
 :61:0310201020C40,00FTRFNONREF//8327000090031791
 Interest credit
 :86: 844?00Uznanie kwotą odsetek?20Odsetki od lokaty nr 101000?21022086
-:62F:C020325PLN50040,00 
+:62F:C020325PLN50040,00
 -

data/spec/fixtures/mt940.txt

@@ -46,30 +46,30 @@ GmbH?3050060400?31084756
 
 -
 
-:20:TELEWIZORY S.A. 
-:25:BPHKPLPK/320000546101 
-:28C:00084/001 
-:60F:C031002PLN40000,00 
-:61:0310201020C20000,00FMSCNONREF//8327000090031789 
-Card transaction 
+:20:TELEWIZORY S.A.
+:25:BPHKPLPK/320000546101
+:28C:00084/001
+:60F:C031002PLN40000,00
+:61:0310201020C20000,00FMSCNONREF//8327000090031789
+Card transaction
 :86: 020?00Wyplata-(dysp/przel)?2008106000760000777777777777?2115617?
-22INFO INFO INFO INFO INFO INFO 1 END?23INFO INFO INFO INFO INFO 
-INFO 2 END?24ZAPLATA ZA FABRYKATY DO TUB?25 - 200 S ZTUK, TRANZY 
-STORY-?26300 SZT GR544 I OPORNIKI-5?2700 SZT GTX847 FAKTURA 333/ 
-2?28003.?3010600076?310000777777777777?32HUTA SZKLA TOPIC UL 
-PRZEMY?33SLOWA 67 32-669 WROCLAW?38PL081060007600007777777 
-77777 
-:61:0310201020D10000,00FTRFREF 25611247//8327000090031790 
-Transfer 
+22INFO INFO INFO INFO INFO INFO 1 END?23INFO INFO INFO INFO INFO
+INFO 2 END?24ZAPLATA ZA FABRYKATY DO TUB?25 - 200 S ZTUK, TRANZY
+STORY-?26300 SZT GR544 I OPORNIKI-5?2700 SZT GTX847 FAKTURA 333/
+2?28003.?3010600076?310000777777777777?32HUTA SZKLA TOPIC UL
+PRZEMY?33SLOWA 67 32-669 WROCLAW?38PL081060007600007777777
+77777
+:61:0310201020D10000,00FTRFREF 25611247//8327000090031790
+Transfer
 :86: 020?00Wyplata-(dysp/przel)?2008106000760000777777777777?2115617?
-22INFO INFO INFO INFO INFO INFO 1 END?23INFO INFO INFO INFO INFO 
-INFO 2 END?24ZAPLATA ZA FABRYKATY DO TUB?25 - 200 S ZTUK, TRANZY 
-STORY-?26300 SZT GR544 I OPORNIKI-5?2700 SZT GTX847 FAKTURA 333/ 
-2?28003.?3010600076?310000777777777777?38PL081060007600007777777 
-77777 
-:61:0310201020C40,00FTRFNONREF//8327000090031791 
+22INFO INFO INFO INFO INFO INFO 1 END?23INFO INFO INFO INFO INFO
+INFO 2 END?24ZAPLATA ZA FABRYKATY DO TUB?25 - 200 S ZTUK, TRANZY
+STORY-?26300 SZT GR544 I OPORNIKI-5?2700 SZT GTX847 FAKTURA 333/
+2?28003.?3010600076?310000777777777777?38PL081060007600007777777
+77777
+:61:0310201020C40,00FTRFNONREF//8327000090031791
 Interest credit
-:86: 844?00Uznanie kwotą odsetek?20Odsetki od lokaty nr 101000?21022086 
-:62F:C020325PLN50040,00 
+:86: 844?00Uznanie kwotą odsetek?20Odsetki od lokaty nr 101000?21022086
+:62F:C020325PLN50040,00
 
 -

data/spec/statement_spec.rb

@@ -57,7 +57,7 @@ describe Cmxl do
           "34" => "171"
         },
         "transaction_code" => "171",
-        "details" => "?00SEPA LASTSCHRIFT KUNDE?10281?20KREF+EREF+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"
+        "details" => "?00SEPA LASTSCHRIFT KUNDE?10281?20KREF+EREF+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",
         }
       )
     }
@@ -87,7 +87,7 @@ describe Cmxl do
         "sign" => -1,
         "debit" => true,
         "credit" => false,
-        "storno" => false
+        "storno" => false,
       })
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmxl
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Michael Bumann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2018-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,7 @@ files:
 - lib/cmxl/fields/statement_details.rb
 - lib/cmxl/fields/statement_number.rb
 - lib/cmxl/fields/transaction.rb
+- lib/cmxl/fields/transaction_supplementary.rb
 - lib/cmxl/statement.rb
 - lib/cmxl/version.rb
 - spec/field_spec.rb
@@ -134,6 +135,7 @@ files:
 - spec/fields/statement_details_spec.rb
 - spec/fields/statement_number_spec.rb
 - spec/fields/transaction_spec.rb
+- spec/fields/transaction_supplementary_spec.rb
 - spec/fields/unknown_spec.rb
 - spec/fixtures/lines/account_balance_credit.txt
 - spec/fixtures/lines/account_balance_debit.txt
@@ -147,6 +149,9 @@ files:
 - spec/fixtures/lines/statement_details_empty_fields.txt
 - spec/fixtures/lines/statement_line.txt
 - spec/fixtures/lines/statement_number.txt
+- spec/fixtures/lines/statement_ocmt.txt
+- spec/fixtures/lines/statement_ocmt_chgs.txt
+- spec/fixtures/lines/statement_supplementary_plain.txt
 - spec/fixtures/mt940-deutsche_bank.txt
 - spec/fixtures/mt940-iso8859-1.txt
 - spec/fixtures/mt940-with-detailed-end-balance.txt
@@ -194,6 +199,7 @@ test_files:
 - spec/fields/statement_details_spec.rb
 - spec/fields/statement_number_spec.rb
 - spec/fields/transaction_spec.rb
+- spec/fields/transaction_supplementary_spec.rb
 - spec/fields/unknown_spec.rb
 - spec/fixtures/lines/account_balance_credit.txt
 - spec/fixtures/lines/account_balance_debit.txt
@@ -207,6 +213,9 @@ test_files:
 - spec/fixtures/lines/statement_details_empty_fields.txt
 - spec/fixtures/lines/statement_line.txt
 - spec/fixtures/lines/statement_number.txt
+- spec/fixtures/lines/statement_ocmt.txt
+- spec/fixtures/lines/statement_ocmt_chgs.txt
+- spec/fixtures/lines/statement_supplementary_plain.txt
 - spec/fixtures/mt940-deutsche_bank.txt
 - spec/fixtures/mt940-iso8859-1.txt
 - spec/fixtures/mt940-with-detailed-end-balance.txt