Add ShipmentTracking Job and Call when updated

This commit adds a ShipmentTrackingJob that calls the ShipmentTracking Service.

This was necessary because the check for the update on the tracking number is called before_save and calling the service at this point would cause a lot of delay for the API to execute. Hence, the service is called asynchronously from this point in the code.

app/decorators/models/solidus_bolt/shipment_decorator.rb

@@ -2,6 +2,10 @@
 
 module SolidusBolt
   module ShipmentDecorator
+    def self.prepended(base)
+      base.before_save :update_bolt_tracking_info
+    end
+
     def bolt_items
       line_items.map do |line_item|
         {
@@ -35,6 +39,19 @@ def currency_symbol
       Monetize.from_string(order.total, order.currency).symbol
     end
 
+    def update_bolt_tracking_info
+      return if tracking_was.present?
+      return unless tracking_changed?
+
+      payment = order&.payments&.completed&.last
+      return unless payment&.payment_method.instance_of?(SolidusBolt::PaymentMethod)
+
+      transaction_reference = payment&.response_code
+      return if transaction_reference.blank?
+
+      SolidusBolt::ShipmentTrackingJob.perform_later(transaction_reference: transaction_reference, shipment: self)
+    end
+
     Spree::Shipment.prepend(self)
   end
 end

app/jobs/solidus_bolt/shipment_tracking_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SolidusBolt
+  class ShipmentTrackingJob < ApplicationJob
+    queue_as :default
+
+    def perform(transaction_reference:, shipment:)
+      SolidusBolt::Orders::TrackShipmentService.call(transaction_reference: transaction_reference, shipment: shipment)
+    end
+  end
+end

spec/decorators/models/solidus_bolt/shipment_decorator_spec.rb

@@ -34,4 +34,30 @@
       expect(items.count).to eq(order.line_items.count)
     end
   end
+
+  describe '#update_bolt_tracking_info' do
+    before { allow(SolidusBolt::Orders::TrackShipmentService).to receive(:call) }
+
+    context 'when tracking is nil' do
+      it 'enqueues SolidusBolt::ShipmentTrackingJob' do
+        create(:shipment, order: order, id: rand(1..10), tracking: nil)
+        order.shipments.reload
+        shipment = order.shipments.last
+
+        shipment.tracking = 'MockBolt1678'
+        expect { shipment.save }.to have_enqueued_job(SolidusBolt::ShipmentTrackingJob)
+      end
+    end
+
+    context 'when tracking has a value' do
+      it 'does not enqueue SolidusBolt::ShipmentTrackingJob' do
+        create(:shipment, order: order, id: rand(1..10), tracking: 'MockBolt1678')
+        order.shipments.reload
+        shipment = order.shipments.last
+
+        shipment.tracking = 'MockBolt1123'
+        expect { shipment.save }.not_to have_enqueued_job(SolidusBolt::ShipmentTrackingJob)
+      end
+    end
+  end
 end

spec/jobs/solidus_bolt/shipment_tracking_job_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe SolidusBolt::ShipmentTrackingJob do
+  subject(:shipment_tracking_job) {
+    described_class.perform_now(transaction_reference: transaction_reference, shipment: shipment)
+  }
+
+  let(:shipment) { build(:shipment) }
+  let(:transaction_reference) { 'Multiverse of Madness' }
+
+  before { allow(SolidusBolt::Orders::TrackShipmentService).to receive(:call) }
+
+  it 'calls the TrackShipmentService' do
+    shipment_tracking_job
+    expect(SolidusBolt::Orders::TrackShipmentService).to have_received(:call).with(
+      transaction_reference: transaction_reference, shipment: shipment
+    )
+  end
+end