ffcrm_cloudfuji 0.2.1 → 0.2.2

data/spec/event_observers/event_rules_observer_spec.rb

@@ -0,0 +1,103 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+include FatFreeCRM::Cloudfuji::EventObservers
+
+describe EventRulesObserver do
+  before do
+    @observer = EventRulesObserver.new
+    @observer.params = {
+      'category' => 'customer',
+      'event'    => 'had_tea',
+      "data" => {
+        "email" => "test_lead@example.com",
+        "type_of_tea" => "Jasmine"
+      }
+    }
+  end
+
+  def find_rule_count(lead, rule)
+    LeadEventRuleCount.find_by_lead_id_and_event_rule_id(lead, rule)
+  end
+
+  describe 'Cloudfuji event received' do
+    describe 'Lead scoring' do
+
+      it "should increment a lead's score when an event is fired" do
+        user = FactoryGirl.create(:user, :ido_id => "1234")
+        @lead = FactoryGirl.create(:lead, :email => 'test_lead@example.com', :user => user, :campaign => nil)
+
+        @rule = FactoryGirl.create :event_rule,
+                                   :event_category  => "cloudfuji_event_received",
+                                   :cloudfuji_event => "customer_had_tea",
+                                   :action          => "change_lead_score",
+                                   :change_score_by => 20
+
+        @observer.catch_all
+        @lead.reload
+        @lead.versions.last.event.should include("Rule for Cloudfuji event - 'customer_had_tea': Score changed by 20 points")
+        @lead.score.should == 20
+        find_rule_count(@lead, @rule).count.should == 1
+
+        # Should increment score twice
+        @observer.catch_all
+        @lead.reload
+        @lead.score.should == 40
+        find_rule_count(@lead, @rule).count.should == 2
+      end
+
+      it "should increment a lead's score only when matching data is present" do
+        user = FactoryGirl.create(:user, :ido_id => "1234")
+        @lead = FactoryGirl.create(:lead, :email => 'test_lead@example.com', :user => user, :campaign => nil)
+
+        @rule = FactoryGirl.create :event_rule,
+                                   :event_category  => "cloudfuji_event_received",
+                                   :cloudfuji_event => "customer_had_tea",
+                                   :action          => "change_lead_score",
+                                   :change_score_by => 15,
+                                   :match  => "Russian Earl Grey"
+
+        @observer.catch_all
+        @lead.reload
+        @lead.score.should == 0
+        # No LeadEventRuleCount should be created yet
+        find_rule_count(@lead, @rule).should == nil
+
+        @observer.params['data']['type_of_tea'] = "Russian Earl Grey"
+        @observer.catch_all
+
+        @lead.reload
+        @lead.score.should == 15
+        find_rule_count(@lead, @rule).count.should == 1
+      end
+
+      it "should not decrement a lead's score three times if the rule should only be applied twice" do
+        user = FactoryGirl.create(:user, :ido_id => "1234")
+        @lead = FactoryGirl.create(:lead, :email => 'test_lead@example.com', :user => user, :campaign => nil)
+
+        @rule = FactoryGirl.create :event_rule,
+                                   :event_category  => "cloudfuji_event_received",
+                                   :cloudfuji_event => "customer_had_tea",
+                                   :action          => "change_lead_score",
+                                   :change_score_by => -10,
+                                   :limit_per_lead  => 1
+
+        test_score = 0
+        2.times do |i|
+          test_score += -10
+          @observer.catch_all
+          @lead.reload
+          
+          @lead.versions.last.event.should == "Rule for Cloudfuji event - 'customer_had_tea': Score changed by -10 points. (New total: #{test_score})"
+          @lead.score.should == test_score
+          find_rule_count(@lead, @rule).count.should == i + 1
+        end
+
+        # Should only decrement score twice
+        @observer.catch_all
+        @lead.reload
+        @lead.score.should == -20
+        find_rule_count(@lead, @rule).count.should == 2
+      end
+    end
+  end
+end

data/spec/factories/lead_scoring_factories.rb

@@ -1,9 +1,15 @@
 FactoryGirl.define do
-  factory :lead_scoring_rule do
-    event {
+  factory :event_rule do
+    event_category { %w(cloudfuji_event_received lead_attribute_changed).sample }
+
+    cloudfuji_event {
       %w(customer email app user).sample << "_" <<
       %w(partied danced backflipped moonwalked).sample
     }
-    points { rand(100) }
+    lead_attribute {  %w(username score first_name last_name).sample }
+    
+    action { %w(add_tag remove_tag change_lead_score send_notification).sample }
+    tag { 'EventTag' }
+    change_score_by { rand(100) }
   end
 end

data/spec/internal/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20120515194445) do
+ActiveRecord::Schema.define(:version => 20120525151511) do
 
   create_table "account_contacts", :force => true do |t|
     t.integer  "account_id"
@@ -196,6 +196,20 @@ ActiveRecord::Schema.define(:version => 20120515194445) do
 
   add_index "emails", ["mediator_id", "mediator_type"], :name => "index_emails_on_mediator_id_and_mediator_type"
 
+  create_table "event_rules", :force => true do |t|
+    t.string   "cloudfuji_event"
+    t.string   "match"
+    t.integer  "change_score_by",           :default => 0
+    t.datetime "created_at",                                                        :null => false
+    t.datetime "updated_at",                                                        :null => false
+    t.string   "event_category",            :default => "cloudfuji_event_received"
+    t.string   "lead_attribute"
+    t.string   "action",                    :default => "change_lead_score"
+    t.string   "tag"
+    t.integer  "limit_per_lead"
+    t.boolean  "case_insensitive_matching"
+  end
+
   create_table "field_groups", :force => true do |t|
     t.string   "name",       :limit => 64
     t.string   "label",      :limit => 128
@@ -227,19 +241,10 @@ ActiveRecord::Schema.define(:version => 20120515194445) do
   add_index "fields", ["field_group_id"], :name => "index_fields_on_field_group_id"
   add_index "fields", ["name"], :name => "index_fields_on_name"
 
-  create_table "lead_scoring_rule_counts", :force => true do |t|
+  create_table "lead_event_rule_counts", :force => true do |t|
     t.integer "lead_id"
-    t.integer "lead_scoring_rule_id"
-    t.integer "count",                :default => 0
-  end
-
-  create_table "lead_scoring_rules", :force => true do |t|
-    t.string   "event"
-    t.string   "match"
-    t.integer  "points",     :default => 0
-    t.boolean  "once"
-    t.datetime "created_at",                :null => false
-    t.datetime "updated_at",                :null => false
+    t.integer "event_rule_id"
+    t.integer "count",         :default => 0
   end
 
   create_table "leads", :force => true do |t|
@@ -271,6 +276,7 @@ ActiveRecord::Schema.define(:version => 20120515194445) do
     t.string   "skype",            :limit => 128
     t.text     "subscribed_users"
     t.integer  "score",                           :default => 0
+    t.text     "ido_id"
   end
 
   add_index "leads", ["assigned_to"], :name => "index_leads_on_assigned_to"

data/spec/models/event_rule_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe EventRule do
+  describe "validations" do
+
+    it "should create a new instance given valid attributes" do
+      EventRule.create!(
+        :event_category  => "cloudfuji_event_received", 
+        :cloudfuji_event => "dummy_event",
+        :action          => "add_tag",
+        :tag      => "EventTag"
+      )
+    end
+      
+    it "should be invalid without a cloudfuji_event if event category is cloudfuji_event_received" do
+      @event_rule = EventRule.new :event_category  => "cloudfuji_event_received"
+      @event_rule.should_not be_valid
+      @event_rule.errors[:cloudfuji_event].should include("can't be blank")
+    end
+    
+    it "should be invalid without a lead_attribute if event category is lead_attribute_changed" do
+      @event_rule = EventRule.new :event_category  => "lead_attribute_changed"
+      @event_rule.should_not be_valid
+      @event_rule.errors[:lead_attribute].should include("can't be blank")
+    end
+    
+    it "should be invalid without a tag if action is add_tag or remove_tag" do
+      @event_rule = EventRule.new :action  => "add_tag"
+      @event_rule.should_not be_valid
+      @event_rule.errors[:tag].should include("can't be blank")
+      @event_rule.action = "remove_tag"
+      @event_rule.should_not be_valid
+      @event_rule.errors[:tag].should include("can't be blank")
+    end    
+    
+    it "should be invalid without change_score_by if action is change_lead_score" do
+      @event_rule = EventRule.new :event_category => "cloudfuji_event_received",
+                                  :cloudfuji_event => "dummy_event",
+                                  :action => "change_lead_score",
+                                  :change_score_by => nil
+      @event_rule.should_not be_valid
+
+      @event_rule.errors[:change_score_by].should include("is not a number")
+    end    
+    
+  end
+end

