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 Spree::Base.json_api_type and json_api_columns

Damian Legawiecc50968203e88
diff --git a/core/app/models/spree/base.rb b/core/app/models/spree/base.rb
index 5037061891..32d5361031 100644
--- a/core/app/models/spree/base.rb
+++ b/core/app/models/spree/base.rb
@@ -30,4 +30,12 @@ class Spree::Base < ApplicationRecord
def self.has_many_inversing
false
end
+
+ def self.json_api_columns
+ column_names.reject { |c| c.match(/_id$|id|preferences|(.*)password|(.*)token|(.*)api_key/) }
+ end
+
+ def self.json_api_type
+ to_s.demodulize.underscore
+ end
end
diff --git a/core/spec/models/spree/base_spec.rb b/core/spec/models/spree/base_spec.rb
index 152aef9d5e..a5bfad10c4 100644
--- a/core/spec/models/spree/base_spec.rb
+++ b/core/spec/models/spree/base_spec.rb
@@ -43,4 +43,19 @@ describe Spree::Base do
expect(model_instance.errors.messages).to include(:parent)
expect(model_instance.errors.messages[:parent]).to include('must exist')
end
+
+ describe '.json_api_type' do
+ it { expect(Spree::InventoryUnit.json_api_type).to eq('inventory_unit') }
+ it { expect(Spree::Address.json_api_type).to eq('address') }
+ end
+
+ describe '.json_api_columns' do
+ it 'skips sensitive data' do
+ expect(Spree::LegacyUser.json_api_columns).not_to include('password')
+ expect(Spree::LegacyUser.json_api_columns).to include('email')
+ end
+
+ it { expect(Spree::Address.json_api_columns).to contain_exactly('address1', 'address2', 'alternative_phone', 'city', 'company', 'created_at', 'deleted_at', 'firstname', 'label', 'lastname', 'phone', 'state_name', 'updated_at', 'zipcode') }
+ it { expect(Spree::Address.json_api_columns).not_to include('country_id') }
+ end
end