canada_payment 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7eeef44cc2f4829a2f6d92131aafe852000aad5
+  data.tar.gz: 36807e158fb8dfcb978df6213bd942c1e3b6806b
+SHA512:
+  metadata.gz: eb7d448670d96434a01c1ae60cf41683c09f8345dff9c54be934bae77726902a6466033763d4334bf7484525d3a101fc4412bf30804328902faf4085ccc0f296
+  data.tar.gz: 10303c98593a3c8b0526ca02799d8a8705f0b07a42b2d05a7160c83ab1f4c9bd9227f5f932b0538770529597f4d04e128a40077aeb4f08b9adf59efd1c4174c8

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+
+# rspec failure tracking
+.rspec_status
+
+*.swp

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in canada_payment.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,30 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+notification :terminal_notifier, app_name: "", activate: "com.googlecode.iTerm2"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Carl Mercier
+
+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,41 @@
+# CanadaPayment
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/canada_payment`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'canada_payment'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install canada_payment
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/cmer/canada_payment. 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](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "canada_payment"
+
+# 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/canada_payment.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'canada_payment/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "canada_payment"
+  spec.version       = CanadaPayment::VERSION
+  spec.authors       = ["Carl Mercier"]
+  spec.email         = ["foss@carlmercier.com"]
+
+  spec.summary       = %q{Canadian ACH/EFT files in Ruby}
+  spec.description   = %q{This library allows you to easily create ACH/EFT CPA005 files from Ruby.}
+  spec.homepage      = "https://gitlab.com/cmer/canada_payment"
+  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_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "terminal-notifier-guard"
+  spec.add_development_dependency "faker"
+  spec.add_development_dependency "simplecov"
+end

data/docs/layouts.md

@@ -0,0 +1,8 @@
+# CPA File Layouts
+
+[https://www.rbcroyalbank.com/ach/cid-212260.html](https://www.rbcroyalbank.com/ach/cid-212260.html)
+[https://www.payments.ca/sites/default/files/standard-005.pdf](https://www.payments.ca/sites/default/files/standard-005.pdf)
+[https://www.scribd.com/document/96254354/CPA-Std005-Specs](https://www.scribd.com/document/96254354/CPA-Std005-Specs)
+
+## Transaction Codes
+[https://www.rbcroyalbank.com/ach/file-450194.pdf](https://www.rbcroyalbank.com/ach/file-450194.pdf)

data/lib/canada_payment.rb

@@ -0,0 +1,8 @@
+require 'date'
+
+module CanadaPayment
+  # Your code goes here...
+end
+
+require_relative "canada_payment/version"
+require_relative "canada_payment/eft"

data/lib/canada_payment/eft.rb

@@ -0,0 +1,6 @@
+module CanadaPayment
+  module EFT; end
+end
+
+require_relative 'eft/helper'
+require_relative 'eft/cpa005'

data/lib/canada_payment/eft/cpa005.rb

@@ -0,0 +1,11 @@
+module CanadaPayment::EFT
+  module CPA005
+    module Debit; end
+    module Credit; end
+  end
+end
+
+require_relative "cpa005/debit/file"
+require_relative "cpa005/debit/segment"
+require_relative "cpa005/credit/file"
+require_relative "cpa005/credit/line"

data/lib/canada_payment/eft/cpa005/credit/file.rb

@@ -0,0 +1,4 @@
+module CanadaPayment::EFT::CPA005::Credit
+  class File
+  end
+end

data/lib/canada_payment/eft/cpa005/credit/line.rb

@@ -0,0 +1,4 @@
+module CanadaPayment::EFT::CPA005::Credit
+  class Line
+  end
+end

data/lib/canada_payment/eft/cpa005/debit/file.rb

@@ -0,0 +1,147 @@
+module CanadaPayment::EFT::CPA005::Debit
+  class File
+    include CanadaPayment::EFT::CPA005::Debit
+    include CanadaPayment::EFT::Helper
+
+    DEFAULT_CURRENCY = "CAD"
+    RECORD_LENGTH = 1464
+
+    attr_accessor :segments, :test
+    attr_reader   :client_number,
+                  :operating_subsidiary,
+                  :file_creation_number,
+                  :creation_date,
+                  :processing_centre,
+                  :currency
+
+    def initialize(client_number:,
+                   file_creation_number:,
+                   processing_centre:,
+                   operating_subsidiary: nil,
+                   creation_date: Date.Today,
+                   currency: DEFAULT_CURRENCY,
+                   test: false)
+      @segments = []
+      @client_number        = client_number
+      @operating_subsidiary = operating_subsidiary
+      @file_creation_number = file_creation_number
+      @creation_date        = creation_date
+      @processing_centre    = processing_centre
+      @currency             = currency.upcase
+      @test                 = test
+    end
+
+    def file_output
+      header_record + line_records
+    end
+
+    # BASE CLASS OVERRIDES
+    def header_record
+      'A' +
+      zero_padded('1', 9) +
+      client_number_with_subsidiary +
+      formatted_file_creation_number +
+      file_creation_date +
+      zero_padded(processing_centre, 5) +
+      space_padded(nil, 20) +
+      ensure_length(currency, 3).upcase +
+      space_padded(nil, 1406)
+    end
+
+    def trailer_record
+      'Z' +
+      zero_padded(trailer_record_number, 9) +
+      client_number_with_subsidiary +
+      formatted_file_creation_number +
+      zero_padded(total_amount_cents, 14) +
+      zero_padded(@segments.size, 8) +
+      zero_padded(nil, 1418)
+    end
+
+    def add_segment(customer_name:, customer_number:, amount_cents:, payment_date:,
+                    institution:, transit:, account_number:,
+                    transaction_code: nil, client_short_name: nil, client_long_name: nil,
+                    client_sundry_info: nil, client_number: nil, operating_subsidiary: nil)
+
+      client_number        ||= @client_number
+      operating_subsidiary ||= @operating_subsidiary
+      client_short_name    ||= @client_short_name
+      client_long_name     ||= @client_long_name
+
+      segment = Segment.new customer_name: customer_name,
+                            customer_number: customer_number,
+                            amount_cents: amount_cents,
+                            payment_date: payment_date,
+                            institution: institution,
+                            transit: transit,
+                            account_number: account_number,
+                            transaction_code: transaction_code,
+                            client_short_name: client_short_name,
+                            client_long_name: client_long_name,
+                            client_sundry_info: client_sundry_info,
+                            client_number: client_number,
+                            operating_subsidiary: operating_subsidiary
+
+      @segments << segment
+      segment
+    end
+
+    def basic_records
+      output = []
+
+      segments.each_with_index do |segment, i|
+        output << '' if output[-1].nil? || output[-1].length == RECORD_LENGTH
+
+        # add record header
+        if i % 6 == 0
+          record_number = (i / 6) + 2
+          output[-1] += "D" + zero_padded(record_number, 9) +
+                        client_number_with_subsidiary + formatted_file_creation_number
+        end
+
+        output[-1] += segment.to_s
+      end
+
+      # fill last row with blank segments
+      unless output[-1].nil?
+        while output[-1].length < RECORD_LENGTH
+          output[-1] += Segment.blank_values
+        end
+      end
+
+      output
+    end
+
+    def to_s
+      header_record + "\n" + basic_records.join("\n") + "\n" + trailer_record
+    end
+    alias_method :output, :to_s
+
+    private
+
+    def total_amount_cents
+      @segments.map {|s| s.amount_cents}.reduce(0, :+)
+    end
+
+    def basic_record_count
+      # Basic records contain 6 segments
+      (@segments.count / 6.0).ceil.to_i
+    end
+
+    def trailer_record_number
+      basic_record_count + 2
+    end
+
+    def client_number_with_subsidiary
+      ensure_length(client_number, 6) + zero_padded(operating_subsidiary, 4)
+    end
+
+    def file_creation_date
+      padded_date(creation_date, 6)
+    end
+
+    def formatted_file_creation_number
+      (test ? 'TEST' : zero_padded(file_creation_number, 4))
+    end
+  end
+end

data/lib/canada_payment/eft/cpa005/debit/segment.rb

@@ -0,0 +1,107 @@
+module CanadaPayment::EFT::CPA005::Debit
+  class Segment
+    include CanadaPayment::EFT::Helper
+    DEFAULT_TRANSACTION_CODE = 450
+
+    attr_accessor :transaction_code,
+                  :amount_cents,
+                  :payment_date,
+                  :institution,
+                  :transit,
+                  :account_number,
+                  :client_short_name,
+                  :client_long_name,
+                  :client_sundry_info,
+                  :client_number,
+                  :operating_subsidiary,
+                  :customer_name,
+                  :customer_number
+
+    def initialize(transaction_code: nil,
+                   amount_cents:,
+                   payment_date:,
+                   institution:,
+                   transit:,
+                   account_number:,
+                   client_short_name:,
+                   client_long_name:,
+                   client_sundry_info: nil,
+                   client_number:,
+                   operating_subsidiary: nil,
+                   customer_name:,
+                   customer_number:)
+      @transaction_code     = transaction_code || DEFAULT_TRANSACTION_CODE
+      @amount_cents         = amount_cents
+      @payment_date         = payment_date
+      @institution          = institution
+      @transit              = transit
+      @account_number       = account_number
+      @client_short_name    = client_short_name
+      @client_long_name     = client_long_name
+      @client_sundry_info   = client_sundry_info
+      @client_number        = client_number
+      @operating_subsidiary = operating_subsidiary
+      @customer_name        = customer_name
+      @customer_number      = customer_number
+    end
+
+    def to_s
+      formatted_transaction_code +
+      formatted_amount +
+      padded_date(@payment_date, 6) +
+      zero_padded(@institution, 4) +
+      zero_padded(@transit, 5) +
+      space_padded(@account_number, 12) +
+      "0" * 22 +
+      "0" * 3 +
+      space_padded(@client_short_name, 15) +
+      space_padded(@customer_name, 30) +
+      space_padded(@client_long_name, 30) +
+      client_number_with_subsidiary +
+      space_padded(@customer_number, 19) +
+      "0" * 9 +
+      " " * 12 +
+      space_padded(@client_sundry_info, 15) +
+      " " * 22 +
+      " " * 2 +
+      " " * 11
+    end
+    alias_method :output, :to_s
+
+    def self.blank_values
+      ' ' * 3 +
+      '0' * 10 +
+      '0' * 6 +
+      '0' * 9 +
+      ' ' * 12 +
+      '0' * 22 +
+      '0' * 3 +
+      ' ' * 15 +
+      ' ' * 30 +
+      ' ' * 30 +
+      ' ' * 10 +
+      ' ' * 19 +
+      '0' * 9 +
+      ' ' * 12 +
+      ' ' * 15 +
+      ' ' * 22 +
+      ' ' * 2 +
+      ' ' * 11
+    end
+
+    private
+
+    def formatted_transaction_code
+      @transaction_code.to_s != '' ? zero_padded(@transaction_code.to_s, 3) : ' ' * 3
+    end
+
+    def formatted_amount
+      raise ArgumentError.new("`amount_cents` must be an Integer") unless @amount_cents.is_a?(Integer)
+      zero_padded(@amount_cents.to_s, 10)
+    end
+
+    def client_number_with_subsidiary
+      ensure_length(client_number, 6) + zero_padded(operating_subsidiary, 4)
+    end
+  end
+end

data/lib/canada_payment/eft/helper.rb

@@ -0,0 +1,31 @@
+module CanadaPayment::EFT::Helper
+  def zero_padded(value, length, justify: :right)
+    char_padded(value, length, "0", justify)
+  end
+
+  def space_padded(value, length, justify: :left)
+    char_padded(value, length, " ", justify)
+  end
+
+  def char_padded(value, length, char, justify = :right)
+    value = value.to_s
+    raise ArgumentError.new("'#{value}' is longer than #{length} characters.") if value.length > length
+
+    case justify.to_sym
+    when :right
+      value.rjust(length, char)
+    when :left
+      value.ljust(length, char)
+    end
+  end
+
+  def ensure_length(value, length)
+    value = value.to_s
+    raise ArgumentError.new("'#{value}' should be exactly #{length} characters long.") if value.length != length
+    value
+  end
+
+  def padded_date(date, length)
+    zero_padded(date.year.to_s[-2..-1] + zero_padded(date.yday, 3), length)
+  end
+end

data/lib/canada_payment/version.rb

@@ -0,0 +1,3 @@
+module CanadaPayment
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: canada_payment
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Carl Mercier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This library allows you to easily create ACH/EFT CPA005 files from Ruby.
+email:
+- foss@carlmercier.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- canada_payment.gemspec
+- docs/layouts.md
+- lib/canada_payment.rb
+- lib/canada_payment/eft.rb
+- lib/canada_payment/eft/cpa005.rb
+- lib/canada_payment/eft/cpa005/credit/file.rb
+- lib/canada_payment/eft/cpa005/credit/line.rb
+- lib/canada_payment/eft/cpa005/debit/file.rb
+- lib/canada_payment/eft/cpa005/debit/segment.rb
+- lib/canada_payment/eft/helper.rb
+- lib/canada_payment/version.rb
+homepage: https://gitlab.com/cmer/canada_payment
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Canadian ACH/EFT files in Ruby
+test_files: []