dm_event 4.2.1.5

data/app/models/dm_event/concerns/registration_state_email.rb

@@ -0,0 +1,80 @@
+# Extends the Registration model with a state machine
+#------------------------------------------------------------------------------
+module DmEvent
+  module Concerns
+    module RegistrationStateEmail
+      extend ActiveSupport::Concern
+      include DmUtilities::DateHelper
+      
+      # 'included do' causes the included code to be evaluated in the
+      # conext where it is included (post.rb), rather than be 
+      # executed in the module's context (blorgh/concerns/models/post).
+      #------------------------------------------------------------------------------
+      included do
+
+        #------------------------------------------------------------------------------
+        def to_liquid
+          result = {
+            'price'               => (workshop_price.nil? ? '' : workshop_price.price_formatted),
+            'receipt_code'        => receipt_code.to_s,
+            'price_description'   => "#{workshop_price.price_description unless workshop_price.nil?}",
+            'title'               => workshop.title,
+            'fullname'            => user_profile.full_name,
+            'payment_url'         => self.payment_url,
+            'balance'             => self.balance_owed.format,
+            'start_date'          => format_date(workshop.starting_on, true),
+            'end_date'            => format_date(workshop.ending_on, true),
+            'start_time'          => format_time(workshop.starting_on),
+            'end_time'            => format_time(workshop.ending_on),
+            'date_range'          => format_date_range(workshop.starting_on, workshop.ending_on)
+          }
+    
+          # TODO This is a security hole.  Any customer field data needs to be sanitized
+          # custom_fields.each do | x |
+          #   result[x.column_name] = x.data
+          # end
+    
+          return result
+        end
+
+        # Send an email for state notification.  if send_email is false, just return 
+        # the content of the email
+        #------------------------------------------------------------------------------
+        def email_state_notification(state = aasm.current_state.to_s, send_email = true)
+          I18n.with_locale(registered_locale) do
+            system_email = workshop.send("#{state}_email")
+            if system_email
+              receipt_content = compile_email(state, system_email)
+              if send_email
+                return RegistrationNotifyMailer.registration_notify(self, receipt_content[:content], receipt_content[:substitutions]).deliver_now
+              else 
+                return receipt_content[:content]
+              end
+            end
+          end
+        end
+
+        # Compile the email values
+        #------------------------------------------------------------------------------
+        def compile_email(state, system_email)
+          substitutions = {
+            'state'   => state.to_s,
+            'event'   => self.to_liquid
+          }
+          substitutions['payment_details'] = Liquid::Template.parse(workshop_price.payment_details).render(substitutions) unless workshop_price.try(:payment_details).blank?
+          substitutions['subject']         = Liquid::Template.parse(system_email.subject).render(substitutions)
+          
+          template  = Liquid::Template.parse(system_email.body)
+          content   = template.render(substitutions)
+          return {:content => content, :substitutions => substitutions}
+        end
+
+      end
+
+      #------------------------------------------------------------------------------
+      module ClassMethods
+      end
+
+    end
+  end
+end

data/app/models/dm_event/concerns/registration_state_machine.rb

