tracking_number 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f1c67af2720cc0d2ba41487f936900218b41a6ad950aa13df012c83254c4e79
-  data.tar.gz: e62646e4968999d1683cc8a24962d58ad0506debd1a1e3f1c66c0c4239ea2ec8
+  metadata.gz: 632e88e03ffd1404e26689c874e6093d8b978ceb7326d0e9c13879ffcf5c4a27
+  data.tar.gz: eb6acde6415fb26c3e303ba155714b8f033a14108b4b39a123f841b38d0310ba
 SHA512:
-  metadata.gz: 4679026723c90a20749b0088fcfb7fce805eceac56076f5d2620fad31cc3e48a0dae6f5d445784b0ad8351d46af534ae70ea8eb6ef8ef49e5f0ed34e29f1d130
-  data.tar.gz: 8c49fcffcacf2be4a081229a2df411157614b3367611220cae997c9f4010b35c493623d4440bfc52d6ce608fe1e055cd014f1b2093f90e0cc099e984c70d045f
+  metadata.gz: 5816c80bcd06b12d4918ca9b8b017035eb9f8caa2fb79c47a457e92863636d2263aa2f09abe757fe5219d149eb940a67556f4efcfa43501cdbb47ef304ee743a
+  data.tar.gz: 416f4a346ad8449e39d0bb570fbbd9ea157c19062f32d7ffc4cc8f2514a5e75b04ee8fa4715ac6a1fc2667de4f8264f8763b43a249a88357a2c50b1eb99c6333

data/.github/workflows/release.yml

@@ -7,13 +7,22 @@ on:
 jobs:
   release:
     name: Release
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
-          fetch-depth: 0
+          submodules: true
           persist-credentials: false
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build
+        run: |
+          gem install bundler
+          git submodule update --init --recursive
+          bundle install --jobs 4 --retry 3
       - name: Setup Node.js
         uses: actions/setup-node@v2
         with:

data/.github/workflows/ruby.yml

@@ -6,10 +6,12 @@ jobs:
       fail-fast: false
       matrix:
         os: [ ubuntu-latest ]
-        ruby: [ '2.5', '2.6', '2.7', '3.0', '3.1' ]
+        ruby: [ '2.6', '2.7', '3.0', '3.1' ]
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3
+      with:
+        submodules: true
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -17,7 +19,7 @@ jobs:
     - name: Build and test with Rake
       run: |
         gem install bundler
-        git submodule update --init
+        git submodule update --init --recursive
         bundle install --jobs 4 --retry 3
         bundle exec rake
   publish:

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 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)
+
+
+### Bug Fixes
+
+* modify release process to include submodules, the lack of which caused the 1.3.2 gem release to not work at all ([578af83](https://github.com/jkeen/tracking_number/commit/578af83d1b9da51c6edb8400d3aba8b195b66629))
+
 ## [1.3.2](https://github.com/jkeen/tracking_number/compare/v1.3.1...v1.3.2) (2022-12-23)
 
 # Changelog

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

@@ -0,0 +1,45 @@
+{
+  "name": "Amazon",
+  "courier_code": "amazon",
+  "tracking_numbers": [
+    {
+      "name": "Amazon Logistics",
+      "id": "amazon_logistics",
+      "regex": [
+        "\\s*T\\s*B\\s*A\\s*(?<SerialNumber>([0-9]\\s*){12,12})\\s*"
+      ],
+      "validation": {},
+      "test_numbers": {
+        "valid": [
+          "TBA000000000000",
+          "TBA010000000000",
+          "TBA 000000000000",
+          "TBA502887274000"
+        ],
+        "invalid": [
+          "TBA50288727400A",
+          "000000000000000",
+          "000000000000",
+          "TBB000000000000"
+        ]
+      }
+    },
+    {
+      "name": "Amazon International",
+      "id": "amazon_international",
+      "regex": [
+        "\\s*[AFC]\\s*(?<SerialNumber>([0-9]\\s*){10,10})\\s*"
+      ],
+      "validation": {},
+      "test_numbers": {
+        "valid": [
+          "C1004444443",
+          "C1004444444"
+        ],
+        "invalid": [
+          "D1234567890"
+        ]
+      }
+    }
+  ]
+}

data/lib/data/couriers/canadapost.json

@@ -0,0 +1,31 @@
+{
+  "name": "Canada Post",
+  "courier_code": "canada_post",
+  "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": {
+          "name": "mod10",
+          "evens_multiplier": 3,
+          "odds_multiplier": 1
+        }
+      },
+      "tracking_url": "https://www.canadapost-postescanada.ca/track-reperage/en#/search?searchFor=%s",
+      "test_numbers": {
+        "valid": [
+          "0073938000549297",
+          "7035114477138472",
+          "4002847016405018"
+        ],
+        "invalid": [
+          "0073938000549292",
+          "7035114477138471",
+          "5002847016405018"
+        ]
+      }
+    }
+  ]
+}

data/lib/data/couriers/dhl.json

@@ -0,0 +1,51 @@
+{
+  "name": "DHL",
+  "courier_code": "dhl",
+  "tracking_numbers": [
+    {
+      "name": "DHL Express",
+      "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"
+        }
+      },
+      "tracking_url": "http://www.dhl.com/en/express/tracking.html?brand=DHL&AWB=%s",
+      "test_numbers": {
+        "valid": [
+          "JVGL0999999990",
+          "3318810025",
+          "73891051146",
+          "8487135506",
+          "3318810036",
+          "3318810014"
+        ],
+        "invalid": [
+          "3318810010",
+          "3318810034",
+          "JVGL3099999999",
+          "3318810011"
+        ]
+      }
+    },
+    {
+      "name": "DHL E-Commerce",
+      "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": [
+          "GS295117494011169041",
+          "GR295117494011169045"
+        ]
+      }
+    }
+  ]
+}