king_dtaus 2.0.2.pre → 2.0.2

data/.gitignore

@@ -0,0 +1,9 @@
+nbproject/*
+.rvmrc
+coverage/*
+rdoc/*
+pkg/*
+.DS_Store
+DTAUS0.TXT
+dta.txt
+Gemfile.lock

data/Gemfile

@@ -1,7 +1,2 @@
 source :rubygems
-
-gemspec
-
-group :test do
-  gem "rcov"
-end
+gemspec

data/README.markdown

@@ -10,7 +10,7 @@ therefore supported in common banking programs too.
 
 This gem saves you all the trouble when generating DTAUS- or DTAZV-text.
 
-We love building payment applications
+We love building payment applications.
 
 ## Install
 
@@ -18,25 +18,38 @@ We love building payment applications
 
 ## Features
 
-* Create DTAUS debit advice (Lastschrift)
-* Create DTAUS credit advice (Gutschrift)
-* Create DTAZV debit advice
-* High test coverage to ensure software quality
+* Create DTAUS debit transfer (Lastschrift)
+* Create DTAUS credit transfer (Gutschrift)
+* Create DTAZV debit transfer
+* 100% test coverage to ensure software quality
+* works with ruby 1.8 & 1.9.2
+
+## Version Info
+
+Version 2 has breaking changes!
+
+* account attributes now passed in as hash
+* renamed account.client_xy => owner_xy
+* renamed account.account_number => bank_account_number
+* added iban/bic to account
+* DTAZV added
+
+If you want to stay with v1 just pin it in your Gemfile:
+    
+    gem "king_dtaus", "<2"
 
 ## TODOs
 
-* first gem with no todo's - never seen it, huh? - just kidding
-* some more edge-case tests needed
+* some more edge-case tests needed, we need your feedback here!
 
 ## Resources
 
+* SalesKing: http://salesking.eu
 * DTAZV-Viewer: http://www.meta-evolutions.de/pages/artikel-20070630-dtazv-datei-betrachter.html
 * DTA/DTAZV PHP Pear: http://pear.php.net/package/Payment_DTA
-* Ruby Kernel Module: http://www.ruby-doc.org/core/classes/Kernel.html
 * Windata ZV-Tools: http://www.windata.de/Site/2Produkte2/ZVTools.aspx
 * The Swift Codes: http://www.theswiftcodes.com/
 * StarMoney: http://www.starmoney.de/index.php?id=starmoneybusiness_testen
-* SalesKing: http://salesking.eu
 
 ## Examples
 
@@ -48,14 +61,21 @@ Here are some examples how to create a DTA- or DTAZV-File. Also check out the sp
     dta = KingDta::Dtaus.new('LK')
   
     # set sender account
-    dta.account = KingDta::Account.new(:account_number => @kto1.account_number, :bank_number => @kto1.bank_number, :client_name => @kto1.client_name, :bank_name => @kto1.bank_name)
+    dta.account = KingDta::Account.new(
+                    :bank_account_number => "123456789",
+                    :bank_number => "69069096",
+                    :owner_name => "Return to Sender",
+                    :bank_name => "Money Burner Bank")
   
-    # the following should be done in a loop to add multiple bookings
+    # following should be done in a loop to add multiple bookings
     # create receiving account
-    rec_acnt = KingDta::Account.new(:account_number => @kto1.account_number, :bank_number => @kto1.bank_number, :client_name => @kto1.client_name, :bank_name => @kto1.bank_name)
-  
+    receiver = KingDta::Account.new(
+                    :bank_account_number => "987456123",
+                    :bank_number => "99099096",
+                    :owner_name => "Gimme More Lt.",
+                    :bank_name => "Banking Bandits")
     # create booking
-    booking = KingDta::Booking.new(rec_acnt, 100.00 )
+    booking = KingDta::Booking.new(receiver, 100.00 )
   
     # set booking text if you want to
     booking.text = "Thanks for your purchase"
@@ -69,48 +89,31 @@ Here are some examples how to create a DTA- or DTAZV-File. Also check out the sp
 
 ### DTAZV
 
-    @date = Date.today
-    @dudes_dtazv_export = KingDta::Dtazv.new(@date)
-    @dudes_konto = self.dudes_konto
-    @dalai_lamas_account = self.dalai_lamas_account
-    @dudes_dtazv_export.account = KingDta::Account.new(
-      :account_number =>      @dudes_konto.account_number,
-      :bank_number =>         @dudes_konto.bank_number,
-      :client_name =>         @dudes_konto.client_name,
-      :client_number =>       @dudes_konto.client_number,
-      :bank_street =>         @dudes_konto.account_street,
-      :bank_city =>           @dudes_konto.account_city,
-      :bank_zip_code =>       @dudes_konto.account_zip_code,
-      :bank_name =>           @dudes_konto.bank_name,
-      :client_street =>       @dudes_konto.client_street,
-      :client_city =>         @dudes_konto.client_city,
-      :client_zip_code =>     @dudes_konto.client_zip_code,
-      :bank_country_code =>   @dudes_konto.bank_country_code,
-      :client_country_code => @dudes_konto.client_country_code
+    @dtazv = KingDta::Dtazv.new()
+
+    # sender account
+    @dtazv.account = KingDta::Account.new(
+      :bank_account_number => "123456789",
+      :bank_number => "40050100",
+      :bank_name => "Greedy Fuckers Bank",
+      :owner_name => "Sender name"
+    )
+
+    # receiver account
+    receiver = KingDta::Account.new(
+      :bank_account_number => "987654321",
+      :bank_iban => "PLsome-long-Iban",
+      :bank_bic => "BicCode",
+      :owner_name => "receivers name"
     )
+    # add bookings, probably in a loop
+    booking = KingDta::Booking.new(receiver, 220.25)
+    @dtazv.add(booking)
+
+    # get output as string
+    @dtazv.create
 
-    @dalai_lamas_booking = KingDta::Booking.new(KingDta::Account.new(
-      :account_number =>      @dalai_lamas_account.account_number,
-      :bank_number =>         @dalai_lamas_account.bank_number,
-      :client_name =>         @dalai_lamas_account.client_name,
-      :client_number =>       @dalai_lamas_account.bank_name,
-      :bank_street =>         @dalai_lamas_account.account_street,
-      :bank_city =>           @dalai_lamas_account.account_city,
-      :bank_zip_code =>       @dalai_lamas_account.account_zip_code,
-      :bank_name =>           @dalai_lamas_account.bank_name,
-      :client_street =>       @dalai_lamas_account.client_street,
-      :client_city =>         @dalai_lamas_account.client_city,
-      :client_zip_code =>     @dalai_lamas_account.client_zip_code,
-      :bank_country_code =>   @dalai_lamas_account.bank_country_code,
-      :client_country_code => @dalai_lamas_account.client_country_code
-    ), 220.25)
-
-    @dudes_dtazv_export.add(@dalai_lamas_booking)
-    @dudes_dtazv_export.create_file
-
-    # Output is DTAZV0.TXT
-
-also make sure to read the specs
+also make sure to read the code and the specs
 
 ## Credits
 
@@ -120,9 +123,6 @@ Bugfixes and enhancements by
 * Kim Rudolph - https://github.com/krudolph
 * Thorsten Böttger - https://github.com/alto
 * Jan Kus - https://github.com/koos
+* used https://rubygems.org/gems/DTAUS as a starting point
 
-This gem used https://rubygems.org/gems/DTAUS as a starting point.
-It was disected, turned into a real class structure, bugs were fixed and
-of course a full test suite ensures its functionality.
-
-Copyright (c) 2009-2011 Georg Leciejewski (SalesKing), Jan Kus (Railslove), released under the MIT license
+Copyright (c) 2009-2011 Georg Leciejewski (SalesKing), Jan Kus (Railslove), released under the MIT license

data/Rakefile

@@ -1,31 +1,18 @@
 require 'rake'
+require 'rspec'
 require 'rspec/core/rake_task'
-
+require 'rdoc/task'
+require 'bundler/gem_helper'
+Bundler::GemHelper.install_tasks
 desc "Run specs"
 RSpec::Core::RakeTask.new
-
 task :default => :spec
 
-RSpec::Core::RakeTask.new(:coverage) do |t|
-  t.rcov = true
-  t.rcov_opts =  %q[--exclude "spec"]
-  t.verbose = true
-end
-
-Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "king_dtaus"
-    gem.summary = %Q{Generate DTAUS strings and files}
-    gem.description = %Q{DTAUS is a text-based format, to create bank transfers for german banks. This gem helps with the creation of those transfer files.}
-    gem.email = "gl@salesking.eu"
-    gem.homepage = "http://github.com/salesking/king_dtaus"
-    gem.authors = ["Georg Leciejewski", "Georg Ledermann", "Jan Kus"]
-    # 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"
+desc 'Generate documentation'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'docs/rdoc'
+  rdoc.title    = 'KingPdf'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/king_dtaus.gemspec

@@ -1,77 +1,34 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'king_dta/version'
 
 Gem::Specification.new do |s|
   s.name = %q{king_dtaus}
-  s.version = "2.0.2.pre"
+  s.version = KingDta::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Georg Leciejewski", "Georg Ledermann", "Jan Kus"]
-  s.date = %q{2011-09-02}
-  s.description = %q{DTAUS is a text-based format, to create bank transfers for german banks. This gem helps with the creation of those transfer files.}
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.authors = ['Georg Leciejewski', 'Georg Ledermann', 'Jan Kus']
+  s.date = %q{2011-11-15}
+  s.summary = %q{Generate DTA/DTAUS and DTAZV bank transfer files .. the easy way}
+  s.description = %q{DTA/DTAUS and DTAZV are text-based formats to create bank transfers for german banks.
+This gem creates DTA/DATAUS files for inner german credit and debit(Gutschrift/Lastschrift) transfers.
+It is also capable of creating DTAZV credit-files for transfers from Germany to European SEPA region.}
   s.email = %q{gl@salesking.eu}
-  s.extra_rdoc_files = [
-    "README.markdown"
-  ]
-  s.files = [
-    ".travis.yml",
-    "Gemfile",
-    "MIT-LICENSE",
-    "README.markdown",
-    "Rakefile",
-    "VERSION",
-    "docs/dtazv.pdf",
-    "docs/dtazv_bank_bbk.pdf",
-    "docs/example.output",
-    "king_dtaus.gemspec",
-    "lib/king_dta/account.rb",
-    "lib/king_dta/booking.rb",
-    "lib/king_dta/dta.rb",
-    "lib/king_dta/dtaus.rb",
-    "lib/king_dta/dtazv.rb",
-    "lib/king_dta/exception.rb",
-    "lib/king_dta/helper.rb",
-    "lib/king_dtaus.rb",
-    "spec/account_spec.rb",
-    "spec/booking_spec.rb",
-    "spec/dtaus_spec.rb",
-    "spec/dtazv_spec.rb",
-    "spec/dtazv_test.rb",
-    "spec/helper_spec.rb",
-    "spec/spec_helper.rb"
-  ]
+  s.extra_rdoc_files = ['README.markdown']
+  s.executables   = nil
+  s.files         = `git ls-files`.split("\n").reject{|i| i[/^docs\//] }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
   s.homepage = %q{http://github.com/salesking/king_dtaus}
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
   s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Generate DTAUS strings and files}
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.add_runtime_dependency 'i18n'
+  s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'rake', '>= 0.9.2'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<king_dtaus>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
-      s.add_development_dependency(%q<mocha>, [">= 0"])
-      s.add_development_dependency(%q<i18n>, [">= 0"])
-    else
-      s.add_dependency(%q<king_dtaus>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
-      s.add_dependency(%q<mocha>, [">= 0"])
-      s.add_dependency(%q<i18n>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<king_dtaus>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
-    s.add_dependency(%q<mocha>, [">= 0"])
-    s.add_dependency(%q<i18n>, [">= 0"])
-  end
 end
 

data/lib/king_dta/account.rb

@@ -1,50 +1,76 @@
 # encoding: utf-8
 module KingDta
-  # A bank account with name of the account owner,
-  # Kontodaten verwalten mit Name des Inhabers und Bank, Bankleitzahl und Kontonummer.
+  # Bank account and owner information
   class Account
     include KingDta::Helper
-    
-    attr_accessor :account_number, :bank_number, :bank_street, :bank_city,
-                  :bank_zip_code, :bank_name, :bank_country_code,
-                  :client_name, :client_number, :client_street, :client_city,
-                  :client_zip_code, :client_country_code
 
-    # TODO test
+    attr_accessor :bank_street, :bank_city,
+                  :bank_zip, :bank_name, :bank_country_code, :bank_iban,
+                  :bank_bic,
+                  :owner_name, :owner_number, :owner_street, :owner_city,
+                  :owner_zip_code, :owner_country_code
+    attr_reader :bank_account_number, :bank_number
+
     def initialize(args={})
 
       @bank_street = convert_text(args.delete(:bank_street))
       @bank_city = convert_text(args.delete(:bank_city))
       @bank_name = convert_text(args.delete(:bank_name))
-      @client_name = convert_text(args.delete(:client_name))
-      @client_street = convert_text(args.delete(:client_street))
-      @client_city = convert_text(args.delete(:client_city))
+      @owner_name = convert_text(args.delete(:owner_name))
+      @owner_street = convert_text(args.delete(:owner_street))
+      @owner_city = convert_text(args.delete(:owner_city))
 
       args.each do |key,value|
         self.send("#{key}=",value)
       end
 
-      raise ArgumentError.new('Account number too long, max 35 allowed') if @account_number && "#{@account_number}".length > 35
-      raise ArgumentError.new('Bank number too long, max 11 allowed') if @bank_number && "#{@bank_number}".length > 11
-      raise ArgumentError.new('Client number too long, max 10 allowed') if @client_number && "#{@client_number}".length > 10
-      raise ArgumentError.new("Bank account number cannot be 0")  if @account_number && @account_number == 0
-      raise ArgumentError.new("Bank number cannot be 0")   if @bank_number && @bank_number == 0
-      raise ArgumentError.new("Bank Street too long, max 35 allowed") if @bank_street && @bank_street.length > 35
-      raise ArgumentError.new("Bank City too long, max 35 allowed") if @bank_city && @bank_city.length > 35
-      raise ArgumentError.new("Bank Name too long, max 35 allowed") if @bank_name && @bank_name.length > 35
-      raise ArgumentError.new("Client Street too long, max 35 allowed") if @client_street && @client_street.length > 35
-      raise ArgumentError.new("Client City too long, max 35 allowed") if @client_city && @client_city.length > 35
-      raise ArgumentError.new("Bank Country code too long, max 2 allowed") if @bank_country_code && @bank_country_code.length > 2
-      raise ArgumentError.new("Client Country code too long, max 2 allowed") if @client_country_code && @client_country_code.length > 2
+      raise ArgumentError.new('Owner number too long, max 10 allowed') if @owner_number && "#{@owner_number}".length > 10
+      raise ArgumentError.new('Owner street too long, max 35 allowed') if @owner_street && @owner_street.length > 35
+      raise ArgumentError.new('Owner city too long, max 35 allowed') if @owner_city && @owner_city.length > 35
+      raise ArgumentError.new('Owner country code too long, max 2 allowed') if @owner_country_code && @owner_country_code.length > 2
+
+
+      raise ArgumentError.new("Bank iban wrong length: #{@bank_iban.length}, must be between 15-34") if @bank_iban && !@bank_iban.length.between?(15,34)
+      raise ArgumentError.new("Bank bic wrong length: #{@bank_bic.length} must be between 8-11") if @bank_bic && !@bank_bic.length.between?(8,11)
+
+      raise ArgumentError.new('Bank street too long, max 35 allowed') if @bank_street && @bank_street.length > 35
+      raise ArgumentError.new('Bank city too long, max 35 allowed') if @bank_city && @bank_city.length > 35
+      raise ArgumentError.new('Bank name too long, max 35 allowed') if @bank_name && @bank_name.length > 35
+      raise ArgumentError.new('Bank country code too long, max 2 allowed') if @bank_country_code && @bank_country_code.length > 2
+
+      @owner_country_code = @bank_iban[0..1 ] if @bank_iban && !@owner_country_code
+    end
+
+    # Cast given account number to integer. Strips spaces and leading zeros
+    # from the bank account number.
+    # DTA relies on integers for checksums and field values.
+    # @param [String|Integer] number
+    def bank_account_number=(number)
+      nr_str = "#{number}".gsub(/\s/,'')
+      raise ArgumentError.new('Bank account number too long, max 10 allowed') if nr_str.length > 10
+      raise ArgumentError.new('Bank account number cannot be 0') if nr_str == '0'
+
+      @bank_account_number = nr_str.to_i
+    end
+
+    # Cast given bank number to integer. Strips spaces and leading zeros
+    # from the bank account number.
+    # DTA relies on integers for checksums and field values.
+    # @param [String|Integer] number
+    def bank_number=(number)
+      nr_str = "#{number}".gsub(/\s/,'')
+      raise ArgumentError.new('Bank number too long, max 8 allowed') if nr_str.length > 8
+      raise ArgumentError.new('Bank number cannot be 0') if nr_str == '0'
 
+      @bank_number = nr_str.to_i
     end
 
-    def zip_city
-      "#{@bank_zip_code} #{@bank_city}"
+    def bank_zip_city
+      "#{@bank_zip} #{@bank_city}"
     end
 
-    def client_zip_city
-      "#{@client_zip_code} #{@client_city}"
+    def owner_zip_city
+      "#{@owner_zip_code} #{@owner_city}"
     end
 
   end

data/lib/king_dta/dta.rb

@@ -4,6 +4,16 @@ module KingDta
     include KingDta::Helper
     attr_reader :default_text
 
+    # Create a new dta string.
+    # === Parameter    # 
+    # typ<Date>:: date when the the transfer is to be created
+    def initialize(date=Date.today )
+      raise ArgumentError.new("Wrong date format. Make it a Time or Date object with yyyy-mm-dd") unless date.respond_to?(:strftime)
+      @date         = date
+      @value_pos    = true  #values are positive by default changed by first booking
+      @closed       = false
+      @default_text = ''
+    end
     #  Set the sending account(you own)
     # === Parameter
     # account<Account>:: the sending account, must be an instance of class