effective_memberships 0.4.9 → 0.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60e4351c09c9d070ea622ed6e7770df2f14d53e177a4ea74e04294d00b91af6f
-  data.tar.gz: 65436fdfda6a93aa08e1846d44b13131eedcc9d92e5831742dd6892d5ed87a32
+  metadata.gz: 9e598cee90bcbc1349b12ff9d56babaf0686ddcc91f6ed162c8a8edc6c4b5c67
+  data.tar.gz: 8ace8c8625d529b305e832b9f24c5377be98e3da711a7d146fdf67d613bf7a93
 SHA512:
-  metadata.gz: bffdf6c0614f8f36ee84b38426b1a8ea9aae37a7b1385fe9ce746584196bb043d2c835f1414942f8dc504b53090e6725649657fe348feab736a9b00453aa13c7
-  data.tar.gz: 845130d67ea3500c634f2f9c96684af9ca1785dc50133ac94efda8087cb80e2e50bf05ea071540106d7d0250c557a0267ead9ed5b3ea2f98ca59cb99858b197a
+  metadata.gz: 2dadd826408201278a2cfcd8638399c140c755ceda775accdb015b8613e7f036d68dbd0776e39d77ff76bc41d0bec765972c33c1f859dc3dfcfc5ce3f57d965f
+  data.tar.gz: 7d915acf40e2b27b05773674e536d70c45555ea217f3f7abaa34c330ee51c00d75c914681c91f8ec43d39d33c0fe2127a6614f1f5afc7fb8664b8af937b054cd

data/app/assets/javascripts/effective_memberships/applicant_experiences.js

@@ -31,8 +31,3 @@ $(document).on('change dp.change keyup', "[data-applicant-experiences-month]", f
   const $form = $(event.currentTarget).closest('form');
   sumApplicantExperiences($form);
 });
-
-
-// $(document).on 'cocoon:after-remove', (event) ->
-//   $form = $(event.target).closest('form')
-//   sumMonths($form) if $form.find('[data-experience-month]').length > 0

data/app/controllers/admin/applicant_endorsements_controller.rb

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

data/app/controllers/effective/applicant_endorsements_controller.rb

@@ -0,0 +1,48 @@
+module Effective
+  class ApplicantEndorsementsController < ApplicationController
+    include Effective::CrudController
+    include Effective::Select2AjaxController
+
+    page_title 'Confidential Endorsement Form'
+
+    # The show and update actions are public routes but can only be reached by the token.
+    # The endorser must declare and submit the form
+    # To move an applicant endorsement from submitted to completed
+
+    submit :notify, 'Resend email notification',
+      success: -> { "Sent email notification to #{resource.email}" }
+
+    submit :complete, 'Complete Endorsement'
+
+    def show
+      @applicant_endorsement = ApplicantEndorsement.submitted.find(params[:id])
+      EffectiveResources.authorize!(self, :show, @applicant_endorsement)
+
+      render 'edit'
+    end
+
+    # Must be signed in
+    def select2_ajax_endorser
+      authenticate_user! if defined?(Devise)
+
+      applicant = EffectiveMemberships.Applicant.find(params[:applicant_id])
+      collection = Effective::ApplicantEndorsement.endorser_collection(applicant)
+
+      respond_with_select2_ajax(collection)
+    end
+
+    protected
+
+    def permitted_params
+      permitted = params.require(:effective_applicant_endorsement).permit!.except(:token, :last_notified_at, :status, :status_steps, :applicant_id, :endorser_id)
+
+      if current_user && current_user.memberships_owners.include?(resource.applicant&.owner)
+        permitted.except(:notes, :accept_declaration)
+      else
+        permitted
+      end
+
+    end
+
+  end
+end

data/app/controllers/effective/applicant_references_controller.rb

@@ -23,7 +23,7 @@ module Effective
     protected
 
     def permitted_params
-      permitted = params.require(:effective_applicant_reference).permit!.except(:token, :last_notified_at, :status, :status_steps)
+      permitted = params.require(:effective_applicant_reference).permit!.except(:token, :last_notified_at, :status, :status_steps, :applicant_id)
 
       if current_user && current_user.memberships_owners.include?(resource.applicant&.owner)
         permitted.except(:reservations, :reservations_reason, :work_history, :accept_declaration)

