e9_crm 0.1.1 → 0.1.4

data/app/views/e9_crm/campaigns/_reports_table.html.haml

@@ -0,0 +1,31 @@
+%table.records
+  %thead
+    %tr
+      %th= orderable_column_link(:type)
+      %th= orderable_column_link(:name)
+      %th= orderable_column_link('campaign_group.name', :campaign_group)
+      %th= orderable_column_link(:new_visits)
+      %th= orderable_column_link(:repeat_visits)
+      %th= orderable_column_link(:deals_count)
+      %th= orderable_column_link(:won_deals_count)
+  %tbody
+    - if collection.empty?
+      %tr
+        %td{:colspan => 5}= e9_t(:no_records_text)
+    - else
+      - collection.each do |record|
+        %tr{:id => "ids_#{record.id}", :class => cycle('odd', 'even')}
+          %td.record-type
+            = record.type[/(.*)Campaign/, 1]
+          %td.record-name
+            = record.name
+          %td.record-campaign-group
+            = record.campaign_group || e9_t(:no_group, :scope => 'e9_crm.campaigns')
+          %td.record-new-visits
+            = record.new_visits
+          %td.record-repeat-visits
+            = record.repeat_visits
+          %td.record-deals-count
+            = record.deals_count
+          %td.record-won-deals-count
+            = record.won_deals_count

data/app/views/e9_crm/campaigns/_table.html.haml

@@ -0,0 +1,31 @@
+%table.records
+  %thead
+    %tr
+      %th= orderable_column_link(:type)
+      %th= orderable_column_link(:name)
+      %th= orderable_column_link('campaign_group.name', :campaign_group)
+      %th= orderable_column_link(:code)
+      %th= orderable_column_link(:affiliate_fee)
+      %th= orderable_column_link(:sales_fee)
+      %th= e9_t(:actions)
+  %tbody
+    - if collection.empty?
+      %tr
+        %td{:colspan => 7}= e9_t(:no_records_text)
+    - else
+      - collection.each do |record|
+        %tr{:id => "ids_#{record.id}", :class => cycle('odd', 'even')}
+          %td.record-type
+            = record.type[/(.*)Campaign/, 1]
+          %td.record-name
+            = record.name
+          %td.record-campaign-group
+            = record.campaign_group || e9_t(:no_group, :scope => 'e9_crm.campaigns')
+          %td.record-code
+            = display_campaign_code(record.code)
+          %td.record-affiliate-fee
+            = display_campaign_fee(record.affiliate_fee)
+          %td.record-sales-fee
+            = display_campaign_fee(record.sales_fee)
+          %td.links
+            = link_to_edit_campaign(record)

data/app/views/e9_crm/campaigns/reports.html.haml

@@ -0,0 +1,13 @@
+= title (@index_title || e9_t(:reports_title))
+
+= render 'header'
+
+- if sortable_controller?
+  = form_tag polymorphic_path([:update_order, resource_class]) do
+    %div#records_table
+      = render 'table', :resources => collection
+- else
+  %div#records_table
+    = render 'table', :resources => collection
+
+= render 'footer'

data/app/views/e9_crm/contact_emails/_form_inner.html.haml

@@ -1,5 +1,5 @@
 = f.hidden_field :name
-= f.hidden_field :user_ids
+= f.hidden_field :contact_ids
 .field
   = f.label :from_email, nil, :class => :req
   = f.text_field :from_email

data/app/views/e9_crm/contacts/_header.html.haml

@@ -1,3 +1,4 @@
+- contact_ids = collection.map(&:id)
 .toolbar
   .toolbar-left
     = form_tag(resource_class, :method => :get, :id => 'contact_search_form') do
@@ -6,13 +7,13 @@
       = submit_tag t(:go), :name => nil
     = submit_tag t(:clear), :name => nil, :id => 'contact_search_clear'
   .toolbar-middle
-    = form_tag new_contact_email_path, :method => :get, :id => 'contact_email_form', 'data-empty' => e9_t(:no_contacts_notification), 'data-count' => @user_ids.length do
+    = form_tag new_contact_email_path, :method => :get, :id => 'contact_email_form', 'data-empty' => e9_t(:no_contacts_notification), 'data-count' => @contact_ids.length do
       = select_tag 'etid', contact_email_template_select_options
