clieop 0.1.1 → 0.1.3

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2009 Willem van Bergen
+Copyright (c) 2008-2010 Willem van Bergen & Leon Berenschot
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -20,7 +20,7 @@ http://www.ingbank.nl/ing/downloadables/eclieop1.pdf
 
 == Usage
 
-Run <tt>gem install clieop -s http://gemcutter.org</tt> to install the gem.
+Run <tt>gem install clieop</tt> to install the gem.
 
 See the project's wiki at http://wiki.github.com/wvanbergen/clieop for an example
 creating and writing a direct debt batch file.

data/clieop.gemspec

@@ -3,8 +3,8 @@ Gem::Specification.new do |s|
 
   # Do not set version and date yourself, this will be done automatically
   # by the gem release script.
-  s.version = "0.1.1"
-  s.date    = "2009-10-10"
+  s.version = "0.1.3"
+  s.date    = "2010-06-02"
 
   s.summary     = "A pure Ruby implementation to write CLIEOP files"
   s.description = "This library is a pure Ruby, MIT licensed implementation of the CLIEOP03 transaction format. CLIEOP03 can be used to communicate direct debt transactions with your (Dutch) bank."
@@ -15,6 +15,6 @@ Gem::Specification.new do |s|
 
   # Do not set files and test_files yourself, this will be done automatically
   # by the gem release script.
-  s.files      = %w(.gitignore lib/clieop/record.rb lib/clieop/file.rb lib/clieop/batch.rb lib/clieop.rb Rakefile MIT-LICENSE test/clieop_writer_test.rb tasks/github-gem.rake clieop.gemspec README.rdoc)
-  s.test_files = %w(test/clieop_writer_test.rb)
+  s.files      = %w(spec/spec_helper.rb spec/clieop/batch_spec.rb .gitignore lib/clieop/record.rb MIT-LICENSE doc/clieop03.pdf lib/clieop/file.rb lib/clieop/batch.rb lib/clieop.rb init.rb Rakefile clieop.gemspec README.rdoc tasks/github-gem.rake spec/clieop_spec.rb spec/clieop/record_spec.rb)
+  s.test_files = %w(spec/clieop/batch_spec.rb spec/clieop_spec.rb spec/clieop/record_spec.rb)
 end

data/init.rb

@@ -0,0 +1 @@
+require 'clieop'

data/lib/clieop/batch.rb

@@ -48,17 +48,17 @@ module Clieop
       # add transactions to batch
       @transactions.each do |tr|
 
-        # update checksums
-        total_account += tr[:account_nr].to_i
-        total_amount  += (tr[:amount].to_f * 100).truncate
-
         # prepare data for this transaction's records
-        transaction_type = @batch_info[:transaction_group] == 10 ? 1002 : 0
+        transaction_type = tr[:transaction_type] || (@batch_info[:transaction_group] == 10 ? 1002 : 0)
         to_account       = @batch_info[:transaction_group] == 10 ? @batch_info[:account_nr] : tr[:account_nr]
         from_account     = @batch_info[:transaction_group] == 10 ? tr[:account_nr] : @batch_info[:account_nr]
-        amount_in_cents  = (tr[:amount].to_f * 100).truncate
+        amount_in_cents  = (tr[:amount] * 100).round.to_i
         name_record      = @batch_info[:transaction_group] == 10 ? :invoice_name : :payment_name
 