data/app/datatables/admin/effective_applicant_endorsements_datatable.rb

@@ -0,0 +1,35 @@
+module Admin
+  class EffectiveApplicantEndorsementsDatatable < Effective::Datatable
+
+    datatable do
+      order :name
+
+      col :applicant
+
+      col :endorser
+      col :email
+      col :name
+      col :phone
+      col :unknown_member, visible: false
+
+      col :status do |endorsement|
+        if endorsement.submitted?
+          'Waiting on response'
+        elsif endorsement.completed?
+          'Completed'
+        end
+      end
+
+      col :last_notified_at do |endorsement|
+        endorsement.last_notified_at&.strftime('%F') unless endorsement.completed?
+      end
+
+      actions_col
+    end
+
+    collection do
+      Effective::ApplicantEndorsement.deep.all
+    end
+
+  end
+end

data/app/datatables/effective_applicant_endorsements_datatable.rb

@@ -0,0 +1,38 @@
+# For the applicant complete step to add additional endorsements
+class EffectiveApplicantEndorsementsDatatable < Effective::Datatable
+
+  datatable do
+    length :all
+    order :name
+
+    col :name do |endorsement|
+      endorser&.to_s || name
+    end
+
+    col :email
+    col :phone
+
+    col :status do |reference|
+      if reference.submitted?
+        'Waiting on response'
+      elsif reference.completed?
+        'Completed'
+      end
+    end
+
+    col :last_notified_at do |endorsement|
+      endorsement.last_notified_at&.strftime('%F') unless endorsement.completed?
+    end
+
+    actions_col partial: 'effective/applicant_endorsements/datatable_actions', partial_as: :applicant_endorsement
+  end
+
+  collection do
+    Effective::ApplicantEndorsement.deep.where(applicant: applicant)
+  end
+
+  def applicant
+    @applicant ||= EffectiveMemberships.Applicant.where(id: attributes[:applicant_id]).first!
+  end
+
+end

data/app/datatables/effective_applicant_equivalences_datatable.rb

@@ -0,0 +1,23 @@
+class EffectiveApplicantEquivalencesDatatable < Effective::Datatable
+  datatable do
+    length :all
+    order :start_on
+
+    col :start_on
+
+    col :end_on do |applicant_equivalence|
+      applicant_equivalence.end_on&.strftime('%F') || '-'
+    end
+
+    col :name
+    col :notes
+  end
+
+  collection do
+    Effective::ApplicantEquivalence.deep.where(applicant: applicant)
+  end
+
+  def applicant
+    @applicant ||= EffectiveMemberships.Applicant.where(id: attributes[:applicant_id]).first!
+  end
+end

data/app/datatables/effective_applicant_experiences_datatable.rb

@@ -1,6 +1,7 @@
 class EffectiveApplicantExperiencesDatatable < Effective::Datatable
   datatable do
     length :all
+
     order :start_on
 
     col :start_on

data/app/datatables/effective_applicant_references_datatable.rb

@@ -1,4 +1,4 @@
-# For the applicant complete step to add additional applicants
+# For the applicant complete step to add additional references
 class EffectiveApplicantReferencesDatatable < Effective::Datatable
 
   datatable do

data/app/mailers/effective/memberships_mailer.rb

@@ -44,6 +44,16 @@ module Effective
       mail(to: resource.user.email, subject: subject, **headers)
     end
 
+    def applicant_endorsement_notification(resource, opts = {})
+      @assigns = assigns_for(resource)
+      @applicant_endorsement = resource
+
+      subject = subject_for(__method__, 'Endorsement Requested', resource, opts)
+      headers = headers_for(resource, opts)
+
+      mail(to: resource.email, subject: subject, **headers)
+    end
+
     def applicant_reference_notification(resource, opts = {})
       @assigns = assigns_for(resource)
       @applicant_reference = resource
@@ -61,6 +71,10 @@ module Effective
         return applicant_assigns(resource).merge(owner_assigns(resource.owner))
       end
 
