mt940_parser 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.specification

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: mt940
+version: !ruby/object:Gem::Version 
+  hash: 23
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-24 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib
+- lib/mt940.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: 
+test_files: []
+

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 betterplace
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,20 @@
+= mt940
+
+This is a library to parse account statements which are formatted as SWIFT mt940. 
+
+See the following link for documentation of the format.
+http://www.google.de/url?sa=t&source=web&cd=1&ved=0CBwQFjAA&url=http%3A%2F%2Fmartin.hinner.info%2Fbankconvert%2Fswift_mt940_942.pdf&ei=alO_TObpPNGRswbD15WqDQ&usg=AFQjCNHkVGOfzofgKkk6dEkynAho02S2cg
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Thies C. Arntzen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mt940_parser"
+    gem.summary = %Q{MT940 parses account statements in the SWIFT MT940 format.}
+    gem.license = "MIT"
+    gem.email = "developers@betterplace.org"
+    gem.homepage = "http://github.com/betterplace/mt940_parser"
+    gem.authors = ["Thies C. Arntzen", "Phillip Oertel"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mt940 #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:patch: 0
+:build: 
+:major: 1
+:minor: 0

data/lib/mt940/customer_statement_message.rb

@@ -0,0 +1,73 @@
+# this is a beautification wrapper around the low-level
+# MT940.parse command. use it in order to make dealing with 
+# the data easier
+class MT940
+
+  class CustomerStatementMessage
+
+    attr_reader :statement_lines
+
+    def self.parse_file(file)
+      self.parse(File.read(file))
+    end
+    
+    def self.parse(data)
+      messages = MT940.parse(data)
+      messages.map { |msg| new(msg) }
+    end
+    
+    def initialize(raw_mt940)
+      @raw = raw_mt940
+      @account = @raw.find { |line| line.class == MT940::Account }
+      @statement_lines = []
+      @raw.each_with_index do |line, i|
+        next unless line.class == MT940::StatementLine
+        ensure_is_info_line!(@raw[i+1])
+        @statement_lines << StatementLineBundle.new(@raw[i], @raw[i+1])
+      end
+    end
+
+    def bank_code
+      @account.bank_code
+    end
+
+    def account_number
+      @account.account_number
+    end
+
+    private 
+    
+    def ensure_is_info_line!(line)
+      unless line.is_a?(MT940::StatementLineInformation)
+        raise StandardError, "Unexpected Structure; expected StatementLineInformation, but was #{line.class}" 
+      end
+    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,
+    }
+
+    def initialize(statement_line, statement_line_info)
+      @line, @info = statement_line, statement_line_info
+    end
+
+    def method_missing(method, *args, &block)
+      super unless METHOD_MAP.has_key?(method)
+      object = instance_variable_get("@#{METHOD_MAP[method.to_sym]}")
+      object.send(method)
+    end
+
+  end
+  
+end

data/lib/mt940.rb

