Add GuestAccess subtype of PlatformInvitation

Allows for time-bound short-term access to platform without ability to register account

Author: rsmithlal

app/controllers/better_together/application_controller.rb

@@ -26,7 +26,7 @@ class ApplicationController < ActionController::Base # rubocop:todo Metrics/Clas
     rescue_from Pundit::NotAuthorizedError, with: :user_not_authorized
     rescue_from StandardError, with: :handle_error
 
-    helper_method :default_url_options, :valid_platform_invitation_token_present?
+    helper_method :current_invitation, :default_url_options, :valid_platform_invitation_token_present?
 
     def self.default_url_options
       super.merge(locale: I18n.locale)
@@ -72,29 +72,33 @@ def set_platform_invitation # rubocop:todo Metrics/CyclomaticComplexity, Metrics
         return
       end
 
-      if params[:invitation_code].present?
-        # On first visit with the invitation code, update the session with the token and a new expiry.
-        token = params[:invitation_code]
-        session[:platform_invitation_token] = token
-        session[:platform_invitation_expires_at] ||= Time.current + platform_invitation_expiry_time
-      else
-        # If no params, simply use the token stored in the session.
-        token = session[:platform_invitation_token]
-      end
+      token = if params[:invitation_code].present?
+                # On first visit with the invitation code, update the session with the token and a new expiry.
+                session[:platform_invitation_token] = params[:invitation_code]
+              else
+                # If no params, simply use the token stored in the session.
+                session[:platform_invitation_token]
+              end
 
       return unless token.present?
 
       @platform_invitation = ::BetterTogether::PlatformInvitation.pending.find_by(token: token)
 
-      return if @platform_invitation
-
-      session.delete(:platform_invitation_token)
-      session.delete(:platform_invitation_expires_at)
+      if @platform_invitation
+        session[:platform_invitation_expires_at] ||= Time.current + @platform_invitation.session_duration_mins.minutes
+      else
+        session.delete(:platform_invitation_token)
+        session.delete(:platform_invitation_expires_at)
+      end
     end
     # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/MethodLength
     # rubocop:enable Metrics/PerceivedComplexity
 
+    def current_invitation
+      @platform_invitation
+    end
+
     def check_platform_privacy
       return if helpers.host_platform.privacy_public?
       return if current_user

app/controllers/better_together/platform_invitations_controller.rb

@@ -113,7 +113,10 @@ def set_platform_invitation
     end
 
     def platform_invitation_params
-      params.require(:platform_invitation).permit(:invitee_email, :platform_role_id, :community_role_id, :locale)
+      params.require(:platform_invitation).permit(
+        :invitee_email, :platform_role_id, :community_role_id, :locale,
+        :valid_from, :valid_until, :greeting, :type, :session_duration_mins
+      )
     end
   end
 end

app/controllers/better_together/platforms_controller.rb

@@ -6,6 +6,11 @@ class PlatformsController < FriendlyResourceController # rubocop:todo Style/Docu
     before_action :authorize_platform, only: %i[show edit update destroy]
     after_action :verify_authorized, except: :index
 
+    before_action only: %i[show], if: -> { Rails.env.development? } do
+      # Make sure that all Platform Invitation subclasses are loaded in dev to generate new block buttons
+      ::BetterTogether::PlatformInvitation.load_all_subclasses
+    end
+
     # GET /platforms
     def index
       # @platforms = ::BetterTogether::Platform.all

app/helpers/better_together/form_helper.rb

@@ -99,26 +99,39 @@ def required_label(form_or_object, field, **options) # rubocop:todo Metrics/AbcS
     # rubocop:enable Metrics/MethodLength
 
     # rubocop:todo Metrics/MethodLength
-    def type_select_field(form:, model_class:, selected_type: nil, include_blank: true, **options)
+    # rubocop:todo Metrics/PerceivedComplexity
+    # rubocop:todo Metrics/AbcSize
+    # rubocop:todo Metrics/ParameterLists
+    def type_select_field(form:, model_class:, selected_type: nil, include_model_class: false, include_blank: true,
+                          **options)
+      # rubocop:enable Metrics/ParameterLists
       # Determine if the model is persisted
       disabled = form&.object&.persisted? || false
 
       options = {
-        **options,
         required: true,
         class: 'form-select',
-        disabled: # Disable if the model is persisted
+        disabled:, # Disable if the model is persisted
+        **options
       }
 
       descendants = model_class.descendants.map { |descendant| [descendant.model_name.human, descendant.name] }
 
+      dropdown_values = if include_model_class
+                          [[model_class.model_name.human, model_class.name]] + descendants
+                        else
+                          descendants
+                        end
+
       if form
-        form.select :type, options_for_select(descendants, form.object.type), { include_blank: }, options
+        form.select :type, options_for_select(dropdown_values, form.object.type), { include_blank: }, options
       else
-        select_tag 'type', options_for_select(descendants, selected_type),
+        select_tag 'type', options_for_select(dropdown_values, selected_type),
                    { include_blank: }.merge(options)
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/PerceivedComplexity
     # rubocop:enable Metrics/MethodLength
   end
 end