+      if resource.kind_of?(Effective::ApplicantEndorsement)
+        return endorsement_assigns(resource).merge(owner_assigns(resource.applicant.owner))
+      end
+
       if resource.kind_of?(Effective::ApplicantReference)
         return reference_assigns(resource).merge(owner_assigns(resource.applicant.owner))
       end
@@ -88,6 +102,17 @@ module Effective
       { applicant: values }
     end
 
+    def endorsement_assigns(applicant_endorsement)
+      raise('expected a endorsement') unless applicant_endorsement.kind_of?(Effective::ApplicantEndorsement)
+
+      values = {
+        name: (applicant_endorsement.endorser&.to_s || applicant_endorsement.name),
+        url: effective_memberships.applicant_endorsement_url(applicant_endorsement)
+      }
+
+      { endorsement: values }
+    end
+
     def reference_assigns(applicant_reference)
       raise('expected a reference') unless applicant_reference.kind_of?(Effective::ApplicantReference)
 

data/app/models/concerns/effective_memberships_applicant.rb

@@ -93,6 +93,12 @@ module EffectiveMembershipsApplicant
     has_many :applicant_educations, -> { order(:id) }, class_name: 'Effective::ApplicantEducation', as: :applicant, inverse_of: :applicant, dependent: :destroy
     accepts_nested_attributes_for :applicant_educations, reject_if: :all_blank, allow_destroy: true
 
+    has_many :applicant_endorsements, -> { order(:id) }, class_name: 'Effective::ApplicantEndorsement', as: :applicant, inverse_of: :applicant, dependent: :destroy
+    accepts_nested_attributes_for :applicant_endorsements, reject_if: :all_blank, allow_destroy: true
+
+    has_many :applicant_equivalences, -> { order(:id) }, class_name: 'Effective::ApplicantEquivalence', as: :applicant, inverse_of: :applicant, dependent: :destroy
+    accepts_nested_attributes_for :applicant_equivalences, reject_if: :all_blank, allow_destroy: true
+
     has_many :applicant_experiences, -> { order(:id) }, class_name: 'Effective::ApplicantExperience', as: :applicant, inverse_of: :applicant, dependent: :destroy
     accepts_nested_attributes_for :applicant_experiences, reject_if: :all_blank, allow_destroy: true
 
@@ -238,6 +244,26 @@ module EffectiveMembershipsApplicant
       end
     end
 
+    # Applicant Endorsements Step
+    with_options(if: -> { current_step == :endorsements }) do
+      validate do
+        required = min_applicant_endorsements()
+        existing = applicant_endorsements().reject(&:marked_for_destruction?).length
+
+        self.errors.add(:applicant_endorsements, "please include #{required} or more endorsements") if existing < required
+      end
+    end
+
+    # Applicant Equivalences Step
+    with_options(if: -> { current_step == :equivalences }) do
+      validate do
+        required = min_applicant_equivalences()
+        existing = applicant_equivalences().reject(&:marked_for_destruction?).length
+
+        self.errors.add(:applicant_equivalences, "please include #{required} or more equivalences") if existing < required
+      end
+    end
+
     # Applicant References Step
     with_options(if: -> { current_step == :references }) do
       validate do
@@ -361,6 +387,7 @@ module EffectiveMembershipsApplicant
       stamps.each { |stamp| stamp.submit! }
 
       after_commit do
+        applicant_endorsements.each { |endorsement| endorsement.notify! if endorsement.submitted? }
         applicant_references.each { |reference| reference.notify! if reference.submitted? }
       end
 
@@ -521,6 +548,16 @@ module EffectiveMembershipsApplicant
     category&.min_applicant_references.to_i
   end
 
+  # Endorsements Step
+  def min_applicant_endorsements
+    category&.min_applicant_endorsements.to_i
+  end
+
+  # Equivalences Step
+  def min_applicant_equivalences
+    category&.min_applicant_equivalences.to_i
+  end
+
   # Files Step
   def min_applicant_files
     category&.min_applicant_files.to_i
@@ -536,6 +573,10 @@ module EffectiveMembershipsApplicant
     )
   end
 
