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
Storefront: fixed newsletter subscribe endpoint plus added event trac… (#12440)
Damian Legawiec8a9ed4886338
diff --git a/core/lib/spree/core/engine.rb b/core/lib/spree/core/engine.rbindex e14d4ccd4b..ef0dbab8e7 100644--- a/core/lib/spree/core/engine.rb+++ b/core/lib/spree/core/engine.rb@@ -243,6 +243,8 @@ module Spreeproduct_added_to_wishlist: 'Product Added to Wishlist',product_removed_from_wishlist: 'Product Removed from Wishlist',+ subscribed_to_newsletter: 'Subscribed to Newsletter',+payment_info_entered: 'Payment Info Entered',coupon_entered: 'Coupon Entered',coupon_removed: 'Coupon Removed',diff --git a/core/lib/spree/testing_support/factories/page_section_factory.rb b/core/lib/spree/testing_support/factories/page_section_factory.rbindex 11ed5ef0a7..430cfda120 100644--- a/core/lib/spree/testing_support/factories/page_section_factory.rb+++ b/core/lib/spree/testing_support/factories/page_section_factory.rb@@ -16,5 +16,7 @@ FactoryBot.define dofactory :announcement_bar_page_section, class: Spree::PageSections::AnnouncementBarfactory :rich_text_page_section, class: Spree::PageSections::RichText++ factory :newsletter_page_section, class: Spree::PageSections::Newsletterendenddiff --git a/storefront/app/controllers/spree/newsletter_subscribers_controller.rb b/storefront/app/controllers/spree/newsletter_subscribers_controller.rbnew file mode 100644index 0000000000..010738444a--- /dev/null+++ b/storefront/app/controllers/spree/newsletter_subscribers_controller.rb@@ -0,0 +1,43 @@+module Spree+ class NewsletterSubscribersController < StoreController+ skip_before_action :redirect_to_password+ before_action :load_newsletter_section, only: :create++ # POST /newsletter_subscribers+ def create+ user = Spree.user_class.find_or_initialize_by(email: newsletter_params[:email])++ if user.new_record? && user.respond_to?(:password) && user.respond_to?(:password_confirmation)+ user.password ||= SecureRandom.hex(16) # we need to set a password to pass validation+ user.password_confirmation ||= user.password+ end++ user.accepts_email_marketing = true if user.new_record? || try_spree_current_user == user++ if user.save+ track_event('subscribed_to_newsletter', { email: user.email, user: user })++ flash[:success] = Spree.t('storefront.newsletter_subscribers.success')+ else+ flash[:error] = user.errors.full_messages.to_sentence.presence || Spree.t('something_went_wrong')+ end++ respond_to do |format|+ format.html { redirect_to spree.root_path }+ format.turbo_stream+ end+ end++ private++ def newsletter_params+ params.require(:newsletter).permit(:email)+ end++ def load_newsletter_section+ return if params[:section_id].blank?++ @newsletter_section = Spree::PageSections::Newsletter.find_by(id: params[:section_id])+ end+ end+enddiff --git a/storefront/app/views/spree/subscribers/create.turbo_stream.erb b/storefront/app/views/spree/newsletter_subscribers/create.turbo_stream.erbsimilarity index 100%rename from storefront/app/views/spree/subscribers/create.turbo_stream.erbrename to storefront/app/views/spree/newsletter_subscribers/create.turbo_stream.erbdiff --git a/storefront/app/views/spree/subscribers/confirm.turbo_stream.erb b/storefront/app/views/spree/subscribers/confirm.turbo_stream.erbdeleted file mode 100644index 244ff2203d..0000000000--- a/storefront/app/views/spree/subscribers/confirm.turbo_stream.erb+++ /dev/null@@ -1 +0,0 @@-<%= spree_turbo_update_flashes %>diff --git a/storefront/app/views/themes/default/spree/page_sections/_newsletter.html.erb b/storefront/app/views/themes/default/spree/page_sections/_newsletter.html.erbindex 1a8371eeaf..38f911cbbb 100644--- a/storefront/app/views/themes/default/spree/page_sections/_newsletter.html.erb+++ b/storefront/app/views/themes/default/spree/page_sections/_newsletter.html.erb@@ -19,16 +19,17 @@<%= block.text.body %></div><% when 'Spree::PageBlocks::NewsletterForm' %>- <form action="<%= subscribers_path %>" method="post" class="flex items-center flex-col md:flex-row w-full <%= block_css_classes(block) %>" <%= block_attributes(block) %>>- <div class='relative w-full lg:w-[424px] flex'>- <%= hidden_field_tag :section_id, section.id %>- <%= email_field_tag 'newsletter[email]', nil, placeholder: block.preferred_placeholder, required: true, class: 'focus:border-primary focus:ring-primary pr-36 text-sm bg-accent rounded-input border-accent py-2 px-4 w-full relative z-30 !leading-[46px]' %>- <div class="absolute right-2 top-1/2 transform -translate-y-1/2 z-40">- <button type='submit' class='<%= block.preferred_button_style == 'secondary' ? 'btn-secondary' : 'btn-primary' %> content-center'>- <%= block.preferred_button_text.html_safe %>- </button>+ <%= form_for :newsletter, url: spree.newsletter_subscribers_path do |f| %>+ <div class="flex items-center flex-col md:flex-row w-full <%= block_css_classes(block) %>" <%= block_attributes(block) %>>+ <div class='relative w-full lg:w-[424px] flex'>+ <%= hidden_field_tag :section_id, section.id %>+ <%= f.email_field :email, placeholder: block.preferred_placeholder, required: true, class: 'focus:border-primary focus:ring-primary pr-36 text-sm bg-accent rounded-input border-accent py-2 px-4 w-full relative z-30 !leading-[46px]' %>+ <div class="absolute right-2 top-1/2 transform -translate-y-1/2 z-40">+ <%= f.submit block.preferred_button_text.html_safe, class: "#{block.preferred_button_style == 'secondary' ? 'btn-secondary' : 'btn-primary'} content-center" %>+ </div></div></div>+ <% end %><% when 'Spree::PageBlocks::Subheading' %><h3 class='<%= block.size == 'small' ? 'text-lg' : block.size == 'medium' ? 'text-xl' : 'text-xl' %>' <%= block_attributes(block) %>><%= block.text.body %>diff --git a/storefront/config/locales/en.yml b/storefront/config/locales/en.ymlindex 0ab1df578e..b18220efff 100644--- a/storefront/config/locales/en.yml+++ b/storefront/config/locales/en.yml@@ -43,6 +43,8 @@ en:customer_support_email_not_configured: Customer support email is not configuredmessage_not_sent: Unfortunately we weren't able to send the email at this time. Please try again latermessage_sent: Message sent!+ newsletter_subscribers:+ success: Thank you for subscribing to our newsletter!newsletter_subscription:description: Take control of your settings and tailor your experience according to your preferences. Customize your notifications to suit your needs.join: Email me about new products, sales, and more. You can unsubscribe at any time.diff --git a/storefront/config/routes.rb b/storefront/config/routes.rbindex 61453548bb..37cd721ff5 100644--- a/storefront/config/routes.rb+++ b/storefront/config/routes.rb@@ -74,11 +74,7 @@ Spree::Core::Engine.add_routes doresource :settings, only: [:update, :show]# Newsletter- resources :subscribers, only: [:create] do- member do- get :confirm- end- end+ resources :newsletter_subscribers, only: [:create]# Contact formresources :contacts, only: [:new, :create]diff --git a/storefront/spec/controllers/spree/newsletter_subscribers_controller_spec.rb b/storefront/spec/controllers/spree/newsletter_subscribers_controller_spec.rbnew file mode 100644index 0000000000..4abc02ed7b--- /dev/null+++ b/storefront/spec/controllers/spree/newsletter_subscribers_controller_spec.rb@@ -0,0 +1,74 @@+require 'spec_helper'++RSpec.describe Spree::NewsletterSubscribersController, type: :controller do+ render_views++ let(:store) { Spree::Store.default }++ before do+ allow(controller).to receive(:current_store).and_return(create(:store))+ end++ describe 'POST #create' do+ let(:newsletter_params) { { newsletter: { email: '[email protected]' } } }+ let(:user) { create(:user) }++ context 'with valid params' do+ it 'creates a new newsletter subscription' do+ expect {+ post :create, params: newsletter_params+ }.to change { Spree.user_class.where(accepts_email_marketing: true).count }.by(1)+ end++ it 'sets success flash message' do+ post :create, params: newsletter_params+ expect(flash[:success]).to eq Spree.t('storefront.newsletter_subscribers.success')+ end++ it 'redirects to root path for html format' do+ post :create, params: newsletter_params+ expect(response).to redirect_to spree.root_path+ end++ it 'renders turbo stream template for turbo_stream format' do+ post :create, params: newsletter_params, format: :turbo_stream+ expect(response).to have_http_status(:success)+ expect(response.media_type).to eq Mime[:turbo_stream]+ end+ end++ context 'with existing user (when signed in as that user)' do+ before do+ allow(controller).to receive(:try_spree_current_user).and_return(user)+ user.update(email: '[email protected]', accepts_email_marketing: false)+ end++ it 'updates accepts_email_marketing for existing user' do+ post :create, params: newsletter_params+ expect(user.reload.accepts_email_marketing).to be true+ end+ end++ context 'with newsletter section' do+ let!(:newsletter_section) { create(:newsletter_page_section) }++ it 'loads newsletter section when section_id provided' do+ post :create, params: newsletter_params.merge(section_id: newsletter_section.id)+ expect(assigns(:newsletter_section)).to eq newsletter_section+ end+ end++ context 'with invalid params' do+ let(:invalid_params) { { newsletter: { email: 'invalid_email' } } }++ before do+ allow_any_instance_of(Spree.user_class).to receive(:save).and_return(false)+ end++ it 'sets error flash message' do+ post :create, params: invalid_params+ expect(flash[:error]).to be_present+ end+ end+ end+end