-      = hidden_field_tag 'uids', @user_ids.join(','), :id => 'contact_email_uids'
+      = hidden_field_tag 'uids', @contact_ids.join(','), :id => 'contact_email_uids'
       = submit_tag e9_t(:send_email_template), :name => nil
-    = form_tag send_email_admin_user_email_path('__ID__'), :method => :put, :id => 'contact_newsletter_form', 'data-confirm' => e9_t(:contact_newsletter_confirmation, :count => collection.length), 'data-empty' => e9_t(:no_contacts_notification), 'data-count' => @user_ids.length  do
+    = form_tag send_email_admin_user_email_path('__ID__'), :method => :put, :id => 'contact_newsletter_form', 'data-confirm' => e9_t(:contact_newsletter_confirmation, :count => collection.length), 'data-empty' => e9_t(:no_contacts_notification), 'data-count' => @contact_ids.length  do
       = select_tag 'eid', contact_newsletter_select_options
-      = hidden_field_tag 'uids', @user_ids.join(','), :id => 'contact_newsletter_uids'
+      = hidden_field_tag 'uids', @contact_ids.join(','), :id => 'contact_newsletter_uids'
       = submit_tag e9_t(:send_email_newsletter), :name => nil
   .toolbar-right
     = link_to_new_resource(Contact)

data/app/views/e9_crm/deals/_reports_table.html.haml

@@ -0,0 +1,86 @@
+%table.records
+  %thead
+    %tr
+      %th= orderable_column_link(:campaign_type)
+      %th= orderable_column_link(:campaign_name)
+      %th= orderable_column_link(:campaign_group)
+      %th= orderable_column_link(:new_visits)
+      %th= orderable_column_link(:repeat_visits)
+      %th= orderable_column_link(:lead_count)
+      %th= orderable_column_link(:deal_count)
+      %th= orderable_column_link(:won_deal_count)
+      %th= orderable_column_link(:total_value)
+      %th= orderable_column_link(:average_value)
+      %th= orderable_column_link(:total_cost)
+      %th= orderable_column_link(:average_cost)
+      %th= orderable_column_link(:average_elapsed)
+  %tbody
+    -# prepare a hash to store the accumulated row data for calculations
+    - dat = Hash.new {|k,v| k[v] = [] }
+
+    - if collection.empty?
+      %tr
+        %td{:colspan => 13}= e9_t(:no_records_text, :scope => 'e9_crm.reports')
+    - else
+      - collection.each do |record|
+        %tr{:id => "ids_#{record.id}", :class => cycle('odd', 'even')}
+          %td.record-campaign-type
+            = record.campaign_type[/(.*)Campaign/, 1]
+          %td.record-campaign-name
+            = record.campaign_name
+          %td.record-campaign-group
+            = record.campaign_group
+          %td.record-new-visits
+            - dat[:new_visits] << record.new_visits
+            = record.new_visits
+          %td.record-repeat-visits
+            - dat[:repeat_visits] << record.repeat_visits
+            = record.repeat_visits
+          %td.record-lead-count
+            - dat[:lead_count] << record.lead_count
+            = record.lead_count.to_i
+          %td.record-deal-count
+            - dat[:deal_count] << record.deal_count
+            = record.deal_count.to_i
+          %td.record-won-deal-count
+            - dat[:won_deal_count] << record.won_deal_count
+            = record.won_deal_count.to_i
+          %td.record-total-value
+            - dat[:total_value] << record.total_value
+            = record.total_value
+          %td.record-averate-value
+            - dat[:average_value] << record.average_value
+            = record.average_value
+          %td.record-total-cost
+            - dat[:total_cost] << record.total_cost
+            = record.total_cost
+          %td.record-average-cost
+            - dat[:average_cost] << record.average_cost
+            = record.average_cost
+          %td.record-average-elapsed
+            - dat[:average_elapsed] << record.average_elapsed
+            = record.average_elapsed && "%s days" % record.average_elapsed || 'n/a'
+    %tfooter
+      %tr{:class => 'record-totals'}
+        %td.record-totals-label{:colspan => 3}
+          #{t(:totals)}:
+        %td.record-new-visits
+          = dat[:new_visits].sum
+        %td.record-repeat-visits
+          = dat[:repeat_visits].sum
+        %td.record-lead-count
+          = dat[:lead_count].sum
+        %td.record-deal-count
+          = dat[:deal_count].sum.to_i
+        %td.record-won-deal-count
+          = dat[:won_deal_count].sum.to_i
+        %td.record-total-value
+          = dat[:total_value].average
+        %td.record-averate-value
+          = dat[:average_value].average
+        %td.record-total-cost
+          = dat[:total_cost].compact.sum
+        %td.record-average-cost
+          = dat[:average_cost].compact.average
+        %td.record-average-elapsed
+          = "%s days" % dat[:average_elapsed].compact.average

