blz 0.1.0

data/lib/blz.rb

@@ -0,0 +1,10 @@
+# Copyright (C) 2012 Oliver Eilhard
+#
+# This library is freely distributable under the terms of 
+# an MIT-style license.
+# See COPYING or http://www.opensource.org/licenses/mit-license.php.
+#
+# Provides information about "Bankleitzahlen" (BLZ),
+# a bank identifier code system used by German and Austrian banks.
+
+require 'blz/bank'

data/lib/blz/bank.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+
+module BLZ
+  #  Represents a bank with a BLZ, a BIC, a name etc.
+  class Bank
+    # BLZ = a bank idenfier code widely used in DE and AT
+    attr_reader :blz
+    # Name of the bank
+    attr_reader :name
+    # Postal code
+    attr_reader :zip
+    # City
+    attr_reader :city
+    # Short name = short description of the bank
+    attr_reader :short_name
+    # BIC = bank identifier code (ISO 9362)
+    attr_reader :bic
+
+    # Initializes a single Bank record.
+    def initialize(blz, name, zip, city, short_name, bic)
+      @blz = blz
+      @name = name 
+      @zip = zip
+      @city = city
+      @short_name = short_name
+      @bic = bic
+    end
+
+    # Returns an array of all Banks specified by +code+.
+    # The following options apply:
+    #
+    #    exact:: Only return exact matches (false by default)
+    #
+    def self.find_by_blz(code, options = nil)
+      options ||= {}
+      exact = options.fetch(:exact, false)
+
+      self.all.inject([]) do |results, bank|
+        if bank.blz == code || (!exact && bank.blz.start_with?(code))
+          results << bank
+        end
+        results
+      end
+    end
+
+    # Returns an array of all Banks with a substring of +city+.
+    def self.find_by_city(substring)
+      self.all.inject([]) do |results, bank|
+        results << bank if bank.city.index(substring)
+        results
+      end
+    end
+
+    # Returns an array of all banks.
+    def self.all
+      # TODO is this the right way to do it?
+      Thread.current[:'BLZ::Bank.all'] ||= read_banks
+    end
+
+    # Returns a nice representation of the bank.
+    def to_s
+      [blz, name, "#{zip} #{city}", bic].reject { |s| s.empty? }.join ", "
+    end
+
+  private
+
+    def self.read_banks
+      banks = []
+      filename = File.join(File.dirname(__FILE__), '..', '..', 'data', 'blz.tsv')
+      File.foreach(filename) do |line|
+        columns = line.split /\t/
+        blz = columns[0].strip
+        name = columns[2].strip
+        zip = columns[3].strip
+        city = columns[4].strip
+        short_name = columns[5].strip
+        bic = columns[7].strip
+        banks << Bank.new(blz, name, zip, city, short_name, bic)
+      end
+      banks
+    end
+
+  end
+end
+

data/test/test_bank.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'blz'
+require 'test/unit'
+
+class TestBank < Test::Unit::TestCase
+
+  def test_all_banks
+    assert !BLZ::Bank.all.nil?
+    assert sskm = BLZ::Bank.all.find { |b| b.blz == "70150000" }
+    assert_equal "Stadtsparkasse München", sskm.name
+  end
+
+  def test_search_by_exact_match
+    assert results = BLZ::Bank.find_by_blz("70150000", :exact => true)
+    assert_equal 1, results.size
+    assert_equal "70150000", results[0].blz
+    assert_equal "Stadtsparkasse München", results[0].name
+    assert_equal "St Spk München", results[0].short_name
+    assert_equal "80791", results[0].zip
+    assert_equal "München", results[0].city
+    assert_equal "SSKMDEMMXXX", results[0].bic
+  end
+
+  def test_search_by_prefix
+    assert results = BLZ::Bank.find_by_blz("7106")
+    assert results.size > 1
+    #assert_equal "Stadtsparkasse München", results[0].bezeichnung
+  end
+  
+  def test_search_by_city
+    assert results = BLZ::Bank.find_by_city("München")
+    assert results.size > 1
+    assert results.find { |b| b.blz == "70150000" }
+  end
+  
+  def test_to_s
+    assert results = BLZ::Bank.find_by_blz("70150000", :exact_only => true)
+    assert_equal 1, results.size
+    assert_equal "70150000, Stadtsparkasse München, 80791 München, SSKMDEMMXXX", results[0].to_s
+  end
+
+end
+

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: blz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Oliver Eilhard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: ! 'BLZ (Bankleitzahlen) is a small library for looking up
+
+  the widely used bank identifier code system in Germany
+
+  and Austria.
+
+
+  http://github.com/olivere/blz
+
+'
+email: oliver.eilhard@gmail.com
+executables:
+- blz
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/blz
+- blz.gemspec
+- data/blz.tsv
+- data/blz_2012_06_04_xls.xlsx
+- lib/blz.rb
+- lib/blz/bank.rb
+- test/test_bank.rb
+homepage: http://github.com/olivere/blz
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: BLZ (Bankleitzahlen) for Ruby
+test_files: []