china_bank-payroll_text_file 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cc594d65bfd78ce8a6b3d251f591cbe5f58c1e5
+  data.tar.gz: cbe63b5572f57a9d389ed558ac1f6b4413ccff3a
+SHA512:
+  metadata.gz: 3b9f428189caefca67dfa23f03af00e5d0f82a793e8ff1980d8865a4eb10e741412c4990a7a87d38979d34bf25ec1ceb76db582ee0f054cc53eebb038e1c46dc
+  data.tar.gz: abf297f6a758e51b71802d1800ae57906211473445fbdc040ba224afe4e67bd5ddcc13e14c03bbfbddc46951823301ad688e0b1e9655265e46038596fc7b34c4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+  - 2.2.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014, PayrollHero PTE. Ltd. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that
+the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
+following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
+following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or
+promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGE.

data/README.md

@@ -0,0 +1,56 @@
+# ChinaBank::PayrollTextFile
+
+[![Gem Version](https://badge.fury.io/rb/china_bank-payroll_text_file.svg)](http://badge.fury.io/rb/china_bank-payroll_text_file)
+[![Code Climate](https://codeclimate.com/github/payrollhero/china_bank-payroll_text_file/badges/gpa.svg)](https://codeclimate.com/github/payrollhero/china_bank-payroll_text_file)
+[![Build Status](https://travis-ci.org/payrollhero/china_bank-payroll_text_file.svg)](https://travis-ci.org/payrollhero/china_bank-payroll_text_file)
+
+A payroll text file generator for China Bank. This specifically supports the format [China Bank Auto
+Credit Arrangement (ACA)](http://www.chinabank.ph/business.aspx?title=China+Bank+Auto+Credit+Arrangement+%28ACA%29) requires.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'china_bank-payroll_text_file'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install china_bank-payroll_text_file
+
+## Usage
+
+```ruby
+    file = ChinaBank::PayrollTextFile.generate account_type: "SA",
+                                               account_number: "1850889513",
+                                               bank_code: "102",
+                                               transactions: [
+                                                 {
+                                                   account_type: "CA",
+                                                   account_number: "2030347812",
+                                                   bank_code: "102",
+                                                   amount: BigDecimal("12965.50")
+                                                 }
+                                               ]
+
+    file.content #=> "*CA2030347812   00000012965.50 C102*\r\n*SA1850889513   00000012965.50 D102*"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/china_bank-payroll_text_file/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+end

data/bin/console

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

data/bin/setup

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

data/china_bank-payroll_text_file.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'china_bank/payroll_text_file/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "china_bank-payroll_text_file"
+  spec.version       = ChinaBank::PayrollTextFile::VERSION
+  spec.authors       = ["Ronald Maravilla"]
+  spec.email         = ["rmaravilla@payrollhero.com"]
+
+  spec.summary       = %q{A payroll text file generator for China Bank}
+  spec.description   = %q{A payroll text file generator for China Bank}
+  spec.homepage      = "https://github.com/payrollhero/china_bank-payroll_text_file"
+  spec.license       = "BSD-3-Clause"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "activemodel"
+end

data/lib/china_bank/payroll_text_file.rb

@@ -0,0 +1,36 @@
+require "china_bank/payroll_text_file/version"
+require "bigdecimal"
+require "active_support"
+
+module ChinaBank
+  # Generates a payroll text file compatible with China Bank Auto Credit Arrangement (ACA).
+  #
+  # @example:
+  #   ChinaBank::PayrollTextFile.generate account_number: ,
+  #                                       account_type: ,
+  #                                       branch_code: ,
+  #                                       transaction_type: ,
+  #                                       transactions: [
+  #                                         {
+  #                                           amount: ,
+  #                                           account_number: ,
+  #                                           account_type: ,
+  #                                           branch_code: ,
+  #                                           transaction_type:
+  #                                         }
+  #                                       ]
+  module PayrollTextFile
+    extend ActiveSupport::Autoload
+
+    autoload :File
+    autoload :Line
+
+    class << self
+      # @param [Hash] options
+      # @return [ChinaBank::PayrollTextFile::File]
+      def generate(**options)
+        File.new options
+      end
+    end
+  end
+end

data/lib/china_bank/payroll_text_file/file.rb

@@ -0,0 +1,54 @@
+require "active_support/core_ext/enumerable"
+
+module ChinaBank
+  module PayrollTextFile
+    # Describes the payroll text file's content including the lines that builds it.
+    class File
+      # @param [String] account_number
+      # @param [String] account_type
+      # @param [String] bank_code
+      # @param [Array<Hash>] transactions
+      def initialize(account_number:, account_type: "00", bank_code: "888", transactions: [])
+        @account_number = account_number
+        @account_type = account_type
+        @bank_code = bank_code
+        @transactions = transactions
+      end
+
+      # @return [String]
+      def content
+        (credit_lines + [debit_line]).join(new_line) + new_line
+      end
+
+      # @return [Array<ChinaBank::PayrollTextFile::Line>
+      def credit_lines
+        transactions.map { |transaction| Line.new transaction.merge(transaction_type: Line::TYPES[:credit]) }
+      end
+
+      # @return [ChinaBank::PayrollTextFile::Line]
+      def debit_line
+        Line.new account_number: account_number,
+                 account_type: account_type,
+                 bank_code: bank_code,
+                 transaction_type: Line::TYPES[:debit],
+                 amount: total
+      end
+
+      private
+
+      attr_reader :account_number,
+                  :account_type,
+                  :bank_code,
+                  :transaction_type,
+                  :transactions
+
+      def total
+        transactions.sum(BigDecimal 0) { |transaction| transaction.fetch :amount }
+      end
+
+      def new_line
+        "\r\n"
+      end
+    end
+  end
+end

data/lib/china_bank/payroll_text_file/line.rb

@@ -0,0 +1,78 @@
+require "active_model"
+
+module ChinaBank
+  module PayrollTextFile
+    # Describes each line on China Bank's payroll text file.
+    class Line
+      include ActiveModel::Model
+
+      AMOUNT_RANGE = BigDecimal("0").. BigDecimal("99999999999.99")
+      TYPES = {
+        credit: "C",
+        debit: "D"
+      }
+
+      attr_accessor :account_type,
+                    :account_number,
+                    :amount,
+                    :transaction_type,
+                    :bank_code
+
+      validates :account_type, inclusion: { in: ["CA", "SA", "00"], message: "must be either CA, SA, or 00" }
+      validates :account_number, length: { in: 10..12 }, numericality: { only_integer: true }
+      validates :amount, inclusion: { in: AMOUNT_RANGE, message: "must be between 0.00 to 99,999,999,999.99" }
+      validates :transaction_type, inclusion: { in: TYPES.values, message: "must be either C or D" }
+      validates :bank_code, length: { is: 3 }, numericality: { only_integer: true }
+      validates :account_type, :account_number, :amount, :transaction_type, :bank_code, presence: true
+
+      # @param [String] account_type
+      # @param [String] account_number
+      # @param [BigDecimal] amount
+      # @param [String] transaction_type
+      # @param [String] bank_code
+      def initialize(account_type: "00", account_number:, amount:, transaction_type:, bank_code: "888")
+        @account_number = account_number
+        @account_type = account_type
+        @bank_code = bank_code
+        @transaction_type = transaction_type
+        @amount = BigDecimal(amount.to_s)
+
+        raise ArgumentError, errors.full_messages.to_sentence unless valid?
+      end
+
+      # @example: "*SA1850889513   00000053931.70 D102*"
+      # @return [String]
+      def to_s
+        [
+          terminator_character,     # "*"
+          account_type,             # "SA"
+          formatted_account_number, # "1850889513  "
+          spacer,                   # " "
+          formatted_amount,         # 00000053931.70
+          spacer,                   # " "
+          transaction_type,         # "D"
+          bank_code,                # "102"
+          terminator_character      # "*"
+        ].join
+      end
+
+      private
+
+      def terminator_character
+        "*"
+      end
+
+      def spacer
+        " "
+      end
+
+      def formatted_account_number
+        account_number.ljust(12)
+      end
+
+      def formatted_amount
+        "%014.2f" % amount
+      end
+    end
+  end
+end

data/lib/china_bank/payroll_text_file/version.rb

@@ -0,0 +1,5 @@
+module ChinaBank
+  module PayrollTextFile
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: china_bank-payroll_text_file
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ronald Maravilla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-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.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: activemodel
+  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'
+description: A payroll text file generator for China Bank
+email:
+- rmaravilla@payrollhero.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- china_bank-payroll_text_file.gemspec
+- lib/china_bank/payroll_text_file.rb
+- lib/china_bank/payroll_text_file/file.rb
+- lib/china_bank/payroll_text_file/line.rb
+- lib/china_bank/payroll_text_file/version.rb
+- lib/references/China Bank ACA File Structure Specs.xlsx
+homepage: https://github.com/payrollhero/china_bank-payroll_text_file
+licenses:
+- BSD-3-Clause
+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.2.3
+signing_key: 
+specification_version: 4
+summary: A payroll text file generator for China Bank
+test_files: []
+has_rdoc: