ffcrm_cloudfuji 0.2.1 → 0.2.2

data/app/assets/javascripts/event_rules.js.coffee

@@ -0,0 +1,55 @@
+(($) ->
+  class @EventRules
+    constructor: (@templates = {}) ->
+
+    add_fields: (button, content) ->
+      new_id = new Date().getTime()
+      regexp = new RegExp('new_event_rule', 'g')
+      $('ul#event_rules').append(content.replace(regexp, new_id))
+      # Setup event autocomplete for new field
+      this.cloudfuji_event_autocomplete('input#event_rules_'+new_id+'_cloudfuji_event')
+
+    remove_fields: (button) ->
+      container = $(button).closest('li.event_rule')
+      index = container.data('index')
+      # If rule has no id, just remove
+      if $("#event_rules_"+index+"_id").length == 0
+        container.remove()
+      else
+        # If rule has an id, mark container as hidden and add _destroy field
+        container.hide()
+        container.append($('<input type="text" name="event_rules['+index+'][_destroy]" value="yes">'))
+
+    cloudfuji_event_autocomplete: (selector = 'input.cloudfuji_event') ->
+      $(selector).autocomplete({source: observed_cloudfuji_events, minLength: 0})
+      # Show all events on focus, if input is empty
+      $(selector).focus ->
+        $(this).autocomplete "search", "" if $(this).val() == ""
+
+    show_field_group: (select, group_name, key) ->
+      # Hide all fields, then show the selected field group
+      container = $(select).closest('li.event_rule')
+      container.find('.'+group_name+'_fields').hide()
+      container.find('.'+group_name+'_'+key).show()
+
+  $(document).ready ->
+    event_rules = new EventRules()
+    # Initialize autocomplete for events
+    event_rules.cloudfuji_event_autocomplete()
+
+    $("button.add_event_rule").live "click", ->
+      event_rules.add_fields this, $(this).data("content")
+      false
+
+    $(".remove_event_rule").live "click", ->
+      event_rules.remove_fields this
+      false
+
+    $('.event_category_select').live "change", ->
+      event_rules.show_field_group this, 'event_category', $(this).val()
+
+    $('.action_select').live "change", ->
+      event_rules.show_field_group this, 'action', $(this).val()
+
+
+) jQuery

data/app/assets/javascripts/ffcrm_cloudfuji.js

@@ -1 +1 @@
-//= require lead_scoring
+//= require event_rules

data/app/assets/stylesheets/event_rules.css.scss

@@ -0,0 +1,53 @@
+ul#event_rules {
+  div { display: inline; }
+
+  li.event_rule {
+    font-size: 13px;
+
+    &:last-child {
+      border-bottom: none;
+    }
+
+    input {
+      font-size: 13px;
+      margin: 0 4px;
+      vertical-align: middle;
+      margin-bottom: 3px;
+    }
+    .cloudfuji_event { width: 120px; }
+    .match_input { width: 140px; }
+    .numeric_input { width: 35px; }
+    .tag_input { width: 100px; }
+    input[type='checkbox'] {
+      width: 14px;
+      margin-left: 2px;
+    }
+
+    .field_with_errors {
+      display: inline;
+      input, select {
+        background-color: #ffdddd;
+      }
+      select {
+        border: 2px solid #ff9999;
+      }
+    }
+  }
+
+  a.remove_event_rule {
+    margin-right: 6px;
+    img {
+      vertical-align: middle;
+      margin-bottom: 4px;
+    }
+  }
+}
+
+.buttonbar.event_rules_buttons {
+  width: 1155px;
+  float: left;
+  font-size: 13px;
+  input[type='submit'], button { font-size: 14px; }
+  .save_or_cancel { float: right; }
+  button { float: left; }
+}

data/app/assets/stylesheets/ffcrm_cloudfuji.css

@@ -1,3 +1,3 @@
 /*
- *= require lead_scoring
+ *= require event_rules
  */

data/app/controllers/admin/{lead_scoring_controller.rb → event_rules_controller.rb}

@@ -1,41 +1,41 @@
-class Admin::LeadScoringController < Admin::ApplicationController
+class Admin::EventRulesController < Admin::ApplicationController
   before_filter :require_user
-  before_filter "set_current_tab('admin/lead_scoring')", :only => [ :index, :update ]
+  before_filter "set_current_tab('admin/event_rules')", :only => [ :index, :update ]
 
-  # GET /admin/lead_scoring
+  # GET /admin/event_rules
   #----------------------------------------------------------------------------
   def index
-    @lead_scoring_rules = LeadScoringRule.all
-    @lead_scoring_rules << LeadScoringRule.new if @lead_scoring_rules.empty?
+    @event_rules = EventRule.all
+    @event_rules << EventRule.new if @event_rules.empty?
 
     respond_to do |format|
       format.html # index.html.haml
     end
   end
 
-  # PUT /admin/lead_scoring
+  # PUT /admin/event_rules
   #----------------------------------------------------------------------------
   def update
     # Create rules without ids,
     # destroy rules with '_destroy' param,
     # update rules with ids
-    @lead_scoring_rules = []
-    params[:lead_scoring_rules].each do |index, data|
+    @event_rules = []
+    params[:event_rules].each do |index, data|
       if data["id"].blank?
-        @lead_scoring_rules << LeadScoringRule.create(data)
+        @event_rules << EventRule.create(data)
       else
-        if rule = LeadScoringRule.find_by_id(data["id"])
+        if rule = EventRule.find_by_id(data["id"])
           if data["_destroy"]
             rule.destroy
           else
             rule.update_attributes data
-            @lead_scoring_rules << rule
+            @event_rules << rule
           end
         end
       end
     end
 
-    if @lead_scoring_rules.all?(&:valid?)
+    if @event_rules.all?(&:valid?)
       flash[:notice] = "All rules were saved successfully."
     else
       flash[:error] = render_to_string(:partial => "errors").html_safe

data/app/helpers/admin/event_rules_helper.rb

@@ -0,0 +1,47 @@
+module Admin::EventRulesHelper
+
+  def add_event_rule_button(f)
+    fields = f.fields_for "new_event_rule", EventRule.new do |builder|
+      render("form", :r => builder, :index => "new_event_rule")
+    end
+    button_tag 'Add New Rule', :class => "add_event_rule", "data-content" => "#{fields}"
+  end
+
+  def event_category_select(form)
+    form.select :event_category, [
+      ["Cloudfuji event", :cloudfuji_event_received],
+      ["Lead attribute",   :lead_attribute_changed]
+    ], {}, :class => "event_category_select"
+  end
+
+  def action_select(form)
+    form.select :action, [
+      ["change Lead score", :change_lead_score],
+      ["send notification", :send_notification],
+      ["add tag",           :add_tag],
+      ["remove tag",        :remove_tag]
+    ], {}, :class => "action_select"
+  end
+
+  # Generates divs with form field groups for event rules
+  def fields_for_event_rule_group(object, subjects, field)
+    subjects = [subjects].flatten
+    content_tag(:div, :class => subjects.map {|s| "#{field}_#{s}" }.join(" ") << " #{field}_fields",
+                      :style => (subjects.none? {|s| s == object.send(field) } ? "display: none;" : "")) do
+      yield
+    end
+  end
+
+  def event_fields_for(object, events, &content)
+    fields_for_event_rule_group(object, events, 'event_category', &content)
+  end
+
+  def action_fields_for(object, actions, &content)
+    fields_for_event_rule_group(object, actions, 'action', &content)
+  end
+
+  def lead_attributes
+    Lead.attribute_names - %w(id deleted_at updated_at created_at)
+  end
+
+end

data/app/models/event_rule.rb

