reduced_fat_crm 0.14.0

data/lib/fat_free_crm/gem_ext/active_record/schema_dumper.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2008-2013 Michael Dvorkin and contributors.
+#
+# Fat Free CRM is freely distributable under the terms of MIT license.
+# See MIT-LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+#
+# Override SchemaDumper so that it ignores custom fields when generating db/schema.rb
+#
+require 'active_record'
+
+unless ENV['INCLUDE_CUSTOM_FIELDS']
+  module ActiveRecord
+    SchemaDumper.class_eval do
+      def initialize_with_ignored_custom_fields(connection, options = {})
+        # Override :columns method on this connection, to ignore any custom field columns
+        connection.class_eval do
+          def columns(*args)
+            super.reject { |c| c.name.start_with? "cf_" }
+          end
+        end
+        initialize_without_ignored_custom_fields(connection, options)
+      end
+
+      alias_method_chain :initialize, :ignored_custom_fields
+    end
+  end
+end

data/lib/fat_free_crm/gem_ext/active_support/buffered_logger.rb

@@ -0,0 +1,17 @@
+# Copyright (c) 2008-2013 Michael Dvorkin and contributors.
+#
+# Fat Free CRM is freely distributable under the terms of MIT license.
+# See MIT-LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+class ActiveSupport::BufferedLogger
+  BRIGHT = "\033[1;37;40m"
+  NORMAL = "\033[0m"
+
+  def p(*args)
+    info "#{BRIGHT}\n\n" << args.join(" ") << "#{NORMAL}\n\n\n"
+  end
+
+  def i(*args)
+    info "#{BRIGHT}\n\n" << args.map(&:inspect).join(" ") << "#{NORMAL}\n\n\n"
+  end
+end

data/lib/fat_free_crm/gem_ext/rails/engine.rb

@@ -0,0 +1,15 @@
+# Copyright (c) 2008-2013 Michael Dvorkin and contributors.
+#
+# Fat Free CRM is freely distributable under the terms of MIT license.
+# See MIT-LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+# Override engine views so that plugin views have higher priority.
+Rails::Engine.initializers.detect { |i| i.name == :add_view_paths }
+  .instance_variable_set("@block", proc do
+    views = paths["app/views"].to_a
+    unless views.empty?
+      ActiveSupport.on_load(:action_controller) { append_view_path(views) }
+      ActiveSupport.on_load(:action_mailer) { append_view_path(views) }
+    end
+  end
+)

data/lib/fat_free_crm/gem_ext/rake/task.rb

@@ -0,0 +1,13 @@
+# Copyright (c) 2008-2013 Michael Dvorkin and contributors.
+#
+# Fat Free CRM is freely distributable under the terms of MIT license.
+# See MIT-LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module Rake
+  Task.class_eval do
+    # Removes a Rake task
+    def self.remove(task_name)
+      Rake.application.instance_variable_get('@tasks').delete(task_name.to_s)
+    end
+  end
+end

data/lib/fat_free_crm/gem_ext/simple_form/action_view_extensions/form_helper.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2008-2013 Michael Dvorkin and contributors.
+#
+# Fat Free CRM is freely distributable under the terms of MIT license.
+# See MIT-LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+#
+# Removes simple_form's css class logic.
+module SimpleForm
+  module ActionViewExtensions
+    module FormHelper
+      def simple_form_for(record, options = {}, &block)
+        options[:builder] ||= SimpleForm::FormBuilder
+        options[:html] ||= {}
+        unless options[:html].key?(:novalidate)
+          options[:html][:novalidate] = !SimpleForm.browser_validations
+        end
+
+        with_simple_form_field_error_proc do
+          form_for(record, options, &block)
+        end
+      end
+    end
+  end
+end

data/lib/fat_free_crm/i18n.rb

