cremul-parser 0.8.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f5e18fc594f98b2ceb5cb96264dfe9108b0e25f
-  data.tar.gz: da574cd070d87a669b0cb77718bcdcf976c7bf66
+  metadata.gz: c8b899dbadb7e1c564cd1156b647acf50fb818f4
+  data.tar.gz: c9f86c8f677051c98481a91b1a751cb3193d654e
 SHA512:
-  metadata.gz: 539817f1790d87fb42e0f6457aca4854e1dbb2f4380c70a9206ec01f35f4ac1a2289d12ee0f873f47699f386fd7739132460254d606ea6c0d2cd58fb9b7affc7
-  data.tar.gz: c58ae3f7e2ca77b2ed3312d298595e22387877b9037dd72331b5fe4914869a6d091d6e06f774e89ef420becae5170ced80df975bc6b33797f206e7204252ca69
+  metadata.gz: 4adb22742847f7ef5f75588f51a837e0b3606a089f21a93907626b2f930169f0cbe37b726d8fc101802184bc8c2ae9a6ae5cde2d51317d06ed93bad36e7a1abe
+  data.tar.gz: e3633e40dd71dc802aeb77af7669e24f84d8447bec993835c2d2d5c31e364e13d4ad8901de329b292249c593706ae5937c652bcbe77e2daa26ca774292b3ca32

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.9.0
+
+Added index numbers to CremulMessage, CremulLine and CremulPaymentTx. The hash of the file +
+the index numbers can be used to create unique ids for each payment transaction. This can be
+useful for instance when importing a large Cremul file into a database when you want to make
+sure that none of the transactions have already been imported.
+
 ## 0.8.0
 
 Bumped to version 0.8.0 to indicate that it is getting close to finished as a 1.0 version.

data/README.md

@@ -36,14 +36,23 @@ f = File.open(<CREMUL-file>)
 parser = CremulParser.new
 parser.parse(f)
 f.close
+```
 
-# or if the file is not utf-8 encoded
+or if the file is not utf-8 encoded
 
+```
 f = File.open(<CREMUL-file>)
 parser = CremulParser.new
 parser.parse(f, <encoding>) # for instance 'ISO-8859-1'
 f.close