app/mailers/better_together/platform_invitation_mailer.rb

@@ -5,18 +5,21 @@
 module BetterTogether
   # Sends the email to the recipient to accept or decline their invitation to the platform
   class PlatformInvitationMailer < ApplicationMailer
-    def invite(platform_invitation)
+    def invite(platform_invitation) # rubocop:todo Metrics/MethodLength
       @platform_invitation = platform_invitation
       @platform = platform_invitation.invitable
 
       # Override time zone and locale if necessary
       self.locale = platform_invitation.locale
 
       @invitee_email = @platform_invitation.invitee_email
+      return if @invitee_email.blank?
+
+      @greeting = @platform_invitation.greeting
       @valid_from = @platform_invitation.valid_from
       @valid_until = @platform_invitation.valid_until
 
-      @invitation_url = better_together.new_user_registration_url(invitation_code: @platform_invitation.token)
+      @invitation_url = @platform_invitation.url
 
       mail(to: @invitee_email,
            subject: I18n.t('better_together.platform_invitation_mailer.invite.subject',

app/models/better_together/guest_access.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module BetterTogether
+  # Allows for platform managers to allow guest access to the platform
+  class GuestAccess < PlatformInvitation
+    def self.model_name
+      ActiveModel::Name.new(self)
+    end
+
+    def registers_user?
+      false
+    end
+
+    def url
+      BetterTogether::Engine.routes.url_helpers.home_page_url(invitation_code: token, locale:)
+    end
+  end
+end

app/models/better_together/platform_invitation.rb

@@ -30,7 +30,10 @@ class PlatformInvitation < ApplicationRecord
 
     enum status: STATUS_VALUES, _prefix: :status
 
-    validates :invitee_email, presence: true, uniqueness: { scope: :invitable_id }
+    has_rich_text :greeting, encrypted: true
+
+    validates :invitee_email, uniqueness: { scope: :invitable_id, allow_nil: true }
+    validates :invitee_email, uniqueness: { scope: :invitable_id, allow_nil: true, allow_blank: true }
     validates :locale, presence: true, inclusion: { in: I18n.available_locales.map(&:to_s) }
     validates :status, presence: true, inclusion: { in: STATUS_VALUES.values }
     validates :token, uniqueness: true
@@ -48,6 +51,10 @@ class PlatformInvitation < ApplicationRecord
 
     # TODO: add 'not expired' scope to find only invitations that are available
 
+    def self.load_all_subclasses
+      [self, GuestAccess].each(&:connection) # Add all known subclasses here
+    end
+
     def accept!(invitee:, save_record: true)
       self.invitee = invitee
       self.status = STATUS_VALUES[:accepted]
@@ -58,6 +65,23 @@ def expired?
       valid_until.present? && valid_until < Time.current
     end
 
+    def invitee_email=(email)
+      new_value = email&.strip&.downcase
+      super(new_value.present? ? new_value : nil)
+    end
+
+    def registers_user?
+      true
+    end
+
+    def url
+      BetterTogether::Engine.routes.url_helpers.new_user_registration_url(invitation_code: token)
+    end
+
+    def to_s
+      "[#{self.class.model_name.human}] - #{id}"
+    end
+
     private
 
     def set_accepted_timestamp
@@ -71,7 +95,7 @@ def queue_invitation_email
     end
 
     def should_send_email?
-      !email_recently_sent? && !throttled?
+      invitee_email.present? && !email_recently_sent? && !throttled?
     end
 
     def email_recently_sent?

app/policies/better_together/guest_access_policy.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BetterTogether
+  class GuestAccessPolicy < PlatformInvitationPolicy
+    class Scope < PlatformInvitationPolicy::Scope # rubocop:todo Style/Documentation
+      def resolve
+        scope.all
+      end
+    end
+  end
+end

app/policies/better_together/platform_invitation_policy.rb

@@ -3,15 +3,15 @@
 module BetterTogether
   class PlatformInvitationPolicy < ApplicationPolicy # rubocop:todo Style/Documentation
     def create?
-      user.present?
+      user.present? && permitted_to?('manage_platform')
     end
 
     def destroy?
-      user.present? && record.status_pending?
+      user.present? && record.status_pending? && permitted_to?('manage_platform')
     end
 
     def resend?
-      user.present? && record.status_pending?
+      user.present? && record.status_pending? && permitted_to?('manage_platform')
     end
 
     class Scope < Scope # rubocop:todo Style/Documentation

app/views/better_together/platform_invitation_mailer/invite.html.erb

@@ -4,6 +4,10 @@
 
 <p><%= t('.message', platform: @platform.name) %></p>
 
+<% if @greeting.present? %>
+  <%= @greeting %>
+<% end %>
+
 <p><%= link_to t('.link_text'), @invitation_url %></p>
 
 <p><%= t('.invitation_code', invitation_code: @platform_invitation.token) %></p>