data/spec/observers/cloudfuji_lead_observer_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe CloudfujiLeadObserver do
+
+  before do
+    @observer = CloudfujiLeadObserver.send :new
+  end 
+  
+  it "should process an event rule when a lead column is updated" do
+    user = FactoryGirl.create(:user, :ido_id => "1234")
+    @lead = FactoryGirl.create(:lead, :first_name => "Henry", :user => user, :campaign => nil)
+
+    EventRule.create!(
+      :event_category  => "lead_attribute_changed", 
+      :lead_attribute  => "first_name",
+      :action          => "change_lead_score",
+      :change_score_by => 5
+    )    
+    
+    EventRule.any_instance.should_receive(:process).with(@lead, ['Henry', 'George'])
+    
+    @lead.first_name = "George"
+    @observer.after_update(@lead)
+  end
+
+end

metadata

@@ -1,137 +1,119 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: ffcrm_cloudfuji
-version: !ruby/object:Gem::Version
-  version: 0.2.1
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 0.2.2
 platform: ruby
-authors:
+authors: 
 - Sean Grove
 - Nathan Broadbent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-22 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-05-25 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.6'
+      - !ruby/object:Gem::Version 
+        version: "2.6"
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.6'
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: capybara
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: combustion
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: cloudfuji
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
         version: 0.0.42
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.0.42
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: authlogic_cloudfuji
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
+      - !ruby/object:Gem::Version 
+        version: "0.9"
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
+  version_requirements: *id005
 description: Integrates Fat Free CRM with the Cloudfuji hosting platform.
 email: s@cloudfuji.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
 - MIT-LICENSE
 - README
 - Rakefile
+- app/assets/javascripts/event_rules.js.coffee
 - app/assets/javascripts/ffcrm_cloudfuji.js
-- app/assets/javascripts/lead_scoring.js.coffee
+- app/assets/stylesheets/event_rules.css.scss
 - app/assets/stylesheets/ffcrm_cloudfuji.css
-- app/assets/stylesheets/lead_scoring.css.scss
-- app/controllers/admin/lead_scoring_controller.rb
-- app/helpers/admin/lead_scoring_helper.rb
-- app/models/lead_scoring_rule.rb
-- app/models/lead_scoring_rule_count.rb
-- app/views/admin/lead_scoring/_errors.html.haml
-- app/views/admin/lead_scoring/_form.html.haml
-- app/views/admin/lead_scoring/index.html.haml
+- app/controllers/admin/event_rules_controller.rb
+- app/helpers/admin/event_rules_helper.rb
+- app/models/event_rule.rb
+- app/models/lead_event_rule_count.rb
+- app/observers/cloudfuji_lead_observer.rb
+- app/views/admin/event_rules/_errors.html.haml
+- app/views/admin/event_rules/_form.html.haml
+- app/views/admin/event_rules/index.html.haml
 - app/views/leads/_lead.html.haml
 - app/views/leads/_sidebar_show_lead_scoring.html.haml
 - config.ru
 - config/database.yml
 - config/initializers/cloudfuji.rb
-- config/initializers/inflections.rb
+- config/locales/en-US.yml
 - config/routes.rb
 - config/settings.yml
 - db/migrate/20120227184555_add_cloudfuji_fields_to_users.rb
 - db/migrate/20120515194445_add_lead_scoring_rules.rb
+- db/migrate/20120524031157_extend_lead_scoring_as_event_rules.rb
+- db/migrate/20120525151511_add_ido_id_to_lead.rb
 - ffcrm_cloudfuji.gemspec
 - install.rb
 - lib/fat_free_crm/cloudfuji.rb
 - lib/fat_free_crm/cloudfuji/event_observers/app_observer.rb
 - lib/fat_free_crm/cloudfuji/event_observers/customer_observer.rb
 - lib/fat_free_crm/cloudfuji/event_observers/email_observer.rb
-- lib/fat_free_crm/cloudfuji/event_observers/lead_scoring_observer.rb
+- lib/fat_free_crm/cloudfuji/event_observers/event_rules_observer.rb
 - lib/fat_free_crm/cloudfuji/event_observers/payment_observer.rb
 - lib/fat_free_crm/cloudfuji/event_observers/user_observer.rb
 - lib/fat_free_crm/cloudfuji/view_hooks.rb
@@ -140,40 +122,46 @@ files:
 - lib/ffcrm_cloudfuji/version.rb
 - spec/event_observers/app_observer_spec.rb
 - spec/event_observers/customer_observer_spec.rb
-- spec/event_observers/lead_scoring_observer_spec.rb
+- spec/event_observers/event_rules_observer_spec.rb
 - spec/factories/lead_scoring_factories.rb
 - spec/internal/config/database.yml
 - spec/internal/db/schema.rb
+- spec/models/event_rule_spec.rb
+- spec/observers/cloudfuji_lead_observer_spec.rb
 - spec/spec_helper.rb
 - uninstall.rb
 homepage: http://cloudfuji.com
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -827916366021811991
+      segments: 
       - 0
