banktools-se 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f480d8889741823d7cc4e020dff15d39406fd68
-  data.tar.gz: 547a6c83c6fe15e4a6e17f943a9b1b925ff1f3ad
+  metadata.gz: 74491115cff66b4bf05d2d842ebc5e244580c253
+  data.tar.gz: 51f456d3da82641e22dc0c236c84b0fdf9b1b66e
 SHA512:
-  metadata.gz: e2b9fa6aeae917ee57d0b2c98303b4437fdb9f7f084ef873cffefc3c9d243a111565f0bf52b7fb10e9af6cc502fee6a72c45ac021e344f9ba6dcdabeaab4b770
-  data.tar.gz: 1070b2bcecd0aca9bdb4a2de78bd94111242a42fa28b072d4ec06fccb15cc8f17e69bc269e0eb218ac4a8b1467b16b8cf68fec6242898da9c03e0f00bf2e0cb8
+  metadata.gz: b28bb0e72521ab8641fa2545002a4a86e6add6856d526c6a98f681002265aa3a4b8f531959c330beba6552fc6138fbd45f598f8fb9023092d9474b91ce491669
+  data.tar.gz: b61fb6be0c11bf1c784dec49d58a4ed199a9adfc244fe119aa2152e2e60c198fe70ca3d74a057bc6ac3985eff4fab3c5aac0a40b6681d8d2715a0a8a2ec1624a

data/.travis.yml

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

data/README.markdown

@@ -43,6 +43,11 @@ Inspired by [iulianu/iban-tools](https://github.com/iulianu/iban-tools). Please
     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.
+    BankTools::SE::OCR.find_all_in_string("OCR1230 and ref4564 and 789")  # => [ "1230", "4564" ]
+    BankTools::SE::OCR.find_all_in_string("1230 and 123067", length_digit: true, pad: "0")  # => [ "123067" ]
+
     # Plusgiro
 
     valid_account = BankTools::SE::Plusgiro.new("2865434")
@@ -105,7 +110,7 @@ Or install it yourself as:
 
 Possible improvements to make:
 
-  * Luhn validation based on [BGC docs](http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG910.pdf).
+  * Luhn validation based on [BGC docs](http://web.archive.org/web/20130613010943/http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG910.pdf).
 
 
 ## Also see

data/lib/banktools-se/account.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-# http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG910.pdf
+# http://web.archive.org/web/20130613010943/http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG910.pdf
 
 require "banktools-se/account/clearing_number"
 

data/lib/banktools-se/ocr.rb

@@ -1,4 +1,4 @@
-# http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG6070.pdf section 5.2
+# http://web.archive.org/web/20111216065227/http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG6070.pdf section 5.2
 
 module BankTools
   module SE
@@ -13,10 +13,10 @@ module BankTools
       MIN_LENGTH = 2
       MAX_LENGTH = 25
 
-      def self.from_number(number, opts = {})
+      def self.from_number(number, length_digit: false, pad: "")
         number = number.to_s
-        add_length_digit = opts.fetch(:length_digit, false)
-        pad = opts.fetch(:pad, "").to_s
+        add_length_digit = length_digit
+        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.
@@ -34,10 +34,10 @@ module BankTools
         number_with_ocr
       end
 
-      def self.to_number(number, opts = {})
+      def self.to_number(number, length_digit: false, pad: "")
         number = number.to_s
-        should_have_length_digit = opts.fetch(:length_digit, false)
-        strip_padding = opts.fetch(:pad, "").to_s
+        should_have_length_digit = length_digit
+        strip_padding = pad.to_s
 
         raise MustBeNumeric unless number.match(/\A\d+\z/)
         raise BadChecksum unless Utils.valid_luhn?(number)
@@ -61,6 +61,17 @@ module BankTools
 
         number[0...-digits_to_chop]
       end
+
+      def self.find_all_in_string(string, length_digit: false, pad: "")
+        string.scan(/\d+/).select { |candidate|
+          begin
+            to_number(candidate, length_digit: length_digit, pad: pad)
+            true
+          rescue InvalidOCR
+            false
+          end
+        }.uniq
+      end
     end
   end
 end

data/lib/banktools-se/version.rb

@@ -1,5 +1,5 @@
 module BankTools
   module SE
-    VERSION = "2.0.0"
+    VERSION = "2.1.0"
   end
 end

data/spec/ocr_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 require "banktools-se"
 
 describe BankTools::SE::OCR do
-  # http://www.bgc.se/upload/Gemensamt/Trycksaker/Manualer/BG6070.pdf section 5.2
+  # http://web.archive.org/web/20111216065227/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"
@@ -66,4 +66,24 @@ describe BankTools::SE::OCR do
       expect { BankTools::SE::OCR.to_number("garbage") }.to raise_error(BankTools::SE::OCR::MustBeNumeric)
     end
   end
+
+  describe ".find_all_in_string" do
+    it "detects only number sequences that are valid OCRs" do
+      expect(BankTools::SE::OCR.find_all_in_string("1230 1234 4564")).to eq [ "1230", "4564" ]
+    end
+
+    it "requires OCRs to comply with length_digit and pad options" do
+      string = "1230 4564 123067 456061"
+      expect(BankTools::SE::OCR.find_all_in_string(string)).to eq [ "1230", "4564", "123067", "456061" ]
+      expect(BankTools::SE::OCR.find_all_in_string(string, length_digit: true, pad: "0")).to eq [ "123067", "456061" ]
+    end
+
+    it "finds digits among any non-digit characters" do
+      expect(BankTools::SE::OCR.find_all_in_string("x1230x")).to eq [ "1230" ]
+    end
+
+    it "excludes duplicates" do
+      expect(BankTools::SE::OCR.find_all_in_string("1230 1230 4564")).to eq [ "1230", "4564" ]
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: banktools-se
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Henrik Nyh
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: banktools-se
-rubygems_version: 2.2.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Validate and normalize Swedish bank account numbers, plusgiro and bankgiro.