@@ -0,0 +1,42 @@
+# Copyright (c) 2008-2013 Michael Dvorkin and contributors.
+#
+# Fat Free CRM is freely distributable under the terms of MIT license.
+# See MIT-LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+require 'pathname'
+
+module FatFreeCRM
+  module I18n
+    #----------------------------------------------------------------------------
+    def t(*args)
+      if args.size == 1
+        super(args.first, default: args.first.to_s)
+      elsif args.second.is_a?(Hash)
+        super(*args)
+      elsif args.second.is_a?(Fixnum)
+        super(args.first, count: args.second)
+      else
+        super(args.first, value: args.second)
+      end
+    end
+
+    # Scan config/locales directory for Fat Free CRM localization files
+    # (i.e. *_fat_free_crm.yml) and return locale part of the file name.
+    # We can't use ::I18n.available_locales because rails provides it's own
+    # translations too and we only want the locales that Fat Free CRM supports.
+    #----------------------------------------------------------------------------
+    def locales
+      @@locales ||= ::I18n.load_path.grep(/_fat_free_crm\.yml$/).map { |path| Pathname.new(path).basename.to_s.match(/(.*)_fat_free_crm\.yml/)[1] }.uniq
+    end
+
+    # Return a hash where the key is locale name, and the value is language name
+    # as defined in the locale_fat_free_crm.yml file.
+    #----------------------------------------------------------------------------
+    def languages
+      @@languages ||= Hash[locales.map { |locale| [locale, t(:language, locale: locale)] }]
+    end
+  end
+end
+
+ActionView::Base.send(:include, FatFreeCRM::I18n)
+ActionController::Base.send(:include, FatFreeCRM::I18n)

data/lib/fat_free_crm/load_settings.rb

@@ -0,0 +1,18 @@
+# Copyright (c) 2008-2013 Michael Dvorkin and contributors.
+#
+# Fat Free CRM is freely distributable under the terms of MIT license.
+# See MIT-LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+
+#
+# Register and call when Setting class is loaded
+# Load settings.default.yml
+# Then override with settings.yml
+# Don't override default settings in test environment
+ActiveSupport.on_load(:fat_free_crm_setting) do
+  setting_files = [FatFreeCRM.root.join("config", "settings.default.yml")]
+  setting_files << Rails.root.join("config", "settings.yml") unless Rails.env == 'test'
+  setting_files.each do |settings_file|
+    Setting.load_settings_from_yaml(settings_file) if File.exist?(settings_file)
+  end
+end

data/lib/fat_free_crm/mail_processor/base.rb

