bambora-batch_upload 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: acb069dcdbfe02b49c8349cb4d01467e025cbcfc
+  data.tar.gz: e10a43dca939849439d38ccb9cabd1285a43970b
+SHA512:
+  metadata.gz: bd175d85e4b2029b272901e657fb0cdd7a00b55a8d1f5510f661990dc112cb3c978f9b8f416d1f2a86d9e7d96bcc2c0f7c8377adcb343a821f6ca12aca442d91
+  data.tar.gz: 99048ba19f2e18b55ae3b5b1dda97ada5c43d6eb1f21a1f5e636b9b1c9a619fc2f1b0e998310ba29f0f87fa1a85db23c3ae1bc11bcfb5f4a2120b4c6d446dcee

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alwesam@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bambora-batch_upload.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    bambora-batch_upload (0.1.0)
+      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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 alwesam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.

data/README.md

@@ -0,0 +1,72 @@
+# Bambora::BatchUpload
+
+Unofficial ruby wrapper for EFT batch uploads to Bambora.
+
+Under development
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bambora-batch_upload'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bambora-batch_upload
+
+## Usage
+
+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.
+
+```ruby
+  Bambora::BatchUpload.configure do |config|
+    config.merchant_id          = "111111111" #9 digits
+    config.batch_upload_api_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+    #optional
+    config.batch_file_path      = "/tmp"    #default
+    config.batch_upload_api_url = "https://api.na.bambora.com/v1/batchpayments" #default
+  end
+```
+
+To create a batch file and then upload:
+
+```ruby
+  #payment type has to be D (debit) or C (credit)
+  #amount must be specified in pennies
+  Bambora::BatchUpload.create_file do |reader|
+    reader.push_into_file(payment_type: "D", amount: 100, reference: 33, customer_code: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX") 
+    ##more lines
+    #reader.push_into_file(...)
+  end
+   
+  #by default process date is next business day
+  Bambora::BatchUpload.do_upload(process_date) do |batch_id|
+    #callback here
+    puts "Upload is successful and batch id is #{batch_id}"
+  end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alwesam/bambora-batch_upload. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bambora::BatchUpload project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/alwesam/bambora-batch_upload/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bambora-batch_upload.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bambora/batch_upload/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bambora-batch_upload"
+  spec.version       = Bambora::BatchUpload::VERSION
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "curb", "0.9.3"
+  spec.add_dependency "holidays"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bambora/batch_upload"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bambora/batch_upload/beanstream_send_batch.rb

@@ -0,0 +1,68 @@
+require 'base64'
+require 'json'
+require 'curb'
+
+module Bambora::BatchUpload
+  class BeanstreamSendBatch
+
+    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
+      @process_date = process_date
+      @process_now  = process_now
+    end
+  
+    BATCH_PROCESS_SUCCESS      = 1
+     
+    def send
+      c = Curl::Easy.new(batch_uploads_api_url) do |curl| 
+        curl.headers["Authorization"] = "Passcode #{encoded_pass_code}"
+      end
+      c.multipart_form_post  = true
+      c.http_post(criteria_content,file_content)
+      response    = JSON.parse(c.body)
+      if response["code"] == BATCH_PROCESS_SUCCESS 
+        response["batch_id"] 
+      else 
+        @failure_message = "Message: #{response["message"]}, Date: #{process_date}"
+        nil
+      end
+    end
+  
+    def criteria_content
+      criteria_content  = Curl::PostField.content("criteria",
+                                                  "{'process_date':#{process_date_formatted},'process_now':#{process_now} }",
+                                                  "application/json")
+    end
+  
+    def file_content
+      file_content      = Curl::PostField.file("file1",file_path)
+    end
+  
+  
+    def process_date_formatted
+      process_date.to_s.gsub("-","")
+    end
+  
+    def encoded_pass_code
+      Base64.strict_encode64("#{merchant_id}:#{batch_uploads_api_key}")
+    end
+  
+    def merchant_id
+      Bambora::BatchUpload.merchant_id
+    end
+  
+    def batch_uploads_api_key
+      Bambora::BatchUpload.batch_upload_api_key
+    end
+  
+    def batch_uploads_api_url
+      Bambora::BatchUpload.get_batch_upload_api_url
+    end
+  
+  end
+end

data/lib/bambora/batch_upload/create_batch_file.rb

@@ -0,0 +1,55 @@
+require 'securerandom'
+require 'date'
+
+module Bambora::BatchUpload
+  class CreateBatchFile
+    
+    attr_accessor :txn_array
+
+    def initialize(txn_array)
+      @txn_array = txn_array
+    end
+  
+    def call 
+      create_file 
+    end
+  
+    private
+  
+    def create_file
+      string    = file_content
+      begin
+        path = "#{Bambora::BatchUpload.get_batch_file_path}/#{batch_file_name}"
+        file = File.open(path, "w")
+        file.write(string) 
+      rescue IOError => e
+        puts "Write Fail"
+      ensure
+        file.close unless file.nil?
+      end
+      path
+    end
+  
+    def batch_file_name
+      file_name = "#{SecureRandom.hex(4)}_#{DateTime.now.strftime("%b_%d_%Y_%H:%M:%S:%L")}.txt"
+    end
+  
+    def file_content
+      string  = "" 
+      txn_array.each do |txn|
+        string << "E,"
+        string << "#{txn.txn_type}," #C for Credit, D for Debit
+        string << "#{txn.transit},"
+        string << "#{txn.institution},"
+        string << "#{txn.account},"
+        string << "#{txn.amount},"
+        string << "#{txn.ref},"
+        string << "#{txn.recipient},"
+        string << "#{txn.customer_code}"
+        string << "\r\n"
+      end
+      string
+    end
+  
+  end
+end

data/lib/bambora/batch_upload/send_single_batch.rb

@@ -0,0 +1,37 @@
+require_relative 'beanstream_send_batch'
+
+module Bambora::BatchUpload
+  class SendSingleBatch
+
+    attr_accessor :file_path
+    attr_accessor :process_date
+    
+    def initialize(file_path,process_date) 
+      @file_path    = file_path
+      @process_date = process_date
+    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}"
+      end
+    end
+  
+    private
+  
+    def process_now
+      if process_date
+        0
+      else
+        1
+      end
+    end
+  
+  end
+end

data/lib/bambora/batch_upload/version.rb

@@ -0,0 +1,5 @@
+module Bambora
+  module BatchUpload
+    VERSION = "0.1.0"
+  end
+end

data/lib/bambora/batch_upload.rb

@@ -0,0 +1,91 @@
+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'
+
+module Bambora
+  module BatchUpload
+    @default_batch_upload_api_url  = "https://api.na.bambora.com/v1/batchpayments"
+    @default_batch_file_path       = "/tmp"
+    class << self
+      #must be provided by user
+      attr_accessor :merchant_id
+      attr_accessor :batch_upload_api_key
+      #optional
+      attr_accessor :batch_file_path
+      attr_accessor :batch_upload_api_url
+      #file name
+      attr_accessor :file_path
+    end
+    def self.do_upload(process_date=Date.next_business_day,&block)
+      raise "Configure Merchant ID and Upload API key" unless config_complete 
+      SendSingleBatch.new(file_path,process_date).call(&block) 
+    end
+
+    def self.create_file &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?
+    end
+
+    def self.get_batch_upload_api_url
+      batch_upload_api_url || @default_batch_upload_api_url
+    end
+
+    def self.get_batch_file_path
+      batch_file_path || @default_batch_file_path 
+    end
+
+    def self.configure &block
+      raise ArgumentError unless block_given?
+      yield(self)
+    end
+
+    def self.create_array &block
+      reader = MakeArray.new
+      yield(reader)
+      reader.array
+    end
+
+    class MakeArray
+      attr_accessor :array
+      def initialize; @array=[]; end
+      def push_into_file(params)
+        validate_args params
+        array << OpenStruct.new(txn_type:      params[:payment_type],
+                                transit:       params[:transit_number].to_s,
+                                institution:   params[:institution_number].to_s,
+                                account:       params[:account_number].to_s,
+                                amount:        params[:amount],
+                                ref:           params[:reference].to_s,
+                                recipient:     params[:recipient].to_s,
+                                customer_code: params[:customer_code].to_s
+                               )
+      end
+      private
+      def validate_args params
+        if params[:amount].nil?
+          raise ArgumentError, "Must provide amount"       
+        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] || 
+                                           params[:institution_number] ||
+                                           params[:account_number])
+          raise ArgumentError, "Must either provide customer code or transit, institution, and account #s"
+        end
+      end
+    end
+    
+    private
+
+    def self.config_complete 
+      merchant_id && batch_upload_api_key
+    end
+
+  end
+end

data/lib/bambora-batch_upload.rb

@@ -0,0 +1 @@
+require_relative 'bambora/batch_upload'

data/lib/extensions/date.rb

@@ -0,0 +1,30 @@
+require 'holidays'
+require 'holidays/core_extensions/date'
+class Date 
+  include Holidays::CoreExtensions::Date
+
+  def self.next_business_day buffer=0
+    day = Date.today+buffer
+    begin
+      day += 1
+    end while(day.is_bc_time_off?)
+    day
+  end
+
+  def self.monday 
+    1
+  end
+
+  def is_bc_time_off?
+    self.holiday?(:ca_bc) || Date.weekend.include?(self.wday) || self.sub_day?
+  end
+
+  def self.weekend 
+    [0,6]
+  end
+
+  def sub_day? 
+    self.wday == self.class.monday && ( (self-1.day).holiday?(:ca_bc) || (self-2.day).holiday?(:ca_bc) )
+  end
+
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: bambora-batch_upload
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alwesam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: holidays
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby wrapper to upload ETF batch files to Bambora.
+email:
+- alwesam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bambora-batch_upload.gemspec
+- bin/console
+- bin/setup
+- lib/bambora-batch_upload.rb
+- 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/send_single_batch.rb
+- lib/bambora/batch_upload/version.rb
+- lib/extensions/date.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper to upload ETF batch files.
+test_files: []