+```
 
+A file may contain one or more Cremul messages. A Cremul message consists of 'message segments'.
+Each segment starts with a Cremul keyword. A group of segments make up a logical element of the
+Cremul message. The overall logical structure of a Cremul file is as follows:
+
+```
+ [ Cremul file ] 1 --- * [ Cremul message ] 1 --- * [ Line ] 1 --- * [ Payment TX ]
 ```
 
 See the `parser_test.rb` file for more details.

data/cremul-parser.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = Cremul::VERSION
   gem.platform      = Gem::Platform::RUBY
   gem.authors       = ["Per Spilling"]
-  gem.email         = ["per@kodemaker.no"]
+  gem.email         = ["per@perspilling.net"]
   gem.summary       = %q{A parser for CREMUL payment transaction files}
   gem.description   = %q{A parser for CREMUL payment transaction files. It parses the CREMUL file and creates a Ruby object structure corresponding to the elements in the file.}
   gem.homepage      = "https://github.com/perspilling/cremul-parser"

data/lib/cremul/cremul_line.rb

@@ -9,9 +9,10 @@ require_relative 'cremul_payment_tx'
 class CremulLine
   include Cremul::ParserHelper
 
-  attr_reader :posting_date, :money, :reference, :bf_account_number, :transactions
+  attr_reader :line_index, :posting_date, :money, :reference, :bf_account_number, :transactions
 
-  def initialize(segments, line_segment_pos)
+  def initialize(line_index, segments, line_segment_pos)
+    @line_index = line_index
     d = segments[next_date_segment_index(segments, line_segment_pos)].split(':')
     @posting_date = Date.parse(d[1])
 
@@ -23,8 +24,9 @@ class CremulLine
     @transactions = []
     n = number_of_transactions_in_line(segments, line_segment_pos)
     tx_index = next_tx_sequence_segment_index(segments, line_segment_pos)
-    n.times do
-      @transactions << CremulPaymentTx.new(segments, tx_index)
+
+    n.times do |i|
+      @transactions << CremulPaymentTx.new(i+1, segments, tx_index)
       tx_index = next_tx_sequence_segment_index(segments, tx_index+1)
     end
 

data/lib/cremul/cremul_message.rb

@@ -5,17 +5,19 @@ require_relative 'parser_helper'
 class CremulMessage
   include Cremul::ParserHelper
 
-  attr_reader :header, :number_of_lines, :lines
+  # The message_index is the index number of the Cremul message in the file.
+  attr_reader :message_index, :header, :number_of_lines, :lines
 
-  def initialize(segments)
+  def initialize(message_number, segments)
+    @message_index = message_number
     @header = CremulHeader.new(segments)
     @lines = []
     @number_of_lines = number_of_lines_in_message(segments)
 
     # instantiate the line items
     line_segment_pos = next_line_segment_index(segments, 0)
-    @number_of_lines.times do
-      @lines << CremulLine.new(segments, line_segment_pos)
+    @number_of_lines.times do |n|
+      @lines << CremulLine.new(n+1, segments, line_segment_pos)
       line_segment_pos = next_line_segment_index(segments, line_segment_pos+1)
     end
 

data/lib/cremul/cremul_payment_tx.rb

@@ -20,10 +20,11 @@ class CremulPaymentTx
   REF_TYPE_INVOICE_NUMBER = 380
 
   attr_reader :posting_date, :money, :references, :invoice_ref_type, :invoice_ref, :free_text
-  attr_reader :payer_account_number, :payer_nad, :beneficiary_nad
+  attr_reader :payer_account_number, :payer_nad, :beneficiary_nad, :tx_index
 
 
-  def initialize(segments, tx_segment_pos)
+  def initialize(tx_index, segments, tx_segment_pos)
+    @tx_index = tx_index  # the index number of this tx within it's parent line
     s = segments[next_date_segment_index(segments, tx_segment_pos)].split(':')
     @posting_date = Date.parse(s[1])
 

data/lib/cremul/cremul_reference.rb

@@ -4,9 +4,9 @@ require_relative 'parser_helper'
 # Represents a reference (RFF) segment in a CREMUL message.
 # Type may be:
 # - :ACK - Bank reference - KID in Norwegian
-# - :AII - Bank’s reference number allocated by the bank to different underlaying individual transactions
+# - :AII - Bank’s reference number allocated by the bank to different underlying individual transactions
 # - :CT - AutoGiro agreement ID
-# - :ABO - Originator´s reference – for excample SWIFT reference senders bank
+# - :ABO - Originator´s reference – for example SWIFT reference senders bank
 # - :ACD - Bank reference = Archive reference
 # - :AEK - Payment order number
 # - :AFO - Beneficiary’s reference

data/lib/cremul/parser_helper.rb

@@ -183,7 +183,7 @@ module Cremul
       n
     end
 
-    def number_of_messages_in_file(segments)
+    def get_messages_in_file(segments)
       m = {}
       n = 0
       segments.each_index do |i|

data/lib/cremul/version.rb

@@ -1,3 +1,3 @@
 module Cremul
-  VERSION = '0.8.0'
+  VERSION = '0.9.1'
 end

data/lib/cremul_parser.rb

@@ -3,6 +3,14 @@
 require_relative 'cremul/parser_helper'
 require_relative 'cremul/cremul_message'
 
+
+#
+# A file may contain one or more Cremul messages. A Cremul message consists of 'message segments'.
+# Each segment starts with a Cremul keyword. A group of segments make up a logical element of the
+# Cremul message. The overall logical structure of a Cremul message is as follows:
+#
+# [ Cremul message ] 1 --- * [ Line ] 1 --- * [ Payment TX ]
+#
 class CremulParser
   include Cremul::ParserHelper
 
@@ -12,6 +20,7 @@ class CremulParser
     @messages = []
   end
 
+  # noinspection RubyResolve
   def parse(file, file_encoding='utf-8')
     file_as_a_string = ''
     file.each do |line|
@@ -27,15 +36,15 @@ class CremulParser
       @segments = @segments.slice(0, @segments.size-1)
     end
 
-    m = number_of_messages_in_file(@segments)
+    m = get_messages_in_file(@segments)
     if m.size == 0
       raise 'No CREMUL message found in file'
     end
     m.each do |n, start_index|
       if n < m.size
-        @messages << CremulMessage.new(@segments[start_index, m[n+1] - start_index])
+        @messages << CremulMessage.new(n, @segments[start_index, m[n+1] - start_index])
       else
-        @messages << CremulMessage.new(@segments[start_index, @segments.size - start_index])
+        @messages << CremulMessage.new(n, @segments[start_index, @segments.size - start_index])
       end
     end
   end

data/test/unit/parser_test.rb

@@ -17,6 +17,7 @@ describe CremulParser do
       d2014_03_12 = Date.new(2014,3,12)
 
       msg = @parser.messages[0]
+      msg.message_index.must_equal 1
       msg.header.must_be_instance_of CremulHeader
       msg.header.msg_id.must_include 'CREMUL'
       msg.header.created_date.must_equal d2014_03_12
@@ -26,6 +27,7 @@ describe CremulParser do
 
       line = msg.lines[0]
       line.must_be_instance_of CremulLine
+      line.line_index.must_equal 1
       line.posting_date.must_equal d2014_03_12
       line.bf_account_number.must_equal '12121212121'
       line.money.must_be_instance_of CremulMoney
@@ -40,6 +42,7 @@ describe CremulParser do
       line.transactions.size.must_equal 1
       tx = line.transactions[0]
       tx.must_be_instance_of CremulPaymentTx
+      tx.tx_index.must_equal 1
       tx.posting_date.must_equal d2014_03_12
       tx.money.amount.must_equal 1394.to_f
       tx.money.currency.must_equal :NOK
@@ -213,6 +216,7 @@ describe CremulParser do
       braekstad_tx = msg.lines[2].transactions[0]
       braekstad_tx.invoice_ref.must_equal '20140453869'
     end
+=end
 
 
     it 'should parse a multi-message file' do
@@ -223,7 +227,6 @@ describe CremulParser do
 
       #write_segments_to_file(@parser.segments, File.open('files/CREMUL_multi_message_segments.txt', 'w'))
     end
-=end
 
     def write_segments_to_file(msg, file)
       begin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cremul-parser
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Per Spilling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -41,7 +41,7 @@ dependencies:
 description: A parser for CREMUL payment transaction files. It parses the CREMUL file
   and creates a Ruby object structure corresponding to the elements in the file.
 email:
-- per@kodemaker.no
+- per@perspilling.net
 executables: []
 extensions: []
 extra_rdoc_files: []