@@ -0,0 +1,112 @@
+class EventRule < ActiveRecord::Base
+  
+  # event category validations
+  validates_presence_of :event_category
+  validates_presence_of :cloudfuji_event, :if => lambda { self.event_category == 'cloudfuji_event_received' }
+  validates_presence_of :lead_attribute,  :if => lambda { self.event_category == 'lead_attribute_changed' }
+
+  # action validations
+  validates_presence_of :action
+  validates_presence_of :tag, :if => lambda { %w(add_tag remove_tag).include?(self.action) }
+  validates_numericality_of :change_score_by, :only_integer => true, :if => lambda { self.action == 'change_lead_score' }
+
+  validates_numericality_of :limit_per_lead,  :only_integer => true, :allow_blank => true
+
+  has_many :lead_event_rule_counts
+  
+  def process(lead, match_data)
+    # How many times this rule has been applied to a given Lead
+    count = LeadEventRuleCount.find_by_lead_id_and_event_rule_id(lead, self) ||
+            LeadEventRuleCount.new(:lead => lead, :event_rule => self)
+    # Don't apply this rule more than limit_per_lead, if set
+    unless limit_per_lead.present? && count.count > limit_per_lead
+      # If :match is present, only apply the rule if data matches string
+      if match.blank? || event_matches?(match_data)
+        # Run the action method if defined
+        if respond_to?(action)
+          send(action, lead, match_data)
+          # Increment and save count of rule/lead applications
+          count.count += 1
+          count.save
+        else
+          raise "Do not know how to process '#{action}' action."
+        end
+      end
+    end
+  end
+  
+  # Actions
+  # -----------------------------------------------------------------
+  def change_lead_score(lead, match_data)
+    lead.without_versioning do
+      lead.update_attribute :score, lead.score + change_score_by
+    end
+    # Add history event to lead, to record change of score
+    lead.versions.create! :event => "Rule for #{human_event_label}: Score changed by #{change_score_by} points. (New total: #{lead.score})"
+  end
+  
+  def send_notification(lead, match_data)
+    if ::Cloudfuji::Platform.on_cloudfuji?
+      # Fire a Cloudfuji event
+      message = case event_category
+      when 'cloudfuji_event_received'
+        "Cloudfuji event was received - '#{cloudfuji_event}'"
+      when 'lead_attribute_changed'
+        "Lead \"#{lead.full_name}\" was updated - #{lead_attribute} was changed from '#{match_data[0]}' to '#{match_data[1]}'."
+      end
+      
+      event = {
+        :category => :fat_free_crm,
+        :name     => :notification,
+        :data     => {
+          :message  => message
+        }
+      }
+      ::Cloudfuji::Event.publish(event)
+    end
+  end
+  
+  def add_tag(lead, match_data)
+    lead.tag_list << tag
+    save_lead_without_versioning_or_observers(lead)
+    lead.versions.create! :event => "Rule for #{human_event_label}: Added tag '#{tag}'"
+  end
+  
+  def remove_tag(lead, match_data)
+    lead.tag_list -= [tag]
+    save_lead_without_versioning_or_observers(lead)
+    lead.versions.create! :event => "Rule for #{human_event_label}: Removed tag '#{tag}'"
+  end
+  
+  
+  private
+  
+  def event_matches?(match_data)
+    test_string = case_insensitive_matching ? match.downcase : match
+    case event_category
+    when 'cloudfuji_event_received'
+      match_string = match_data.inspect
+      match_string.downcase! if case_insensitive_matching
+      match_string.include?(test_string) 
+    when 'lead_attribute_changed'
+      match_string = match_data[1].dup
+      match_string.downcase! if case_insensitive_matching
+      match_string == test_string
+    end
+  end
+  
+  def human_event_label
+    case event_category
+    when 'cloudfuji_event_received'; "Cloudfuji event - '#{cloudfuji_event}'"
+    when 'lead_attribute_changed';   "Lead update - '#{lead_attribute}'"
+    end
+  end
+  
+  def save_lead_without_versioning_or_observers(lead)
+    Lead.observers.disable :cloudfuji_lead_observer do
+      lead.without_versioning do
+        lead.save
+      end
+    end
+  end
+end

data/app/models/lead_event_rule_count.rb

@@ -0,0 +1,4 @@
+class LeadEventRuleCount < ActiveRecord::Base
+  belongs_to :lead
+  belongs_to :event_rule
+end

data/app/observers/cloudfuji_lead_observer.rb

