tracking_number 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7f7fa343ef418dd7cd2ace8046a191aaf354798c49afab48f74dc2d086efcb7
-  data.tar.gz: f39e99015f0ad90fc5bc4e25387ab45f5ecd28a0002a666b60c41e2984855fa8
+  metadata.gz: c982bd19b169cb2d7c3451f310d0408185e3ca3da9056dfd7f08f6d70194d9f1
+  data.tar.gz: ead95abd691ee8572fd295b3e8aed206b44cbb791437c8d40c90702c1e8cd5e7
 SHA512:
-  metadata.gz: 37351ce16a47c35af8f4cd516931251e9c0b8e30ca216857298d09f29988df0944c68081e773c9f0afe806f51fa98169055b924f1dda9d58e633a7abab1d826b
-  data.tar.gz: 9ada728daa08df0c616db4cf053fe812e0afa346ccd17ad8fe592838658c88fd6e82bbd1c9070e1916bdbac931071d371d4da927f3224adbfe14d02b62735b39
+  metadata.gz: '086856f2923929118bd32f6e6ccd9725c0099c9d274273a9ac5ff072fb2f561460cd940d6b95506ca3ea2685b998310cba8534ef3404732353bdb8a2452094e4'
+  data.tar.gz: 2280018d8645ce2181819c7cc35a53e8ea857ef7e785a335ed03c6bac6b813e47f6bcb5ac6831e251e77b7f17ffc5451680fea15d69cbaec84bb753dacef3f1e

data/.travis.yml

@@ -4,9 +4,9 @@ cache: bundler
 rvm:
 - 2.0.0
 - 2.1.10
-- 2.2.7
-- 2.3.4
-- 2.4.1
+- 2.2.9
+- 2.3.6
+- 2.4.3
 - 2.5.0
 before_install:
 - travis_retry gem update --system

data/README.md

@@ -9,6 +9,10 @@ It detects tracking numbers from UPS, FedEx, DHL, USPS, OnTrac, Amazon Logistics
 
 This gem does not do tracking. That is left up to you.
 