+        # update checksums
+        total_account += tr[:account_nr].to_i
+        total_amount  += amount_in_cents
+
         # generate transaction record
         batch_data << Clieop::Record.new(:transaction_info,
                           :transaction_type => transaction_type, :amount       => amount_in_cents,
@@ -70,15 +70,15 @@ module Clieop
 
         # split discription into lines and make a record for the first 4 lines
         unless tr[:description].nil? || tr[:description] == ''
-          tr[:description].split(/\r?\n/)[0, 4].each do |line|
+          tr[:description].split(/\r?\n/)[0, 4].each do |line| # FIXME raise warning when line is longer than 32 chars/description longer than 4 lines
             batch_data << Clieop::Record.new(:transaction_description, :description => line.strip).to_s unless line == ''
           end
         end
       end
 
       # generate batch footer record including some checks
-      batch_data << Clieop::Record.new(:batch_footer, :tranasction_count => @transactions.length,
-                        :total_amount => total_amount, :account_checksum => total_account.to_s[0..10]).to_clieop
+      batch_data << Clieop::Record.new(:batch_footer, :transaction_count => @transactions.length,
+                        :total_amount => total_amount, :account_checksum => account_checksum(total_account)).to_clieop
 
     end
 
@@ -98,5 +98,11 @@ module Clieop
       Clieop::Batch.new(batch_info)
     end
 
+    # the checksum on the total of accounts is in fact the last 10 chars of total amount
+    def account_checksum(total)
+      total.to_s.split('').last(10).join('') # ruby 1.8.6
+      # total.to_s.chars.last(10).join('')     # ruby 1.8.7
+    end
+
   end
 end

data/lib/clieop/record.rb

@@ -8,9 +8,9 @@ module Clieop
             [:record_variant, :alpha, 1, 'A'],
             [:date, :numeric, 6],
             [:filename, :alpha, 8, 'CLIEOP03'],
-      			[:sender_identification, :alpha, 5],
-      			[:file_identification, :alpha, 4],
-      			[:duplicate_code, :numeric, 1, 1]
+            [:sender_identification, :alpha, 5],
+            [:file_identification, :alpha, 4],
+            [:duplicate_code, :numeric, 1, 1]
           ],
         :file_footer => [
             [:record_code, :numeric, 4, 9999],
@@ -29,7 +29,7 @@ module Clieop
             [:record_variant, :alpha, 1, 'A'],
             [:total_amount, :numeric, 18],
             [:account_checksum, :numeric, 10],
-            [:tranasction_count, :numeric, 7],
+            [:transaction_count, :numeric, 7],
           ],
         :batch_description => [
             [:record_code, :numeric, 4, 20],
@@ -47,7 +47,7 @@ module Clieop
         :transaction_info => [
             [:record_code, :numeric, 4, 100],
             [:record_variant, :alpha, 1, 'A'],
-            [:transaction_type, :numeric, 4, 1002],
+            [:transaction_type, :alpha, 4, "1002"],
             [:amount, :numeric, 12],
             [:from_account, :numeric, 10],
             [:to_account, :numeric, 10],
@@ -65,14 +65,14 @@ module Clieop
         :transaction_reference => [
             [:record_code, :numeric, 4, 150],
             [:record_variant, :alpha, 1, 'A'],
-            [:reference_number, :numeric, 16],
+            [:reference_number, :alpha, 16],
           ],
         :transaction_description => [
             [:record_code, :numeric, 4, 160],
             [:record_variant, :alpha, 1, 'A'],
             [:description, :alpha, 32],
           ],
-      }
+    }
 
     attr_accessor :definition, :data
 
@@ -95,10 +95,10 @@ module Clieop
       #format each field
       @definition.each do |field|
         fmt = '%'
-  			fmt << (field[1] == :numeric ? '0' : '-')
-  			fmt << (field[2].to_s)
-  			fmt << (field[1] == :numeric ? 'd' : 's')
-  			raw_data = (field[1] == :numeric) ? @data[field[0]].to_i : @data[field[0]]
+        fmt << (field[1] == :numeric ? '0' : '-')
+        fmt << (field[2].to_s)
+        fmt << (field[1] == :numeric ? 'd' : 's')
+        raw_data = (field[1] == :numeric) ? @data[field[0]].to_i : @data[field[0]]
         value = sprintf(fmt, raw_data)
         line << (field[1] == :numeric ? value[0 - field[2], field[2]] : value[0, field[2]])
       end

data/lib/clieop.rb

@@ -1,4 +1,9 @@
 require 'date'
+
+module Clieop
+  VERSION = "0.1.3"
+end
+
 require 'clieop/record.rb'
 require 'clieop/file.rb'
 require 'clieop/batch.rb'

