Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Added `TrackingNumber::BaseService` for automatic tracking URL genera… (#12127)
Damian Legawiec97749ae315d6
diff --git a/core/app/models/spree/shipment.rb b/core/app/models/spree/shipment.rbindex 0104ab7fe1..e8bb2107fe 100644--- a/core/app/models/spree/shipment.rb+++ b/core/app/models/spree/shipment.rb@@ -109,6 +109,8 @@ module Spreemoney_methods :cost, :discounted_cost, :final_price, :item_cost, :additional_tax_total, :included_tax_total, :tax_totalalias display_amount display_cost+ auto_strip_attributes :tracking+# Returns the shipment number and shipping method name## @return [String]diff --git a/core/app/models/spree/shipping_method.rb b/core/app/models/spree/shipping_method.rbindex 740580b455..489fef5367 100644--- a/core/app/models/spree/shipping_method.rb+++ b/core/app/models/spree/shipping_method.rb@@ -48,9 +48,25 @@ module Spreeenddef build_tracking_url(tracking)- return if tracking.blank? || tracking_url.blank?+ return if tracking.blank?++ tracking = tracking.upcase++ # build tracking url automatically+ if tracking_url.blank?+ # use tracking number gem to build tracking url+ # we need to upcase the tracking number+ # https://github.com/jkeen/tracking_number/pull/85+ tracking_number_service(tracking).tracking_url if tracking_number_service(tracking).valid?+ else+ # build tracking url manually+ tracking_url.gsub(/:tracking/, ERB::Util.url_encode(tracking)) # :url_encode exists in 1.8.7 through 2.1.0+ end+ end- tracking_url.gsub(/:tracking/, ERB::Util.url_encode(tracking)) # :url_encode exists in 1.8.7 through 2.1.0+ # your shipping method subclasses can override this method to provide a custom tracking number service+ def tracking_number_service(tracking)+ @tracking_number_service ||= Spree::Dependencies.tracking_number_service.constantize.new(tracking)enddef self.calculatorsdiff --git a/core/app/services/spree/tracking_numbers/base_service.rb b/core/app/services/spree/tracking_numbers/base_service.rbnew file mode 100644index 0000000000..6b75e8cb6e--- /dev/null+++ b/core/app/services/spree/tracking_numbers/base_service.rb@@ -0,0 +1,19 @@+require 'tracking_number'++# This is a very basic service that can be used to track packages.+# It uses the tracking_number gem to validate and build tracking urls.+# https://github.com/jkeen/tracking_number+# You can create your own service by subclassing this one and using 3rd party services, eg. AfterShip or Shippo+module Spree+ module TrackingNumbers+ class BaseService+ def initialize(tracking_number)+ @tracking = TrackingNumber.new(tracking_number)+ end++ attr_reader :tracking++ delegate :valid?, :tracking_url, to: :tracking+ end+ end+enddiff --git a/core/lib/spree/core/dependencies.rb b/core/lib/spree/core/dependencies.rbindex 605ffcf0d2..9ca2594ad9 100644--- a/core/lib/spree/core/dependencies.rb+++ b/core/lib/spree/core/dependencies.rb@@ -43,6 +43,9 @@ module Spreeshipment_add_item_service: 'Spree::Shipments::AddItem',shipment_remove_item_service: 'Spree::Shipments::RemoveItem',+ # tracking numbers+ tracking_number_service: 'Spree::TrackingNumbers::BaseService',+# sortercollection_sorter: 'Spree::BaseSorter',order_sorter: 'Spree::BaseSorter',diff --git a/core/spec/models/spree/shipping_method_spec.rb b/core/spec/models/spree/shipping_method_spec.rbindex 4195f55e6d..66b083e48e 100644--- a/core/spec/models/spree/shipping_method_spec.rb+++ b/core/spec/models/spree/shipping_method_spec.rb@@ -102,7 +102,7 @@ describe Spree::ShippingMethod, type: :model doendend- context 'generating tracking URLs' do+ describe '#build_tracking_url' docontext 'shipping method has a tracking URL mask on file' dolet(:tracking_url) { 'https://track-o-matic.com/:tracking' }@@ -110,7 +110,7 @@ describe Spree::ShippingMethod, type: :model docontext 'tracking number has spaces' dolet(:tracking_numbers) { ['1234 5678 9012 3456', 'a bcdef'] }- let(:expectations) { %w[https://track-o-matic.com/1234%205678%209012%203456 https://track-o-matic.com/a%20bcdef] }+ let(:expectations) { %w[https://track-o-matic.com/1234%205678%209012%203456 https://track-o-matic.com/A%20BCDEF] }it "returns a single URL with '%20' in lieu of spaces" dotracking_numbers.each_with_index do |num, i|@@ -119,6 +119,16 @@ describe Spree::ShippingMethod, type: :model doendendend++ context 'shipping method does not have a tracking URL mask on file' do+ let(:usps_tracking_number) { '1Z879E930346834440' }++ before { allow(subject).to receive(:tracking_url) { nil } }++ it 'uses tracking number gem to build tracking url' do+ expect(subject.build_tracking_url(usps_tracking_number)).to eq('https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z879E930346834440')+ end+ endend# Regression test for #4320diff --git a/core/spree_core.gemspec b/core/spree_core.gemspecindex 6615c20926..7452abc41d 100644--- a/core/spree_core.gemspec+++ b/core/spree_core.gemspec@@ -50,6 +50,7 @@ Gem::Specification.new do |s|s.add_dependency 'state_machines-activerecord', '~> 0.6's.add_dependency 'state_machines-activemodel', '~> 0.7's.add_dependency 'stringex'+ s.add_dependency 'tracking_number's.add_dependency 'validates_zipcode's.add_dependency 'image_processing', '~> 1.2's.add_dependency 'active_storage_validations', '~> 1.1'