banktools-gb 0.5.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0f3e7f61bc8d6f56034536be0c064e6cf1f7d18
-  data.tar.gz: bb3a03b154524de3daed3de0d75513236b4541c8
+  metadata.gz: ffdb9dce789b6c5c38ef0e3178ee9a3e80172267
+  data.tar.gz: 2753c4af90e0ebb2b7bdd4ac45dc67648139729b
 SHA512:
-  metadata.gz: 9a57461e8877d93410799c501e87d06cd995d9c92519f29731d3fdcef79c3450d43a0b23f2f4a0d8a149d5d7f9248ee711b15f7731de935855d51372abbf470a
-  data.tar.gz: f7e80fe6f3758b54ab86cd6f452172537fa0f684517313cce0b619a8b84b40e68824b1a201a6295695c8f7a46487dc14e5a320e5d5ac4ace2f909f4759b9e160
+  metadata.gz: e493caa282cadc173b55f63ca09eda5ac1ffb248b9ff882e355adb347e1978561321eaa25ec4c20895baa869816b9962bce1cf84ec6371cb23cb776b3c171987
+  data.tar.gz: 3f77553a66f5234082d2b2b150ebb3e4876939b4778ec1c699d26f2256d70151c8a833220342296f004df5d1398085aab77cf7ba1747b7162183b3d33a68b57e

data/README.md

