clieop 0.2.2 → 1.0.0

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: clieop
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
 - Willem van Bergen
 - Leon Berenschot
+- Reinier de Lange
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-23 00:00:00.000000000 -04:00
-default_executable: 
+date: 2012-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153186320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153186320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153185700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +39,15 @@ dependencies:
         version: '2.2'
   type: :development
   prerelease: false
-  version_requirements: *2153185700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &2153185140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,13 +55,19 @@ dependencies:
         version: '4.4'
   type: :development
   prerelease: false
-  version_requirements: *2153185140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.4'
 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.
 email:
 - willem@vanbergen.org
 - LeipeLeon@gmail.com
+- r.j.delange@nedforce.nl
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -65,18 +81,29 @@ files:
 - Rakefile
 - autotest/discover.rb
 - clieop.gemspec
+- doc/VERWINFO_NL_4.1_11-2009.pdf
 - doc/clieop03.pdf
 - lib/clieop.rb
-- lib/clieop/batch.rb
-- lib/clieop/file.rb
-- lib/clieop/record.rb
-- spec/clieop/batch_spec.rb
-- spec/clieop/file_spec.rb
-- spec/clieop/record_spec.rb
+- lib/clieop/payment/batch.rb
+- lib/clieop/payment/file.rb
+- lib/clieop/payment/record.rb
+- lib/clieop/process_info/batch.rb
+- lib/clieop/process_info/file.rb
+- lib/clieop/process_info/record.rb
+- lib/clieop/process_info/transaction.rb
+- lib/core_ext/hash.rb
+- lib/core_ext/string.rb
+- spec/clieop/payment/batch_spec.rb
+- spec/clieop/payment/file_spec.rb
+- spec/clieop/payment/record_spec.rb
+- spec/clieop/process_info/batch_spec.rb
+- spec/clieop/process_info/file_spec.rb
+- spec/clieop/process_info/record_spec.rb
+- spec/clieop/process_info/transaction_spec.rb
 - spec/clieop_spec.rb
+- spec/files/VERWINFO.txt
 - spec/spec_helper.rb
 - tasks/github-gem.rake
-has_rdoc: true
 homepage: http://github.com/wvanbergen/clieop/wiki
 licenses: []
 post_install_message: 
@@ -89,20 +116,30 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3597033530160283450
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3597033530160283450
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: A pure Ruby implementation to write CLIEOP files
 test_files:
-- spec/clieop/batch_spec.rb
-- spec/clieop/file_spec.rb
-- spec/clieop/record_spec.rb
+- spec/clieop/payment/batch_spec.rb
+- spec/clieop/payment/file_spec.rb
+- spec/clieop/payment/record_spec.rb
+- spec/clieop/process_info/batch_spec.rb
+- spec/clieop/process_info/file_spec.rb
+- spec/clieop/process_info/record_spec.rb
+- spec/clieop/process_info/transaction_spec.rb
 - spec/clieop_spec.rb

data/lib/clieop/batch.rb

