tracking_number 0.5.0 → 0.6.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzY2OGRiZjAzMTU1ODQxNTg4YTA2ZjhlZGVhZDdmZGMyNDIxYTg4MQ==
+  data.tar.gz: !binary |-
+    NTdhZWI1OTRlMWIwNTM3M2UxMThjMmJmZjJkNzVmZDA0NGI3MDI0ZQ==
+SHA512:
+  metadata.gz: !binary |-
+    YTJkYTVlMGUzYjIwZWUyNTdjYTAwZDg5YjU2YjlkMDI4NWFmN2VjM2NiMzU4
+    MDM1MjFiNDEyZmI3MTNhZjBiYTgwMTAxZjhiNTQ0ZGM4ZTQ1OTUxNWNiODAw
+    YmVjNWQwZGQwMDQ0N2YxZWM2YTUxYTRiMTk2OTU4NjBlZjZjNzM=
+  data.tar.gz: !binary |-
+    YmFiNDcxMjBjMDU5NzNhZWI0YzJmYmQ5YjIzYjkxMzJlOGQ2M2M5ZTVkYzRm
+    MTQzNTc2NmIxNTJiZDIzZGRmNjhkMTI0MDIzOTI5OTE1MzA2Y2FmMDEwNzZl
+    MjBjMDgwYjZjMWUzOTgyNThkZjc1MmI5MmQ5YjcxMzFkYzM0MDM=

data/.gitignore

@@ -40,3 +40,4 @@ pkg
 #
 # For vim:
 #*.swp
+Gemfile.lock

data/README.rdoc

