banktools-gb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7844b2232f6e8f4a3abb4cda46f17b31eab9991
+  data.tar.gz: 45f58057f06de492845f3f67a2f94f0a2dd5c7c1
+SHA512:
+  metadata.gz: a7f830e8b6dbe17967ba61e871a7f2c7dc5167015c77cb78f2d578c8b55e086b74845335b3cad8267b22c63ed664b2de42def0e2e99c79adfff327c402a825a9
+  data.tar.gz: 4808daee629b2f70ae7345ca72039228ce564ce5e8d8f6e4dbcbaf35ae204644dc900407c3f92db62ccc7a80a3c31306d0950027eb6b6c9a01ce3e73d328da59

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/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in banktools-gb.gemspec
+gemspec
+
+gem "uk_account_validator", github: "ball-hayden/uk_account_validator"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Auctionet.com
+
+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,66 @@
+# United Kingdom banktools
+
+Ruby gem to validate and normalize United Kingdom bank account numbers.
+
+If we got anything wrong, please file an issue or contribute a fix yourself.
+
+## Usage
+
+    account = BankTools::GB::AccountNumberWithSortCode.new(account_number: "31926819", sort_code: "60-16-13")
+    account.valid?  # => true
+    account.errors  # => []
+
+    bad_account = BankTools::GB::AccountNumberWithSortCode.new(account_number: "1", sort_code: "")
+    bad_account.valid?  # => false
+    bad_account.errors  # => [:too_short]
+
+    # Error codes
+
+    BankTools::GB::Errors::ACCOUNT_NUMBER_TOO_SHORT                # => :account_number_too_short
+    BankTools::GB::Errors::ACCOUNT_NUMBER_TOO_LONG                 # => :account_number_too_long
+    BankTools::GB::Errors::SORT_CODE_WITH_WRONG_LENGTH             # => :sort_code_with_wrong_length
+    BankTools::GB::Errors::ACCOUNT_NUMBER_INVALID_CHARACTERS       # => :account_number_invalid_characters
+    BankTools::GB::Errors::SORT_CODE_INVALID_CHARACTERS            # => :sort_code_invalid_characters
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "banktools-gb"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install banktools-gb
+
+## Tests
+
+    bundle
+    rspec  # or: rake
+
+## TODO
+
+* Make separation between sort code and account number less naive (could possible be fixed by normalisation).
+* Add errors
+* Mooore tests!
+
+## Also see
+
+* [BankTools::SE (Swedish)](https://github.com/barsoom/banktools-se)
+* [BankTools::DE (German)](https://github.com/barsoom/banktools-de)
+* [BankTools::DK (German)](https://github.com/barsoom/banktools-dk)
+
+## Credits
+
+* [Hayden Ball](https://github.com/ball-hayden) for creating [UkAccountValidator](https://github.com/ball-hayden/uk_account_validator) that we base this gem on.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/banktools-gb.
+
+## 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/banktools-gb.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "banktools-gb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "banktools-gb"
+  spec.version       = Banktools::Gb::VERSION
+  spec.authors       = ["Tomas Skogberg"]
+  spec.email         = ["tomas@auctionet.com"]
+
+  spec.summary       = %q{Validate and normalise United Kingdom bank account numbers.}
+  spec.homepage      = "https://github.com/barsoom/banktools-gb"
+  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_dependency "uk_account_validator", "~> 0.0.3"
+  spec.add_dependency "attr_extras", "~> 4.6"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 11"
+  spec.add_development_dependency "rspec", "~> 3"
+end

data/bin/console

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

@@ -0,0 +1,60 @@
+require "attr_extras/explicit"
+require "banktools-gb/errors"
+
+module BankTools
+  module GB
+    class AccountNumberWithSortCode
+      extend AttrExtras.mixin
+
+      ACCOUNT_NUMBER_MIN_LENGTH = 6
+      ACCOUNT_NUMBER_MAX_LENGTH = 10
+      SORT_CODE_LENGTH = 6
+
+      pattr_initialize [ :account_number, :sort_code ]
+
+      def valid?
+        UkAccountValidator::Validator.new(compact_account_number, compact_sort_code).valid?
+      end
+
+      def errors
+        errors = []
+        errors << :account_number_too_short if account_number_too_short?
+        errors << :account_number_too_long if account_number_too_long?
+        errors << :sort_code_with_wrong_length if sort_code_with_wrong_length?
+        errors << :sort_code_invalid_characters if any_non_digits?(compact_sort_code)
+        errors << :account_number_invalid_characters if any_non_digits?(compact_account_number)
+        errors
+      end
+
+      private
+
+      def sort_code_with_wrong_length?
+        compact_sort_code.length != SORT_CODE_LENGTH
+      end
+
+      def account_number_too_short?
+        compact_account_number.length < ACCOUNT_NUMBER_MIN_LENGTH
+      end
+
+      def account_number_too_long?
+        compact_account_number.length > ACCOUNT_NUMBER_MAX_LENGTH
+      end
+
+      def any_non_digits?(number)
+        number.match(/\D/)
+      end
+
+      def compact_sort_code
+        compact(sort_code)
+      end
+
+      def compact_account_number
+        compact(account_number)
+      end
+
+      def compact(number)
+        number.gsub(/[\s-]/, "")
+      end
+    end
+  end
+end

data/lib/banktools-gb/errors.rb

@@ -0,0 +1,11 @@
+module Banktools
+  module GB
+    module Errors
+      ACCOUNT_NUMBER_TOO_SHORT = :account_number_too_short
+      ACCOUNT_NUMBER_TOO_LONG = :account_number_too_long
+      SORT_CODE_WITH_WRONG_LENGTH = :sort_code_with_wrong_length
+      SORT_CODE_INVALID_CHARACTERS = :sort_code_invalid_characters
+      ACCOUNT_NUMBER_INVALID_CHARACTERS = :account_number_invalid_characters
+    end
+  end
+end

data/lib/banktools-gb/version.rb

@@ -0,0 +1,5 @@
+module Banktools
+  module Gb
+    VERSION = "0.1.0"
+  end
+end

data/lib/banktools-gb.rb

@@ -0,0 +1,5 @@
+require "uk_account_validator"
+
+require "banktools-gb/version"
+require "banktools-gb/account_number_with_sort_code"
+require "banktools-gb/errors"

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: banktools-gb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Skogberg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uk_account_validator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: attr_extras
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: 
+email:
+- tomas@auctionet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- banktools-gb.gemspec
+- bin/console
+- bin/setup
+- lib/banktools-gb.rb
+- lib/banktools-gb/account_number_with_sort_code.rb
+- lib/banktools-gb/errors.rb
+- lib/banktools-gb/version.rb
+homepage: https://github.com/barsoom/banktools-gb
+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 and normalise United Kingdom bank account numbers.
+test_files: []