tracking_number 1.3.5 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d8a86aeaa8c06073cb379d6c64b1637b8246c8cd54f821696c20c39348061b2
-  data.tar.gz: 8e561f7d1ea8c26d0003297ea4ce5cf9835b805bb6278714c10f81a164375f38
+  metadata.gz: 632e88e03ffd1404e26689c874e6093d8b978ceb7326d0e9c13879ffcf5c4a27
+  data.tar.gz: eb6acde6415fb26c3e303ba155714b8f033a14108b4b39a123f841b38d0310ba
 SHA512:
-  metadata.gz: 5920313b3ea08d709c564a3ca5b03e9ee34e0fe213e83fbdee53680504a24f02dac5fa9e774f864d77259e960100177abf9430b5e717991ec589d881f9f9d246
-  data.tar.gz: df3aab7b35d0cbfaa9b012439de32f0e38dac1217d65c14939dccbc8792ccb918059f58eafcb2f37d52de9f0b911ccaac8bfd16dceb9f0b94923fa0de8a94695
+  metadata.gz: 5816c80bcd06b12d4918ca9b8b017035eb9f8caa2fb79c47a457e92863636d2263aa2f09abe757fe5219d149eb940a67556f4efcfa43501cdbb47ef304ee743a
+  data.tar.gz: 416f4a346ad8449e39d0bb570fbbd9ea157c19062f32d7ffc4cc8f2514a5e75b04ee8fa4715ac6a1fc2667de4f8264f8763b43a249a88357a2c50b1eb99c6333

data/.github/workflows/release.yml

@@ -7,7 +7,7 @@ on:
 jobs:
   release:
     name: Release
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v3

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 tracking_number changelog
 
