mt940_parser 1.5.4 → 1.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c10c25af0fbeca4a9f993982b9d6836c93f97a7689aad0437f6d7c296db76627
-  data.tar.gz: e374fb82f872046d4928c56356e80d26f2aaf2d3ee987ce73ca97b3b8a97f7b6
+  metadata.gz: 83c746f0f3871275400a75662a116760798fa3212f443588965c03cb53bfc7a5
+  data.tar.gz: f96ef50e6f342890620391ade43d1034a34df62e7320f95502b473abe9d71a3b
 SHA512:
-  metadata.gz: 4f2e1879aa0385913ae9d5d1144e55104c94d0eb7195ce5a8cb63a61b5c7121f97371f365fe473c6d30b825d8756102fd4f1f79b5708189d4de4256d993a4fe1
-  data.tar.gz: e41928d11934d6d2419850bc8792b26f96eda4de933bba63e8caa67034751f211965ff1ca588a8a6d5ded3e8b0acd7937f4ee779bcf337911bd6ea9f02413cb1
+  metadata.gz: a9ba3439db4b3e5bb1595ac608c9060a453d0a0b3a3b56a4dd41e5f9eb68d017834932723ad574b0f07f0828935313dd966bec679de825060ca746fec2f84432
+  data.tar.gz: 2eacc5076f62817e7b1822426573ae8c2efddc6ecaf8af9d7642cb378490fd9d3d40c481ec7a3483c36077dc191eeac3aab5b05e6f28d0d6953256e379ab450d

data/VERSION

@@ -1 +1 @@
-1.5.4
+1.5.5

data/lib/mt940/customer_statement_message.rb

@@ -3,11 +3,10 @@
 # the data easier
 class MT940
   class CustomerStatementMessage
-
-    attr_reader :account, :statement_lines
+    attr_reader :account, :statement_lines, :opening_balance, :closing_balance
 
     def self.parse_file(file)
-      self.parse(File.read(file))
+      parse(File.read(file))
     end
 
     def self.parse(data)
@@ -16,12 +15,15 @@ class MT940
     end
 
     def initialize(lines)
-      @account = lines.find { |line| line.class == MT940::AccountIdentification }
+      @account = select_by_type(lines, MT940::AccountIdentification)
+      @opening_balance = select_by_type(lines, MT940::AccountBalance)
+      @closing_balance = select_by_type(lines, MT940::ClosingBalance)
       @statement_lines = []
       lines.each_with_index do |line, i|
         next unless line.class == MT940::StatementLine
-        ensure_is_info_line!(lines[i+1])
-        @statement_lines << StatementLineBundle.new(lines[i], lines[i+1])
+
+        ensure_is_info_line!(lines[i + 1])
+        @statement_lines << StatementLineBundle.new(lines[i], lines[i + 1])
       end
     end
 
@@ -33,36 +35,45 @@ class MT940
       @account.account_number
     end
 
+    def signature
+      Digest::SHA256.hexdigest(opening_balance.content.to_s + closing_balance.content.to_s)
+    end
+
     private
 
+    def select_by_type(lines, line_klass)
+      lines.select { |line| line.instance_of?(line_klass) }.first
+    end
+
     def ensure_is_info_line!(line)
-      unless line.is_a? MT940::StatementLineInformation
-        raise Errors::UnexpectedStructureError,
-          "Unexpected Structure; expected StatementLineInformation, "\
-          "but was #{line.class}"
-      end
+      return if line.is_a? MT940::StatementLineInformation
+
+      raise Errors::UnexpectedStructureError,
+            'Unexpected Structure; expected StatementLineInformation, ' \
+            "but was #{line.class}"
     end
   end
 
   class StatementLineBundle
     METHOD_MAP = {
-      :amount                   => :line,
-      :funds_code               => :line,
-      :value_date               => :line,
-      :entry_date               => :line,
-      :account_holder           => :info,
-      :details                  => :info,
-      :account_number           => :info,
-      :bank_code                => :info,
-      :code                     => :info,
-      :transaction_description  => :info,
+      amount: :line,
+      funds_code: :line,
+      value_date: :line,
+      entry_date: :line,
+      account_holder: :info,
+      details: :info,
+      account_number: :info,
+      bank_code: :info,
+      code: :info,
+      transaction_description: :info
     }
 
     def initialize(statement_line, statement_line_info)
-      @line, @info = statement_line, statement_line_info
+      @line = statement_line
+      @info = statement_line_info
     end
 
-    def method_missing(method, *args, &block)
+    def method_missing(method, *args, &)
       super unless METHOD_MAP.has_key?(method)
       object = instance_variable_get("@#{METHOD_MAP[method.to_sym]}")
       object.send(method)

data/lib/mt940/version.rb

@@ -1,6 +1,6 @@
 class MT940
   # MT940 version