+  def applicant_endorsements_required?
+    min_applicant_endorsements > 0
+  end
+
   def applicant_references_required?
     min_applicant_references > 0
   end
@@ -543,13 +584,18 @@ module EffectiveMembershipsApplicant
   # When an application is submitted, these must be done to go to completed.
   # An Admin can override this and just set them to completed.
   def completed_requirements
-    if category&.applicant_wizard_steps&.include?(:references) || applicant_references_required?
-      {
-        'Applicant References' => (!applicant_references_required? || applicant_references.count(&:completed?) >= min_applicant_references)
-      }
-    else
-      {}
+    requirements = {}
+    return requirements unless category.present?
+
+    if category.applicant_wizard_steps.include?(:references) || applicant_references_required?
+      requirements['Applicant References'] = (!applicant_references_required? || applicant_references.count(&:completed?) >= min_applicant_references)
     end
+
+    if category.applicant_wizard_steps.include?(:endorsements) || applicant_endorsements_required?
+      requirements['Applicant Endorsements'] = (!applicant_endorsements_required? || applicant_endorsements.count(&:completed?) >= min_applicant_endorsements)
+    end
+
+    requirements
   end
 
   def complete!

data/app/models/concerns/effective_memberships_category.rb

@@ -55,6 +55,8 @@ module EffectiveMembershipsCategory
       applicant_wizard_steps     :text
 
       min_applicant_educations          :integer
+      min_applicant_endorsements        :integer
+      min_applicant_equivalences        :integer
       min_applicant_experiences_months  :integer
       min_applicant_references          :integer
       min_applicant_courses             :integer

data/app/models/concerns/effective_memberships_fee_payment.rb

@@ -129,7 +129,6 @@ module EffectiveMembershipsFeePayment
 
         fee_payment_steps.delete(:organization) unless organization?
 
-
         wizard_steps.select do |step|
           required_steps.include?(step) || category.blank? || fee_payment_steps.include?(step)
         end

data/app/models/effective/applicant_endorsement.rb

@@ -0,0 +1,100 @@
+# An ApplicantEndorsement is similar to a reference, except it must be an existing member
+
+module Effective
+  class ApplicantEndorsement < ActiveRecord::Base
+    acts_as_tokened
+
+    acts_as_statused(
+      :submitted, # Was submitted by the applicant
+      :completed # Was completed by the endorser.
+    )
+
+    log_changes(to: :applicant) if respond_to?(:log_changes)
+
+    belongs_to :applicant, polymorphic: true
+    belongs_to :endorser, polymorphic: true, optional: true
+
+    effective_resource do
+      # These fields are submitted by the applicant
+      # They should try to select an endorser from the dropdown
+      # But we also allow a fallback
+      unknown_member   :boolean
+      endorser_email   :string
+      name             :string
+      phone            :string
+
+      # As per acts_as_statused. For tracking the state machine.
+      status            :string
+      status_steps      :text
+
+      # Endorser Declaration
+      notes                   :text
+      accept_declaration      :boolean
+
+      # Tracking the submission
+      token                     :string
+      last_notified_at          :datetime
+
+      timestamps
+    end
+
+    scope :deep, -> { all }
+
+    # All step validations
+    validates :applicant, presence: true
+    validates :endorser_id, presence: true, unless: -> { unknown_member? }
+
+    with_options(if: -> { unknown_member? }) do
+      validates :endorser_email, presence: true, email: true
+      validates :name, presence: true
+      validates :phone, presence: true
+    end
+
+    # When being submit by the reference
+    with_options(if: -> { completed? }) do
+      validates :accept_declaration, acceptance: true
+    end
+
+    after_commit(on: :create, if: -> { applicant.was_submitted? }) { notify! }
+
+    def self.endorser_collection(applicant)
+      raise('expected an effective memberships applicant') unless applicant.class.try(:effective_memberships_applicant?)
+
+      collection_method = EffectiveMemberships.applicant_endorsements_endorser_collection()
+
+      if collection_method.blank?
+        return (applicant.user.class.members)
+      end
+
+      collection = instance_exec(applicant, &collection_method)
+
+      unless collection.kind_of?(ActiveRecord::Relation)
+        raise("expected EffectiveMemberships.applicant_endorsements_endorsers_collection to return an ActiveRecord::Relation.")
+      end
+
+      collection
+    end
+
+    def to_s
+      'endorsement'
+    end
+
+    def email
+      endorser&.email || endorser_email
+    end
+
+    def notify!
+      raise('expected endorsement email') unless email.present?
+
+      EffectiveMemberships.send_email(:applicant_endorsement_notification, self)
+      update!(last_notified_at: Time.zone.now)
+    end
+
+    def complete!
+      completed!
+      applicant.save!
+    end
+
+  end
+
+end

