effective_events 0.1.10 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '069d27a813f8daeb16748df4948a0e653dbe0bb8d3a853e5fe8ef24fda74729c'
-  data.tar.gz: 2214b6dbdac9cc9e824948303ff983a4aef264fc4544bb43dca0d208a492612c
+  metadata.gz: cd744d00aed47ee8fe88bbfa4f9224f6dea924726a9d7f42be397e88315e5a0f
+  data.tar.gz: b24c00d8bc3a54e3ccad2f43db728ede8a53b5aaff618646386c3ad179c827ed
 SHA512:
-  metadata.gz: 37f1f2d5c00228a0bfbc67ca1aeb49eb70b0691945c06bea4a2432d307658059bbc14bae09d7089c9bea649ab45ecd849bb44af087a90792f3d30827c45411bc
-  data.tar.gz: 41f9da86b0be58b72eff25b4fd1853105e63be29782787135d90abd8e38fcec7910da9846e640f845635a7424039c3d852e0ebe4fb0032fbaadbd369bc1c4931
+  metadata.gz: bee221260b8e2aad273c9b79250707bf4c053dc64a937c3eff477eb345e8bc3a10afb4b9504d45f2d2be778a842a62ffc7dc4a9ac76138915575eff8c295524c
+  data.tar.gz: 305c28be0450a00d070e15d32d0af3dc2de4c72bdbad1e345948c00851ccb882566b84b9a256d9c62786573902cced56a63a658204fd671614d4e59ebc3a58f2

data/app/controllers/admin/event_notifications_controller.rb

@@ -0,0 +1,8 @@
+module Admin
+  class EventNotificationsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_events) }
+
+    include Effective::CrudController
+  end
+end

data/app/controllers/effective/event_registrations_controller.rb

@@ -39,7 +39,6 @@ module Effective
 
     def permitted_params
       model = (params.key?(:effective_event_registration) ? :effective_event_registration : :event_registration)
-
       params.require(model).permit!.except(:status, :status_steps, :wizard_steps, :submitted_at)
     end
 

data/app/controllers/effective/events_controller.rb

@@ -8,7 +8,7 @@ module Effective
     }
 
     def index
-      @events ||= resource_scope
+      @events ||= resource_scope.published
 
       @events = @events.paginate(page: params[:page])
 

data/app/datatables/admin/effective_event_notifications_datatable.rb

@@ -0,0 +1,52 @@
+class Admin::EffectiveEventNotificationsDatatable < Effective::Datatable
+  # filters do
+  #   scope :all
+  #   scope :started
+  #   scope :completed
+  # end
+
+  datatable do
+    col :updated_at, visible: false
+    col :created_at, visible: false
+    col :id, visible: false
+
+    col :event
+    col :category
+
+    col :from do |event|
+      html_escape(event.from)
+    end
+
+    # col :reminder do |poll_notification|
+    #   case poll_notification.category
+    #   when 'When poll starts'
+    #     poll_notification.poll.start_at&.strftime('%F %H:%M')
+    #   when 'When poll ends'
+    #     poll_notification.poll.end_at&.strftime('%F %H:%M')
+    #   when 'Upcoming reminder'
+    #     Effective::PollNotification::UPCOMING_REMINDERS.invert[poll_notification.reminder]
+    #   when 'Reminder'
+    #     Effective::PollNotification::REMINDERS.invert[poll_notification.reminder]
+    #   when 'Before poll ends'
+    #     Effective::PollNotification::UPCOMING_REMINDERS.invert[poll_notification.reminder]
+    #   else
+    #     raise('unexpected category')
+    #   end
+    # end
+
+    col :subject
+
+    col :body do |notification|
+      simple_format(notification.body)
+    end
+
+    # col :started_at, visible: false
+    # col :completed_at
+
+    actions_col
+  end
+
+  collection do
+    Effective::EventNotification.all.deep
+  end
+end

data/app/datatables/admin/effective_events_datatable.rb

@@ -14,6 +14,8 @@ module Admin
       col :id, visible: false
 
       col :title
+      col :slug, visible: false
+
       col :draft
       col :start_at, label: 'Event Start Date'
       col :end_at, label: 'Event End Date', visible: false

data/app/mailers/effective/events_mailer.rb

