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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
SD-1453 As a Storefront API user I can set User MetaData when creating an Account (#11497)
Aleksandar Petrushev56f131ac5295
diff --git a/api/app/serializers/spree/v2/storefront/user_serializer.rb b/api/app/serializers/spree/v2/storefront/user_serializer.rbindex c5e163e9fa..8a3a233843 100644--- a/api/app/serializers/spree/v2/storefront/user_serializer.rb+++ b/api/app/serializers/spree/v2/storefront/user_serializer.rb@@ -4,7 +4,7 @@ module Spreeclass UserSerializer < BaseSerializerset_type :user- attributes :email+ attributes :email, :public_metadataattribute :store_credits do |user|user.total_available_store_creditdiff --git a/api/docs/v2/storefront/index.yaml b/api/docs/v2/storefront/index.yamlindex cbcd84dbed..cf57775aad 100644--- a/api/docs/v2/storefront/index.yaml+++ b/api/docs/v2/storefront/index.yaml@@ -63,6 +63,16 @@ paths:password_confirmation:type: stringexample: spree123+ public_metadata:+ type: object+ example:+ user_segment: 'supplier'+ description: The public metadata for this User+ private_metadata:+ type: object+ example:+ has_abandoned_cart: false+ description: The private metadata for this Userdescription: ''responses:'200':@@ -3470,6 +3480,11 @@ components:type: numberexample: 3description: Number of placed Orders by this User+ public_metadata:+ type: object+ example:+ user_segment: 'supplier'+ description: The public metadata for this Userrelationships:type: objectproperties:@@ -4889,6 +4904,8 @@ components:email: [email protected]store_credits: 0completed_orders: 0+ public_metadata:+ user_segment: 'supplier'relationships:default_billing_address:data:diff --git a/api/spec/requests/spree/api/v2/storefront/account_spec.rb b/api/spec/requests/spree/api/v2/storefront/account_spec.rbindex 620ab0d3c3..51a4db22ed 100644--- a/api/spec/requests/spree/api/v2/storefront/account_spec.rb+++ b/api/spec/requests/spree/api/v2/storefront/account_spec.rb@@ -3,7 +3,7 @@ require 'spec_helper'describe 'Storefront API v2 Account spec', type: :request doinclude_context 'API v2 tokens'- let!(:user) { create(:user_with_addresses) }+ let!(:user) { create(:user_with_addresses) }let(:headers) { headers_bearer }shared_examples 'mock tests for failed user saving' do@@ -43,6 +43,7 @@ describe 'Storefront API v2 Account spec', type: :request doexpect(json_response['data']).to have_attribute(:email).with_value(user.email)expect(json_response['data']).to have_attribute(:store_credits).with_value(user.total_available_store_credit)expect(json_response['data']).to have_attribute(:completed_orders).with_value(user.orders.complete.count)+ expect(json_response['data']).to have_attribute(:public_metadata).with_value(user.public_metadata)endcontext 'with params "include=default_billing_address"' do@@ -89,7 +90,9 @@ describe 'Storefront API v2 Account spec', type: :request dopassword: 'newpassword123',password_confirmation: 'newpassword123',bill_address_id: default_bill_address.id.to_s,- ship_address_id: default_ship_address.id.to_s+ ship_address_id: default_ship_address.id.to_s,+ public_metadata: { 'has_other_account' => 'true' },+ private_metadata: { 'shops_in_other_stores' => 'false' }}endlet(:params) { { user: new_attributes } }@@ -100,8 +103,11 @@ describe 'Storefront API v2 Account spec', type: :request doit_behaves_like 'returns 200 HTTP status'it 'creates and returns user' do- expect(json_response['data']['id'].to_i).to eq Spree.user_class.last.id+ created_user = Spree.user_class.last+ expect(json_response['data']['id'].to_i).to eq created_user.idexpect(json_response['data']).to have_attribute(:email).with_value(new_attributes[:email])+ expect(json_response['data']).to have_attribute(:public_metadata).with_value(new_attributes[:public_metadata])+ expect(created_user.private_metadata).to eq(new_attributes[:private_metadata])expect(json_response.size).to eq(1)enddiff --git a/core/lib/spree/permitted_attributes.rb b/core/lib/spree/permitted_attributes.rbindex f4ae0e74c6..a099ee519d 100644--- a/core/lib/spree/permitted_attributes.rb+++ b/core/lib/spree/permitted_attributes.rb@@ -145,7 +145,7 @@ module Spree]# TODO: Should probably use something like Spree.user_class.attributes- @@user_attributes = [:email, :bill_address_id, :ship_address_id, :password, :password_confirmation]+ @@user_attributes = [:email, :bill_address_id, :ship_address_id, :password, :password_confirmation, { public_metadata: {}, private_metadata: {} }]@@variant_attributes = [:name, :presentation, :cost_price, :discontinue_on, :lock_version,diff --git a/core/lib/spree/testing_support/factories/user_factory.rb b/core/lib/spree/testing_support/factories/user_factory.rbindex 45d3ecbecf..935c76b925 100644--- a/core/lib/spree/testing_support/factories/user_factory.rb+++ b/core/lib/spree/testing_support/factories/user_factory.rb@@ -9,6 +9,8 @@ FactoryBot.define dopassword { 'secret' }password_confirmation { password }authentication_token { generate(:user_authentication_token) } if Spree.user_class.attribute_method? :authentication_token+ public_metadata { {} }+ private_metadata { {} }factory :admin_user dospree_roles { [Spree::Role.find_by(name: 'admin') || create(:role, name: 'admin')] }