Skip to content

armgit / spree

Public Imported from GitHub
0

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.

Added Shipments::AddItem service

Damian Legawiec1445a89b0c24
diff --git a/core/app/services/spree/shipments/add_item.rb b/core/app/services/spree/shipments/add_item.rb
new file mode 100644
index 0000000000..b4b3bf08b7
--- /dev/null
+++ b/core/app/services/spree/shipments/add_item.rb
@@ -0,0 +1,32 @@
+# adds item to an existing shipment
+# if this variant is already added to the cart it will increase the quantity
+# if not it will create new line item
+module Spree
+ module Shipments
+ class AddItem
+ prepend Spree::ServiceModule::Base
+ include Helper
+
+ def call(shipment:, variant_id:, quantity:)
+ ActiveRecord::Base.transaction do
+ run :prepare_arguments
+ run :add_or_update_line_item
+ end
+ end
+
+ protected
+
+ def prepare_arguments(shipment:, variant_id:, quantity:)
+ order = shipment.order
+ store = order.store
+
+ variant = store.variants.find_by(id: variant_id)
+ return failure(nil, :variant_not_found) if variant.nil?
+
+ quantity = quantity&.to_i || 1
+
+ success(order: order, shipment: shipment, variant: variant, quantity: quantity)
+ end
+ end
+ end
+end
diff --git a/core/app/services/spree/shipments/create.rb b/core/app/services/spree/shipments/create.rb
index 9c0ffbeba3..ede7bb4823 100644
--- a/core/app/services/spree/shipments/create.rb
+++ b/core/app/services/spree/shipments/create.rb
@@ -1,9 +1,11 @@
+# creates new shipment record
+# if selected item (variant) is already added to order it will update line item
+# if not - it will create new line item record
module Spree
module Shipments
class Create
prepend Spree::ServiceModule::Base
-
- attr_accessor :shipment
+ include Helper
def call(store:, shipment_attributes:)
ActiveRecord::Base.transaction do
@@ -33,7 +35,7 @@ module Spree
end
def create_shipment(order:, stock_location:, variant:, quantity:)
- @shipment = order.shipments.create(
+ shipment = order.shipments.create(
order_id: order.id,
stock_location_id: stock_location.id
)
@@ -41,24 +43,6 @@ module Spree
success(order: order, variant: variant, quantity: quantity, shipment: shipment)
end
-
- def return_shipment(line_item)
- success(line_item.target_shipment)
- end
-
- def add_or_update_line_item(order:, variant:, quantity:, shipment:)
- result = add_item_service.call(order: order, variant: variant, quantity: quantity, options: { shipment: shipment})
-
- if result.success?
- success(shipment.reload)
- else
- failure(result.value, result.error)
- end
- end
-
- def add_item_service
- Spree::Dependencies.cart_add_item_service.constantize
- end
end
end
end
diff --git a/core/app/services/spree/shipments/helper.rb b/core/app/services/spree/shipments/helper.rb
new file mode 100644
index 0000000000..44786472e1
--- /dev/null
+++ b/core/app/services/spree/shipments/helper.rb
@@ -0,0 +1,19 @@
+module Spree
+ module Shipments
+ module Helper
+ def add_or_update_line_item(order:, variant:, quantity:, shipment:)
+ result = add_item_service.call(order: order, variant: variant, quantity: quantity, options: { shipment: shipment })
+
+ if result.success?
+ success(shipment.reload)
+ else
+ failure(result.value, result.error)
+ end
+ end
+
+ def add_item_service
+ Spree::Dependencies.cart_add_item_service.constantize
+ end
+ end
+ end
+end
diff --git a/core/spec/services/spree/shipments/add_item_spec.rb b/core/spec/services/spree/shipments/add_item_spec.rb
new file mode 100644
index 0000000000..209f02e9a9
--- /dev/null
+++ b/core/spec/services/spree/shipments/add_item_spec.rb
@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+module Spree
+ describe Shipments::AddItem do
+ subject { described_class }
+
+ let(:store) { create(:store) }
+ let(:order) { create(:order_with_totals, store: store, user: nil, email: '[email protected]') }
+ let(:product) { create(:product_in_stock, stores: [store]) }
+ let(:variant) { product.master }
+
+ let(:execute) { subject.call(params) }
+ let(:value) { execute.value }
+
+ let(:params) do
+ {
+ shipment: shipment,
+ variant_id: variant.id,
+ quantity: 2
+ }
+ end
+
+ let(:shipment) { create(:shipment, order: order) }
+ let(:line_item) { shipment.line_items.last }
+
+ context 'valid attributes' do
+ shared_context 'creates a line item' do
+ it 'creates new line item record' do
+ expect { execute }.to change(order.line_items, :count).by(1)
+ expect(line_item.variant).to eq(variant)
+ expect(line_item.quantity).to eq(2)
+ end
+ end
+
+ context 'without pre-existing line item' do
+ it_behaves_like 'creates a line item'
+ end
+
+ context 'with existing line item' do
+ let!(:old_line_item) { create(:line_item, order: order, variant: variant, quantity: 2) }
+
+ it 'does not create a new line item' do
+ expect { execute }.not_to change(order.line_items, :count)
+ end
+
+ it 'adds quantity to the existing line item' do
+ expect(old_line_item.quantity).to eq(2)
+ execute
+ expect(old_line_item.reload.quantity).to eq(4)
+ end
+
+ it 'updates line item totals' do
+ expect(old_line_item.total).to eq(20)
+ execute
+ expect(old_line_item.reload.total).to eq(BigDecimal(40)) # 4 x 10 unit price
+ end
+ end
+ end
+
+ context 'missing variant' do
+ let(:params) do
+ {
+ shipment: shipment,
+ variant_id: 141223453,
+ quantity: 2
+ }
+ end
+
+ it { expect(execute.success?).to eq(false) }
+ it { expect(execute.error.to_s).to eq('variant_not_found') }
+ end
+
+ xcontext 'invalid attributes' do
+ let(:params) do
+ {
+ order_id: order.id,
+ variant_id: variant.id,
+ quantity: 'invalid', # this will not work as we're doing `to_i` casting
+ stock_location_id: stock_location.id
+ }
+ end
+
+ it { expect(execute.success?).to eq(false) }
+ it { expect(execute.error.value).to be_kind_of(ActiveModel::Errors) }
+ end
+ end
+end