@@ -16,8 +16,22 @@ TrackingNumber.search("Lorem ipsum dolor sit amet, consectetur adipisicing elit,
 
 #=> [TrackingNumber, TrackingNumber]
 
+== ActiveModel validation
+
+For Rails 3 (or any ActiveModel client), validate your fields as a tracking number:
+
+    class Shipment < ActiveRecord::Base
+      validates :tracking, :tracking_number => true
+    end
+
+Sometimes it's helpful to have a "magic" tracking number that isn't valid for any of the real carriers, and maybe will have other side effects (e.g., special treatment of a shipping email.)
+
+    class Shipment < ActiveRecord::Base
+      validates :tracking, :tracking_number => { :except => 'magic-hand-delivery' }
+    end
+
 == 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

data/Rakefile

@@ -1,20 +1,7 @@
 require 'rubygems'
 require 'bundler'
 Bundler::GemHelper.install_tasks
-
-# if not defined?(Bundler)
-#   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
-# end
-
 require 'rake'
-
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
@@ -22,17 +9,10 @@ Rake::TestTask.new(:test) do |test|
   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|
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
   $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
   require 'tracking_number'
 

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/tracking_number/active_model_validator.rb

@@ -0,0 +1,12 @@
+class TrackingNumberValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return unless value.present?
+    if options[:exception] == value
+      # magic valid value (an exception that says "not really shipped" or something)
+    elsif TrackingNumber.new(value).valid?
+      # looks good to me
+    else
+      record.errors[attribute] << options[:message] || 'is not a valid tracking number'
+    end
+  end
+end

data/lib/tracking_number/base.rb

@@ -1,6 +1,8 @@
 module TrackingNumber
   class Base
     attr_accessor :tracking_number
+    attr_accessor :original_number
+
     def initialize(tracking_number)
       @original_number = tracking_number
       @tracking_number = tracking_number.strip.gsub(" ", "").upcase
@@ -13,16 +15,16 @@ module TrackingNumber
       valids.each do |t|
         uniques[t.tracking_number] = t unless uniques.has_key?(t.tracking_number)
       end
-      
+
       uniques.values
     end
-    
+
     def self.scan(body)
       patterns = [self.const_get("SEARCH_PATTERN")].flatten
       possibles = patterns.collect do |pattern|
         body.scan(pattern).uniq.flatten
       end
-      
+
       possibles.flatten.compact.uniq
     end
 
@@ -35,7 +37,7 @@ module TrackingNumber
     def valid_format?
       !matches.nil? && !matches.empty?
     end
-    
+
     def decode
       {}
     end

data/lib/tracking_number/fedex.rb

@@ -9,7 +9,7 @@ module TrackingNumber
     SEARCH_PATTERN = /(\b([0-9]\s*){12,12}\b)/
     VERIFY_PATTERN = /^([0-9]{11,11})([0-9])$/
     LENGTH = 12
-    
+
     def matches
       self.tracking_number.scan(VERIFY_PATTERN).flatten
     end
@@ -22,21 +22,21 @@ module TrackingNumber
       return (total % 11) == check.to_i
     end
   end
-  
+
   #TODO Fix these FedEx ground numberss
 
   class FedExGround96 < FedEx
     SEARCH_PATTERN = /(\b9\s*6\s*([0-9]\s*){20,20}\b)/
     VERIFY_PATTERN = /^96[0-9]{5,5}([0-9]{14,14})([0-9])$/
     LENGTH = 22
-    
+
     def matches
       self.tracking_number.scan(VERIFY_PATTERN).flatten
     end
 
     def decode
       {:application_id => self.tracking_number.to_s.slice(0...2),
-       :serial_container =>  self.tracking_number.to_s.slice(2...4), 
+       :serial_container =>  self.tracking_number.to_s.slice(2...4),
        :service_code => self.tracking_number.to_s.slice(4...7),
        :shipper_id =>  self.tracking_number.to_s.slice(7...14),
        :package_identifier =>  self.tracking_number.to_s.slice(14...21),
@@ -48,7 +48,7 @@ module TrackingNumber
       # 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)
@@ -72,7 +72,7 @@ module TrackingNumber
     SEARCH_PATTERN = /(\b([0-9]\s*){15,15}\b)/
     VERIFY_PATTERN = /^([0-9]{15,15})$/
     LENGTH = 15
-    
+
     def matches
       self.tracking_number.scan(VERIFY_PATTERN).flatten
     end
@@ -95,25 +95,25 @@ module TrackingNumber
     SEARCH_PATTERN = /(\b([0-9]\s*){18,18}\b)/
     VERIFY_PATTERN = /^[0-9]{2,2}([0-9]{15,15})([0-9])$/
     LENGTH = 20
-    
+
     def matches
       self.tracking_number.scan(VERIFY_PATTERN).flatten
     end
 
     def decode
       {:application_id => self.tracking_number.to_s.slice(0...2),
-       :serial_container =>  self.tracking_number.to_s.slice(1...2), 
+       :serial_container =>  self.tracking_number.to_s.slice(1...2),
        :service_code => self.tracking_number.to_s.slice(2...3),
        :shipper_id =>  self.tracking_number.to_s.slice(3...10),
        :package_identifier =>  self.tracking_number.to_s.slice(10...17),
        :check_digit => self.tracking_number.slice(17...18)
       }
     end
-    
+
     def valid_checksum?
       # [0-9]{2,2} - Not used
       # [0-9]{15, 15} - used for calculation
-      
+
       sequence = tracking_number.chars.to_a.map(&:to_i)
       check_digit = sequence.pop
       total = 0

data/lib/tracking_number/ups.rb

@@ -2,7 +2,7 @@ module TrackingNumber
   class UPS < Base
     SEARCH_PATTERN = /(\b1\s*Z\s*(\w\s*){16,16}\b)/
     VERIFY_PATTERN = /^1Z(\w{15,15})(\w)$/
-    
+
     def carrier
       :ups
     end
@@ -33,7 +33,7 @@ module TrackingNumber
     end
 
     def decode
-      {:shipper_account =>  self.tracking_number.to_s.slice(2...8), 
+      {:shipper_account =>  self.tracking_number.to_s.slice(2...8),
        :service_type => self.tracking_number.to_s.slice(8...10),
        :package_identifier =>  self.tracking_number.to_s.slice(10...17),
        :check_digit => self.tracking_number.to_s.slice(17, 18)

data/lib/tracking_number/usps.rb

@@ -4,14 +4,14 @@ module TrackingNumber
       :usps
     end
   end
-  
+
   class USPS91 < USPS
     SEARCH_PATTERN = [/(\b9\s*[14]\s*(([0-9]\s*){20,20}\b))/, /(\b([0-9]\s*){20,20}\b)/]
     VERIFY_PATTERN = /^(9[14][0-9]{19,19})([0-9])$/
-  
+
     # Sometimes these numbers will appear without the leading 91 or 94, though, so we need to account for that case
-    
-    def decode 
+
+    def decode
       # Application ID: 91 or 94
       # Service Code: 2 Digits
       # Mailer Id: 8 Digits
@@ -19,13 +19,13 @@ module TrackingNumber
       # Checksum: 1 Digit
 
       {:application_id => self.tracking_number.to_s.slice(0...2),
-       :service_code =>  self.tracking_number.to_s.slice(2...4), 
+       :service_code =>  self.tracking_number.to_s.slice(2...4),
        :mailer_id => self.tracking_number.to_s.slice(4...12),
        :package_identifier =>  self.tracking_number.to_s.slice(12...21),
        :check_digit => self.tracking_number.slice(21...22)
       }
     end
-    
+
     def matches
       if self.tracking_number =~ /^9[14]/
         self.tracking_number.scan(VERIFY_PATTERN).flatten
@@ -33,10 +33,10 @@ module TrackingNumber
         "91#{self.tracking_number}".scan(VERIFY_PATTERN).flatten
       end
     end
-    
+
     def valid_checksum?
-      if self.tracking_number =~ /^9[14]/ 
-        return true if weighted_usps_checksum_valid?(tracking_number) 
+      if self.tracking_number =~ /^9[14]/
+        return true if weighted_usps_checksum_valid?(tracking_number)
       else
         if weighted_usps_checksum_valid?("91#{self.tracking_number}")
           # set the tracking number to the 91 format if it passes this test
@@ -45,13 +45,13 @@ module TrackingNumber
         end
       end
     end
-    
+
     private
-    
+
     def weighted_usps_checksum_valid?(sequence)
       chars = sequence.chars.to_a
       check_digit = chars.pop
-      
+
       total = 0
       chars.reverse.each_with_index do |c, i|
         x = c.to_i
@@ -65,26 +65,26 @@ module TrackingNumber
       return true if check == check_digit.to_i
     end
   end
-  
+
   class USPS20 < USPS
     # http://www.usps.com/cpim/ftp/pubs/pub109.pdf (Publication 109. Extra Services Technical Guide, pg. 19)
     # http://www.usps.com/cpim/ftp/pubs/pub91.pdf (Publication 91. Confirmation Services Technical Guide pg. 38)
-    
+
     SEARCH_PATTERN = /(\b([0-9]\s*){20,20}\b)/
     VERIFY_PATTERN = /^([0-9]{2,2})([0-9]{9,9})([0-9]{8,8})([0-9])$/
 
     def matches
       self.tracking_number.scan(VERIFY_PATTERN).flatten
     end
-    
+
     def decode
-      {:service_code =>  self.tracking_number.to_s.slice(0...2), 
+      {:service_code =>  self.tracking_number.to_s.slice(0...2),
        :mailer_id => self.tracking_number.to_s.slice(2...11),
        :package_identifier =>  self.tracking_number.to_s.slice(11...19),
        :check_digit => self.tracking_number.slice(19...20)
       }
     end
-    
+
     def service_type
       case decode[:service_code]
       when "71"
@@ -97,11 +97,11 @@ module TrackingNumber
         "Return Receipt for Merchandise"
       end
     end
-    
+
     def valid_checksum?
       chars = tracking_number.chars.to_a
       check_digit = chars.pop
-      
+
       total = 0
       chars.reverse.each_with_index do |c, i|
         x = c.to_i
@@ -114,11 +114,11 @@ module TrackingNumber
       return true if check == check_digit.to_i
     end
   end
-  
+
   class USPS13 < USPS
     SEARCH_PATTERN = /(\b([A-Z]\s*){2,2}([0-9]\s*){9,9}([A-Z]\s*){2,2}\b)/
     VERIFY_PATTERN = /^([A-Z]{2,2})([0-9]{9,9})([A-Z]{2,2})$/
-    
+
     def matches
       self.tracking_number.scan(VERIFY_PATTERN).flatten
     end
@@ -127,12 +127,12 @@ module TrackingNumber
       sequence = tracking_number.scan(/[0-9]+/).flatten.join
       chars = sequence.chars.to_a
       check_digit = chars.pop.to_i
-      
+
       sum = 0
       chars.zip([8,6,4,2,3,5,9,7]).each do |pair|
         sum += (pair[0].to_i * pair[1].to_i)
       end
-      
+
       remainder = sum % 11
       check = case remainder
       when 1
@@ -142,7 +142,7 @@ module TrackingNumber
       else
         11 - remainder
       end
-      
+
       return check == check_digit
     end
   end

data/lib/tracking_number/version.rb

@@ -1,3 +1,3 @@
 module TrackingNumber
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/tracking_number.rb

@@ -10,6 +10,10 @@ require 'tracking_number/ups'
 require 'tracking_number/dhl'
 require 'tracking_number/ontrac'
 
+if defined?(ActiveModel::EachValidator)
+  require 'tracking_number/active_model_validator'
+end
+
 module TrackingNumber
   TYPES = [UPS, FedExExpress, FedExGround, FedExGround18, FedExGround96, USPS91, USPS20, USPS13, DHL, OnTrac]
 

data/test/active_model_validator_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class TrackingNumberValidatorTest < Test::Unit::TestCase
+  class Validatable
+    include ActiveModel::Validations
+    attr_accessor :tracking_number
+    ERROR_MESSAGE = "must be valid, or 'magic' to prevent inclusion in confirmation email"
+    validates :tracking_number, :presence => true,
+              :tracking_number => {
+                :exception => 'magic',
+                :message => ERROR_MESSAGE
+              }
+  end
+  def test_valid_numbers
+    %w(magic 790535312317).each do |valid_tracking_number|
+      obj = Validatable.new
+      obj.tracking_number = valid_tracking_number
+      assert obj.valid?, "should allow tracking_number #{valid_tracking_number}"
+    end
+  end
+  def test_invalid_numbers
+    %w(wrong 1234).each do |invalid_tracking_number|
+      obj = Validatable.new
+      obj.tracking_number = invalid_tracking_number
+      assert !obj.valid?
+      assert_equal obj.errors[:tracking_number], [Validatable::ERROR_MESSAGE]
+    end
+  end
+end

data/test/fedex_tracking_number_test.rb

@@ -21,7 +21,7 @@ class FedExTrackingNumberTest < Test::Unit::TestCase
         should_detect_number_variants(valid_number, TrackingNumber::FedExGround96)
       end
     end
-    
+
     ["0414 4176 0228 964", "5682 8361 0012 000", "5682 8361 0012 734"].each do |valid_number|
       should "return fedex ground for #{valid_number}" do
         should_be_valid_number(valid_number, TrackingNumber::FedExGround, :fedex)

data/test/test_helper.rb

@@ -1,16 +1,9 @@
+require 'simplecov'
+SimpleCov.start
 require 'rubygems'
-# if not defined?(Bundler)
-#   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
-# end
 require 'test/unit'
 require 'shoulda'
+require 'active_model'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -38,7 +31,7 @@ class Test::Unit::TestCase
   end
 
   def should_detect_number_variants(valid_number, type)
-    possible_strings(valid_number).each do |string|      
+    possible_strings(valid_number).each do |string|
       results = type.search(string)
       assert_equal 1, results.size, "could not find #{type} #{valid_number} in #{string}"
     end

data/test/usps_tracking_number_test.rb

@@ -11,7 +11,7 @@ class USPSTrackingNumberTest < Test::Unit::TestCase
         should_detect_number_variants(valid_number, TrackingNumber::USPS91)
       end
     end
-    
+
     ["0307 1790 0005 2348 3741"].each do |valid_number|
       should "return usps with valid 20 digit number: #{valid_number}" do
         should_be_valid_number(valid_number, TrackingNumber::USPS20, :usps)

data/tracking_number.gemspec

@@ -29,21 +29,19 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, [">= 0"])
       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"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<activemodel>, [">= 3"])
     else
+      s.add_dependency(%q<rake>, [">= 0"])
       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"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rake>, [">= 0"])
     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"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
   end
 end
 

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tracking_number
 version: !ruby/object:Gem::Version
-  version: 0.5.0
-  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors:
 - Jeff Keen
@@ -11,28 +10,62 @@ bindir: bin
 cert_chain: []
 date: 2011-04-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70300998016440 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70300998016440
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &70300998015740 !ruby/object:Gem::Requirement
-    none: false
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70300998015740
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Match tracking numbers to a service, and search blocks of text and pull
   out valid tracking numbers.
 email: jeff@keen.me
@@ -45,12 +78,12 @@ files:
 - .document
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/tracking_number.rb
+- lib/tracking_number/active_model_validator.rb
 - lib/tracking_number/base.rb
 - lib/tracking_number/dhl.rb
 - lib/tracking_number/fedex.rb
@@ -58,6 +91,7 @@ files:
 - lib/tracking_number/ups.rb
 - lib/tracking_number/usps.rb
 - lib/tracking_number/version.rb
+- test/active_model_validator_test.rb
 - test/dhl_tracking_number_test.rb
 - test/fedex_tracking_number_test.rb
 - test/ontrac_tracking_number_test.rb
@@ -69,33 +103,25 @@ files:
 homepage: http://github.com/jkeen/tracking_number
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 3
 summary: Identifies valid tracking numbers
-test_files:
-- test/dhl_tracking_number_test.rb
-- test/fedex_tracking_number_test.rb
-- test/ontrac_tracking_number_test.rb
-- test/test_helper.rb
-- test/tracking_number_test.rb
-- test/ups_tracking_number_test.rb
-- test/usps_tracking_number_test.rb
+test_files: []

data/Gemfile.lock

@@ -1,18 +0,0 @@
-PATH
-  remote: .
-  specs:
-    tracking_number (0.4.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    rcov (0.9.9)
-    shoulda (2.11.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rcov
-  shoulda
-  tracking_number!