banktools-se 0.11.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10c053f2d5762e614cad39a501a08dd8ffab2526
-  data.tar.gz: b1c6e6cf66384a55799aa99b4a1cc8be62140830
+  metadata.gz: a6e034f74096ed867627484354817c11aba890bb
+  data.tar.gz: 0418f31cf0df526976031a3cbeee701f59fc0a58
 SHA512:
-  metadata.gz: 8e334a027c0367e992f80f813674ad6f8423817f0a12491ea2a885aa1a5a6c82ab2f43843625083dd3e494bd58d8cddef82c4a51f325f40b3f22c960acf05459
-  data.tar.gz: 19b36f3156e07f3bf2a2fc11de9cfb60f81493bc94d32b02f21487e6ec968695f45907e7d2d415048f600c8e08d0fdba1f87ef3c8b0ae97c0674ee734365ea90
+  metadata.gz: d53bc1373a91f12a8a65ea3b2e09734f0e6e23fa25a16af4c63fd6b5a577919b955b18c60327ef8d5b20ba828e6826a287dbdce77b481da71bf5b9f409365270
+  data.tar.gz: b1babe91af17f1029af9d71fea57cf0fb6819e8bcab2922c0579169a68a84ed575bc005b279d3eba4e22c3653af1c2fb1ce72325f58c16318d49ae4e9d3197b1

data/README.markdown

@@ -8,7 +8,7 @@ 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.
+It can also generate and unpack payment 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.
 
