tracking_number 0.10.1 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8799619e95c7b19fe6450c03fce87028bb0a3fd8
-  data.tar.gz: 3e668840372f1fec3a347c222c62b503d04fdb73
+  metadata.gz: b29f70e5c8aca81b52b8e013d67345ee6dab7542
+  data.tar.gz: fd8291a569ba1ba082de8d318f6b2d8a82959030
 SHA512:
-  metadata.gz: 50abc9f65eb2a8452bf3c7066fe63d1c8fa940a60d9309f5eed519ae39709f169086bb8c568db5e8b9b1a7a20bee6ee353218fecd78c9980f50954e2850606a8
-  data.tar.gz: 84e0aeb6ad30b64c718c764b3f3493294f7c8c5549a3948da130cb5dbe48918df2f4094b6d3993c01167ae37656168988f35fc12162b2d9b03d1518780a475d7
+  metadata.gz: b762b796594d170ebee3e36d2ac81ba6de4ee5557c9bdff965c940fbd34218432bc4c8500ee9a84e3e9c50947d6cc571a0e3110ae6ce96c83bfe9b6b0560d99b
+  data.tar.gz: 64229ede64bae0dadaad30130ab2e7d16789e96fb39563e9474519d002ad7439135573483c4ecba54160c91a626caf6e2621eabcf33057751646db51b70447e9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tracking_number (0.10.1)
+    tracking_number (0.10.3)
 
 GEM
   remote: http://rubygems.org/
@@ -47,3 +47,6 @@ DEPENDENCIES
   shoulda
   simplecov
   tracking_number!
+
+BUNDLED WITH
+   1.11.2

data/{README.rdoc → README.md}

@@ -1,36 +1,52 @@
-= tracking_number
+## tracking_number
 
-Identifies valid tracking numbers and the service they're associated with.
+This gem identifies valid tracking numbers and the service they're associated with. It can also tell you a little bit about the package purely from the number—there's quite a bit of info tucked away into those numbers, it turns out.
 
+This gem does not do tracking. That is left up to you.
+
+```ruby
 t = TrackingNumber.new("MYSTERY_TRACKING_NUMBER")
+# => #<TrackingNumber::Unknown MYSTERY_TRACKING_NUMBER>
+
 t.valid? #=> false
 t.carrier #=> :unknown
 
 t = TrackingNumber.new("1Z879E930346834440")
+# => #<TrackingNumber::UPS 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.")
+```ruby
+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]
+#=> [#<TrackingNumber::UPS 1Z879E930346834440>, #<TrackingNumber::FedExGround96 9611020987654312345672>]
+```
 
-== ActiveModel validation
+## 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
-
+```ruby
+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
+```ruby
+class Shipment < ActiveRecord::Base
+  validates :tracking, :tracking_number => { :except => 'magic-hand-delivery' }
+end
+```
 
-== Contributing to tracking_number
+## 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
@@ -40,8 +56,7 @@ Sometimes it's helpful to have a "magic" tracking number that isn't valid for an
 * 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
 
 Copyright (c) 2010 Jeff Keen. See LICENSE.txt for
 further details.
-

data/VERSION

@@ -1 +1 @@
-0.10.1
+0.10.2

data/lib/tracking_number.rb

@@ -15,7 +15,7 @@ if defined?(ActiveModel::EachValidator)
 end
 
 module TrackingNumber
-  TYPES = [UPS, FedExExpress, FedExSmartPost, FedExGround, FedExGround18, FedExGround96, USPS91, USPS20, USPS13, DHLExpress, DHLExpressAir, OnTrac]
+  TYPES = [UPS, UPSTest, FedExExpress, FedExSmartPost, FedExGround, FedExGround18, FedExGround96, USPS91, USPS20, USPS13, USPSTest, DHLExpress, DHLExpressAir, OnTrac]
 
   def self.search(body)
     TYPES.collect { |type| type.search(body) }.flatten

data/lib/tracking_number/fedex.rb

@@ -52,8 +52,6 @@ module TrackingNumber
     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])$/

data/lib/tracking_number/ups.rb

@@ -89,4 +89,20 @@ module TrackingNumber
       end
     end
   end
