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
Fixed Pages API
Damian Legawiecaac370e08440
diff --git a/api/app/controllers/spree/api/v2/storefront/cms_pages_controller.rb b/api/app/controllers/spree/api/v2/storefront/cms_pages_controller.rbindex ad5798670c..ec9ca5e0d9 100644--- a/api/app/controllers/spree/api/v2/storefront/cms_pages_controller.rb+++ b/api/app/controllers/spree/api/v2/storefront/cms_pages_controller.rb@@ -21,8 +21,18 @@ module SpreeSpree::Api::Dependencies.storefront_cms_page_serializer.constantizeend+ def collection_finder+ Spree::Api::Dependencies.storefront_cms_page_finder.constantize+ end+def scope- super.by_locale(I18n.locale).linkable+ super.by_locale(I18n.locale)+ end++ def scope_includes+ {+ cms_sections: :linked_resource+ }endendenddiff --git a/api/app/serializers/spree/api/v2/platform/cms_page_serializer.rb b/api/app/serializers/spree/api/v2/platform/cms_page_serializer.rbindex 758e69e213..6e2b89483f 100644--- a/api/app/serializers/spree/api/v2/platform/cms_page_serializer.rb+++ b/api/app/serializers/spree/api/v2/platform/cms_page_serializer.rb@@ -4,6 +4,8 @@ module Spreemodule Platformclass CmsPageSerializer < BaseSerializerinclude ::Spree::Api::V2::ResourceSerializerConcern++ has_many :cms_sections, serializer: :cms_sectionendendenddiff --git a/api/app/serializers/spree/v2/storefront/cms_page_serializer.rb b/api/app/serializers/spree/v2/storefront/cms_page_serializer.rbindex e33b63ebdf..756dc2d1d0 100644--- a/api/app/serializers/spree/v2/storefront/cms_page_serializer.rb+++ b/api/app/serializers/spree/v2/storefront/cms_page_serializer.rb@@ -7,7 +7,7 @@ module Spreeattributes :title, :content, :locale, :meta_description, :meta_title,:slug, :type- has_many :cms_sections+ has_many :cms_sections, serializer: :cms_sectionendendenddiff --git a/api/app/serializers/spree/v2/storefront/cms_section_serializer.rb b/api/app/serializers/spree/v2/storefront/cms_section_serializer.rbindex 98396f681f..983b2b0a96 100644--- a/api/app/serializers/spree/v2/storefront/cms_section_serializer.rb+++ b/api/app/serializers/spree/v2/storefront/cms_section_serializer.rb@@ -21,7 +21,7 @@ module Spreesection.fullscreen?end- belongs_to :cms_page+ belongs_to :linked_resource, polymorphic: trueendendenddiff --git a/api/config/routes.rb b/api/config/routes.rbindex abf213d19e..b3addbd8cd 100644--- a/api/config/routes.rb+++ b/api/config/routes.rb@@ -165,8 +165,7 @@ Spree::Core::Engine.add_routes doget '/stores/:code', to: 'stores#show', as: :storeresources :menus, only: %i[index show]-- resources :cms_pages, only: %i[index show], path: '/pages'+ resources :cms_pages, only: %i[index show]endnamespace :platform dodiff --git a/api/spec/requests/spree/api/v2/storefront/cms_pages_spec.rb b/api/spec/requests/spree/api/v2/storefront/cms_pages_spec.rbnew file mode 100644index 0000000000..4f1c96de9a--- /dev/null+++ b/api/spec/requests/spree/api/v2/storefront/cms_pages_spec.rb@@ -0,0 +1,180 @@+require 'spec_helper'++describe 'Storefront API v2 CMS Pages spec', type: :request do+ let(:store) { Spree::Store.default }++ before do+ store.update(supported_locales: 'en,fr')+ end++ describe 'cms_pages#index' do+ let!(:home_en) { create(:cms_homepage, store: store) }+ let!(:standard_en) { create(:cms_standard_page, store: store, title: 'About us') }+ let!(:home_fr) { create(:cms_homepage, store: store, locale: 'fr') }+ let!(:standard_fr) { create(:cms_standard_page, store: store, locale: 'fr') }+ let!(:home_store_2) { create(:cms_homepage, store: create(:store)) }+ let(:page) { home_en }++ shared_examples 'returns proper JSON structure' do+ it 'with page attributes and relationships' do+ expect(json_response['data'][0]).to have_type('cms_page')+ expect(json_response['data'][0]).to have_relationships(:cms_sections)+ expect(json_response['data'][0]['id']).to eq(page.id.to_s)+ expect(json_response['data'][0]['attributes']['title']).to eq page.title+ expect(json_response['data'][0]['attributes']['locale']).to eq page.locale+ expect(json_response['data'][0]['attributes']['content']).to eq page.content+ expect(json_response['data'][0]['attributes']['meta_description']).to eq page.meta_description+ expect(json_response['data'][0]['attributes']['meta_title']).to eq page.meta_title+ expect(json_response['data'][0]['attributes']['slug']).to eq page.slug+ expect(json_response['data'][0]['attributes']['type']).to eq page.type+ end+ end++ context 'with no params' do+ before { get '/api/v2/storefront/cms_pages' }++ it_behaves_like 'returns 200 HTTP status'+ it_behaves_like 'returns proper JSON structure'++ it 'returns all pages for the current store and locale' do+ expect(json_response['data'].pluck(:id)).to contain_exactly(home_en.id.to_s, standard_en.id.to_s)+ end+ end++ context 'with locale param' do+ let(:page) { home_fr }++ before { get '/api/v2/storefront/cms_pages?locale=fr' }++ it_behaves_like 'returns 200 HTTP status'+ it_behaves_like 'returns proper JSON structure'++ it 'returns all pages for the current store and specified locale' do+ expect(json_response['data'].pluck(:id)).to contain_exactly(home_fr.id.to_s, standard_fr.id.to_s)+ end+ end++ context 'filtering by type' do+ shared_examples 'returns proper records' do+ before { get "/api/v2/storefront/cms_pages?filter[type]=#{kind}" }++ it_behaves_like 'returns 200 HTTP status'++ it 'returns pages for the current store and specified kind' do+ expect(json_response['data'].pluck(:id)).to contain_exactly(page.id.to_s)+ end+ end++ context 'homepage' do+ let(:kind) { 'home' }+ let(:page) { home_en }++ it_behaves_like 'returns proper records'+ end++ context 'standard' do+ let(:kind) { 'standard' }+ let(:page) { standard_en }++ it_behaves_like 'returns proper records'+ end++ context 'feature' do+ let(:kind) { 'feature' }+ let!(:page) { create(:cms_feature_page, store: store) }++ it_behaves_like 'returns proper records'+ end++ context 'non-existing type' do+ before { get '/api/v2/storefront/cms_pages?filter[type]=non-existing' }++ it_behaves_like 'returns 200 HTTP status'++ it 'returns all records' do+ expect(json_response['data'].pluck(:id)).to contain_exactly(home_en.id.to_s, standard_en.id.to_s)+ end+ end+ end++ context 'filtering by title' do+ before { get '/api/v2/storefront/cms_pages?filter[title]=about' }++ it_behaves_like 'returns 200 HTTP status'++ it 'returns page with title containing the query' do+ expect(json_response['data'].pluck(:id)).to contain_exactly(standard_en.id.to_s)+ end+ end++ context 'including cms sections with linked resources' do+ let(:taxonomy) { create(:taxonomy, store: store) }+ let(:taxon) { create(:taxon, taxonomy: taxonomy) }+ let!(:cms_section) { create(:cms_section, cms_page: home_en, linked_resource: taxon) }++ before { get '/api/v2/storefront/cms_pages?include=cms_sections.linked_resource' }++ it_behaves_like 'returns 200 HTTP status'+ it_behaves_like 'returns proper JSON structure'++ it 'returns cms sections and their associations' do+ expect(json_response['included']).to include(have_type('taxon').and(have_id(taxon.id.to_s)))+ expect(json_response['included']).to include(+ have_type('cms_section').+ and(+ have_id(cms_section.id.to_s).+ and(have_relationship(:linked_resource)).+ and(have_jsonapi_attributes(+ :name, :content, :settings, :link, :fit, :type, :position, :is_fullscreen,+ :img_one_sm, :img_one_md, :img_one_lg, :img_two_sm, :img_two_md, :img_two_lg,+ :img_three_sm, :img_three_md, :img_three_lg+ ))+ )+ )+ end+ end+ end++ describe 'cms_pages#show' do+ context 'with valid page ID' do+ let!(:page) { create(:cms_standard_page, store: store) }+ let(:taxonomy) { create(:taxonomy, store: store) }+ let(:taxon) { create(:taxon, taxonomy: taxonomy) }+ let!(:page_item) { create(:cms_section, cms_page: page, linked_resource: taxon) }++ before { get "/api/v2/storefront/cms_pages/#{page.id}?include=cms_sections.linked_resource" }++ it_behaves_like 'returns 200 HTTP status'++ it 'returns page attributes and relationships' do+ expect(json_response['data']['id']).to eq(page.id.to_s)+ expect(json_response['data']['attributes']['title']).to eq page.title++ expect(json_response['included']).to include(have_type('taxon').and(have_id(taxon.id.to_s)))+ expect(json_response['included']).to include(have_type('cms_section').and(have_id(page_item.id.to_s).and(have_relationship(:linked_resource))))+ end+ end++ context 'with valid slug' do+ let!(:page) { create(:cms_standard_page, store: store) }++ before { get "/api/v2/storefront/cms_pages/#{page.slug}" }++ it_behaves_like 'returns 200 HTTP status'+ end++ context 'with page from different store' do+ let!(:page) { create(:cms_standard_page, store: create(:store)) }++ before { get "/api/v2/storefront/cms_pages/#{page.id}" }++ it_behaves_like 'returns 404 HTTP status'+ end++ context 'with non-existing page ID' do+ before { get '/api/v2/storefront/cms_pages/0' }++ it_behaves_like 'returns 404 HTTP status'+ end+ end+enddiff --git a/core/app/finders/spree/cms_pages/find.rb b/core/app/finders/spree/cms_pages/find.rbindex 8094047bb9..9446c0ea8a 100644--- a/core/app/finders/spree/cms_pages/find.rb+++ b/core/app/finders/spree/cms_pages/find.rb@@ -1,24 +1,41 @@module Spree- module CmsPage+ module CmsPagesclass Find < ::Spree::BaseFinder+ ALLOWED_KINDS = %w[standard home feature].freeze+def initialize(scope:, params:)@scope = scope- @title = params.dig(:filter, :title)+ @title = params.dig(:filter, :title)+ @kind = params.dig(:filter, :type)enddef execute- pages = by_title(pages)+ pages = by_title(scope)+ pages = by_kind(pages)pagesend+ private++ attr_reader :scope, :title, :kind+def title_matcherSpree::CmsPage.arel_table[:title].matches("%#{title}%")enddef by_title(pages)+ return pages if title.blank?+pages.where(title_matcher)end++ def by_kind(pages)+ return pages if kind.blank?+ return pages if ALLOWED_KINDS.exclude?(kind)++ pages.send(kind)+ endendendenddiff --git a/core/app/models/spree/app_dependencies.rb b/core/app/models/spree/app_dependencies.rbindex 3a3d73871f..79fee44393 100644--- a/core/app/models/spree/app_dependencies.rb+++ b/core/app/models/spree/app_dependencies.rb@@ -74,7 +74,7 @@ module Spreedef set_default_finders@address_finder = 'Spree::Addresses::Find'@country_finder = 'Spree::Countries::Find'- @cms_page_finder_finder = 'Spree::CmsPage::Find'+ @cms_page_finder = 'Spree::CmsPages::Find'@menu_finder = 'Spree::Menus::Find'@current_order_finder = 'Spree::Orders::FindCurrent'@current_store_finder = 'Spree::Stores::FindCurrent'diff --git a/core/app/models/spree/cms_page.rb b/core/app/models/spree/cms_page.rbindex 8504164e0a..cc3811a74d 100644--- a/core/app/models/spree/cms_page.rb+++ b/core/app/models/spree/cms_page.rb@@ -22,7 +22,10 @@ module Spreescope :visible, -> { where(visible: true) }scope :by_locale, ->(locale) { where(locale: locale) }scope :by_slug, ->(slug) { where(slug: slug) }- scope :linkable, -> { where.not(slug: nil, type: 'Spree::Cms::Pages::Homepage') }++ scope :home, -> { where(type: 'Spree::Cms::Pages::Homepage') }+ scope :standard, -> { where(type: 'Spree::Cms::Pages::StandardPage') }+ scope :feature, -> { where(type: 'Spree::Cms::Pages::FeaturePage') }self.whitelisted_ransackable_attributes = %w[title type locale store_id]diff --git a/core/app/models/spree/cms_section.rb b/core/app/models/spree/cms_section.rbindex 7a174bec10..9dafbbea70 100644--- a/core/app/models/spree/cms_section.rb+++ b/core/app/models/spree/cms_section.rb@@ -1,6 +1,6 @@module Spree- class CmsSection < Spree::Base- include Spree::DisplayLink+ class CmsSection < Base+ include DisplayLinkacts_as_list scope: :cms_pagebelongs_to :cms_page, touch: truediff --git a/core/spec/models/spree/cms_page_spec.rb b/core/spec/models/spree/cms_page_spec.rbindex 3d429b32e2..05d4a9311f 100644--- a/core/spec/models/spree/cms_page_spec.rb+++ b/core/spec/models/spree/cms_page_spec.rb@@ -100,7 +100,7 @@ describe Spree::CmsPage, type: :model doendend- describe 'by_locale' do+ describe '.by_locale' dolet!(:homepage_en) { create(:cms_homepage, store: store_a, locale: 'en') }let!(:homepage_de) { create(:cms_homepage, store: store_a, locale: 'de') }@@ -111,7 +111,7 @@ describe Spree::CmsPage, type: :model doendend- describe 'by_slug' do+ describe '.by_slug' dolet!(:standard_page_slug_a) { create(:cms_standard_page, store: store_a, title: 'Little Page') }let!(:standard_page_slug_b) { create(:cms_standard_page, store: store_a, title: 'Big Page') }@@ -122,19 +122,6 @@ describe Spree::CmsPage, type: :model doendend- describe 'linkable' do- let!(:homepage_not_linkable) { create(:cms_homepage, store: store_a, title: 'homepage-a') }- let!(:feature_page_linkable) { create(:cms_feature_page, title: 'This New Product', store: store_a) }- let!(:standard_page_linkable) { create(:cms_standard_page, store: store_a, title: 'Big Page') }-- it 'returns standard_page_slug_a for the requested locale' do- result_feature_page_linkable = described_class.find(feature_page_linkable.id)- result_standard_page_linkable = described_class.find(standard_page_linkable.id)-- expect(described_class.linkable).to eq([result_feature_page_linkable, result_standard_page_linkable])- end- end-describe '#seo_title' dolet!(:homepage_title) { create(:cms_homepage, store: store_a, title: 'This Is My Homepage Title') }