data/app/views/e9_crm/deals/reports.html.haml

@@ -0,0 +1,19 @@
+= title (@index_title || e9_t(:index_title, :scope => 'e9_crm.reports'))
+
+.toolbar
+  .toolbar-left
+    = form_tag(resource_class, :method => :get, :id => 'campaign_search_form') do
+      %select{:name => 'type'}
+        = campaign_type_select_options
+      %select{:name => 'group'}
+        = campaign_group_select_options
+      %select{:name => 'from'}
+        = deal_date_select_options
+      %select{:name => 'until'}
+        = deal_date_select_options(true)
+
+  .toolbar-right
+    = link_to_collection(Campaign)
+
+%div#records_table
+  = render 'reports_table'

data/app/views/e9_crm/deals/reports.js.erb

@@ -0,0 +1 @@
+$("table.records").replaceWith("<%= escape_javascript(render('reports_table', :collection => collection)) %>");  

data/app/views/e9_crm/email_campaigns/_form_inner.html.haml

@@ -0,0 +1 @@
+= render 'e9_crm/campaigns/form_inner', :f => f

data/app/views/e9_crm/page_views/_table.html.haml

@@ -1,8 +1,8 @@
 %table.records
   %thead
     %tr
-      %th= orderable_column_link('campaign.name', :campaign)
       %th= orderable_column_link(:created_at)
+      %th= orderable_column_link('campaign.name', :campaign)
       %th= orderable_column_link(:request_path)
       %th= orderable_column_link(:referer)
       %th= orderable_column_link(:remote_ip)
@@ -13,13 +13,13 @@
     - else
       - collection.each do |record|
         %tr{:id => "ids_#{record.id}", :class => cycle('odd', 'even')}
-          %td.contact-campaign-name
-            = record.campaign_name || 'n/a'
-          %td.contact-created-at
+          %td.record-created-at
             = I18n.l(record.created_at)
-          %td.contact-request-path
+          %td.record-campaign-name
+            = record.campaign_name || e9_t(:no_campaign)
+          %td.record-request-path
             = record.request_path
-          %td.contact-referer
+          %td.record-referer
             = record.referer
-          %td.contact-remote-ip
+          %td.record-remote-ip
             = record.remote_ip

data/app/views/e9_crm/resources/_table.html.haml

@@ -14,7 +14,7 @@
       - collection.each do |record|
         %tr{:id => "ids_#{record.id}", :class => cycle('odd', 'even')}
           - field_map[:fields].each do |key, value|
-            %td{:class => "contact-#{key}"}
+            %td{:class => "record-#{key.to_s.dasherize}"}
               = value.respond_to?(:call) ? value.call(record) : record.send(key)
           %td.links
             - field_map[:links][record].each do |link|

data/app/views/e9_crm/sales_campaigns/_form_inner.html.haml

@@ -0,0 +1,11 @@
+= render 'e9_crm/campaigns/form_inner', :f => f
+
+%fieldset
+  %legend= e9_t(:salesperson_information_legend, :scope => 'e9_crm.campaigns')
+  .field
+    = f.label :sales_person_id
+    = f.collection_select :sales_person_id, Contact.sales_persons.all, :id, :name, :prompt => true
+  .field
+    = f.label :sales_fee
+    = f.text_field :sales_fee
+

data/config/locales/e9.en.yml

@@ -17,7 +17,7 @@ en:
         send_email_template: Send Email
         send_email_newsletter: Send Newsletter
         contact_newsletter_confirmation: "The system will send the newsletter to all of the selected contacts (%{count}) if they are subscribed to receieve email.  Are you sure you want to proceed?"
