tracking_number 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jeff Keen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,33 @@
+= tracking_number
+
+Identifies valid tracking numbers and the service they're associated with.
+
+t = TrackingNumber.new("MYSTERY_TRACKING_NUMBER")
+t.valid? #=> false
+t.carrier #=> :unknown
+
+t = TrackingNumber.new("1Z879E930346834440")
+t.valid? #=> true
+t.carrier #=> :ups
+
+Also can take a block of text and find all the valid tracking numbers within it
+
+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.")
+
+#=> [TrackingNumber, TrackingNumber]
+
+== Contributing to tracking_number
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Jeff Keen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "tracking_number"
+  gem.homepage = "http://github.com/jkeen/tracking_number"
+  gem.license = "MIT"
+  gem.summary = %Q{Identifies valid tracking numbers}
+  gem.description = %Q{Match tracking numbers to a service, and search blocks of text and pull out valid tracking numbers.}
+  gem.email = "jeff@keen.me"
+  gem.authors = ["Jeff Keen"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tracking_number #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/tracking_number.rb

@@ -0,0 +1,172 @@
+# Identify if tracking numbers are valid, and which service they belong to
+
+# Information on validating tracking numbers found here:
+# http://answers.google.com/answers/threadview/id/207899.html
+
+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/
+  }
+
+  VERIFY_PATTERNS = {
+    :ups => /^1Z(\w{15,15})(\w)$/,
+    :fedex_express => /^([0-9]{11,11})([0-9])$/,
+    :fedex_ground_96 => /^96[0-9]{5,5}([0-9]{14,14})([0-9])$/,
+    :fedex_ground_sscc18 => /^[0-9]{2,2}([0-9]{15,15})([0-9])$/,
+    :dhl => /^([0-9]{10,10})([0-9])$/,
+    :usps => /^([0-9]{21,21})([0-9])/
+  }
+
+  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? }
+  end
+
+  def initialize(tracking_number)
+   @tracking_number = tracking_number.to_s.upcase.gsub(/\s/,"")
+    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
+    end
+
+    def tracking_number
+      @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?
+
+        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?)
+
+        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
+
+        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
+      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
+      end
+
+      def dhl?(tracking_number)
+        # standard mod 7 check
+        results = tracking_number.scan(VERIFY_PATTERNS[:dhl]).flatten
+        return false if results.nil? || results.empty?
+
+        sequence, check_digit = results
+        return true if sequence.to_i % 7 == check_digit.to_i
+      end
+
+      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
+        total = 0
+        sequence.chars.to_a.reverse.each_with_index do |c, i|
+          x = c.to_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
+      end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tracking_number'
+
+class Test::Unit::TestCase
+end

data/test/test_tracking_number.rb

@@ -0,0 +1,61 @@
+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 
+  end
+  
+  should "return fedex with 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
+  
+  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 with valid fedex ground (SSCC18) number" do
+    t = TrackingNumber.new("000123450000000027")
+    assert_equal :fedex, t.carrier 
+    assert t.valid?
+  end
+  
+  should "return dhl with valid dhl number" do
+    t = TrackingNumber.new("73891051146")
+    assert_equal :dhl, t.carrier
+    assert t.valid?
+  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?
+  end
+  
+  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
+  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.")
+    
+    assert_equal 2, s.size
+  end
+end

data/tracking_number.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tracking_number}
+  s.version = "0.1.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.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 = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/tracking_number.rb",
+    "test/test_helper.rb",
+    "test/test_tracking_number.rb",
+    "tracking_number.gemspec"
+  ]
+  s.homepage = %q{http://github.com/jkeen/tracking_number}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Identifies valid tracking numbers}
+  s.test_files = [
+    "test/test_helper.rb",
+    "test/test_tracking_number.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: tracking_number
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeff Keen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-30 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Match tracking numbers to a service, and search blocks of text and pull out valid tracking numbers.
+email: jeff@keen.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tracking_number.rb
+- test/test_helper.rb
+- test/test_tracking_number.rb
+- tracking_number.gemspec
+has_rdoc: true
+homepage: http://github.com/jkeen/tracking_number
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2711137712783242213
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Identifies valid tracking numbers
+test_files: 
+- test/test_helper.rb
+- test/test_tracking_number.rb