@@ -0,0 +1,56 @@
+module Effective
+  class EventsMailer < EffectiveResources.parent_mailer_class
+    default from: -> { EffectiveResources.mailer_sender }
+    layout -> { EffectiveResources.mailer_layout }
+
+    include EffectiveEmailTemplatesMailer if EffectiveEvents.use_effective_email_templates
+
+    def event_registrant_purchased(event_registrant, opts = {})
+      @assigns = assigns_for(event_registrant)
+      @event_registrant = event_registrant
+
+      mail(to: event_registrant.email, **headers_for(event_registrant, opts))
+    end
+
+    protected
+
+    def headers_for(resource, opts = {})
+      resource.respond_to?(:log_changes_datatable) ? opts.merge(log: resource) : opts
+    end
+
+    def assigns_for(resource)
+      if resource.kind_of?(EventRegistrant)
+        return event_registrant_assigns(resource).merge(event_assigns(resource.event)).merge(event_ticket_assigns(resource.event_ticket))
+      end
+
+      raise('unexpected resource')
+    end
+
+    def event_assigns(resource)
+      raise('expected an event') unless resource.kind_of?(Event)
+
+      values = {
+        name: resource.title,
+        date: resource.start_at.strftime('%F %H:%M'),
+        url: effective_events.event_url(resource)
+      }
+
+      { event: values }
+    end
+
+    def event_ticket_assigns(resource)
+      raise('expected an event ticket') unless resource.kind_of?(EventTicket)
+
+      values = { name: resource.title }
+      { ticket: values }
+    end
+
+    def event_registrant_assigns(resource)
+      raise('expected an event registrant') unless resource.kind_of?(EventRegistrant)
+
+      values = { name: resource.name, email: resource.email }
+      { registrant: values }
+    end
+
+  end
+end

data/app/models/concerns/effective_events_event_registration.rb

@@ -118,6 +118,11 @@ module EffectiveEventsEventRegistration
       (event_registrants + event_addons)
     end
 
+    def after_submit_purchased!
+      notifications = event.event_notifications.select(&:registrant_purchased?)
+      notifications.each { |notification| notification.notify!(event_registrants: event_registrants) }
+    end
+
   end
 
   # Instance Methods

data/app/models/effective/event.rb

@@ -2,10 +2,10 @@
 
 module Effective
   class Event < ActiveRecord::Base
-    has_many :event_tickets, -> { EventTicket.sorted }, inverse_of: :event
+    has_many :event_tickets, -> { EventTicket.sorted }, inverse_of: :event, dependent: :destroy
     accepts_nested_attributes_for :event_tickets, allow_destroy: true
 
-    has_many :event_products, -> { EventProduct.sorted }, inverse_of: :event
+    has_many :event_products, -> { EventProduct.sorted }, inverse_of: :event, dependent: :destroy
     accepts_nested_attributes_for :event_products, allow_destroy: true
 
     has_many :event_registrants, -> { order(:event_ticket_id, :created_at) }, inverse_of: :event
@@ -14,6 +14,9 @@ module Effective
     has_many :event_addons, -> { order(:event_product_id, :created_at) }, inverse_of: :event
     accepts_nested_attributes_for :event_addons, allow_destroy: true
 
+    has_many :event_notifications, -> { order(:id) }, inverse_of: :event, dependent: :destroy
+    accepts_nested_attributes_for :event_notifications, allow_destroy: true
+
     # rich_text_body - Used by the select step
     has_many_rich_texts
 

data/app/models/effective/event_notification.rb

