clieop 0.2.2 → 1.0.0

data/lib/clieop.rb

@@ -1,9 +1,18 @@
 require 'date'
 
 module Clieop
-  VERSION = "0.2.2"
+  VERSION = "1.0.0"
 end
 
-require 'clieop/record'
-require 'clieop/file'
-require 'clieop/batch'
+unless defined?(ActiveSupport)
+  require 'core_ext/string'
+  require 'core_ext/hash'
+end
+
+require 'clieop/payment/record'
+require 'clieop/payment/file'
+require 'clieop/payment/batch'
+require 'clieop/process_info/record'
+require 'clieop/process_info/file'
+require 'clieop/process_info/batch'
+require 'clieop/process_info/transaction'

data/lib/core_ext/hash.rb

@@ -0,0 +1,13 @@
+class Hash
+  # Return a hash that includes everything but the given keys. This is useful for
+  # limiting a set of parameters to everything but a few known toggles:
+  def except(*keys)
+    dup.except!(*keys)
+  end
+
+  # Replaces the hash without the given keys.
+  def except!(*keys)
+    keys.each { |key| delete(key) }
+    self
+  end
+end

data/lib/core_ext/string.rb

@@ -0,0 +1,19 @@
+class String
+  # 0x3000: fullwidth whitespace
+  NON_WHITESPACE_REGEXP = %r![^\s#{[0x3000].pack("U")}]!
+
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   "".blank?                 # => true
+  #   "   ".blank?              # => true
+  #   "　".blank?               # => true
+  #   " something here ".blank? # => false
+  #
+  def blank?
+    self !~ NON_WHITESPACE_REGEXP
+  end
+  
+  def present?
+    !blank?
+  end  
+end

data/spec/clieop/{batch_spec.rb → payment/batch_spec.rb}

@@ -1,28 +1,35 @@
 require 'spec_helper'
 
-describe Clieop::Batch do
+describe Clieop::Payment::Batch do
 
   before(:all) do
-    @batch_info = {
-      :description   => "Batch",
+    @batch_info_without_description = {
       :account_nr    => 123456789,
       :account_owner => "Reciever"
     }
+    
+    @batch_info = @batch_info_without_description.merge :description => 'Batch'
   end
 
   it "should generate valid object" do
-    Clieop::Batch.new(@batch_info.dup).class.should eql(Clieop::Batch)
+    Clieop::Payment::Batch.new(@batch_info.dup).class.should eql(Clieop::Payment::Batch)
   end
 
   it "should generate a invoice batch" do
-    batch = Clieop::Batch.invoice_batch(@batch_info.dup)
-    batch.class.should eql(Clieop::Batch)
+    batch = Clieop::Payment::Batch.invoice_batch(@batch_info.dup)
+    batch.class.should eql(Clieop::Payment::Batch)
     batch.batch_info[:transaction_group].should eql(10)
   end
 
+  it 'should allow omitting a description' do
+    expect {
+      Clieop::Payment::Batch.invoice_batch(@batch_info_without_description)
+    }.to_not raise_error
+  end
+
   it "should generate a payment batch" do
-    batch = Clieop::Batch.payment_batch(@batch_info.dup)
-    batch.class.should eql(Clieop::Batch)
+    batch = Clieop::Payment::Batch.payment_batch(@batch_info.dup)
+    batch.class.should eql(Clieop::Payment::Batch)
     batch.batch_info[:transaction_group].should eql(0)
   end
 
@@ -31,15 +38,17 @@ describe Clieop::Batch do
     describe "Invoice" do
 
       before do
-        @batch = Clieop::Batch.invoice_batch(@batch_info.dup)
-        @batch << {
+        @batch = Clieop::Payment::Batch.invoice_batch(@batch_info.dup)
+        @transaction = {
           :reference_number => "Factnr 100101",
           :account_nr       => 123456789,
           :account_owner    => 'Payee',
+          :account_city     => 'Enschede',          
           :amount           => 30102,
           :description      => "Testing a CLIEOP direct debt transaction\nCharging your bank account",
           :transaction_type => 1001
         }
+        @batch << @transaction
       end
 
       it "should add transactions to batch" do
@@ -49,12 +58,28 @@ describe Clieop::Batch do
         @batch.to_clieop.should  match(/0030B1000000Reciever                           P  /)
         @batch.to_clieop.should  match(/0100A100100000301020001234567890123456789         /)
         @batch.to_clieop.should  match(/0110BPayee                                        /)
+        @batch.to_clieop.should  match(/0113BEnschede                                     /)        
         @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
 
+      it 'should omit 0020 record when there is no description' do
+        batch = Clieop::Payment::Batch.invoice_batch(@batch_info_without_description)
+        batch << @transaction
+        batch.to_clieop.should_not match(/^0020/)
+      end
+      
+      it 'should allow multiline 0020 batch descriptions' do        
+        batch = Clieop::Payment::Batch.invoice_batch(@batch_info.merge(:description => "Test\nbatch\nfor\nmultiline\ndescriptions"))
+        batch.to_clieop.should      match(/0020ATest                                         /)
+        batch.to_clieop.should      match(/0020Abatch                                        /)
+        batch.to_clieop.should      match(/0020Afor                                          /)
+        batch.to_clieop.should      match(/0020Amultiline                                    /)
+        batch.to_clieop.should_not  match(/0020Adescriptions                                 /) # Max 4 lines   
+      end        
+
       it "should appear in proper order" do
         last_record_code = 0
         @batch.to_clieop.split("\n").each do |line|
@@ -69,15 +94,17 @@ describe Clieop::Batch do
     describe "Payment" do
 
       before do
-        @batch = Clieop::Batch.payment_batch(@batch_info.dup)
-        @batch << {
+        @batch = Clieop::Payment::Batch.payment_batch(@batch_info.dup)
+        @transaction = {
           :reference_number => "Factnr 100101",
           :account_nr       => 123456789,
           :account_owner    => 'Payee',
+          :account_city     => 'Enschede',     
           :amount           => 30102,
           :description      => "Testing a CLIEOP direct credit transaction\nPaying your bank account",
           :transaction_type => 1001
         }
+        @batch << @transaction
       end
 
       it "should add transactions to batch" do
@@ -90,9 +117,25 @@ describe Clieop::Batch do
         @batch.to_clieop.should  match(/0160ATesting a CLIEOP direct credit t             /)
         @batch.to_clieop.should  match(/0160APaying your bank account                     /)
         @batch.to_clieop.should  match(/0170BPayee                                        /)
+        @batch.to_clieop.should  match(/0173BEnschede                                     /)          
         @batch.to_clieop.should  match(/9990A00000000000301020002469135780000001          /)
       end
 
+      it 'should omit the 0020 batch description record when there is no description' do
+        batch = Clieop::Payment::Batch.payment_batch(@batch_info_without_description)
+        batch << @transaction
+        batch.to_clieop.should_not match(/^0020/)
+      end
+      
+      it 'should allow multiline 0020 batch descriptions' do        
+        batch = Clieop::Payment::Batch.payment_batch(@batch_info.merge(:description => "Test\nbatch\nfor\nmultiline\ndescriptions"))
+        batch.to_clieop.should      match(/0020ATest                                         /)
+        batch.to_clieop.should      match(/0020Abatch                                        /)
+        batch.to_clieop.should      match(/0020Afor                                          /)
+        batch.to_clieop.should      match(/0020Amultiline                                    /)
+        batch.to_clieop.should_not  match(/0020Adescriptions                                 /) # Max 4 lines   
+      end      
+
       it "should appear in proper order" do
         last_record_code = 0
         @batch.to_clieop.split("\n").each do |line|

data/spec/clieop/{file_spec.rb → payment/file_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Clieop::File do
+describe Clieop::Payment::File do
 
   context "#save" do
 

data/spec/clieop/{record_spec.rb → payment/record_spec.rb}

@@ -1,22 +1,22 @@
 require 'spec_helper'
 
-describe Clieop::Record do
+describe Clieop::Payment::Record do
 
   before(:all) do
   end
 
   it "should generate :file_header" do
-    record = Clieop::Record.new(:file_header, :date => '050410')
+    record = Clieop::Payment::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 = Clieop::Payment::Record.new(:file_footer)
     record.to_clieop.should match(/9999A                                             /)
   end
 
   it "should generate :batch_header for direct debit" do
-    record = Clieop::Record.new(:batch_header,
+    record = Clieop::Payment::Record.new(:batch_header,
       :transaction_group => 10,
       :acount_nr         => 1234567890,
       :serial_nr         => 1
@@ -25,7 +25,7 @@ describe Clieop::Record do
   end
 
   it "should generate :batch_header for payment" do
-    record = Clieop::Record.new(:batch_header,
+    record = Clieop::Payment::Record.new(:batch_header,
       :transaction_group => 0,
       :acount_nr         => 1234567890,
       :serial_nr         => 1
@@ -35,7 +35,7 @@ describe Clieop::Record do
 
   # TODO Also do calculations
   it "should generate :batch_footer" do
-    record = Clieop::Record.new(:batch_footer,
+    record = Clieop::Payment::Record.new(:batch_footer,
       :total_amount      => 0,
       :account_checksum  => 1234567890,
       :tranasction_count => 0
@@ -44,21 +44,21 @@ describe Clieop::Record do
   end
 
   it "should generate :batch_description" do
-    record = Clieop::Record.new(:batch_description,
+    record = Clieop::Payment::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,
+    record = Clieop::Payment::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,
+    record = Clieop::Payment::Record.new(:transaction_info,
       :amount       => 'Reciever',
       :from_account => 1234567890,
       :to_account   => 1234567890
@@ -67,28 +67,42 @@ describe Clieop::Record do
   end
 
   it "should generate :invoice_name" do
-    record = Clieop::Record.new(:invoice_name,
+    record = Clieop::Payment::Record.new(:invoice_name,
       :name => 'Payee'
     )
     record.to_clieop.should match(/0110BPayee                                        /)
   end
+  
+  it "should generate :invoice_city" do
+    record = Clieop::Payment::Record.new(:invoice_city,
+      :city => 'Enschede'
+    )
+    record.to_clieop.should match(/0113BEnschede                                     /)
+  end   
 
   it "should generate :payment_name" do
-    record = Clieop::Record.new(:payment_name,
+    record = Clieop::Payment::Record.new(:payment_name,
       :name => 'Reciever'
     )
     record.to_clieop.should match(/0170BReciever                                     /)
   end
+  
+  it "should generate :payment_city" do
+    record = Clieop::Payment::Record.new(:payment_city,
+      :city => 'Enschede'
+    )
+    record.to_clieop.should match(/0173BEnschede                                     /)
+  end  
 
   it "should generate :transaction_reference" do
-    record = Clieop::Record.new(:transaction_reference,
+    record = Clieop::Payment::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,
+    record = Clieop::Payment::Record.new(:transaction_description,
       :description => 'Automatic Invoice Transaction'
     )
     record.to_clieop.should match(/0160AAutomatic Invoice Transaction                /)

data/spec/clieop/process_info/batch_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Clieop::ProcessInfo::Batch do
+
+  before :all do
+    @info_file = Clieop::ProcessInfo::File.from_file(File.open(File.join(File.dirname(__FILE__), '../../files/VERWINFO.txt')), true)    
+  end
+  
+  subject { @info_file.batches.first }
+  
+  it "should add batch info to batches" do
+    subject.info.should == {:account_nr=>123456789, :total_amount=>nil, :transaction_count=>9, :test_code=>"T", :batch_type=>"A", :period_type=>nil, :period_length=>nil, :period_nr=>nil, :currency=>"EUR", :batch_identifier=>nil, :total_rejected=>9, :total_reversed=>0}
+  end
+  
+  it "should have several transactions" do
+    subject.transactions.should have(9).things
+  end
+  
+  it "should add records to the current transaction info" do
+    info_keys = subject.transactions.first.info.keys
+    [:euro_record, :reverse_info, :reject_info, :transaction_descriptions, :settle_info].each do |record_type|
+      info_keys.should include record_type
+    end
+  end
+
+end

data/spec/clieop/process_info/file_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Clieop::ProcessInfo::File do
+
+  before :each do
+    @verwinfo_file = File.open(File.join(File.dirname(__FILE__), '../../files/VERWINFO.txt'))
+  end
+
+  subject { Clieop::ProcessInfo::File.from_file(@verwinfo_file, true) }  
+
+  it "should accept a VERWINFO file" do
+    subject.records.should_not be_empty
+  end
+  
+  it "should accept a VERWINFO string" do
+    Clieop::ProcessInfo::File.from_string(@verwinfo_file.read).records.should_not be_empty
+  end
+  
+  it "should parse file info" do
+    subject.info.should == {:filename=>"VERWINFO", :file_version=>"4.1", :date=> Time.parse('101015').send(:to_date), :run_number=>4432, :account_nr=>123456789, :serial_nr=>2, :file_nr=>1, :batches_count=>1, :next_file_nr=>0 }
+  end
+  
+  it "should parse records" do
+    subject.records.should have(96).things # 96 lines + 1 EOS char
+  end
+  
+  it "should parse batches" do
+    subject.batches.should have(2).things
+  end
+  
+  it "should throw an error when no data can be parsed" do
+    lambda { Clieop::ProcessInfo::File.from_string('invalid data') }.should raise_error(RuntimeError, 'No valid records found in VERWINFO data')
+  end  
+
+end

data/spec/clieop/process_info/record_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Clieop::ProcessInfo::Record do
+
+  subject { Clieop::ProcessInfo::Record.new('1000000000000000012307149201234567890123456789') }  
+
+  it "should generate a hash of record codes to types" do
+    Clieop::ProcessInfo::Record::TYPE_FOR_RECORD_CODE.keys.should =~ [10, 990, 50, 51, 950, 100, 101, 105, 110, 115, 500, 503, 505, 510, 515, 600]
+  end
+  
+  it "should parse alpha values" do
+    Clieop::ProcessInfo::Record.parse_alpha_value('test').should == 'test'    
+    Clieop::ProcessInfo::Record.parse_alpha_value('   test   ').should == 'test'
+  end
+  
+  it "should parse numeric values" do
+    Clieop::ProcessInfo::Record.parse_numeric_value('000100').should == 100
+  end
+
+  it "should parse date values" do
+    Clieop::ProcessInfo::Record.parse_date_value('120304').should == Time.parse('120304').send(:to_date)
+  end
+  
+  it "should properly parse the record line and set record attributes" do
+    subject.raw_line.should == '1000000000000000012307149201234567890123456789'
+    subject.type.should == :transaction_info
+    subject.definition.should == Clieop::ProcessInfo::Record::TYPE_DEFINITIONS[:transaction_info]
+    subject.data == {:record_code=>100, :amount=>0, :from_account=>123071492, :to_account=>123456789, :entry_account=>123456789, :from_account_verification_nr=>0, :transaction_reference_ok=>nil}
+  end
+  
+
+end

data/spec/clieop/process_info/transaction_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Clieop::ProcessInfo::Transaction do
+
+  before :all do
+    @info_file = Clieop::ProcessInfo::File.from_file(File.open(File.join(File.dirname(__FILE__), '../../files/VERWINFO.txt')), true)    
+  end
+  
+  subject { @info_file.batches.first.transactions.first }
+  
+  it "should have transaction info" do
+    subject.info.except(:euro_record, :reverse_info, :reject_info, :transaction_descriptions, :settle_info).should == { :amount => BigDecimal('0.0'), :from_account=>123071492, :to_account=>123456789, :entry_account=>123456789, :from_account_verification_nr=>nil, :transaction_reference_ok=>nil }
+  end
+  
+  it "should contain transaction info records" do
+    info_keys = subject.info.keys
+    [:euro_record, :reverse_info, :reject_info, :transaction_descriptions, :settle_info].each do |record_type|
+      info_keys.should include record_type
+    end
+  end
+
+end

data/spec/clieop_spec.rb

@@ -4,7 +4,7 @@ describe Clieop do
 
   it "should test basic invoice usage" do
 
-    file = Clieop::File.new
+    file = Clieop::Payment::File.new
 
     file.invoice_batch({:description => 'some description', :account_nr => 123, :account_owner => 'me'}) do |batch|
 
@@ -24,7 +24,7 @@ describe Clieop do
   end
 
   it "should format the checksum" do
-    batch = Clieop::Batch.new({:description => "Description", :account_nr => "Account Nr", :account_owner => "Account Owner" } )
+    batch = Clieop::Payment::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

data/spec/files/VERWINFO.txt

@@ -0,0 +1,97 @@
+010VERWINFOA4.110101544320123456789000201         
+0500123456789   0000000000000270000000025TA       
+051EUR                                            
+1000000000000000012307149201234567890123456789    
+101EUR00000000000000000000000000                  
+105CI:81:40        0007002885114827698            
+110INCASSO TEST COMPANY                       
+110AUTO INCASSO ABONNEMENT                        
+110T.B.V. ABONNEMENT ADVIES ABONNEM               
+50001                    4432101015               
+6001021BEDRAG NUL NIET TOEGESTAAN                 
+1000000000000000012339666401234567890123456789    
+101EUR00000000000000000000000000                  
+105CI:80:44        0007002885114827701            
+110INCASSO TEST COMPANY                       
+110AUTO INCASSO ABONNEMENT                        
+110T.B.V. ABONNEMENT BEST-OFF  ABON               
+50001                    4432101015               
+6001021BEDRAG NUL NIET TOEGESTAAN                 
+1000000000000000012307149201234567890123456789    
+101EUR00000000000000000000000000                  
+105CI:81:45        0007002885114827719            
+110INCASSO TEST COMPANY                       
+110AUTO INCASSO ABONNEMENT                        
+110T.B.V. ABONNEMENT ADVIES ABONNEM               
+50001                    4432101015               
+6001021BEDRAG NUL NIET TOEGESTAAN                 
+1000000000000000012339666401234567890123456789    
+101EUR00000000000000000000000000                  
+105CI:80:51        0007002885114827727            
+110INCASSO TEST COMPANY                       
+110AUTO INCASSO ABONNEMENT                        
+110T.B.V. ABONNEMENT BEST-OFF  ABON               
+50001                    4432101015               
+6001021BEDRAG NUL NIET TOEGESTAAN                 
+1000000000000000012307149201234567890123456789    
+101EUR00000000000000000000000000                  
+105CI:81:52        0007002885114827735            
+110INCASSO TEST COMPANY                       
+110AUTO INCASSO ABONNEMENT                        
+110T.B.V. ABONNEMENT ADVIES ABONNEM               
+50001                    4432101015               
+6001021BEDRAG NUL NIET TOEGESTAAN                 
+1000000000000000012339666401234567890123456789    
+101EUR00000000000000000000000000                  
+105CI:80:56        0007002885114827743            
+110INCASSO TEST COMPANY                       
+110AUTO INCASSO ABONNEMENT                        
+110T.B.V. ABONNEMENT BEST-OFF  ABON               
+50001                    4432101015               
+6001021BEDRAG NUL NIET TOEGESTAAN                 
+1000000000000000012307149201234567890123456789    
+101EUR00000000000000000000000000                  
+105CI:81:57        0007002885114827751            
+110INCASSO TEST COMPANY                       
+110AUTO INCASSO ABONNEMENT                        
+110T.B.V. ABONNEMENT ADVIES ABONNEM               
+50001                    4432101015               
+6001021BEDRAG NUL NIET TOEGESTAAN                 
+1000000000000000012339666401234567890123456789    
+101EUR00000000000000000000000000                  
+105CI:80:60        0007002885114827761            
+110INCASSO TEST COMPANY                       
+110AUTO INCASSO ABONNEMENT                        
+110T.B.V. ABONNEMENT BEST-OFF  ABON               
+50001                    4432101015               
+6001021BEDRAG NUL NIET TOEGESTAAN                 
+1000000000000000012307149201234567890123456789    
+101EUR00000000000000000000000000                  
+105CI:81:61        0007002885114827778            
+110INCASSO TEST COMPANY                       
+110AUTO INCASSO ABONNEMENT                        
+110T.B.V. ABONNEMENT ADVIES ABONNEM               
+50001                    4432101015               
+6001021BEDRAG NUL NIET TOEGESTAAN                 
+950000000900000000000009
+0500123456789   0000000000000270000000025TA       
+051EUR                                            
+1000000000000000012307149201234567890123456789    
+101EUR00000000000000000000000000                  
+105CI:81:40        0007002885114827698            
+110INCASSO TEST COMPANY                       
+110AUTO INCASSO ABONNEMENT                        
+110T.B.V. ABONNEMENT ADVIES ABONNEM               
+50001                    4432101015               
+6001021BEDRAG NUL NIET TOEGESTAAN                 
+1000000000000000012339666401234567890123456789    
+101EUR00000000000000000000000000                  
+105CI:80:44        0007002885114827701            
+110INCASSO TEST COMPANY                       
+110AUTO INCASSO ABONNEMENT                        
+110T.B.V. ABONNEMENT BEST-OFF  ABON               
+50001                    4432101015               
+6001021BEDRAG NUL NIET TOEGESTAAN                  
+950000000900000000000009
+99000000100                                       
+