@@ -0,0 +1,218 @@
+# Extends the Registration model with a state machine
+#------------------------------------------------------------------------------
+module DmEvent
+  module Concerns
+    module RegistrationStateMachine
+      extend ActiveSupport::Concern
+
+      # 'included do' causes the included code to be evaluated in the
+      # conext where it is included (post.rb), rather than be 
+      # executed in the module's context (blorgh/concerns/models/post).
+      #------------------------------------------------------------------------------
+      included do
+        include AASM
+
+        #--- define how the state machine works
+        aasm do
+          state :open,                :initial => true, :after_enter => Proc.new { |o| o.start! }
+          state :pending,             :after_enter => :state_pending
+          state :reviewing,           :after_enter => :state_reviewing
+          state :accepted,            :after_enter => :state_acceptance
+          state :rejected,            :after_enter => :state_rejection
+          state :paid,                :after_enter => :state_paid
+          state :waitlisted,          :after_enter => :state_waitlisted
+          state :canceled,            :after_enter => :state_canceled
+          state :refunded,            :after_enter => :state_refunded
+          state :noshow,              :after_enter => :state_noshow
+
+          #------------------------------------------------------------------------------
+          event :start do
+            transitions :from => :open,       :to => :waitlisted, :guard => Proc.new {|o| o.workshop.waitlisting?}   
+            transitions :from => :open,       :to => :pending,    :guard => Proc.new {|o| o.workshop.require_review?}   
+            transitions :from => :open,       :to => :accepted
+          end
+  
+          #------------------------------------------------------------------------------
+          event :review do
+            transitions :from => :pending,    :to => :reviewing
+            transitions :from => :accepted,   :to => :reviewing
+            transitions :from => :rejected,   :to => :reviewing
+            transitions :from => :waitlisted, :to => :reviewing
+            transitions :from => :canceled,   :to => :reviewing
+            transitions :from => :refunded,   :to => :reviewing
+            transitions :from => :noshow,     :to => :reviewing
+          end  
+    
+          #------------------------------------------------------------------------------
+          event :accept do
+            transitions :from => :pending,    :to => :accepted
+            transitions :from => :paid,       :to => :accepted
+            transitions :from => :reviewing,  :to => :accepted
+            transitions :from => :rejected,   :to => :accepted
+            transitions :from => :waitlisted, :to => :accepted
+            transitions :from => :canceled,   :to => :accepted
+            transitions :from => :refunded,   :to => :accepted
+            transitions :from => :noshow,     :to => :accepted
+          end  
+  
+          #------------------------------------------------------------------------------
+          event :paid do
+            transitions :from => :pending,    :to => :paid
+            transitions :from => :reviewing,  :to => :paid
+            transitions :from => :accepted,   :to => :paid
+            transitions :from => :paid,       :to => :paid
+            transitions :from => :rejected,   :to => :paid
+            transitions :from => :refunded,   :to => :paid
+            transitions :from => :noshow,     :to => :paid
+            transitions :from => :waitlisted, :to => :paid
+          end
+    
+          #------------------------------------------------------------------------------
+          event :refund do
+            transitions :from => :paid,       :to => :refunded
+            transitions :from => :canceled,   :to => :refunded
+            transitions :from => :accepted,   :to => :refunded
+            transitions :from => :pending,    :to => :refunded
+            transitions :from => :reviewing,  :to => :refunded
+            transitions :from => :waitlisted, :to => :refunded
+          end
+    
+          #------------------------------------------------------------------------------
+          event :reject do
+            transitions :from => :pending,    :to => :rejected
+            transitions :from => :reviewing,  :to => :rejected
+            transitions :from => :waitlisted, :to => :rejected
+            transitions :from => :canceled,   :to => :rejected
+          end
+
+          #------------------------------------------------------------------------------
+          event :cancellation do
+            transitions :from => :accepted,   :to => :canceled
+            transitions :from => :pending,    :to => :canceled
+            transitions :from => :reviewing,  :to => :canceled
+            transitions :from => :paid,       :to => :canceled
+            transitions :from => :waitlisted, :to => :canceled
+            transitions :from => :rejected,   :to => :canceled
+            transitions :from => :noshow,     :to => :canceled
+          end
+
+          #------------------------------------------------------------------------------
+          event :waitlist do
+            transitions :from => :pending,    :to => :waitlisted
+            transitions :from => :reviewing,  :to => :waitlisted
+            transitions :from => :rejected,   :to => :waitlisted
+            transitions :from => :accepted,   :to => :waitlisted
+            transitions :from => :canceled,   :to => :waitlisted
+            transitions :from => :paid,       :to => :waitlisted
+          end
+
+          #------------------------------------------------------------------------------
+          event :noshow do
+            transitions :from => :pending,    :to => :noshow
+            transitions :from => :reviewing,  :to => :noshow
+            transitions :from => :accepted,   :to => :noshow
+            transitions :from => :rejected,   :to => :noshow
+            transitions :from => :paid,       :to => :noshow
+            transitions :from => :canceled,   :to => :noshow
+            transitions :from => :waitlisted, :to => :noshow
+            transitions :from => :refunded,   :to => :noshow
+          end
+
+          #------------------------------------------------------------------------------
+          event :pending do
+            transitions :from => :reviewing,  :to => :pending
+            transitions :from => :waitlisted, :to => :pending
+          end
+
+        end
+        
+        #------------------------------------------------------------------------------
+        def current_state
+          aasm.current_state
+        end
+        
+        # send the email if it's defined
+        #------------------------------------------------------------------------------
+        def state_pending
+          update_state_date
+          email_state_notification(:pending)
+        end
+
+        #------------------------------------------------------------------------------
+        def state_reviewing
+          update_state_date
+        end
+
+        # send the email if it's defined
+        #------------------------------------------------------------------------------
+        def state_acceptance
+          update_state_date
+          email_state_notification(:accepted) unless @suppress_transition_email
+        end
+
+        # send the email if it's defined
+        #------------------------------------------------------------------------------
+        def state_rejection
+          update_state_date
+          email_state_notification(:rejected)
+        end
+
+        # send the email if it's defined
+        #------------------------------------------------------------------------------
+        def state_paid
+          update_state_date
+          email_state_notification(:paid)
+        end
+
+        # send the email if it's defined
+        #------------------------------------------------------------------------------
+        def state_waitlisted
+          update_state_date
+          email_state_notification(:waitlisted)
+        end
+
+        #------------------------------------------------------------------------------
+        def state_canceled
+          update_state_date
+        end
+
+        #------------------------------------------------------------------------------
+        def state_refunded
+          update_state_date
+        end
+
+        #------------------------------------------------------------------------------
+        def state_noshow
+          update_state_date
+        end
+        
+        #------------------------------------------------------------------------------
+        def update_state_date
+          update_attribute(:process_changed_on, Time.now)
+        end
+        
+        #------------------------------------------------------------------------------
+        def attending?
+          aasm_state == 'accepted' || aasm_state == 'paid'
+        end
+  
+        # return true if they have registered
+        #------------------------------------------------------------------------------
+        def registered?
+          aasm_state == 'pending' || aasm_state == 'waitlisted' || attending?
+        end
+
+        # don't send a the notification email during a state transition
+        #------------------------------------------------------------------------------
+        def suppress_transition_email
+          @suppress_transition_email = true
+        end
+      end
+
+      #------------------------------------------------------------------------------
+      module ClassMethods
+      end
+
+    end
+  end
+end

