bambora-batch_upload 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5df6239fae3d7858fa64bbb6036702411fe78272
-  data.tar.gz: 9a65c41b2139546a702425319b1d655a7e13e5b9
+  metadata.gz: 6ed4d50be5df4a6df523d8ccaff654ea6f38cb3e
+  data.tar.gz: d1a65d47fa70ab3bbb3dec4510674ffb2bfdd7f6
 SHA512:
-  metadata.gz: 0de1d46a82f52e230e0a025413c05fc18336a010ce2901e6a08989148ab312b14f62438f6f7524f1d26c52d158f2c77dc58e42a307d052c5ac6cd688e496bbe7
-  data.tar.gz: b4e450f72aedaabd5d3493f7e3b0f8d9200aec5665bb5650bb2929593fdcca601fef947f4b053bfda9237a700d9819895a4a4ab5a523d2ad93116c41a4d610b0
+  metadata.gz: 16c71a0cf400eda46a8a526d10b11212cfab9153f10bbd1ad9d5845547b3869d6ef6b42e8bd529abfc7f1cceb12befff1e648c76346fb42a15f5834794171c0e
+  data.tar.gz: adf405388fc6e9cf7c70173f217741977d2fbc8885365fef6572c9383a6b98a95cbde12155123c3c504a13c7aa2bdf3e65c4f14246c5277e3639896f4e159a0c

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/README.md

@@ -1,8 +1,10 @@
 # Bambora::BatchUpload
 
-Unofficial ruby wrapper for EFT batch uploads to Bambora.
+Unofficial ruby wrapper for EFT and ACH batch uploads to Bambora.
 
-Under development
+## TODO
+
+Add credit card batch upload.
 
 ## Installation
 
@@ -22,6 +24,8 @@ Or install it yourself as:
 
 ## Usage
 