@@ -0,0 +1,27 @@
+# Fat Free CRM
+# Copyright (C) 2008-2011 by Michael Dvorkin
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#------------------------------------------------------------------------------
+
+class CloudfujiLeadObserver < ActiveRecord::Observer
+  observe :lead
+
+  def after_update(lead)
+    # Find all event rules where the lead attribute is one of the changed fields
+    EventRule.find_all_by_event_category_and_lead_attribute('lead_attribute_changed', lead.changes.keys).each do |rule|
+      rule.process(lead, lead.changes[rule.lead_attribute])  # Send [old, new] values as matching data
+    end
+  end
+end

data/app/views/admin/{lead_scoring → event_rules}/_errors.html.haml

@@ -1,4 +1,4 @@
-- invalid_rules = @lead_scoring_rules.select{|r| r.errors.any? }
+- invalid_rules = @event_rules.select{|r| r.errors.any? }
 - if invalid_rules.any?
   There were (#{invalid_rules.size}) invalid rules:
   %br

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

@@ -0,0 +1,39 @@
+%li.event_rule{"data-index" => index}
+  = link_to image_tag('delete.png', :size => '16x16', :alt => 'Remove Rule'), nil, :class => "remove_event_rule"
+
+  = r.hidden_field(:id) unless r.object.new_record?
+
+  If
+  = event_category_select(r)
+
+  = event_fields_for(r.object, 'cloudfuji_event_received') do
+    = r.text_field :cloudfuji_event, :class => "cloudfuji_event"
+    is received, and contains
+
+  = event_fields_for(r.object, 'lead_attribute_changed') do
+    = r.select :lead_attribute, lead_attributes, :class => "lead_attribute", :include_blank => true
+    changes, and equals
+
+  = content_tag(:small, "(optional)") << ":".html_safe
+  = r.text_field :match, :class => "match_input"
+
+  %small
+    (Case insensitive?
+    = r.check_box(:case_insensitive_matching) << h(")")
+
+  then
+  = action_select(r)
+
+  = action_fields_for(r.object, 'change_lead_score') do
+    by
+    = r.text_field :change_score_by, :class => "numeric_input"
+    points.
+
+  -# Add/Remove tag actions share the same field
+  = action_fields_for(r.object, %w(add_tag remove_tag)) do
+    = r.text_field :tag, :class => "tag_input"
+
+  = action_fields_for(r.object, %w(change_lead_score send_notification)) do
+    %small
+      (Limit per lead:
+      = r.text_field(:limit_per_lead, :class => "numeric_input") << h(")")

data/app/views/admin/{lead_scoring → event_rules}/index.html.haml

@@ -2,18 +2,18 @@
   var observed_cloudfuji_events = #{Cloudfuji::Data.observed_events.map(&:to_s).inspect};
 
 .title
-  Lead Scoring
+  Event Rules
 
 .list
-  = form_for :lead_scoring_rules do |f|
-    %ul#lead_scoring_rules
-      - @lead_scoring_rules.each_with_index do |rule, i|
+  = form_for :event_rules do |f|
+    %ul#event_rules
+      - @event_rules.each_with_index do |rule, i|
         = f.fields_for i.to_s, rule do |r|
           = render "form", :r => r, :index => i
 
-    .buttonbar.lead_scoring_buttons
-      = add_lead_scoring_rule_button(f)
+    .buttonbar.event_rules_buttons
+      = add_event_rule_button(f)
       .save_or_cancel
         = submit_tag 'Save', :name => :save
         #{t :or}
-        = link_to "Cancel", admin_lead_scoring_index_path
+        = link_to "Cancel", admin_event_rules_path

data/app/views/leads/_sidebar_show_lead_scoring.html.haml

@@ -1,8 +1,8 @@
-.caption Lead Scoring
+.caption Event Rules
 %li
   %dt= lead.score
   %tt Score:
-- if lead.respond_to?(:lead_scoring_rule_counts) && lead.lead_scoring_rule_counts.any?
+- if lead.respond_to?(:lead_event_rule_counts) && lead.lead_event_rule_counts.any?
   %li
-    %dt= lead.lead_scoring_rule_counts.sum {|c| c.count }
+    %dt= lead.lead_event_rule_counts.sum {|c| c.count }
     %tt Total scoring events:

data/config/locales/en-US.yml

@@ -0,0 +1,5 @@
+"en-US":
+  activerecord:
+    attributes:
+      event_rule:
+        change_score_by: "Points"

data/config/routes.rb

@@ -16,7 +16,7 @@ Rails.application.routes.draw do
   end
 
   namespace :admin do
-    resources :lead_scoring, :only => :index do
+    resources :event_rules, :only => :index do
       post :update, :on => :collection
     end
   end

data/db/migrate/20120524031157_extend_lead_scoring_as_event_rules.rb

@@ -0,0 +1,54 @@
+class ExtendLeadScoringAsEventRules < ActiveRecord::Migration
+  def up
+    # Save current values of boolean :once column
+    once_values = connection.select_all("SELECT id,once from lead_scoring_rules;")
+
+    rename_table  :lead_scoring_rules, :event_rules
+
+    rename_table  :lead_scoring_rule_counts, :lead_event_rule_counts
+    rename_column :lead_event_rule_counts, :lead_scoring_rule_id, :event_rule_id
+
+    add_column    :event_rules, :event_category, :string, :default => 'cloudfuji_event_received'
+
+    # Columns for cloudfuji event matching
+    rename_column :event_rules, :event, :cloudfuji_event
+
+    # Columns for lead column changes
+    add_column    :event_rules, :lead_attribute, :string
+
+    # Columns for actions
+    add_column    :event_rules, :action, :string, :default => 'change_lead_score'
+    add_column    :event_rules, :tag, :string
+    rename_column :event_rules, :points, :change_score_by
+
+    remove_column :event_rules, :once
+    add_column    :event_rules, :limit_per_lead, :integer
+    add_column    :event_rules, :case_insensitive_matching, :boolean
+
+    # Migrate :once values to :limit_times & :max_times
+    ids = once_values.select{|v| v['once'] == 't' }.map {|v| v['id'] }
+    if ids.any?
+      connection.execute("UPDATE event_rules SET limit_times = 1, max_times = 1 WHERE id IN (#{ids.join(',')});")
+    end
+
+  end
+
+  # Instead of meticulously mirroring the reverse of all these changes,
+  # just drop the tables and re-create the tables from the previous migration.
+  def down
+    # Remove tables
+    drop_table :event_rules
+    drop_table :lead_event_rule_counts
+    # Load previous migration
+    require File.expand_path('../20120515194445_add_lead_scoring_rules.rb', __FILE__)
+    migration = AddLeadScoringRules.new
+    # Only create tables (don't re-add columns to app tables)
+    migration.class_eval do
+      def add_column(table, column, type, options)
+        puts "-- not re-adding '#{column}' column to '#{table}' table."
+      end
+    end
+    # Run migration
+    migration.up
+  end
+end

data/db/migrate/20120525151511_add_ido_id_to_lead.rb

@@ -0,0 +1,5 @@
+class AddIdoIdToLead < ActiveRecord::Migration
+  def change
+    add_column :leads, :ido_id, :text
+  end
+end

data/lib/fat_free_crm/cloudfuji/event_observers/customer_observer.rb

@@ -42,10 +42,12 @@ module FatFreeCRM
             return result if result
           end
 
-          lead = Lead.find_by_email(data['email']) || Lead.new
+          lead   = Lead.find_by_ido_id(data['customer_ido_id'])
+          lead ||= Lead.find_by_email(data['email'])
           lead ||= Lead.new
 
           lead.email      = data['email']
+          lead.ido_id     = data['customer_ido_id']
           lead.first_name = data['first_name'] || data['email'].split("@").first if lead.first_name.blank?
           lead.last_name  = data['last_name']  || data['email'].split("@").last  if lead.last_name.blank?
           lead.user       ||= User.first

data/lib/fat_free_crm/cloudfuji/event_observers/email_observer.rb

@@ -79,10 +79,12 @@ module FatFreeCRM
           end
 
           puts "No pre-existing records found, creating a lead"
-          lead   = Lead.find_by_email(recipient)
+          lead   = Lead.find_by_ido_id(data['customer_ido_id'])
+          lead ||= Lead.find_by_email(recipient)
           lead ||= Lead.new
 
-          lead.email = recipient
+          lead.email      = recipient
+          lead.ido_id     = data['customer_ido_id']
           lead.first_name = recipient.split("@").first if lead.first_name.blank?
           lead.last_name  = recipient.split("@").last  if lead.last_name.blank?
           lead.user       ||= User.first

data/lib/fat_free_crm/cloudfuji/event_observers/event_rules_observer.rb

@@ -0,0 +1,23 @@
+module FatFreeCRM
+  module Cloudfuji
+    module EventObservers
+      class EventRulesObserver < ::Cloudfuji::EventObserver
+        # Fire for all events
+        def catch_all
+          data  = params['data']
+          email = data['email'] || data['recipient']
+          # Look up Lead by ido_id, fall back to email address
+          lead = Lead.find_by_ido_id(data['customer_ido_id'])
+          if lead ||= Lead.find_by_email(email)
+            event_name = "#{params['category']}_#{params['event']}"
+
+            EventRule.find_all_by_event_category_and_cloudfuji_event('cloudfuji_event_received', event_name).each do |rule|
+              rule.process(lead, params['data'])
+            end
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/fat_free_crm/cloudfuji/event_observers/user_observer.rb

@@ -3,20 +3,21 @@ module FatFreeCRM
     module EventObservers
       class UserObserver < ::Cloudfuji::EventObserver
         def user_added
+          data = params['data']
+          ido_id = data['ido_id'].to_s
+
           puts "Adding a new user with incoming data #{params.inspect}"
           puts "Authlogic username column: #{::Authlogic::Cas.cas_username_column}="
-          puts "Setting username to: #{params['data'].try(:[], 'ido_id')}"
-
-          data = params['data']
+          puts "Setting username to: #{ido_id}"
 
-          user = User.unscoped.find_or_create_by_ido_id(data['ido_id'])
+          user = User.unscoped.find_or_create_by_ido_id(ido_id)
 
           user.email      = data['email']
           user.first_name = user.email.split('@').first
           user.last_name  = user.email.split('@').last
           user.username   = data['email']
           user.deleted_at = nil
-          user.send("#{::Authlogic::Cas.cas_username_column}=".to_sym, data.try(:[], 'ido_id'))
+          user.send("#{::Authlogic::Cas.cas_username_column}=".to_sym, ido_id)
 
           puts user.inspect
 

data/lib/fat_free_crm/cloudfuji.rb

@@ -37,7 +37,7 @@ module FatFreeCRM
       def extend_lead!
         puts "Extending the Lead model"
         Lead.instance_eval do
-          has_many :lead_scoring_rule_counts
+          has_many :lead_event_rule_counts
         end
       end
 

data/lib/ffcrm_cloudfuji/engine.rb

@@ -1,15 +1,20 @@
 module FatFreeCRM
   module Cloudfuji
     class Engine < Rails::Engine
+      config.before_initialize do
+        # Register observers to fire Cloudfuji events
+        (config.active_record.observers ||= []) << :cloudfuji_lead_observer
+      end
+    
       config.to_prepare do
         require 'fat_free_crm/cloudfuji/view_hooks'
 
-        # Add Lead Scoring tab
+        # Add Event Rules tab
         begin
-          unless FatFreeCRM::Tabs.admin.any? {|t| t[:text] == "Lead Scoring" }
+          unless FatFreeCRM::Tabs.admin.any? {|t| t[:text] == "Event Rules" }
             FatFreeCRM::Tabs.admin << {
-            :text => "Lead Scoring",
-            :url => { :controller => "admin/lead_scoring" }
+            :text => "Event Rules",
+            :url => { :controller => "admin/event_rules" }
           }
           end
         rescue TypeError

data/lib/ffcrm_cloudfuji/version.rb

@@ -1,5 +1,5 @@
 module FatFreeCRM
   module Cloudfuji
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end