Merge pull request #1744 from basecamp/open-source-split+signups

Allow signups in the OSS, offer hooks for the SaaS counterpart

Author: jorgemanrubia

Gemfile.saas.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/basecamp/fizzy-saas
-  revision: 40f68d8604a1b410ba514f5793a93e9b11c00219
+  revision: f251028405bd0ba586fe836d1a8c56428b8abff0
   specs:
     fizzy-saas (0.1.0)
       queenbee

README.md

@@ -2,7 +2,7 @@
 
 ## Setting up for development
 
-First get everything installed and configured with:
+First, get everything installed and configured with:
 
     bin/setup
 

app/controllers/application_controller.rb

@@ -4,7 +4,6 @@ class ApplicationController < ActionController::Base
   include CurrentRequest, CurrentTimezone, SetPlatform
   include RequestForgeryProtection
   include TurboFlash, ViewTransitions
-  include Saas
   include RoutingHeaders
 
   etag { "v1" }

app/controllers/concerns/saas.rb

@@ -19,13 +19,9 @@ def new
 
   def create
     if identity = Identity.find_by_email_address(email_address)
-      magic_link = identity.send_magic_link
-      flash[:magic_link_code] = magic_link&.code if Rails.env.development?
-      redirect_to session_magic_link_path
-    elsif signups_allowed?
-      Signup.new(email_address: email_address).create_identity
-      session[:return_to_after_authenticating] = saas.new_signup_completion_path
-      redirect_to session_magic_link_path
+      handle_existing_user(identity)
+    elsif
+      handle_new_signup
     end
   end
 
@@ -38,4 +34,16 @@ def destroy
     def email_address
       params.expect(:email_address)
     end
+
+    def handle_existing_user(identity)
+      magic_link = identity.send_magic_link
+      flash[:magic_link_code] = magic_link&.code if Rails.env.development?
+      redirect_to session_magic_link_path
+    end
+
+    def handle_new_signup
+      Signup.new(email_address: email_address).create_identity
+      session[:return_to_after_authenticating] = new_signup_completion_path
+      redirect_to session_magic_link_path
+    end
 end

app/controllers/sessions_controller.rb

@@ -0,0 +1,24 @@
+class Signup::CompletionsController < ApplicationController
+  layout "public"
+
+  disallow_account_scope
+
+  def new
+    @signup = Signup.new(identity: Current.identity)
+  end
+
+  def create
+    @signup = Signup.new(signup_params)
+
+    if @signup.complete
+      redirect_to landing_url(script_name: @signup.account.slug)
+    else
+      render :new, status: :unprocessable_entity
+    end
+  end
+
+  private
+    def signup_params
+      params.expect(signup: %i[ full_name ]).with_defaults(identity: Current.identity)
+    end
+end

app/controllers/signup/completions_controller.rb

@@ -11,6 +11,7 @@ class Account < ApplicationRecord
 
   has_many_attached :uploads
 
+  before_create :assign_external_account_id
   after_create :create_join_code
 
   validates :name, presence: true
@@ -35,4 +36,9 @@ def account
   def system_user
     users.where(role: :system).first!
   end
+
+  private
+    def assign_external_account_id
+      self.external_account_id ||= ExternalIdSequence.next
+    end
 end

app/models/account.rb

@@ -0,0 +1,26 @@
+# Provides sequential IDs for +external_account_id+ when creating accounts without one.
+class Account::ExternalIdSequence < ApplicationRecord
+  class << self
+    def next
+      with_lock do |sequence|
+        sequence.increment!(:value).value
+      end
+    end
+
+    def value
+      first&.value
+    end
+
+    private
+      def with_lock
+        transaction do
+          sequence = lock.first_or_create!(value: initial_value)
+          yield sequence
+        end
+      end
+
+      def initial_value
+        Account.maximum(:external_account_id) || 0
+      end
+  end
+end

app/models/account/external_id_sequence.rb

@@ -0,0 +1,100 @@
+class Signup
+  include ActiveModel::Model
+  include ActiveModel::Attributes
+  include ActiveModel::Validations
+
+  attr_accessor :full_name, :email_address, :identity
+  attr_reader :account, :user
+
+  with_options on: :completion do
+    validates_presence_of :full_name, :identity
+  end
+
+  def initialize(...)
+    super
+
+    @email_address = @identity.email_address if @identity
+  end
+
+  def create_identity
+    @identity = Identity.find_or_create_by!(email_address: email_address)
+    @identity.send_magic_link
+  end
+
+  def complete
+    if valid?(:completion)
+      begin
+        @tenant = create_tenant
+        create_account
+        true
+      rescue => error
+        destroy_account
+        handle_account_creation_error(error)
+
+        errors.add(:base, "Something went wrong, and we couldn't create your account. Please give it another try.")
+        Rails.error.report(error, severity: :error)
+        Rails.logger.error error
+        Rails.logger.error error.backtrace.join("\n")
+
+        false
+      end
+    else
+      false
+    end
+  end
+
+  private
+    # Override to customize the handling of external accounts associated to the account.
+    def create_tenant
+      nil
+    end
+
+    # Override to inject custom handling for account creation errors
+    def handle_account_creation_error(error)
+    end
+
+    def create_account
+      @account = Account.create_with_admin_user(
+        account: {
+          external_account_id: @tenant,
+          name: generate_account_name
+        },
+        owner: {
+          name: full_name,
+          identity: identity
+        }
+      )
+      @user = @account.users.find_by!(role: :admin)
+      @account.setup_customer_template
+    end
+
+    def generate_account_name
+      AccountNameGenerator.new(identity: identity, name: full_name).generate
+    end
+
+
+    def destroy_account
+      @account&.destroy!
+
+      @user = nil
+      @account = nil
+      @tenant = nil
+    end
+
+    def subscription_attributes
+      subscription = FreeV1Subscription
+
+      {}.tap do |attributes|
+        attributes[:name]  = subscription.to_param
+        attributes[:price] = subscription.price
+      end
+    end
+
+    def request_attributes
+      {}.tap do |attributes|
+        attributes[:remote_address] = Current.ip_address
+        attributes[:user_agent]     = Current.user_agent
+        attributes[:referrer]       = Current.referrer
+      end
+    end
+end

app/models/signup.rb

@@ -0,0 +1,53 @@
+class Signup::AccountNameGenerator
+  SUFFIX = "Fizzy".freeze
+
+  attr_reader :identity, :name
+
+  def initialize(identity:, name:)
+    @identity = identity
+    @name = name
+  end
+
+  def generate
+    next_index = current_index + 1
+
+    if next_index == 1
+      "#{prefix} #{SUFFIX}"
+    else
+      "#{prefix} #{next_index.ordinalize} #{SUFFIX}"
+    end
+  end
+
+  private
+    def current_index
+      existing_indices.max || 0
+    end
+
+    def existing_indices
+      Current.without_account do
+        identity.accounts.filter_map do |account|
+          if account.name.match?(first_account_name_regex)
+            1
+          elsif match = account.name.match(nth_account_name_regex)
+            match[1].to_i
+          end
+        end
+      end
+    end
+
+    def first_account_name_regex
+      @first_account_name_regex ||= /\A#{prefix}\s+#{SUFFIX}\Z/i
+    end
+
+    def nth_account_name_regex
+      @nth_account_name_regex ||= /\A#{prefix}\s+(1st|2nd|3rd|\d+th)\s+#{SUFFIX}/i
+    end
+
+    def prefix
+      @prefix ||= "#{first_name}'s"
+    end
+
+    def first_name
+      name.strip.split(" ", 2).first
+    end
+end