@@ -1,112 +0,0 @@
-module Clieop
-
-  class Batch
-
-    attr_accessor :transactions, :batch_info
-
-    def initialize(batch_info)
-      raise "Required: :description, :account_nr, :account_owner" unless ([:description, :account_nr, :account_owner] - batch_info.keys).empty?
-      @transactions = []
-      @batch_info = batch_info
-    end
-
-    # Adds a transaction to the batch
-    #
-    # :amount The amount involved with this transaction
-    # :account_nr The bank account from the other party
-    # :account_owner The name of the owner of the bank account
-    # :reference_number A reference number to identify this transaction
-    # :description A description for this transaction (4 lines max)
-    def add_transaction (transaction)
-      raise "No :account_nr given"    if transaction[:account_nr].nil?
-      raise "No :amount given"        if transaction[:amount].nil?
-      raise "No :account_owner given" if transaction[:account_owner].nil?
-      @transactions << transaction
-    end
-
-    alias_method :<<, :add_transaction
-
-    def to_clieop
-
-      # generate batch header records
-      batch_data = ""
-      batch_data << Clieop::Record.new(:batch_header,
-                        :transaction_group => @batch_info[:transaction_group] || 0,
-                        :acount_nr         => @batch_info[:account_nr] || 0,
-                        :serial_nr         => @batch_info[:serial_nr] || 1,
-                        :currency          => @batch_info[:currency] || "EUR").to_clieop
-
-      batch_data << Clieop::Record.new(:batch_description, :description => @batch_info[:description]).to_clieop
-      batch_data << Clieop::Record.new(:batch_owner,
-                        :process_date => @batch_info[:process_date] || 0,
-                        :owner        => @batch_info[:account_owner]).to_clieop
-
-      # initialize checksums
-      total_account = @batch_info[:account_nr].to_i * @transactions.length
-      total_amount  = 0
-
-      # add transactions to batch
-      @transactions.each do |tr|
-
-        # prepare data for this transaction's records
-        transaction_type = tr[:transaction_type] || (transaction_is_payment? ? 1002 : 0)
-        to_account       = transaction_is_payment? ? @batch_info[:account_nr] : tr[:account_nr]
-        from_account     = transaction_is_payment? ? tr[:account_nr] : @batch_info[:account_nr]
-        amount_in_cents  = (tr[:amount] * 100).round.to_i
-
-        # 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,
-                          :to_account       => to_account,       :from_account => from_account).to_clieop
-
-        # generate record with transaction information
-        batch_data << Clieop::Record.new(:invoice_name, :name => tr[:account_owner]).to_clieop if transaction_is_payment?
-        batch_data << Clieop::Record.new(:transaction_reference, :reference_number => tr[:reference_number]).to_clieop unless tr[:reference_number].nil?
-
-        # 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| # 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
-        batch_data << Clieop::Record.new(:payment_name, :name => tr[:account_owner]).to_clieop unless transaction_is_payment?
-
-      end
-
-      # generate batch footer record including some checks
-      batch_data << Clieop::Record.new(:batch_footer, :transaction_count => @transactions.length,
-                        :total_amount => total_amount, :account_checksum => account_checksum(total_account)).to_clieop
-
-    end
-
-    alias_method :to_s, :to_clieop
-
-    # creates a batch for payments from a given account
-    def self.payment_batch(batch_info = {})
-      batch_info[:transaction_group] ||= 0
-      Clieop::Batch.new(batch_info)
-    end
-
-    # creates a batch for invoices to a given account
-    def self.invoice_batch(batch_info = {})
-      batch_info[:transaction_group] ||= 10
-      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
-
-  private
-
-    def transaction_is_payment?
-      @batch_info[:transaction_group] == 10
-    end
-  end
-end

data/lib/clieop/file.rb

@@ -1,43 +0,0 @@
-module Clieop
-
-  class File
-
-    attr_accessor :batches
-    attr_reader   :file_info
-
-    def initialize(file_info = {})
-      file_info[:date] = Date.today unless file_info[:date]
-      file_info[:date] = file_info[:date].strftime('%d%m%y') if file_info[:date].respond_to?(:strftime)
-      @file_info = file_info
-      @batches = []
-    end
-
-    # renders this file as a CLIEOP03 formatted string
-    def to_clieop
-      clieop_data = Clieop::Record.new(:file_header, @file_info).to_clieop
-      @batches.each { |batch| clieop_data << batch.to_clieop }
-      clieop_data << Clieop::Record.new(:file_footer).to_clieop
-    end
-
-    # Alias for to_clieop
-    alias_method :to_s, :to_clieop
-
-    def payment_batch(options)
-      @batches << Clieop::Batch.payment_batch(options)
-      yield(@batches.last) if block_given?
-      return @batches.last
-    end
-
-    def invoice_batch(options)
-      @batches << Clieop::Batch.invoice_batch(options)
-      yield(@batches.last) if block_given?
-      return @batches.last
-    end
-
-    def save(filename)
-      ::File.open(filename, 'w') do |f|
-        f.write(self.to_clieop)
-      end
-    end
-  end
-end