-        no_contacts_notification: "Either no contacts are selected, or none of those selected have configured primary emails."
+        no_contacts_notification: "You cannot send an email with no recipients!"
       contact_merges:
         new_title: Merge Contacts
         no_value: (No Value)
@@ -26,3 +26,13 @@ en:
         send_email: Send Email
       leads:
         index_title: Leads
+      reports:
+        index_title: Marketing Report
+        no_records_text: No data exists for those query parameters.
+      campaigns:
+        no_campaign: No Campaign
+        no_group: No Group
+        campaign_information_legend: Campaign Information
+        salesperson_information_legend: Salesperson Information
+        affiliate_information_legend: Affiliate Information
+        code_help: "Be careful when creating tracking codes.  They are NOT EDITABLE after you save them.

To track the success of this campaign, you can append ?%{code}={Your Code} to the end of any and all URLs on your website.

It might look something like this: http://www.example.com/about-us?%{code}=alpha, where \"alpha\" represents the code you created.

You can provide this tracking URL to a salesperson or an affiliate or it can be placed at the end of a link in any of your advertisements."

data/config/locales/en.yml

@@ -3,6 +3,9 @@ en:
   go: Go
   search: Search
   view: View
+  none: None
+  totals: Totals
+  inline_help_link: '[?]'
 
   e9_crm:
     add_record_attribute: Add
@@ -10,10 +13,13 @@ en:
 
   activerecord:
     links:
-      new: "New %{model}"
-      edit: "Edit %{model}"
-      destroy: "Delete %{model}"
-      show: "View %{model}"
+      edit: "Edit"
+      destroy: "Delete"
+      show: "View"
+      index: "Manage %{models}"
+
+      campaign_group: 
+        confirm_destroy: Are you sure?  This cannot be undone.  Any campaigns which are associated with this group will become groupless.
 
     errors:
       messages:
@@ -27,8 +33,10 @@ en:
               invalid: "One or more of the emails you entered is invalid."
         contact_email:
           attributes:
+            contact_ids:
+              blank: "You cannot send an emailwith no recipients!"
             user_ids:
-              blank: "You cannot send an email with no recipients!"
+              blank: "None of the contacts selected are configured with primary emails.  Please correct this and try again."
         deal:
           attributes:
             status:
@@ -53,6 +61,9 @@ en:
     attributes:
       campaign:
         name: Name
+        code_hint: Append to URL
+      no_campaign:
+        name: No Campaign
       offer:
         alert_email_instructions: (Enter an email if you want to be notified of conversions)
         submit_button_text: Submit Button Text

data/config/routes.rb

@@ -4,7 +4,7 @@ Rails.application.routes.draw do
   scope :path => crm_path, :module => :e9_crm do
     resources :companies, :except => :show
     resources :contacts, :except => :show do
-      resources :page_views, :path => 'activity', :only => :index
+      #resources :page_views, :path => 'activity', :only => :index
       collection { get :templates }
     end
     resources :deals, :except => :show
@@ -18,26 +18,28 @@ Rails.application.routes.draw do
       collection { post :update_order }
     end
 
-    # campaigns_controller only handles index, the individual controllers all support
-    # specific index views and manage create/edit/destroy
-    resources :campaigns, :only  => :index do
-      resources :page_views, :path => 'activity', :only => :index
+    resources :campaigns, :only  => [:index, :destroy] do
+      #resources :page_views, :path => 'activity', :only => :index
     end
     scope :path => :campaigns do
-      get '/activity', :to => redirect("/#{crm_path}/campaigns/all/activity")
-
+      #get '/activity', :to => redirect("/#{crm_path}/campaigns/all/activity")
       resources :campaign_groups, :path => 'groups', :except => [:show]
-      resources :sales_campaigns, :path => 'sales', :except => [:show]
-      resources :advertising_campaigns, :path => 'advertising', :except => [:show] do
+
+      resources :sales_campaigns, :path => 'sales', :except => [:show, :index]
+      resources :affiliate_campaigns, :path => 'affiliate', :except => [:show, :index]
+      resources :email_campaigns, :path => 'email', :except => [:show, :index]
+      resources :advertising_campaigns, :path => 'advertising', :except => [:show, :index] do
         resources :dated_costs, :path => 'costs'
       end
