nz_bank_account_validator 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c851a0b46247ae865d59bac22f1c982b58cc1422
+  data.tar.gz: 8afecdcd65e79a97950894874a70b21144babb11
+SHA512:
+  metadata.gz: 9b51753e2f12832625ae6bc7d3f698a2c791a60e1a7be4a9e3af96a55d173bc1b16082c61d7b242df40e23fdcfdc92cbe240fa5236674dce1219e90ad99072b2
+  data.tar.gz: edb846b0d34f07dc14232f64e4596f7f2ed190c86f76d31dd57dd38ebde1ead06bd2de2a04596ddabeba5a70a735d2bccf19e09c1e7e73381713d832b2e8431e

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CHANGELOG.txt

@@ -0,0 +1,8 @@
+0.9.0 - Add new ranges from updated IRD document
+        Use new RSpec syntax
+        Accept a string of a full bank account number rather than a collection of parts
+        Add class method to validate without instantiating
+        Rename gem
+0.0.3 - Bugfix
+0.0.2 - Never happened
+0.0.1 - Initial Release

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Steve Hoeksema
+
+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,42 @@
+# NzBankAccountValidator
+
+An implementation of the process described on page 10 of the [IRD RWT - NRWT 2008 Specification](https://www.ird.govt.nz/resources/d/8/d8e49dce-1bda-4875-8acf-9ebf908c6e17/rwt-nrwt-spec-2014.pdf).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "nz_bank_account_validator"
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install nz_bank_account_validator
+
+
+## Usage
+
+    NzBankAccountValidator.valid?(string)
+
+
+## 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/steveh/nz_bank_account_validator.
+
+
+## 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 "nz_bank_account_validator"
+
+# 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,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/nz_bank_account_validator.rb

@@ -0,0 +1,132 @@
+require "nz_bank_account_validator/version"
+
+# frozen_string_literal: true
+class NzBankAccountValidator
+  PATTERN = /\A^(?<bank_id>\d{1,2})[- ]?(?<bank_branch>\d{1,4})[- ]?(?<account_base_number>\d{1,8})[- ]?(?<account_suffix>\d{1,4})\z/
+
+  RADIX = 10
+
+  CHECKSUM_DIGITS = 18
+
+  ACCOUNT_BASE_NUMBER_CUTOFF = 990000
+
+  BANKS = { 1 => { ranges: [1..999, 1100..1199, 1800..1899] },
+            2 => { ranges: [1..999, 1200..1299] },
+            3 => { ranges: [1..999, 1300..1399, 1500..1599, 1700..1799, 1900..1999] },
+            6 => { ranges: [1..999, 1400..1499] },
+            8 => { ranges: [6500..6599], algo: :d },
+            9 => { ranges: [], algo: :e }, # range was 0000
+            11 => { ranges: [5000..6499, 6600..8999] },
+            12 => { ranges: [3000..3299, 3400..3499, 3600..3699] },
+            13 => { ranges: [4900..4999] },
+            14 => { ranges: [4700..4799] },
+            15 => { ranges: [3900..3999] },
+            16 => { ranges: [4400..4499] },
+            17 => { ranges: [3300..3399] },
+            18 => { ranges: [3500..3599] },
+            19 => { ranges: [4600..4649] },
+            20 => { ranges: [4100..4199] },
+            21 => { ranges: [4800..4899] },
+            22 => { ranges: [4000..4049] },
+            23 => { ranges: [3700..3799] },
+            24 => { ranges: [4300..4349] },
+            25 => { ranges: [2500..2599], algo: :f },
+            26 => { ranges: [2600..2699], algo: :g },
+            27 => { ranges: [3800..3849] },
+            28 => { ranges: [2100..2149], algo: :g },
+            29 => { ranges: [2150..2299], algo: :g },
+            30 => { ranges: [2900..2949] },
+            31 => { ranges: [2800..2849], algo: :x },
+            33 => { ranges: [6700..6799], algo: :f },
+            35 => { ranges: [2400..2499] },
+            38 => { ranges: [9000..9499] } }.freeze
+
+  ALGOS = {
+    a: [0, 0, 6, 3, 7, 9, 0, 0, 10, 5, 8, 4, 2, 1, 0, 0, 0, 0, 11],
+    b: [0, 0, 0, 0, 0, 0, 0, 0, 10, 5, 8, 4, 2, 1, 0, 0, 0, 0, 11],
+    c: [3, 7, 0, 0, 0, 0, 9, 1, 10, 5, 3, 4, 2, 1, 0, 0, 0, 0, 11],
+    d: [0, 0, 0, 0, 0, 0, 0, 7,  6, 5, 4, 3, 2, 1, 0, 0, 0, 0, 11],
+    e: [0, 0, 0, 0, 0, 0, 0, 0,  0, 0, 5, 4, 3, 2, 0, 0, 0, 1, 11],
+    f: [0, 0, 0, 0, 0, 0, 0, 1,  7, 3, 1, 7, 3, 1, 0, 0, 0, 0, 10],
+    g: [0, 0, 0, 0, 0, 0, 0, 1,  3, 7, 1, 3, 7, 1, 0, 3, 7, 1, 10],
+    x: [0, 0, 0, 0, 0, 0, 0, 0,  0, 0, 0, 0, 0, 0, 0, 0, 0, 0,  1],
+  }.freeze
+
+  def self.valid?(string)
+    new(string).valid?
+  end
+
+  def initialize(string)
+    match = string.match(PATTERN)
+
+    if match
+      @bank_id = Integer(match[:bank_id], RADIX)
+      @bank_branch = Integer(match[:bank_branch], RADIX)
+      @account_base_number = Integer(match[:account_base_number], RADIX)
+      @account_suffix = Integer(match[:account_suffix], RADIX)
+    end
+  end
+
+  attr_accessor :bank_id, :bank_branch, :account_base_number, :account_suffix
+
+  def valid?
+    return false unless valid_bank_id?
+    return false unless valid_bank_branch?
+    return false unless account_base_number
+    return false unless account_suffix
+    return false unless valid_modulo?
+    true
+  end
+
+  def valid_bank_id?
+    return false unless bank_id
+
+    BANKS.key?(bank_id)
+  end
+
+  def valid_bank_branch?
+    return false unless valid_bank_id?
+    return false unless bank_branch
+
+    if BANKS[bank_id][:ranges].empty?
+      # Bank 9. Anything is valid? # TODO: confirm
+      true
+    else
+      BANKS[bank_id][:ranges].any? do |range|
+        range.include?(bank_branch)
+      end
+    end
+  end
+
+  def valid_modulo?
+    (checksum % algo[CHECKSUM_DIGITS]).zero?
+  end
+
+  def algo_code
+    # If the account base number is below 00990000 then apply algorithm A
+    # Otherwise apply algorithm B.
+    BANKS[bank_id][:algo] || (account_base_number < ACCOUNT_BASE_NUMBER_CUTOFF ? :a : :b)
+  end
+
+  def algo
+    ALGOS[algo_code]
+  end
+
+  def number_for_checksum
+    format("%02d%04d%08d%04d", bank_id, bank_branch, account_base_number, account_suffix)
+  end
+
+  def checksum
+    if [:e, :g].include?(algo_code)
+      (0...CHECKSUM_DIGITS).inject(0) do |sum, index|
+        s = number_for_checksum[index].to_i * algo[index]
+        2.times { s = s.to_s.chars.map(&:to_i).inject(:+) }
+        sum + s
+      end
+    else
+      (0...CHECKSUM_DIGITS).inject(0) do |sum, index|
+        sum + number_for_checksum[index].to_i * algo[index]
+      end
+    end
+  end
+end

data/lib/nz_bank_account_validator/version.rb

@@ -0,0 +1,3 @@
+class NzBankAccountValidator
+  VERSION = "0.9.0"
+end

data/validate_nz_bank_acc.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nz_bank_account_validator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nz_bank_account_validator"
+  spec.version       = NzBankAccountValidator::VERSION
+  spec.authors       = ["Steve Hoeksema", "Eaden McKee"]
+  spec.email         = ["steve@kotiri.com"]
+  spec.summary       = "Validate a New Zealand bank account number according to IRD specifications"
+  spec.description   = "Validate a New Zealand bank account number according to IRD specifications"
+  spec.homepage      = "https://github.com/steveh/nz_bank_account_validator"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: nz_bank_account_validator
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Steve Hoeksema
+- Eaden McKee
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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: rake
+  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: 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'
+description: Validate a New Zealand bank account number according to IRD specifications
+email:
+- steve@kotiri.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.txt
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nz_bank_account_validator.rb
+- lib/nz_bank_account_validator/version.rb
+- validate_nz_bank_acc.gemspec
+homepage: https://github.com/steveh/nz_bank_account_validator
+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.1
+signing_key: 
+specification_version: 4
+summary: Validate a New Zealand bank account number according to IRD specifications
+test_files: []