outbanker 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGE0OTE3YTI0NWE1YzFiMDRkYWY4MDllOGFjNDIwZTEyYTMzODk4Ng==
+  data.tar.gz: !binary |-
+    NDczY2VkNTcwY2Q5YjE5MDVjMDA2ZDVkZmUwYjU0ODBhNGZjMTExNA==
+SHA512:
+  metadata.gz: !binary |-
+    ZjM0MWQxZWZkMzVmZDFlZDk1NjA5YTJiYzk4NjU5YTk1YmM2YmQyNDM2NzVj
+    ODY1MjcyZDgzYWQwODU2NWVlMWYxYzgzMzUzODRkMjU3ZDRjYzVlYjFiNGI3
+    MjczYjE5ZjcyNWFiMWUzZjYxNTA4NGU5YWQzMDY0OTI0NmNiZTQ=
+  data.tar.gz: !binary |-
+    NTUwMGUwOGZmNjBlZWE1MmZmODk1Mjk5NjRjOWVlZTRiMzM4YWVhZGNiMTQ4
+    YThlMTczYmIxMWEzMGY5NDE3YWQ3ZTI3Mzg0ZTI2YmI3NzNjYzU3ZjJiYmJm
+    OGJhZDYxZmY4OGIxZDhhMmU3ZDBhZjNmZjdlNjdkMTgyMzQyNTI=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+env:
+  - RUBYOPT=-Ku

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in outbanker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Phillip Oertel
+
+MIT License
+
+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.md