@@ -0,0 +1,237 @@
+class MT940
+  class Field
+    attr_reader :modifier, :content
+  
+    DATE = /(\d{2})(\d{2})(\d{2})/
+    SHORT_DATE = /(\d{2})(\d{2})/
+  
+    class << self
+
+      def for(line)
+        if line.match(/^:(\d{2,2})(\w)?:(.*)$/)
+          number, modifier, content = $1, $2, $3
+          klass = {
+            '20' => Job,
+            '21' => Reference,
+            '25' => Account,
+            '28' => Statement,
+            '60' => AccountBalance,
+            '61' => StatementLine,
+            '62' => ClosingBalance,
+            '64' => ValutaBalance,
+            '65' => FutureValutaBalance,
+            '86' => StatementLineInformation
+          }[number]
+          
+          raise StandardError, "Field #{number} is not implemented" unless klass
+          
+          klass.new(modifier, content)
+        else
+          raise StandardError, "Wrong line format: #{line.dump}"
+        end
+      end
+    end
+    
+    def initialize(modifier, content)
+      @modifier = modifier
+      parse_content(content)
+    end
+
+    private
+      def parse_amount_in_cents(amount)
+        # don't use Integer(amount) function, because amount can be "008" - interpreted as octal number ("010" = 8)
+        amount.gsub(',', '').to_i 
+      end
+      
+      def parse_date(date)
+        date.match(DATE)
+        Date.new("20#{$1}".to_i, $2.to_i, $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)
+        if (entry_date.year != value_date.year)
+          raise "Unhandled case: value date and entry date are in different years"
+        end
+        entry_date
+      end
+  end
+
+  # 20
+  class Job < Field
+    attr_reader :reference
+    
+    def parse_content(content)
+      @reference = content
+    end
+  end
+ 
+  # 21
+  class Reference < Job
+  end
+ 
+  # 25
+  class Account < Field
+    attr_reader :bank_code, :account_number, :account_currency
+    
+    def parse_content(content)
+      content.match(/^(.{8,11})\/(\d{0,23})([A-Z]{3})?$/)
+      @bank_code, @account_number, @account_currency = $1, $2, $3
+    end
+  end
+  
+  # 28
+  class Statement < Field
+    attr_reader :number, :sheet
+    
+    def parse_content(content)
+      content.match(/^(0|(\d{5,5})\/(\d{2,5}))$/)
+      if $1 == '0'
+        @number = @sheet = 0
+      else
+        @number, @sheet = $2.to_i, $3.to_i
+      end
+    end
+  end
+ 
+  # 60
+  class AccountBalance < Field
+    attr_reader :balance_type, :sign, :currency, :amount, :date
+    
+    def parse_content(content)
+      content.match(/^(C|D)(\w{6})(\w{3})(\d{1,12},\d{0,2})$/)
+
+      @balance_type = case @modifier
+        when 'F'
+          :start
+        when 'M'
+          :intermediate
+      end
+      
+      @sign = case $1
+        when 'C'
+          :credit
+        when 'D'
+          :debit
+      end
+      
+      raw_date = $2
+      @currency = $3
+      @amount = parse_amount_in_cents($4)
+      
+      @date = case raw_date
+        when 'ALT', '0'
+          nil
+        when DATE
+          Date.new("20#{$1}".to_i, $2.to_i, $3.to_i) 
+      end
+    end
+  end
+  
+  # 61
+  class StatementLine < Field
+    attr_reader :date, :entry_date, :funds_code, :amount, :swift_code, :reference, :transaction_description
+
+    def parse_content(content)
+      content.match(/^(\d{6})(\d{4})?(C|D|RC|RD)\D?(\d{1,12},\d{0,2})((?:N|F).{3})(NONREF|.{0,16})(?:$|\/\/)(.*)/).to_a
+      
+      raw_date = $1
+      raw_entry_date = $2
+      @funds_code = case $3
+        when 'C'
+          :credit
+        when 'D'
+          :debit
+        when 'RC'
+          :return_credit
+        when 'RD'
+          :return_debit
+      end
+      
+      @amount = parse_amount_in_cents($4)
+      @swift_code = $5
+      @reference = $6
+      @transaction_description = $7
+      
+      @date = parse_date(raw_date)
+      @entry_date = parse_entry_date(raw_entry_date, @date)
+    end
+    
+    def value_date
+      @date
+    end
+  end
+  
+  # 62
+  class ClosingBalance < AccountBalance
+  end
+  
+  # 64
+  class ValutaBalance < AccountBalance
+  end
+
+  # 65
+  class FutureValutaBalance < AccountBalance
+  end
+  
+  # 86
+  class StatementLineInformation < Field
+    attr_reader :code, :transaction_description, :prima_nota, :details, :bank_code, :account_number, 
+      :account_holder, :text_key_extension, :not_implemented_fields
+    
+    def parse_content(content)
+      content.match(/^(\d{3})((.).*)$/)
+      @code = $1.to_i
+      
+      details = []
+      account_holder = []
+
+      if seperator = $3
+        sub_fields = $2.scan(/#{Regexp.escape(seperator)}(\d{2})([^#{Regexp.escape(seperator)}]*)/)
+      
+      
+        sub_fields.each do |(code, content)|
+          case code.to_i
+            when 0
+              @transaction_description = content
+            when 10
+              @prima_nota = content
+            when 20..29, 60..63
+              details << content
+            when 30
+              @bank_code = content
+            when 31
+              @account_number = content
+            when 32..33
+              account_holder << content
+            when 34
+              @text_key_extension = content
+          else
+            @not_implemented_fields ||= []
+            @not_implemented_fields << [code, content]
+            $stderr << "code not implemented: code:#{code} content:»#{content}«\n" if $DEBUG
+          end
+        end
+      end
+      
+      @details = details.join("\n")
+      @account_holder = account_holder.join("\n")
+    end
+  end
+  
+  class << self
+    def parse(text)
+      text << "\r\n" if text[-1,1] == '-'
+      raw_sheets = text.split(/^-\r\n/).map { |sheet| sheet.gsub(/\r\n(?!:)/, '') }
+      sheets = raw_sheets.map { |raw_sheet| parse_sheet(raw_sheet) }
+    end
+    
+    private
+      def parse_sheet(sheet)
+        lines = sheet.split("\r\n")
+        fields = lines.reject { |line| line.empty? }.map { |line| Field.for(line) }
+        fields
+      end
+  end
+end

data/test/fixtures/currency_in_25.txt

@@ -0,0 +1 @@
+:25:51210600/9223382012EUR

data/test/fixtures/currency_in_25.yml

@@ -0,0 +1,6 @@
+--- 
+- - !ruby/object:MT940::Account 
+    account_currency: EUR
+    account_number: "9223382012"
+    bank_code: "51210600"
+    modifier: 

data/test/fixtures/empty_86.txt

@@ -0,0 +1,2 @@
+:86:091
+-

data/test/fixtures/empty_86.yml

@@ -0,0 +1,6 @@
+--- 
+- - !ruby/object:MT940::StatementLineInformation 
+    account_holder: ""
+    code: 0
+    details: ""
+    modifier: 

data/test/fixtures/empty_line.txt

@@ -0,0 +1,2 @@
+
+:20:TELEREPORTING

data/test/fixtures/empty_line.yml

@@ -0,0 +1,4 @@
+--- 
+- - !ruby/object:MT940::Job 
+    modifier: 
+    reference: TELEREPORTING

data/test/fixtures/missing_crlf_at_end.txt

@@ -0,0 +1,2 @@
+:62F:C100323EUR42570,04
+-

data/test/fixtures/missing_crlf_at_end.yml

@@ -0,0 +1,8 @@
+--- 
+- - !ruby/object:MT940::ClosingBalance 
+    amount: 4257004
+    balance_type: :start
+    currency: EUR
+    date: 2010-03-23
+    modifier: F
+    sign: :credit