+# [1.4.0](https://github.com/jkeen/tracking_number/compare/v1.3.5...v1.4.0) (2023-05-15)
+
+
+### Features
+
+* add partnership support with tracking_number_data 1.5 ([75fe530](https://github.com/jkeen/tracking_number/commit/75fe5304e933679aff89a91a93d2b7cf58c1fe5c))
+* update to tracking number data 1.5 ([237ad3c](https://github.com/jkeen/tracking_number/commit/237ad3c82230d39b415df56eb8c8c9eeb22ba15c))
+
 ## [1.3.5](https://github.com/jkeen/tracking_number/compare/v1.3.4...v1.3.5) (2023-01-09)
 
 

data/README.md

@@ -92,6 +92,28 @@ t = TrackingNumber.new("012345000000002")
 t.package_type #=> "case/carton"
 ```
 
+#### Tracking URL
+Get the tracking url from the shipper
+```ruby
+t = TrackingNumber.new("1Z6072AF0320751583")
+t.tracking_url #=> ""https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z6072AF0320751583"
+```
+
+#### All the info we have
+Get a object of all the info we have on the thing
+```ruby
+t = TrackingNumber.new("1Z6072AF0320751583")
+t.info #=>  @courier=#<TrackingNumber::Info:0x000000010a45fed8 @code=:ups, @name="UPS">,
+       #    @decode={:serial_number=>"6072AF032075158", :shipper_id=>"6072AF", :service_type=>"03", :package_id=>"2075158", :check_digit=>"3"},
+       #    @destination_zip=nil,
+       #    @package_type=nil,
+       #    @partners=nil,
+       #    @service_description=nil,
+       #    @service_type="UPS United States Ground",
+       #    @shipper_id="6072AF",
+       #    @tracking_url="https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z6072AF0320751583">
+```
+
 #### Decoding
 Most tracking numbers have a format where each part of the number has meaning. `decode` splits up the number into its known named parts.
 ```ruby
@@ -107,6 +129,32 @@ Most tracking numbers have a format where each part of the number has meaning. `
   # }   
 ```
 
+#### Multiple shippers / Partnerships
+Some tracking numbers match multiple carriers, because they belong to multiple carriers. Some shipments like Fedex Smartpost contract the "last mile" out to USPS. 
+
+```ruby
+  # Search defaults to only showing numbers that fulfill the carrier side of the relationship 
+  # (if a partnership exists at all), as this is the end a consumer would most likely be interested in.
+
+  results = TrackingNumber.search('420112139261290983497923666238') 
+  => [#<TrackingNumber::USPS91:0x26ac0 420112139261290983497923666238>]
+
+  all_results = TrackingNumber.search('420112139261290983497923666238', match: :all) 
+  => [#<TrackingNumber::FedExSmartPost:0x30624 420112139261290983497923666238>, #<TrackingNumber::USPS91:0x26ac0 420112139261290983497923666238>]
+
+  tn = results.first
+  tn.shipper? #=> false
+  tn.carrier? #=> true
+  tn.partnership? #=> true
+  tn.partners
+  #=> <struct TrackingNumber::Base::PartnerStruct
+  #       shipper=#<TrackingNumber::FedExSmartPost:0x30624 420112139261290983497923666238>,
+  #       carrier=#<TrackingNumber::USPS91:0x2f1fc 420112139261290983497923666238>>
+
+  tn.partners.shipper #=> #<TrackingNumber::FedExSmartPost:0x30624 420112139261290983497923666238>
+  tn.partners.carrier == tn #=> true
+```
+
 ## ActiveModel validation
 
 For Rails 3 (or any ActiveModel client), validate your fields as a tracking number:

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tracking_number'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/lib/data/couriers/amazon.json

@@ -4,6 +4,7 @@
   "tracking_numbers": [
     {
       "name": "Amazon Logistics",
+      "id": "amazon_logistics",
       "regex": [
         "\\s*T\\s*B\\s*A\\s*(?<SerialNumber>([0-9]\\s*){12,12})\\s*"
       ],
@@ -12,7 +13,7 @@
         "valid": [
           "TBA000000000000",
           "TBA010000000000",
-          " T B A 0 0 0 0 0 0 0 0 0 0 0 0 ",
+          "TBA 000000000000",
           "TBA502887274000"
         ],
         "invalid": [
@@ -25,6 +26,7 @@
     },
     {
       "name": "Amazon International",
+      "id": "amazon_international",
       "regex": [
         "\\s*[AFC]\\s*(?<SerialNumber>([0-9]\\s*){10,10})\\s*"
       ],

data/lib/data/couriers/canadapost.json

@@ -4,6 +4,7 @@
   "tracking_numbers": [
     {
       "name": "Canada Post (16)",
+      "id": "canada_post",
       "regex": "\\s*(?<SerialNumber>(?<OriginId>([0-9]\\s*){7})([0-9]\\s*){8})(?<CheckDigit>[0-9]\\s*)",
       "validation": {
         "checksum": {

data/lib/data/couriers/dhl.json

@@ -4,7 +4,8 @@
   "tracking_numbers": [
     {
       "name": "DHL Express",
-      "regex": "\\s*(?<SerialNumber>([0-9]\\s*){9})(?<CheckDigit>([0-9]\\s*))",
+      "id": "dhl_express",
+      "regex": "\\s*(?<SerialNumber>(J[A-Z][A-Z][A-Z])?([0-9])?([0-9]\\s*){9})(?<CheckDigit>([0-9]\\s*))",
       "validation": {
         "checksum": {
           "name": "mod7"
@@ -13,47 +14,31 @@
       "tracking_url": "http://www.dhl.com/en/express/tracking.html?brand=DHL&AWB=%s",
       "test_numbers": {
         "valid": [
+          "JVGL0999999990",
           "3318810025",
+          "73891051146",
           "8487135506",
           "3318810036",
-          " 3 3 1 8 8 1 0 0 3 6 ",
           "3318810014"
         ],
         "invalid": [
           "3318810010",
           "3318810034",
+          "JVGL3099999999",
           "3318810011"
         ]
       }
     },
-    {
-      "name": "DHL Express Air",
-      "regex": "\\s*(?<SerialNumber>([0-9]\\s*){10})(?<CheckDigit>[0-9]\\s*)",
-      "validation": {
-        "checksum": {
-          "name": "mod7"
-        }
-      },
-      "tracking_url": "http://www.dhl.com/en/express/tracking.html?brand=DHL&AWB=%s",
-      "test_numbers": {
-        "valid": [
-          "73891051146",
-          " 7 3 8 9 1 0 5 1 1 4 6 "
-        ],
-        "invalid": [
-          "73891051149",
-          "73891051147"
-        ]
-      }
-    },
     {
       "name": "DHL E-Commerce",
-      "regex": "\\s*((G\\s*M\\s*)|(L\\s*X\\s*)|(R\\s*X\\s*)|(U\\s*V\\s*)|(C\\s*N\\s*)|(S\\s*G\\s*)|(T\\s*H\\s*)|(I\\s*N\\s*)|(H\\s*K\\s*)|(M\\s*Y\\s*))\\s*(?<SerialNumber>([0-9]\\s*){10,39})",
+      "id": "dhl_ecommerce",
+      "regex": "\\s*((GM)|(LX)|(RX)|(UV)|(CN)|(SG)|(TH)|(IN)|(HK)|(MY))\\s*(?<SerialNumber>([0-9]\\s*){10,39})",
       "validation": {},
       "tracking_url": "http://www.dhl.com/en/express/tracking.html?brand=DHL&AWB=%s",
       "test_numbers": {
         "valid": [
           "GM2951173225174494",
+          "GM 2 9 5 117 32 25 1 7 44 9 4",
           "GM295117494011169042"
         ],
         "invalid": [

data/lib/data/couriers/dpd.json

@@ -4,6 +4,7 @@
   "tracking_numbers": [
     {
       "name": "DPD (28)",
+      "id": "dpd",
       "regex": [
         "\\s*",
         "(?<SerialNumber>",
@@ -313,6 +314,7 @@
     },
     {
       "name": "DPD (14)",
+      "id": "dpd_14",
       "regex": [
         "\\s*(?<SerialNumber>",
           "([0-9]\\s*){14}",

data/lib/data/couriers/fedex.json

@@ -4,6 +4,7 @@
   "tracking_numbers": [
     {
       "name": "FedEx Express (12)",
+      "id": "fedex_12",
       "regex": "\\s*(?<SerialNumber>([0-9]\\s*){11})(?<CheckDigit>[0-9]\\s*)",
       "validation": {
         "checksum": {
@@ -42,6 +43,7 @@
     },
     {
       "name": "FedEx Express (34)",
+      "id": "fedex_34",
       "regex": [
         "\\s*1\\s*0\\s*[0-9]\\s*[0-9]\\s*[0-9]\\s*",
         "([0-9]\\s*){10}",
@@ -88,19 +90,38 @@
     },
     {
       "name": "FedEx SmartPost",
-      "description": "IMpb CO3 standard",
+      "id": "fedex_smartpost",
+      "description": "Shipped by FedEx, Delivered by USPS",
       "regex": [
         "\\s*(?:",
         "(?:(?<RoutingApplicationId>4\\s*2\\s*0\\s*)(?<DestinationZip>([0-9]\\s*){5}))?",
         "(?<ApplicationIdentifier>9\\s*2\\s*)",
         ")?",
         "(?<SerialNumber>",
-        "(?<ServiceType>([0-9]\\s*){3})",
-        "(?<ShipperId>([0-9]\\s*){9})",
-        "(?<PackageId>([0-9]\\s*){7})",
+        "(?<SCNC>([0-9]\\s*){2})",
+        "(?<ServiceType>([0-9]\\s*){2})",
+        "(?<ShipperId>([0-9]\\s*){8})",
+        "(?<PackageId>([0-9]\\s*){11}|([0-9]\\s*){7})",
         ")",
         "(?<CheckDigit>([0-9]\\s*))"
       ],
+      "additional": [
+        {
+          "name": "Service Type",
+          "regex_group_name": "ServiceType",
+          "lookup": [
+            {
+              "matches_regex": ".",
+              "name": "Delivered by USPS"
+            }
+          ]
+        }
+      ],
+      "partners": [{
+        "partner_id": "usps_91",
+        "partner_type": "carrier",
+        "description": "FedEx SmartPost is a shipping service that utilizes FedEx for the initial transport and the United States Postal Service for final delivery."
+      }],
       "validation": {
         "checksum": {
           "name": "mod10",
@@ -118,7 +139,6 @@
       "test_numbers": {
         "valid": [
           "61299998820821171811",
-          " 6 1 2 9 9 9 9 8 8 2 0 8 2 1 1 7 1 8 1 1 ",
           "9261292700768711948021",
           "420 11213 92 6129098349792366623 8",
           "92 6129098349792366623 8",
@@ -134,6 +154,7 @@
     },
     {
       "name": "FedEx Ground",
+      "id": "fedex_ground",
       "regex": "\\s*(?<SerialNumber>([0-9]\\s*){14})(?<CheckDigit>([0-9]\\s*))",
       "validation": {
         "checksum": {
@@ -157,6 +178,7 @@
     },
     {
       "name": "FedEx Ground (SSCC-18)",
+      "id": "fedex_ground_sscc_18",
       "regex": "\\s*(?<ShippingContainerType>([0-9]\\s*){2})(?<SerialNumber>([0-9]\\s*){15})(?<CheckDigit>[0-9]\\s*)",
       "tracking_url": "https://www.fedex.com/apps/fedextrack/?tracknumbers=%s",
       "validation": {
@@ -202,6 +224,7 @@
     },
     {
       "name": "FedEx Ground 96 (22)",
+      "id": "fedex_ground_96",
       "regex": [
         "\\s*(?<ApplicationIdentifier>9\\s*6\\s*)",
         "(?<SCNC>([0-9]\\s*){2})",
@@ -229,6 +252,7 @@
     },
     {
       "name": "FedEx Ground GSN",
+      "id": "fedex_ground_gsn",
       "regex": [
         "\\s*(?<ApplicationIdentifier>9\\s*6\\s*)",
         "(?<SCNC>([0-9]\\s*){2})",

data/lib/data/couriers/landmark.json

@@ -4,6 +4,7 @@
   "tracking_numbers": [
     {
       "name": "Landmark Global LTN",
+      "id": "landmark_global",
       "regex": [
         "\\s*L\\s*T\\s*N\\s*(?<SerialNumber>([0-9]\\s*){8})\\s*N\\s*1"
       ],

data/lib/data/couriers/lasership.json

@@ -4,6 +4,7 @@
   "tracking_numbers": [
     {
       "name": "LaserShip LX",
+      "id": "lasership_lx",
       "regex": [
         "\\s*L\\s*[AIEHNX]\\s*[1-3]\\s*(?<SerialNumber>([0-9]\\s*){7,7})\\s*"
       ],
@@ -42,6 +43,7 @@
     },
     {
       "name": "LaserShip 1LS7 (15)",
+      "id": "lasership_1ls7",
       "regex": [
         "\\s*1\\s*L\\s*S\\s*7\\s*[12]\\s*([0-9]\\s*){4,4}",
         "(?<SerialNumber>([0-9]\\s*){6,6})\\s*"

data/lib/data/couriers/ontrac.json

@@ -4,6 +4,7 @@
   "tracking_numbers": [
     {
       "name": "OnTrac",
+      "id": "ontrac_c",
       "regex": "\\s*C\\s*(?<SerialNumber>([0-9]\\s*){13})(?<CheckDigit>[0-9]\\s*)",
       "validation": {
         "checksum": {
@@ -22,7 +23,7 @@
       "test_numbers": {
         "valid": [
           "C11031500001879",
-          " C 1 1 0 3 1 5 0 0 0 0 1 8 7 9 ",
+          "C 110 31 500 00187 9",
           "C10999911320231",
           "C11121552953069",
           "C11121553156000",
@@ -36,6 +37,7 @@
     },
     {
       "name": "OnTrac D",
+      "id": "ontrac_d",
       "regex": "\\s*D\\s*(?<SerialNumber>([0-9]\\s*){13})(?<CheckDigit>[0-9]\\s*)",
       "validation": {
         "checksum": {
@@ -55,6 +57,7 @@
         "valid": [
           "D10011354453707",
           "D10011345983010",
+          "D 100 113 459 830 10",
           "D10011342332145"
         ],
         "invalid": [

data/lib/data/couriers/s10.json

@@ -3,6 +3,7 @@
   "courier_code": "s10",
   "tracking_numbers": [
     {
+      "id": "s10",
       "name": "S10",
       "validation": {
         "checksum": {
@@ -21,8 +22,7 @@
           "RB123456785GB",
           "RB123456785US",
           "RB123456785CV",
-          "RB123456785CF",
-          " R B 1 2 3 4 5 6 7 8 5 C F "
+          "RB123456785CF"
         ],
         "invalid": [
           "RB123456786US",

data/lib/data/couriers/ups.json

@@ -4,6 +4,7 @@
   "tracking_numbers": [
     {
       "name": "UPS",
+      "id": "ups",
       "regex": [
         "\\s*1\\s*Z\\s*(?<SerialNumber>",
         "(?<ShipperId>(?:[A-Z0-9]\\s*){6,6})",
@@ -138,7 +139,7 @@
     {
       "name": "UPS Waybill",
       "regex": [
-        "\\s*(?<ServiceType>([A-Z]\\s*){1})",
+        "\\s*(?<ServiceType>([AHJKTV]\\s*){1})",
         "(?<SerialNumber>(?:[0-9]\\s*){9})",
         "(?<CheckDigit>[0-9]\\s*){1}"
       ],
@@ -173,6 +174,7 @@
       "test_numbers": {
         "valid": [
           "K1506235620",
+          "K 150 623 562 0",
           "K2479825491",
           "J4603636537",
           "V0490119172",

data/lib/data/couriers/usps.json

@@ -5,6 +5,7 @@
     {
       "tracking_url": "https://tools.usps.com/go/TrackConfirmAction?tLabels=%s",
       "name": "USPS 20",
+      "id": "usps_20",
       "description": "20 digit USPS numbers",
       "regex": [
         "\\s*(?<SerialNumber>",
@@ -58,6 +59,7 @@
     },
     {
       "name": "USPS 34v2",
+      "id": "usps_32V2",
       "description": "variation on 34 digit USPS IMpd numbers",
       "regex": [
         "\\s*(?<RoutingApplicationId>4\\s*2\\s*0\\s*)(?<DestinationZip>([0-9]\\s*){5})",
@@ -90,6 +92,7 @@
     },
     {
       "name": "USPS 91",
+      "id": "usps_91",
       "description": "USPS now calls this the IMpd barcode format",
       "regex": [
         "\\s*(?:(?<RoutingApplicationId>4\\s*2\\s*0\\s*)(?<DestinationZip>([0-9]\\s*){5}))?",
@@ -115,6 +118,23 @@
           }
         }
       },
+      "partners": [{
+        "description": "FedEx SmartPost uses USPS for last mile delivery, but not all USPS91 numbers are SmartPosts",
+        "partner_type": "shipper",
+        "partner_id": "fedex_smartpost",
+        "validation": {
+          "matches_all": [
+            {
+              "regex_group_name": "ServiceType",
+              "matches": "29"
+            },
+            {
+              "matches": "61",
+              "regex_group_name": "SCNC"
+            }
+          ]
+        }
+      }],
       "tracking_url": "https://tools.usps.com/go/TrackConfirmAction?tLabels=%s",
       "test_numbers": {
         "valid": [
@@ -125,7 +145,6 @@
           "92748931507708513018050063",
           "9400 1112 0108 0805 4830 16",
           "9361 2898 7870 0317 6337 95",
-          " 9 3 6 1   2 8 9 8   7 8 7 0   0 3 1 7   6 3 3 7   9 5 ",
           "9405803699300124287899"
         ],
         "invalid": [
@@ -134,7 +153,23 @@
           "420000000000000000000000000000",
           "420000009200000000000000000000"
         ]
-      }
+      },
+      "additional": [
+        {
+          "name": "Service Type",
+          "regex_group_name": "ServiceType",
+          "lookup": [
+            {
+              "matches": "11",
+              "name": "First Class (R)"
+            },
+            {
+              "matches": "29",
+              "name": "Fedex Smart Post"
+            }
+          ]
+        }
+      ]
     }
   ]
 }

data/lib/tracking_number/base.rb

@@ -1,15 +1,16 @@
 module TrackingNumber
   class Base
-    attr_accessor :tracking_number
-    attr_accessor :original_number
+    attr_accessor :tracking_number, :original_number, :partner, :partner_data
+
+    PartnerStruct = Struct.new(:shipper, :carrier)
 
     def initialize(tracking_number)
       @original_number = tracking_number
-      @tracking_number = tracking_number.strip.gsub(" ", "").upcase
+      @tracking_number = tracking_number.strip.gsub(' ', '').upcase
     end
 
     def self.search(body)
-      valids = self.scan(body).uniq.collect { |possible| new(possible) }.select { |t| t.valid? }
+      valids = scan(body).uniq.collect { |possible| new(possible) }.select { |t| t.valid? }
 
       uniques = {}
       valids.each do |t|
@@ -23,10 +24,10 @@ module TrackingNumber
       # matches with match groups within the match data
       matches = []
 
-      body.scan(self.const_get(:SEARCH_PATTERN)){
-        #get the match data instead, which is needed with these types of regexes
+      body.scan(const_get(:SEARCH_PATTERN)) do
+        # get the match data instead, which is needed with these types of regexes
         matches << $~
-      }
+      end
 
       if matches
         matches.collect { |m| m[0] }
@@ -36,31 +37,29 @@ module TrackingNumber
     end
 
     def serial_number
-      return match_group("SerialNumber") unless self.class.const_get("VALIDATION")
+      return match_group('SerialNumber') unless self.class.const_get('VALIDATION')
 
       format_info   = self.class.const_get(:VALIDATION)[:serial_number_format]
-      raw_serial    = match_group("SerialNumber")
+      raw_serial    = match_group('SerialNumber')
 
-      if format_info
-        if format_info[:prepend_if] && raw_serial.match(Regexp.new(format_info[:prepend_if][:matches_regex]))
-          return "#{format_info[:prepend_if][:content]}#{raw_serial}"
-        elsif format_info[:prepend_if_missing]
+      if format_info && format_info[:prepend_if] && raw_serial.match(Regexp.new(format_info[:prepend_if][:matches_regex]))
+        return "#{format_info[:prepend_if][:content]}#{raw_serial}"
+      # elsif format_info && format_info[:prepend_if_missing]
 
-        end
       end
 
-      return raw_serial
+      raw_serial
     end
 
     def check_digit
-      match_group("CheckDigit")
+      match_group('CheckDigit')
     end
 
     def decode
       decoded = {}
-      (self.matches.try(:names) || []).each do |name|
+      (matches.try(:names) || []).each do |name|
         sym = name.underscore.to_sym
-        decoded[sym] = self.matches[name]
+        decoded[sym] = matches[name]
       end
 
       decoded
@@ -70,7 +69,8 @@ module TrackingNumber
       return false unless valid_format?
       return false unless valid_checksum?
       return false unless valid_optional_checks?
-      return true
+
+      true
     end
 
     def valid_format?
@@ -78,7 +78,7 @@ module TrackingNumber
     end
 
     def valid_optional_checks?
-      additional_check = self.class.const_get("VALIDATION")[:additional]
+      additional_check = self.class.const_get('VALIDATION')[:additional]
       return true unless additional_check
 
       exist_checks = (additional_check[:exists] ||= [])
@@ -86,8 +86,9 @@ module TrackingNumber
     end
 
     def valid_checksum?
-      return false unless self.valid_format?
-      checksum_info   = self.class.const_get(:VALIDATION)[:checksum]
+      return false unless valid_format?
+
+      checksum_info = self.class.const_get(:VALIDATION)[:checksum]
       return true unless checksum_info
 
       name            = checksum_info[:name]
@@ -97,22 +98,25 @@ module TrackingNumber
     end
 
     def to_s
-      self.tracking_number
+      tracking_number
     end
 
     def inspect
-      "#<%s:%#0x %s>" % [self.class.to_s, self.object_id, tracking_number]
+      format('#<%s:%#0x %s>', self.class.to_s, object_id, tracking_number)
     end
 
     def info
       Info.new({
-        :courier => courier_info,
-        :service_type => service_type,
-        :service_description => service_description,
-        :destination_zip => destination_zip,
-        :shipper_id => shipper_id,
-        :package_type => package_type
-      })
+                 courier: courier_info,
+                 service_type: service_type,
+                 service_description: service_description,
+                 destination_zip: destination_zip,
+                 shipper_id: shipper_id,
+                 package_type: package_type,
+                 tracking_url: tracking_url,
+                 partners: partners,
+                 decode: decode
+               })
     end
 
     def courier_code
@@ -120,68 +124,88 @@ module TrackingNumber
     end
 
     def courier_name
-      if matching_additional["Courier"]
-        matching_additional["Courier"][:courier]
-      else
-        if self.class.constants.include?(:COURIER_INFO)
-          self.class.const_get(:COURIER_INFO)[:name]
-        end
+      if matching_additional['Courier']
+        matching_additional['Courier'][:courier]
+      elsif self.class.constants.include?(:COURIER_INFO)
+        self.class.const_get(:COURIER_INFO)[:name]
       end
     end
 
-    alias_method :carrier, :courier_code #OG tracking_number gem used :carrier.
-    alias_method :carrier_code, :courier_code
-    alias_method :carrier_name, :courier_name
+    alias carrier courier_code # OG tracking_number gem used :carrier.
+    alias carrier_code courier_code
+    alias carrier_name courier_name
 
     def courier_info
-      basics = {:name => courier_name, :code => courier_code}
+      basics = { name: courier_name, code: courier_code }
 
-      if info = matching_additional["Courier"]
-        basics.merge!(:name => info[:courier], :url => info[:courier_url], :country => info[:country])
+      if info = matching_additional['Courier']
+        basics.merge!(name: info[:courier], url: info[:courier_url], country: info[:country])
       end
 
       @courier ||= Info.new(basics)
     end
 
-    def service_type
-      if matching_additional["Service Type"]
-        @service_type ||= Info.new(matching_additional["Service Type"]).name
+    def partnership?
+      partners.present?
+    end
+
+    def shipper?
+      return true unless partnership?
+
+      partners.shipper == self
+    end
+
+    def carrier?
+      return true unless partnership?
+
+      partners.carrier == self
+    end
+
+    def partners
+      return unless self.class.const_defined?(:PARTNERS)
+
+      partner_hash = {}
+
+      return unless (partner_tn = find_matching_partner)
+
+      possible_twin = partner_tn.send(:find_matching_partner)
+      if possible_twin.instance_of?(self.class) && possible_twin.tracking_number == tracking_number
+        partner_hash[partner_data[:partner_type].to_sym] = partner_tn
+        partner_hash[partner_tn.partner_data[:partner_type].to_sym] = self
       end
+
+      PartnerStruct.new(partner_hash[:shipper], partner_hash[:carrier]) if partner_hash.keys.any?
+    end
+
+    def service_type
+      @service_type ||= Info.new(matching_additional['Service Type']).name if matching_additional['Service Type']
     end
 
     def service_description
-      if matching_additional["Service Type"]
-        @service_description ||= Info.new(matching_additional["Service Type"]).description
-      end
+      @service_description ||= Info.new(matching_additional['Service Type']).description if matching_additional['Service Type']
     end
 
     def package_type
-      if matching_additional["Container Type"]
-        @package_type ||= Info.new(matching_additional["Container Type"]).name
-      end
+      @package_type ||= Info.new(matching_additional['Container Type']).name if matching_additional['Container Type']
     end
 
     def destination_zip
-      match_group("DestinationZip")
+      match_group('DestinationZip')
     end
 
     def shipper_id
-      match_group("ShipperId")
+      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
+      if matching_additional['Courier']
+        url = matching_additional['Courier'][:tracking_url]
+      elsif self.class.const_defined?(:TRACKING_URL)
+        url = self.class.const_get(:TRACKING_URL)
       end
 
-      if url
-        url.sub('%s', self.tracking_number)
-      end
+      url.sub('%s', tracking_number) if url
     end
 
     def matching_additional
@@ -189,21 +213,21 @@ module TrackingNumber
 
       relevant_sections = {}
 
-      additional.each do |info|
-        if self.matches && self.matches.length > 0
-          if value = self.matches[info[:regex_group_name]].gsub(/\s/, "")
-            # has matching value
-            matches = info[:lookup].find do |i|
-              if i[:matches]
-                value == i[:matches]
-              elsif i[:matches_regex]
-                value =~ Regexp.new(i[:matches_regex])
-              end
-            end
-
-            relevant_sections[info[:name]] = matches
+      additional.each do |additional_info|
+        next unless matches && matches.length > 0 # skip if no match groups
+        value = matches[additional_info[:regex_group_name]].gsub(/\s/, '') # match is empty
+        next unless value
+
+        matches = additional_info[:lookup].find do |i|
+          if i[:matches]
+            value == i[:matches]
+          elsif i[:matches_regex]
+            value =~ Regexp.new(i[:matches_regex])
           end
         end
+
+        # has matching value
+        relevant_sections[additional_info[:name]] = matches
       end
 
       relevant_sections
@@ -211,21 +235,78 @@ module TrackingNumber
 
     protected
 
-    def matches
-      if self.class.constants.include?(:VERIFY_PATTERN)
-        self.tracking_number.match(self.class.const_get(:VERIFY_PATTERN))
-      else
-        []
+    def match_all(items)
+      items.all? do |i|
+        if i[:matches] && matches[i[:regex_group_name]]
+          matches[i[:regex_group_name]] == i[:matches]
+        elsif i[:matches_regex] && matches[i[:regex_group_name]]
+          matches[i[:regex_group_name]] =~ Regexp.new(i[:matches_regex])
+        else
+          false
+        end
       end
     end
 
+    def match_any(items)
+      items.find do |i|
+        if i[:matches] && matches[i[:regex_group_name]]
+          matches[i[:regex_group_name]] == i[:matches]
+        elsif i[:matches_regex] && matches[i[:regex_group_name]]
+          matches[i[:regex_group_name]] =~ Regexp.new(i[:matches_regex])
+        else
+          false
+        end
+      end
+    end
+
+    def matches
+      @matches ||= if self.class.constants.include?(:VERIFY_PATTERN)
+                     tracking_number.match(self.class.const_get(:VERIFY_PATTERN))
+                   else
+                     []
+                   end
+    end
+
     def match_group(name)
-      begin
-        self.matches[name].gsub(/\s/, '')
-      rescue
-        nil
+      matches[name].gsub(/\s/, '')
+    rescue StandardError
+      nil
+    end
+
+    def find_matching_partner
+      partner_info = self.class.const_get(:PARTNERS) || []
+
+      partner_info.each do |partner_data|
+        klass = find_tracking_class_by_id(partner_data[:partner_id])
+
+        return false unless klass
+
+        tn = klass.new(tracking_number)
+
+        valid = if partner_data.dig(:validation, :matches_all)
+                  tn.valid? && match_all(partner_data.dig(:validation, :matches_all))
+                elsif partner_data.dig(:validation, :matches_any)
+                  tn.valid? && match_any(partner_data.dig(:validation, :matches_any))
+                else
+                  tn.valid?
+                end
+
+        next unless valid
+
+        @partner = tn
+        @partner_data = partner_data
+        break
       end
+
+      return @partner
     end
 
+    def find_tracking_class_by_id(id)
+      return unless id
+
+      TrackingNumber::TYPES.detect do |type|
+        type.const_get('ID') == id
+      end
+    end
   end
 end

data/lib/tracking_number/loader.rb

@@ -1,22 +1,21 @@
-
 module TrackingNumber
   module Loader
     class << self
-      def load_tracking_number_data(couriers_path = File.join(File.dirname(__FILE__), "../data/couriers/"))
+      def load_tracking_number_data(couriers_path = File.join(File.dirname(__FILE__), '../data/couriers/'))
         mapping_data = []
         tracking_number_types = []
         Dir.glob(File.join(couriers_path, '/*.json')).each do |file|
-          courier_info          = read_courier_info(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)
+            klass = create_class(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))
+            throw 'missing regex match groups' unless test_numbers_return_required_groups?(tracking_info,
+                                                                                           Regexp.new(klass::VERIFY_PATTERN))
+            const = register_class(klass, tracking_info[:name])
 
-            const = register_class(klass, tracking_name)
             tracking_number_types.push(const)
             mapping_data << {
               class: const,
@@ -28,33 +27,33 @@ module TrackingNumber
         end
 
         TrackingNumber.const_set('TYPES', tracking_number_types)
-        
-        return mapping_data
+
+        mapping_data
       end
 
       private
 
       def has_test_numbers?(tracking)
-        return tracking[:test_numbers] && tracking[:test_numbers][:valid]
+        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"]
+        matches['SerialNumber']
       end
 
       def read_courier_info(file)
-        return JSON.parse(File.read(file)).deep_symbolize_keys!
+        JSON.parse(File.read(file)).deep_symbolize_keys!
       end
 
-      def create_class(klass, courier_info, tracking_info)
+      def create_class(courier_info, tracking_info)
         klass = Class.new(TrackingNumber::Base)
-        klass.const_set("COURIER_CODE", courier_info[:courier_code])
+        klass.const_set('COURIER_CODE', courier_info[:courier_code])
         info = courier_info.dup
         info.delete(:tracking_numbers)
-        klass.const_set("COURIER_INFO", info)
+        klass.const_set('COURIER_INFO', info)
 
         pattern = tracking_info[:regex]
         pattern = tracking_info[:regex].join if tracking_info[:regex].is_a?(Array)
@@ -62,19 +61,21 @@ module TrackingNumber
         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('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])
+        klass.const_set('VALIDATION', tracking_info[:validation])
+        klass.const_set('ADDITIONAL', tracking_info[:additional])
+        klass.const_set('TRACKING_URL', tracking_info[:tracking_url])
+        klass.const_set('PARTNERS', tracking_info[:partners])
+        klass.const_set('ID', tracking_info[:id])
 
-        return klass
+        klass
       end
 
       def register_class(klass, tracking_name)
         klass_name = tracking_name.gsub(/[^0-9A-Za-z]/, '')
-        return TrackingNumber.const_set(klass_name, klass)
+        TrackingNumber.const_set(klass_name, klass)
       end
     end
   end

data/lib/tracking_number/partnership.rb

@@ -0,0 +1,7 @@
+module TrackingNumber
+  class Partnership
+    def initialize(tracking_numbers)
+      
+    end
+  end
+end

data/lib/tracking_number/version.rb

@@ -1,3 +1,3 @@
 module TrackingNumber
-  VERSION = "1.3.5"
+  VERSION = "1.4.0"
 end

data/lib/tracking_number.rb

@@ -5,6 +5,7 @@ require 'tracking_number/checksum_validations'
 require 'tracking_number/loader'
 require 'tracking_number/base'
 require 'tracking_number/info'
+require 'tracking_number/partnership'
 require 'tracking_number/unknown'
 require 'active_support/core_ext/string'
 require 'active_support/core_ext/hash'
@@ -16,29 +17,51 @@ end
 TrackingNumber::Loader.load_tracking_number_data
 
 module TrackingNumber
-  def self.search(body)
-    TYPES.collect { |type| type.search(body) }.flatten
+  def self.search(body, match: :carrier)
+    matches = TYPES.collect { |type| type.search(body) }.flatten
+
+    # Some tracking numbers (e.g. Fedex Smartpost) are partnerships between two parties, where one party is the shipper (e.g. Fedex)
+    # and the other party is the [last mile] carrier (e.g. USPS). We're probably interested in the last mile aspect of
+    # the partnership, so by default we'll show those
+
+    # Tracking numbers without a partnership are both the shipper and carrier.
+
+    case match
+    when :carrier
+      matches.filter(&:carrier?)
+    when :shipper
+      matches.filter(&:shipper?)
+    when :all
+      matches
+    else
+      matches
+    end
   end
 
-  def self.detect(tracking_number)
+  def self.detect(tracking_number, match: :carrier)
     tn = nil
-    for test_klass in (TYPES+[Unknown])
+    (TYPES + [Unknown]).each do |test_klass|
       tn = test_klass.new(tracking_number)
-      break if tn.valid?
+      if tn.valid? && (!match || match == :all)
+        break
+      elsif tn.valid? && tn.send("#{match}?")
+        break
+      end
     end
-    return tn
+    tn
   end
 
   def self.detect_all(tracking_number)
     matches = []
-    for test_klass in (TYPES+[Unknown])
+    (TYPES + [Unknown]).each do |test_klass|
       tn = test_klass.new(tracking_number)
       matches << tn if tn.valid?
     end
-    return matches
+
+    matches
   end
 
   def self.new(tracking_number)
-    self.detect(tracking_number)
+    detect(tracking_number)
   end
 end

data/test/test_helper.rb

@@ -18,8 +18,6 @@ class Minitest::Test
     possible_numbers = []
     possible_numbers << tracking
     possible_numbers << tracking.to_s.gsub(" ", "")
-    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.flatten.uniq

data/test/tracking_number_meta_test.rb

@@ -23,7 +23,7 @@ class TrackingNumberMetaTest < Minitest::Test
         tracking_info[:test_numbers][:valid].each do |valid_number|
           should "detect #{valid_number} as #{klass_name}" do
             #TODO fix this multiple matching thing
-            matches = TrackingNumber.search(valid_number)
+            matches = TrackingNumber.search(valid_number, match: :all)
             assert matches.collect(&:class).include?(klass)
           end
 

data/test/tracking_number_test.rb

@@ -147,9 +147,77 @@ class TrackingNumberTest < Minitest::Test
       assert_nil tracking_number.package_type
     end
 
+    should "report no partnership" do
+      assert_equal false, tracking_number.partnership?
+    end
+
+    should "report no partners" do
+      assert_equal nil, tracking_number.partners
+    end
+
+    should "report as shipper and carrier" do
+      assert_equal true, tracking_number.shipper?
+      assert_equal true, tracking_number.carrier?
+    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 partnership data for FedExSmartPost/USPS91" do
+    tracking_number = TrackingNumber.new("420 11213 92 6129098349792366623 8")
+
+    should "report correct courier name" do
+      assert_equal "United States Postal Service", tracking_number.courier_name
+    end
+
+    should "report correct courier code" do
+      assert_equal :usps, tracking_number.courier_code
+    end
+
+    should "report correct service type" do
+      assert_equal "Fedex Smart Post", tracking_number.service_type
+    end
+
+    should "report partnership" do
+      assert_equal true, tracking_number.partnership?
+    end
+
+    should "report not shipper side of the partnership" do
+      assert_equal false, tracking_number.shipper?
+    end
+
+    should "report carrier side of the partnership" do
+      assert_equal true, tracking_number.carrier?
+    end
+
+    should "report partner pairing" do
+      assert_equal :fedex, tracking_number.partners.shipper.courier_code
+    end
+  end
+
+  context "searching numbers that have partners" do
+    partnership_number = "420 11213 92 6129098349792366623 8"
+    single_number = "0307 1790 0005 2348 3741"
+  
+    search_string = ["number that matches two services", partnership_number, " number that matches only one: ", single_number, "let's see if that does it"].join(' ')
+
+    should "match only carriers by default" do
+      matches = TrackingNumber.search(search_string)
+      assert_equal 2, matches.size
+      assert_equal [true, true], matches.collect { |t| t.carrier? }
+    end
+
+    should "match all if specified" do
+      matches = TrackingNumber.search(search_string, match: :all)
+      assert_equal 3, matches.size
+    end
+
+    should "match only shippers if specified" do
+      matches = TrackingNumber.search(search_string, match: :shipper)
+      assert_equal 2, matches.size
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tracking_number
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.4.0
 platform: ruby
 authors:
 - Jeff Keen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -140,7 +140,8 @@ description: This gem identifies valid tracking numbers and the service they're
   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: []
+executables:
+- console
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
@@ -157,6 +158,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
 - lib/data/couriers/amazon.json
 - lib/data/couriers/canadapost.json
 - lib/data/couriers/dhl.json
@@ -174,6 +176,7 @@ files:
 - lib/tracking_number/checksum_validations.rb
 - lib/tracking_number/info.rb
 - lib/tracking_number/loader.rb
+- lib/tracking_number/partnership.rb
 - lib/tracking_number/unknown.rb
 - lib/tracking_number/version.rb
 - package.json