data/app/models/effective/applicant_equivalence.rb

@@ -0,0 +1,32 @@
+module Effective
+  class ApplicantEquivalence < ActiveRecord::Base
+    belongs_to :applicant, polymorphic: true
+
+    log_changes(to: :applicant) if respond_to?(:log_changes)
+
+    effective_resource do
+      name           :string
+
+      start_on       :date
+      end_on         :date
+
+      notes          :text
+
+      timestamps
+    end
+
+    scope :deep, -> { all }
+
+    validates :name, presence: true
+    validates :start_on, presence: true
+
+    validate(if: -> { start_on.present? && end_on.present? }) do
+      errors.add(:end_on, 'must be after start date') unless start_on < end_on
+    end
+
+    def to_s
+      name || 'equivalence'
+    end
+
+  end
+end

data/app/views/admin/applicant_endorsements/_applicant_endorsement.html.haml

@@ -0,0 +1 @@
+= render '/effective/applicant_endorsements/applicant_endorsement', applicant_endorsement: applicant_endorsement, skip_actions: true

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

@@ -25,6 +25,10 @@
     = tab 'References' do
       .mb-4= render_inline_datatable(Admin::EffectiveApplicantReferencesDatatable.new(applicant: applicant))
 
+  - if applicant.applicant_endorsements.present?
+    = tab 'Endorsements' do
+      .mb-4= render_inline_datatable(Admin::EffectiveApplicantEndorsementsDatatable.new(applicant: applicant))
+
   - if applicant.fees.present? || applicant.orders.present?
     = tab 'Fees' do
       .mb-4

data/app/views/admin/categories/_form_applicant_steps.html.haml

@@ -32,6 +32,18 @@
           %td= f.number_field :min_applicant_experiences_months, label: false
           %td minimimum months of work experience
 
+      - if applicant.wizard_step_keys.include?(:endorsements)
+        %tr
+          %td= applicant.wizard_step_title(:endorsements)
+          %td= f.number_field :min_applicant_endorsements, label: false
+          %td minimimum number of endorsements
+
+      - if applicant.wizard_step_keys.include?(:equivalences)
+        %tr
+          %td= applicant.wizard_step_title(:equivalences)
+          %td= f.number_field :min_applicant_equivalences, label: false
+          %td minimimum number of equivalent memberships
+
       - if applicant.wizard_step_keys.include?(:references)
         %tr
           %td= applicant.wizard_step_title(:references)

data/app/views/effective/applicant_endorsements/_applicant_endorsement.html.haml

@@ -0,0 +1,46 @@
+- endorsement = applicant_endorsement
+
+%table.table.table-sm
+  %tbody
+    %tr
+      %th Endorser
+      %td
+        - if endorsement.endorser.present?
+          - endorser = endorsement.endorser
+          = link_to("#{endorser.to_s} <#{endorser.email}>", "mailto:#{endorser.email}")
+        - else
+          = link_to("#{endorsement.name} <#{endorsement.email}>", "mailto:#{endorsement.email}")
+      %td
+
+    - if endorsement.phone.present?
+      %tr
+        %th Phone
+        %td= endorsement.phone
+
+    - if endorsement.applicant.was_submitted?
+      %tr
+        %th Status
+        %td
+          - if endorsement.submitted?
+            Waiting on response
+          - elsif endorsement.completed?
+            Response completed
+
+    - unless endorsement.applicant.was_approved?
+      %tr
+        %th Last Notified at
+        %td= endorsement.last_notified_at&.strftime('%F') || 'Never'
+
+      - if can?(:notify, endorsement) && !local_assigns[:skip_actions]
+        %tr
+          %th Notification
+          %td= link_to('Resend email notification', effective_memberships.notify_applicant_endorsement_path(endorsement), 'data-method': :post, 'data-confirm': "Really resend email notification to #{endorsement.email}?")
+
+    - if endorsement.completed? && can?(:review, endorsement)
+      %tr
+        %th Notes
+        %td= endorsement.notes
+
+      %tr
+        %th Endorsed On
+        %td= endorsement.completed_at.strftime('%F')

