solidus_easypost 2.0.0 → 3.0.0

data/spec/integration/checkout_spec.rb

@@ -0,0 +1,45 @@
+RSpec.describe 'Checkout' do
+  it 'retrieves the rates from EasyPost', vcr: { cassette_name: 'integration/checkout' } do
+    stub_easypost_config(purchase_labels: true)
+    stub_spree_preferences(require_payment_to_ship: false, track_inventory_levels: false)
+    use_easypost_estimator
+    create_easypost_shipping_methods
+
+    order = Spree::TestingSupport::OrderWalkthrough.up_to(:complete)
+    shipment = order.shipments.first
+    shipment.ship!
+
+    expect(order.state).to eq('complete')
+    expect(shipment.shipping_rates).to match_array([
+      have_attributes(
+        selected: true,
+        cost: 0.393e1,
+        name: 'USPS First',
+        easy_post_shipment_id: /shp_/,
+        easy_post_rate_id: /rate_/,
+      ),
+      have_attributes(
+        selected: false,
+        cost: 0.692e1,
+        name: 'USPS ParcelSelect',
+        easy_post_shipment_id: /shp_/,
+        easy_post_rate_id: /rate_/,
+      ),
+      have_attributes(
+        selected: false,
+        cost: 0.702e1,
+        name: 'USPS Priority',
+        easy_post_shipment_id: /shp_/,
+        easy_post_rate_id: /rate_/,
+      ),
+      have_attributes(
+        selected: false,
+        cost: 0.23e2,
+        name: 'USPS Express',
+        easy_post_shipment_id: /shp_/,
+        easy_post_rate_id: /rate_/,
+      ),
+    ])
+    expect(shipment.tracking).to be_present
+  end
+end

data/spec/integration/order_shipping_spec.rb

@@ -0,0 +1,33 @@
+RSpec.describe 'Order shipping' do
+  context 'with purchase_labels set to true', vcr: { cassette_name: 'integration/order_shipping/with_purchase_labels' } do
+    it 'buys the rate in EasyPost' do
+      stub_easypost_config(purchase_labels: true)
+      stub_spree_preferences(require_payment_to_ship: false, track_inventory_levels: false)
+      use_easypost_estimator
+      create_easypost_shipping_methods
+
+      order = Spree::TestingSupport::OrderWalkthrough.up_to(:complete)
+      shipment = order.shipments.first
+      shipment.ship!
+
+      expect(shipment).to be_shipped
+      expect(shipment.tracking).to be_present
+    end
+  end
+
+  context 'with purchase_labels set to false', vcr: { cassette_name: 'integration/order_shipping/without_purchase_labels' } do
+    it 'does not buy the rate in EasyPost' do
+      stub_easypost_config(purchase_labels: false)
+      stub_spree_preferences(require_payment_to_ship: false, track_inventory_levels: false)
+      use_easypost_estimator
+      create_easypost_shipping_methods
+
+      order = Spree::TestingSupport::OrderWalkthrough.up_to(:complete)
+      shipment = order.shipments.first
+      shipment.ship!
+
+      expect(shipment).to be_shipped
+      expect(shipment.tracking).not_to be_present
+    end
+  end
+end

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

@@ -2,49 +2,16 @@
 
 require 'spec_helper'
 
-RSpec.describe SolidusEasypost::ReturnAuthorization, :vcr do
-  let(:auth) { described_class.new return_authorization }
-  let(:return_authorization) do
-    create :return_authorization do |ra|
-      ra.return_items << create(:return_item)
-    end
-  end
-  before { create :shipping_method, admin_name: 'USPS Priority' }
-
-  before { create :store }
-
-  describe '#easypost_shipment' do
-    subject { auth.easypost_shipment }
-
-    it 'is an EasyPost::Shipment object' do
-      expect(subject).to be_a(EasyPost::Shipment)
-    end
-  end
-
+RSpec.describe SolidusEasypost::ReturnAuthorization, vcr: { cassette_name: 'return_authorization' } do
   describe '#return_label' do
-    subject { auth.return_label shipment.rates.first }
+    it 'returns a valid return label' do
+      return_authorization = create(:return_item).return_authorization
 
