banktools-se 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 423ae55440789051d2a88262b7da03873b9359b3
-  data.tar.gz: a8cc8599a42101869684162d84e0f957bf8fe7e3
+  metadata.gz: 56417ca1fa0b99e2d5c754563686051cc73c0387
+  data.tar.gz: 7abf1933594e2ff146fe570a5b935e41ab996e14
 SHA512:
-  metadata.gz: 2207ad3837fa11039e03088ca5df0d96ea79e1c87150609a23a21db7581437a06e03763345fef03447a8de38f970000edeff6c932941cd99fd3d62f6d968742c
-  data.tar.gz: d61848a2806d739bf908cc894eef42a4548aab91552780414b64d1303ed4081aa4e81c3109925e5800a44d6b4d28197315c51990bcc2d29ca1ddff0258c1a44a
+  metadata.gz: 920c68e4e3cdfed665e6242256952f5cd770ed3e25faab56cd8cbb33b76ffec39d38d1fcfed12a0a0cda67dde11cafc0b6a91c51274bcbc163d4108f18b6c2bc
+  data.tar.gz: 3176a6146b0380d9db063b82e343dce699918ab2537fb7cd419d4bc3321fd07bd085a9d3847baf15abe7ad5068b4dbd9e00bfb5128d41978406fd41c203c7c7c

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
+  - 2.1.0
   - 2.0.0
   - 1.9.3

data/README.markdown

@@ -8,24 +8,13 @@ Ruby gem to validate, normalize/prettify and to some extent interpret
   * Swedish plusgiro numbers
   * Swedish bankgiro numbers
 
