fat_free_crm 0.11.0

data/app/models/base/account_opportunity.rb

@@ -0,0 +1,37 @@
+# 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/>.
+#------------------------------------------------------------------------------
+
+# == Schema Information
+#
+# Table name: account_opportunities
+#
+#  id             :integer         not null, primary key
+#  account_id     :integer
+#  opportunity_id :integer
+#  deleted_at     :datetime
+#  created_at     :datetime
+#  updated_at     :datetime
+#
+
+class AccountOpportunity < ActiveRecord::Base
+  belongs_to :account
+  belongs_to :opportunity
+  validates_presence_of :account_id, :opportunity_id
+
+  has_paper_trail
+end
+

data/app/models/base/campaign.rb

@@ -0,0 +1,123 @@
+# 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/>.
+#------------------------------------------------------------------------------
+
+# == Schema Information
+#
+# Table name: campaigns
+#
+#  id                  :integer         not null, primary key
+#  user_id             :integer
+#  assigned_to         :integer
+#  name                :string(64)      default(""), not null
+#  access              :string(8)       default("Public")
+#  status              :string(64)
+#  budget              :decimal(12, 2)
+#  target_leads        :integer
+#  target_conversion   :float
+#  target_revenue      :decimal(12, 2)
+#  leads_count         :integer
+#  opportunities_count :integer
+#  revenue             :decimal(12, 2)
+#  starts_on           :date
+#  ends_on             :date
+#  objectives          :text
+#  deleted_at          :datetime
+#  created_at          :datetime
+#  updated_at          :datetime
+#  background_info     :string(255)
+#
+
+class Campaign < ActiveRecord::Base
+  belongs_to  :user
+  belongs_to  :assignee, :class_name => "User", :foreign_key => :assigned_to
+  has_many    :tasks, :as => :asset, :dependent => :destroy#, :order => 'created_at DESC'
+  has_many    :leads, :dependent => :destroy, :order => "id DESC"
+  has_many    :opportunities, :dependent => :destroy, :order => "id DESC"
+  has_many    :activities, :as => :subject#, :order => 'created_at DESC'
+  has_many    :emails, :as => :mediator
+
+  scope :state, lambda { |filters|
+    where('status IN (?)' + (filters.delete('other') ? ' OR status IS NULL' : ''), filters)
+  }
+  scope :created_by, lambda { |user| where('user_id = ?' , user.id) }
+  scope :assigned_to, lambda { |user| where('assigned_to = ?', user.id) }
+
+  scope :text_search, lambda { |query|
+    query = query.gsub(/[^\w\s\-\.'\p{L}]/u, '').strip
+    where('upper(name) LIKE upper(?)', "%#{query}%")
+  }
+
+  uses_user_permissions
+  acts_as_commentable
+  acts_as_taggable_on :tags
+  has_paper_trail
+  has_fields
+  exportable
+  sortable :by => [ "name ASC", "target_leads DESC", "target_revenue DESC", "leads_count DESC", "revenue DESC", "starts_on DESC", "ends_on DESC", "created_at DESC", "updated_at DESC" ], :default => "created_at DESC"
+
+  validates_presence_of :name, :message => :missing_campaign_name
+  validates_uniqueness_of :name, :scope => [ :user_id, :deleted_at ]
+  validate :start_and_end_dates
+  validate :users_for_shared_access
+
+  # Default values provided through class methods.
+  #----------------------------------------------------------------------------
+  def self.per_page ; 20     ; end
+  def self.outline  ; "long" ; end
+
+  # Attach given attachment to the campaign if it hasn't been attached already.
+  #----------------------------------------------------------------------------
+  def attach!(attachment)
+    unless self.send("#{attachment.class.name.downcase}_ids").include?(attachment.id)
+      if attachment.is_a?(Task)
+        self.send(attachment.class.name.tableize) << attachment
+      else # Leads, Opportunities
+        attachment.update_attribute(:campaign, self)
+        attachment.send("increment_#{attachment.class.name.tableize}_count")
+        [ attachment ]
+      end
+    end
+  end
+
+  # Discard given attachment from the campaign.
+  #----------------------------------------------------------------------------
+  def discard!(attachment)
+    if attachment.is_a?(Task)
+      attachment.update_attribute(:asset, nil)
+    else # Leads, Opportunities
+      attachment.send("decrement_#{attachment.class.name.tableize}_count")
+      attachment.update_attribute(:campaign, nil)
+    end
+  end
+
+  private
+  # Make sure end date > start date.
+  #----------------------------------------------------------------------------
+  def start_and_end_dates
+    if (self.starts_on && self.ends_on) && (self.starts_on > self.ends_on)
+      errors.add(:ends_on, :dates_not_in_sequence)
+    end
+  end
+
+  # Make sure at least one user has been selected if the campaign is being shared.
+  #----------------------------------------------------------------------------
+  def users_for_shared_access
+    errors.add(:access, :share_campaign) if self[:access] == "Shared" && !self.permissions.any?
+  end
+
+end
+

data/app/models/base/contact.rb

@@ -0,0 +1,191 @@
+# 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/>.
+#------------------------------------------------------------------------------
+
+# == Schema Information
+#
+# Table name: contacts
+#
+#  id              :integer         not null, primary key
+#  user_id         :integer
+#  lead_id         :integer
+#  assigned_to     :integer
+#  reports_to      :integer
+#  first_name      :string(64)      default(""), not null
+#  last_name       :string(64)      default(""), not null
+#  access          :string(8)       default("Public")
+#  title           :string(64)
+#  department      :string(64)
+#  source          :string(32)
+#  email           :string(64)
+#  alt_email       :string(64)
+#  phone           :string(32)
+#  mobile          :string(32)
+#  fax             :string(32)
+#  blog            :string(128)
+#  linkedin        :string(128)
+#  facebook        :string(128)
+#  twitter         :string(128)
+#  born_on         :date
+#  do_not_call     :boolean         default(FALSE), not null
+#  deleted_at      :datetime
+#  created_at      :datetime
+#  updated_at      :datetime
+#  background_info :string(255)
+#  skype           :string(128)
+#
+
+class Contact < ActiveRecord::Base
+  belongs_to  :user
+  belongs_to  :lead
+  belongs_to  :assignee, :class_name => "User", :foreign_key => :assigned_to
+  has_one     :account_contact, :dependent => :destroy
+  has_one     :account, :through => :account_contact
+  has_many    :contact_opportunities, :dependent => :destroy
+  has_many    :opportunities, :through => :contact_opportunities, :uniq => true, :order => "opportunities.id DESC"
+  has_many    :tasks, :as => :asset, :dependent => :destroy#, :order => 'created_at DESC'
+  has_many    :activities, :as => :subject#, :order => 'created_at DESC'
+  has_one     :business_address, :dependent => :destroy, :as => :addressable, :class_name => "Address", :conditions => "address_type = 'Business'"
+  has_many    :emails, :as => :mediator
+
+  accepts_nested_attributes_for :business_address, :allow_destroy => true
+
+  scope :created_by, lambda { |user| { :conditions => [ "user_id = ?", user.id ] } }
+  scope :assigned_to, lambda { |user| { :conditions => ["assigned_to = ?", user.id ] } }
+
+  scope :text_search, lambda { |query|
+    query = query.gsub(/[^@\w\s\-\.'\p{L}]/u, '').strip
+    # We can't always be sure that names are entered in the right order, so we must
+    # split the query into all possible first/last name permutations.
+    name_query = if query.include?(" ")
+      query.name_permutations.map{ |first, last|
+        "(upper(first_name) LIKE upper('%#{first}%') AND upper(last_name) LIKE upper('%#{last}%'))"
+      }.join(" OR ")
+    else
+      "upper(first_name) LIKE upper('%#{query}%') OR upper(last_name) LIKE upper('%#{query}%')"
+    end
+    where("#{name_query} OR upper(email) LIKE upper(:m) OR upper(alt_email) LIKE upper(:m) OR phone LIKE :m OR mobile LIKE :m", :m => "%#{query}%")
+  }
+
+  uses_user_permissions
+  acts_as_commentable
+  acts_as_taggable_on :tags
+  has_paper_trail
+  has_fields
+  exportable
+  sortable :by => [ "first_name ASC",  "last_name ASC", "created_at DESC", "updated_at DESC" ], :default => "created_at DESC"
+
+  validates_presence_of :first_name, :message => :missing_first_name
+  validates_presence_of :last_name, :message => :missing_last_name if Setting.require_last_names
+  validate :users_for_shared_access
+
+  # Default values provided through class methods.
+  #----------------------------------------------------------------------------
+  def self.per_page ; 20                  ; end
+  def self.outline  ; "long"              ; end
+  def self.first_name_position ; "before" ; end
+
+  #----------------------------------------------------------------------------
+  def full_name(format = nil)
+    if format.nil? || format == "before"
+      "#{self.first_name} #{self.last_name}"
+    else
+      "#{self.last_name}, #{self.first_name}"
+    end
+  end
+  alias :name :full_name
+
+  # Backend handler for [Create New Contact] form (see contact/create).
+  #----------------------------------------------------------------------------
+  def save_with_account_and_permissions(params)
+    account = Account.create_or_select_for(self, params[:account], params[:users])
+    self.account_contact = AccountContact.new(:account => account, :contact => self) unless account.id.blank?
+    self.opportunities << Opportunity.find(params[:opportunity]) unless params[:opportunity].blank?
+    self.save_with_permissions(params[:users])
+  end
+
+  # Backend handler for [Update Contact] form (see contact/update).
+  #----------------------------------------------------------------------------
+  def update_with_account_and_permissions(params)
+    if params[:account][:id] == "" || params[:account][:name] == ""
+      self.account = nil # Contact is not associated with the account anymore.
+    else
+      account = Account.create_or_select_for(self, params[:account], params[:users])
+      if self.account != account and account.id.present?
+        self.account_contact = AccountContact.new(:account => account, :contact => self)
+      end
+    end
+    self.reload
+    self.update_with_permissions(params[:contact], params[:users])
+  end
+
+  # Attach given attachment to the contact if it hasn't been attached already.
+  #----------------------------------------------------------------------------
+  def attach!(attachment)
+    unless self.send("#{attachment.class.name.downcase}_ids").include?(attachment.id)
+      self.send(attachment.class.name.tableize) << attachment
+    end
+  end
+
+  # Discard given attachment from the contact.
+  #----------------------------------------------------------------------------
+  def discard!(attachment)
+    if attachment.is_a?(Task)
+      attachment.update_attribute(:asset, nil)
+    else # Opportunities
+      self.send(attachment.class.name.tableize).delete(attachment)
+    end
+  end
+
+  # Class methods.
+  #----------------------------------------------------------------------------
+  def self.create_for(model, account, opportunity, params)
+    attributes = {
+      :lead_id     => model.id,
+      :user_id     => params[:account][:user_id],
+      :assigned_to => params[:account][:assigned_to],
+      :access      => params[:access]
+    }
+    %w(first_name last_name title source email alt_email phone mobile blog linkedin facebook twitter skype do_not_call background_info).each do |name|
+      attributes[name] = model.send(name.intern)
+    end
+
+    contact = Contact.new(attributes)
+    contact.business_address = Address.new(:street1 => model.business_address.street1, :street2 => model.business_address.street2, :city => model.business_address.city, :state => model.business_address.state, :zipcode => model.business_address.zipcode, :country => model.business_address.country, :full_address => model.business_address.full_address, :address_type => "Business") unless model.business_address.nil?
+
+    # Save the contact only if the account and the opportunity have no errors.
+    if account.errors.empty? && opportunity.errors.empty?
+      # Note: contact.account = account doesn't seem to work here.
+      contact.account_contact = AccountContact.new(:account => account, :contact => contact) unless account.id.blank?
+      contact.opportunities << opportunity unless opportunity.id.blank?
+      if contact.access != "Lead" || model.nil?
+        contact.save_with_permissions(params[:users])
+      else
+        contact.save_with_model_permissions(model)
+      end
+    end
+    contact
+  end
+
+  private
+  # Make sure at least one user has been selected if the contact is being shared.
+  #----------------------------------------------------------------------------
+  def users_for_shared_access
+    errors.add(:access, :share_contact) if self[:access] == "Shared" && !self.permissions.any?
+  end
+
+end
+

data/app/models/base/contact_opportunity.rb

@@ -0,0 +1,38 @@
+# 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/>.
+#------------------------------------------------------------------------------
+
+# == Schema Information
+#
+# Table name: contact_opportunities
+#
+#  id             :integer         not null, primary key
+#  contact_id     :integer
+#  opportunity_id :integer
+#  role           :string(32)
+#  deleted_at     :datetime
+#  created_at     :datetime
+#  updated_at     :datetime
+#
+
+class ContactOpportunity < ActiveRecord::Base
+  belongs_to :contact
+  belongs_to :opportunity
+  validates_presence_of :contact_id, :opportunity_id
+
+  # has_paper_trail
+end
+

data/app/models/base/lead.rb

@@ -0,0 +1,188 @@
+# 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/>.
+#------------------------------------------------------------------------------
+
+# == Schema Information
+#
+# Table name: leads
+#
+#  id              :integer         not null, primary key
+#  user_id         :integer
+#  campaign_id     :integer
+#  assigned_to     :integer
+#  first_name      :string(64)      default(""), not null
+#  last_name       :string(64)      default(""), not null
+#  access          :string(8)       default("Public")
+#  title           :string(64)
+#  company         :string(64)
+#  source          :string(32)
+#  status          :string(32)
+#  referred_by     :string(64)
+#  email           :string(64)
+#  alt_email       :string(64)
+#  phone           :string(32)
+#  mobile          :string(32)
+#  blog            :string(128)
+#  linkedin        :string(128)
+#  facebook        :string(128)
+#  twitter         :string(128)
+#  rating          :integer         default(0), not null
+#  do_not_call     :boolean         default(FALSE), not null
+#  deleted_at      :datetime
+#  created_at      :datetime
+#  updated_at      :datetime
+#  background_info :string(255)
+#  skype           :string(128)
+#
+
+class Lead < ActiveRecord::Base
+  belongs_to  :user
+  belongs_to  :campaign
+  belongs_to  :assignee, :class_name => "User", :foreign_key => :assigned_to
+  has_one     :contact, :dependent => :nullify # On destroy keep the contact, but nullify its lead_id
+  has_many    :tasks, :as => :asset, :dependent => :destroy#, :order => 'created_at DESC'
+  has_many    :activities, :as => :subject#, :order => 'created_at DESC'
+  has_one     :business_address, :dependent => :destroy, :as => :addressable, :class_name => "Address", :conditions => "address_type='Business'"
+  has_many    :emails, :as => :mediator
+
+  accepts_nested_attributes_for :business_address, :allow_destroy => true
+
+  scope :state, lambda { |filters|
+    where([ 'status IN (?)' + (filters.delete('other') ? ' OR status IS NULL' : ''), filters ])
+  }
+  scope :converted, where(:status => 'converted')
+  scope :for_campaign, lambda { |id| where('campaign_id = ?', id) }
+  scope :created_by, lambda { |user| where('user_id = ?' , user.id) }
+  scope :assigned_to, lambda { |user| where('assigned_to = ?' , user.id) }
+
+  scope :text_search, lambda { |query|
+    query = query.gsub(/[^\w\s\-\.'\p{L}]/u, '').strip
+    where('upper(first_name) LIKE upper(:s) OR upper(last_name) LIKE upper(:s) OR upper(company) LIKE upper(:m) OR upper(email) LIKE upper(:m)', :s => "#{query}%", :m => "%#{query}%")
+  }
+
+  uses_user_permissions
+  acts_as_commentable
+  acts_as_taggable_on :tags
+  has_paper_trail
+  has_fields
+  exportable
+  sortable :by => [ "first_name ASC", "last_name ASC", "company ASC", "rating DESC", "created_at DESC", "updated_at DESC" ], :default => "created_at DESC"
+
+  validates_presence_of :first_name, :message => :missing_first_name
+  validates_presence_of :last_name, :message => :missing_last_name if Setting.require_last_names
+  validate :users_for_shared_access
+
+  after_create  :increment_leads_count
+  after_destroy :decrement_leads_count
+
+  # Default values provided through class methods.
+  #----------------------------------------------------------------------------
+  def self.per_page ; 20                  ; end
+  def self.outline  ; "long"              ; end
+  def self.first_name_position ; "before" ; end
+
+  # Save the lead along with its permissions.
+  #----------------------------------------------------------------------------
+  def save_with_permissions(params)
+    self.campaign = Campaign.find(params[:campaign]) unless params[:campaign].blank?
+    if self.access == "Campaign" && self.campaign # Copy campaign permissions.
+      save_with_model_permissions(Campaign.find(self.campaign_id))
+    else
+      super(params[:users]) # invoke :save_with_permissions in plugin.
+    end
+  end
+
+  # Update lead attributes taking care of campaign lead counters when necessary.
+  #----------------------------------------------------------------------------
+  def update_with_permissions(attributes, users)
+    if self.campaign_id == attributes[:campaign_id] # Same campaign (if any).
+      super(attributes, users)                      # See lib/fat_free_crm/permissions.rb
+    else                                            # Campaign has been changed -- update lead counters...
+      decrement_leads_count                         # ..for the old campaign...
+      lead = super(attributes, users)               # Assign new campaign.
+      increment_leads_count                         # ...and now for the new campaign.
+      lead
+    end
+  end
+
+  # Promote the lead by creating contact and optional opportunity. Upon
+  # successful promotion Lead status gets set to :converted.
+  #----------------------------------------------------------------------------
+  def promote(params)
+    account     = Account.create_or_select_for(self, params[:account], params[:users])
+    opportunity = Opportunity.create_for(self, account, params[:opportunity], params[:users])
+    contact     = Contact.create_for(self, account, opportunity, params)
+
+    return account, opportunity, contact
+  end
+
+  #----------------------------------------------------------------------------
+  def convert
+    update_attribute(:status, "converted")
+  end
+
+  #----------------------------------------------------------------------------
+  def reject
+    update_attribute(:status, "rejected")
+  end
+
+  # Attach a task to the lead if it hasn't been attached already.
+  #----------------------------------------------------------------------------
+  def attach!(task)
+    unless self.task_ids.include?(task.id)
+      self.tasks << task
+    end
+  end
+
+  # Discard a task from the lead.
+  #----------------------------------------------------------------------------
+  def discard!(task)
+    task.update_attribute(:asset, nil)
+  end
+
+  #----------------------------------------------------------------------------
+  def full_name(format = nil)
+    if format.nil? || format == "before"
+      "#{self.first_name} #{self.last_name}"
+    else
+      "#{self.last_name}, #{self.first_name}"
+    end
+  end
+  alias :name :full_name
+
+  private
+  #----------------------------------------------------------------------------
+  def increment_leads_count
+    if self.campaign_id
+      Campaign.increment_counter(:leads_count, self.campaign_id)
+    end
+  end
+
+  #----------------------------------------------------------------------------
+  def decrement_leads_count
+    if self.campaign_id
+      Campaign.decrement_counter(:leads_count, self.campaign_id)
+    end
+  end
+
+  # Make sure at least one user has been selected if the lead is being shared.
+  #----------------------------------------------------------------------------
+  def users_for_shared_access
+    errors.add(:access, :share_lead) if self[:access] == "Shared" && !self.permissions.any?
+  end
+
+end
+