konto_check 0.0.1

data/ext/konto_check/konto_check_ruby.c

@@ -0,0 +1,129 @@
+/*==================================================================
+ *
+ * KontoCheck Module, C Ruby Extension
+ *
+ * Copyright (c) 2010 Provideal Systems GmbH
+ *
+ * Peter Horn, peter.horn@provideal.net
+ *
+ * ------------------------------------------------------------------
+ *
+ * ACKNOWLEDGEMENT
+ *
+ * This module is entirely based on the C library konto_check
+ * http://www.informatik.hs-mannheim.de/konto_check/
+ * http://sourceforge.net/projects/kontocheck/
+ * by Michael Plugge.
+ *
+ * ------------------------------------------------------------------
+ *
+ * LICENCE
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+// Include the Ruby headers and goodies
+#include "ruby.h"
+#include <stdio.h>
+#include "konto_check.h"
+
+// Defining a space for information and references about the module to be stored internally
+VALUE KontoCheck = Qnil;
+
+/**
+ * KontoCheck::konto_check(<kto>, <blz>)
+ *
+ * check whether the given account number kto kann possibly be
+ * a valid number of the bank with the bic blz.
+ */
+VALUE konto_check(VALUE self, VALUE kto_rb, VALUE blz_rb) {
+  char* kto = RSTRING(kto_rb)->ptr;
+  char* blz = RSTRING(blz_rb)->ptr;
+  int ret = kto_check_blz(blz, kto);
+  switch (ret) {
+    case OK:
+      return Qtrue;
+    case LUT2_NOT_INITIALIZED:
+      rb_raise(rb_eRuntimeError, "KontoCheck unitialized, use 'load_bank_data' to import bank information.");
+  }
+  return Qfalse;
+}
+
+/**
+ * KontoCheck::load_bank_data(<datafile>)
+ *
+ * initialize the underlying C library konto_check with the bank
+ * information from datafile.
+ * Internally, this file is first transformed into a LUT file and then
+ * read.
+ *
+ * For the datafile, use the file 'blz_yyyymmdd.txt' from
+ * http://www.bundesbank.de/zahlungsverkehr/zahlungsverkehr_bankleitzahlen_download.php
+ * These files are updated every three months, so be sure to
+ * replace them regularly.
+ */
+VALUE load_bank_data(VALUE self, VALUE path_rb) {
+  char* path = RSTRING(path_rb)->ptr;
+  char* tmp_lut = tmpnam(NULL);
+
+  // convert the Bankfile to a LUT file
+  int ret = generate_lut(path, tmp_lut, "Temporary LUT file", 2);
+  switch (ret) {
+    case LUT1_FILE_GENERATED:
+      break;
+    case FILE_READ_ERROR:
+      rb_raise(rb_eRuntimeError, "[%d] KontoCheck: can not open file '%s'.", ret, path);
+    case INVALID_BLZ_FILE:
+      rb_raise(rb_eRuntimeError, "[%d] KontoCheck: invalid input file '%s'. Use the file 'blz_yyyymmdd.txt' from http://www.bundesbank.de/zahlungsverkehr/zahlungsverkehr_bankleitzahlen_download.php", ret, path);
+    default:
+      rb_raise(rb_eRuntimeError, "[%d] KontoCheck: error reading file '%s'.", ret, tmp_lut);
+  }
+
+  // read the LUT file
+  ret = kto_check_init2(tmp_lut);
+  switch (ret) {
+    case LUT1_SET_LOADED:
+    case LUT2_PARTIAL_OK:
+      return Qtrue;
+    case FILE_READ_ERROR:
+      rb_raise(rb_eRuntimeError, "[%d] KontoCheck: can not open tempfile '%s'.", ret, tmp_lut);
+    case INVALID_LUT_FILE:
+      rb_raise(rb_eRuntimeError, "[%d] KontoCheck: invalid input tempfile '%s'.", ret, tmp_lut);
+  }
+  rb_raise(rb_eRuntimeError, "[%d] KontoCheck: error reading tempfile '%s'.", ret, tmp_lut);
+  return Qnil;
+}
+
+/**
+ * KontoCheck::bank_name(<blz>)
+ *
+ * gives the name of the bank as a string or nil
+ * if no bank with the given name exists.
+ */
+VALUE bank_name(VALUE self, VALUE bic) {
+  char* blz = RSTRING(bic)->ptr;
+  return rb_str_new2(lut_name(blz, 0, NULL));
+}
+
+
+/**
+ * The initialization method for this module
+ */
+void Init_konto_check() {
+  KontoCheck = rb_define_module("KontoCheck");
+  rb_define_module_function(KontoCheck, "konto_check", konto_check, 2);
+  rb_define_module_function(KontoCheck, "bank_name", bank_name, 1);
+  rb_define_module_function(KontoCheck, "load_bank_data", load_bank_data, 1);
+}
+

data/konto_check.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{konto_check}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Provideal Systems GmbH"]
+  s.date = %q{2010-04-14}
+  s.description = %q{Check whether a certain bic/account-no-combination can possibly be valid. It uses the C library kontocheck (see http://sourceforge.net/projects/kontocheck/) by Michael Plugge.}
+  s.email = %q{info@provideal.net}
+  s.extensions = ["ext/konto_check/extconf.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION.yml",
+     "ext/konto_check/extconf.rb",
+     "ext/konto_check/konto_check.c",
+     "ext/konto_check/konto_check.h",
+     "ext/konto_check/konto_check_ruby.c",
+     "konto_check.gemspec",
+     "test/helper.rb",
+     "test/test_konto_check.rb"
+  ]
+  s.homepage = %q{http://github.com/provideal/konto_check}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Checking german BICs/Bank account numbers}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_konto_check.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'konto_check'
+
+class Test::Unit::TestCase
+end

data/test/test_konto_check.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestKontoCheck < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: konto_check
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Provideal Systems GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Check whether a certain bic/account-no-combination can possibly be valid. It uses the C library kontocheck (see http://sourceforge.net/projects/kontocheck/) by Michael Plugge.
+email: info@provideal.net
+executables: []
+
+extensions: 
+- ext/konto_check/extconf.rb
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION.yml
+- ext/konto_check/extconf.rb
+- ext/konto_check/konto_check.c
+- ext/konto_check/konto_check.h
+- ext/konto_check/konto_check_ruby.c
+- konto_check.gemspec
+- test/helper.rb
+- test/test_konto_check.rb
+has_rdoc: true
+homepage: http://github.com/provideal/konto_check
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Checking german BICs/Bank account numbers
+test_files: 
+- test/helper.rb
+- test/test_konto_check.rb