mr_common 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e0885e32d5643b86e1da2fe11974a06eb9c5a327fd82bd7bebcf8d85484e8ef
-  data.tar.gz: 0e20a6e34659744854a5ed28eac632c92c4b5f7d969ad201d8fa31e31a21944a
+  metadata.gz: 54451845d3b9872d8263616b7cd840d794e9ec6c5ad523065e3a9706bb426e3e
+  data.tar.gz: '0564509763ef97f22dbec7798998ad2c7f590387413e8a3842a094cec50d551f'
 SHA512:
-  metadata.gz: a1070f2831e2216c89b387e6a1fa4c0c0e88519f2d01a0fd93af120cefeeabeed64fc40fe572fbf809c67610f93f86dcbf8936f288b9ced626dc6be1a22cd48e
-  data.tar.gz: 3af9a459afe31200e94a344ac87299f9b09bc3c6a2d2e30156e7ae61a21bcb3dc0ded109747ac462db7a34c87c3120841bdac00219f340e946c10ac7dc4deac7
+  metadata.gz: ca8b97d5a0d98de6fc4d0fb955367df3d4460bccb8e01be610b9763af7c954415c7d393c9e6e2d9846f8245a00c1d803ed22b1cee7e78196b00bdb64aa488ce6
+  data.tar.gz: 22e0354f7d4661a67529ecdc5fa26db58518c9f3c792183de385364596983c724377a99943f78fa8c181a1a819f76fc6287b20788e73c9eba7e8a9b2ee7af13c

data/README.md

@@ -4,6 +4,7 @@ Common utilities extracted from starter-reg-site for use elsewhere
 ## Features
 * Dashboard at the mount point that relies on the host app for authentication
 * [MrCommon::Registration](/doc/mr_common/registration.md) - default registration model and controller with csv export exposed via the dashboard
+* MrCommon::PreRegistration - whitelist firstname + lastname combos, or emails for automatic registration confirmation, requires `MrCommon.registration_confirmation_strategy == :pre_register`
 * [MrCommon::Reminder](/doc/mr_common/reminder.md) - model for generating downloadable ical reminders
 * MrCommon::Country - convenient wrapper around the Carmen gem
 * MrCommon::Pattern - a utility class for sharing common regex patterns
@@ -16,7 +17,7 @@ Add to Gemfile
 
 ```ruby
 # Gemfile
-gem 'mr_common', '~> 1'
+gem 'mr_common', '~> 2'
 ```
 
 Add to routes.rb
@@ -29,10 +30,13 @@ mount MrCommon::Engine, at: '/common'
 root to: "mr_common/registrations/public#new"
 ```
 
-Generate view overrides in the host project
+Copy model/controller/views into the host app for overriding/customizing.
 
 ```
+$ bin/rails g mr_common:models
 $ bin/rails g mr_common:views
+$ bin/rails g mr_common:mailers
+$ bin/rails g mr_common:controllers
 ```
 
 Configure an initializer if you need different values than the defaults listed here
@@ -46,19 +50,36 @@ MrCommon.current_user_authorization_method_name = :mr_common_admin?
 MrCommon.logout_path_helper = :destroy_user_session_path
 MrCommon.logout_path_method = :delete
 MrCommon.sign_in_path_helper = :new_user_session_path
-MrCommon.registration_success_notice = "Registration completed successfully."
-MrCommon.registration_failure_alert = "Registration could not be completed."
 MrCommon.host_app_layout = "application"
-MrCommon.registration_confirmation_subject = "Your registration confirmation."
-MrCommon.registration_reminder_slug = "reminder"
+
+# Alert/Notice strings
+MrCommon.registration_failure_alert = "Registration could not be completed."
+MrCommon.registration_success_notice = "Registration created successfully."
+
+# RegistrationMailer subjects
+MrCommon.registration_confirmed_subject = "Your registration is confirmed."
+MrCommon.registration_unconfirmed_subject = "Thanks for your interest."
+MrCommon.registration_revoked_subject = "Your registration is not confirmed."
+
+# Dashboard Title
+MrCommon.title = "Mreach Common Utils"
+
+# All Registrations will be automatically confirmed (default)
+# MrCommon.registration_confirmation_strategy = :auto
+
+# Registrations will be confirmed automatically if a PreRegistration is found
+# MrCommon.registration_confirmation_strategy = :pre_register
+  
+# An admin will need to log in and click the confirm button for each registration
+# MrCommon.registration_confirmation_strategy = :manual
 ```
 
 ## Development
 
 1. `gem install foreman mailcatcher`
-1. Clone
-1. Bundle Install
-1. Don't yarn. Engines have to use old school sprockets manifests
+1. clone
+1. bundle Install
+1. don't use yarn/npm, engines have to use old school sprockets manifests
 1. run `bin/rails run` to start the app + mailcatcher.
 
 ## License

data/app/controllers/mr_common/dashboard_controller.rb

@@ -2,6 +2,7 @@
 
 module MrCommon
   class DashboardController < BaseController
