effective_polls 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f66e30b255f3552e0c56f6c7b6b4fa7958360f4a6b59cd77d30e829105444491
-  data.tar.gz: 8950bced702e1ca99e324449238156880b3659a542838fb761fe1291d492109d
+  metadata.gz: 57df19aaa933dd133ba655525265e129ca1c2bd7a60a78a5a8f2fe89ec1aa5cc
+  data.tar.gz: 86fe4a6defeef051e4ff9c8543480fd6db703e213d80cf100781f4c71cc60e4b
 SHA512:
-  metadata.gz: 83401587a66ec82a26a108575e90c9e7cfea3ad0fdfebce30179d31ef392467ba6549bdfdcbe51ee56e3a009dc1232eaf2f03ade8e6454bebd5c5002e1b3d8b4
-  data.tar.gz: 1f208285019d5b8cec81fa03a53c0106ac86119206549589049e3eeaec51d49726dceb9e624a1fd0fbbcba1bff030b66936d260c97fde61e42f8742651d7d310
+  metadata.gz: 1b6f6ace193a55d55b49184f8a2b9a1a0766b0e1249c5c3daa65bfac034a7bb7b8ae1920b66ed04d1605137a88798d749951f0f714e2289774f63dfc5d820ca4
+  data.tar.gz: e0b94cefd83a9af17f232cedc37369615ed0042543b886a496174fd807a3117cab3a876bcb6eb34d61f2ca50a70ede2c2c92d965df67d4b0619dc9a3fd05f052

data/app/controllers/admin/poll_notifications_controller.rb

@@ -1,9 +1,7 @@
 module Admin
   class PollNotificationsController < ApplicationController
-    layout EffectivePolls.layout[:admin]
-
     before_action(:authenticate_user!) if defined?(Devise)
-    before_action { EffectivePolls.authorize!(self, :admin, :effective_polls) }
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_polls) }
 
     include Effective::CrudController
 

data/app/controllers/admin/poll_questions_controller.rb

@@ -1,9 +1,7 @@
 module Admin
   class PollQuestionsController < ApplicationController
-    layout EffectivePolls.layout[:admin]
-
     before_action(:authenticate_user!) if defined?(Devise)
-    before_action { EffectivePolls.authorize!(self, :admin, :effective_polls) }
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_polls) }
 
     include Effective::CrudController
 

data/app/controllers/admin/polls_controller.rb

@@ -1,15 +1,13 @@
 module Admin
   class PollsController < ApplicationController
-    layout EffectivePolls.layout[:admin]
-
     before_action(:authenticate_user!) if defined?(Devise)
-    before_action { EffectivePolls.authorize!(self, :admin, :effective_polls) }
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_polls) }
 
     include Effective::CrudController
 
     def results
       @poll = Effective::Poll.find(params[:id])
-      EffectivePolls.authorize!(self, :results, @poll)
+      EffectiveResources.authorize!(self, :results, @poll)
 
       @datatable = Admin::EffectivePollResultsDatatable.new(poll_token: @poll.token)
       @page_title = "#{@poll} Results"

data/app/controllers/effective/ballots_controller.rb

@@ -1,8 +1,7 @@
 module Effective
   class BallotsController < ApplicationController
-    layout EffectivePolls.layout[:polls]
-
     before_action(:authenticate_user!) if defined?(Devise)
+
     include Effective::WizardController
 
     resource_scope do
@@ -19,7 +18,7 @@ module Effective
         flash[:danger] = 'You have already completed a ballot for this poll.'
         redirect_to(root_path)
       elsif existing.present?
-        flash[:success] = "You have been redirected to the #{resource_wizard_step_title(existing.next_step)} step."
+        flash[:success] = "You have been redirected to the #{resource_wizard_step_title(existing, existing.next_step)} step."
         redirect_to effective_polls.poll_ballot_build_path(existing.poll, existing, existing.next_step)
       end
     end

data/app/controllers/effective/polls_controller.rb

@@ -4,7 +4,8 @@ module Effective
 
     def show
       poll = Effective::Poll.find(params[:id])