@@ -0,0 +1,227 @@
+# Copyright (c) 2008-2013 Michael Dvorkin and contributors.
+#
+# Fat Free CRM is freely distributable under the terms of MIT license.
+# See MIT-LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+require 'net/imap'
+require 'mail'
+require 'email_reply_parser'
+require 'premailer'
+require 'nokogiri'
+
+module FatFreeCRM
+  module MailProcessor
+    class Base
+      KEYWORDS = %w(account campaign contact lead opportunity).freeze
+
+      #--------------------------------------------------------------------------------------
+      def initialize
+        @archived, @discarded, @dry_run = 0, 0, false
+      end
+
+      # Setup imap folders in settings.
+      #--------------------------------------------------------------------------------------
+      def setup
+        log "connecting to #{@settings[:server]}..."
+        connect!(setup: true) or return nil
+        log "logged in to #{@settings[:server]}, checking folders..."
+        folders = [@settings[:scan_folder]]
+        folders << @settings[:move_to_folder] unless @settings[:move_to_folder].blank?
+        folders << @settings[:move_invalid_to_folder] unless @settings[:move_invalid_to_folder].blank?
+
+        # Open (or create) destination folder in read-write mode.
+        folders.each do |folder|
+          if @imap.list("", folder)
+            log "folder #{folder} OK"
+          else
+            log "folder #{folder} missing, creating..."
+            @imap.create(folder)
+          end
+        end
+      rescue => e
+        $stderr.puts "setup error #{e.inspect}"
+      ensure
+        disconnect!
+      end
+
+      #--------------------------------------------------------------------------------------
+      def run(dry_run = false)
+        if @dry_run = dry_run
+          log "Not discarding or archiving any new messages..."
+        end
+        connect! or return nil
+        with_new_emails do |uid, email|
+          # Subclasses must define a #process method that takes arguments: uid, email
+          process(uid, email)
+          archive(uid)
+        end
+      ensure
+        log "messages processed=#{@archived + @discarded} archived=#{@archived} discarded=#{@discarded}"
+        disconnect!
+      end
+
+      private
+
+      # Connects to the imap server with the loaded settings
+      #------------------------------------------------------------------------------
+      def connect!(options = {})
+        log "connecting & logging in to #{@settings[:server]}..."
+        @imap = Net::IMAP.new(@settings[:server], @settings[:port], @settings[:ssl])
+        @imap.login(@settings[:user], @settings[:password])
+        log "logged in to #{@settings[:server]}, checking folders..."
+        @imap.select(@settings[:scan_folder]) unless options[:setup]
+        @imap
+      rescue Exception => e
+        $stderr.puts "Could not login to the IMAP server: #{e.inspect}" unless Rails.env == "test"
+        nil
+      end
+
+      #------------------------------------------------------------------------------
+      def disconnect!
+        if @imap
+          @imap.logout
+          unless @imap.disconnected?
+            @imap.disconnect rescue nil
+          end
+        end
+      end
+
+      #--------------------------------------------------------------------------------------
+      def with_new_emails
+        @imap.uid_search(%w(NOT SEEN)).each do |uid|
+          begin
+            email = Mail.new(@imap.uid_fetch(uid, 'RFC822').first.attr['RFC822'])
+            log "fetched new message...", email
+            if is_valid?(email) && sent_from_known_user?(email)
+              yield(uid, email)
+            else
+              discard(uid)
+            end
+          rescue Exception => e
+            if %w(test development).include?(Rails.env)
+              $stderr.puts e
+              $stderr.puts e.backtrace
+            end
+            log "error processing email: #{e.inspect}", email
+            discard(uid)
+          end
+
+          if @dry_run
+            log "Marking message as unread"
+            @imap.uid_store(uid, "-FLAGS", [:Seen])
+          end
+        end
+      end
+
+      # Discard message (not valid) action based on settings
+      #------------------------------------------------------------------------------
+      def discard(uid)
+        if @dry_run
+          log "Not discarding message"
+        else
+          if @settings[:move_invalid_to_folder]
+            @imap.uid_copy(uid, @settings[:move_invalid_to_folder])
+          end
+          @imap.uid_store(uid, "+FLAGS", [:Deleted])
+        end
+        @discarded += 1
+      end
+
+      # Archive message (valid) action based on settings
+      #------------------------------------------------------------------------------
+      def archive(uid)
+        if @dry_run
+          log "Not archiving message"
+        else
+          if @settings[:move_to_folder]
+            @imap.uid_copy(uid, @settings[:move_to_folder])
+          end
+          @imap.uid_store(uid, "+FLAGS", [:Seen])
+        end
+        @archived += 1
+      end
+
+      #------------------------------------------------------------------------------
+      def is_valid?(email)
+        valid = email.content_type != "text/html"
+        log("not a text message, discarding") unless valid
+        valid
+      end
+
+      #------------------------------------------------------------------------------
+      def sent_from_known_user?(email)
+        email_address = email.from.first
+        known = !find_sender(email_address).nil?
+        log("sent by unknown user #{email_address}, discarding") unless known
+        known
+      end
+
+      #------------------------------------------------------------------------------
+      def find_sender(email_address)
+        if @sender = User.find_by(
+            '(lower(email) = :email OR lower(alt_email) = :email) AND suspended_at IS NULL',
+            email: email_address.downcase)
+          # Set the PaperTrail user for versions (if user is found)
+          PaperTrail.whodunnit = @sender.id.to_s
+        end
+      end
+
+      #--------------------------------------------------------------------------------------
+      def sender_has_permissions_for?(asset)
+        return true if asset.access == "Public"
+        return true if asset.user_id == @sender.id || asset.assigned_to == @sender.id
+        return true if asset.access == "Shared" && Permission.exists('user_id = ? AND asset_id = ? AND asset_type = ?', @sender.id, asset.id, asset.class.to_s)
+
+        false
+      end
+
+      # Centralized logging.
+      #--------------------------------------------------------------------------------------
+      def log(message, email = nil)
+        unless %w(test cucumber).include?(Rails.env)
+          klass = self.class.to_s.split("::").last
+          klass << " [Dry Run]" if @dry_run
+          puts "[#{Time.now.rfc822}] #{klass}: #{message}"
+          puts "[#{Time.now.rfc822}] #{klass}: From: #{email.from}, Subject: #{email.subject} (#{email.message_id})" if email
+        end
+      end
+
+      # Returns the plain-text version of an email, or strips html tags
+      # if only html is present.
+      #--------------------------------------------------------------------------------------
+      def plain_text_body(email)
+        # Extract all parts including nested
+        parts = if email.multipart?
+                  email.parts.map { |p| p.multipart? ? p.parts : p }.flatten
+                else
+                  charset = email.charset
+                  [email]
+        end
+
+        if text_part = parts.detect { |p| p.content_type.include?('text/plain') }
+          text_body = text_part.body.to_s
+          charset = text_part.charset if email.multipart?
+        else
+          html_part = parts.detect { |p| p.content_type.include?('text/html') } || email
+          text_body = Premailer.new(html_part.body.to_s, with_html_string: true).to_plain_text
+          charset = html_part.charset if email.multipart?
+        end
+
+        # Convert to UTF8 and standardize newline
+        clean_invalid_utf8_bytes(text_body.strip.gsub("\r\n", "\n"), charset)
+      end
+
+      # Forces the encoding of the given string to UTF8 and replaces invalid characters. This is
+      # necessary as emails sometimes have invalid characters like MS "Smart Quotes."
+      def clean_invalid_utf8_bytes(text, src_encoding)
+        text.encode(
+          'UTF-8',
+          src_encoding,
+          invalid: :replace,
+          undef: :replace,
+          replace: ''
+        )
+      end
+    end
+  end
+end