+    # The root of the admin dashboard
     def index
     end
   end

data/app/controllers/mr_common/pre_registrations/import_controller.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module MrCommon
+  module PreRegistrations
+    # Implements PreRegistration import for the admin panel. Expects the user to
+    # upload a CSV file with a header line and columns ordered like:
+    #   first_name, last_name, email
+    class ImportController < BaseController
+      def new
+      end
+
+      def create
+        csv = import_params[:csv_file]
+        importer = MrCommon::PreRegistrationImporter.new(csv.read)
+        result = importer.import
+        redirect_to new_pre_registrations_import_path, notice: "Imported #{result.created} and skipped #{result.skipped} duplicate or invalid entries."
+      end
+
+      def import_params
+        params.require(:import).permit(:csv_file)
+      end
+    end
+  end
+end

data/app/controllers/mr_common/pre_registrations/pre_registrations_controller.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module MrCommon
+  module PreRegistrations
+    class PreRegistrationsController < BaseController
+      def index
+        @pre_registration = PreRegistration.order(email: :asc)
+      end
+
+      def new
+        @pre_registration = PreRegistration.new
+      end
+
+      def create
+        @pre_registration = PreRegistration.new(pre_registration_params)
+
+        if @pre_registration.save
+          redirect_to pre_registrations_path, notice: "Pre-registration saved."
+        else
+          flash.now[:alert] = "There was a problem saving the pre-registration."
+          render :new, status: :unprocessable_entity
+        end
+      end
+
+      def destroy
+        @pre_registration = PreRegistration.find(params[:id])
+
+        if @pre_registration.destroy
+          redirect_to pre_registrations_path, notice: "Pre-registration deleted."
+        else
+          redirect_to pre_registrations_path, notice: "There was a problem deleting the pre-registration."
+        end
+      end
+
+      private
+
+        def pre_registration_params
+          params.require(
+            :confirmed_registration
+          ).permit(
+            :email,
+            :first_name,
+            :last_name
+          )
+        end
+    end
+  end
+end

data/app/controllers/mr_common/registrations/confirmations_controller.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module MrCommon
+  module Registrations
+    class ConfirmationsController < BaseController
+      # Confirm a registration.
+      def create
+        find_registration
+
+        if confirm_registration
+          send_notification
+          redirect_to @registration, notice: "Registration confirmed. Registrant will receive an email."
+        else
+          Rails.logger.debug(@registration.errors.full_messages)
+          redirect_to @registration, alert: "Unable to confirm registration"
+        end
+      end
+
+      # Revoke a registration's confirmation.
+      def destroy
+        find_registration
+
+        if unconfirm_registration
+          send_notification
+          redirect_to @registration, notice: "Confirmation revoked. Registrant will receive an email."
+        else
+          Rails.logger.debug(@registration.errors.full_messages)
+          redirect_to @registration, alert: "Unable to revoke confirmation"
+        end
+      end
+
+      private
+        def find_registration
+          @registration = MrCommon::Registration.find(params[:registration_id])
+        end
+
+        def confirm_registration
+          @registration.update(confirmed: true)
+        end
+
+        def unconfirm_registration
+          @registration.update(confirmed: false)
+        end
+
+        def send_notification
+          if @registration.confirmed?
+            RegistrationMailer.confirmed_registration(@registration.id).deliver_now
+          else
+            RegistrationMailer.revoked_registration(@registration.id).deliver_now
+          end
+        end
+    end
+  end
+end

data/app/controllers/mr_common/registrations/export_controller.rb

@@ -3,12 +3,43 @@
 module MrCommon
   module Registrations
     class ExportController < BaseController
+      # Generates CSV data and sends as file download.
       def index
-        send_data(
-          Registration.as_csv(format_rules: Registration.try(:csv_format_rules)),
-          filename: "Registrations-#{Date.today}.csv"
-        )
+        send_data(registrations_csv, filename: filename)
       end
+
+      private
+
+        def registrations_csv
+          fields = csv_fields
+          fields.delete(:pre_registered?) unless MrCommon.registration_confirmation_strategy == :pre_register
+
+          CSVRenderer.new(
+            collection: MrCommon::Registration.all,
+            decorator: MrCommon::RegistrationDecorator,
+            fields: fields
+          ).render
+        end
+
+        def csv_fields
+          [
+            :first_name,
+            :last_name,
+            :email,
+            :company_name,
+            :telephone,
+            :zip_code,
+            :country,
+            :pre_registered?,
+            :confirmed?,
+            :created_at,
+            :updated_at
+          ]
+        end
+
+        def filename
+          "Registrations-#{Date.today}.csv"
+        end
     end
   end
 end

data/app/controllers/mr_common/registrations/public_controller.rb

@@ -2,6 +2,7 @@
 
 module MrCommon
   module Registrations
+    # Implements public Registration actions available from the landing page.
     class PublicController < PublicBaseController
       def new
         @registration = Registration.new
@@ -9,9 +10,10 @@ module MrCommon
 
       def create
         @registration = Registration.new(registration_params)