@@ -2,28 +2,45 @@
 
 [![Build Status](https://travis-ci.org/barsoom/banktools-gb.svg?branch=master)](https://travis-ci.org/barsoom/banktools-gb)
 
-Ruby gem to validate United Kingdom bank account numbers.
+Ruby gem to validate United Kingdom sort codes and bank account numbers.
+
+When in doubt, this library aims to err on the side of allowing too much.
 
 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")
+    # Sort code
+
+    sort_code = BankTools::GB::SortCode.new("60-16-13")
+    sort_code.valid?  # => true
+    sort_code.errors  # => []
+
+    bad_sort_code = BankTools::GB::SortCode.new("1X")
+    bad_sort_code.valid?  # => false
+    bad_sort_code.errors  # => [ :too_short, :invalid_characters ]
+
+    # Account
+
+    account = BankTools::GB::Account.new("31926819")
     account.valid?  # => true
     account.errors  # => []
 
-    bad_account = BankTools::GB::AccountNumberWithSortCode.new(account_number: "1", sort_code: "")
+    bad_account = BankTools::GB::Account.new("1")
     bad_account.valid?  # => false
-    bad_account.errors  # => [:account_number_is_too_short]
+    bad_account.errors  # => [ :too_short ]
 
-    # Error codes
 
-    BankTools::GB::Errors::ACCOUNT_NUMBER_IS_TOO_SHORT              # => :account_number_is_too_short
-    BankTools::GB::Errors::ACCOUNT_NUMBER_IS_TOO_LONG               # => :account_number_is_too_long
-    BankTools::GB::Errors::SORT_CODE_WITH_WRONG_LENGTH              # => :sort_code_with_wrong_length
-    BankTools::GB::Errors::ACCOUNT_NUMBER_WITH_INVALID_CHARACTERS   # => :account_number_with_invalid_characters
-    BankTools::GB::Errors::SORT_CODE_WITH_INVALID_CHARACTERS        # => :sort_code_with_invalid_characters
-    BankTools::GB::Errors::ACCOUNT_NUMBER_DOES_NOT_MATCH_SORT_CODE  # => :account_number_does_not_match_sort_code
+    # Account and sort code (checksum check and others)
+    # This relies on [our fork of the uk_account_validator gem](https://github.com/barsoom/uk_account_validator). If that gem is out of date, the checksum check may be also.
+
+    account_and_sort_code = BankTools::GB::AccountNumberAndSortCode.new(account_number_original_value: 14248387, sort_code_original_value: 405161).valid?
+    account_and_sort_code.valid?  # => true
+    account_and_sort_code.errors  # => []
+
+    account_and_sort_code = BankTools::GB::AccountNumberAndSortCode.new(account_number_original_value: 14248387, sort_code_original_value: "xx")
+    account_and_sort_code.valid?  # => false
+    account_and_sort_code.errors  # => [:sort_code_too_short, :sort_code_invalid_characters, :bad_checksum]
 
 ## Installation
 
@@ -46,18 +63,13 @@ Or install it yourself as:
 
 ## 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)
+* [Our other BankTools](https://github.com/barsoom?q=banktools)
+* [BanklineCsvImportFile](https://github.com/barsoom/bankline_csv_import_file)
 
 ## 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/banktools-gb.gemspec

@@ -5,7 +5,7 @@ require "banktools-gb/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "banktools-gb"
-  spec.version       = Banktools::Gb::VERSION
+  spec.version       = BankTools::GB::VERSION
   spec.authors       = ["Tomas Skogberg"]
   spec.email         = ["tomas@auctionet.com"]
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "uk_account_validator", "~> 0"
+  spec.add_dependency "uk_account_validator_auctionet", "~> 0"
   spec.add_dependency "attr_extras", "~> 5"
 
   spec.add_development_dependency "bundler", "~> 1"

data/lib/banktools-gb.rb

@@ -1,5 +1,6 @@
 require "uk_account_validator"
 
 require "banktools-gb/version"
-require "banktools-gb/account_number_with_sort_code"
-require "banktools-gb/errors"
+require "banktools-gb/sort_code"
+require "banktools-gb/account"
+require "banktools-gb/account_number_and_sort_code"

data/lib/banktools-gb/account.rb

@@ -0,0 +1,43 @@
+require "attr_extras/explicit"
+require "banktools-gb/errors"
+
+module BankTools
+  module GB
+    class Account
+      extend AttrExtras.mixin
+
+      # Officially, bank accounts in the UK can be between 6 and 10 digits, but
+      # the standard is 8, and any system that receives them will require them to
+      # be zero-padded. Customers should be used to prepend zeroes, and it should not be an issue.
+      # If this becomes an issue, lets consider handling auto-zeropadding, but it is both
+      # less technical issues and easier to give feedback to the user if we enforce the 8 digit length rule.
+      LENGTH = 8
+
+      pattr_initialize :original_value
+
+      def valid?
+        errors.none?
+      end
+
+      def errors
+        errors = []
+
+        errors << Errors::ACCOUNT_TOO_SHORT if compacted_value.length < LENGTH
+        errors << Errors::ACCOUNT_TOO_LONG if compacted_value.length > LENGTH
+        errors << Errors::ACCOUNT_INVALID_CHARACTERS if any_non_digits?
+
+        errors
+      end
+
+      def compacted_value
+        original_value.to_s.gsub(/[\s-]/, "")
+      end
+
+      private
+
+      def any_non_digits?
+        compacted_value.match(/\D/)
+      end
+    end
+  end
+end

data/lib/banktools-gb/account_number_and_sort_code.rb

@@ -0,0 +1,40 @@
+require "attr_extras/explicit"
+require "banktools-gb/errors"
+
+module BankTools
+  module GB
+    class AccountNumberAndSortCode
+      extend AttrExtras.mixin
+
+      pattr_initialize [ :account_number_original_value, :sort_code_original_value ]
+
+      def valid?
+        errors.none?
+      end
+
+      def errors
+        errors = []
+
+        errors << account_number.errors
+        errors << sort_code.errors
+        errors << Errors::BAD_CHECKSUM unless valid_account_number_and_sort_code?
+
+        errors.flatten
+      end
+
+      private
+
+      def account_number
+        Account.new(account_number_original_value)
+      end
+
+      def sort_code
+        SortCode.new(sort_code_original_value)
+      end
+
+      def valid_account_number_and_sort_code?
+        UkAccountValidator::Validator.new(account_number.compacted_value, sort_code.compacted_value).valid?
+      end
+    end
+  end
+end

data/lib/banktools-gb/errors.rb

@@ -1,12 +1,13 @@
-module Banktools
+module BankTools
   module GB
     module Errors
-      ACCOUNT_NUMBER_IS_TOO_SHORT             = :account_number_is_too_short
-      ACCOUNT_NUMBER_IS_TOO_LONG              = :account_number_is_too_long
-      SORT_CODE_WITH_WRONG_LENGTH             = :sort_code_with_wrong_length
-      SORT_CODE_WITH_INVALID_CHARACTERS       = :sort_code_with_invalid_characters
-      ACCOUNT_NUMBER_WITH_INVALID_CHARACTERS  = :account_number_with_invalid_characters
-      ACCOUNT_NUMBER_DOES_NOT_MATCH_SORT_CODE = :account_number_does_not_match_sort_code
+      ACCOUNT_TOO_SHORT            = :account_too_short
+      ACCOUNT_TOO_LONG             = :account_too_long
+      SORT_CODE_TOO_SHORT          = :sort_code_too_short
+      SORT_CODE_TOO_LONG           = :sort_code_too_long
+      ACCOUNT_INVALID_CHARACTERS   = :account_invalid_characters
+      SORT_CODE_INVALID_CHARACTERS = :sort_code_invalid_characters
+      BAD_CHECKSUM                 = :bad_checksum
     end
   end
 end

data/lib/banktools-gb/sort_code.rb

@@ -0,0 +1,38 @@
+require "attr_extras/explicit"
+require "banktools-gb/errors"
+
+module BankTools
+  module GB
+    class SortCode
+      extend AttrExtras.mixin
+
+      LENGTH = 6
+
+      pattr_initialize :original_value
+
+      def valid?
+        errors.none?
+      end
+
+      def errors
+        errors = []
+
+        errors << Errors::SORT_CODE_TOO_SHORT if compacted_value.length < LENGTH
+        errors << Errors::SORT_CODE_TOO_LONG if compacted_value.length > LENGTH
+        errors << Errors::SORT_CODE_INVALID_CHARACTERS if any_non_digits?
+
+        errors
+      end
+
+      def compacted_value
+        original_value.to_s.gsub(/[\s-]/, "")
+      end
+
+      private
+
+      def any_non_digits?
+        compacted_value.match(/\D/)
+      end
+    end
+  end
+end

data/lib/banktools-gb/version.rb

@@ -1,5 +1,5 @@
-module Banktools
-  module Gb
-    VERSION = "0.5.0"
+module BankTools
+  module GB
+    VERSION = "0.11.0"
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: banktools-gb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Tomas Skogberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2018-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: uk_account_validator
+  name: uk_account_validator_auctionet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -98,8 +98,10 @@ files:
 - bin/console
 - bin/setup
 - lib/banktools-gb.rb
-- lib/banktools-gb/account_number_with_sort_code.rb
+- lib/banktools-gb/account.rb
+- lib/banktools-gb/account_number_and_sort_code.rb
 - lib/banktools-gb/errors.rb
+- lib/banktools-gb/sort_code.rb
 - lib/banktools-gb/version.rb
 homepage: https://github.com/barsoom/banktools-gb
 licenses:
@@ -121,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Validate and normalise United Kingdom bank account numbers.

data/lib/banktools-gb/account_number_with_sort_code.rb

@@ -1,65 +0,0 @@
-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?
-        errors.none?
-      end
-
-      def errors
-        errors = []
-        errors << :account_number_is_too_short if account_number_is_too_short?
-        errors << :account_number_is_too_long if account_number_is_too_long?
-        errors << :sort_code_with_wrong_length if sort_code_with_wrong_length?
-        errors << :sort_code_with_invalid_characters if any_non_digits?(compact_sort_code)
-        errors << :account_number_with_invalid_characters if any_non_digits?(compact_account_number)
-        errors << :account_number_does_not_match_sort_code unless valid_account_number_with_sort_code?
-        errors
-      end
-
-      private
-
-      def valid_account_number_with_sort_code?
-        UkAccountValidator::Validator.new(compact_account_number, compact_sort_code).valid?
-      end
-
-      def sort_code_with_wrong_length?
-        compact_sort_code.length != SORT_CODE_LENGTH
-      end
-
-      def account_number_is_too_short?
-        compact_account_number.length < ACCOUNT_NUMBER_MIN_LENGTH
-      end
-
-      def account_number_is_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