kontoapi-rails 0.0.1

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "rails", "~> 3.0.0"
+gem 'kontoapi-ruby'
+
+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,96 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.6)
+      actionpack (= 3.0.6)
+      mail (~> 2.2.15)
+    actionpack (3.0.6)
+      activemodel (= 3.0.6)
+      activesupport (= 3.0.6)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.6)
+      activesupport (= 3.0.6)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.6)
+      activemodel (= 3.0.6)
+      activesupport (= 3.0.6)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.6)
+      activemodel (= 3.0.6)
+      activesupport (= 3.0.6)
+    activesupport (3.0.6)
+    addressable (2.2.5)
+    arel (2.0.9)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    kontoapi-ruby (0.1.0)
+      addressable
+      yajl-ruby
+    mail (2.2.16)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.6)
+      actionmailer (= 3.0.6)
+      actionpack (= 3.0.6)
+      activerecord (= 3.0.6)
+      activeresource (= 3.0.6)
+      activesupport (= 3.0.6)
+      bundler (~> 1.0)
+      railties (= 3.0.6)
+    railties (3.0.6)
+      actionpack (= 3.0.6)
+      activesupport (= 3.0.6)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    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)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.26)
+    yajl-ruby (0.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  kontoapi-ruby
+  rails (~> 3.0.0)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jan Schwenzien
+
+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.markdown

@@ -0,0 +1,48 @@
+Konto API Rails Validator
+=========================
+
+This library is a wrapper for the Konto API (https://www.kontoapi.de/).
+It provides a validation method for ActiveRecord models that checks if a given account number and bank code represent a valid combination.
+
+INSTALLATION
+------------
+
+    $ [sudo] gem install kontoapi-rails
+
+USAGE
+-----
+
+Add an initializer (e.g. kontoapi.rb) in `config/initializers`:
+
+    KontoAPI.setup do |config|
+      # mendatory
+      config.api_key = '<your-api-key>' # get one at https://www.kontoapi.de/
+      # optional (with defaults)
+      config.timeout = 10
+    end
+
+Then, in one of the models you want to validate bank account data with:
+
+    class PaymentData < ActiveRecord::Base
+    
+      # other validations
+      validates :account_number, :bank_code, :presence => true
+    
+      # account data validation
+      # (really just a shortcut for `validates_with KontoAPI::BankAccountValidator`)
+      # takes any of the following options (the defaults are shown here):
+      #   :account_number_field => :account_number,
+      #   :bank_code_field      => :bank_code,
+      #   :allow_nil            => true,    <-- don't validate if one of them is nil
+      #   :on_timeout           => :ignore  <-- do nothing if a timeout occurs, others:
+      #                            :fail    <-- throw a validation error
+      #                            :retry   <-- (not supported yet)
+      validates_account_data
+    
+    end
+
+Copyright
+---------
+
+Copyright (c) 2011 General Scripting - Jan Schwenzien. See LICENSE for further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+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'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "kontoapi-rails"
+  gem.homepage = "http://github.com/GeneralScripting/kontoapi-rails"
+  gem.license = "MIT"
+  gem.summary = %Q{A wrapper for the Konto API (https://www.kontoapi.de/) providing model validation.}
+  gem.description = %Q{This library is a wrapper for the Konto API (https://www.kontoapi.de/). It provides a validation method for models that checks if a given account number and bank code represent a valid combination.}
+  gem.email = "jan@schwenzien.org"
+  gem.authors = ["Jan Schwenzien"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "kontoapi-rails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/init.rb

@@ -0,0 +1 @@
+require 'kontoapi-rails'

data/kontoapi-rails.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{kontoapi-rails}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jan Schwenzien"]
+  s.date = %q{2011-04-18}
+  s.description = %q{This library is a wrapper for the Konto API (https://www.kontoapi.de/). It provides a validation method for models that checks if a given account number and bank code represent a valid combination.}
+  s.email = %q{jan@schwenzien.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "kontoapi-rails.gemspec",
+    "lib/kontoapi-rails.rb",
+    "lib/kontoapi-rails/config.rb",
+    "lib/kontoapi-rails/orm/active_record_extension.rb",
+    "lib/kontoapi-rails/orm/mongoid_extension.rb",
+    "lib/kontoapi-rails/railtie.rb",
+    "lib/kontoapi-rails/validators/bank_account_validator.rb",
+    "spec/kontoapi-rails_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/GeneralScripting/kontoapi-rails}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.7.2}
+  s.summary = %q{A wrapper for the Konto API (https://www.kontoapi.de/) providing model validation.}
+  s.test_files = [
+    "spec/kontoapi-rails_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<kontoapi-ruby>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, ["~> 3.0.0"])
+      s.add_dependency(%q<kontoapi-ruby>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 3.0.0"])
+    s.add_dependency(%q<kontoapi-ruby>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/kontoapi-rails.rb

@@ -0,0 +1,3 @@
+require 'kontoapi-ruby'
+require 'kontoapi-rails/config'
+require 'kontoapi-rails/railtie'

data/lib/kontoapi-rails/config.rb

@@ -0,0 +1,23 @@
+module KontoAPI
+
+  module Config
+
+    class << self
+
+      def api_key=(new_key)
+        KontoAPI::api_key = new_key
+      end
+
+      def timeout=(new_timeout)
+        KontoAPI::timeout = new_timeout
+      end
+
+    end
+
+  end
+
+  def self.setup
+    yield KontoAPI::Config
+  end
+
+end

data/lib/kontoapi-rails/orm/active_record_extension.rb

@@ -0,0 +1,31 @@
+module KontoAPI
+  module ActiveRecordExtension
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    module ClassMethods
+      def validates_bank_account(options={})
+        options.symbolize_keys!
+        validates_with KontoAPI::BankAccountValidator, options
+      end
+
+      def autocomplete_bank_name(options={})
+        options.symbolize_keys!
+        options.reverse_merge!(
+          :bank_code_field  => :bank_code,
+          :bank_name_field  => :bank_name
+        )
+        #write_inheritable_attribute(:autocomplete_bank_name_options, options)
+        define_method :autocomplete_bank_name do
+          current_value = send(:"#{options[:bank_name_field]}")
+          blz           = send(:"#{options[:bank_code_field]}")
+          self.send(:"#{options[:bank_name_field]}=", KontoAPI::bank_name(blz)) if current_value.blank? && blz.present?
+        end
+        before_save :autocomplete_bank_name
+      end
+    end
+
+  end
+end

data/lib/kontoapi-rails/orm/mongoid_extension.rb

@@ -0,0 +1 @@
+# not implemented yet

data/lib/kontoapi-rails/railtie.rb

@@ -0,0 +1,21 @@
+require 'rails'
+# ensure ORMs are loaded *before* initializing
+begin; require 'mongoid'; rescue LoadError; end
+
+require File.join(File.dirname(__FILE__), 'validators/bank_account_validator')
+
+module KontoAPI
+  class Railtie < ::Rails::Railtie #:nodoc:
+    initializer 'kontoapi' do |app|
+      ActiveSupport.on_load(:active_record) do
+        require File.join(File.dirname(__FILE__), 'orm/active_record_extension')
+        ::ActiveRecord::Base.send :include, KontoAPI::ActiveRecordExtension
+      end
+      if defined? ::Mongoid
+        require File.join(File.dirname(__FILE__), 'orm/mongoid_extension')
+        #::Mongoid::Document.send :include, KontoAPI::MongoidExtension::Document
+        #::Mongoid::Criteria.send :include, KontoAPI::MongoidExtension::Criteria
+      end
+    end
+  end
+end

data/lib/kontoapi-rails/validators/bank_account_validator.rb

@@ -0,0 +1,30 @@
+require 'active_model/validator'
+
+module KontoAPI
+  class BankAccountValidator < ActiveModel::Validator
+
+    DEFAULTS = {
+      :account_number_field => :account_number,
+      :bank_code_field      => :bank_code,
+      :allow_nil            => true,
+      :on_timeout           => :ignore
+    }
+
+    def validate(record)
+      record_options  = options.reverse_merge(DEFAULTS)
+      account_number  = record.send(:"#{record_options[:account_number_field]}")
+      bank_code       = record.send(:"#{record_options[:bank_code_field]}")
+      record.errors.add(:"#{record_options[:account_number_field]}", :invalid) unless KontoAPI::valid?(account_number, bank_code)
+    rescue Timeout::Error => ex
+      case record_options[:on_timeout]
+      when :fail
+        record.errors.add(:"#{record_options[:account_number_field]}", :timeout)
+      when :ignore
+        # nop
+      when :retry
+        raise 'not implemented yet'
+      end
+    end
+
+  end
+end

data/spec/kontoapi-rails_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "KontoAPI Rails" do
+  it "should be tested" do
+    fail "TEST ME!"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'kontoapi-rails'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification 
+name: kontoapi-rails
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jan Schwenzien
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: kontoapi-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: This library is a wrapper for the Konto API (https://www.kontoapi.de/). It provides a validation method for models that checks if a given account number and bank code represent a valid combination.
+email: jan@schwenzien.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- kontoapi-rails.gemspec
+- lib/kontoapi-rails.rb
+- lib/kontoapi-rails/config.rb
+- lib/kontoapi-rails/orm/active_record_extension.rb
+- lib/kontoapi-rails/orm/mongoid_extension.rb
+- lib/kontoapi-rails/railtie.rb
+- lib/kontoapi-rails/validators/bank_account_validator.rb
+- spec/kontoapi-rails_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/GeneralScripting/kontoapi-rails
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: A wrapper for the Konto API (https://www.kontoapi.de/) providing model validation.
+test_files: 
+- spec/kontoapi-rails_spec.rb
+- spec/spec_helper.rb