-      resources :affiliate_campaigns, :path => 'affiliate', :except => [:show]
-      resources :email_campaigns, :path => 'email', :except => [:show]
+
+      %w( advertising affiliate email sales ).each do |path|
+        get "/#{path}", :to => redirect("/#{crm_path}/campaigns?type=#{path}")
+      end
     end
 
     # leads are simply a scoped view of offers (only index)
     get :leads, :as => :leads, :to => 'deals#leads'
-    get :marketing_report, :to => 'campaigns#reports', :only => :index
+    get :marketing_report, :to => 'deals#reports', :only => :index
 
     get  '/merge_contacts/:contact_a_id/and/:contact_b_id', :as => :new_contact_merge, :to => 'contact_merges#new'
     post '/merge_contacts', :as => :contact_merges, :to => 'contact_merges#create'
@@ -57,5 +59,6 @@ Rails.application.routes.draw do
     ).each do |path|
       get "/#{path}/:id", :to => redirect("/#{crm_path}/#{path}/%{id}/edit"), :constraints => { :id => /\d+/ }
     end
+
   end
 end

data/e9_crm.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_dependency("inherited_resources", "~> 1.1.2")
   s.add_dependency("has_scope")
   s.add_dependency("money")
-  s.add_dependency("e9_rails", "~> 0.0.11")
+  s.add_dependency("e9_rails", "~> 0.0.13")
   s.add_dependency("e9_tags", "~> 0.0.11")
   s.add_dependency("will_paginate")
 end

data/lib/e9_crm/rails_extensions.rb

@@ -1,6 +1,13 @@
 require 'active_record/base'
 require 'action_view/base'
 
+class Array
+  def average
+    return 0 unless length > 0 && all? {|n| n && n.respond_to?(:to_f) }
+    sum / length
+  end
+end
+
 class ActiveRecord::Base
   #
   # Basic conversion for "money" columns using the Money class and Rails composed_of

data/lib/e9_crm/tracking_controller.rb

@@ -2,77 +2,94 @@ module E9Crm
   module TrackingController
     extend ActiveSupport::Concern
 
-    included { before_filter :track_page_view }
+    included do
+      before_filter :check_for_new_session 
+      after_filter  :track_page_view
+    end
 
     protected 
+      def check_for_new_session
+        if request.session_options[:id].blank?
+          E9Crm.log("No session found, page view will increment campaign counter cache")
+          @_should_cache = true
+        end
+      end
 
-    def track_page_view
-      @_page_view ||= tracking_cookie.page_views.create({
-        :request_path => request.fullpath,
-        :user_agent   => request.user_agent,
-        :referer      => request.referer,
-        :remote_ip    => request.remote_ip,
-        :session      => request.session_options[:id],
-        :campaign     => tracking_cookie.code.presence && Campaign.find_by_code(tracking_cookie.code),
-        :new_visit    => tracking_cookie.new_visit?
-      })
-    end
+      def track_page_view
+        @_page_view ||= tracking_cookie.page_views.create({
+          :request_path => request.fullpath,
+          :user_agent   => request.user_agent,
+          :referer      => request.referer,
+          :remote_ip    => request.remote_ip,
+          :session      => request.session_options[:id],
+          :campaign     => tracking_campaign,
+          :new_visit    => session[:new_visit].present?,
+          :should_cache => !!@_should_cache
+        })
+      end
 
-    def tracking_cookie
-      @_tracking_cookie ||= begin
-        E9Crm.log "Begin load or install cookie: cookie_name[#{E9Crm.cookie_name}] query_param[#{E9Crm.query_param}]"
+      def tracking_cookie
+        @_tracking_cookie ||= begin
+          E9Crm.log "Begin load or install cookie: cookie_name[#{E9Crm.cookie_name}] query_param[#{E9Crm.query_param}]"
 
-        code = params.delete(E9Crm.query_param)
+          code = params.delete(E9Crm.query_param)
 
-        if hid = cookies[E9Crm.cookie_name]
-          E9Crm.log("Installed cookie found: hid(#{hid})")
-          @_tracking_cookie = TrackingCookie.find_by_hid(hid)
+          if hid = cookies[E9Crm.cookie_name]
+            E9Crm.log("Installed cookie found: hid(#{hid})")
+            @_tracking_cookie = TrackingCookie.find_by_hid(hid)
 