@@ -0,0 +1,36 @@
+[![Build Status](https://api.travis-ci.org/phillipoertel/outbanker.png?branch=master)](https://travis-ci.org/phillipoertel/outbanker)
+
+# Outbanker
+
+Outbanker reads a CSV file exported from [Outbank](http://www.outbank.de) and converts the types to Ruby, as well as doing some cleanups.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'outbanker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install outbanker
+
+## Usage
+
+    lines = Outbanker::StatementLines.read('outbank.csv')
+    lines.each do |line|
+      puts line.amount
+    end
+
+See the class +StatementLine+ for all available fields.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+   t.libs << "test"
+   t.test_files = FileList['test/outbanker/**/*_test.rb']
+   t.verbose = true
+end
+
+desc 'parse a file given as FILE for testing purposes, show the FIELDS given on the cli'
+task :parse_file do
+  require 'outbanker'
+  require 'yaml'
+  file = ENV['FILE']
+  fields = ENV['FIELDS'].split(',')
+  Outbanker::StatementLines.read(file).each do |line|
+    puts fields.map { |f| "#{f}: #{line.send(f)}" }.join("\n")
+  end
+end

data/lib/outbanker/money_string_parser.rb

@@ -0,0 +1,14 @@
+module Outbanker
+  module MoneyStringParser
+    def to_cents(string)
+      matches = string.match(/(?<separator>\.|\,)(?<cents>[0-9]{1,2})\Z/)
+      if !matches
+        string.to_i * 100
+      elsif matches[:cents].length == 1
+        string.gsub(matches[:separator], '').to_i * 10
+      elsif matches[:cents].length == 2
+        string.gsub(matches[:separator], '').to_i
+      end
+    end
+  end
+end

data/lib/outbanker/statement_line.rb

@@ -0,0 +1,78 @@
+require 'digest/md5'
+
+module Outbanker
+  
+  # 
+  # this is a representation of one line in an outbank csv statement
+  # with translated, parsed attributes (cents, date, etc.).
+  #
+  class StatementLine
+
+    include MoneyStringParser
+    
+    ATTRIBUTE_MAPPING = {
+      :currency => "Währung",
+      :amount => "Betrag",
+      :booked_on => "Buchungstag",
+      :valuta_on => "Valuta-Datum",
+      :recipient => "Empfänger/Auftraggeber",
+      :bank_code => "Bankleitzahl",
+      :account_number => "Kontonummer",
+      :description => "Verwendungszweck",
+      :category => "Kategorie"
+    }
+
+    def initialize(csv_row)
+      @row = csv_row
+    end
+    
+    def amount
+      to_cents(@row['Betrag'])
+    end
+    
+    def booked_on
+      Date.parse(@row['Buchungstag'])
+    end
+    
+    def charged?
+      # in different cases I get either "Abgerechnet" or "" when a line was charged.
+      @row['Buchungstext'] != "Nicht abgerechnet"
+    end
+    
+    def valuta_on
+      Date.parse(@row['Valuta-Datum'])
+    end
+    
+    def description
+      @row['Verwendungszweck'].to_s.gsub(/\s+/, ' ')
+    end
+    
+    def payee
+      desc_lines = @row['Verwendungszweck'].split("  ").reject { |row| row =~ /\A\s*\Z/ }.map { |row| row.strip }
+      desc_lines[1] || desc_lines[0] || nil
+    end
+    
+    def category
+      [nil, ''].include?(@row['Kategorie']) ? nil : @row['Kategorie']
+    end
+    
+    def prebooking?
+      @row['Vormerkung'] == 'Ja'
+    end
+    
+    def method_missing(arg)
+      super unless ATTRIBUTE_MAPPING.keys.include?(arg)
+      @row.send(:[], ATTRIBUTE_MAPPING[arg])
+    end
+    
+    def unique_id
+      unique_string = [amount, booked_on, description].join('-')
+      Digest::MD5.hexdigest(unique_string)
+    end
+    
+    def to_s
+      "Buchung vom: #{booked_on}, Betrag: #{amount}, Beschreibung: #{description}"
+    end
+    
+  end
+end

data/lib/outbanker/statement_lines.rb

@@ -0,0 +1,50 @@
+require 'csv'
+
+module Outbanker
+  class StatementLines
+  
+    attr_reader :earliest_booking, :latest_booking, :num_statements
+
+    # required for testing only
+    attr_reader :csv
+  
+    def self.read(file = 'data/outbank.csv')
+      instance = new
+      instance.read(file)
+      instance
+    end  
+  
+    def read(file)
+      @csv = read_csv(file)
+      get_csv_metadata
+      @lines = @csv.map { |row| Outbanker::StatementLine.new(row) }
+    end
+    
+    # delegate stuff to the @lines array
+    def method_missing(method, *args, &block)
+      delegated_methods = [:size, :each, :map, :[]]
+      return super unless delegated_methods.include?(method)
+      @lines.send(method, *args, &block)
+    end
+    
+    private
+    
+      def read_csv(file)
+        options = { 
+          :col_sep => ';', 
+          :headers => true,
+          :converters => [:all]
+        }
+        CSV.new(File.read(file), options)
+      end
+      
+      def get_csv_metadata
+        rows = @csv.read
+        @earliest_booking = Date.parse(rows[rows.size - 1]['Buchungstag'])
+        @latest_booking   = Date.parse(rows[0]['Buchungstag'])
+        @num_statements   = rows.size
+        @csv.rewind
+      end
+    
+  end
+end

data/lib/outbanker/version.rb

@@ -0,0 +1,3 @@
+module Outbanker
+  VERSION = "0.1.1"
+end

data/lib/outbanker.rb

@@ -0,0 +1,7 @@
+require 'minitest/unit'
+
+require "outbanker/version"
+require "outbanker/money_string_parser"
+require "outbanker/statement_line"
+require "outbanker/statement_lines"
+

data/outbanker.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'outbanker/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "outbanker"
+  gem.version       = Outbanker::VERSION
+  gem.authors       = ["Phillip Oertel"]
+  gem.email         = ["me@phillipoertel.com"]
+  gem.description   = %q{outbanker is Ruby wrapper for Outbank CSV files.}
+  gem.summary       = %q{outbanker reads a CSV file exported from Outbanker/MAC and converts the types to Ruby, as well as doing some cleanups.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency('rake')
+  gem.add_dependency('turn')
+end

data/test/fixtures/outbank-cc.csv

@@ -0,0 +1,3 @@
+"Buchungstext";"Währung";"Betrag";"Buchungstag";"Valuta-Datum";"Empfänger/Auftraggeber";"Bankleitzahl";"Kontonummer";"Verwendungszweck";"Vormerkung";"Buchungsschlüssel";"Kommentar";"Kategorie";"PayPal Empfänger/Auftraggeber";"PayPal An E-Mail";"PayPal Von E-Mail";"PayPal Gebühr";"PayPal Transaktionscode";"PayPal Status"
+"Nicht abgerechnet";"EUR";"-105,90";"22.01.2013";"23.01.2013";;;;"Paypal Foo Bar";"Nein";;;"Some category";;;;;;
+"Abgerechnet";"EUR";"-6,84";"19.01.2013";"21.01.2013";;;;"Some service 541-2264551";"Nein";;;"Weiterbildung";;;;;;

data/test/fixtures/outbank-fixture.csv

@@ -0,0 +1,5 @@
+"Buchungstext";"Währung";"Betrag";"Buchungstag";"Valuta-Datum";"Empfänger/Auftraggeber";"Bankleitzahl";"Kontonummer";"Verwendungszweck";"Vormerkung";"Buchungsschlüssel";"Kommentar";"Kategorie";"PayPal Empfänger/Auftraggeber";"PayPal An E-Mail";"PayPal Von E-Mail";"PayPal Gebühr";"PayPal Transaktionscode";"PayPal Status"
+;"EUR";"-15,42";"31.12.2012";"02.01.2013";;;;"Saldo der Abschlussposten  QM - Support               04082 Leipzig";"Nein";"835";;"Bankgebühren";;;;;;
+;"EUR";"-17,97";"31.12.2012";"31.12.2012";;;;"Saldo der Abschlussposten  QM - Support               04082 Leipzig              Kontoabschluss             4. Quartal 12                Foo                              14,97               8 kostenfreie Poste";"Nein";"835";;"";;;;;;
+;"EUR";"-15,00";"28.12.2012";"28.12.2012";;;;"12.2012  VNR. 42-4444 PO             XY LV               PO             ";"Ja";"835";;"Altersvorsorge";;;;;;
+;"EUR";"20,15";"28.12.2012";"28.12.2012";;;;"GELDKARTEBLABLAERSTATTUNG UNTER VORBEHALT SNR.0                      KNR.424242 BLZ.42424242 672219500001343382         ";"Nein";"835";;"Bus & Bahn";;;;;;

data/test/outbanker/money_string_parser_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+class Outbanker::MoneyStringParserTest < MiniTest::Unit::TestCase
+  
+  class Tester
+    include ::Outbanker::MoneyStringParser
+  end
+  
+  def setup
+    @tester = Tester.new
+  end
+
+  def test_full_value
+    assert_equal 1200, @tester.to_cents("12")
+  end
+  
+  def test_full_value_negative
+    assert_equal -1200, @tester.to_cents("-12")
+  end
+  
+  #
+  # COMMAS
+  #
+  def test_comma_full_euros
+    assert_equal 1200, @tester.to_cents("12,00")
+  end
+  
+  def test_comma_euros_and_cents
+    assert_equal 1212, @tester.to_cents("12,12")
+  end
+  
+  def test_comma_euros_and_cents_one_digit
+    assert_equal 1210, @tester.to_cents("12,1")
+  end
+  
+  def test_comma_zero
+    assert_equal 0, @tester.to_cents("0,00")
+  end
+  
+  def test_comma_negative_full_euros
+    assert_equal -1200, @tester.to_cents("-12,00")
+  end
+  
+  def test_comma_negative_euros_and_cents
+    assert_equal -1212, @tester.to_cents("-12,12")
+  end
+
+  #
+  # DOT
+  #
+  def test_dot_full_euros
+    assert_equal 1200, @tester.to_cents("12.00")
+  end
+  
+  def test_dot_euros_and_cents
+    assert_equal 1212, @tester.to_cents("12.12")
+  end
+  
+  def test_dot_euros_and_cents_one_digit
+    assert_equal 1210, @tester.to_cents("12.1")
+  end
+  
+  def test_dot_zero
+    assert_equal 0, @tester.to_cents("0.00")
+  end
+  
+  def test_dot_negative_full_euros
+    assert_equal -1200, @tester.to_cents("-12.00")
+  end
+  
+  def test_dot_negative_euros_and_cents
+    assert_equal -1212, @tester.to_cents("-12.12")
+  end
+  
+end

data/test/outbanker/statement_line_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+class Outbanker::StatementLineTest < MiniTest::Unit::TestCase
+  
+  def setup
+    fixture = File.join(File.dirname(__FILE__), '../fixtures/outbank-fixture.csv')
+    @lines = Outbanker::StatementLines.read(fixture)
+  end
+  
+  def setup_cc_fixture
+    fixture = File.join(File.dirname(__FILE__), '../fixtures/outbank-cc.csv')
+    @lines = Outbanker::StatementLines.read(fixture)
+  end
+  
+  def test_attribute_mapping_works
+    line = @lines[0]
+    assert_equal "EUR", line.currency
+    assert_equal -1542, line.amount
+    assert_equal Date.parse("31.12.2012"), line.booked_on
+    assert_equal Date.parse("02.01.2013"), line.valuta_on
+    assert_equal nil, line.recipient
+    assert_equal nil, line.bank_code
+    assert_equal nil, line.account_number
+    assert_equal "Saldo der Abschlussposten QM - Support 04082 Leipzig", line.description
+    assert_equal "Bankgebühren", line.category
+  end
+
+  def test_empty_category_is_returned_as_nil
+    line = @lines[1]
+    assert_equal nil, line.category
+  end
+  
+  #
+  # Unique Ids
+  #
+  def test_unique_id_exists
+    line = @lines[0]
+    assert_equal "218d1ee8478cbb5b697fe77962424817", line.unique_id
+  end
+
+  def test_unique_id_depends_on_amount
+    line = @lines[0]
+    row = @lines.csv.read # get the raw first csv line
+    row['Betrag'] = "1#{row['Betrag']}"
+    refute_equal Outbanker::StatementLine.new(row), line.unique_id
+  end
+  
+  def test_unique_id_depends_on_booked_on
+    line = @lines[0]
+    row = @lines.csv.read # get the raw first csv line
+    row['Buchungstag'] = "01.01.1971"
+    refute_equal Outbanker::StatementLine.new(row), line.unique_id
+  end
+  
+  def test_unique_id_depends_on_description
+    line = @lines[0]
+    row = @lines.csv.read # get the raw first csv line
+    row['Verwendungszweck'] = "#{row['Verwendungszweck']} Bla bla"
+    refute_equal Outbanker::StatementLine.new(row), line.unique_id
+  end
+  
+  def test_was_charged_when_empty
+    line = @lines[0]
+    assert_equal true, line.charged?
+  end
+  
+  def test_was_charged_when_filled
+    setup_cc_fixture
+    line = @lines[1]
+    assert_equal true, line.charged?
+  end
+  
+  def test_was_not_charged
+    setup_cc_fixture
+    line = @lines[0]
+    assert_equal false, line.charged?
+  end
+  
+  def test_prebooking_false
+    line = @lines[0]
+    assert_equal false, line.prebooking?
+  end
+  
+  def test_prebooking_true
+    line = @lines[2]
+    assert_equal true, line.prebooking?
+  end
+end

data/test/outbanker/statement_lines_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class Outbanker::StatementLinesTest < MiniTest::Unit::TestCase
+  
+  def setup
+    fixture = File.join(File.dirname(__FILE__), '../fixtures/outbank-fixture.csv')
+    @lines = Outbanker::StatementLines.read(fixture)
+  end
+  
+  #
+  # test array behaviour
+  #
+  def test_size
+    assert_equal 4, @lines.size
+  end
+  
+  def test_each
+    count = 0
+    @lines.each { |l| count += 1 }
+    assert_equal 4, count
+  end
+  
+  def test_map
+    out = @lines.map { |l| l }
+    assert_equal 4, out.size
+  end
+  
+  def test_array_access
+    assert_equal Outbanker::StatementLine, @lines[0].class
+  end
+  
+  #
+  # test metadata
+  #
+  def test_num_statements
+    assert_equal 4, @lines.num_statements
+  end
+  
+  def test_latest_booking
+    assert_equal Date.parse("31.12.2012"), @lines.latest_booking
+  end
+  
+  def test_earliest_booking
+    assert_equal Date.parse("28.12.2012"), @lines.earliest_booking
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'outbanker'
+
+# TESTING UTILITIES
+begin; require 'turn/autorun'; rescue LoadError; end
+require 'minitest/autorun'
+require 'ostruct'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: outbanker
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Phillip Oertel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+description: outbanker is Ruby wrapper for Outbank CSV files.
+email:
+- me@phillipoertel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/outbanker.rb
+- lib/outbanker/money_string_parser.rb
+- lib/outbanker/statement_line.rb
+- lib/outbanker/statement_lines.rb
+- lib/outbanker/version.rb
+- outbanker.gemspec
+- test/fixtures/outbank-cc.csv
+- test/fixtures/outbank-fixture.csv
+- test/outbanker/money_string_parser_test.rb
+- test/outbanker/statement_line_test.rb
+- test/outbanker/statement_lines_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: outbanker reads a CSV file exported from Outbanker/MAC and converts the types
+  to Ruby, as well as doing some cleanups.
+test_files:
+- test/fixtures/outbank-cc.csv
+- test/fixtures/outbank-fixture.csv
+- test/outbanker/money_string_parser_test.rb
+- test/outbanker/statement_line_test.rb
+- test/outbanker/statement_lines_test.rb
+- test/test_helper.rb