-      EffectivePolls.authorize!(self, :show, poll)
+
+      EffectiveResources.authorize!(self, :show, poll)
 
       ballot = Effective::Ballot.where(poll: poll, user: current_user).first
 

data/app/datatables/admin/effective_poll_notifications_datatable.rb

@@ -23,6 +23,8 @@ class Admin::EffectivePollNotificationsDatatable < Effective::Datatable
         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

data/app/mailers/effective/polls_mailer.rb

@@ -1,6 +1,8 @@
 module Effective
-  class PollsMailer < EffectivePolls.mailer_class
-    layout EffectivePolls.mailer[:layout].presence || 'effective_polls_mailer_layout'
+  class PollsMailer < EffectivePolls.parent_mailer_class
+
+    include EffectiveMailer
+    include EffectiveEmailTemplatesMailer if EffectivePolls.use_effective_email_templates
 
     def poll_upcoming_reminder(poll_notification, user)
       @assigns = effective_email_templates_assigns(poll_notification, user)
@@ -35,6 +37,17 @@ module Effective
       )
     end
 
+    def poll_before_poll_ends(poll_notification, user)
+      @assigns = effective_email_templates_assigns(poll_notification, user)
+
+      mail(
+        to: user.email,
+        from: poll_notification.from,
+        body: poll_notification.body,
+        subject: poll_notification.subject
+      )
+    end
+
     def poll_when_poll_ends(poll_notification, user)
       @assigns = effective_email_templates_assigns(poll_notification, user)
 
