e9_crm 0.1.1

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

@@ -0,0 +1,2 @@
+= title e9_t(:edit_title)
+= render 'form'

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

@@ -0,0 +1,13 @@
+= title (@index_title || e9_t(:index_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/resources/index.js.erb

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

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

@@ -0,0 +1,2 @@
+= title e9_t(:new_title)
+= render 'form'

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

@@ -0,0 +1,2 @@
+= title e9_t(:show_title)
+= render 'form'

data/app/views/e9_crm/resources/update.js.erb

@@ -0,0 +1,5 @@
+<% if resource.errors.any? %>
+  $('form .errors').html("<%= escape_javascript(resource_error_messages!) %>");
+<% else %>
+  window.location.reload(true);
+<% end %>

data/config/initializers/inflections.rb

@@ -0,0 +1,3 @@
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.singular /^(\w*cookie)s$/i, '\1'
+end

data/config/locales/e9.en.yml

@@ -0,0 +1,28 @@
+en:
+  e9:
+    e9_crm:
+      no_records_text: "No records were found."
+      index_title: "%{models}"
+      edit_title: "Edit %{model}"
+      new_title: "New %{model}"
+      actions: Actions
+
+      contacts:
+        index_title_with_search: "%{models} matching \"%{search}\""
+        index_title_with_tags: "%{models} tagged \"%{tagged}\""
+        index_title_with_search_and_tags: "%{models} tagged \"%{tagged}\", matching \"%{search}\""
+        form_legend_contact: Contact Information
+        form_legend_standard: Personal Information
+        form_legend_user: Login Accounts
+        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."
+      contact_merges:
+        new_title: Merge Contacts
+        no_value: (No Value)
+      contact_emails:
+        prepare_title: Edit Your Template
+        send_email: Send Email
+      leads:
+        index_title: Leads

data/config/locales/en.yml

@@ -0,0 +1,63 @@
+en:
+  clear: Clear
+  go: Go
+  search: Search
+  view: View
+
+  e9_crm:
+    add_record_attribute: Add
+    destroy_record_attribute: Remove
+
+  activerecord:
+    links:
+      new: "New %{model}"
+      edit: "Edit %{model}"
+      destroy: "Delete %{model}"
+      show: "View %{model}"
+
+    errors:
+      messages:
+        merge_required: 'Merge Required! <a href="%{merge_path}">MERGE ME</a>.'
+
+      models:
+        contact:
+          attributes:
+            users:
+              taken: "Two or more of the login accounts entered share a duplicate email."
+              invalid: "One or more of the emails you entered is invalid."
+        contact_email:
+          attributes:
+            user_ids:
+              blank: "You cannot send an email with no recipients!"
+        deal:
+          attributes:
+            status:
+              illegal_conversion: A Deal with "lead" status can only be converted to "pending"
+              illegal_reversion: A Deal that has been marked "won" or "lost" cannot be reverted to a "lead"
+              invalid: "Status must be one of (%{options})"
+
+    models:
+      sales_campaign: Sales Campaign
+      email_campaign: Email Campaign
+      email_template: Email Template
+      affiliate_campaign: Affiliate Campaign
+      advertising_campaign: Advertising Campaign
+      campaign: Campaign
+      campaign_type: Campaign Type
+      company: Company
+      contact: Contact
+      deal: Deal
+      page_view: Page View
+      tracking_cookie: Tracking Cookie
+    
+    attributes:
+      campaign:
+        name: Name
+      offer:
+        alert_email_instructions: (Enter an email if you want to be notified of conversions)
+        submit_button_text: Submit Button Text
+        success_alert_text: Success Alert Text
+        download_link_text: Download Link Text
+        conversion_alert_email: Send Alert Email To
+        success_page_text: Success Page Text
+        custom_form_html: Custom Form Html

data/config/routes.rb

@@ -0,0 +1,61 @@
+Rails.application.routes.draw do
+  crm_path = 'admin/crm'
+
+  scope :path => crm_path, :module => :e9_crm do
+    resources :companies, :except => :show
+    resources :contacts, :except => :show do
+      resources :page_views, :path => 'activity', :only => :index
+      collection { get :templates }
+    end
+    resources :deals, :except => :show
+    resources :offers, :except => :show
+
+    # contact_emails are generated by email templates, and end up in the sent emails list
+    resources :contact_emails,  :except => [:index, :show]
+    resources :email_templates, :except => :show
+
+    resources :menu_options, :except => [:show] 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
+    end
+    scope :path => :campaigns do
+      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 :dated_costs, :path => 'costs'
+      end
+      resources :affiliate_campaigns, :path => 'affiliate', :except => [:show]
+      resources :email_campaigns, :path => 'email', :except => [:show]
+    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  '/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'
+
+    # redirect shows to edits
+    %w(
+      campaigns/advertising
+      campaigns/affiliate
+      campaigns/email
+      campaigns/sales
+      campaigns/groups
+      contacts
+      deals
+      email_templates
+      menu_options
+      offers
+    ).each do |path|
+      get "/#{path}/:id", :to => redirect("/#{crm_path}/#{path}/%{id}/edit"), :constraints => { :id => /\d+/ }
+    end
+  end
+end

data/e9_crm.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "e9_crm/version"
+
+Gem::Specification.new do |s|
+  s.name        = "e9_crm"
+  s.version     = E9Crm::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.email       = "travis@e9digital.com"
+  s.homepage    = "http://www.e9digital.com"
+  s.summary     = "CRM engine plugin for the e9 CMS"
+  s.description = File.open('README.md').read rescue nil
+  s.authors     = ['Travis Cox']
+
+  s.rubyforge_project = "e9_crm"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("rails", "~> 3.0.0")
+  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_tags", "~> 0.0.11")
+  s.add_dependency("will_paginate")
+end

data/lib/e9_crm/model.rb

@@ -0,0 +1,63 @@
+module E9Crm
+  ##
+  # The User model associated with a Contact.  The idea is that a Contact can be 
+  # associated to many different logins/users (e.g. bob@home.com, bob@work.com).
+  #
+  # In the default setup the included model is treated as simply an email, and given a
+  # "type" such as Personal, Work, etc.
+  #
+  # One and only one of these models should be considered "primary".  The designation of
+  # which is handled largely by the Contact class.
+  #
+  module Model
+    extend ActiveSupport::Concern
+    include E9Rails::ActiveRecord::InheritableOptions
+
+    included do
+      belongs_to :contact, :inverse_of => :users
+
+      has_many :tracking_cookies, :inverse_of => :user
+      has_many :page_views, :through => :tracking_cookies
+
+      self.options_parameters = [:type, :primary]
+
+      scope :primary, lambda { where(arel_table[:options].matches("%primary: true%")) }
+
+      before_create :create_contact_if_missing
+      after_destroy :cleanup_contact
+    end
+
+    ##
+    # Is this the Contact's primary model?
+    #
+    def primary?
+      !!options.primary
+    end
+
+    protected
+
+      def create_contact_parameters
+        { :first_name => self.first_name, :last_name => self.last_name }
+      end
+
+      def create_contact_if_missing
+        if contact.blank?
+          # when creating a contact we should assume we're primary
+          self.options.primary = true
+          create_contact(create_contact_parameters)
+        end
+      end
+
+      def cleanup_contact
+        # NOTE this is called after_delete, reload the contact to clear the deleted
+        #      user from the contact's #users
+        contact.reload.users.reset_primary! if self.primary? && contact.present?
+      end
+
+    module ClassMethods
+      def email_types
+        MenuOption.fetch_values('Email')
+      end
+    end
+  end
+end

data/lib/e9_crm/rails_extensions.rb

@@ -0,0 +1,98 @@
+require 'active_record/base'
+require 'action_view/base'
+
+class ActiveRecord::Base
+  #
+  # Basic conversion for "money" columns using the Money class and Rails composed_of
+  #
+  def self.money_columns(*column_names)
+    column_names.each do |column_name|
+      class_eval <<-EVAL
+        composed_of :#{column_name},
+                    :class_name => 'Money',
+                    :mapping => %w(#{column_name} cents),
+                    :converter => Proc.new { |value| value.respond_to?(:to_money) ? value.to_money : Money.empty }
+      EVAL
+    end
+  end
+end
+
+module E9Crm
+  #
+  # Simple string subclass that lets you query the string against
+  # a "label" it was initialized with. e.g. 
+  #
+  #   LabeledString.new(:omfg, 'whatever').omfg? #=> true
+  #
+  class LabeledString < String
+    attr_reader :label
+
+    def initialize(label, *args)
+      @label = label if label.is_a?(Symbol)
+      super(*args)
+    end
+
+    def method_missing(method_name, *args)
+      if @label && method_name.to_s[-1,1] == '?'
+        method_name.to_s[0..-2] == @label.to_s
+      else
+        super
+      end
+    end
+  end
+end
+
+module ActiveModel
+  class Errors
+    alias :default_add :add
+
+    # Monkeypatch add to replace the error message with a LabeledString, which
+    # simply changes method missing to respond to methods ending with '?' by
+    # checking to see if their label matches the method.
+    #
+    # This makes it easy to check an error's message for what error symbol it
+    # was generated for, e.g. :invalid, by calling #invalid? on it.
+    #
+    # Errors#add accepts a Proc or a Symbol for message (or defaults to :invalid)
+    # so this is hack isn't always useful, but for my purposes I want to know when
+    # a :taken error was added to a User#email, and this is good enough.
+    #
+    def add(attribute, message = nil, options = {})
+      default_add(attribute, message, options)
+
+      self[attribute] << E9Crm::LabeledString.new(message, self[attribute].pop)
+    end
+  end
+end
+
+module E9Crm
+  #
+  # Fairly straightforward hack to allow e9_crm views to inherit from resources.
+  # If a missing template error is raised by a view looking for a template prefixed with
+  # "e9_crm", redirect the lookup to "e9_crm/resources"
+  #
+  # This would be worth looking into further but inherited templates are a feature coming 
+  # up in Rails anyway.
+  #
+  module ActionView
+    extend ActiveSupport::Concern
+
+    included do
+      def self.process_view_paths(value)
+        value.is_a?(::E9Crm::ActionView::PathSet) ?
+          value.dup : ::E9Crm::ActionView::PathSet.new(Array.wrap(value))
+      end
+    end
+    
+    class PathSet < ::ActionView::PathSet
+      def find(path, prefix = nil, partial = false, details = {}, key = nil)
+        super
+      rescue ::ActionView::MissingTemplate
+        raise $! unless prefix =~ /^e9_crm/
+        super(path, "e9_crm/resources", partial, details, key)
+      end
+    end
+  end
+end
+
+ActionView::Base.send(:include, E9Crm::ActionView)

data/lib/e9_crm/tracking_controller.rb

@@ -0,0 +1,78 @@
+module E9Crm
+  module TrackingController
+    extend ActiveSupport::Concern
+
+    included { before_filter :track_page_view }
+
+    protected 
+
+    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 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)
+
+        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!")
+          end
+        end
+
+        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 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
+
+              E9Crm.log "Cookie marked as new"
+              attrs[: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?
+          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
+          end
+        end
+
+        E9Crm.log("Final Cookie : #{@_tracking_cookie.inspect}")
+
+        @_tracking_cookie
+      end
+    end
+  end
+end

data/lib/e9_crm/version.rb

@@ -0,0 +1,3 @@
+module E9Crm
+  VERSION = '0.1.1'
+end

data/lib/e9_crm.rb

@@ -0,0 +1,59 @@
+require 'rails'
+require 'e9_rails'
+require 'e9_tags'
+require 'money'
+require 'inherited_resources'
+require 'will_paginate'
+require 'has_scope'
+
+require 'e9_crm/rails_extensions'
+
+module E9Crm
+  autoload :VERSION,            'e9_crm/version'
+  autoload :TrackingController, 'e9_crm/tracking_controller'
+  autoload :Model,              'e9_crm/model'
+
+  mattr_accessor :cookie_name
+  @@cookie_name = '_e9_tc'
+
+  mattr_accessor :query_param
+  @@query_param = 'code'
+
+  mattr_accessor :log_level
+  @@log_level = :debug
+
+  mattr_accessor :logging
+  @@logging = false
+
+  mattr_accessor :user_model
+  @@user_model = nil
+
+  mattr_accessor :tracking_controllers
+  @@tracking_controllers = []
+
+  def E9Crm.log(message)
+    Rails.logger.send(@@log_level, "e9Crm: #{message}") if @@logging
+  end
+
+  def E9Crm.init!
+    user_model = case @@user_model
+    when Class; @@user_model
+    when String, Symbol; @@user_model.classify.constantize
+    end
+
+    if user_model
+      user_model.send(:include, E9Crm::Model)
+    end
+
+    E9Crm.tracking_controllers.each do |controller|
+      controller.send(:include, E9Crm::TrackingController)
+    end
+  end
+
+  class Engine < ::Rails::Engine
+    config.e9_crm = E9Crm
+    config.active_record.observers ||= []
+    config.active_record.observers << :deal_observer
+    config.to_prepare { E9Crm.init! }
+  end
+end

data/lib/generators/e9_crm/install_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module E9Crm
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('templates', File.dirname(__FILE__))
+
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def generate_migrations
+        migration_template 'create_e9_crm_tables.rb', 'db/migrate/create_e9_crm_tables.rb'
+      end
+
+      def copy_initializer
+        copy_file 'initializer.rb', 'config/initializers/e9_crm.rb'
+      end
+
+      def copy_javascript
+        copy_file 'javascript.js', 'public/javascripts/e9_crm.js'
+      end
+    end
+  end
+end

data/lib/generators/e9_crm/templates/create_e9_crm_tables.rb

@@ -0,0 +1,107 @@
+class CreateE9CrmTables < ActiveRecord::Migration
+  def self.up
+    create_table :page_views, :force => true do |t| 
+      t.references :tracking_cookie, :campaign
+      t.string :request_path, :user_agent, :referer, :limit => 200
+      t.string :session, :limit => 32
+      t.string :remote_ip, :limit => 16
+      t.boolean :new_visit, :default => false
+      t.timestamp :created_at
+    end
+    add_index 'page_views', 'tracking_cookie_id'
+    add_index 'page_views', 'campaign_id'
+
+    create_table :tracking_cookies, :force => true do |t|
+      t.references :user
+      t.string :hid, :code, :limit => 32
+      t.timestamps
+    end
+    add_index 'tracking_cookies', 'hid'
+    add_index 'tracking_cookies', 'code'
+    add_index 'tracking_cookies', 'user_id'
+
+    create_table :contacts, :force => true do |t|
+      t.string :type
+      t.string :first_name
+      t.string :last_name
+      t.string :title
+      t.string :avatar
+      t.references :company
+      t.timestamps
+    end
+    add_index 'contacts', 'company_id'
+
+    create_table :record_attributes, :force => true do |t|
+      t.string :type
+      t.references :record, :polymorphic => true
+      t.text :value, :options, :limit => 3.kilobytes
+    end
+
+    create_table :dated_costs, :force => true do |t|
+      t.references :costable, :polymorphic => true
+      t.integer :cost, :default => 0
+      t.date :date
+      t.timestamps
+    end
+
+    create_table :campaign_groups, :force => true do |t|
+      t.string :name
+      t.timestamps
+    end
+
+    create_table :campaigns, :force => true do |t|
+      t.string :type
+      t.string :name
+      t.references :campaign_group, :affiliate, :sales_person
+      t.string :code, :limit => 32
+      t.integer :affiliate_fee, :sales_fee, :default => 0
+      t.boolean :active, :default => true
+      t.timestamps
+    end
+    add_index 'campaigns', 'campaign_group_id'
+    add_index 'campaigns', 'code'
+
+    create_table :companies, :force => true do |t|
+      t.string :name
+      t.timestamps
+    end
+
+    create_table :deals, :force => true do |t|
+      t.string :type
+      t.references :offer, :campaign, :tracking_cookie
+      t.timestamp :created_at, :updated_at, :converted_at
+      t.string :status, :limit => 32
+    end
+    add_index 'deals', 'offer_id'
+    add_index 'deals', 'campaign_id'
+    add_index 'deals', 'tracking_cookie_id'
+    add_index 'deals', 'status'
+
+    create_table :offers, :force => true do |t|
+      t.string :type
+      t.references :offer, :campaign, :tracking_cookie
+      t.timestamp :created_at, :updated_at, :converted_at
+      t.string :status, :limit => 32
+    end
+
+
+
+    add_column :users, :contact_id, :integer rescue nil
+    add_column :users, :options, :text, :limit => 1.kilobyte rescue nil
+  end
+
+  def self.down
+    remove_column :users, :contact_id rescue nil
+    remove_column :users, :options rescue nil
+
+    drop_table :deals rescue nil
+    drop_table :companies rescue nil
+    drop_table :campaigns rescue nil
+    drop_table :campaign_groups rescue nil
+    drop_table :dated_costs rescue nil
+    drop_table :record_attributes rescue nil
+    drop_table :contacts rescue nil
+    drop_table :tracking_cookies rescue nil
+    drop_table :page_views rescue nil
+  end
+end

data/lib/generators/e9_crm/templates/initializer.rb

@@ -0,0 +1,4 @@
+require 'e9_crm'
+
+E9Crm.user_model = User
+E9Crm.tracking_controllers << ApplicationController