banktools-se 2.6.3 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6df052c5e1e856bc395b39e9e9355817f5a0bcdb
-  data.tar.gz: 82f54243c1e5ed41b80c4689d3c6e0cd7656aa21
+SHA256:
+  metadata.gz: ae26d83c75f488a904bc1dcaffada866c129f7f923a4083ef4c2886c58c4d605
+  data.tar.gz: 1a52ea7948ea5d90c0df16501455015ff8c870f22f00b64ca7ccf64f050aba83
 SHA512:
-  metadata.gz: 4cc99d6b3c4e554c68401414da3e8b679f552603654d42c4667e0a723ce730785f4b0c3ee7a0652e7bc30b610bec98681459df40f4cd5dc0548458cee03ce6dc
-  data.tar.gz: 49557f51445e632e2f6ac97717d1a13c98696fcae3a865cf2a62a4918d3733fdbca7948642984b0e7102e1d8717a3f16dd529505ac6bcacefb3dcdf473ebe374
+  metadata.gz: 4ea749b95887d14fce1fa99b3f34537f497706ea1670050014cf94064830b6e23a1db8c3a71caeaab0282a559879562ea4305d9507608f1ad01f04c0ffa859fc
+  data.tar.gz: 3aef88169d2c7be49fcfa7d88148db48db4a2ff2d9f8822cc9898ee03f9fad0cc0b4e7f9197ce0410f1021c3459172b8159d99d49269f20a0f06c98b882f8eb7

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+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/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+tmp/*

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## 3.1.0
+
+- Add more banks to the range in `BankTools::SE::Account::ClearingNumber`. See [#7]. Thanks, Milen Dimitrov!
+
+## 3.0.1
+
+- Fix deprecation error: "NOTE: Gem::Specification#rubyforge_project= is deprecated with no replacement. It will be removed on or after 2019-12-01."
+
+## 3.0.0
+
+- Change `BankTools::SE::OCR.find_all_in_string` default `max_length` from 19 to 18 to avoid out of range errors with Active Record.
+
+## 2.6.3 and earlier
+
+- Please see commit history.
+
+[#7]: https://github.com/barsoom/banktools-se/pull/7

data/Gemfile

@@ -1,4 +1,9 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in bank-tools-se.gemspec
 gemspec
+
+group :development do
+  gem "barsoom_utils", github: "barsoom/barsoom_utils"
+  gem "rubocop"
+end

data/README.markdown

@@ -1,6 +1,6 @@
 # Swedish bank tools
 
-[![Build Status](https://secure.travis-ci.org/barsoom/banktools-se.png)](http://travis-ci.org/barsoom/banktools-se)
+[![Ruby CI](https://github.com/barsoom/banktools-se/actions/workflows/ci.yml/badge.svg)](https://github.com/barsoom/banktools-se/actions/workflows/ci.yml)
 
 Ruby gem to validate, normalize/prettify and to some extent interpret
 
@@ -17,87 +17,90 @@ Inspired by [iulianu/iban-tools](https://github.com/iulianu/iban-tools). Please
 
 ## Usage
 
-    # Bankgiro
+```ruby
+# Bankgiro
 
-    valid_account = BankTools::SE::Bankgiro.new(" 5402968 1 ")
-    valid_account.valid?  # => true
-    valid_account.errors  # => []
-    valid_account.normalize  # => "5402-9681"
+valid_account = BankTools::SE::Bankgiro.new(" 5402968 1 ")
+valid_account.valid?  # => true
+valid_account.errors  # => []
+valid_account.normalize  # => "5402-9681"
 
-    bad_account = BankTools::SE::Bankgiro.new(" 1X ")
-    bad_account.valid?  # => false
-    bad_account.errors  # => [ :too_short, :invalid_characters, :bad_checksum ]
-    bad_account.normalize  # => " 1 "
+bad_account = BankTools::SE::Bankgiro.new(" 1X ")
+bad_account.valid?  # => false
+bad_account.errors  # => [ :too_short, :invalid_characters, :bad_checksum ]
+bad_account.normalize  # => " 1 "
 
-    # 90-konto
-    fundraising_account = BankTools::SE::Bankgiro.new("902-0033")
-    fundraising_account.fundraising?  # => true
+# 90-konto
+fundraising_account = BankTools::SE::Bankgiro.new("902-0033")
+fundraising_account.fundraising?  # => true
 
-    # OCR
+# OCR
 
-    BankTools::SE::OCR.from_number("123")  # => "1230"
-    BankTools::SE::OCR.from_number("123", length_digit: true)  # => "12351"
-    BankTools::SE::OCR.from_number("123", length_digit: true, pad: "0")  # => "123067"
+BankTools::SE::OCR.from_number("123")  # => "1230"
+BankTools::SE::OCR.from_number("123", length_digit: true)  # => "12351"
+BankTools::SE::OCR.from_number("123", length_digit: true, pad: "0")  # => "123067"
 
-    BankTools::SE::OCR.to_number("1230")  # => "123"
-    BankTools::SE::OCR.to_number("123067", length_digit: true, pad: "0")  # => "123"
-    BankTools::SE::OCR.to_number("1230", length_digit: true, pad: "0")  # Raises exception because there's no length digit or padding.
+BankTools::SE::OCR.to_number("1230")  # => "123"
+BankTools::SE::OCR.to_number("123067", length_digit: true, pad: "0")  # => "123"
+BankTools::SE::OCR.to_number("1230", length_digit: true, pad: "0")  # Raises exception because there's no length digit or padding.
 
-    # This feature is intended to try to find all OCR numbers in a noisy bank statement string.
-    # By design it may find too many numbers (e.g. valid substrings of other numbers), so you should check results against actual outstanding invoices.
-    # By default, it excludes OCRs shorter than 4 digits and longer than 19 digits, but this limit can be specified per below.
-    BankTools::SE::OCR.find_all_in_string("OCR1230 and ref4564 and 7890")  # => [ "1230", "4564", … ]
-    BankTools::SE::OCR.find_all_in_string("1230 and 123067", length_digit: true, pad: "0")  # => [ "123067" ]
-    BankTools::SE::OCR.find_all_in_string("00 and 18 and 1230", min_length: 2, max_length: 3)  # => [ "00", "018", "18" ]
+# This feature is intended to try to find all OCR numbers in a noisy bank statement string.
+# By design it may find too many numbers (e.g. valid substrings of other numbers), so you should check results against actual outstanding invoices.
+# By default, it excludes OCRs shorter than 4 digits and longer than 18 digits, but this limit can be specified per below.
+BankTools::SE::OCR.find_all_in_string("OCR1230 and ref4564 and 7890")  # => [ "1230", "4564", … ]
+BankTools::SE::OCR.find_all_in_string("1230 and 123067", length_digit: true, pad: "0")  # => [ "123067" ]
+BankTools::SE::OCR.find_all_in_string("00 and 18 and 1230", min_length: 2, max_length: 3)  # => [ "00", "018", "18" ]
 
-    # Plusgiro
+# Plusgiro
 
-    valid_account = BankTools::SE::Plusgiro.new("2865434")
-    valid_account.valid?  # => true
-    valid_account.errors  # => []
-    valid_account.normalize  # => "28 65 53-4"
+valid_account = BankTools::SE::Plusgiro.new("2865434")
+valid_account.valid?  # => true
+valid_account.errors  # => []
+valid_account.normalize  # => "28 65 53-4"
 
-    bad_account = BankTools::SE::Plusgiro.new(" 1X ")
-    bad_account.valid?  # => false
-    bad_account.errors  # => [ :too_short, :invalid_characters, :bad_checksum ]
-    bad_account.normalize  # => " 1 "
+bad_account = BankTools::SE::Plusgiro.new(" 1X ")
+bad_account.valid?  # => false
+bad_account.errors  # => [ :too_short, :invalid_characters, :bad_checksum ]
+bad_account.normalize  # => " 1 "
 
-    # 90-konto
-    fundraising_account = BankTools::SE::Plusgiro.new("90 20 03-3")
-    fundraising_account.fundraising?  # => true
+# 90-konto
+fundraising_account = BankTools::SE::Plusgiro.new("90 20 03-3")
+fundraising_account.fundraising?  # => true
 
 
-    # Bank account
+# Bank account
 
-    valid_account = BankTools::SE::Account.new("11000000000")
-    valid_account.valid?  # => true
-    valid_account.errors  # => []
-    valid_account.normalize  # => "1100-0000000"
-    valid_account.bank  # => "Nordea"
-    valid_account.clearing_number  # => "1100"
-    valid_account.serial_number  # => "0000000"
+valid_account = BankTools::SE::Account.new("11000000000")
+valid_account.valid?  # => true
+valid_account.errors  # => []
+valid_account.normalize  # => "1100-0000000"
+valid_account.bank  # => "Nordea"
+valid_account.clearing_number  # => "1100"
+valid_account.serial_number  # => "0000000"
 
-    bad_account = BankTools::SE::Account.new(" 0000-0000000X ")
-    bad_account.valid?  # => false
-    bad_account.errors  # => [ :invalid_characters, :unknown_clearing_number ]
-    bad_account.bank  # => nil
-    bad_account.normalize  # => " 0000-0000000X "
+bad_account = BankTools::SE::Account.new(" 0000-0000000X ")
+bad_account.valid?  # => false
+bad_account.errors  # => [ :invalid_characters, :unknown_clearing_number ]
+bad_account.bank  # => nil
+bad_account.normalize  # => " 0000-0000000X "
 
 
-    # Error codes
-
-    BankTools::SE::Errors::TOO_SHORT                # => :too_short
-    BankTools::SE::Errors::TOO_LONG                 # => :too_long
-    BankTools::SE::Errors::INVALID_CHARACTERS       # => :invalid_characters
-    BankTools::SE::Errors::BAD_CHECKSUM             # => :bad_checksum
-    BankTools::SE::Errors::UNKNOWN_CLEARING_NUMBER  # => :unknown_clearing_number
+# Error codes
 
+BankTools::SE::Errors::TOO_SHORT                # => :too_short
+BankTools::SE::Errors::TOO_LONG                 # => :too_long
+BankTools::SE::Errors::INVALID_CHARACTERS       # => :invalid_characters
+BankTools::SE::Errors::BAD_CHECKSUM             # => :bad_checksum
+BankTools::SE::Errors::UNKNOWN_CLEARING_NUMBER  # => :unknown_clearing_number
+```
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'banktools-se'
+```ruby
+gem 'banktools-se'
+```
 
 And then execute:
 
@@ -117,9 +120,9 @@ Possible improvements to make:
 
 ## Also see
 
-* [BankTools::DE (German)](https://github.com/barsoom/banktools-de)
-* [iban-tools](https://github.com/iulianu/iban-tools)
 * [Bankgirocentral documentation](https://www.bankgirot.se/kundservice/handbocker/)
+* [Our other BankTools](https://github.com/barsoom?q=banktools)
+* [iban-tools](https://github.com/iulianu/iban-tools)
 
 
 ## Credits and license

data/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/banktools-se.gemspec

@@ -5,17 +5,15 @@ require "banktools-se/version"
 Gem::Specification.new do |s|
   s.name        = "banktools-se"
   s.version     = BankTools::SE::VERSION
-  s.authors     = ["Henrik Nyh"]
-  s.email       = ["henrik@barsoom.se"]
+  s.authors     = [ "Henrik Nyh" ]
+  s.email       = [ "henrik@barsoom.se" ]
   s.homepage    = ""
   s.summary     = %q{Validate and normalize Swedish bank account numbers, plusgiro and bankgiro.}
 
-  s.rubyforge_project = "banktools-se"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = [ "lib" ]
+  s.metadata      = { "rubygems_mfa_required" => "true" }
 
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"

data/lib/banktools-se/account/clearing_number.rb

@@ -11,11 +11,11 @@ module BankTools
           2300..2399 => { name: "Ålandsbanken" },
           2400..2499 => { name: "Danske Bank" },
           3000..3299 => { name: "Nordea" },
-          3300..3300 => { name: "Nordea", serial_number_length: 10, luhn_for_serial: true },  # Personkonto.
+          3300..3300 => { name: "Nordea", serial_number_length: 10, luhn_for_serial: true }, # Personkonto.
           3301..3399 => { name: "Nordea" },
           3400..3409 => { name: "Länsförsäkringar Bank" },
           3410..3781 => { name: "Nordea" },
-          3782..3782 => { name: "Nordea", serial_number_length: 10, luhn_for_serial: true },  # Personkonto.
+          3782..3782 => { name: "Nordea", serial_number_length: 10, luhn_for_serial: true }, # Personkonto.
           3783..4999 => { name: "Nordea" },
           5000..5999 => { name: "SEB" },
           6000..6999 => { name: "Handelsbanken", serial_number_length: 8..9 },
@@ -45,6 +45,19 @@ module BankTools
           9500..9549 => { name: "Nordea/Plusgirot", serial_number_length: 1..10 },
           9550..9569 => { name: "Avanza Bank" },
           9570..9579 => { name: "Sparbanken Syd", serial_number_length: 10, zerofill: true },
+          9630..9639 => { name: "Lån og Spar Bank Sverige" },
+          9640..9649 => { name: "Nordax Bank AB" },
+          9650..9659 => { name: "MedMera Bank" },
+          9660..9669 => { name: "Svea Bank" },
+          9670..9679 => { name: "JAK Medlemsbank" },
+          9680..9689 => { name: "Bluestep Finance" },
+          9690..9699 => { name: "Folkia" },
+          9700..9709 => { name: "Ekobanken" },
+          9720..9729 => { name: "Netfonds Bank (ub)" },
+          9750..9759 => { name: "Northmill Bank" },
+          9770..9779 => { name: "FTCS" },
+          9780..9789 => { name: "Klarna Bank" },
+          9955..9955 => { name: "Kommuninvest" },
           9960..9969 => { name: "Nordea/Plusgirot", serial_number_length: 1..10 },
         }
       end

data/lib/banktools-se/account.rb

@@ -50,8 +50,8 @@ module BankTools
 
       def clearing_number
         [
-          digits[0,4],
-          checksum_for_clearing? ? digits[4,1] : nil
+          digits[0, 4],
+          checksum_for_clearing? ? digits[4, 1] : nil,
         ].compact.join("-")
       end
 
@@ -72,7 +72,7 @@ module BankTools
       end
 
       def bank_data
-        number = digits[0,4].to_i
+        number = digits[0, 4].to_i
         _, found_data = CLEARING_NUMBER_MAP.find { |interval, data| interval.include?(number) }
         found_data || {}
       end
@@ -90,7 +90,7 @@ module BankTools
           Array(serial_number_length).last +
             (checksum_for_clearing? ? 1 : 0)
         else
-          1/0.0  # Infinity.
+          1 / 0.0  # Infinity.
         end
       end
 
@@ -107,7 +107,7 @@ module BankTools
       end
 
       def digits
-        number.to_s.gsub(/\D/, '')
+        number.to_s.gsub(/\D/, "")
       end
 
       def zerofill?

data/lib/banktools-se/bankgiro.rb

@@ -38,7 +38,7 @@ module BankTools
       private
 
       def digits
-        number.to_s.gsub(/\D/, '')
+        number.to_s.gsub(/\D/, "")
       end
 
     end

data/lib/banktools-se/ocr.rb

@@ -20,6 +20,7 @@ module BankTools
         pad = pad.to_s
 
         raise MustBeNumeric unless number.match(/\A\d+\z/)
+
         # Padding isn't something BGC specifies, but we needed it to support a legacy scheme.
         number += pad
         # Adding 2: 1 length digit, 1 check digit.
@@ -64,8 +65,8 @@ module BankTools
         ocr[0...-digits_to_chop]
       end
 
-      # max_length is 19 because that's the longest allowed integer by default in a Postgres integer column with Ruby on Rails. So attempting some queries with longer OCRs may cause exceptions.
-      def self.find_all_in_string(string, length_digit: false, pad: "", min_length: 4, max_length: 19)
+      # max_length is 18, because the biggest allowed integer by default in a Postgres integer column ("bigint") is 19 digits long, as is the next (disallowed) number. Attempting some queries with longer OCRs may cause Ruby on Rails exceptions.
+      def self.find_all_in_string(string, length_digit: false, pad: "", min_length: 4, max_length: 18)
         # First, treat the input as one long string of digits.
         # E.g. "1234 and 5678" becomes "12345678".
 
@@ -88,7 +89,7 @@ module BankTools
 
         # Get rid of any duplicates.
 
-        candidates.uniq!
+        candidates = candidates.uniq
 
         # Finally, limit these substrings to ones that are actually valid OCRs.
 

data/lib/banktools-se/plusgiro.rb

@@ -45,7 +45,7 @@ module BankTools
       private
 
       def digits
-        number.to_s.gsub(/\D/, '')
+        number.to_s.gsub(/\D/, "")
       end
 
     end

data/lib/banktools-se/version.rb

@@ -1,5 +1,5 @@
 module BankTools
   module SE
-    VERSION = "2.6.3"
+    VERSION = "3.1.1"
   end
 end

data/spec/account_spec.rb

@@ -17,7 +17,7 @@ describe BankTools::SE::Account do
 
     it "should be false with errors" do
       account = BankTools::SE::Account.new("foo")
-      allow(account).to receive(:errors).and_return([:error])
+      allow(account).to receive(:errors).and_return([ :error ])
       expect(account).not_to be_valid
     end
   end

data/spec/bankgiro_spec.rb

@@ -15,7 +15,7 @@ describe BankTools::SE::Bankgiro do
 
     it "should be false with errors" do
       account = BankTools::SE::Bankgiro.new("foo")
-      allow(account).to receive(:errors).and_return([:error])
+      allow(account).to receive(:errors).and_return([ :error ])
       expect(account).not_to be_valid
     end
   end

data/spec/ocr_spec.rb

@@ -121,15 +121,17 @@ describe BankTools::SE::OCR do
     end
 
     it "lets you configure the accepted OCR max_length" do
-      ocr_length_19 = "1234567890123456785"
-      ocr_length_20 = "12345678901234567894"
-      string = "#{ocr_length_19} #{ocr_length_20}"
+      # Add a check digit to the input.
+      ocr_length_18 = BankTools::SE::OCR.from_number("12345678901234567")
+      ocr_length_19 = BankTools::SE::OCR.from_number("123456789012345678")
 
-      # Default max_length is 19.
-      expect(BankTools::SE::OCR.find_all_in_string(string)).to include ocr_length_19
-      expect(BankTools::SE::OCR.find_all_in_string(string)).not_to include ocr_length_20
+      string = "#{ocr_length_18} #{ocr_length_19}"
 
-      expect(BankTools::SE::OCR.find_all_in_string(string, max_length: 20)).to include ocr_length_19, ocr_length_20
+      # Default max_length is 18.
+      expect(BankTools::SE::OCR.find_all_in_string(string)).to include ocr_length_18
+      expect(BankTools::SE::OCR.find_all_in_string(string)).not_to include ocr_length_19
+
+      expect(BankTools::SE::OCR.find_all_in_string(string, max_length: 19)).to include ocr_length_18, ocr_length_19
     end
 
     it "excludes duplicates" do

data/spec/plusgiro_spec.rb

@@ -17,7 +17,7 @@ describe BankTools::SE::Plusgiro do
 
     it "should be false with errors" do
       account = BankTools::SE::Plusgiro.new("foo")
-      allow(account).to receive(:errors).and_return([:error])
+      allow(account).to receive(:errors).and_return([ :error ])
       expect(account).not_to be_valid
     end
 

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
 RSpec.configure do |config|
-  config.filter_run :focus => true
+  config.filter_run focus: true
   config.run_all_when_everything_filtered = true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: banktools-se
 version: !ruby/object:Gem::Version
-  version: 2.6.3
+  version: 3.1.1
 platform: ruby
 authors:
 - Henrik Nyh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -73,8 +73,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - README.markdown
 - Rakefile
@@ -96,7 +98,8 @@ files:
 - spec/utils_spec.rb
 homepage: ''
 licenses: []
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -112,15 +115,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: banktools-se
-rubygems_version: 2.5.1
+rubygems_version: 3.2.28
 signing_key: 
 specification_version: 4
 summary: Validate and normalize Swedish bank account numbers, plusgiro and bankgiro.
-test_files:
-- spec/account_spec.rb
-- spec/bankgiro_spec.rb
-- spec/ocr_spec.rb
-- spec/plusgiro_spec.rb
-- spec/spec_helper.rb
-- spec/utils_spec.rb
+test_files: []

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.0
-  - 2.2.5