@@ -0,0 +1,160 @@
+module Effective
+  class EventNotification < ActiveRecord::Base
+    log_changes(to: :event) if respond_to?(:log_changes)
+
+    belongs_to :event
+
+    CATEGORIES = ['Registrant purchased']
+    EMAIL_TEMPLATE_VARIABLES = ['event.name', 'event.date', 'event.url', 'ticket.name', 'registrant.name', 'registrant.email']
+
+    #CATEGORIES = ['Upcoming reminder', 'When event starts', 'Reminder', 'Before event ends', 'When event ends']
+
+    # UPCOMING_REMINDERS = {
+    #   '1 hour before' => 1.hours.to_i,
+    #   '3 hours before' => 3.hours.to_i,
+    #   '6 hours before' => 6.hours.to_i,
+    #   '12 hours before' => 12.hours.to_i,
+    #   '1 day before' => 1.days.to_i,
+    #   '2 days before' => 2.days.to_i,
+    #   '3 days before' => 3.days.to_i,
+    #   '4 days before' => 4.days.to_i,
+    #   '5 days before' => 5.days.to_i,
+    #   '6 days before' => 6.days.to_i,
+    #   '1 week before' => 1.weeks.to_i,
+    #   '2 weeks before' => 2.weeks.to_i,
+    #   '3 weeks before' => 3.weeks.to_i,
+    #   '1 month before' => 1.month.to_i
+    # }
+
+    # REMINDERS = {
+    #   '1 hour after' => 1.hours.to_i,
+    #   '3 hours after' => 3.hours.to_i,
+    #   '6 hours after' => 6.hours.to_i,
+    #   '12 hours after' => 12.hours.to_i,
+    #   '1 day after' => 1.days.to_i,
+    #   '2 days after' => 2.days.to_i,
+    #   '3 days after' => 3.days.to_i,
+    #   '4 days after' => 4.days.to_i,
+    #   '5 days after' => 5.days.to_i,
+    #   '6 days after' => 6.days.to_i,
+    #   '1 week after' => 1.weeks.to_i,
+    #   '2 weeks after' => 2.weeks.to_i,
+    #   '3 weeks after' => 3.weeks.to_i,
+    #   '1 month after' => 1.month.to_i
+    # }
+
+    effective_resource do
+      category          :string
+      reminder          :integer  # Number of seconds before event.start_at
+
+      # Email
+      from              :string
+      subject           :string
+      body              :text
+
+      # Tracking background jobs email send out
+      started_at        :datetime
+      completed_at      :datetime
+
+      timestamps
+    end
+
+    scope :sorted, -> { order(:id) }
+    scope :deep, -> { includes(:event) }
+
+    scope :started, -> { where.not(started_at: nil) }
+    scope :completed, -> { where.not(completed_at: nil) }
+
+    # Called by a future event_notifier rake task
+    scope :notifiable, -> { where(started_at: nil, completed_at: nil) }
+
+    validates :category, presence: true, inclusion: { in: CATEGORIES }
+
+    validates :from, presence: true, email: true
+    validates :subject, presence: true
+    validates :body, presence: true
+
+    if EffectiveEvents.use_effective_email_templates
+      validates :body, liquid: true
+      validates :subject, liquid: true
+    end
+
+    # validates :reminder, if: -> { reminder? || upcoming_reminder? || before_event_ends? },
+    #   presence: true, uniqueness: { scope: [:event_id, :category], message: 'already exists' }
+
+    def to_s
+      'event notification'
+    end
+
+    def email_template
+      'event_' + category.to_s.parameterize.underscore
+    end
+
+    def registrant_purchased?
+      category == 'Registrant purchased'
+    end
+
+    # def upcoming_reminder?
+    #   category == 'Upcoming reminder'
+    # end
+
+    # def event_start?
+    #   category == 'When event starts'
+    # end
+
+    # def reminder?
+    #   category == 'Reminder'
+    # end
+
+    # def before_event_ends?
+    #   category == 'Before event ends'
+    # end
+
+    # def event_end?
+    #   category == 'When event ends'
+    # end
+
+    # def notifiable?
+    #   started_at.blank? && completed_at.blank?
+    # end
+
+    def notify_now?
+      true
+
+      #return false unless notifiable?
+
+      # case category
+      # when 'When event starts'
+      #   event.available?
+      # when 'When event ends'
+      #   event.ended?
+      # when 'Upcoming reminder'
+      #   !event.started? && event.start_at < (Time.zone.now + reminder)
+      # when 'Reminder'
+      #   !event.ended? && event.start_at < (Time.zone.now - reminder)
+      # when 'Before event ends'
+      #   !event.ended? && event.end_at.present? && event.end_at < (Time.zone.now + reminder)
+      # else
+      #   raise('unexpected category')
+      # end
+    end
+
+    def notify!(force: false, event_registrants: nil)
+      return false unless (notify_now? || force)
+
+      # We send one email to each registrant
+      event_registrants ||= event.event_registrants.purchased
+
+      update_column(:started_at, Time.zone.now)
+
+      opts = { from: from, subject: subject, body: body }
+
+      event_registrants.each do |event_registrant|
+        EffectiveEvents.send_email(email_template, event_registrant, opts)
+      end
+
+      update_column(:completed_at, Time.zone.now)
+    end
+
+  end
+end

