Merge pull request #160 from joyofrails/feat/subscribers

Add newsletter subscriptions from scratch

Author: rossta

Gemfile

@@ -35,6 +35,7 @@ gem "rouge", group: [:default, :wasm] # Pure Ruby syntaix highlighter [https://g
 gem "sitepress-rails", group: [:default, :wasm] # Static site generator for Rails [https://sitepress.cc/getting-started/rails]
 gem "phlex-rails", group: [:default, :wasm] # An object-oriented alternative to ActionView for Ruby on Rails. [https://github.com/phlex-ruby/phlex-rails]
 gem "commonmarker", require: false
+gem "invisible_captcha", group: [:default, :wasm] # Unobtrusive and flexible spam protection for Rails apps [https://github.com/markets/invisible_captcha]
 
 gem "bootsnap", require: false # Reduces boot times through caching; required in config/boot.rb [https://github.com/Shopify/bootsnap]
 

Gemfile.lock

@@ -237,6 +237,8 @@ GEM
     inline_svg (1.9.0)
       activesupport (>= 3.0)
       nokogiri (>= 1.6)
+    invisible_captcha (2.3.0)
+      rails (>= 5.2)
     io-console (0.7.2)
     irb (1.13.1)
       rdoc (>= 4.0.0)
@@ -562,6 +564,7 @@ DEPENDENCIES
   fog-aws
   honeybadger
   inline_svg
+  invisible_captcha
   js
   letter_opener
   litestream

app/content/layouts/article.html.erb

@@ -24,6 +24,6 @@
     </div>
   </article>
   <section>
-    <%= render "newsletter/banner" %>
+    <%= render "users/newsletter_subscriptions/banner" %>
   </section>
 <% end %>

app/content/pages/index.html.erb

@@ -9,4 +9,6 @@ title: Joy of Rails
     <% end %>
   </div>
 </section>
-<section><%= render "newsletter/banner" %></section>
+<section>
+  <%= render "users/newsletter_subscriptions/banner" %>
+</section>

app/controllers/application_controller.rb

@@ -1,3 +1,4 @@
 class ApplicationController < ActionController::Base
+  include Erroring
   include Authentication
 end

app/controllers/concerns/authentication.rb

@@ -21,6 +21,10 @@ def authenticate_user!
     redirect_to new_users_session_path, alert: "You need to sign in to access that page" unless user_signed_in?
   end
 
+  def authenticate_user_or_not_found!
+    user_signed_in? || not_found!
+  end
+
   def redirect_admin_if_authenticated
     redirect_to admin_root_path, alert: "You are already logged in." if admin_user_signed_in?
   end

app/controllers/concerns/erroring.rb

@@ -0,0 +1,5 @@
+module Erroring
+  def not_found!
+    raise ActionController::RoutingError, "Not Found"
+  end
+end

app/controllers/users/newsletter_subscriptions_controller.rb