-  VERSION         = '1.5.4'
+  VERSION         = '1.5.5'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/mt940.rb

@@ -4,6 +4,7 @@ require 'mt940/customer_statement_message'
 require 'bigdecimal'
 require 'bigdecimal/util'
 require 'date'
+require 'digest/sha2'
 
 class MT940
   class Field
@@ -13,12 +14,13 @@ class MT940
     SHORT_DATE = /(\d{2})(\d{2})/
 
     class << self
-
       LINE = /^:(\d{2})(\w)?:(.*)$/
 
       def for(line)
         if line.match(LINE)
-          number, modifier, content = $1, $2, $3
+          number = ::Regexp.last_match(1)
+          modifier = ::Regexp.last_match(2)
+          content = ::Regexp.last_match(3)
           klass = {
             '20' => Job,
             '21' => Reference,
@@ -37,8 +39,8 @@ class MT940
           klass.new(modifier, content)
         else
           raise Errors::WrongLineFormatError,
-            "Wrong line format does not match #{LINE.inspect}. Got: "\
-            "#{line.dump[0...80]}#{'[...]' if line.dump.size > 80}"
+                "Wrong line format does not match #{LINE.inspect}. Got: " \
+                "#{line.dump[0...80]}#{'[...]' if line.dump.size > 80}"
         end
       end
     end
@@ -59,15 +61,14 @@ class MT940
 
     def parse_date(date)
       date.match(DATE)
-      ::Date.new("20#{$1}".to_i, $2.to_i, $3.to_i)
+      ::Date.new("20#{::Regexp.last_match(1)}".to_i, ::Regexp.last_match(2).to_i, ::Regexp.last_match(3).to_i)
     end
 
     def parse_entry_date(raw_entry_date, value_date)
       raw_entry_date.match(SHORT_DATE)
-      entry_date = ::Date.new(value_date.year, $1.to_i, $2.to_i)
-      unless entry_date.year == value_date.year
-        raise "Unhandled case: value date and entry date are in different years"
-      end
+      entry_date = ::Date.new(value_date.year, ::Regexp.last_match(1).to_i, ::Regexp.last_match(2).to_i)
+      raise 'Unhandled case: value date and entry date are in different years' unless entry_date.year == value_date.year
+
       entry_date
     end
   end
@@ -88,20 +89,21 @@ class MT940
   # 25
   class AccountIdentification < Field
     attr_reader :account_identifier
-    CONTENT = /(.{1,35})/ #any 35 chars (35x from the docs)
+
+    CONTENT = /(.{1,35})/ # any 35 chars (35x from the docs)
 
     def parse_content(content)
       content.match(CONTENT)
-      @account_identifier = $1
+      @account_identifier = ::Regexp.last_match(1)
     end
 
     # fail over to the old Account class
-    def method_missing(method, *args, &block)
+    def method_missing(method, *args, &)
       @fail_over_implementation ||= Account.new(@modifier, @content)
       value = @fail_over_implementation.send(method)
-      warn "[DEPRECATION]:"
+      warn '[DEPRECATION]:'
       warn "You used '#{method}' on the Account/AccountIdentification class"
-      warn "This field is not part of the MT940 specification but implementation specific"
+      warn 'This field is not part of the MT940 specification but implementation specific'
       warn "Please use the 'account_identifier' and parse yourself."
 
       value
@@ -113,11 +115,13 @@ class MT940
   class Account < Field
     attr_reader :bank_code, :account_number, :account_currency
 
-    CONTENT = /^(.{8,11})\/(\d{0,23})([A-Z]{3})?$/
+    CONTENT = %r{^(.{8,11})/(\d{0,23})([A-Z]{3})?$}
 
     def parse_content(content)
       content.match(CONTENT)
-      @bank_code, @account_number, @account_currency = $1, $2, $3
+      @bank_code = ::Regexp.last_match(1)
+      @account_number = ::Regexp.last_match(2)
+      @account_currency = ::Regexp.last_match(3)
     end
   end
 
@@ -125,14 +129,15 @@ class MT940
   class Statement < Field
     attr_reader :number, :sheet
 
-    CONTENT = /^(0|(\d{5,5})\/(\d{2,5}))$/
+    CONTENT = %r{^(0|(\d{5,5})/(\d{2,5}))$}
 
     def parse_content(content)
       content.match(CONTENT)
-      if $1 == '0'
+      if ::Regexp.last_match(1) == '0'
         @number = @sheet = 0
       else
-        @number, @sheet = $2.to_i, $3.to_i
+        @number = ::Regexp.last_match(2).to_i
+        @sheet = ::Regexp.last_match(3).to_i
       end
     end
   end
@@ -155,23 +160,23 @@ class MT940
         end
 
       @sign =
-        case $1
+        case ::Regexp.last_match(1)
         when 'C'
           :credit
         when 'D'
           :debit
         end
 
-      raw_date  = $2
-      @currency = $3
-      @amount   = parse_amount_in_cents($4)
+      raw_date  = ::Regexp.last_match(2)
+      @currency = ::Regexp.last_match(3)
+      @amount   = parse_amount_in_cents(::Regexp.last_match(4))
 
       @date =
         case raw_date
         when 'ALT', '0'
           nil
         when DATE
-          ::Date.new("20#{$1}".to_i, $2.to_i, $3.to_i)
+          ::Date.new("20#{::Regexp.last_match(1)}".to_i, ::Regexp.last_match(2).to_i, ::Regexp.last_match(3).to_i)
         end
     end
   end
@@ -180,15 +185,15 @@ class MT940
   class StatementLine < Field
     attr_reader :date, :entry_date, :funds_code, :amount, :swift_code, :reference, :transaction_description
 
-    CONTENT = /^(\d{6})(\d{4})?(C|D|RC|RD)\D?(\d{1,12},\d{0,2})((?:N|F).{3})(NONREF|.{0,16})(?:$|\/\/)(.*)/
+    CONTENT = %r{^(\d{6})(\d{4})?(C|D|RC|RD)\D?(\d{1,12},\d{0,2})((?:N|F).{3})(NONREF|.{0,16})(?:$|//)(.*)}
 
     def parse_content(content)
       content.match(CONTENT)
 
-      raw_date       = $1
-      raw_entry_date = $2
+      raw_date       = ::Regexp.last_match(1)
+      raw_entry_date = ::Regexp.last_match(2)
       @funds_code =
-        case $3
+        case ::Regexp.last_match(3)
         when 'C'
           :credit
         when 'D'
@@ -199,10 +204,10 @@ class MT940
           :return_debit
         end
 
-      @amount = parse_amount_in_cents($4)
-      @swift_code = $5
-      @reference = $6
-      @transaction_description = $7
+      @amount = parse_amount_in_cents(::Regexp.last_match(4))
+      @swift_code = ::Regexp.last_match(5)
+      @reference = ::Regexp.last_match(6)
+      @transaction_description = ::Regexp.last_match(7)
 
       @date = parse_date(raw_date)
       @entry_date = parse_entry_date(raw_entry_date, @date) if raw_entry_date
@@ -228,17 +233,17 @@ class MT940
   # 86
   class StatementLineInformation < Field
     attr_reader :code, :transaction_description, :prima_nota, :details, :bank_code, :account_number,
-      :account_holder, :text_key_extension, :not_implemented_fields
+                :account_holder, :text_key_extension, :not_implemented_fields
 
     def parse_content(content)
       content.match(/^(\d{3})((.).*)$/)
-      @code = $1.to_i
+      @code = ::Regexp.last_match(1).to_i
 
       details        = []
       account_holder = []
 
-      if seperator = $3
-        sub_fields = $2.scan(
+      if seperator = ::Regexp.last_match(3)
+        sub_fields = ::Regexp.last_match(2).scan(
           /#{Regexp.escape(seperator)}(\d{2})([^#{Regexp.escape(seperator)}]*)/
         )
 
@@ -260,10 +265,8 @@ class MT940
             @text_key_extension = content
           else
             @not_implemented_fields ||= []
-            @not_implemented_fields << [ code, content ]
-            if $DEBUG
-              warn "code not implemented: code:#{code} content: #{content.inspect}"
-            end
+            @not_implemented_fields << [code, content]
+            warn "code not implemented: code:#{code} content: #{content.inspect}" if $DEBUG
           end
         end
       end
@@ -287,8 +290,7 @@ class MT940
 
     def parse_sheet(sheet)
       lines = sheet.split("\r\n")
-      fields = lines.reject { |line| line.empty? }.map { |line| Field.for(line) }
-      fields
+      lines.reject { |line| line.empty? }.map { |line| Field.for(line) }
     end
   end
 end

data/mt940_parser.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: mt940_parser 1.5.4 ruby lib
+# stub: mt940_parser 1.5.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "mt940_parser".freeze
-  s.version = "1.5.4"
+  s.version = "1.5.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Thies C. Arntzen".freeze, "Phillip Oertel".freeze]
-  s.date = "2022-05-27"
+  s.date = "2025-05-21"
   s.description = "Ruby library that parses account statements in the SWIFT MT940 format.".freeze
   s.email = "developers@betterplace.org".freeze
   s.extra_rdoc_files = ["README.md".freeze, "lib/mt940.rb".freeze, "lib/mt940/customer_statement_message.rb".freeze, "lib/mt940/errors.rb".freeze, "lib/mt940/version.rb".freeze, "lib/mt940_parser.rb".freeze]

data/test/test_customer_statement_message.rb

@@ -1,22 +1,20 @@
 require_relative 'test_helper'
 
-
 # $DEBUG = true
 class TestCustomerStatementMessage < Test::Unit::TestCase
-
   def setup
-    file = File.dirname(__FILE__) + "/fixtures/sepa_snippet.txt"
+    file = File.dirname(__FILE__) + '/fixtures/sepa_snippet.txt'
     messages = MT940::CustomerStatementMessage.parse_file(file)
     @message = messages.first
     @message_2 = messages.last
   end
 
   def test_it_should_know_the_bank_code
-    assert_equal "50880050", @message.bank_code
+    assert_equal '50880050', @message.bank_code
   end
 
   def test_it_should_know_the_account_number
-    assert_equal "0194787400888", @message.account_number
+    assert_equal '0194787400888', @message.account_number
   end
 
   def test_it_should_have_an_account_identification
@@ -30,7 +28,7 @@ class TestCustomerStatementMessage < Test::Unit::TestCase
 
   def test_statement_lines_should_have_amount_info_credit
     line = @message.statement_lines.first
-    assert_equal 5099005, line.amount
+    assert_equal 5_099_005, line.amount
     assert_equal :credit, line.funds_code
   end
 
@@ -47,12 +45,12 @@ class TestCustomerStatementMessage < Test::Unit::TestCase
 
   def test_statement_lines_info_should_have_bank_code
     line = @message.statement_lines.first
-    assert_equal "DRESDEFF508", line.bank_code
+    assert_equal 'DRESDEFF508', line.bank_code
   end
 
   def test_statement_lines_info_should_have_account_number
     line = @message.statement_lines.first
-    assert_equal "DE14508800500194785000", line.account_number
+    assert_equal 'DE14508800500194785000', line.account_number
   end
 
   def test_statement_lines_should_have_details
@@ -62,32 +60,45 @@ class TestCustomerStatementMessage < Test::Unit::TestCase
 
   def test_statement_lines_should_have_an_entry_date
     line = @message.statement_lines.first
-    assert_equal Date.parse("2007-09-04"), line.entry_date
+    assert_equal Date.parse('2007-09-04'), line.entry_date
   end
 
   def test_statement_lines_should_have_a_value_date
     line = @message.statement_lines.first
-    assert_equal Date.parse("2007-09-07"), line.value_date
+    assert_equal Date.parse('2007-09-07'), line.value_date
   end
 
   def test_parsing_the_file_should_return_two_message_objects
-    file = File.dirname(__FILE__) + "/fixtures/sepa_snippet.txt"
+    file = File.dirname(__FILE__) + '/fixtures/sepa_snippet.txt'
     messages = MT940::CustomerStatementMessage.parse_file(file)
     assert_equal 2, messages.size
-    assert_equal "0194787400888", messages[0].account_number
-    assert_equal "0194791600888", messages[1].account_number
+    assert_equal '0194787400888', messages[0].account_number
+    assert_equal '0194791600888', messages[1].account_number
   end
 
   def test_parsing_a_file_with_broken_structure_should_raise_an_exception
-    file = File.dirname(__FILE__) + "/fixtures/sepa_snippet_broken.txt"
+    file = File.dirname(__FILE__) + '/fixtures/sepa_snippet_broken.txt'
     assert_raise(MT940::Errors::UnexpectedStructureError) do
       MT940::CustomerStatementMessage.parse_file(file)
     end
   end
 
   def test_should_raise_method_missing_when_asking_statement_lines_for_unknown_stuff
-    file = File.dirname(__FILE__) + "/fixtures/sepa_snippet.txt"
+    file = File.dirname(__FILE__) + '/fixtures/sepa_snippet.txt'
+    message = MT940::CustomerStatementMessage.parse_file(file).first
+    assert_raise(NoMethodError) { message.statement_lines.first.foo }
+  end
+
+  def test_should_parse_opening_and_closing_saldo
+    file = File.dirname(__FILE__) + '/fixtures/sepa_snippet.txt'
+    message = MT940::CustomerStatementMessage.parse_file(file).first
+    assert_equal(message.opening_balance.amount, 76_665_649)
+    assert_equal(message.closing_balance.amount, 112_525_040)
+  end
+
+  def test_should_have_signature
+    file = File.dirname(__FILE__) + '/fixtures/sepa_snippet.txt'
     message = MT940::CustomerStatementMessage.parse_file(file).first
-    assert_raise(NoMethodError) { message.statement_lines.first.foo  }
+    assert_equal(message.signature, 'b16439633c7c52fed8e28f717f364e7ec1936f123aa56ab66b15662093cb60ca')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mt940_parser
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.5.5
 platform: ruby
 authors:
 - Thies C. Arntzen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-27 00:00:00.000000000 Z
+date: 2025-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar