tracking_number 0.1.0 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/tracking_number.rb

@@ -5,12 +5,12 @@
 
 class TrackingNumber
   SEARCH_PATTERNS = {
-    :ups => /\b1Z\w{16,16}\b/,
-    :fedex_express => /\b[0-9]{12,12}\b/,
-    :fedex_ground_96 => /\b96[0-9]{20,20}\b/,
-    :fedex_ground_sscc18 => /\b[0-9]{18,18}\b/,
-    :dhl => /\b[0-9]{11,11}\b/,
-    :usps => /\b[0-9]{22,22}\b/
+    :ups => /(\b1\s*Z\s*(\w\s*){16,16}\b)/,
+    :fedex_express => /(\b([0-9]\s*){12,12}\b)/,
+    :fedex_ground_96 => /(\b9\s*6\s*([0-9]\s*){20,20}\b)/,
+    :fedex_ground_sscc18 => /(\b([0-9]\s*){18,18}\b)/,
+    :dhl => /(\b([0-9]\s*){11,11}\b)/,
+    :usps => /(\b([0-9]\s*){22,22}\b)/
   }
 
   VERIFY_PATTERNS = {
@@ -22,151 +22,158 @@ class TrackingNumber
     :usps => /^([0-9]{21,21})([0-9])/
   }
 
+  def self.scan(body)
+    possibles = SEARCH_PATTERNS.values.collect { |pattern| 
+      body.scan(pattern)
+    }.uniq.flatten
+  end
+
   def self.search(body)
-   possibles = SEARCH_PATTERNS.values.collect { |pattern| 
-     body.scan(pattern)
-   }.uniq.flatten
-   
-   possibles.collect { |possible| TrackingNumber.new(possible) }.select { |t| t.valid? }
+   self.scan(body).uniq.collect { |possible| TrackingNumber.new(possible) }.select { |t| t.valid? }
   end
 
   def initialize(tracking_number)
-   @tracking_number = tracking_number.to_s.upcase.gsub(/\s/,"")
-    end
+    @original_number = tracking_number
+    @tracking_number = tracking_number.to_s.upcase.gsub(/\s/,"")
+  end
 
-    def valid?
-      carrier != :unknown
-    end
+  def valid?
+    carrier != :unknown
+  end
 
-    def carrier
-      @carrier = if ups?(@tracking_number)
-        :ups
-      elsif fedex_express?(@tracking_number)
-        :fedex
-      elsif fedex_ground_96?(@tracking_number)
-        :fedex
-      elsif fedex_ground_sscc18?(@tracking_number)
-        :fedex
-      elsif usps?(@tracking_number)
-        :usps
-      elsif dhl?(@tracking_number)
-        :dhl
-      else
-        :unknown
-      end
+  def carrier
+    @carrier = if ups?(@tracking_number)
+      :ups
+    elsif fedex_express?(@tracking_number)
+      :fedex
+    elsif fedex_ground_96?(@tracking_number)
+      :fedex
+    elsif fedex_ground_sscc18?(@tracking_number)
+      :fedex
+    elsif usps?(@tracking_number)
+      :usps
+    elsif dhl?(@tracking_number)
+      :dhl
+    else
+      :unknown
     end
+  end
+  
+  def original_number
+    @original_number
+  end
+  
+  def tracking_number
+    @tracking_number
+  end
 
-    def tracking_number
-      @tracking_number
-    end
+  def to_s
+    @tracking_number
+  end
 
-    def to_s
-      @tracking_number
-    end
+  private
+
+    def ups?(tracking_number)
+      results = tracking_number.scan(VERIFY_PATTERNS[:ups])
+      return false if results.nil? || results.empty?
 
-    private
-
-      def ups?(tracking_number)
-        results = tracking_number.scan(VERIFY_PATTERNS[:ups])
-        return false if results.nil? || results.empty?
-
-        sequence, check_digit = results.flatten
-        total = 0
-        sequence.chars.each_with_index do |c, i|
-          x = if c[/[0-9]/] # numeric
-            c.to_i
-          else
-            (c[0].ord - 3) % 10
-          end
-          x *= 2 if i.odd?
-          total += x
+      sequence, check_digit = results.flatten
+      total = 0
+      sequence.chars.each_with_index do |c, i|
+        x = if c[/[0-9]/] # numeric
+          c.to_i
+        else
+          (c[0].ord - 3) % 10
         end
+        x *= 2 if i.odd?
+        total += x
+      end
 
-        check = (total % 10)
-        check = (10 - check) unless (check.zero?)
+      check = (total % 10)
+      check = (10 - check) unless (check.zero?)
 
-        return true if (check.to_i == check_digit.to_i)
-      end
+      return true if (check.to_i == check_digit.to_i)
+    end
 
 
-      def fedex_express?(tracking_number)
-        results = tracking_number.scan(VERIFY_PATTERNS[:fedex_express]).flatten
-        return false if results.nil? || results.empty?
-        sequence, check = results
+    def fedex_express?(tracking_number)
+      results = tracking_number.scan(VERIFY_PATTERNS[:fedex_express]).flatten
+      return false if results.nil? || results.empty?
+      sequence, check = results
 
-        sequence = sequence.chars.to_a.map(&:to_i)
-        total = 0
-        sequence.zip([3,1,7,3,1,7,3,1,7,3,1]).collect { |pair| pair[0] * pair[1] }.each { |t| total += t.to_i }
-        return true if (total % 11) == check.to_i
-      end
+      sequence = sequence.chars.to_a.map(&:to_i)
+      total = 0
+      sequence.zip([3,1,7,3,1,7,3,1,7,3,1]).collect { |pair| pair[0] * pair[1] }.each { |t| total += t.to_i }
+      return true if (total % 11) == check.to_i
+    end
 
-      def fedex_ground_96?(tracking_number)
-        # 22 numbers
-        # http://fedex.com/us/solutions/ppe/FedEx_Ground_Label_Layout_Specification.pdf
-        # 96 - UCC/EAN Application Identifier
-        # [0-9]{2,2} - SCNC
-        # [0-9]{3,3} - Class Of Service
-
-        # [0-9]{7,7} - RPS Shipper ID (used in calculation)
-        # [0-9]{7,7} - Package Number (used in calculation)
-
-        # [0-9]      - Check Digit
-        results = tracking_number.scan(VERIFY_PATTERNS[:fedex_ground_96]).flatten
-        return false if results.nil? || results.empty?
-
-        sequence, check_digit = results.flatten
-        total = 0
-        sequence.chars.to_a.reverse.map(&:to_i).each_with_index do |x, i|
-          x *= 3 if i.even?
-          total += x
-        end
-        check = total % 10
-        check = (10 - check) unless (check.zero?)
-        return true if check == check_digit.to_i
+    def fedex_ground_96?(tracking_number)
+      # 22 numbers
+      # http://fedex.com/us/solutions/ppe/FedEx_Ground_Label_Layout_Specification.pdf
+      # 96 - UCC/EAN Application Identifier
+      # [0-9]{2,2} - SCNC
+      # [0-9]{3,3} - Class Of Service
+
+      # [0-9]{7,7} - RPS Shipper ID (used in calculation)
+      # [0-9]{7,7} - Package Number (used in calculation)
+
+      # [0-9]      - Check Digit
+      results = tracking_number.scan(VERIFY_PATTERNS[:fedex_ground_96]).flatten
+      return false if results.nil? || results.empty?
+
+      sequence, check_digit = results.flatten
+      total = 0
+      sequence.chars.to_a.reverse.map(&:to_i).each_with_index do |x, i|
+        x *= 3 if i.even?
+        total += x
       end
+      check = total % 10
+      check = (10 - check) unless (check.zero?)
+      return true if check == check_digit.to_i
+    end
 
-      def fedex_ground_sscc18?(tracking_number)
-        # [0-9]{2,2} - Not used
-        # [0-9]{15, 15} - used for calculation
-        results = tracking_number.scan(VERIFY_PATTERNS[:fedex_ground_sscc18]).flatten
-        return false if results.nil? || results.empty?
-        sequence, check_digit = results
-        total = 0
-        sequence.chars.to_a.map(&:to_i).reverse.each_with_index do |x, i|
-          x *= 3 if i.even?
-          total += x
-        end
-
-        check = total % 10
-        check = (10 - check) unless (check.zero?)
-        return true if check == check_digit.to_i
+    def fedex_ground_sscc18?(tracking_number)
+      # [0-9]{2,2} - Not used
+      # [0-9]{15, 15} - used for calculation
+      results = tracking_number.scan(VERIFY_PATTERNS[:fedex_ground_sscc18]).flatten
+      return false if results.nil? || results.empty?
+      sequence, check_digit = results
+      total = 0
+      sequence.chars.to_a.map(&:to_i).reverse.each_with_index do |x, i|
+        x *= 3 if i.even?
+        total += x
       end
 
-      def dhl?(tracking_number)
-        # standard mod 7 check
-        results = tracking_number.scan(VERIFY_PATTERNS[:dhl]).flatten
-        return false if results.nil? || results.empty?
+      check = total % 10
+      check = (10 - check) unless (check.zero?)
+      return true if check == check_digit.to_i
+    end
 
-        sequence, check_digit = results
-        return true if sequence.to_i % 7 == check_digit.to_i
-      end
+    def dhl?(tracking_number)
+      # standard mod 7 check
+      results = tracking_number.scan(VERIFY_PATTERNS[:dhl]).flatten
+      return false if results.nil? || results.empty?
 
-      def usps?(tracking_number)
-        # standard mod 10 check
-        results = tracking_number.scan(VERIFY_PATTERNS[:usps]).flatten
-        return false if results.nil? || results.empty?
+      sequence, check_digit = results
+      return true if sequence.to_i % 7 == check_digit.to_i
+    end
 
-        sequence, check_digit = results
-        total = 0
-        sequence.chars.to_a.reverse.each_with_index do |c, i|
-          x = c.to_i
-          x *= 3 if i.even?
+    def usps?(tracking_number)
+      # standard mod 10 check
+      results = tracking_number.scan(VERIFY_PATTERNS[:usps]).flatten
+      return false if results.nil? || results.empty?
 
-          total += x
-        end
+      sequence, check_digit = results
+      total = 0
+      sequence.chars.to_a.reverse.each_with_index do |c, i|
+        x = c.to_i
+        x *= 3 if i.even?
 
-        check = total % 10
-        check = 10 - check unless (check.zero?)
-        return true if check == check_digit.to_i
-      end
+        total += x
       end
+
+      check = total % 10
+      check = 10 - check unless (check.zero?)
+      return true if check == check_digit.to_i
+    end
+end

data/test/test_helper.rb

@@ -15,4 +15,14 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'tracking_number'
 
 class Test::Unit::TestCase
+  def possible_numbers(tracking)
+    possible_numbers = []
+    possible_numbers << tracking
+    possible_numbers << tracking.chars.to_a.join(" ")
+    possible_numbers << tracking.chars.to_a.join("  ")
+    possible_numbers << tracking.slice(0, (tracking.length / 2)) + "  " + tracking.slice((tracking.length / 2), tracking.length)
+    
+    possible_numbers
+  end
+  
 end

data/test/test_tracking_number.rb

@@ -1,61 +1,96 @@
 require 'test_helper'
 
-class TrackingNumberTest < Test::Unit::TestCase
-  should "return ups with valid ups number" do
-    assert_equal :ups, TrackingNumber.new("1Z5R89390357567127").carrier
-    assert_equal :ups, TrackingNumber.new("1Z879E930346834440").carrier 
-    assert_equal :ups, TrackingNumber.new("1Z410E7W0392751591").carrier 
-    assert_equal :ups, TrackingNumber.new("1Z8V92A70367203024").carrier 
+class TrackingNumberTest < Test::Unit::TestCase 
+  context "a UPS tracking number" do
+    should "return ups as the carrier" do
+      assert_equal :ups, TrackingNumber.new("1Z5R89390357567127").carrier
+      assert_equal :ups, TrackingNumber.new("1Z879E930346834440").carrier 
+      assert_equal :ups, TrackingNumber.new("1Z410E7W0392751591").carrier 
+      assert_equal :ups, TrackingNumber.new("1Z8V92A70367203024").carrier 
+    end
   end
-  
-  should "return fedex with valid fedex express number" do
-    t = TrackingNumber.new("986578788855")
-    assert_equal :fedex, t.carrier
-    assert t.valid?
+
+  context "a FedEx tracking number" do  
+    should "return fedex as the carrier if it's a valid fedex express number" do
+      t = TrackingNumber.new("986578788855")
+      assert_equal :fedex, t.carrier
+      assert t.valid?
     
-    t = TrackingNumber.new("477179081230")
-    assert_equal :fedex, t.carrier 
-    assert t.valid?
-  end
+      t = TrackingNumber.new("477179081230")
+      assert_equal :fedex, t.carrier 
+      assert t.valid?
+    end
   
-  should "return fedex with valid fedex ground (96) number" do
-    t = TrackingNumber.new("9611020987654312345672")
-    assert_equal :fedex, t.carrier 
-    assert t.valid?    
-  end
+    should "return fedex as the carrier with valid fedex ground (96) number" do
+      t = TrackingNumber.new("9611020987654312345672")
+      assert_equal :fedex, t.carrier 
+      assert t.valid?    
+    end
 
-  should "return fedex with valid fedex ground (SSCC18) number" do
-    t = TrackingNumber.new("000123450000000027")
-    assert_equal :fedex, t.carrier 
-    assert t.valid?
+    should "return fedex as the carrier with valid fedex ground (SSCC18) number" do
+      t = TrackingNumber.new("000123450000000027")
+      assert_equal :fedex, t.carrier 
+      assert t.valid?
+    end
   end
   
-  should "return dhl with valid dhl number" do
-    t = TrackingNumber.new("73891051146")
-    assert_equal :dhl, t.carrier
-    assert t.valid?
+  context "a DHL tracking number" do
+    should "return dhl if it's a valid number" do
+      t = TrackingNumber.new("73891051146")
+      assert_equal :dhl, t.carrier
+      assert t.valid?
+    end    
   end
   
-  should "return usps with valid usps number" do
-    t = TrackingNumber.new("9101 1234 5678 9000 0000 13")
-    assert_equal :usps, t.carrier
-    assert t.valid?
+  context "a USPS tracking number" do  
+    should "return usps with if number" do
+      t = TrackingNumber.new("9101 1234 5678 9000 0000 13")
+      assert_equal :usps, t.carrier
+      assert t.valid?
+    end
   end
   
-  should "return unknown when given invalid number" do
-    t = TrackingNumber.new("101")
-    assert_equal :unknown, t.carrier
-    assert !t.valid?
-  end
+  context "a tracking number" do
+    should "return unknown when given invalid number" do
+      t = TrackingNumber.new("101")
+      assert_equal :unknown, t.carrier
+      assert !t.valid?
+    end
   
-  should "upcase and remove spaces from tracking number" do
-    t = TrackingNumber.new("abc 123 def")
-    assert_equal "ABC123DEF", t.tracking_number
+    should "upcase and remove spaces from tracking number" do
+      t = TrackingNumber.new("abc 123 def")
+      assert_equal "ABC123DEF", t.tracking_number
+    end
   end
   
-  should "return two tracking numbers when given test search string" do
-    s = TrackingNumber.search("Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, 1Z879E930346834440 nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute 9611020987654312345672 dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.")
+  context "tracking number search" do  
+    [{"73891051146" => :dhl}, 
+     {"1Z8V92A70367203024" => :ups}, 
+     {"000123450000000027" => :fedex}, {"9611020987654312345672" => :fedex}, {"477179081230" => :fedex}, 
+     {"9101123456789000000013" => :usps}].each do |pair|
+      expected_service = pair.to_a.flatten[1]
+      tracking = pair.to_a.flatten[0]
+          
+      should "detect #{expected_service} with number #{tracking} regardless of spacing" do 
+        possible_numbers(tracking).each do |spaced_tracking|
+          results = TrackingNumber.search("blah blah #{spaced_tracking} blah blah")
+          assert_equal 1, results.size, "#{spaced_tracking} did not match #{expected_service}"
+          assert_equal expected_service, results.first.carrier
+        end
+      end
     
-    assert_equal 2, s.size
+      should "not detect #{expected_service} when word word boundaries are not in tact" do  
+        possible_numbers(tracking).each do |spaced_tracking|
+          bad_number = "x1#{spaced_tracking}1x"          
+          results = TrackingNumber.search("blah blah #{bad_number} blah blah")
+          assert_equal 0, results.size, "#{bad_number} should not match #{expected_service}"
+        end
+      end
+      
+      should "return two tracking numbers when given string with two" do
+        s = TrackingNumber.search("Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, 1Z879E930346834440 nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute 9611020987654312345672 dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.")
+        assert_equal 2, s.size
+      end
+    end
   end
 end

data/tracking_number.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{tracking_number}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Keen"]
-  s.date = %q{2010-12-30}
+  s.date = %q{2011-01-29}
   s.description = %q{Match tracking numbers to a service, and search blocks of text and pull out valid tracking numbers.}
   s.email = %q{jeff@keen.me}
   s.extra_rdoc_files = [

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jeff Keen
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-30 00:00:00 -06:00
+date: 2011-01-29 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -108,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2711137712783242213
+      hash: -1308548554367875831
       segments: 
       - 0
       version: "0"