solidus_easypost 1.0.3 → 3.0.0

data/spec/models/solidus_easypost/parcel_dimension_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SolidusEasypost::ParcelDimension do
+  describe '.new' do
+    subject(:instance) { described_class.new(params) }
+
+    let(:params) do
+      { height: 3 }
+    end
+
+    context 'when the weight is not passed' do
+      let(:params) do
+        { height: 3 }
+      end
+
+      it 'raises an argument error exception' do
+        expect {
+          instance
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'when the passed weight is zero' do
+      let(:params) do
+        { height: 3, weight: 0 }
+      end
+
+      it 'raises an argument error exception' do
+        expect {
+          instance
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#to_h' do
+    subject(:instance_hash) { described_class.new(params).to_h }
+
+    context 'when the params contains zero values' do
+      let(:params) do
+        { weight: 3, width: 0, height: 0, unknown: -1 }
+      end
+
+      it 'returns the correct parcel dimension hash' do
+        expect(instance_hash).to eq({
+          weight: 3
+        })
+      end
+    end
+
+    context 'when the params contains the wrong params' do
+      let(:params) do
+        { weight: 3, unknown: -1, another: 11 }
+      end
+
+      it 'returns the correct parcel dimension hash' do
+        expect(instance_hash).to eq({
+          weight: 3
+        })
+      end
+    end
+
+    context 'when the params contains the correct params' do
+      let(:params) do
+        { weight: 3, width: 1, depth: 6, height: 11 }
+      end
+
+      it 'returns the correct parcel dimension hash' do
+        expect(instance_hash).to eq({
+          height: 11,
+          weight: 3,
+          width: 1,
+          length: 6,
+        })
+      end
+    end
+  end
+end

data/spec/models/solidus_easypost/return_authorization_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SolidusEasypost::ReturnAuthorization, vcr: { cassette_name: 'return_authorization' } do
+  describe '#return_label' do
+    it 'returns a valid return label' do
+      return_authorization = create(:return_item).return_authorization
+
+      easypost_return_authorization = described_class.new(return_authorization)
+      selected_easypost_rate = easypost_return_authorization.easypost_shipment.rates.first
+      return_label = easypost_return_authorization.return_label(selected_easypost_rate)
+
+      expect(return_label).to have_attributes(object: 'PostageLabel')
+    end
+  end
+end

data/spec/models/spree/carton_spec.rb

@@ -0,0 +1,57 @@
+RSpec.describe Spree::Carton do
+  describe '.create' do
+    context 'when track_all_cartons is true' do
+      it 'tracks the package automatically' do
+        stub_easypost_config(track_all_cartons: true)
+        tracker = instance_double(EasyPost::Tracker, id: 'trk_test')
+        allow(EasyPost::Tracker).to receive(:create).and_return(tracker)
+
+        carton = create(:carton)
+
+        expect(carton.easy_post_tracker_id).to eq('trk_test')
+      end
+    end
+
+    context 'when track_all_cartons is false' do
+      it 'does not track all packages automatically' do
+        stub_easypost_config(track_all_cartons: false)
+
+        carton = create(:carton)
+
+        expect(carton.easy_post_tracker_id).to eq(nil)
+      end
+    end
+  end
+
+  describe '#easypost_tracker' do
+    context 'when a tracker was already created' do
+      it 'returns the existing tracker' do
+        carton = create(:carton, easy_post_tracker_id: 'trk_test')
+        tracker = instance_double(EasyPost::Tracker)
+        allow(EasyPost::Tracker).to receive(:retrieve).with('trk_test').and_return(tracker)
+
+        expect(carton.easypost_tracker).to eq(tracker)
+      end
+    end
+
+    context 'when a tracker was not created' do
+      it 'creates a new tracker' do
+        carton = create(:carton, tracking: 'TESTTRACKING', shipping_method: create(:shipping_method, carrier: 'FedEx'))
+        tracker = instance_double(EasyPost::Tracker, id: 'trk_test')
+        allow(EasyPost::Tracker).to receive(:create).with(tracking_code: 'TESTTRACKING', carrier: 'FedEx').and_return(tracker)
+
+        expect(carton.easypost_tracker).to eq(tracker)
+      end
+
+      it "sets the tracker's ID on the carton" do
+        carton = create(:carton)
+        tracker = instance_double(EasyPost::Tracker, id: 'trk_test')
+        allow(EasyPost::Tracker).to receive(:create).and_return(tracker)
+
+        carton.easypost_tracker
+
+        expect(carton.easy_post_tracker_id).to eq('trk_test')
+      end
+    end
+  end
+end

data/spec/models/spree/shipment_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Spree::Shipment do
+  describe '#easypost_shipment' do
+    context 'when no shipping rate was selected' do
+      it 'returns nil' do
+        shipment = create(:shipment)
+
+        expect(shipment.easypost_shipment).to be_nil
+      end
+    end
+
+    context 'when a shipping rate was selected' do
+      it 'returns the shipment associated with the shipping rate' do
+        easypost_shipment = stub_easypost_shipment
+        shipment = create(
+          :shipment,
+          :with_easypost,
+          easypost_shipment_id: easypost_shipment.id,
+        )
+
+        expect(shipment.easypost_shipment).to eq(easypost_shipment)
+      end
+    end
+  end
+
+  describe '#ship!' do
+    context 'when purchase_labels is true' do
+      it 'buys the selected rate' do
+        stub_easypost_config(purchase_labels: true)
+        easypost_shipment = stub_easypost_shipment
+        selected_easypost_rate = easypost_shipment.rates.first
+
+        shipment = create(
+          :shipment,
+          :with_easypost,
+          state: 'ready',
+          easypost_shipment_id: easypost_shipment.id,
+          easypost_rate_id: selected_easypost_rate.id,
+        )
+        shipment.ship!
+
+        expect(easypost_shipment).to have_received(:buy).with(selected_easypost_rate)
+      end
+    end
+
+    context 'when purchase_labels is false' do
+      it 'does not buy rates automatically' do
+        stub_easypost_config(purchase_labels: false)
+        easypost_shipment = stub_easypost_shipment
+        selected_easypost_rate = easypost_shipment.rates.first
+
+        shipment = create(
+          :shipment,
+          :with_easypost,
+          state: 'ready',
+          easypost_shipment_id: easypost_shipment.id,
+          easypost_rate_id: selected_easypost_rate.id,
+        )
+
+        shipment.ship!
+
+        expect(easypost_shipment).not_to have_received(:buy)
+      end
+    end
+  end
+end

data/spec/models/spree/shipping_rate_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Spree::ShippingRate do
+  describe '#name' do
+    context 'when the shipping rate has its own name' do
+      it 'returns the name on the shipping rate' do
+        shipping_rate = build_stubbed(:shipping_rate, name: 'USPS Express')
+
+        expect(shipping_rate.name).to eq('USPS Express')
+      end
+    end
+
+    context 'when the shipping rate does not have its own name' do
+      it 'returns the name on the shipping method' do
+        shipping_rate = build_stubbed(:shipping_rate, name: nil)
+
+        expect(shipping_rate.name).to eq(shipping_rate.shipping_method.name)
+      end
+    end
+  end
+end

data/spec/solidus_easypost/address_builder_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe SolidusEasypost::AddressBuilder do
+  describe '.from_address', vcr: { cassette_name: 'address_builder/from_address' } do
+    it 'builds an address with the correct attributes' do
+      address = described_class.from_address(build_stubbed(:address))
+
+      expect(address).to have_attributes(object: 'Address')
+    end
+  end
+
+  describe '.from_stock_location', vcr: { cassette_name: 'address_builder/from_stock_location' } do
+    it 'builds an address with the correct attributes' do
+      address = described_class.from_stock_location(create(:stock_location))
+
+      expect(address).to have_attributes(object: 'Address')
+    end
+  end
+end

data/spec/solidus_easypost/calculator/weight_dimension_calculator_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+RSpec.describe SolidusEasypost::Calculator::WeightDimensionCalculator do
+  describe '#compute' do
+    subject(:compute) { described_class.new.compute(resource) }
+
+    context 'when a wrong resource is passed' do
+      let(:resource) { create(:shipment) }
+
+      it 'raises an unknown partial resource error' do
+        expect { compute }.to raise_error(SolidusEasypost::Errors::UnknownPartialResourceError)
+      end
+    end
+
+    context 'when a Spree::Stock::Package is passed' do
+      let(:resource) { create(:shipment).to_package }
+
+      before { allow(SolidusEasypost::ParcelDimension).to receive(:new) }
+
+      it 'build a parcel dimension' do
+        compute
+
+        expect(SolidusEasypost::ParcelDimension).to have_received(:new).with({ weight: 10.to_f })
+      end
+    end
+
+    context 'when a SolidusEasypost::ReturnAuthorization is passed' do
+      let(:resource) { SolidusEasypost::ReturnAuthorization.new(create(:return_authorization)) }
+
+      before { allow(SolidusEasypost::ParcelDimension).to receive(:new) }
+
+      it 'build a parcel dimension' do
+        compute
+
+        expect(SolidusEasypost::ParcelDimension).to have_received(:new).with({ weight: 0.to_f })
+      end
+    end
+  end
+end

data/spec/solidus_easypost/estimator_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SolidusEasypost::Estimator, vcr: { cassette_name: 'estimator' } do
+  describe '#shipping_rates' do
+    context 'when the shipping methods are available to users' do
+      it 'returns the shipping rates' do
+        stub_shipping_method_selector(available_to_users: true)
+
+        rates = described_class.new.shipping_rates(create(:shipment).to_package)
+
+        hash = {
+          "USPS Express" => 22.74,
+          "USPS First" => 3.82,
+          "USPS ParcelSelect" => 6.85,
+          "USPS Priority" => 6.95,
+        }
+
+        expect(rates.sort_by(&:name).map { |r| [r.name, r.cost] }.to_h).to eq(hash)
+      end
+    end
+
+    context 'when the shipping methods are not available to users' do
+      it 'returns no rates' do
+        stub_shipping_method_selector(available_to_users: false)
+
+        rates = described_class.new.shipping_rates(create(:shipment).to_package)
+
+        expect(rates).to be_empty
+      end
+    end
+  end
+
+  private
+
+  def stub_shipping_method_selector(available_to_users:)
+    shipping_method_selector = Class.new.tap do |klass|
+      klass.define_method(:shipping_method_for) do |rate|
+        Spree::ShippingMethod.new(
+          name: "#{rate.carrier} #{rate.service}",
+          available_to_users: available_to_users,
+        )
+      end
+    end
+
+    stub_const('FakeShippingMethodSelector', shipping_method_selector)
+
+    allow(SolidusEasypost.configuration).to receive(:shipping_method_selector_class)
+      .and_return(FakeShippingMethodSelector)
+  end
+end

data/spec/solidus_easypost/parcel_builder_spec.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+RSpec.describe SolidusEasypost::ParcelBuilder do
+  describe '.from_package', vcr: { cassette_name: 'parcel_builder/from_package' } do
+    let(:shipment) { create(:shipment) }
+    let(:package) { shipment.to_package }
+    let(:parcel_dimension_calculator) { instance_spy('SolidusEasypost.configuration.parcel_dimension_calculator_class') }
+    let(:parcel_dimension) { instance_spy('SolidusEasypost::ParcelDimension') }
+
+    before do
+      allow(SolidusEasypost.configuration.parcel_dimension_calculator_class)
+        .to receive(:new)
+        .and_return(parcel_dimension_calculator)
+
+      allow(parcel_dimension_calculator).to receive(:compute).and_return(parcel_dimension)
+      allow(parcel_dimension).to receive(:to_h).and_return(dimension_hash)
+      allow(EasyPost::Parcel).to receive(:create).and_call_original
+    end
+
+    context 'when there is only the weight set' do
+      let(:dimension_hash) { { weight: 10.to_f } }
+
+      it 'builds a parcel with the correct attributes' do
+        parcel = described_class.from_package(package)
+
+        expect(parcel_dimension_calculator)
+          .to have_received(:compute)
+          .with(package)
+
+        expect(EasyPost::Parcel)
+          .to have_received(:create)
+          .with({ weight: 10.to_f })
+
+        expect(parcel).to have_attributes(object: 'Parcel')
+      end
+    end
+
+    context 'when all the properties are set' do
+      let(:dimension_hash) do
+        { weight: 10.to_f, height: 2.to_f, width: 3.to_f, depth: 4.to_f }
+      end
+
+      it 'builds a parcel with the correct attributes' do
+        parcel = described_class.from_package(package)
+
+        expect(parcel_dimension_calculator)
+          .to have_received(:compute)
+          .with(package)
+
+        expect(EasyPost::Parcel)
+          .to have_received(:create)
+          .with({ weight: 10.to_f, height: 2.to_f, width: 3.to_f, depth: 4.to_f })
+
+        expect(parcel).to have_attributes(object: 'Parcel')
+      end
+    end
+  end
+
+  describe '.from_return_authorization', vcr: { cassette_name: 'parcel_builder/from_return_authorization' } do
+    let(:return_item) { create(:return_item) }
+    let(:return_authorization) { return_item.return_authorization }
+    let(:parcel_dimension_calculator) { instance_spy('SolidusEasypost.configuration.parcel_dimension_calculator_class') }
+    let(:parcel_dimension) { instance_spy('SolidusEasypost::ParcelDimension') }
+
+    before do
+      allow(SolidusEasypost.configuration.parcel_dimension_calculator_class)
+        .to receive(:new)
+        .and_return(parcel_dimension_calculator)
+
+      allow(parcel_dimension_calculator).to receive(:compute).and_return(parcel_dimension)
+      allow(parcel_dimension).to receive(:to_h).and_return(dimension_hash)
+      allow(EasyPost::Parcel).to receive(:create).and_call_original
+    end
+
+    context 'when there is only the weight set' do
+      let(:dimension_hash) { { weight: 10.to_f } }
+
+      it 'builds a parcel with the correct attributes' do
+        parcel = described_class.from_return_authorization(return_authorization)
+
+        expect(parcel_dimension_calculator)
+          .to have_received(:compute)
+          .with(return_authorization)
+
+        expect(EasyPost::Parcel)
+          .to have_received(:create)
+          .with({ weight: 10.to_f })
+
+        expect(parcel).to have_attributes(object: 'Parcel')
+      end
+    end
+
+    context 'when all the properties are set' do
+      let(:dimension_hash) do
+        { weight: 10.to_f, height: 2.to_f, width: 3.to_f, depth: 4.to_f }
+      end
+
+      it 'builds a parcel with the correct attributes' do
+        parcel = described_class.from_return_authorization(return_authorization)
+
+        expect(parcel_dimension_calculator)
+          .to have_received(:compute)
+          .with(return_authorization)
+
+        expect(EasyPost::Parcel)
+          .to have_received(:create)
+          .with({ weight: 10.to_f, height: 2.to_f, width: 3.to_f, depth: 4.to_f })
+
+        expect(parcel).to have_attributes(object: 'Parcel')
+      end
+    end
+  end
+end

data/spec/solidus_easypost/shipment_builder_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+RSpec.describe SolidusEasypost::ShipmentBuilder do
+  describe '.from_package', vcr: { cassette_name: 'shipment_builder/from_package' } do
+    it 'builds a shipment with the correct attributes' do
+      shipment = described_class.from_package(create(:shipment).to_package)
+
+      expect(shipment).to have_attributes(object: 'Shipment')
+    end
+  end
+
+  describe '.from_shipment', vcr: { cassette_name: 'shipment_builder/from_shipment' } do
+    it 'builds a shipment with the correct attributes' do
+      shipment = described_class.from_shipment(create(:shipment))
+
+      expect(shipment).to have_attributes(object: 'Shipment')
+    end
+  end
+
+  describe '.from_return_authorization', vcr: { cassette_name: 'shipment_builder/from_return_authorization' } do
+    it 'builds a shipment with the correct attributes' do
+      solidus_return_authorization = create(:return_item).return_authorization
+      shipment = described_class.from_return_authorization(SolidusEasypost::ReturnAuthorization.new(solidus_return_authorization))
+
+      expect(shipment).to have_attributes(object: 'Shipment')
+    end
+  end
+end

data/spec/solidus_easypost/shipping_method_selector_spec.rb

@@ -0,0 +1,33 @@
+RSpec.describe SolidusEasypost::ShippingMethodSelector do
+  describe '#shipping_method_for' do
+    context 'when a shipping method for the given carrier and service exists' do
+      it 'returns the existing shipping method' do
+        shipping_method = create(:shipping_method, carrier: 'USPS', service_level: 'Express')
+        easypost_rate = EasyPost::Rate.construct_from('carrier' => 'USPS', 'service' => 'Express')
+
+        selector = described_class.new
+        selected_shipping_method = selector.shipping_method_for(easypost_rate)
+
+        expect(selected_shipping_method).to eq(shipping_method)
+      end
+    end
+
+    context 'when a shipping method for the given carrier and service does not exist' do
+      it 'creates a new shipping method' do
+        shipping_category = create(:shipping_category)
+        easypost_rate = EasyPost::Rate.construct_from('carrier' => 'USPS', 'service' => 'Express')
+
+        selector = described_class.new
+        selected_shipping_method = selector.shipping_method_for(easypost_rate)
+
+        expect(selected_shipping_method).to have_attributes(
+          name: 'USPS Express',
+          carrier: 'USPS',
+          service_level: 'Express',
+          shipping_categories: [shipping_category],
+          available_to_users: false,
+        )
+      end
+    end
+  end
+end

data/spec/solidus_easypost/shipping_rate_calculator_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe SolidusEasypost::ShippingRateCalculator do
+  describe '#compute' do
+    it 'returns the amount on the EasyPost rate' do
+      easypost_rate = EasyPost::Rate.construct_from('rate' => 25.0)
+
+      calculator = described_class.new
+      computed_rate = calculator.compute(easypost_rate)
+
+      expect(computed_rate).to eq(25.0)
+    end
+  end
+end

data/spec/solidus_easypost/tracker_webhook_handler_spec.rb

@@ -0,0 +1,58 @@
+RSpec.describe SolidusEasypost::TrackerWebhookHandler do
+  describe '.call' do
+    context 'when the event is not tracker.updated' do
+      it 'does not process the event' do
+        stub_const('Spree::Event', class_spy(Spree::Event))
+        create(:carton, easy_post_tracker_id: 'trk_test')
+
+        payload = {
+          'description' => 'tracker.created',
+          'result' => {
+            'id' => 'trk_test',
+          },
+        }
+        described_class.call(payload)
+
+        expect(Spree::Event).not_to have_received(:fire)
+      end
+    end
+
+    context 'when the tracker was not registered in Solidus' do
+      it 'does not process the event' do
+        stub_const('Spree::Event', class_spy(Spree::Event))
+        create(:carton, easy_post_tracker_id: 'trk_test')
+
+        payload = {
+          'description' => 'tracker.updated',
+          'result' => {
+            'id' => 'trk_test1',
+          },
+        }
+        described_class.call(payload)
+
+        expect(Spree::Event).not_to have_received(:fire)
+      end
+    end
+
+    context 'when the event is a tracker update for a registered tracker' do
+      it 'forwards the event via the event bus' do
+        stub_const('Spree::Event', class_spy(Spree::Event))
+        carton = create(:carton, easy_post_tracker_id: 'trk_test')
+
+        payload = {
+          'description' => 'tracker.updated',
+          'result' => {
+            'id' => 'trk_test',
+          },
+        }
+        described_class.call(payload)
+
+        expect(Spree::Event).to have_received(:fire).with(
+          'solidus_easypost.tracker.updated',
+          carton: carton,
+          payload: payload,
+        )
+      end
+    end
+  end
+end

data/spec/solidus_easypost_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SolidusEasypost do
+  describe '.configuration' do
+    it 'returns the configuration' do
+      expect(described_class.configuration).to be_instance_of(SolidusEasypost::Configuration)
+    end
+  end
+
+  describe '.configure' do
+    it 'yields the configuration' do
+      expect { |b| described_class.configure(&b) }.to yield_with_args(
+        an_instance_of(SolidusEasypost::Configuration),
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+# Run Coverage report
+require 'solidus_dev_support/rspec/coverage'
+
+# Create the dummy app if it's still missing.
+dummy_env = "#{__dir__}/dummy/config/environment.rb"
+system 'bin/rake extension:test_app' unless File.exist? dummy_env
+require dummy_env
+
+# Requires factories and other useful helpers defined in spree_core.
+require 'solidus_dev_support/rspec/feature_helper'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{__dir__}/support/**/*.rb"].sort.each { |f| require f }
+
+# Requires factories defined in lib/solidus_easypost/testing_support/factories.rb
+require 'solidus_easypost/testing_support/factories'
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+  config.use_transactional_fixtures = false
+
+  if Spree.solidus_gem_version < Gem::Version.new('2.11')
+    config.extend Spree::TestingSupport::AuthorizationHelpers::Request, type: :system
+  end
+end

data/spec/support/easypost.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.before { EasyPost.api_key = 'CvzYtuda6KRI9JjG7SAHbA' }
+end

data/spec/support/factory_bot.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+FactoryBot.use_parent_strategy = false