banktools-gb 0.5.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c0f3e7f61bc8d6f56034536be0c064e6cf1f7d18
-  data.tar.gz: bb3a03b154524de3daed3de0d75513236b4541c8
+SHA256:
+  metadata.gz: 8f241c891a2df2eb6956201979b16081156a886ca681486b1eeb66756275ba31
+  data.tar.gz: '0975475a825a66dc1b6653a17dd9fa8baa55dd9eac1866c8e140d31590caf62a'
 SHA512:
-  metadata.gz: 9a57461e8877d93410799c501e87d06cd995d9c92519f29731d3fdcef79c3450d43a0b23f2f4a0d8a149d5d7f9248ee711b15f7731de935855d51372abbf470a
-  data.tar.gz: f7e80fe6f3758b54ab86cd6f452172537fa0f684517313cce0b619a8b84b40e68824b1a201a6295695c8f7a46487dc14e5a320e5d5ac4ace2f909f4759b9e160
+  metadata.gz: 1823f38ba139459d6dfde4d1732f14d9e7df62c77b99bede06de3d910a3df70a8df47c2f0e76bba5ea28f93061894499cc6edff816548d9eff0f323774895607
+  data.tar.gz: b89460ed009cd2c14d3c41ab527a183c30bc2a60413216ebce426d7e4d573ef0d7ae624ad1b0e68748faf331819e4e27fc28b518e276e63f09fbf8db430e6a27

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["3.0", "2.7", "2.6", "2.5"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@ae9cb3b565e36682a2c6045e4f664388da4c73aa
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - "tmp/**/*"
+inherit_gem:
+  barsoom_utils: shared_rubocop.yml

data/Gemfile

@@ -4,3 +4,8 @@ source "https://rubygems.org"
 gemspec
 
 gem "uk_account_validator", github: "ball-hayden/uk_account_validator"
+
+group :development do
+  gem "barsoom_utils", github: "barsoom/barsoom_utils"
+  gem "rubocop"
+end

data/README.md

@@ -1,35 +1,44 @@
 # United Kingdom bank tools
 
-[![Build Status](https://travis-ci.org/barsoom/banktools-gb.svg?branch=master)](https://travis-ci.org/barsoom/banktools-gb)
+[![Ruby CI](https://github.com/barsoom/banktools-gb/actions/workflows/ci.yml/badge.svg)](https://github.com/barsoom/banktools-gb/actions/workflows/ci.yml)
 
-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")
-    account.valid?  # => true
-    account.errors  # => []
+```ruby
+# 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 ]
 
-    bad_account = BankTools::GB::AccountNumberWithSortCode.new(account_number: "1", sort_code: "")
-    bad_account.valid?  # => false
-    bad_account.errors  # => [:account_number_is_too_short]
+# Account
 
-    # Error codes
+account = BankTools::GB::Account.new("31926819")
+account.valid?  # => true
+account.errors  # => []
 
-    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
+bad_account = BankTools::GB::Account.new("1")
+bad_account.valid?  # => false
+bad_account.errors  # => [ :too_short ]
+```
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem "banktools-gb"
+```ruby
+gem "banktools-gb"
+```
 
 And then execute:
 
@@ -46,18 +55,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,9 +5,9 @@ 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.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"
@@ -16,12 +16,12 @@ Gem::Specification.new do |spec|
   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.require_paths = [ "lib" ]
+  spec.metadata      = { "rubygems_mfa_required" => "true" }
 
-  spec.add_dependency "uk_account_validator", "~> 0"
-  spec.add_dependency "attr_extras", "~> 5"
+  spec.add_dependency "attr_extras"
 
-  spec.add_development_dependency "bundler", "~> 1"
-  spec.add_development_dependency "rake", "~> 11"
+  spec.add_development_dependency "bundler", ">= 1"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3"
 end

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/errors.rb

@@ -1,12 +1,12 @@
-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
     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.13.1"
   end
 end

data/lib/banktools-gb.rb

@@ -1,5 +1,3 @@
-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"

metadata

@@ -1,71 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: banktools-gb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Tomas Skogberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: uk_account_validator
+  name: attr_extras
   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: attr_extras
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,9 +73,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -98,13 +85,15 @@ 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/errors.rb
+- lib/banktools-gb/sort_code.rb
 - lib/banktools-gb/version.rb
 homepage: https://github.com/barsoom/banktools-gb
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -120,8 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.2.28
 signing_key: 
 specification_version: 4
 summary: Validate and normalise United Kingdom bank account numbers.

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.1
-  - 2.2.0
-  - 2.1.0
-  - 2.0.0

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