data/spec/clieop/batch_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Clieop::Batch do
+
+  before(:all) do
+    @batch_info = {
+      :description => "Batch" , 
+      :account_nr  => 123456789, 
+      :account_owner => "Reciever"
+    }
+  end
+
+  it "should generate valid object" do
+    Clieop::Batch.new(@batch_info.dup).class.should eql(Clieop::Batch)
+  end
+
+  it "should generate a invoice batch" do
+    batch = Clieop::Batch.invoice_batch(@batch_info.dup)
+    batch.class.should eql(Clieop::Batch)
+    batch.batch_info[:transaction_group].should eql(10)
+  end
+
+  it "should generate a payment batch" do
+    batch = Clieop::Batch.payment_batch(@batch_info.dup)
+    batch.class.should eql(Clieop::Batch)
+    batch.batch_info[:transaction_group].should eql(0)
+  end
+
+  it "should add transactions to batch" do
+    batch = Clieop::Batch.invoice_batch(@batch_info.dup)
+    batch << {
+      :reference_number => "Factnr 100101",
+      :account_nr       => 123456789,
+      :account_owner    => 'Payee',
+      :amount           => 30102,
+      :description      => "Testing a CLIEOP direct debt transaction\nCharging your bank account",
+      :transaction_type => 1001
+    }
+    batch.batch_info[:transaction_group].should eql(10)
+    batch.to_clieop.should  match(/0010B1001234567890001EUR                          /)
+    batch.to_clieop.should  match(/0020ABatch                                        /)
+    batch.to_clieop.should  match(/0030B1000000Reciever                           P  /)
+    batch.to_clieop.should  match(/0100A100100000301020001234567890123456789         /)
+    batch.to_clieop.should  match(/0110BPayee                                        /)
+    batch.to_clieop.should  match(/0150AFactnr 100101                                /)
+    batch.to_clieop.should  match(/0160ATesting a CLIEOP direct debt tra             /)
+    batch.to_clieop.should  match(/0160ACharging your bank account                   /)
+    batch.to_clieop.should  match(/9990A00000000000301020002469135780000001          /)
+  end
+
+end

data/spec/clieop/record_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Clieop::Record do
+
+  before(:all) do
+  end
+
+  it "should generate :file_header" do
+    record = Clieop::Record.new(:file_header, :date => '050410')
+    record.to_clieop.should match(/0001A050410CLIEOP03         1                     /)
+  end
+
+  it "should generate :file_footer" do
+    record = Clieop::Record.new(:file_footer)
+    record.to_clieop.should match(/9999A                                             /)
+  end
+
+  it "should generate :batch_header" do
+    record = Clieop::Record.new(:batch_header,
+      :transaction_group => 10,
+      :acount_nr         => 1234567890,
+      :serial_nr         => 1
+    )
+    record.to_clieop.should match(/0010B1012345678900001EUR                          /)
+  end
+
+  # TODO Also do calculations
+  it "should generate :batch_footer" do
+    record = Clieop::Record.new(:batch_footer,
+      :total_amount      => 0,
+      :account_checksum  => 1234567890,
+      :tranasction_count => 0
+    )
+    record.to_clieop.should match(/9990A00000000000000000012345678900000000          /)
+  end
+
+  it "should generate :batch_description" do
+    record = Clieop::Record.new(:batch_description,
+      :description      => 'Testing a CLIEOP direct debt transaction\nCharging your bank account'
+    )
+    record.to_clieop.should match(/0020ATesting a CLIEOP direct debt tra             /)
+  end
+
+  it "should generate :batch_owner" do
+    record = Clieop::Record.new(:batch_owner,
+      :owner => 'Reciever'
+    )
+    record.to_clieop.should match(/0030B1000000Reciever                           P  /)
+  end
+
+  it "should generate :transaction_info" do
+    record = Clieop::Record.new(:transaction_info,
+      :amount       => 'Reciever',
+      :from_account => 1234567890,
+      :to_account   => 1234567890
+    )
+    record.to_clieop.should match(/0100A100200000000000012345678901234567890         /)
+  end
+
+  it "should generate :invoice_name" do
+    record = Clieop::Record.new(:invoice_name,
+      :name => 'Payee'
+    )
+    record.to_clieop.should match(/0110BPayee                                        /)
+  end
+
+  it "should generate :payment_name" do
+    record = Clieop::Record.new(:payment_name,
+      :name => 'Reciever'
+    )
+    record.to_clieop.should match(/0170BReciever                                     /)
+  end
+
+  it "should generate :transaction_reference" do
+    record = Clieop::Record.new(:transaction_reference,
+      :reference_number => '201000505'
+    )
+    record.to_clieop.should match(/0150A201000505                                    /)
+  end
+
+  it "should generate :transaction_description" do
+    record = Clieop::Record.new(:transaction_description,
+      :description => 'Automatic Invoice Transaction'
+    )
+    record.to_clieop.should match(/0160AAutomatic Invoice Transaction                /)
+  end
+
+end