@@ -0,0 +1,93 @@
+class Users::NewsletterSubscriptionsController < ApplicationController
+  invisible_captcha only: [:create]
+
+  before_action :authenticate_user_or_not_found!, only: [:index, :subscribe]
+  before_action :authenticate_user!, only: [:subscribe]
+  before_action :redirect_if_authenticated, only: [:create]
+
+  def index
+    @newsletter_subscription = current_user.newsletter_subscription || current_user.build_newsletter_subscription
+
+    render Users::NewsletterSubscriptions::ShowView.new(newsletter_subscription: @newsletter_subscription, show_unsubscribe: true)
+  end
+
+  def show
+    @newsletter_subscription = NewsletterSubscription.find(params[:id]) or raise ActiveRecord::RecordNotFound
+
+    render Users::NewsletterSubscriptions::ShowView.new(newsletter_subscription: @newsletter_subscription, show_unsubscribe: false)
+  end
+
+  def new
+    user = current_user || User.new
+    @newsletter_subscription = user.newsletter_subscription || user.build_newsletter_subscription
+
+    render Users::NewsletterSubscriptions::NewView.new(newsletter_subscription: @newsletter_subscription)
+  end
+
+  def create
+    create_user_params = params.require(:user).permit(:email)
+    @user = User.find_or_initialize_by(email: create_user_params[:email]) do |u|
+      u.subscribing = true
+    end
+
+    @newsletter_subscription = @user.newsletter_subscription || @user.build_newsletter_subscription
+
+    @user.save
+
+    if @user.errors.any?
+      return render Users::NewsletterSubscriptions::NewView.new(newsletter_subscription: @newsletter_subscription), status: :unprocessable_entity
+    end
+
+    if @user.needs_confirmation?
+      EmailConfirmationNotifier.deliver_to(@user)
+    else
+      # TODO: Send already subscribed email
+    end
+
+    redirect_to users_newsletter_subscription_path(@newsletter_subscription)
+  end
+
+  def subscribe
+    if !current_user.subscribed_to_newsletter?
+      current_user.create_newsletter_subscription
+    end
+
+    @newsletter_subscription = current_user.newsletter_subscription
+
+    if current_user.needs_confirmation?
+      EmailConfirmationNotifier.deliver_to(current_user)
+    end
+
+    respond_to do |format|
+      format.html { redirect_to root_path, notice: "Success!" }
+      format.turbo_stream { redirect_to users_newsletter_subscription_path(@newsletter_subscription) }
+    end
+  end
+
+  def unsubscribe
+    if params[:token]
+      subscription = NewsletterSubscription.find_by_token_for(:unsubscribe, params[:token]) or raise ActiveRecord::RecordNotFound
+      subscription.destroy
+    elsif current_user
+      # Even though we model the subscription as a has_one, we should destroy
+      # all because has_one is not enforced as a constraint
+      NewsletterSubscription.where(subscriber: current_user).destroy_all
+    else
+      not_found!
+    end
+
+    if request.post? && params["List-Unsubscribe"] == "One-Click"
+      # must not redirect according to RFC 8058
+      # could render show action instead
+      render plain: "You have been unsubscribed", status: :ok
+    else
+      respond_to do |format|
+        format.html { redirect_to root_path, notice: "You have been unsubscribed" }
+        format.turbo_stream {
+          redirect_path = current_user ? users_newsletter_subscriptions_path : new_users_newsletter_subscription_path
+          redirect_to redirect_path
+        }
+      end
+    end
+  end
+end

app/controllers/users/registrations_controller.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class Users::RegistrationsController < ApplicationController
+  invisible_captcha only: [:create]
+
   before_action :feature_enabled!
   before_action :redirect_if_authenticated, only: [:create, :new]
   before_action :authenticate_user!, only: [:edit, :update, :destroy]

app/javascript/css/application.css

@@ -5,6 +5,7 @@
 @import './config/colors-tailwind.css' layer(theme);
 @import './config/colors-uicolors.css' layer(theme);
 @import './config/colors.css' layer(theme);
+@import './config/dracula.css' layer(theme);
 @import './config/theme.css' layer(theme);
 @import './config/settings.css' layer(theme);
 @import './baseline.css' layer(theme);
@@ -15,9 +16,9 @@
 @import './config/grid.css' layer(layout);
 @import './layout.scss' layer(layout);
 
-@import './utilities/tailwind.css';
-@import './utilities/tailwind-media.scss';
-@import './utilities/custom.css';
+@import './utilities/tailwind.css' layer(utilities);
+@import './utilities/tailwind-media.scss' layer(utilities);
+@import './utilities/custom.css' layer(utilities);
 
 @import './components/logo.css';
 @import './components/button.css';
@@ -30,3 +31,4 @@
 @import './components/footer-content.css';
 @import './components/newsletter-banner.css';
 @import './components/anchors.scss';
+@import './components/callout.css';