data/lib/fat_free_crm/mail_processor/comment_replies.rb

@@ -0,0 +1,69 @@
+# Copyright (c) 2008-2013 Michael Dvorkin and contributors.
+#
+# Fat Free CRM is freely distributable under the terms of MIT license.
+# See MIT-LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+require 'fat_free_crm/mail_processor/base'
+
+module FatFreeCRM
+  module MailProcessor
+    class CommentReplies < Base
+      # Subject line of email can contain full entity, or shortcuts
+      # e.g. [contact:1234] OR [co:1234]
+      ENTITY_SHORTCUTS = {
+        'ac' => 'account',
+        'ca' => 'campaign',
+        'co' => 'contact',
+        'le' => 'lead',
+        'op' => 'opportunity',
+        'ta' => 'task'
+      }
+
+      #--------------------------------------------------------------------------------------
+      def initialize
+        @settings = Setting.email_comment_replies.dup
+        super
+      end
+
+      private
+
+      # Email processing pipeline
+      #--------------------------------------------------------------------------------------
+      def process(_uid, email)
+        with_subject_line(email) do |entity_name, entity_id|
+          create_comment email, entity_name, entity_id
+        end
+      end
+
+      # Checks the email to detect [entity:id] in the subject.
+      #--------------------------------------------------------------------------------------
+      def with_subject_line(email)
+        if /\[([^:]*):([^\]]*)\]/ =~ email.subject
+          entity_name, entity_id = Regexp.last_match[1], Regexp.last_match[2]
+          # Check that entity is a known model
+          if ENTITY_SHORTCUTS.values.include?(entity_name)
+            yield entity_name, entity_id
+          # Check if entity is a 2 letter 'shortcut'
+          elsif expanded_entity = ENTITY_SHORTCUTS[entity_name]
+            yield expanded_entity, entity_id
+          end
+        end
+      end
+
+      # Creates a new comment on an entity
+      #--------------------------------------------------------------------------------------
+      def create_comment(email, entity_name, entity_id)
+        # Find entity from subject params
+        if (entity = entity_name.capitalize.constantize.find_by_id(entity_id))
+          # Create comment if sender has permissions for entity
+          if sender_has_permissions_for?(entity)
+            parsed_reply = EmailReplyParser.parse_reply(plain_text_body(email))
+            Comment.create user:        @sender,
+                           commentable: entity,
+                           comment:     parsed_reply
+          end
+        end
+      end
+    end
+  end
+end