+See Bambora [Batch Payment API](https://dev.na.bambora.com/docs/references/batch_payment/#format-of-data-in-file) for reference.
+
 To configure the upload, you must provide your merchant ID as well as Batch
 Upload API Key. The default location for batch files (before uploading) is /tmp.
 
@@ -57,6 +61,21 @@ To create a batch file and then upload:
     ##more lines
     #reader.push_into_file(...)
   end
+
+  ##for ACH
+  Bambora::BatchUpload.create_file("A") do |reader|
+    reader.push_into_file(payment_type: "D", amount: 100, reference: 34, 
+                          customer_code: "C6777B381C16434B82d40A8d23a19a68",
+                          dynamic_descriptor: "Wesam Corp") 
+    reader.push_into_file(payment_type: "D",
+                          transit_routing_number: "123456789",
+                          account_number: "123458",
+                          account_code: "PC",
+                          amount: 200,
+                          reference: 667,
+                          recipient: "Haddad"
+                          )
+  end
    
   #by default process date is next business day
   Bambora::BatchUpload.do_upload(process_date) do |batch_id|

data/bambora-batch_upload.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["alwesam"]
   spec.email         = ["alwesam@gmail.com"]
 
-  spec.summary       = %q{Ruby wrapper to upload ETF batch files.}
-  spec.description   = %q{Ruby wrapper to upload ETF batch files to Bambora.}
+  spec.summary       = %q{Ruby wrapper to upload batch files.}
+  spec.description   = %q{Ruby wrapper to upload batch files to Bambora.}
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/lib/bambora/batch_upload.rb

@@ -2,7 +2,6 @@ require_relative "batch_upload/version"
 require_relative 'batch_upload/create_batch_file'
 require_relative "batch_upload/send_single_batch"
 require_relative "../extensions/date"
-
 require 'ostruct'
 require 'date'
 
@@ -25,10 +24,14 @@ module Bambora
       SendSingleBatch.new(file_path,process_date).call(&block) 
     end
 
-    def self.create_file &block
+    def self.create_file txn_type, &block
       raise "provide a block" unless block_given?
-      @file_path = CreateBatchFile.new(create_array(&block)).call
-      raise "WTF, no file generated!!!" if @file_path.nil?
+      @file_path = CreateBatchFile.new(create_array(txn_type,&block)).call
+      if @file_path.nil?
+        raise "No file generated!!!" 
+      else
+        @file_path
+      end
     end
 
     def self.get_batch_upload_api_url
@@ -44,40 +47,60 @@ module Bambora
       yield(self)
     end
 
-    def self.create_array &block
-      reader = MakeArray.new
+    def self.create_array txn_type, &block
+      reader = MakeArray.new txn_type
       yield(reader)
       reader.array
     end
 
     class MakeArray
-      attr_accessor :array
-      def initialize; @array=[]; end
+      attr_accessor :array, :txn_type
+      def initialize(txn_type)
+        @txn_type = txn_type
+        @array    = []
+      end
       def push_into_file(params)
         validate_args params
-        array << OpenStruct.new(txn_type:      params[:payment_type],
-                                institution:   params[:institution_number].to_s,
-                                transit:       params[:transit_number].to_s,
-                                account:       params[:account_number].to_s,
-                                amount:        params[:amount],
-                                ref:           (params[:reference] || 0 ).to_s,
-                                recipient:     params[:recipient].to_s,
-                                customer_code: params[:customer_code].to_s,
-                                descriptor:    params[:dynamic_descriptor].to_s
+        array << OpenStruct.new(txn_type:               @txn_type,
+                                payment_type:           params[:payment_type].to_s,
+                                institution_number:     params[:institution_number].to_s,
+                                transit_number:         params[:transit_number], 
+                                transit_routing_number: params[:transit_routing_number].to_s,
+                                account_number:         params[:account_number].to_s,
+                                account_code:           params[:account_code].to_s,
+                                amount:                 params[:amount],
+                                ref:                    (params[:reference] || 0 ).to_s,
+                                recipient:              params[:recipient].to_s,
+                                customer_code:          params[:customer_code].to_s,
+                                descriptor:             params[:dynamic_descriptor].to_s,
+                                standard_entry_code:    params[:standard_entry_code].to_s,
+                                entry_detail_addenda:   params[:entry_detail_addenda_record].to_s
                                )
       end
       private
       def validate_args params
-        if params[:amount].nil?
-          raise ArgumentError, "Must provide amount"       
+        unless @txn_type == "E" || @txn_type == "A"
+          raise ArgumentError, "Must specify transaction type: E (EFT) or A (ACH)" 
         end
         unless params[:payment_type] == "D" || params[:payment_type] == "C"
           raise ArgumentError, "Must provide payment type: C (credit) or D (debit)" 
         end
-        if params[:customer_code].nil? && (params[:transit_number].nil? || 
-                                           params[:institution_number].nil? ||
-                                           params[:account_number].nil?)
-          raise ArgumentError, "Must either provide customer code or transit, institution, and account #s"
+        if params[:amount].nil?
+          raise ArgumentError, "Must provide amount"       
+        end
+        #banking info
+        if @txn_type == "E"
+          if params[:customer_code].nil? && (params[:transit_number].nil? || 
+                                             params[:institution_number].nil? ||
+                                             params[:account_number].nil?)
+            raise ArgumentError, "Must either provide customer code or transit, institution, and account #s"
+          end
+        else
+          if params[:customer_code].nil? && (params[:transit_routing_number].nil? || 
+                                             params[:account_code].nil? ||
+                                             params[:account_number].nil?)
+            raise ArgumentError, "Must either provide customer code or transit routing, account #s, and accounting code"
+          end
         end
       end
     end

data/lib/bambora/batch_upload/beanstream_send_batch.rb

@@ -8,7 +8,6 @@ module Bambora::BatchUpload
     attr_accessor :file_path
     attr_accessor :process_date
     attr_accessor :process_now
-    attr_accessor :failure_message
 
     def initialize(file_path, process_date, process_now)
       @file_path    = file_path
@@ -24,15 +23,17 @@ module Bambora::BatchUpload
       end
       c.multipart_form_post  = true
       c.http_post(criteria_content,file_content)
-      response    = JSON.parse(c.body)
+      response       = JSON.parse(c.body)
+      response_code  = c.response_code
       if response["code"] == BATCH_PROCESS_SUCCESS 
-        response["batch_id"] 
+        response["batch_id"]
       else 
-        @failure_message = "Message: #{response["message"]}, Date: #{process_date}"
-        nil
+        raise BatchUploadError.new(code: response["code"], category: response["category"], message: response["message"], http_code: response_code)
       end
     end
-  
+
+    private
+
     def criteria_content
       criteria_content  = Curl::PostField.content("criteria",
                                                   "{'process_date':#{process_date_formatted},'process_now':#{process_now} }",

data/lib/bambora/batch_upload/create_batch_file.rb

@@ -37,16 +37,26 @@ module Bambora::BatchUpload
     def file_content
       string  = "" 
       txn_array.each do |txn|
-        string << "E,"
-        string << "#{txn.txn_type}," #C for Credit, D for Debit
-        string << "#{txn.institution},"
-        string << "#{txn.transit},"
-        string << "#{txn.account},"
+        string << "#{txn.txn_type},"     #E for EFT, A for ACH
+        string << "#{txn.payment_type}," #C for Credit, D for Debit
+        if txn.txn_type == "E"
+          string << "#{txn.institution_number},"
+          string << "#{txn.transit_number},"
+          string << "#{txn.account_number},"
+        else
+          string << "#{txn.transit_routing_number},"
+          string << "#{txn.account_number},"
+          string << "#{txn.account_code},"
+        end
         string << "#{txn.amount},"
         string << "#{txn.ref},"
         string << "#{txn.recipient},"
         string << "#{txn.customer_code},"
         string << "#{txn.descriptor}"
+        if txn.txn_type == "A"
+          string << ",#{txn.standard_entry_code}," #add comma at beginning to separate from above
+          string << "#{txn.entry_detail_addenda}"
+        end
         string << "\r\n"
       end
       string

data/lib/bambora/batch_upload/exceptions.rb

@@ -0,0 +1,16 @@
+module Bambora::BatchUpload
+  class BatchUploadError < StandardError
+    attr_reader :code, :category, :message, :http_code
+    def initialize args
+      @code      = args[:code]
+      @category  = args[:category] 
+      @message   = args[:message]
+      @http_code = args[:http_code]
+    end
+    def to_s
+      "Code: #{code}, Error Category: #{category}, Message: #{message}, HTTP response: #{http_code}"
+    end
+  end
+  class ConnectionError < StandardError
+  end
+end

data/lib/bambora/batch_upload/send_single_batch.rb

@@ -1,4 +1,5 @@
 require_relative 'beanstream_send_batch'
+require_relative 'exceptions'
 
 module Bambora::BatchUpload
   class SendSingleBatch
@@ -12,14 +13,20 @@ module Bambora::BatchUpload
     end
   
     def call
-      service          = BeanstreamSendBatch.new(file_path, 
-                                                 process_date,
-                                                 process_now)
-      batch_id         = service.send
-      unless batch_id.nil?
-        yield(batch_id) if block_given?
-      else
-        raise "Batch Scheduling Failed: #{service.failure_message}"
+      begin
+        service          = BeanstreamSendBatch.new(file_path,
+                                                   process_date,
+                                                   process_now)
+        batch_id         = service.send
+        unless batch_id.nil?
+          yield(batch_id) if block_given? 
+        end
+      rescue BatchUploadError #reraise error
+        raise
+      rescue JSON::ParserError => err
+        raise ConnectionError, "JSON parse Error: #{err.message}"
+      rescue => err #most likely api connection error
+        raise ConnectionError, "#{err.class}: #{err.message}"
       end
     end
   

data/lib/bambora/batch_upload/version.rb

@@ -1,5 +1,5 @@
 module Bambora
   module BatchUpload
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bambora-batch_upload
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - alwesam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-25 00:00:00.000000000 Z
+date: 2017-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Ruby wrapper to upload ETF batch files to Bambora.
+description: Ruby wrapper to upload batch files to Bambora.
 email:
 - alwesam@gmail.com
 executables: []
@@ -89,11 +89,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".rvmrc"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -104,6 +102,7 @@ files:
 - lib/bambora/batch_upload.rb
 - lib/bambora/batch_upload/beanstream_send_batch.rb
 - lib/bambora/batch_upload/create_batch_file.rb
+- lib/bambora/batch_upload/exceptions.rb
 - lib/bambora/batch_upload/send_single_batch.rb
 - lib/bambora/batch_upload/version.rb
 - lib/extensions/date.rb
@@ -130,5 +129,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: Ruby wrapper to upload ETF batch files.
+summary: Ruby wrapper to upload batch files.
 test_files: []

data/.rvmrc

@@ -1,60 +0,0 @@
-#!/usr/bin/env bash
-
-# This is an RVM Project .rvmrc file, used to automatically load the ruby
-# development environment upon cd'ing into the directory
-
-# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
-# Only full ruby name is supported here, for short names use:
-#     echo "rvm use 2.3.3@bambora" > .rvmrc
-environment_id="ruby-2.3.3@bambora-batch_upload"
-
-# Uncomment the following lines if you want to verify rvm version per project
-# rvmrc_rvm_version="1.29.2 (master)" # 1.10.1 seems like a safe start
-# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | __rvm_awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
-#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
-#   return 1
-# }
-
-# First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficient compared to running through the entire
-# CLI and selector. If you want feedback on which environment was used then
-# insert the word 'use' after --create as this triggers verbose mode.
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
-  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
-then
-  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
-  do
-    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
-    then \. "${__hook}" || true
-    fi
-  done
-  unset __hook
-  if (( ${rvm_use_flag:=1} >= 1 )) # display automatically
-  then
-    if [[ $- == *i* ]] # check for interactive shells
-    then printf "%b" "Using: $(tput setaf 2 2>/dev/null)$GEM_HOME$(tput sgr0 2>/dev/null)\n" # show the user the ruby and gemset they are using in green
-    else printf "%b" "Using: $GEM_HOME\n" # don't use colors in non-interactive shells
-    fi
-  fi
-else
-  # If the environment file has not yet been created, use the RVM CLI to select.
-  rvm --create use  "$environment_id" || {
-    echo "Failed to create RVM environment '${environment_id}'."
-    return 1
-  }
-fi
-
-# If you use bundler, this might be useful to you:
-# if [[ -s Gemfile ]] && {
-#   ! builtin command -v bundle >/dev/null ||
-#   builtin command -v bundle | GREP_OPTIONS="" \command \grep $rvm_path/bin/bundle >/dev/null
-# }
-# then
-#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
-#   gem install bundler
-# fi
-# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
-# then
-#   bundle install | GREP_OPTIONS="" \command \grep -vE '^Using|Your bundle is complete'
-# fi

data/Gemfile.lock

@@ -1,39 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bambora-batch_upload (0.1.1)
-      curb (= 0.9.3)
-      holidays
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    curb (0.9.3)
-    diff-lcs (1.3)
-    holidays (6.2.0)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bambora-batch_upload!
-  bundler (~> 1.16)
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.16.0