data/app/views/effective/applicant_endorsements/_datatable_actions.html.haml

@@ -0,0 +1,4 @@
+= dropdown(variation: :dropleft) do
+  - unless applicant_endorsement.completed?
+    = dropdown_link_to 'Notify', effective_memberships.notify_applicant_endorsement_path(applicant_endorsement),
+      data: { method: :post, confirm: "Really notify #{applicant_endorsement.email}?" }

data/app/views/effective/applicant_endorsements/_form.html.haml

@@ -0,0 +1,9 @@
+= effective_form_with(model: applicant_endorsement, engine: true) do |f|
+  = f.hidden_field :applicant_id
+  = f.hidden_field :applicant_type
+
+  - if f.object.new_record?
+    %p An email will be sent asking them to complete a endorsement declaration form.
+    = f.submit('Create and Notify endorser')
+  - else
+    = f.submit

data/app/views/effective/applicant_endorsements/_form_declaration.html.haml

@@ -0,0 +1,22 @@
+= effective_form_with(model: applicant_endorsement, engine: true) do |f|
+  %h2 Applicant endorsement
+
+  %p
+    I endorse and sponser
+    = applicant_endorsement.applicant.owner
+    as a candidate for
+    = applicant_endorsement.applicant.category
+    membership and certify that I have personal knowledge of the professional ability
+    and character, methods of practice, and experience of the applicant.
+
+  %p
+    The candidate has satisfied the requirements for membership in this category,
+    and to the best of my personal knowledge,
+    the applicant observes and upholds the Code of Ethics and Professional Practice.
+
+  .mt-4
+
+  = f.text_area :notes, label: "Additional comments"
+  = f.check_box :accept_declaration, label: 'Yes, I declare that the above information is true and accurate'
+
+  = f.submit 'Complete Endorsement'

data/app/views/effective/applicant_endorsements/complete.html.haml

@@ -0,0 +1,2 @@
+= card do
+  %p Thank you! The confidential endorsement has been completed.

data/app/views/effective/applicant_endorsements/edit.html.haml

@@ -0,0 +1,7 @@
+= card do
+  %p
+    Please provide a endorsement for the applicant
+    = succeed('.') do
+      %strong= @applicant_endorsement.applicant.owner
+
+  = render('form_declaration', applicant_endorsement: @applicant_endorsement)

data/app/views/effective/applicant_references/complete.html.haml

@@ -1,3 +1,2 @@
-.card
-  .card-body
-    %p Thank you! The confidential reference has been completed.
+= card do
+  %p Thank you! The confidential reference has been completed.

data/app/views/effective/applicant_references/edit.html.haml

@@ -1,8 +1,7 @@
-.card
-  .card-body
-    %p
-      Please provide a reference for the applicant
-      = succeed('.') do
-        %strong= @applicant_reference.applicant.owner
+= card do
+  %p
+    Please provide a reference for the applicant
+    = succeed('.') do
+      %strong= @applicant_reference.applicant.owner
 
-    = render('form_declaration', applicant_reference: @applicant_reference)
+  = render('form_declaration', applicant_reference: @applicant_reference)

data/app/views/effective/applicants/_applicant.html.haml

@@ -1,3 +1,4 @@
 .effective-applicant
   - applicant.render_steps.each do |partial|
-    = render "effective/applicants/#{partial}", applicant: applicant, step: partial
+    - applicant.render_step = partial
+    = render "effective/applicants/#{partial}", applicant: applicant