-end
+
+  class UPSTest < UPS
+    # Easypost UPS test numbers as described here:
+    # https://www.easypost.com/docs/api#tracking (scroll down a bit).
+    SEARCH_PATTERN = /^EZ(\d)00000000\1$/
+    VERIFY_PATTERN = SEARCH_PATTERN
+
+    def matches
+      self.tracking_number.scan(VERIFY_PATTERN).flatten
+    end
+
+    def valid_checksum?
+      sequence = tracking_number.scan(/[a-zA-Z0-9]+/).flatten.join
+      return sequence =~ /EZ(\d)00000000\1/
+    end
+  end
+end

data/lib/tracking_number/usps.rb

@@ -148,4 +148,19 @@ module TrackingNumber
       return check == check_digit
     end
   end
+
+  class USPSTest < USPS
+    # USPS Test Number From Easypost. IE: 9499 9071 2345 6123 4567 81
+    SEARCH_PATTERN = /(\b([0-9]\s*){22,22}\b)/
+    VERIFY_PATTERN = SEARCH_PATTERN
+
+    def matches
+      self.tracking_number.scan(VERIFY_PATTERN).flatten
+    end
+
+    def valid_checksum?
+      sequence = tracking_number.scan(/[0-9]+/).flatten.join
+      return sequence == "9499907123456123456781"
+    end
+  end
 end

data/lib/tracking_number/version.rb

@@ -1,3 +1,3 @@
 module TrackingNumber
-  VERSION = "0.10.1"
+  VERSION = "0.10.3"
 end

data/test/ups_tracking_number_test.rb

@@ -16,4 +16,21 @@ class UPSTrackingNumberTest < Minitest::Test
       end
     end
   end
+
+  context "a UPS test tracking number" do
+    ["EZ1000000001", "EZ2000000002", "EZ3000000003", "EZ4000000004", "EZ5000000005", "EZ6000000006", "EZ7000000007"].each do |valid_number|
+      should "return test for #{valid_number}" do
+        should_be_valid_number(valid_number, TrackingNumber::UPSTest, :ups)
+      end
+
+      should "fail on check digit changes on #{valid_number}" do
+        should_fail_on_check_digit_changes(valid_number)
+      end
+    end
+
+    should "not detect an invalid number" do
+      results = TrackingNumber::UPSTest.search("C10999911320230")
+      assert_equal 0, results.size
+    end
+  end
 end

data/test/usps_tracking_number_test.rb

@@ -63,5 +63,11 @@ class USPSTrackingNumberTest < Minitest::Test
         should_fail_on_check_digit_changes(valid_number)
       end
     end
+
+    ["9499907123456123456781", "94999 07123 45612 34567 81"].each do |valid_number|
+      should "return usps with test 22 digit number: #{valid_number}" do
+        should_be_valid_number(valid_number, TrackingNumber::USPSTest, :usps)
+      end
+    end
   end
 end

data/tracking_number.gemspec

@@ -9,12 +9,11 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Keen"]
-  s.date = %q{2011-04-26}
-  s.description = %q{Match tracking numbers to a service, and search blocks of text and pull out valid tracking numbers.}
+  s.date = %q{2017-02-21}
+  s.description = %q{This gem identifies valid tracking numbers and the service they're associated with. It can also tell you a little bit about the package purely from the number—there's quite a bit of info tucked away into those numbers, it turns out.}
   s.email = %q{jeff@keen.me}
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
   ]
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -31,4 +30,3 @@ Gem::Specification.new do |s|
   s.add_development_dependency('activemodel')
   s.add_development_dependency('minitest','~> 5.5')
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tracking_number
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.3
 platform: ruby
 authors:
 - Jeff Keen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-26 00:00:00.000000000 Z
+date: 2017-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,14 +80,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.5'
-description: Match tracking numbers to a service, and search blocks of text and pull
-  out valid tracking numbers.
+description: This gem identifies valid tracking numbers and the service they're associated
+  with. It can also tell you a little bit about the package purely from the number—there's
+  quite a bit of info tucked away into those numbers, it turns out.
 email: jeff@keen.me
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
 files:
 - ".document"
 - ".gitignore"
@@ -95,7 +95,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/tracking_number.rb
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Identifies valid tracking numbers