@@ -34,12 +34,11 @@ Inspired by [iulianu/iban-tools](https://github.com/iulianu/iban-tools). Please
     fundraising_account.fundraising?  # => true
 
     # OCR
-    BankTools::SE::Bankgiro.number_to_ocr("123")  # => "1230"
-    BankTools::SE::Bankgiro.number_to_ocr("123", length_digit: true)  # => "12351"
-    BankTools::SE::Bankgiro.number_to_ocr("123", length_digit: true, pad: "0")  # => "123067"
-    BankTools::SE::Bankgiro.number_from_ocr("1230")  # => "123"
-    BankTools::SE::Bankgiro.number_from_ocr("123067", length_digit: true, pad: "0")  # => "123"
-
+    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"
 
     # Plusgiro
 

data/lib/banktools-se/bankgiro.rb

@@ -1,20 +1,9 @@
 # http://sv.wikipedia.org/wiki/Bankgirot#Bankgironummer
-
-require "banktools-se/bankgiro/ocr"
-
 module BankTools
   module SE
     class Bankgiro
       attr_reader :number
 
-      def self.number_to_ocr(number, opts = {})
-        OCR.number_to_ocr(number, opts)
-      end
-
-      def self.number_from_ocr(number, opts = {})
-        OCR.number_from_ocr(number, opts)
-      end
-
       def initialize(number)
         @number = number
       end

data/lib/banktools-se/ocr.rb

@@ -0,0 +1,51 @@
+# http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG6070.pdf section 5.2
+
+module BankTools
+  module SE
+    class OCR
+      class InvalidOCR < StandardError; end
+      class OverlongOCR < InvalidOCR; end
+      class BadChecksum < InvalidOCR; end
+      class MustBeNumeric < InvalidOCR; end
+
+      MIN_LENGTH = 2
+      MAX_LENGTH = 25
+
+      def self.from_number(number, opts = {})
+        number = number.to_s
+        add_length_digit = opts.fetch(:length_digit, false)
+        pad = opts.fetch(: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.
+        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 > 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.to_number(number, opts = {})
+        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.
+        digits_to_chop += 1 if strip_length_digit
+        digits_to_chop += strip_padding.length
+
+        number[0...-digits_to_chop]
+      end
+    end
+  end
+end

data/lib/banktools-se/version.rb

@@ -1,5 +1,5 @@
 module BankTools
   module SE
-    VERSION = "0.11.0"
+    VERSION = "1.0.0"
   end
 end

data/lib/banktools-se.rb

@@ -4,3 +4,4 @@ require "banktools-se/utils"
 require "banktools-se/bankgiro"
 require "banktools-se/plusgiro"
 require "banktools-se/account"
+require "banktools-se/ocr"

data/spec/bankgiro_spec.rb

@@ -83,57 +83,4 @@ describe BankTools::SE::Bankgiro do
       BankTools::SE::Bankgiro.new("5402-9681").should_not be_fundraising
     end
   end
-
-  # http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG6070.pdf section 5.2
-  describe ".number_to_ocr" do
-    it "adds a mod-10 check digit" do
-      BankTools::SE::Bankgiro.number_to_ocr("123").should eq "1230"
-    end
-
-    it "handles integer input" do
-      BankTools::SE::Bankgiro.number_to_ocr(123).should eq "1230"
-    end
-
-    it "can add an optional length digit" do
-      BankTools::SE::Bankgiro.number_to_ocr("1234567890", length_digit: true).should eq "123456789023"
-    end
-
-    it "can pad the number" do
-      BankTools::SE::Bankgiro.number_to_ocr("1234567890", length_digit: true, pad: "0").should eq "1234567890037"
-    end
-
-    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
-    it "strips the mod-10 check digit" do
-      BankTools::SE::Bankgiro.number_from_ocr("1230").should eq "123"
-    end
-
-    it "handles integer input" do
-      BankTools::SE::Bankgiro.number_from_ocr(1230).should eq "123"
-    end
-
-    it "can strip an optional length digit" do
-      BankTools::SE::Bankgiro.number_from_ocr("123456789023", length_digit: true).should eq "1234567890"
-    end
-
-    it "can pad the number" do
-      BankTools::SE::Bankgiro.number_from_ocr("1234567890037", length_digit: true, pad: "0").should eq "1234567890"
-    end
-
-    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

data/spec/ocr_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+require "banktools-se"
+
+describe BankTools::SE::OCR do
+  # http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG6070.pdf section 5.2
+  describe ".from_number" do
+    it "adds a mod-10 check digit" do
+      BankTools::SE::OCR.from_number("123").should eq "1230"
+    end
+
+    it "handles integer input" do
+      BankTools::SE::OCR.from_number(123).should eq "1230"
+    end
+
+    it "can add an optional length digit" do
+      BankTools::SE::OCR.from_number("1234567890", length_digit: true).should eq "123456789023"
+    end
+
+    it "can pad the number" do
+      BankTools::SE::OCR.from_number("1234567890", length_digit: true, pad: "0").should eq "1234567890037"
+    end
+
+    it "raises if resulting number is > 25 digits" do
+      expect { BankTools::SE::OCR.from_number("1234567890123456789012345") }.to raise_error(BankTools::SE::OCR::OverlongOCR)
+    end
+
+    it "raises if input is non-numeric" do
+      expect { BankTools::SE::OCR.from_number("garbage") }.to raise_error(BankTools::SE::OCR::MustBeNumeric)
+    end
+  end
+
+  describe ".to_number" do
+    it "strips the mod-10 check digit" do
+      BankTools::SE::OCR.to_number("1230").should eq "123"
+    end
+
+    it "handles integer input" do
+      BankTools::SE::OCR.to_number(1230).should eq "123"
+    end
+
+    it "can strip an optional length digit" do
+      BankTools::SE::OCR.to_number("123456789023", length_digit: true).should eq "1234567890"
+    end
+
+    it "can pad the number" do
+      BankTools::SE::OCR.to_number("1234567890037", length_digit: true, pad: "0").should eq "1234567890"
+    end
+
+    it "raises if checksum is wrong" do
+      expect { BankTools::SE::OCR.to_number("1231") }.to raise_error(BankTools::SE::OCR::BadChecksum)
+    end
+
+    it "raises if input is non-numeric" do
+      expect { BankTools::SE::OCR.to_number("garbage") }.to raise_error(BankTools::SE::OCR::MustBeNumeric)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: banktools-se
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Henrik Nyh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-02 00:00:00.000000000 Z
+date: 2016-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -83,13 +83,14 @@ files:
 - 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
+- lib/banktools-se/ocr.rb
 - lib/banktools-se/plusgiro.rb
 - lib/banktools-se/utils.rb
 - lib/banktools-se/version.rb
 - spec/account_spec.rb
 - spec/bankgiro_spec.rb
+- spec/ocr_spec.rb
 - spec/plusgiro_spec.rb
 - spec/spec_helper.rb
 - spec/utils_spec.rb
@@ -112,13 +113,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: banktools-se
-rubygems_version: 2.2.2
+rubygems_version: 2.2.1
 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

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

@@ -1,53 +0,0 @@
-# http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG6070.pdf section 5.2
-
-module BankTools
-  module SE
-    class Bankgiro
-      class InvalidOCR < StandardError; end
-      class OverlongOCR < InvalidOCR; end
-      class BadChecksum < InvalidOCR; end
-      class MustBeNumeric < InvalidOCR; end
-
-      class OCR
-        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
-
-          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 > 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 = {})
-          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.
-          digits_to_chop += 1 if strip_length_digit
-          digits_to_chop += strip_padding.length
-
-          number[0...-digits_to_chop]
-        end
-      end
-    end
-  end
-end