-      hash: -3365246970251086224
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -827916366021811991
+      segments: 
       - 0
-      hash: -3365246970251086224
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Fat Free CRM - Cloudfuji Integration
 test_files: []
+

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

@@ -1,42 +0,0 @@
-(($) ->
-  class @LeadScoring
-    constructor: (@templates = {}) ->
-
-    add_fields: (button, content) ->
-      new_id = new Date().getTime()
-      regexp = new RegExp('new_lead_scoring_rule', 'g')
-      $('ul#lead_scoring_rules').append(content.replace(regexp, new_id))
-      # Setup event autocomplete for new field
-      this.event_autocomplete('input#lead_scoring_rules_'+new_id+'_event')
-
-    remove_fields: (button) ->
-      container = $(button).closest('li.lead_scoring_rule')
-      index = container.data('index')
-      # If rule has no id, just remove
-      if $("#lead_scoring_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="lead_scoring_rules['+index+'][_destroy]" value="yes">'))
-
-    event_autocomplete: (selector = 'input.lead_scoring_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() == ""
-
-  $(document).ready ->
-    lead_scoring = new LeadScoring()
-    # Initialize autocomplete for events
-    lead_scoring.event_autocomplete()
-
-    $("button.add_lead_scoring_rule").live "click", ->
-      lead_scoring.add_fields this, $(this).data("content")
-      false
-
-    $(".remove_lead_scoring_rule").live "click", ->
-      lead_scoring.remove_fields this
-      false
-
-) jQuery

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

@@ -1,47 +0,0 @@
-li.lead_scoring_rule {
-  font-size: 13px;
-
-  &:last-child {
-    border-bottom: none;
-  }
-
-  input {
-    font-size: 13px;
-    margin: 0 4px;
-    vertical-align: middle;
-    margin-bottom: 3px;
-  }
-  .lead_scoring_event { width: 160px; }
-  .lead_scoring_once {
-    width: 14px;
-    margin-left: 2px;
-  }
-  .lead_scoring_match { width: 190px; }
-  .lead_scoring_points { width: 35px; }
-
-  .field_with_errors {
-    display: inline;
-    input {
-      background-color: #ffdddd;
-    }
-  }
-}
-
-ul#lead_scoring_rules {
-  a.remove_lead_scoring_rule {
-    margin-right: 6px;
-    img {
-      vertical-align: middle;
-      margin-bottom: 4px;
-    }
-  }
-}
-
-.buttonbar.lead_scoring_buttons {
-  width: 845px;
-  float: left;
-  font-size: 13px;
-  input[type='submit'], button { font-size: 14px; }
-  .save_or_cancel { float: right; }
-  button { float: left; }
-}

data/app/helpers/admin/lead_scoring_helper.rb

@@ -1,10 +0,0 @@
-module Admin::LeadScoringHelper
-
-  def add_lead_scoring_rule_button(f)
-    fields = f.fields_for "new_lead_scoring_rule", LeadScoringRule.new(:points => 0) do |builder|
-      render("form", :r => builder, :index => "new_lead_scoring_rule")
-    end
-    button_tag 'Add New Rule', :class => "add_lead_scoring_rule", "data-content" => "#{fields}"
-  end
-
-end

data/app/models/lead_scoring_rule.rb

@@ -1,6 +0,0 @@
-class LeadScoringRule < ActiveRecord::Base
-  validates_presence_of :event, :points
-  validates_numericality_of :points, :only_integer => true
-
-  has_many :lead_scoring_rule_counts
-end

data/app/models/lead_scoring_rule_count.rb

@@ -1,4 +0,0 @@
-class LeadScoringRuleCount < ActiveRecord::Base
-  belongs_to :lead
-  belongs_to :lead_scoring_rule
-end

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

@@ -1,14 +0,0 @@
-%li.lead_scoring_rule{"data-index" => index}
-  = link_to image_tag('delete.png', :size => '16x16', :alt => 'Remove Rule'), nil, :class => "remove_lead_scoring_rule"
-
-  = r.hidden_field(:id) unless r.object.new_record?
-
-  If event:
-  = r.text_field :event, :class => "lead_scoring_event"
-  matches:
-  = r.text_field :match, :class => "lead_scoring_match"
-  change score by
-  = r.text_field :points, :class => "lead_scoring_points"
-  points.
-  Only once per lead:
-  = r.check_box :once, :class => "lead_scoring_once"

data/config/initializers/inflections.rb

@@ -1,3 +0,0 @@
-ActiveSupport::Inflector.inflections do |inflect|
-  inflect.uncountable "lead_scoring"
-end