-    let(:shipment) { auth.easypost_shipment }
-
-    it 'is an EasyPost::PackageLabel object' do
-      expect(subject).to be_a(EasyPost::PostageLabel)
-    end
+      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)
 
-    it 'has the correct fields' do
-      expect(subject).to have_attributes(
-        id: "pl_37f765f275dd46c2866d0515694a306c",
-        object: "PostageLabel",
-        created_at: "2019-11-12T08:36:50Z",
-        updated_at: "2019-11-12T08:36:51Z",
-        date_advance: 0,
-        integrated_form: "none",
-        label_date: "2019-11-12T08:36:50Z",
-        label_resolution: 300,
-        label_size: "4x6",
-        label_type: "default",
-        label_url: "https://easypost-files.s3-us-west-2.amazonaws.com/files/postage_label/20191112/ebe045d367a742dd8bf718e63a58c390.png",
-        label_file_type: "image/png"
-      )
+      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

@@ -2,78 +2,67 @@
 
 require 'spec_helper'
 
-RSpec.describe Spree::Shipment, :vcr do
-  let!(:shipment) { order.shipments.first }
-  let!(:order) do
-    create(:order_with_line_items, line_items_count: 1, ship_address: to) do |order|
-      order.variants.each { |v| v.update! weight: 10 }
-    end
-  end
-
-  let(:to) do
-    Spree::Address.create(
-      firstname: 'Newt',
-      lastname: 'Scamander',
-      address1: '200 19th St',
-      city: 'Birmingham',
-      state: Spree::State.first || create(:state),
-      country: Spree::Country.first || create(:country),
-      zipcode: 35_203,
-      phone: '123456789'
-    )
-  end
-
-  before do
-    create_shipping_methods
-    shipment.stock_location.update(
-      address1: '2630 Cahaba Rd',
-      city: 'Birmingham',
-      state: Spree::State.first,
-      country: Spree::Country.first,
-      zipcode: 35_223,
-    )
-  end
-
-  it "'buys' a shipping rate after transitioning to ship" do
-    shipment.refresh_rates
-    shipment.state = 'ready'
-
-    shipment.ship!
-    expect(shipment.tracking).to be_present
-  end
-
+RSpec.describe Spree::Shipment do
   describe '#easypost_shipment' do
-    subject { shipment.easypost_shipment }
+    context 'when no shipping rate was selected' do
+      it 'returns nil' do
+        shipment = create(:shipment)
 
-    shared_examples 'an easypost shipment' do
-      it 'is an EasyPost::Shipment object' do
-        expect(subject).to be_a(EasyPost::Shipment)
+        expect(shipment.easypost_shipment).to be_nil
       end
     end
 
-    context 'when it is a new shipment' do
-      it_behaves_like 'an easypost shipment'
+    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,
+        )
 
-      it 'calls the api' do
-        expect(EasyPost::Shipment).to receive(:create).with(anything)
-        subject
+        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
 
-    context 'when it is an existing shipment' do
-      let(:new_shipment) { create :shipment }
+        shipment = create(
+          :shipment,
+          :with_easypost,
+          state: 'ready',
+          easypost_shipment_id: easypost_shipment.id,
+          easypost_rate_id: selected_easypost_rate.id,
+        )
+        shipment.ship!
 
-      before do
-        ep_id = shipment.easypost_shipment.id
-        shipment.shipping_rates.first.update selected: true, easy_post_shipment_id: ep_id
-        shipment.instance_variable_set('@ep_shipment', nil)
+        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,
+        )
 
-      it_behaves_like 'an easypost shipment'
+        shipment.ship!
 
-      it 'loads the existing shipment' do
-        expect(EasyPost::Shipment).to receive(:retrieve).with(anything)
-        subject
+        expect(easypost_shipment).not_to have_received(:buy)
       end
     end
   end

data/spec/models/spree/shipping_rate_spec.rb

@@ -2,15 +2,22 @@
 
 require 'spec_helper'
 
-RSpec.describe Spree::ShippingRate, :vcr do
-  let(:rate) { described_class.new name: name }
-  let(:name) { 'SuperAwesomeCool' }
-
+RSpec.describe Spree::ShippingRate do
   describe '#name' do
-    subject { rate.name }
+    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)
 
-    it 'has the right name' do
-      expect(subject).to eq(name)
+        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