+#### New in 1.0
+
+Starting with the 1.0 release the specifications for detecting tracking numbers have been moved into a separate repository ([tracking_number_data](http://github.com/jkeen/tracking_number_data)) that this gem relies on. I did this so a) we can have a single place to document all tracking number types and it can be more of a crowdsourced effort, and b) so clients can be written in other languages easier.
+
 ## Usage
 
 #### Checking an individual tracking number
@@ -119,9 +123,6 @@ class Shipment < ActiveRecord::Base
 end
 ```
 
-## Where the data comes from
-Starting with the 1.0 release of this gem the data for tracking numbers has been extracted into a separate repository ([tracking_number_data](http://github.com/jkeen/tracking_number_data)) so non-ruby clients can benefit from the detection/documentation that used to be contained deep in the code of this gem. If you want to write a client in some other language, that's the stuff you want.
-
 ## 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

data/lib/tracking_number.rb

@@ -1,10 +1,11 @@
 # Identify if tracking numbers are valid, and which service they belong to
 
 require 'json'
+require 'tracking_number/checksum_validations'
+require 'tracking_number/loader'
 require 'tracking_number/base'
 require 'tracking_number/info'
 require 'tracking_number/unknown'
-require 'checksum_validations'
 require 'active_support/core_ext/string'
 require 'active_support/core_ext/hash'
 
@@ -12,67 +13,7 @@ if defined?(ActiveModel::EachValidator)
   require 'tracking_number/active_model_validator'
 end
 
-def has_test_numbers?(tracking)
-  return tracking[:test_numbers] && tracking[:test_numbers][:valid]
-end
-
-def test_numbers_return_required_groups?(tracking, regex)
-  test_number = tracking[:test_numbers][:valid][0]
-  matches = test_number.match(regex)
-
-  return matches["SerialNumber"]
-end
-
-def read_courier_info(file)
-  return JSON.parse(File.read(file)).deep_symbolize_keys!
-end
-
-def create_class(klass, courier_info, tracking_info)
-  klass = Class.new(TrackingNumber::Base)
-  klass.const_set("COURIER_CODE", courier_info[:courier_code])
-  info = courier_info.dup
-  info.delete(:tracking_numbers)
-  klass.const_set("COURIER_INFO", info)
-
-  pattern = tracking_info[:regex]
-  pattern = tracking_info[:regex].join if tracking_info[:regex].is_a?(Array)
-
-  verify_pattern = "^#{pattern}$"
-  search_pattern = "\\b#{pattern}\\b"
-
-  klass.const_set("SEARCH_PATTERN", Regexp.new(search_pattern))
-  klass.const_set("VERIFY_PATTERN", Regexp.new(verify_pattern))
-
-  klass.const_set("VALIDATION", tracking_info[:validation])
-  klass.const_set("ADDITIONAL", tracking_info[:additional])
-
-  return klass
-end
-
-def register_class(klass, tracking_name)
-  klass_name = tracking_name.gsub(/[^0-9A-Za-z]/, '')
-  return TrackingNumber.const_set(klass_name, klass)
-end
-
-tracking_number_types = []
-
-Dir.glob(File.join(File.dirname(__FILE__), "data/couriers/*.json")).each do |file|
-  courier_info          = read_courier_info(file)
-
-  courier_info[:tracking_numbers].each do |tracking_info|
-    tracking_name = tracking_info[:name]
-    klass         = create_class(klass, courier_info, tracking_info)
-
-    # Do some basic checks on the data file
-    throw 'missing test numbers' unless has_test_numbers?(tracking_info)
-    throw 'missing regex match groups' unless test_numbers_return_required_groups?(tracking_info, Regexp.new(klass::VERIFY_PATTERN))
-
-    const = register_class(klass, tracking_name)
-    tracking_number_types.push(const)
-  end
-end
-
-TrackingNumber.const_set("TYPES", tracking_number_types)
+TrackingNumber::Loader.load_tracking_number_data
 
 module TrackingNumber
   def self.search(body)

data/lib/tracking_number/base.rb

@@ -1,5 +1,3 @@
-require 'checksum_validations'
-
 module TrackingNumber
   class Base
     attr_accessor :tracking_number
@@ -95,7 +93,7 @@ module TrackingNumber
       name            = checksum_info[:name]
       method_name     = "validates_#{name}?"
 
-      ChecksumValidations.send(method_name, serial_number, check_digit, checksum_info)
+      TrackingNumber::ChecksumValidations.send(method_name, serial_number, check_digit, checksum_info)
     end
 
     def to_s
@@ -113,8 +111,7 @@ module TrackingNumber
         :service_description => service_description,
         :destination_zip => destination_zip,
         :shipper_id => shipper_id,
-        :package_type => package_type,
-        :package_description => package_description
+        :package_type => package_type
       })
     end
 
@@ -172,6 +169,21 @@ module TrackingNumber
       match_group("ShipperId")
     end
 
+    def tracking_url
+      url = nil
+      if matching_additional["Courier"]
+        url = matching_additional["Courier"][:tracking_url]
+      else
+        if self.class.const_defined?(:TRACKING_URL)
+          url = self.class.const_get(:TRACKING_URL)
+        end
+      end
+
+      if url
+        url.sub('%s', self.tracking_number)
+      end
+    end
+
     def matching_additional
       additional = self.class.const_get(:ADDITIONAL) || []
 

data/lib/tracking_number/checksum_validations.rb

@@ -0,0 +1,65 @@
+module TrackingNumber
+  module ChecksumValidations
+    class << self
+      def validates_s10?(sequence, check_digit, extras = {})
+        weighting = [8,6,4,2,3,5,9,7]
+
+        total = 0
+        sequence.chars.to_a.zip(weighting).each do |(a,b)|
+          total += a.to_i * b.to_i
+        end
+
+        remainder = total % 11
+        check = case remainder
+        when 1
+          0
+        when 0
+          5
+        else
+          11 - remainder
+        end
+
+        return check.to_i == check_digit.to_i
+      end
+
+      def validates_sum_product_with_weightings_and_modulo?(sequence, check_digit, extras = {})
+        weighting = extras[:weightings] || []
+
+        total = 0
+        sequence.chars.to_a.zip(weighting).each do |(a,b)|
+          total += a.to_i * b
+        end
+        return (total % extras[:modulo1] % extras[:modulo2]) == check_digit.to_i
+      end
+
+      def validates_mod10?(sequence, check_digit, extras = {})
+        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
+
+          if extras[:odds_multiplier] && i.odd?
+            x *= extras[:odds_multiplier].to_i
+          elsif extras[:evens_multiplier] && i.even?
+            x *= extras[:evens_multiplier].to_i
+          end
+
+          total += x
+        end
+
+        check = (total % 10)
+        check = (10 - check) unless (check.zero?)
+
+        return (check.to_i == check_digit.to_i)
+      end
+
+      def validates_mod7?(sequence, check_digit, extras = {})
+        # standard mod 7 check
+        return true if sequence.to_i % 7 == check_digit.to_i
+      end
+    end
+  end
+end

data/lib/tracking_number/info.rb

@@ -11,8 +11,16 @@ module TrackingNumber
       end
     end
 
+    def method_missing(*args)
+      nil
+    end
+
     def to_s
       @default || @name
     end
+
+    def to_json
+
+    end
   end
 end

data/lib/tracking_number/loader.rb

@@ -0,0 +1,73 @@
+
+module TrackingNumber
+  module Loader
+    class << self
+      def load_tracking_number_data
+        tracking_number_types = []
+
+        Dir.glob(File.join(File.dirname(__FILE__), "../data/couriers/*.json")).each do |file|
+          courier_info          = read_courier_info(file)
+
+          courier_info[:tracking_numbers].each do |tracking_info|
+            tracking_name = tracking_info[:name]
+            klass         = create_class(klass, courier_info, tracking_info)
+
+            # Do some basic checks on the data file
+            throw 'missing test numbers' unless has_test_numbers?(tracking_info)
+            throw 'missing regex match groups' unless test_numbers_return_required_groups?(tracking_info, Regexp.new(klass::VERIFY_PATTERN))
+
+            const = register_class(klass, tracking_name)
+            tracking_number_types.push(const)
+          end
+        end
+
+        TrackingNumber.const_set("TYPES", tracking_number_types)
+      end
+
+      private
+
+      def has_test_numbers?(tracking)
+        return tracking[:test_numbers] && tracking[:test_numbers][:valid]
+      end
+
+      def test_numbers_return_required_groups?(tracking, regex)
+        test_number = tracking[:test_numbers][:valid][0]
+        matches = test_number.match(regex)
+
+        return matches["SerialNumber"]
+      end
+
+      def read_courier_info(file)
+        return JSON.parse(File.read(file)).deep_symbolize_keys!
+      end
+
+      def create_class(klass, courier_info, tracking_info)
+        klass = Class.new(TrackingNumber::Base)
+        klass.const_set("COURIER_CODE", courier_info[:courier_code])
+        info = courier_info.dup
+        info.delete(:tracking_numbers)
+        klass.const_set("COURIER_INFO", info)
+
+        pattern = tracking_info[:regex]
+        pattern = tracking_info[:regex].join if tracking_info[:regex].is_a?(Array)
+
+        verify_pattern = "^#{pattern}$"
+        search_pattern = "\\b#{pattern}\\b"
+
+        klass.const_set("SEARCH_PATTERN", Regexp.new(search_pattern))
+        klass.const_set("VERIFY_PATTERN", Regexp.new(verify_pattern))
+
+        klass.const_set("VALIDATION", tracking_info[:validation])
+        klass.const_set("ADDITIONAL", tracking_info[:additional])
+        klass.const_set("TRACKING_URL", tracking_info[:tracking_url])
+
+        return klass
+      end
+
+      def register_class(klass, tracking_name)
+        klass_name = tracking_name.gsub(/[^0-9A-Za-z]/, '')
+        return TrackingNumber.const_set(klass_name, klass)
+      end
+    end
+  end
+end

data/lib/tracking_number/version.rb

@@ -1,3 +1,3 @@
 module TrackingNumber
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/test/tracking_number_meta_test.rb

@@ -21,13 +21,6 @@ class TrackingNumberMetaTest < Minitest::Test
 
       describe "[#{tracking_info[:name]}]" do
         tracking_info[:test_numbers][:valid].each do |valid_number|
-
-          should "validate #{valid_number} with #{klass_name}" do
-            t = klass.new(valid_number)
-            assert_equal courier_code, t.carrier
-            assert t.valid?, "should be valid"
-          end
-
           should "detect #{valid_number} as #{klass_name}" do
             #TODO fix this multiple matching thing
             matches = TrackingNumber.search(valid_number)
@@ -45,47 +38,53 @@ class TrackingNumberMetaTest < Minitest::Test
             should_detect_number_variants(valid_number, "TrackingNumber::#{klass_name}".constantize)
           end
 
-          should "return correct courier code on #{valid_number} when calling #courier_code" do
-            t = klass.new(valid_number)
-            assert_equal courier_info[:courier_code].to_sym, t.courier_code
-            assert_equal courier_info[:courier_code].to_sym, t.courier_code
-          end
+          context "number test" do
+            tracking_number = klass.new(valid_number)
 
-          should "return correct courier name on #{valid_number} when calling #courier_name" do
-            t = klass.new(valid_number)
+            should "validate #{valid_number} with #{klass_name}" do
+              assert_equal courier_code, tracking_number.carrier
+              assert tracking_number.valid?, "should be valid"
+            end
 
-            if (t.matching_additional["Courier"])
-              assert_equal t.matching_additional["Courier"][:courier], t.courier_name
-            else
-              assert_equal courier_name, t.courier_name
+            should "return correct courier code on #{valid_number} when calling #courier_code" do
+              tracking_number = klass.new(valid_number)
+              assert_equal courier_info[:courier_code].to_sym, tracking_number.courier_code
+              assert_equal courier_info[:courier_code].to_sym,tracking_number.courier_code
             end
-          end
 
-          should "not throw an error when calling #service_type on #{valid_number}" do
-            t = klass.new(valid_number)
-            service_type = t.service_type
-            assert service_type.is_a?(String) || service_type.nil?
-          end
+            should "return correct courier name on #{valid_number} when calling #courier_name" do
+              if (tracking_number.matching_additional["Courier"])
+                assert_equal tracking_number.matching_additional["Courier"][:courier], tracking_number.courier_name
+              else
+                assert_equal courier_name, tracking_number.courier_name
+              end
+            end
 
-          should "not throw an error when calling #destination on #{valid_number}" do
-            t = klass.new(valid_number)
-            assert t.destination_zip.is_a?(String) || t.destination_zip.nil?
-          end
+            should "not throw an error when calling #service_type on #{valid_number}" do
+              service_type = tracking_number.service_type
+              assert service_type.is_a?(String) || service_type.nil?
+            end
 
-          should "not throw an error when calling #shipper on #{valid_number}" do
-            t = klass.new(valid_number)
-            assert t.shipper_id.is_a?(String) || t.shipper_id.nil?
-          end
+            should "not throw an error when calling #destination on #{valid_number}" do
+              assert tracking_number.destination_zip.is_a?(String) || tracking_number.destination_zip.nil?
+            end
 
-          should "not throw an error when calling #package_type on #{valid_number}" do
-            t = klass.new(valid_number)
-            assert t.package_type.is_a?(String) || t.package_type.nil?
-          end
+            should "not throw an error when calling #shipper on #{valid_number}" do
+              t = klass.new(valid_number)
+              assert tracking_number.shipper_id.is_a?(String) || tracking_number.shipper_id.nil?
+            end
+
+            should "not throw an error when calling #package_type on #{valid_number}" do
+              t = klass.new(valid_number)
+              assert tracking_number.package_type.is_a?(String) || tracking_number.package_type.nil?
+            end
+
+            should "not throw an error when calling #decode on #{valid_number}" do
+              t = klass.new(valid_number)
+              decode = tracking_number.decode
+              assert decode.is_a?(Hash)
+            end
 
-          should "not throw an error when calling #decode on #{valid_number}" do
-            t = klass.new(valid_number)
-            decode = t.decode
-            assert decode.is_a?(Hash)
           end
         end
 

data/test/tracking_number_test.rb

@@ -64,6 +64,11 @@ class TrackingNumberTest < Minitest::Test
     should "report correct no package info" do
       assert_nil tracking_number.package_type
     end
+
+    should "have valid tracking url" do
+      assert tracking_number.tracking_url, "Tracking url should not be blank"
+      assert tracking_number.tracking_url.include?(tracking_number.tracking_number), "Should include tracking number in the url"
+    end
   end
 
   context "tracking number additional data for s10" do
@@ -112,6 +117,11 @@ class TrackingNumberTest < Minitest::Test
     should "report correct no package info" do
       assert_nil tracking_number.package_type
     end
+
+    should "have valid tracking url" do
+      assert tracking_number.tracking_url, "Tracking url should not be blank"
+      assert tracking_number.tracking_url.include?(tracking_number.tracking_number), "Should include tracking number in the url"
+    end
   end
 
   context "tracking number additional data for USPS 34v2" do
@@ -136,5 +146,10 @@ class TrackingNumberTest < Minitest::Test
     should "report correct no package info" do
       assert_nil tracking_number.package_type
     end
+
+    should "have valid tracking url" do
+      assert tracking_number.tracking_url, "Tracking url should not be blank"
+      assert tracking_number.tracking_url.include?(tracking_number.tracking_number), "Should include tracking number in the url"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tracking_number
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Jeff Keen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -139,7 +139,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/checksum_validations.rb
 - lib/data/couriers/amazon.json
 - lib/data/couriers/dhl.json
 - lib/data/couriers/fedex.json
@@ -150,7 +149,9 @@ files:
 - lib/tracking_number.rb
 - lib/tracking_number/active_model_validator.rb
 - lib/tracking_number/base.rb
+- lib/tracking_number/checksum_validations.rb
 - lib/tracking_number/info.rb
+- lib/tracking_number/loader.rb
 - lib/tracking_number/unknown.rb
 - lib/tracking_number/version.rb
 - test/active_model_validator_test.rb
@@ -182,4 +183,8 @@ rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Identifies valid tracking numbers
-test_files: []
+test_files:
+- test/active_model_validator_test.rb
+- test/test_helper.rb
+- test/tracking_number_meta_test.rb
+- test/tracking_number_test.rb

data/lib/checksum_validations.rb

@@ -1,63 +0,0 @@
-module ChecksumValidations
-  class << self
-    def validates_s10?(sequence, check_digit, extras = {})
-      weighting = [8,6,4,2,3,5,9,7]
-
-      total = 0
-      sequence.chars.to_a.zip(weighting).each do |(a,b)|
-        total += a.to_i * b.to_i
-      end
-
-      remainder = total % 11
-      check = case remainder
-      when 1
-        0
-      when 0
-        5
-      else
-        11 - remainder
-      end
-
-      return check.to_i == check_digit.to_i
-    end
-
-    def validates_sum_product_with_weightings_and_modulo?(sequence, check_digit, extras = {})
-      weighting = extras[:weightings] || []
-
-      total = 0
-      sequence.chars.to_a.zip(weighting).each do |(a,b)|
-        total += a.to_i * b
-      end
-      return (total % extras[:modulo1] % extras[:modulo2]) == check_digit.to_i
-    end
-
-    def validates_mod10?(sequence, check_digit, extras = {})
-      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
-
-        if extras[:odds_multiplier] && i.odd?
-          x *= extras[:odds_multiplier].to_i
-        elsif extras[:evens_multiplier] && i.even?
-          x *= extras[:evens_multiplier].to_i
-        end
-
-        total += x
-      end
-
-      check = (total % 10)
-      check = (10 - check) unless (check.zero?)
-
-      return (check.to_i == check_digit.to_i)
-    end
-
-    def validates_mod7?(sequence, check_digit, extras = {})
-      # standard mod 7 check
-      return true if sequence.to_i % 7 == check_digit.to_i
-    end
-  end
-end