data/lib/clieop/record.rb

@@ -1,110 +0,0 @@
-module Clieop
-
-  class Record
-
-    TYPE_DEFINITIONS = {
-        :file_header => [
-            [:record_code, :numeric, 4, 1],
-            [: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]
-          ],
-        :file_footer => [
-            [:record_code, :numeric, 4, 9999],
-            [:record_variant, :alpha, 1, 'A'],
-          ],
-        :batch_header => [
-            [:record_code, :numeric, 4, 10],
-            [:record_variant, :alpha, 1, 'B'],
-            [:transaction_group, :numeric, 2],
-            [:acount_nr, :numeric, 10],
-            [:serial_nr, :numeric, 4],
-            [:currency, :alpha, 3, 'EUR']
-          ],
-        :batch_footer => [
-            [:record_code, :numeric, 4, 9990],
-            [:record_variant, :alpha, 1, 'A'],
-            [:total_amount, :numeric, 18],
-            [:account_checksum, :numeric, 10],
-            [:transaction_count, :numeric, 7],
-          ],
-        :batch_description => [
-            [:record_code, :numeric, 4, 20],
-            [:record_variant, :alpha, 1, 'A'],
-            [:description, :alpha, 32]
-          ],
-        :batch_owner => [
-            [:record_code, :numeric, 4, 30],
-            [:record_variant, :alpha, 1, 'B'],
-            [:naw_code, :numeric, 1, 1],
-            [:process_date, :numeric, 6, 0],
-            [:owner, :alpha, 35],
-            [:test, :alpha, 1, 'P']
-          ],
-        :transaction_info => [
-            [:record_code, :numeric, 4, 100],
-            [:record_variant, :alpha, 1, 'A'],
-            [:transaction_type, :numeric, 4, 1002],
-            [:amount, :numeric, 12],
-            [:from_account, :numeric, 10],
-            [:to_account, :numeric, 10],
-          ],
-        :invoice_name => [
-            [:record_code, :numeric, 4, 110],
-            [:record_variant, :alpha, 1, 'B'],
-            [:name, :alpha, 35],
-          ],
-        :transaction_reference => [
-            [:record_code, :numeric, 4, 150],
-            [:record_variant, :alpha, 1, 'A'],
-            [:reference_number, :alpha, 16],
-          ],
-        :transaction_description => [
-            [:record_code, :numeric, 4, 160],
-            [:record_variant, :alpha, 1, 'A'],
-            [:description, :alpha, 32],
-          ],
-        :payment_name =>[
-            [:record_code, :numeric, 4, 170],
-            [:record_variant, :alpha, 1, 'B'],
-            [:name, :alpha, 35],
-          ],
-    }
-
-    attr_accessor :definition, :data
-
-    def initialize record_type, record_data = {}
-
-      # load record definition
-      raise "Unknown record type" unless Clieop::Record::TYPE_DEFINITIONS[record_type.to_sym]
-      @definition = Clieop::Record::TYPE_DEFINITIONS[record_type.to_sym]
-
-      # set default values according to definition
-      @data = @definition.inject({}) { |memo, field| memo[field[0]] = field[3] if field[3] ; memo }
-
-      # set values for all the provided data
-      record_data.each { |field, value| @data[field] = value }
-    end
-
-    def to_clieop
-      line = ""
-      # format each field
-      @definition.each do |field, type, length, content|
-        fmt = '%'
-        fmt << (type == :numeric ? '0' : '-')
-        fmt << (length.to_s)
-        fmt << (type == :numeric ? 'd' : 's')
-        raw_data = (type == :numeric) ? @data[field].to_i : @data[field]
-        value = sprintf(fmt, raw_data)
-        line << (type == :numeric ? value[0 - length, length] : value[0, length])
-      end
-      # fill each line with spaces up to 50 characters and close with a CR/LF
-      line.ljust(50) + "\r\n"
-    end
-
-    alias_method :to_s, :to_clieop
-  end
-end