data/{test/clieop_writer_test.rb → spec/clieop_spec.rb}

@@ -1,22 +1,16 @@
-$:.unshift("#{File.dirname(__FILE__)}/../lib")
+require 'spec_helper'
 
-require 'test/unit'
-require 'clieop'
+describe Clieop do
 
-class ClieopWriterTest < Test::Unit::TestCase
+  it "should test basic invoice usage" do
 
-  def setup
-  end
-
-  def teardown
-  end
-
-  def test_basic_invoice_usage
     file = Clieop::File.new
+
     file.invoice_batch({:description => 'some description', :account_nr => 123, :account_owner => 'me'}) do |batch|
 
       batch << { :account_nr => 123456, :account_owner => 'you', :amount => 133.0,
-                 :description => "Testing a CLIEOP direct debt transaction\nCharging your bank account" }
+                 :description => "Testing a CLIEOP direct debt transaction\nCharging your bank account" 
+               }
 
       batch << { :account_nr => 654321, :account_owner => 'somebody else', :amount => 233.0,
                  :description => 'Some description for the other guy' }
@@ -25,9 +19,16 @@ class ClieopWriterTest < Test::Unit::TestCase
 
     clieop_data = file.to_clieop
 
-    #TODO: more tests
-    assert_kind_of String, clieop_data
+    clieop_data.class.should  eql(String)
+
+  end
 
+  it "should format the checksum" do
+    batch = Clieop::Batch.new({:description => "Description", :account_nr => "Account Nr", :account_owner => "Account Owner" } )
+    batch.account_checksum('1234567890123').should  eql('4567890123')
+    batch.account_checksum('7654321').should  eql('7654321')
   end
 
+  #TODO: more tests
+
 end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'spec/autorun'
+require 'clieop'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f }
+
+Spec::Runner.configure do |config|
+  
+end
+

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: clieop
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Willem van Bergen
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-10 00:00:00 +02:00
+date: 2010-06-02 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -23,17 +29,22 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- spec/spec_helper.rb
+- spec/clieop/batch_spec.rb
 - .gitignore
 - lib/clieop/record.rb
+- MIT-LICENSE
+- doc/clieop03.pdf
 - lib/clieop/file.rb
 - lib/clieop/batch.rb
 - lib/clieop.rb
+- init.rb
 - Rakefile
-- MIT-LICENSE
-- test/clieop_writer_test.rb
-- tasks/github-gem.rake
 - clieop.gemspec
 - README.rdoc
+- tasks/github-gem.rake
+- spec/clieop_spec.rb
+- spec/clieop/record_spec.rb
 has_rdoc: true
 homepage: http://github.com/wvanbergen/clieop/wikis
 licenses: []
@@ -44,23 +55,31 @@ 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"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A pure Ruby implementation to write CLIEOP files
 test_files: 
-- test/clieop_writer_test.rb
+- spec/clieop/batch_spec.rb
+- spec/clieop_spec.rb
+- spec/clieop/record_spec.rb