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.

Fix Store Credit and Refund serializers (#12088)

Łukasz Adamczykc0d21ed0a760
diff --git a/api/app/serializers/spree/api/v2/platform/admin_user_serializer.rb b/api/app/serializers/spree/api/v2/platform/admin_user_serializer.rb
new file mode 100644
index 0000000000..63bc74a7b4
--- /dev/null
+++ b/api/app/serializers/spree/api/v2/platform/admin_user_serializer.rb
@@ -0,0 +1,11 @@
+module Spree
+ module Api
+ module V2
+ module Platform
+ class AdminUserSerializer < UserSerializer
+ set_type :admin_user
+ end
+ end
+ end
+ end
+end
diff --git a/api/app/serializers/spree/api/v2/platform/refund_serializer.rb b/api/app/serializers/spree/api/v2/platform/refund_serializer.rb
index 1c2229f30c..77475d2d66 100644
--- a/api/app/serializers/spree/api/v2/platform/refund_serializer.rb
+++ b/api/app/serializers/spree/api/v2/platform/refund_serializer.rb
@@ -5,6 +5,7 @@ module Spree
class RefundSerializer < BaseSerializer
include ResourceSerializerConcern
+ belongs_to :refunder, serializer: Dependencies.platform_admin_user_serializer.constantize
belongs_to :payment
belongs_to :reimbursement
belongs_to :refund_reason, object_method_name: :reason
diff --git a/api/app/serializers/spree/api/v2/platform/store_credit_serializer.rb b/api/app/serializers/spree/api/v2/platform/store_credit_serializer.rb
index 06060c230c..a202f7a458 100644
--- a/api/app/serializers/spree/api/v2/platform/store_credit_serializer.rb
+++ b/api/app/serializers/spree/api/v2/platform/store_credit_serializer.rb
@@ -6,7 +6,7 @@ module Spree
include ResourceSerializerConcern
belongs_to :user
- belongs_to :created_by, serializer: :user, type: :user
+ belongs_to :created_by, serializer: Dependencies.platform_admin_user_serializer.constantize
belongs_to :store_credit_category, object_method_name: :category, id_method_name: :category_id
belongs_to :store_credit_type, object_method_name: :credit_type, id_method_name: :type_id
diff --git a/api/lib/spree/api/dependencies.rb b/api/lib/spree/api/dependencies.rb
index cfb95d983e..c73df88961 100644
--- a/api/lib/spree/api/dependencies.rb
+++ b/api/lib/spree/api/dependencies.rb
@@ -87,7 +87,7 @@ module Spree
error_handler: 'Spree::Api::ErrorHandler',
# serializers
- platform_admin_user_serializer: 'Spree::Api::V2::Platform::UserSerializer',
+ platform_admin_user_serializer: 'Spree::Api::V2::Platform::AdminUserSerializer',
# coupon code handler
platform_coupon_handler: -> { Spree::Dependencies.coupon_handler },
diff --git a/api/spec/serializers/spree/api/v2/platform/refund_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/refund_serializer_spec.rb
index 0a9c18e767..f68428903e 100644
--- a/api/spec/serializers/spree/api/v2/platform/refund_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/refund_serializer_spec.rb
@@ -5,9 +5,31 @@ describe Spree::Api::V2::Platform::RefundSerializer do
subject { described_class.new(resource, params: serializer_params).serializable_hash }
- let(:resource) { create(:refund, amount: 5.0) }
+ let(:resource) { create(:refund, amount: 5.0, refunder: create(:user)) }
it { expect(subject).to be_kind_of(Hash) }
it_behaves_like 'an ActiveJob serializable hash'
+
+ context 'with included relationships' do
+ subject do
+ described_class.new(resource, include: described_class.relationships_to_serialize.keys).serializable_hash
+ end
+
+ it 'serializes the refund' do
+ expect(subject[:data][:id]).to eq(resource.id.to_s)
+ expect(subject[:data][:type]).to eq(:refund)
+
+ expect(subject[:data][:relationships]).to include(
+ refunder: {
+ data: {
+ id: resource.refunder_id.to_s,
+ type: :admin_user
+ }
+ }
+ )
+
+ expect(subject[:included]).to include(hash_including(id: resource.refunder_id.to_s))
+ end
+ end
end
diff --git a/api/spec/serializers/spree/api/v2/platform/store_credit_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/store_credit_serializer_spec.rb
index 9dbe7dbdd5..be0b7a7236 100644
--- a/api/spec/serializers/spree/api/v2/platform/store_credit_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/store_credit_serializer_spec.rb
@@ -10,4 +10,26 @@ describe Spree::Api::V2::Platform::StoreCreditSerializer do
it { expect(subject).to be_kind_of(Hash) }
it_behaves_like 'an ActiveJob serializable hash'
+
+ context 'with included relationships' do
+ subject do
+ described_class.new(resource, include: described_class.relationships_to_serialize.keys).serializable_hash
+ end
+
+ it 'serializes the store credit' do
+ expect(subject[:data][:id]).to eq(resource.id.to_s)
+ expect(subject[:data][:type]).to eq(:store_credit)
+
+ expect(subject[:data][:relationships]).to include(
+ created_by: {
+ data: {
+ id: resource.created_by_id.to_s,
+ type: :admin_user
+ }
+ }
+ )
+
+ expect(subject[:included]).to include(hash_including(id: resource.created_by_id.to_s))
+ end
+ end
end
diff --git a/core/db/migrate/20240725124530_add_refunder_to_spree_refunds.rb b/core/db/migrate/20240725124530_add_refunder_to_spree_refunds.rb
new file mode 100644
index 0000000000..80f84a260d
--- /dev/null
+++ b/core/db/migrate/20240725124530_add_refunder_to_spree_refunds.rb
@@ -0,0 +1,6 @@
+class AddRefunderToSpreeRefunds < ActiveRecord::Migration[6.1]
+ def change
+ add_column :spree_refunds, :refunder_id, :bigint, if_not_exists: true
+ add_index :spree_refunds, :refunder_id, if_not_exists: true
+ end
+end