absa-h2h 0.0.11

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+build.sh

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in absa-h2h.gemspec
+gemspec
+
+gem 'rspec'
+gem 'strata', '0.0.1', :git => 'git://github.com/tehtorq/strata.git'

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/absa-h2h.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "absa-h2h/version"
+
+Gem::Specification.new do |s|
+  s.name        = "absa-h2h"
+  s.version     = Absa::H2h::VERSION
+  s.authors     = ["Jeffrey van Aswegen, Douglas Anderson"]
+  s.email       = ["jeffmess@gmail.com, i.am.douglas.anderson@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A ruby interface to commumicate with the ABSA Host 2 Host platform}
+  s.description = %q{The interface supports Account holder verifications, EFT payments, Debit orders, collecting statements.}
+
+  s.rubyforge_project = "absa-h2h"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "activesupport"
+  s.add_dependency "i18n"
+end

data/lib/absa-h2h/account_holder_verification.rb

@@ -0,0 +1,22 @@
+module Absa
+  module H2h
+    module Transmission
+      class AccountHolderVerification < Set
+        class Header < Record; end
+        class Trailer < Record; end
+        class InternalAccountDetail < Record; end
+        class ExternalAccountDetail < Record; end
+        
+        def validate! 
+          unless trailer.no_det_recs == transactions.length.to_s
+            raise "no_det_recs mismatch: expected #{trailer.no_det_recs}, got #{transactions.length}" 
+          end
+
+          unless transactions.map {|t| t.seq_no} == (1..(transactions.length)).map(&:to_s).to_a
+            raise "seq_no mismatch: #{transactions.map {|t| t.seq_no}}"
+          end             
+        end
+      end      
+    end
+  end
+end

data/lib/absa-h2h/account_holder_verification_output.rb

@@ -0,0 +1,22 @@
+module Absa
+  module H2h
+    module Transmission
+      class AccountHolderVerificationOutput < Set
+        class Header < Record; end
+        class Trailer < Record; end
+        class InternalAccountDetail < Record; end
+        class ExternalAccountDetail < Record; end
+        
+        def validate! 
+          unless trailer.no_det_recs == transactions.length.to_s
+            raise "no_det_recs mismatch: expected #{trailer.no_det_recs}, got #{transactions.length}" 
+          end
+
+          unless transactions.map {|t| t.seq_no} == (1..(transactions.length)).map(&:to_s).to_a
+            raise "seq_no mismatch: #{transactions.map {|t| t.seq_no}}"
+          end             
+        end
+      end      
+    end
+  end
+end

data/lib/absa-h2h/eft/rejection_code.rb

@@ -0,0 +1,30 @@
+module Absa
+  module H2h
+    module Eft
+      class RejectionCode
+        
+        def self.reasons
+          self.config['reasons']
+        end
+      
+        def self.qualifiers
+          self.config['qualifiers']
+        end
+        
+        def self.reason_for_code(code)
+          self.reasons[code]
+        end
+        
+        def self.qualifier_for_code(code)
+          self.qualifiers[code]
+        end
+      
+        def self.config
+          file_name = "#{Absa::H2h::CONFIG_DIR}/eft_rejection_codes.yml"
+          YAML.load(File.open(file_name))
+        end
+        
+      end
+    end
+  end
+end

data/lib/absa-h2h/eft.rb

@@ -0,0 +1,200 @@
+module Absa
+  module H2h
+    module Transmission
+      class Eft < Set
+        
+        def validate_standard_transactions!
+          if transactions.first.user_sequence_number != header.first_sequence_number
+            raise "user_sequence_number: 1st Standard transactions user sequence number and the headers first sequence number must be equal." 
+          end
+          
+          raise "user_sequence_number: Duplicate user sequence number. Transactions must have unique sequence numbers!" unless transactions.map(&:user_sequence_number).uniq.length == transactions.length
+
+          unless transactions.map(&:user_sequence_number) == ((transactions.first.user_sequence_number.to_i)..(transactions.first.user_sequence_number.to_i + transactions.length-1)).map(&:to_s).to_a
+            raise "user_sequence_number: Transactions must increment sequentially. Got: #{transactions.map(&:user_sequence_number)}" 
+          end
+          
+          transactions.each do |transaction|
+            first_action_date = Date.strptime(header.first_action_date, "%y%m%d")
+            last_action_date = Date.strptime(header.last_action_date, "%y%m%d")
+            action_date = Date.strptime(transaction.action_date, "%y%m%d")
+            
+            raise "action_date: Must be within the range of the headers first_action_date and last_action_date" unless (first_action_date..last_action_date).cover?(action_date)
+            raise "rec_status: Transaction and Header record status must be equal" if header.rec_status != transaction.rec_status
+          end
+        end
+        
+        def validate_header_trailer!
+          raise "rec_status: Trailer and Header record status must be equal" if header.rec_status != trailer.rec_status
+          raise "bankserv_user_code: Trailer and Header user code must be equal." if header.bankserv_user_code != trailer.bankserv_user_code
+          raise "first_sequence_number: Trailer and Header sequence number must be equal." if header.first_sequence_number != trailer.first_sequence_number
+          raise "first_action_date: Trailer and Header first action date must be equal." if header.first_action_date != trailer.first_action_date
+          raise "last_action_date: Trailer and Header last action date must be equal." if header.last_action_date != trailer.last_action_date
+        end
+        
+        def validate_contra_records!
+          transactions.select{|t| t.contra_record? }.each do |transaction|
+            # Loop used to validate contra records against the standard records
+            unless calculate_contra_record_total(transaction) == transaction.amount.to_i
+              raise "amount: Contra record amount must be the sum amount of all preceeding transactions. Expected #{calculate_contra_record_total(transaction)}. Got #{transaction.amount}." 
+            end
+            
+            transactions = transactions_for_contra_record(transaction)
+            
+            if transactions.map(&:action_date).uniq.length > 1
+              raise "action_date: Contra records action date must be equal to all preceeding standard transactions action date. Got #{transactions_for_contra_record(transaction).map(&:action_date)}." 
+            end
+            
+            if (transactions.map(&:user_nominated_account).uniq.length > 1) or (transactions.map(&:user_nominated_account).first != transaction.user_nominated_account)
+              raise "user_nominated_account: Contra records user nominated account must match all preceeding standard transactions user nominated accounts. Got #{transactions.map(&:user_nominated_account)}."
+            end
+            
+            if (transactions.map(&:user_branch).uniq.length > 1) or (transactions.map(&:user_branch).first != transaction.user_branch)
+              raise "user_branch_code: Contra records user branch must match all preceeding standard transactions user branch. Got #{transactions.map(&:user_branch)}."
+            end
+            
+            raise "user_code: Contra records user code must match the headers users code. Got #{transaction.user_code}. Expected #{header.bankserv_user_code}." unless transaction.user_code == header.bankserv_user_code
+          end
+        end
+        
+        def validate_trailer_transactions!
+          unless trailer.last_sequence_number == transactions.last.user_sequence_number
+            raise "last_sequence_number: Trailer records last sequence number must match the last contra records sequence number. Got #{trailer.last_sequence_number}. Expected #{transactions.last.user_sequence_number}"
+          end
+          
+          debit_records = transactions.select {|t| t.bankserv_record_identifier.to_i == 50 }
+          credit_records = transactions.select {|t| t.bankserv_record_identifier.to_i == 10 }
+          
+          unless trailer.no_debit_records.to_i == self.debit_records.count + self.credit_contra_records.count
+            raise "no_debit_records: Trailer records number of debit records must match the number of debit records. Expected #{debit_records.count}. Got #{trailer.no_debit_records}."
+          end
+          
+          unless trailer.no_credit_records.to_i == self.credit_records.count + self.debit_contra_records.count
+            raise "no_credit_records: Trailer records number of credit records must match the number of credit records and contra debit records. Expected #{self.credit_records.count + self.debit_contra_records.count}. Got #{trailer.no_credit_records}."
+          end
+          
+          unless trailer.no_contra_records.to_i == self.contra_records.count
+            raise "no_contra_records: Trailer records number of contra records must match the number of contra records. Expected #{self.contra_records.count}. Got #{trailer.no_contra_records}."
+          end
+          
+          unless trailer.total_debit_value.to_i == self.total_debit_transactions
+            raise "total_debit_value: Trailer records total debit value must equal the sum amount of all transactions and credit contra records. Expected #{self.total_debit_transactions}. Got #{trailer.total_debit_value.to_i}."
+          end
+          
+          unless trailer.total_credit_value.to_i == self.total_credit_transactions
+            raise "total_credit_value: Trailer records total credit value must equal the sum amount of all transactions and debit contra records. Expected #{self.total_credit_transactions}. Got #{trailer.total_credit_value.to_i}."
+          end
+          
+          unless trailer.hash_total_of_homing_account_numbers.to_i == self.homing_numbers_hash_total
+            raise "hash_total_of_homing_account_numbers: Trailers hash total of homing account numbers does not match. Expected #{self.homing_numbers_hash_total}. Got #{trailer.hash_total_of_homing_account_numbers}."
+          end
+        end
+        
+        def validate!
+          validate_standard_transactions!
+          validate_header_trailer!
+          validate_contra_records!
+          validate_trailer_transactions!          
+        end
+        
+        def contra_records
+          transactions.select {|t| t.contra_record? }
+        end
+        
+        def standard_records
+          transactions.select {|t| !t.contra_record? }
+        end
+        
+        def debit_records
+          # Standard records only
+          transactions.select {|t| t.bankserv_record_identifier.to_i == 50 }
+        end
+        
+        def credit_records
+          # Standard records only
+          transactions.select {|t| t.bankserv_record_identifier.to_i == 10 }
+        end
+        
+        def debit_contra_records
+          transactions.select {|t| t.contra_record? && t.bankserv_record_identifier.to_i == 52}
+        end
+        
+        def credit_contra_records
+          transactions.select {|t| t.contra_record? && t.bankserv_record_identifier.to_i == 12}
+        end
+        
+        def total_debit_transactions
+          # including credit contra records
+          ccr = self.credit_contra_records == [] ? 0 : self.credit_contra_records.map(&:amount).map(&:to_i).inject(&:+)
+          (self.debit_records.map(&:amount).map(&:to_i).inject(&:+) || 0) + ccr
+        end
+        
+        def total_credit_transactions
+          # including debit contra records
+          dcr = self.debit_contra_records == [] ? 0 : self.debit_contra_records.map(&:amount).map(&:to_i).inject(&:+)
+          (self.credit_records.map(&:amount).map(&:to_i).inject(&:+) || 0) + dcr
+        end
+        
+        def calculate_contra_record_total(contra_record)
+          transactions_for_contra_record(contra_record).map(&:amount).map(&:to_i).inject(&:+)
+        end
+        
+        def transactions_for_contra_record(contra_record)
+          contra_records = self.contra_records.map(&:user_sequence_number)
+          sequence = transactions.map(&:user_sequence_number)
+          
+          if contra_records.index(contra_record.user_sequence_number) == 0 # First contra record in user set
+            previous_contra_record = contra_record.user_sequence_number
+            start_point = 0
+          else
+            previous_contra_record = contra_records[contra_records.index(contra_record.user_sequence_number)-1]
+            start_point = sequence.index(previous_contra_record) + 1
+          end
+          
+          end_point = sequence.index(contra_record.user_sequence_number)-1
+          transactions[start_point..end_point]
+        end
+        
+        def homing_numbers_hash_total
+          ns_homing_account_number_total = self.standard_records.map(&:non_standard_homing_account_number).empty? ? 0 : self.standard_records.map(&:non_standard_homing_account_number).map(&:to_i).inject(&:+)
+          field9 = transactions.map(&:homing_account_number).map(&:to_i).inject(&:+) + ns_homing_account_number_total
+          field9.to_s.reverse[0,12].reverse.to_i
+        end
+        
+        class Header < Record; end
+        class ContraRecord < Record
+        
+          def contra_record?
+            true
+          end
+          
+          def validate!(options={})
+            super(options)
+            raise "homing_branch: Should match the user branch. Got #{@homing_branch}. Expected #{@user_branch}." unless @homing_branch == @user_branch
+            raise "homing_account_number: Should match the user nominated account number. Got #{@homing_account_number}. Expected #{@user_nominated_account}." unless @homing_account_number == @user_nominated_account
+            raise "user_ref: Position 1 - 10 is compulsory. Please provide users abbreviated name." if @user_ref[0..9].blank?
+            raise "user_ref: Position 11 - 16 is compulsory and must be set to 'CONTRA'. Got #{@user_ref[10..15]}" if @user_ref[10..15] != "CONTRA"
+          end
+          
+        end
+
+        class StandardRecord < Record
+          
+          def contra_record?
+            false
+          end
+          
+          def validate!(options={})
+            super(options)
+            
+            raise "user_ref: Position 1 - 10 is compulsory. Please provide users abbreviated name." if @user_ref[0..11].blank?
+            raise "homing_account_name: Not to be left blank." if @homing_account_name.blank?
+          end
+          
+        end
+
+        class Trailer < Record; end
+      end
+    end
+  end
+end

data/lib/absa-h2h/eft_output.rb

@@ -0,0 +1,12 @@
+module Absa
+  module H2h
+    module Transmission
+      class EftOutput < Set
+        
+        class Header < Record; end
+        class Trailer < Record; end
+
+      end
+    end
+  end
+end

data/lib/absa-h2h/eft_redirect.rb

@@ -0,0 +1,13 @@
+module Absa
+  module H2h
+    module Transmission
+      class EftRedirect < Set
+        
+        class Header < Record; end
+        class Trailer < Record; end
+        class Transaction < Record; end
+
+      end      
+    end
+  end
+end

data/lib/absa-h2h/eft_unpaid.rb

@@ -0,0 +1,13 @@
+module Absa
+  module H2h
+    module Transmission
+      class EftUnpaid < Set
+        
+        class Header < Record; end
+        class Trailer < Record; end
+        class Transaction < Record; end
+
+      end      
+    end
+  end
+end

data/lib/absa-h2h/reply.rb

@@ -0,0 +1,27 @@
+module Absa
+  module H2h
+    module Transmission
+      class Reply < Set
+        
+        class TransmissionStatus < Record; end
+        class TransmissionRejectedReason < Record; end
+        class EftStatus < Record; end
+        class AcceptedReportReply < Record; end
+        class RejectedMessage < Record; end
+        
+        def self.hash_from_s(string, transmission_type)
+          set_info = {type: self.partial_class_name.underscore, data: []}
+
+          string.split(/^/).each do |line|
+            if Set.for_record(line, transmission_type) == self
+              set_info[:data] << self.process_record(line[0, 198])
+            end
+          end
+
+          set_info
+        end
+      
+      end      
+    end
+  end
+end

data/lib/absa-h2h/transmission/document.rb

@@ -0,0 +1,26 @@
+module Absa
+  module H2h
+    module Transmission
+    
+      class Document < Set
+        
+        class Header < Record; end
+        class Trailer < Record; end
+        
+        def self.from_s(string, transmission_type)
+          options = self.hash_from_s(string, transmission_type)
+          self.build(options[:data])
+        end
+        
+        def to_file!(filename)
+          File.open(destination, 'w') {|file| file.write(self.to_s) }
+        end
+        
+        def from_file!(filename)
+          self.from_s(File.open(filename, "rb").read)
+        end
+    
+      end
+    end    
+  end
+end

data/lib/absa-h2h/transmission/record.rb

@@ -0,0 +1,18 @@
+module Absa::H2h::Transmission
+    
+  class Record
+    include Strata::RecordWriter
+    extend Strata::RecordWriter::ClassMethods
+    
+    set_record_length 198
+    set_delimiter "\r\n"
+    set_allowed_characters ('A'..'Z').to_a + ('a'..'z').to_a + (0..9).to_a.map(&:to_s) + ['.','/','-','&','*',',','(',')','<','+','$',';','>','=',"'",' '] # move to config file
+
+    def initialize(options = {})
+      set_layout_variables(options)
+      validate! options
+    end
+
+  end
+  
+end

data/lib/absa-h2h/transmission/set.rb

@@ -0,0 +1,168 @@
+module Absa::H2h::Transmission
+  class Set
+    
+    attr_accessor :records
+    
+    def initialize
+      self.records = []
+    end
+    
+    def self.build(data)
+      set = self.new
+      
+      data.each do |hash|  
+        puts hash.inspect
+        if hash[:data].is_a? Array
+          klass = "Absa::H2h::Transmission::#{hash[:type].capitalize.camelize}".constantize
+          set.records << klass.build(hash[:data])
+        else
+          klass = "Absa::H2h::Transmission::#{self.partial_class_name}::#{hash[:type].capitalize.camelize}".constantize
+          set.records << klass.new(hash[:data])
+        end
+      end
+      
+      set.validate!
+      set
+    end
+    
+    def header
+      records[0]
+    end
+    
+    def trailer
+      records[-1]
+    end
+    
+    def transactions
+      records[1..-2]
+    end
+    
+    def validate!
+      
+    end
+    
+    def to_s
+      string = ""
+      records.each {|record| string += record.to_s }
+      string
+    end
+    
+    def self.for_record(record, transmission_type) # move this logic to yml file
+      record_id = record[0..2]
+      
+      case record_id
+      when '000','999'
+        return Absa::H2h::Transmission::Document
+      when '030','031','039'
+        return (transmission_type == "output") ? Absa::H2h::Transmission::AccountHolderVerificationOutput : Absa::H2h::Transmission::AccountHolderVerification
+      when '001', '020'
+        return Absa::H2h::Transmission::Eft
+      when '010','019'
+        return Absa::H2h::Transmission::EftOutput
+      when '011','013','014'
+        return Absa::H2h::Transmission::EftUnpaid
+      when '016','017','018'
+        return Absa::H2h::Transmission::EftRedirect
+      when '900','901','902','903'
+        return Absa::H2h::Transmission::Reply
+      end
+    end
+    
+    def self.trailer_id(klass)
+      case klass.name
+      when 'Absa::H2h::Transmission::Document'
+        return '999'
+      when 'Absa::H2h::Transmission::AccountHolderVerification'
+        return '039'
+      when 'Absa::H2h::Transmission::AccountHolderVerificationOutput'
+        return '039'
+      when 'Absa::H2h::Transmission::EftOutput'
+        return '019'
+      when 'Absa::H2h::Transmission::EftUnpaid'
+        return '014'
+      when 'Absa::H2h::Transmission::EftRedirect'
+        return '018'
+      end
+    end  
+    
+    def self.is_trailer_record?(set, record)
+      record_id = record[0,3]
+      return true if set == Absa::H2h::Transmission::Eft and (["001","020"].include? record_id) and record[4,2] == "92"
+      self.trailer_id(set) == record_id
+    end
+    
+    def self.process_record(record)
+      record_info = {}
+      
+      self.record_types.each do |record_type|
+        klass = "#{self.name}::#{record_type.camelize}".constantize
+
+        if klass.matches_definition?(record)
+          options = klass.string_to_hash(record)
+          record_info = {type: record_type, data: options}
+          break
+        end
+      end
+      
+      record_info
+    end
+    
+    def self.hash_from_s(string, transmission_type)
+      set_info = {type: self.partial_class_name.underscore, data: []}
+      lines = string.split(/^/)
+            
+      # look for rec_ids, split into chunks, and pass each related class a piece of string
+      
+      buffer = []
+      current_set = nil
+      subset = nil
+      
+      lines.each do |line|
+        if Set.for_record(line, transmission_type) == self
+          if subset && (buffer.length > 0)
+            set_info[:data] << subset.hash_from_s(buffer.join, transmission_type)
+            buffer = []
+            subset = nil
+          end
+          
+          record = line[0, 198]
+          set_info[:data] << self.process_record(record)
+        else
+          subset = Set.for_record(line, transmission_type) unless subset        
+          buffer << line
+          
+          if self.is_trailer_record?(subset, line)
+            set_info[:data] << subset.hash_from_s(buffer.join, transmission_type)
+            buffer = []
+            subset = nil
+          end
+        end
+      end
+      
+      set_info
+    end
+    
+    def self.record_types
+      self.layout_rules.map {|k,v| k}
+    end
+    
+    def self.module_name
+      self.name.split("::")[0..-1].join("::")
+    end
+    
+    def self.partial_class_name
+      self.name.split("::")[-1]
+    end
+    
+    def self.layout_rules
+      file_name = "#{Absa::H2h::CONFIG_DIR}/#{self.partial_class_name.underscore}.yml"
+      
+      YAML.load(File.open(file_name))
+    end
+    
+    def self.record_type(record_type)
+      "#{self.name}::#{record_type.camelize}".constantize
+    end
+   
+  end
+end

data/lib/absa-h2h/version.rb

@@ -0,0 +1,5 @@
+module Absa
+  module H2h
+    VERSION = "0.0.11"
+  end
+end

data/lib/absa-h2h.rb

@@ -0,0 +1,22 @@
+require "absa-h2h/version"
+require "active_support/core_ext/string"
+require "yaml"
+#require 'strata'
+
+module Absa
+  module H2h
+    CONFIG_DIR = File.expand_path(File.dirname(__FILE__)) + "/config" 
+  end
+end
+
+require 'absa-h2h/transmission/set'
+require 'absa-h2h/transmission/record'
+require 'absa-h2h/transmission/document'
+require 'absa-h2h/account_holder_verification'
+require 'absa-h2h/account_holder_verification_output'
+require 'absa-h2h/eft'
+require 'absa-h2h/eft_output'
+require 'absa-h2h/eft_unpaid'
+require 'absa-h2h/eft_redirect'
+require 'absa-h2h/eft/rejection_code'
+require 'absa-h2h/reply'