-          unless @_tracking_cookie
-            # This should only happen in developemnt, as it means the cookie has been
-            # installed then removed from the database.
-            E9Crm.log("Installed cookie's hash id does not match any stored cookies!")
+            unless @_tracking_cookie
+              # This should only happen in developemnt, as it means the cookie has been
+              # installed then removed from the database.
+              E9Crm.log("Installed cookie's hash id does not match any stored cookies!")
+            end
           end
-        end
 
-        E9Crm.log(@_tracking_cookie ? "Cookie loaded: (#{E9Crm.cookie_name} : #{@_tracking_cookie.hid})" : "Cookie not found")
+          E9Crm.log(@_tracking_cookie ? "Cookie loaded: (#{E9Crm.cookie_name} : #{@_tracking_cookie.hid})" : "Cookie not found")
 
-        if @_tracking_cookie
-          if current_user && @_tracking_cookie.user_id? && @_tracking_cookie.user_id != current_user.id
-            E9Crm.log "Tracking user_id not matched: found(#{@_tracking_cookie.user_id}), current(#{current_user.id}"
-            @_tracking_cookie = nil
-          else
-            attrs = {}
+          if @_tracking_cookie
+            if current_user && @_tracking_cookie.user_id? && @_tracking_cookie.user_id != current_user.id
+              E9Crm.log "Tracking user_id not matched: found(#{@_tracking_cookie.user_id}), current(#{current_user.id}"
+              @_tracking_cookie = nil
+            else
+              attrs = {}
 
-            if current_user && !@_tracking_cookie.user_id?
-              E9Crm.log("Cookie user (#{@_tracking_cookie.user_id}) not current_user (#{current_user.id}), changing...")
-              attrs[:user] = current_user
-            end
+              if current_user && !@_tracking_cookie.user_id?
+                E9Crm.log("Cookie user (#{@_tracking_cookie.user_id}) not current_user (#{current_user.id}), changing...")
+                attrs[:user] = current_user
+              end
 
-            if code.present? && code != @_tracking_cookie.code
-              E9Crm.log "Code present and cookie code(#{@_tracking_cookie.code}) does not match (#{code}), changing..."
-              attrs[:code] = code
+              if code.present? && code != @_tracking_cookie.code && Campaign.find_by_code(code)
+                E9Crm.log "Code present and cookie code(#{@_tracking_cookie.code}) does not match (#{code}), changing..."
+                attrs[:code] = code
 
-              E9Crm.log "Cookie marked as new"
-              attrs[:new_visit] = true
-            end
+                E9Crm.log "Cookie marked as new"
+                session[:new_visit] = true
+              end
 
-            E9Crm.log(attrs.blank? ? "Cookie unchanged, no update" : "Cookie changed, new attrs: #{attrs.inspect}")
-            @_tracking_cookie.update_attributes(attrs) unless attrs.blank?
+              E9Crm.log(attrs.blank? ? "Cookie unchanged, no update" : "Cookie changed, new attrs: #{attrs.inspect}")
+              @_tracking_cookie.update_attributes(attrs) unless attrs.blank?
+            end
           end
-        end
 
-        @_tracking_cookie ||= begin
-          TrackingCookie.create(:code => code, :user => current_user, :new_visit => true).tap do |cookie|
-            E9Crm.log "Installing new cookie (#{E9Crm.cookie_name} : #{cookie.hid})"
-            cookies.permanent[E9Crm.cookie_name] = cookie.hid
+          @_tracking_cookie ||= begin
+            session[:new_visit] = true
+
+            TrackingCookie.create(:code => code, :user => current_user).tap do |cookie|
+              E9Crm.log "Installing new cookie (#{E9Crm.cookie_name} : #{cookie.hid})"
+              cookies.permanent[E9Crm.cookie_name] = cookie.hid
+            end
           end
-        end
 
-        E9Crm.log("Final Cookie : #{@_tracking_cookie.inspect}")
+          E9Crm.log("Final Cookie : #{@_tracking_cookie.inspect}")
 
-        @_tracking_cookie
+          @_tracking_cookie
+        end
       end
-    end
+
+      def tracking_campaign
+        @_tracking_campaign ||= tracking_cookie.code.presence && Campaign.find_by_code(tracking_cookie.code) || Campaign.default
+      end
+
   end
 end