data/app/models/effective/event_registrant.rb

@@ -58,6 +58,10 @@ module Effective
       "#{event_ticket} - #{last_first_name}"
     end
 
+    def name
+      "#{first_name} #{last_name}"
+    end
+
     def last_first_name
       "#{last_name}, #{first_name}"
     end

data/app/views/admin/event_notifications/_form.html.haml

@@ -0,0 +1,44 @@
+= effective_form_with(model: [:admin, event_notification], engine: true) do |f|
+  - if inline_datatable?
+    = f.hidden_field :event_id
+  - else
+    = f.select :event_id, Effective::Event.sorted.all
+
+  = f.select :category, Effective::EventNotification::CATEGORIES,
+    label: 'Send an email notification'
+
+  - # Render email templates
+  - Effective::EventNotification::CATEGORIES.each do |category|
+    - template = 'event_' + category.parameterize.underscore
+
+    = f.show_if :category, category do
+      = render "/admin/event_notifications/form_#{template}", f: f
+
+      - if f.object.category == category && f.object.persisted?
+        = f.text_field :from
+        = f.text_field :subject
+        = f.text_area :body, rows: 10
+
+      - elsif EffectiveEvents.use_effective_email_templates == false
+        = f.text_field :from, value: EffectiveResources.mailer_sender
+        = f.text_field :subject, value: ''
+        = f.text_area :body, rows: 10, value: ''
+
+      - else
+        - email_template = Effective::EmailTemplate.where(template_name: template).first!
+
+        = f.text_field :from, value: email_template.from
+        = f.text_field :subject, value: email_template.subject
+        = f.text_area :body, rows: 10, value: email_template.body
+
+      - if EffectiveEvents.use_effective_email_templates
+
+        %p The available variables are:
+
+        %ul
+          - Effective::EventNotification::EMAIL_TEMPLATE_VARIABLES.each do |variable|
+            %li {{ #{variable} }}
+
+        %small.text-muted Only a developer can add additional variables
+
+  = effective_submit(f)

data/app/views/admin/event_notifications/_form_event_registrant_purchased.html.haml

@@ -0,0 +1,3 @@
+.alert.alert-warning
+  %strong When registrant purchased
+  notifications will be sent to each registrant at time of purchase.

data/app/views/admin/events/_form.html.haml

@@ -16,6 +16,12 @@
       - datatable = Admin::EffectiveEventProductsDatatable.new(event_id: event.id)
       = render_inline_datatable(datatable)
 
+    = tab 'Email' do
+      %p Click New to add one or more emails.
+
+      - datatable = Admin::EffectiveEventNotificationsDatatable.new(event_id: event.id)
+      = render_datatable(datatable, inline: true, simple: true)
+
     = tab 'Registrations' do
       %h2 Registrations
       - datatable = Admin::EffectiveEventRegistrationsDatatable.new(event_id: event.id)

data/app/views/effective/event_registrations/_dashboard.html.haml

@@ -17,7 +17,7 @@
     = link_to('Abandon registration', effective_events.event_event_registration_path(registration.event, registration), 'data-confirm': "Really delete #{registration}?", 'data-method': :delete, class: 'btn btn-danger')
     to register for another event.
 
-    %hr
+  %hr
 
 %h2 Event Registrations
 

data/app/views/effective/events/_event.html.haml

@@ -1,5 +1,5 @@
 .effective-event
-  %table.table.effective-events-table
+  %table.table.effective-event-table
     %tbody
       %tr
         %td Starts

data/app/views/effective/events_mailer/event_registrant_purchased.liquid

@@ -0,0 +1,17 @@
+---
+subject: 'You have been registered for {{ event.title }}'
+from: 'admin@example.com'
+---
+Hello {{ registrant.name }},
+
+Your ticket {{ ticket.name }} has been purchased.
+
+You are registered for {{ event.name }}
+
+The event starts on {{ event.date }}
+
+{{ event.url }}
+
+Thank you.
+
+Please contact us for assistance.

data/config/effective_events.rb

@@ -18,4 +18,15 @@ EffectiveEvents.setup do |config|
 
   # Events can be restricted by role
   config.use_effective_roles = true
+
+  # Mailer Configuration
+  #
+  # Additional mailer settings for parent_mailer, delivery_method, layout, sender and admin
+  # are required fields in config/initializers/effective_resources.rb
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = 'Effective::EventsMailer'
+
+  # Use effective email templates for event notifications
+  config.use_effective_email_templates = true
 end

data/config/routes.rb

@@ -21,6 +21,7 @@ EffectiveEvents::Engine.routes.draw do
     resources :event_registrants, except: [:show]
     resources :event_addons, except: [:show]
     resources :event_registrations, only: [:index, :show]
+    resources :event_notifications, except: [:show]
   end
 
 end

data/db/migrate/01_create_effective_events.rb.erb

@@ -131,5 +131,22 @@ class CreateEffectiveEvents < ActiveRecord::Migration[6.0]
     add_index <%= @event_registrations_table_name %>, :status
     add_index <%= @event_registrations_table_name %>, :token
 
+    create_table <%= @event_notifications_table_name %> do |t|
+      t.references :event
+
+      t.string :category
+      t.integer :reminder
+
+      t.string :from
+      t.string :subject
+      t.text :body
+
+      t.datetime :started_at
+      t.datetime :completed_at
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+
   end
 end

data/lib/effective_events/version.rb

@@ -1,3 +1,3 @@
 module EffectiveEvents
-  VERSION = '0.1.10'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/effective_events.rb

@@ -9,7 +9,8 @@ module EffectiveEvents
       :events_table_name, :event_registrants_table_name, :event_tickets_table_name,
       :event_registrations_table_name, :event_products_table_name, :event_addons_table_name,
       :layout, :per_page, :use_effective_roles,
-      :event_registration_class_name
+      :event_registration_class_name,
+      :mailer, :use_effective_email_templates
     ]
   end
 
@@ -19,4 +20,8 @@ module EffectiveEvents
     event_registration_class_name&.constantize || Effective::EventRegistration
   end
 
+  def self.mailer_class
+    mailer&.constantize || Effective::EventsMailer
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_events
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-17 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: effective_email_templates
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Event registrations, tickets and products
 email:
 - info@codeandeffect.com
@@ -180,6 +194,7 @@ files:
 - app/assets/stylesheets/effective_events.scss
 - app/assets/stylesheets/effective_events/base.scss
 - app/controllers/admin/event_addons_controller.rb
+- app/controllers/admin/event_notifications_controller.rb
 - app/controllers/admin/event_products_controller.rb
 - app/controllers/admin/event_registrants_controller.rb
 - app/controllers/admin/event_registrations_controller.rb
@@ -188,6 +203,7 @@ files:
 - app/controllers/effective/event_registrations_controller.rb
 - app/controllers/effective/events_controller.rb
 - app/datatables/admin/effective_event_addons_datatable.rb
+- app/datatables/admin/effective_event_notifications_datatable.rb
 - app/datatables/admin/effective_event_products_datatable.rb
 - app/datatables/admin/effective_event_registrants_datatable.rb
 - app/datatables/admin/effective_event_registrations_datatable.rb
@@ -198,14 +214,18 @@ files:
 - app/datatables/effective_event_registrations_datatable.rb
 - app/datatables/effective_events_datatable.rb
 - app/helpers/effective_events_helper.rb
+- app/mailers/effective/events_mailer.rb
 - app/models/concerns/effective_events_event_registration.rb
 - app/models/effective/event.rb
 - app/models/effective/event_addon.rb
+- app/models/effective/event_notification.rb
 - app/models/effective/event_product.rb
 - app/models/effective/event_registrant.rb
 - app/models/effective/event_registration.rb
 - app/models/effective/event_ticket.rb
 - app/views/admin/event_addons/_form.html.haml
+- app/views/admin/event_notifications/_form.html.haml
+- app/views/admin/event_notifications/_form_event_registrant_purchased.html.haml
 - app/views/admin/event_products/_form.html.haml
 - app/views/admin/event_registrants/_form.html.haml
 - app/views/admin/event_tickets/_form.html.haml
@@ -237,6 +257,7 @@ files:
 - app/views/effective/events/_spacer.html.haml
 - app/views/effective/events/index.html.haml
 - app/views/effective/events/show.html.haml
+- app/views/effective/events_mailer/event_registrant_purchased.liquid
 - config/effective_events.rb
 - config/routes.rb
 - db/migrate/01_create_effective_events.rb.erb