+        @registration.confirmed = true if should_confirm_registration?
 
         if @registration.save
-          RegistrationMailer.confirmation(@registration.id).deliver_now
+          send_notification
           redirect_to registrations_success_index_path, notice: MrCommon.registration_success_notice
         else
           flash.now[:alert] = MrCommon.registration_failure_alert if MrCommon.registration_failure_alert.present?
@@ -21,6 +23,27 @@ module MrCommon
 
       private
 
+        def should_confirm_registration?
+          case MrCommon.registration_confirmation_strategy
+          when :auto
+            true
+          when :pre_register
+            PreRegistration.exists_for?(@registration)
+          when :manual
+            false
+          else
+            false
+          end
+        end
+
+        def send_notification
+          if @registration.confirmed?
+            RegistrationMailer.confirmed_registration(@registration.id).deliver_now
+          else
+            RegistrationMailer.unconfirmed_registration(@registration.id).deliver_now
+          end
+        end
+
         def registration_params
           params.require(
             :registration

data/app/controllers/mr_common/registrations/registrations_controller.rb

@@ -2,6 +2,7 @@
 
 module MrCommon
   module Registrations
+    # Admin CRUD for Registrations.
     class RegistrationsController < BaseController
       def index
         @registrations = Registration.order(first_name: :asc, last_name: :asc)
@@ -63,6 +64,7 @@ module MrCommon
             :company_name,
             :telephone,
             :job_title,
+            :confirmed,
             :contact_via_email,
             :contact_via_phone,
           )

data/app/controllers/mr_common/registrations/resend_notifications_controller.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module MrCommon
+  module Registrations
+    class ResendNotificationsController < BaseController
+      def create
+        find_registration
+        send_notification
+        redirect_to @registration, notice: "Notification sent."
+      end
+
+      private
+
+        def find_registration
+          @registration = MrCommon::Registration.find(params[:registration_id])
+        end
+
+        def send_notification
+          if @registration.confirmed?
+            MrCommon::RegistrationMailer.confirmed_registration(@registration.id).deliver_now
+          else
+            MrCommon::RegistrationMailer.unconfirmed_registration(@registration.id).deliver_now
+          end
+        end
+    end
+  end
+end

data/app/controllers/mr_common/registrations/success_controller.rb

@@ -3,6 +3,7 @@
 module MrCommon
   module Registrations
     class SuccessController < PublicBaseController
+      # Page rendered when a Registration is created successfully.
       def index
       end
     end

data/app/mailers/mr_common/registration_mailer.rb

@@ -2,10 +2,20 @@
 
 module MrCommon
   class RegistrationMailer < ApplicationMailer
-    def confirmation(registration_id)
+    def unconfirmed_registration(registration_id)
       @registration = Registration.find(registration_id)
-      @reminders = Reminder.where(include_in_confirmation_mailer: true)
-      mail(to: @registration.email, subject: MrCommon.registration_confirmation_subject)
+      mail(to: @registration.email, subject: MrCommon.registration_unconfirmed_subject)
+    end
+
+    def confirmed_registration(registration_id)
+      @registration = Registration.find(registration_id)
+      @reminders = Reminder.for_confirmed_notice
+      mail(to: @registration.email, subject: MrCommon.registration_confirmed_subject)
+    end
+
+    def revoked_registration(registration_id)
+      @registration = Registration.find(registration_id)
+      mail(to: @registration.email, subject: MrCommon.registration_revoked_subject)
     end
   end
 end

data/app/models/concerns/mr_common/csv_exportable.rb

@@ -5,8 +5,12 @@ module MrCommon
     extend ActiveSupport::Concern
 
     class_methods do
-      def as_csv(adapter: nil, format_rules: nil)
-        CSVExporter.new(self, adapter: adapter, format_rules: format_rules).generate_csv
+      def as_csv(scope: :all, fields: nil, decorator: nil)
+        CSVRenderer.new(
+          collection: self.send(scope),
+          fields: fields || self.column_names,
+          decorator: decorator
+        ).render
       end
     end
   end

data/app/models/mr_common/country.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
 module MrCommon
+  # Wrapper doing common tasks with the Carmen gem
   class Country
     class << self
+      # @param top [Array<String>] a list of country codes that should be
+      #   promoted to the top of the list.
+      # @return [Array<Array<String, String>>] an array of label-value pairs for
+      #   building country select options.
       def all(top = [])
         all_countries = label_value_pairs.dup
 
@@ -13,14 +18,18 @@ module MrCommon
         all_countries
       end
 
+      # @return [Array<String>] two letter country codes in alphabetical order
       def codes
         Carmen::Country.all.map(&:code).sort
       end
 
+      # @return [Array<String>] country names in alphabetical order
       def names
         Carmen::Country.all.map(&:name).sort
       end
 
+      # @param code [String] a two letter country code
+      # @return [String] the name of the country for that code
       def name_for(code)
         Carmen::Country.alpha_2_coded(code).name
       end