@@ -57,9 +70,10 @@ module Effective
       raise('expected poll to be persisted') unless poll&.persisted?
 
       {
+        subject: poll_notification.subject,
         available_date: poll.available_date,
         title: poll.title,
-        url: effective_polls.new_poll_ballot_url(poll),
+        url: effective_polls.poll_url(poll),
         user: {
           name: user.to_s,
           email: user.email

data/app/models/effective/poll_notification.rb

@@ -3,7 +3,7 @@ module Effective
     belongs_to :poll
     log_changes(to: :poll) if respond_to?(:log_changes)
 
-    CATEGORIES = ['Upcoming reminder', 'When poll starts', 'Reminder', 'When poll ends']
+    CATEGORIES = ['Upcoming reminder', 'When poll starts', 'Reminder', 'Before poll ends', 'When poll ends']
     EMAIL_TEMPLATE_VARIABLES = ['available_date', 'title', 'url', 'user.name', 'user.email']
 
     UPCOMING_REMINDERS = {
@@ -77,7 +77,7 @@ module Effective
       validates :subject, liquid: true
     end
 
-    validates :reminder, if: -> { reminder? || upcoming_reminder? },
+    validates :reminder, if: -> { reminder? || upcoming_reminder? || before_poll_ends? },
       presence: true, uniqueness: { scope: [:poll_id, :category], message: 'already exists' }
 
     def to_s
@@ -100,6 +100,10 @@ module Effective
       category == 'Reminder'
     end
 
+    def before_poll_ends?
+      category == 'Before poll ends'
+    end
+
     def poll_end?
       category == 'When poll ends'
     end
@@ -120,16 +124,18 @@ module Effective
         !poll.started? && poll.start_at < (Time.zone.now + reminder)
       when 'Reminder'
         !poll.ended? && poll.start_at < (Time.zone.now - reminder)
+      when 'Before poll ends'
+        !poll.ended? && poll.end_at.present? && poll.end_at < (Time.zone.now + reminder)
       else
         raise('unexpected category')
       end
     end
 
-    def notify!
-      return false unless notify_now?
+    def notify!(force: false)
+      return false unless (notify_now? || force)
 
       # We send to all users, except for the 'Reminder' that exclude completed users
-      users = poll.users(except_completed: (category == 'Reminder'))
+      users = poll.users(except_completed: (category == 'Reminder' || category == 'Before poll ends'))
 
       update_column(:started_at, Time.zone.now)
 

data/app/views/admin/poll_notifications/_form_poll_before_poll_ends.html.haml

@@ -0,0 +1,8 @@
+= f.select :reminder, Effective::PollNotification::UPCOMING_REMINDERS, label: false,
+  hint: "before the poll ends on #{f.object.poll&.end_at&.strftime('%F') || 'never'}."
+
+.alert.alert-warning
+  %strong Before Poll Ends
+  reminders are sent to users in the audience who have not yet completed their ballot.
+  %br
+  Use before poll ends notifications to remind people to vote.

data/app/views/effective/polls_mailer/poll_before_poll_ends.liquid

@@ -0,0 +1,13 @@
+---
+subject: 'Please submit your ballot for {{ title }}'
+from: 'admin@example.com'
+---
+Hello {{ user.name }},
+
+The {{ title }} poll is almost complete.
+
+Please remember to submit your ballot.
+
+{{ url }}
+
+Thank you

data/config/effective_polls.rb

@@ -7,34 +7,9 @@ EffectivePolls.setup do |config|
   config.ballot_responses_table_name = :ballot_responses
   config.ballot_response_options_table_name = :ballot_response_options
 
-  # Authorization Method
-  #
-  # This method is called by all controller actions with the appropriate action and resource
-  # If it raises an exception or returns false, an Effective::AccessDenied Error will be raised
-  #
-  # Use via Proc:
-  # Proc.new { |controller, action, resource| authorize!(action, resource) }       # CanCan
-  # Proc.new { |controller, action, resource| can?(action, resource) }             # CanCan with skip_authorization_check
-  # Proc.new { |controller, action, resource| authorize "#{action}?", resource }   # Pundit
-  # Proc.new { |controller, action, resource| current_user.is?(:admin) }           # Custom logic
-  #
-  # Use via Boolean:
-  # config.authorization_method = true  # Always authorized
-  # config.authorization_method = false # Always unauthorized
-  #
-  # Use via Method (probably in your application_controller.rb):
-  # config.authorization_method = :my_authorization_method
-  # def my_authorization_method(resource, action)
-  #   true
-  # end
-  config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) }
-
   # Layout Settings
   # Configure the Layout per controller, or all at once
-  config.layout = {
-    polls: 'application',
-    admin: 'admin'
-  }
+  # config.layout = { application: 'application', admin: 'admin' }
 
   # Audience Scope Collection
   #
@@ -51,14 +26,19 @@ EffectivePolls.setup do |config|
   # Schedule rake effective_polls:notify to run every 10 minutes
   # to send out email poll notifications
   #
-  config.mailer = {
-    layout: 'effective_polls_mailer_layout',
-    default_from: 'no-reply@example.com'
-  }
-
-  # Will work with effective_email_templates gem:
-  # - The poll notifications email content will be preopulated based off the template
-  # - Uses a EmailTemplatesMailer mailer instead of ActionMailer::Base
-  config.use_effective_email_templates = false
+  # Please see config/initializers/effective_resources.rb for default effective_* gem mailer settings
+  #
+  # Configure the class responsible to send e-mails.
+  # config.mailer = 'Effective::EventsMailer'
+  #
+  # Override effective_resource mailer defaults
+  #
+  # config.parent_mailer = nil      # The parent class responsible for sending emails
+  # config.deliver_method = nil     # The deliver method, deliver_later or deliver_now
+  # config.mailer_layout = nil      # Default mailer layout
+  # config.mailer_sender = nil      # Default From value
+  # config.mailer_admin = nil       # Default To value for Admin correspondence
 
+  # Use effective email templates for event notifications
+  config.use_effective_email_templates = true
 end

data/lib/effective_polls/version.rb

@@ -1,3 +1,3 @@
 module EffectivePolls
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

data/lib/effective_polls.rb

@@ -4,52 +4,20 @@ require 'effective_polls/engine'
 require 'effective_polls/version'
 
 module EffectivePolls
-  mattr_accessor :polls_table_name
-  mattr_accessor :poll_notifications_table_name
-  mattr_accessor :poll_questions_table_name
-  mattr_accessor :poll_question_options_table_name
-  mattr_accessor :ballots_table_name
-  mattr_accessor :ballot_responses_table_name
-  mattr_accessor :ballot_response_options_table_name
 
-  mattr_accessor :authorization_method
-
-  mattr_accessor :layout
-
-  mattr_accessor :audience_user_scopes
-
-  # Hashes of configs
-  mattr_accessor :use_effective_email_templates
-  mattr_accessor :mailer
-
-  def self.setup
-    yield self
+  def self.config_keys
+    [
+      :polls_table_name, :poll_notifications_table_name, :poll_questions_table_name, :poll_question_options_table_name,
+      :ballots_table_name, :ballot_responses_table_name, :ballot_response_options_table_name,
+      :layout, :audience_user_scopes,
+      :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject, :use_effective_email_templates
+    ]
   end
 
-  def self.authorized?(controller, action, resource)
-    @_exceptions ||= [Effective::AccessDenied, (CanCan::AccessDenied if defined?(CanCan)), (Pundit::NotAuthorizedError if defined?(Pundit))].compact
-
-    return !!authorization_method unless authorization_method.respond_to?(:call)
-    controller = controller.controller if controller.respond_to?(:controller)
-
-    begin
-      !!(controller || self).instance_exec((controller || self), action, resource, &authorization_method)
-    rescue *@_exceptions
-      false
-    end
-  end
-
-  def self.authorize!(controller, action, resource)
-    raise Effective::AccessDenied.new('Access Denied', action, resource) unless authorized?(controller, action, resource)
-  end
+  include EffectiveGem
 
   def self.mailer_class
-    if use_effective_email_templates
-      require 'effective_email_templates'
-      Effective::EmailTemplatesMailer
-    else
-      ActionMailer::Base
-    end
+    mailer&.constantize || Effective::PollsMailer
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_polls
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -104,7 +104,6 @@ files:
 - app/datatables/effective_polls_datatable.rb
 - app/helpers/effective_polls_helper.rb
 - app/mailers/effective/polls_mailer.rb
-- app/models/effective/access_denied.rb
 - app/models/effective/ballot.rb
 - app/models/effective/ballot_response.rb
 - app/models/effective/ballot_response_option.rb
@@ -113,6 +112,7 @@ files:
 - app/models/effective/poll_question.rb
 - app/models/effective/poll_question_option.rb
 - app/views/admin/poll_notifications/_form.html.haml
+- app/views/admin/poll_notifications/_form_poll_before_poll_ends.html.haml
 - app/views/admin/poll_notifications/_form_poll_reminder.html.haml
 - app/views/admin/poll_notifications/_form_poll_upcoming_reminder.html.haml
 - app/views/admin/poll_notifications/_form_poll_when_poll_ends.html.haml
@@ -171,11 +171,11 @@ files:
 - app/views/effective/poll_results/results/_select_up_to_5.html.haml
 - app/views/effective/poll_results/results/_short_answer.html.haml
 - app/views/effective/poll_results/results/_upload_file.html.haml
+- app/views/effective/polls_mailer/poll_before_poll_ends.liquid
 - app/views/effective/polls_mailer/poll_reminder.liquid
 - app/views/effective/polls_mailer/poll_upcoming_reminder.liquid
 - app/views/effective/polls_mailer/poll_when_poll_ends.liquid
 - app/views/effective/polls_mailer/poll_when_poll_starts.liquid
-- app/views/layouts/effective_polls_mailer_layout.html.haml
 - config/effective_polls.rb
 - config/routes.rb
 - db/migrate/01_create_effective_polls.rb.erb

data/app/models/effective/access_denied.rb

@@ -1,17 +0,0 @@
-unless defined?(Effective::AccessDenied)
-  module Effective
-    class AccessDenied < StandardError
-      attr_reader :action, :subject
-
-      def initialize(message = nil, action = nil, subject = nil)
-        @message = message
-        @action = action
-        @subject = subject
-      end
-
-      def to_s
-        @message || I18n.t(:'unauthorized.default', :default => 'Access Denied')
-      end
-    end
-  end
-end

data/app/views/layouts/effective_polls_mailer_layout.html.haml

@@ -1,7 +0,0 @@
-!!!
-%html{style: 'background: #fff;'}
-  %head
-    %meta{:content => 'text/html; charset=UTF-8', 'http-equiv' => 'Content-Type'}
-
-  %body{style: 'background: #fff;'}
-    = yield