data/app/models/dm_event/concerns/user_profile.rb

@@ -0,0 +1,20 @@
+# Extends the User model with hooks for the Event engine
+#------------------------------------------------------------------------------
+module DmEvent
+  module Concerns
+    module UserProfile
+      extend ActiveSupport::Concern
+
+      included do
+
+        has_many   :registrations
+        
+      end
+
+      #------------------------------------------------------------------------------
+      module ClassMethods
+      end
+
+    end
+  end
+end

data/app/models/dm_event/model_decorators.rb

@@ -0,0 +1,6 @@
+# Decorate any models
+# Chose to use this method for now, instead of creating a decorator folder and
+# eager-loading it.  Prefer to keep the logic in the model folder.
+#------------------------------------------------------------------------------
+
+UserProfile.send(:include, DmEvent::Concerns::UserProfile)

data/app/models/dm_event/permitted_params.rb

@@ -0,0 +1,35 @@
+module DmEvent
+  module PermittedParams
+
+    #------------------------------------------------------------------------------
+    def workshop_params
+      params.require(:workshop).permit! if can? :manage_events, :all
+    end
+
+    #------------------------------------------------------------------------------
+    def workshop_price_params
+      params.require(:workshop_price).permit! if can? :manage_events, :all
+    end
+
+    #------------------------------------------------------------------------------
+    def registration_params
+      return nil if params[:registration].nil? || params[:registration].empty?
+      if can? :manage_events, :all
+        params.require(:registration).permit!
+      else
+        # nested attributes: because field_data can be either a single value or an array of values,
+        # we include it twice in the permit, once as a normal param, and again as a param with data.
+        # sample data:
+        #  {"workshop_price_id"=>"72", "custom_fields_attributes"=>{"0"=>{"field_data"=>"234", "custom_field_def_id"=>"8"}, 
+        #    "1"=>{"field_data"=>["eee", ""], "custom_field_def_id"=>"16"}}}
+        params.require(:registration).permit(:workshop_price_id, custom_fields_attributes: [:field_data, {:field_data => []}, :custom_field_def_id])
+      end
+    end
+
+    #------------------------------------------------------------------------------
+    def system_email_params
+      params.require(:system_email).permit! if can? :manage_events, :all
+    end
+    
+  end
+end

data/app/models/payment.rb

@@ -0,0 +1,48 @@
+# Handle payment related logic
+#------------------------------------------------------------------------------
+class Payment
+  include ActiveMerchant::Billing::Integrations
+
+  # Handle Payment notification logic
+  #------------------------------------------------------------------------------
+  def self.event_payment_ipn(notify, payment_method = '')
+    Rails.logger.error('===> Enter: Payment.event_payment_ipn')
+    Rails.logger.error(notify.inspect)
+    registration = Registration.find_by_receipt_code(notify.item_id)
+    
+    if notify.acknowledge
+      if registration
+        Rails.logger.error(registration.inspect)
+        payment_history = PaymentHistory.find_by_transaction_id(notify.transaction_id) ||
+                            registration.manual_payment( nil,
+                                          notify.amount.to_f.to_s,
+                                          notify.currency,
+                                          nil,
+                                          payment_method: payment_method,
+                                          payment_date: notify.received_at,
+                                          notify_data: notify,
+                                          transaction_id: notify.transaction_id,
+                                          status: notify.status
+                      )
+          Rails.logger.error(payment_history.inspect)
+        begin
+          if notify.complete?
+            payment_history.status = notify.status
+          else
+            # TODO need to handle refunding, etc
+            Rails.logger.error("Failed to verify #{payment_method} payment notification, please investigate")
+          end
+        rescue => e
+          payment_history.status = 'Error'
+          raise
+        ensure
+          payment_history.save
+        end
+      else
+        #--- [todo] a linked registration was not found.  Should be stored in payment table anyway
+        Rails.logger.error("   > Error: Registration was not found: #{notify.item_id}")
+      end
+    end
+  end
+
+end