+It can also generate and unpack Bankgiro OCR numbers (reference codes) with a check digit, optional length digit and optional padding digits.
+
 This gem does what it can to weed out invalid numbers but errs on the side of allowing too much, in the absence of good specifications, so be advised that a "valid" number might still be incorrect.
 
 Inspired by [iulianu/iban-tools](https://github.com/iulianu/iban-tools). Please consider contributing gems for your country.
 
 
-## Installation
-
-With Bundler for e.g. Ruby on Rails, add this to your `Gemfile`:
-
-    gem 'banktools-se', :git => 'git://github.com/barsoom/banktools-se.git'
-
-and run
-
-    bundle
-
-to install it.
-
-
 ## Usage
 
     # Bankgiro
@@ -95,6 +84,21 @@ to install it.
     BankTools::SE::Errors::UNKNOWN_CLEARING_NUMBER  # => :unknown_clearing_number
 
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'banktools-se'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install banktools-se
+
+
 ## TODO
 
 Possible improvements to make:
@@ -102,6 +106,12 @@ Possible improvements to make:
   * Luhn validation based on [BGC docs](http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG910.pdf).
 
 
+## Also see
+
+* [BankTools::DE (German)](https://github.com/barsoom/banktools-de)
+* [iban-tools](https://github.com/iulianu/iban-tools)
+
+
 ## Credits and license
 
 By [Henrik Nyh](http://henrik.nyh.se/) for [Barsoom](http://barsoom.se) under the MIT license:

data/lib/banktools-se/account.rb

@@ -1,56 +1,14 @@
 # encoding: utf-8
 
+# http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG910.pdf
+
+require "banktools-se/account/clearing_number"
+
 module BankTools
   module SE
     class Account
-
-      # http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG910.pdf
-
       DEFAULT_SERIAL_NUMBER_LENGTH = 7
-
-      CLEARING_NUMBER_MAP = {
-        1100..1199 => { :name => "Nordea" },
-        1200..1399 => { :name => "Danske Bank" },
-        1400..2099 => { :name => "Nordea" },
-        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.
-        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.
-        3783..4999 => { :name => "Nordea" },
-        5000..5999 => { :name => "SEB" },
-        6000..6999 => { :name => "Handelsbanken", :serial_number_length => 9 },
-        7000..7999 => { :name => "Swedbank" },
-        # Can be fewer chars but must be zero-filled, so let's call it 10.
-        8000..8999 => { :name => "Swedbank", :serial_number_length => 10, :checksum_for_clearing => true, :zerofill => true },
-        9020..9029 => { :name => "Länsförsäkringar Bank" },
-        9040..9049 => { :name => "Citibank" },
-        9060..9069 => { :name => "Länsförsäkringar Bank" },
-        9090..9099 => { :name => "Royal Bank of Scotland" },
-        9100..9109 => { :name => "Nordnet Bank" },
-        9120..9124 => { :name => "SEB" },
-        9130..9149 => { :name => "SEB" },
-        9150..9169 => { :name => "Skandiabanken" },
-        9170..9179 => { :name => "Ikano Bank" },
-        9180..9189 => { :name => "Danske Bank", :serial_number_length => 10 },
-        9190..9199 => { :name => "Den Norske Bank" },
-        9230..9239 => { :name => "Marginalen Bank" },
-        9250..9259 => { :name => "SBAB" },
-        9260..9269 => { :name => "Den Norske Bank" },
-        9270..9279 => { :name => "ICA Banken" },
-        9280..9289 => { :name => "Resurs Bank" },
-        9300..9349 => { :name => "Sparbanken Öresund", :serial_number_length => 10, :zerofill => true },
-        9400..9449 => { :name => "Forex Bank" },
-        9460..9469 => { :name => "GE Money Bank" },
-        9470..9479 => { :name => "Fortis Bank" },
-        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},
-        9960..9969 => { :name => "Nordea/Plusgirot", :serial_number_length => 1..10 },
-      }
+      CLEARING_NUMBER_MAP = ClearingNumber::MAP
 
       attr_reader :number
 
@@ -67,10 +25,10 @@ module BankTools
 
         errors << Errors::TOO_SHORT if serial_number.length < min_length
         errors << Errors::TOO_LONG if serial_number.length > max_length
-        errors << Errors::INVALID_CHARACTERS if number.to_s.match(/[^0-9 -]/)
+        errors << Errors::INVALID_CHARACTERS if number.to_s.match(/[^\d -]/)
 
         if luhn_for_serial?
-          errors << Errors::BAD_CHECKSUM unless BankTools::SE::Utils.valid_luhn?(serial_number)
+          errors << Errors::BAD_CHECKSUM unless Utils.valid_luhn?(serial_number)
         end
 
         errors << Errors::UNKNOWN_CLEARING_NUMBER unless bank
@@ -99,7 +57,12 @@ module BankTools
 
       def serial_number
         number = digits.slice(clearing_number_length..-1) || ""
-        zerofill? ? "%.#{bank_data[:serial_number_length]}d" % number.to_i(10) : number
+
+        if zerofill?
+          number.rjust(serial_number_length, "0")
+        else
+          number
+        end
       end
 
       private
@@ -110,15 +73,13 @@ module BankTools
 
       def bank_data
         number = digits[0,4].to_i
-        _, found_data = CLEARING_NUMBER_MAP.find do |interval, data|
-          interval.include?(number)
-        end
+        _, found_data = CLEARING_NUMBER_MAP.find { |interval, data| interval.include?(number) }
         found_data || {}
       end
 
       def min_length
         if bank_data
-          Array(bank_data[:serial_number_length] || DEFAULT_SERIAL_NUMBER_LENGTH).first
+          Array(serial_number_length).first
         else
           0
         end
@@ -126,13 +87,17 @@ module BankTools
 
       def max_length
         if bank_data
-          Array(bank_data[:serial_number_length] || DEFAULT_SERIAL_NUMBER_LENGTH).last +
+          Array(serial_number_length).last +
             (checksum_for_clearing? ? 1 : 0)
         else
           1/0.0  # Infinity.
         end
       end
 
+      def serial_number_length
+        bank_data.fetch(:serial_number_length, DEFAULT_SERIAL_NUMBER_LENGTH)
+      end
+
       def luhn_for_serial?
         bank_data[:luhn_for_serial]
       end
@@ -148,7 +113,6 @@ module BankTools
       def zerofill?
         !!bank_data[:zerofill]
       end
-
     end
   end
 end

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

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+module BankTools
+  module SE
+    class Account
+      module ClearingNumber
+        MAP = {
+          1100..1199 => { name: "Nordea" },
+          1200..1399 => { name: "Danske Bank" },
+          1400..2099 => { name: "Nordea" },
+          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.
+          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.
+          3783..4999 => { name: "Nordea" },
+          5000..5999 => { name: "SEB" },
+          6000..6999 => { name: "Handelsbanken", serial_number_length: 9 },
+          7000..7999 => { name: "Swedbank" },
+          # Can be fewer chars but must be zero-filled, so let's call it 10.
+          8000..8999 => { name: "Swedbank", serial_number_length: 10, checksum_for_clearing: true, zerofill: true },
+          9020..9029 => { name: "Länsförsäkringar Bank" },
+          9040..9049 => { name: "Citibank" },
+          9060..9069 => { name: "Länsförsäkringar Bank" },
+          9090..9099 => { name: "Royal Bank of Scotland" },
+          9100..9109 => { name: "Nordnet Bank" },
+          9120..9124 => { name: "SEB" },
+          9130..9149 => { name: "SEB" },
+          9150..9169 => { name: "Skandiabanken" },
+          9170..9179 => { name: "Ikano Bank" },
+          9180..9189 => { name: "Danske Bank", serial_number_length: 10 },
+          9190..9199 => { name: "Den Norske Bank" },
+          9230..9239 => { name: "Marginalen Bank" },
+          9250..9259 => { name: "SBAB" },
+          9260..9269 => { name: "Den Norske Bank" },
+          9270..9279 => { name: "ICA Banken" },
+          9280..9289 => { name: "Resurs Bank" },
+          9300..9349 => { name: "Sparbanken Öresund", serial_number_length: 10, zerofill: true },
+          9400..9449 => { name: "Forex Bank" },
+          9460..9469 => { name: "GE Money Bank" },
+          9470..9479 => { name: "Fortis Bank" },
+          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 },
+          9960..9969 => { name: "Nordea/Plusgirot", serial_number_length: 1..10 },
+        }
+      end
+    end
+  end
+end

data/lib/banktools-se/bankgiro.rb

@@ -29,7 +29,7 @@ module BankTools
         errors << Errors::TOO_SHORT if digits.length < 7
         errors << Errors::TOO_LONG if digits.length > 8
         errors << Errors::INVALID_CHARACTERS if number.to_s.match(/[^0-9 -]/)
-        errors << Errors::BAD_CHECKSUM unless BankTools::SE::Utils.valid_luhn?(number)
+        errors << Errors::BAD_CHECKSUM unless Utils.valid_luhn?(number)
 
         errors
       end
@@ -43,7 +43,7 @@ module BankTools
       end
 
       def fundraising?
-        valid? && digits.match(/^90[0-4]/)
+        valid? && digits.match(/\A90[0-4]/)
       end
 
       private

data/lib/banktools-se/bankgiro/ocr.rb

@@ -6,35 +6,39 @@ module BankTools
       class InvalidOCR < StandardError; end
       class OverlongOCR < InvalidOCR; end
       class BadChecksum < InvalidOCR; end
+      class MustBeNumeric < InvalidOCR; end
 
       class OCR
-        def self.number_to_ocr(number, opts = {})
-          add_length_digit = opts.fetch(:length_digit, false)
-          pad = opts.fetch(:pad, nil)
+        MIN_LENGTH = 2
+        MAX_LENGTH = 25
 
+        def self.number_to_ocr(number, opts = {})
           number = number.to_s
+          add_length_digit = opts.fetch(:length_digit, false)
+          pad = opts.fetch(:pad, "").to_s
 
-          number += pad if pad
-
+          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.
           number += ((number.length + 2) % 10).to_s if add_length_digit
 
           number_with_ocr = number + Utils.luhn_checksum(number).to_s
 
           length = number_with_ocr.length
-          if length > 25
-            raise OverlongOCR, "Bankgiro OCR must be 2-25 characters (this one would be #{length} characters)"
+          if length > MAX_LENGTH
+            raise OverlongOCR, "Bankgiro OCR must be #{MIN_LENGTH} - #{MAX_LENGTH} characters (this one would be #{length} characters)"
           end
 
           number_with_ocr
         end
 
         def self.number_from_ocr(number, opts = {})
-          strip_length_digit = opts.fetch(:length_digit, false)
-          strip_padding = opts.fetch(:pad, "")
-
           number = number.to_s
+          strip_length_digit = opts.fetch(:length_digit, false)
+          strip_padding = opts.fetch(:pad, "").to_s
 
+          raise MustBeNumeric unless number.match(/\A\d+\z/)
           raise BadChecksum unless Utils.valid_luhn?(number)
 
           digits_to_chop  = 1  # Checksum.

data/lib/banktools-se/plusgiro.rb

@@ -21,7 +21,7 @@ module BankTools
         errors << Errors::TOO_SHORT if digits.length < 2
         errors << Errors::TOO_LONG if digits.length > 8
         errors << Errors::INVALID_CHARACTERS if number.to_s.match(/[^0-9 -]/)
-        errors << Errors::BAD_CHECKSUM unless BankTools::SE::Utils.valid_luhn?(number)
+        errors << Errors::BAD_CHECKSUM unless Utils.valid_luhn?(number)
 
         errors
       end
@@ -39,7 +39,7 @@ module BankTools
       # http://www.plusgirot.se/Om+PlusGirot/90-konton/508552.html
       # http://www.insamlingskontroll.se/
       def fundraising?
-        valid? && digits.match(/^90\d{5}$/)
+        valid? && digits.match(/\A90\d{5}$/)
       end
 
       private

data/lib/banktools-se/version.rb

@@ -1,5 +1,5 @@
 module BankTools
   module SE
-    VERSION = "0.8.0"
+    VERSION = "0.10.0"
   end
 end

data/spec/account_spec.rb

@@ -142,9 +142,6 @@ describe BankTools::SE::Account do
       BankTools::SE::Account.new("12").serial_number.should == ""
     end
 
-    it "should manage pre-zerofilled account numbers" do
-      BankTools::SE::Account.new("8000-2-0800000002").should be_valid
-    end
   end
 
   describe "#normalize" do

data/spec/bankgiro_spec.rb

@@ -105,6 +105,10 @@ describe BankTools::SE::Bankgiro do
     it "raises if resulting number is > 25 digits" do
       expect { BankTools::SE::Bankgiro.number_to_ocr("1234567890123456789012345") }.to raise_error(BankTools::SE::Bankgiro::OverlongOCR)
     end
+
+    it "raises if input is non-numeric" do
+      expect { BankTools::SE::Bankgiro.number_to_ocr("garbage") }.to raise_error(BankTools::SE::Bankgiro::MustBeNumeric)
+    end
   end
 
   describe ".number_from_ocr" do
@@ -127,5 +131,9 @@ describe BankTools::SE::Bankgiro do
     it "raises if checksum is wrong" do
       expect { BankTools::SE::Bankgiro.number_from_ocr("1231") }.to raise_error(BankTools::SE::Bankgiro::BadChecksum)
     end
+
+    it "raises if input is non-numeric" do
+      expect { BankTools::SE::Bankgiro.number_from_ocr("garbage") }.to raise_error(BankTools::SE::Bankgiro::MustBeNumeric)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: banktools-se
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Henrik Nyh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-17 00:00:00.000000000 Z
+date: 2014-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -81,6 +81,7 @@ files:
 - banktools-se.gemspec
 - lib/banktools-se.rb
 - lib/banktools-se/account.rb
+- lib/banktools-se/account/clearing_number.rb
 - lib/banktools-se/bankgiro.rb
 - lib/banktools-se/bankgiro/ocr.rb
 - lib/banktools-se/errors.rb