mail_manager 0.0.1

data/lib/daemons/mail_manager.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+# You might want to change this
+ENV['Rails.env'] ||= 'production'
+require File.dirname(__FILE__) + "/../../config/environment"
+require 'workers/mail_manager/mailing_job'
+require 'workers/mail_manager/test_message_job'
+require 'workers/mail_manager/message_job'
+require 'workers/mail_manager/bounce_job'
+
+$running = true
+Signal.trap("TERM") do
+  $running = false
+end
+
+while($running) do
+  begin
+    MailManager::MailingJob.run
+  rescue => e
+    Rails.logger.warn " MailManager::MailingJob.run failed.\n#{e.message}\n #{e.backtrace.join("  \n")}"
+  end
+  begin
+    MailManager::MessageJob.run
+  rescue => e
+    Rails.logger.warn " MailManager::MessageJob.run failed.\n#{e.message}\n #{e.backtrace.join("  \n")}"
+  end
+  begin
+    MailManager::TestMessageJob.run
+  rescue => e
+    Rails.logger.warn " MailManager::TestMessageJob.run failed.\n#{e.message}\n #{e.backtrace.join("  \n")}"
+  end
+  begin
+    MailManager::BounceJob.run
+  rescue => e
+    Rails.logger.warn " MailManager::Bounce.run failed.\n#{e.message}\n #{e.backtrace.join("  \n")}"
+  end
+  sleep 30
+end

data/lib/daemons/mail_manager_ctl

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require "daemons"
+require 'yaml'
+require 'erb'
+require 'active_support'
+
+options = YAML.load(
+  ERB.new(
+  IO.read(
+  File.dirname(__FILE__) + "/../../config/daemons.yml"
+  )).result).with_indifferent_access
+options[:dir_mode] = options[:dir_mode].to_sym
+
+Daemons.run File.dirname(__FILE__) + '/mail_manager.rb', options

data/lib/deleteable.rb

@@ -0,0 +1,50 @@
+module Deleteable
+
+  def self.included(receiver)
+    receiver.extend ClassMethods
+  end
+
+  def is_deleted?
+    !deleted_at.nil?
+  end
+
+  def delete
+    update_attribute(:deleted_at,Time.now)
+  end
+
+  def undelete
+    update_attribute(:deleted_at,nil)
+  end
+
+  module ClassMethods
+    def find(*args)
+      if args[0] == (:exclusive_scope)
+        args.shift
+        super
+      else
+        with_scope(:find => {:conditions => ["#{table_name}.deleted_at is null"]}) do
+          super
+        end
+      end
+    end
+  end
+
+end
+
+module DeleteableActions
+  def delete
+    destroy
+  end
+
+  def destroy
+    thing = controller_name.singularize.split('_').collect{|string| string.capitalize}.join.constantize.find(params[:id])
+    thing.delete
+    redirect_to(eval("#{controller_name}_path(derailed_params)"))
+  end
+
+  def undelete
+    thing = controller_name.singularize.split('_').collect{|string| string.capitalize}.join.constantize.find(:exclusive_scope,params[:id])
+    thing.undelete
+    redirect_to(eval("#{controller_name}_path(derailed_params)"))
+  end
+end

data/lib/lock.rb

@@ -0,0 +1,36 @@
+class Lock
+  class LockException < Exception
+  end
+  def self.with_lock(name, timeout=5, max_attempts=1, &block)
+    ActiveRecord::Base.connection_pool.with_connection do |connection|
+      begin
+        lock = get_lock(connection,name,timeout,max_attempts)
+        raise LockException.new("Failed to obtain lock #{name} in #{timeout} secs") unless lock
+        yield lock
+      ensure
+        is_released = release_lock(connection,name)
+        Rails.logger.warn "Warning: lock #{name} not released!" unless is_released.values.include?('1')
+      end
+    end
+  end
+  
+  private
+  
+  def self.name_prefix
+    "#{MailManager.site_url}-#{Rails.env}"
+  end
+  
+  def self.get_lock(connection,name,timeout,max_attempts)
+    attempts = 0
+    lock = {}
+    while !lock.values.include?('1') and attempts < max_attempts do 
+      attempts += 1
+      lock = connection.select_one("SELECT GET_LOCK('#{name_prefix}-#{name}',#{timeout})")
+    end
+    lock.values.detect{|value| value.to_s.eql?('1')}
+  end
+  
+  def self.release_lock(connection,name)
+    connection.select_one("SELECT RELEASE_LOCK('#{name_prefix}-#{name}')")
+  end
+end

data/lib/mail_manager.rb

@@ -0,0 +1,5 @@
+require "mail_manager/version"
+require "mail_manager/engine"
+require "deleteable" unless defined?(Deleteable)
+# Include hook code here
+require File.join(File.dirname(__FILE__), 'workers', 'mail_manager', 'bounce_job.rb')

data/lib/mail_manager/config.rb

@@ -0,0 +1,50 @@
+require 'erb'
+require 'yaml'
+
+class MailManager::Config
+  attr_reader :sections, :params
+  
+  def initialize(file = nil)
+    @sections = {}
+    @params = {}
+    use_file!(file) if file
+  end
+  
+  def use_file!(file)
+    begin
+      hash = YAML::load(ERB.new(IO.read(file)).result)       
+      @sections.merge!(hash) {|key, old_val, new_val| (old_val || new_val).merge new_val }
+      @params.merge!(@sections['common'])
+    rescue => e
+      nil
+    end    
+  end
+  
+  def use_section!(section)
+    @params.merge!(@sections[section.to_s]) if @sections.key?(section.to_s)
+  end
+  
+  def method_missing(param)
+    param = param.to_s
+    if @params.key?(param)
+      @params[param]
+    else
+      Rails.logger.warn "Invalid AppConfig Parameter " + param
+      nil
+    end
+  end
+
+  def self.initialize!
+    standard_file = File.join(Rails.root,'config','mail_manager.yml')
+    local_file = File.join(Rails.root,'config','mail_manager.local.yml')
+    unless File.exists?(standard_file)
+      $stderr.puts "Missing Configuration: either define ::Conf with proper values or create a config/mail_manager.yml with rake mail_manager:default_app_config"
+    end
+    c = ::MailManager::Config.new
+    c.use_file!("#{Rails.root}/config/mail_manager.yml")
+    c.use_file!("#{Rails.root}/config/mail_manager.local.yml")
+    c.use_section!(Rails.env)
+    c
+  end
+  
+end

data/lib/mail_manager/engine.rb

@@ -0,0 +1,43 @@
+module MailManager
+  mattr_accessor :secret, :site_url, :dont_include_images_domains, :sleep_time_between_messages, :table_prefix,
+    :default_from_email_address, :bounce, :unsubscribe_path, :site_path, :layout, :use_show_for_resources
+  class Engine < ::Rails::Engine
+    isolate_namespace MailManager
+    initializer "MailManager.config" do |app|
+      if File.exist?(File.join(Rails.root,'config','mail_manager.yml'))
+        require 'mail_manager/config'
+        MailManager.initialize_with_config(MailManager::Config.initialize!)
+      end
+    end
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+    end
+  end
+  PLUGIN_ROOT = File.expand_path(File.join(File.dirname(__FILE__),'..','..'))
+  def self.edit_route_for(contactable)
+    ContactableRegistry.edit_route_for(contactable.is_a?(String) ? contactable : contactable.class.name)
+  end
+  def self.assets_path
+    File.join(PLUGIN_ROOT,'assets')
+  end
+  def self.initialize_with_config(conf)
+    MailManager.secret ||= conf.secret rescue nil
+    default_url_options = ActionController::Base.default_url_options
+    default_site_url = "#{default_url_options[:protocol]||'http'}://#{default_url_options[:domain]}" 
+    MailManager.site_url ||= conf.site_url || default_site_url rescue default_site_url
+    MailManager.dont_include_images_domains ||= conf.dont_include_images_domains || [] rescue []
+    MailManager.sleep_time_between_messages ||= conf.sleep_time_between_messages || 0.3 rescue 0.3
+    MailManager.table_prefix ||= conf.table_prefix || 'mail_manager_' rescue 'mail_manager_'
+    MailManager.default_from_email_address ||= conf.default_from_email_address rescue nil
+    MailManager.bounce ||= conf.bounce || {} rescue {}
+    MailManager.unsubscribe_path ||= conf.unsubscribe_path || "/listmgr" rescue "/listmgr"
+    MailManager.site_path ||= conf.site_path || "/" rescue "/"
+    MailMatager.layout ||= conf.layout || "application" rescue "application"
+    MailMatager.use_show_for_resources ||= conf.use_show_for_resources || false rescue false
+  end
+end
+MailManager::Engine.config.to_prepare do
+  ApplicationController.helper(MailManager::SubscriptionsHelper)
+end
+require 'will_paginate'

data/lib/mail_manager/version.rb

@@ -0,0 +1,3 @@
+module MailManager
+  VERSION = "0.0.1"
+end

data/lib/tasks/mail_manager.rake

@@ -0,0 +1,143 @@
+require 'rake'
+ENV["Rails.env"] ||= "development"
+require "#{Rails.root}/config/environment"
+
+namespace :mail_manager do
+  desc "Create mlm LSI Auth Menus"
+  task :create_auth_menus, :parent_menu do |t,args|
+    Rails.logger.warn "Creating mlm LSI Auth Menus"
+    parent_menu = args.parent_menu
+     AdminMenu.create_or_find(
+       :description=>'Mailings',
+       :path=>'admin/mail_manager/mailings',
+       :admin_menu_id=>AdminMenu.find_by_description(parent_menu).id,
+       :menu_order=>15,
+       :is_visible=>1,
+       :auth_all=>1)
+     AdminMenu.create_or_find(
+       :description=>'Mailing Lists',
+       :path=>'admin/mail_manager/mailing_lists',
+       :admin_menu_id=>AdminMenu.find_by_description(parent_menu).id,
+       :menu_order=>20,
+       :is_visible=>1,
+       :auth_all=>1)
+     AdminMenu.create_or_find(
+       :description=>'Bounces',
+       :path=>'admin/mail_manager/bounces',
+       :admin_menu_id=>AdminMenu.find_by_description(parent_menu).id,
+       :menu_order=>30,
+       :is_visible=>1,
+       :auth_all=>1)
+     AdminMenu.create_or_find(
+       :description=>'Contacts',
+       :path=>'admin/mail_manager/contacts',
+       :admin_menu_id=>AdminMenu.find_by_description('Newsletter').id,
+       :menu_order=>10,
+       :is_visible=>1,
+       :auth_all=>1)
+     AdminMenu.create_or_find(
+       :description=>'MLM General Auth',
+       :path=>'admin/mail_manager',
+       :admin_menu_id=>nil,
+       :menu_order=>0,
+       :is_visible=>0,
+       :auth_all=>1)
+  end
+
+  desc "Add mlm defaults to config/mail_manager.yml"
+  task :default_app_config, :table_prefix do |t,args|
+    Rails.logger.warn "Adding defaults to config/mail_manager.yml"
+    begin
+      app_config = YAML.load_file('config/mail_manager.yml')
+    rescue => e
+      app_config = Hash.new
+    end
+    File.open('config/mail_manager.yml','w') do |file|
+      file.write YAML.dump({
+        'common' => {
+          'site_url' => 'http://example.com',
+          'mail_manager' => {
+            'unsubscribe_path' => '/listmgr',
+            'dont_include_images_domains' => [
+              'yahoo.com', 'google.com', 'hotmail.com'
+            ],
+            'sleep_time_between_messages' => 0.3,
+            'path_prefix' => '/admin',
+            'table_prefix' => args.table_prefix,
+            'default_from_email_address' => 'eESI <eESINews@eesipeo.com>',
+            'secret' => SecureRandom.hex(15).to_s,
+            'bounce' => {
+                'email_address' => 'test@example.com',
+                'login' => 'test',
+                'password' => 'secret',
+                'pop_server' => 'pop.example.com'
+            }
+          }
+        }
+      }.deep_merge(app_config))
+    end
+  end
+  desc "Import  Migrations"
+  task :import_migrations  do
+    Rails.logger.info "Importing  Migrations"
+    seconds_offset = 1
+    migrations_dir = ::MailManager::PLUGIN_ROOT+'/db/migrate'
+    FileUtils.mkdir_p('db/migrate') unless File.exists?('db/migrate')
+    Dir.entries(migrations_dir).
+      select{|filename| filename =~ /^\d+.*rb$/}.sort.each do |filename|
+      migration_name = filename.gsub(/^\d+/,'')
+      if Dir.entries('db/migrate').detect{|file| file =~ /^\d+#{migration_name}$/}
+        puts "Migrations already exist for #{migration_name}"
+      else
+        Rails.logger.info "Importing  Migration: #{migration_name}"
+        File.open("db/migrate/#{seconds_offset.seconds.from_now.strftime("%Y%m%d%H%M%S")}#{migration_name}",'w') do |file|
+          file.write File.readlines("#{migrations_dir}/#{filename}").join
+        end
+        seconds_offset += 1
+      end
+    end
+  end
+  desc "Create Mailing List"
+  task :create_mailing_list, :list_name do |t,args|
+    Rails.logger.warn "Creating Mailing List '#{args.list_name}'"
+    MailManager::MailingList.create(:name => args.list_name)
+  end
+
+  desc "Create Delayed Jobs for Mail Mgr"
+  task :create_delayed_jobs  do
+    Delayed::RepeatingJob.enqueue(MailManager::BounceJob.new(15.minutes))
+  end
+
+  desc "Create Groups and Users"
+  task :import_groups_and_users do
+    groups = ["CORPORATE_GOVERNMENT_GROUP", "CORPORATE_MEDICAL_GROUP", "CORPORATE_BUSINESS_GROUP", "CORPORATE_SCIENCE_AND_TECH_GROUP"]
+     #groups = ["CORPORATE_BUSINESS_GROUP"]
+
+    groups.each do |group|
+      puts "Processing group #{group}..."
+      mailing_list = MailManager::MailingList.find(:first, :conditions => ["name=?",group])
+      if mailing_list.nil?
+        mailing_list = MailManager::MailingList.create(:name => group)
+      end
+      items_read = 0
+      items_added = 0
+      group_file = File.open("#{RAILS_ROOT}/imports/#{group}.csv", "r")
+      #this works with csv file generated on microsoft office for windows
+      group_file.readlines.each do |record|
+          users = record.split(" ")
+          for u in users
+            items_read += 1
+            user = MailManager::Contact.find(:first, :conditions => ["email_address=?", u])
+            if user.nil?
+              items_added += 1
+              user = MailManager::Contact.create(:email_address => u)
+            end
+            user.subscribe(mailing_list)
+          end
+
+      end
+      puts "I read in #{items_read.to_s} items and added #{items_added.to_s} of them."
+    end
+  end
+end
+

data/lib/tasks/mail_manager_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :mail_manager do
+#   # Task goes here
+# end

data/lib/tasks/rspec.rake

@@ -0,0 +1,165 @@
+# gem 'test-unit', '1.2.3' if RUBY_VERSION.to_f >= 1.9
+
+# # Don't load rspec if running "rake gems:*"
+# unless ARGV.any? {|a| a =~ /^gems/}
+
+# begin
+#   require 'spec/rake/spectask'
+# rescue MissingSourceFile
+#   module Spec
+#     module Rake
+#       class SpecTask
+#         def initialize(name)
+#           task name do
+#             # if rspec-rails is a configured gem, this will output helpful material and exit ...
+#             require File.expand_path(File.dirname(__FILE__) + "/../../config/environment")
+
+#             # ... otherwise, do this:
+#             raise <<-MSG
+
+# #{"*" * 80}
+# *  You are trying to run an rspec rake task defined in
+# *  #{__FILE__},
+# *  but rspec can not be found in vendor/gems, vendor/plugins or system gems.
+# #{"*" * 80}
+# MSG
+#           end
+#         end
+#       end
+#     end
+#   end
+# end
+
+# Rake.application.instance_variable_get('@tasks').delete('default')
+
+# spec_prereq = File.exist?(File.join(RAILS_ROOT, 'config', 'database.yml')) ? "db:test:prepare" : :noop
+# task :noop do
+# end
+
+# task :default => :spec
+# task :stats => "spec:statsetup"
+
+# desc "Run all specs in spec directory (excluding plugin specs)"
+# Spec::Rake::SpecTask.new(:spec => spec_prereq) do |t|
+#   t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
+#   t.spec_files = FileList['spec/**/*/*_spec.rb']
+# end
+
+# namespace :spec do
+#   desc "Run all specs in spec directory with RCov (excluding plugin specs)"
+#   Spec::Rake::SpecTask.new(:rcov) do |t|
+#     t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
+#     t.spec_files = FileList['spec/**/*/*_spec.rb']
+#     t.rcov = true
+#     t.rcov_opts = lambda do
+#       IO.readlines("#{RAILS_ROOT}/spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+#     end
+#   end
+
+#   desc "Print Specdoc for all specs (excluding plugin specs)"
+#   Spec::Rake::SpecTask.new(:doc) do |t|
+#     t.spec_opts = ["--format", "specdoc", "--dry-run"]
+#     t.spec_files = FileList['spec/**/*/*_spec.rb']
+#   end
+
+#   desc "Print Specdoc for all plugin examples"
+#   Spec::Rake::SpecTask.new(:plugin_doc) do |t|
+#     t.spec_opts = ["--format", "specdoc", "--dry-run"]
+#     t.spec_files = FileList['vendor/plugins/**/spec/**/*/*_spec.rb'].exclude('vendor/plugins/rspec/*')
+#   end
+
+#   [:models, :controllers, :views, :helpers, :lib].each do |sub|
+#     desc "Run the code examples in spec/#{sub}"
+#     Spec::Rake::SpecTask.new(sub => spec_prereq) do |t|
+#       t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
+#       t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+#     end
+#   end
+
+#   desc "Run the code examples in vendor/plugins (except RSpec's own)"
+#   Spec::Rake::SpecTask.new(:plugins => spec_prereq) do |t|
+#     t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
+#     t.spec_files = FileList['vendor/plugins/**/spec/**/*/*_spec.rb'].exclude('vendor/plugins/rspec/*').exclude("vendor/plugins/rspec-rails/*")
+#   end
+
+#   namespace :plugins do
+#     desc "Runs the examples for rspec_on_rails"
+#     Spec::Rake::SpecTask.new(:rspec_on_rails) do |t|
+#       t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
+#       t.spec_files = FileList['vendor/plugins/rspec-rails/spec/**/*/*_spec.rb']
+#     end
+#   end
+
+#   # Setup specs for stats
+#   task :statsetup do
+#     require 'code_statistics'
+#     ::STATS_DIRECTORIES << %w(Model\ specs spec/models) if File.exist?('spec/models')
+#     ::STATS_DIRECTORIES << %w(View\ specs spec/views) if File.exist?('spec/views')
+#     ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers) if File.exist?('spec/controllers')
+#     ::STATS_DIRECTORIES << %w(Helper\ specs spec/helpers) if File.exist?('spec/helpers')
+#     ::STATS_DIRECTORIES << %w(Library\ specs spec/lib) if File.exist?('spec/lib')
+#     ::STATS_DIRECTORIES << %w(Routing\ specs spec/lib) if File.exist?('spec/routing')
+#     ::CodeStatistics::TEST_TYPES << "Model specs" if File.exist?('spec/models')
+#     ::CodeStatistics::TEST_TYPES << "View specs" if File.exist?('spec/views')
+#     ::CodeStatistics::TEST_TYPES << "Controller specs" if File.exist?('spec/controllers')
+#     ::CodeStatistics::TEST_TYPES << "Helper specs" if File.exist?('spec/helpers')
+#     ::CodeStatistics::TEST_TYPES << "Library specs" if File.exist?('spec/lib')
+#     ::CodeStatistics::TEST_TYPES << "Routing specs" if File.exist?('spec/routing')
+#   end
+
+#   namespace :db do
+#     namespace :fixtures do
+#       desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y. Load from subdirectory in test/fixtures using FIXTURES_DIR=z."
+#       task :load => :environment do
+#         ActiveRecord::Base.establish_connection(Rails.env)
+#         base_dir = File.join(Rails.root, 'spec', 'fixtures')
+#         fixtures_dir = ENV['FIXTURES_DIR'] ? File.join(base_dir, ENV['FIXTURES_DIR']) : base_dir
+        
+#         require 'active_record/fixtures'
+#         (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/).map {|f| File.join(fixtures_dir, f) } : Dir.glob(File.join(fixtures_dir, '*.{yml,csv}'))).each do |fixture_file|
+#           Fixtures.create_fixtures(File.dirname(fixture_file), File.basename(fixture_file, '.*'))
+#         end
+#       end
+#     end
+#   end
+
+#   namespace :server do
+#     daemonized_server_pid = File.expand_path("#{RAILS_ROOT}/tmp/pids/spec_server.pid")
+    
+#     desc "start spec_server."
+#     task :start do
+#       if File.exist?(daemonized_server_pid)
+#         $stderr.puts "spec_server is already running."
+#       else
+#         $stderr.puts %Q{Starting up spec_server ...}
+#         FileUtils.mkdir_p('tmp/pids') unless test ?d, 'tmp/pids'
+#         system("ruby", "script/spec_server", "--daemon", "--pid", daemonized_server_pid)
+#       end
+#     end
+
+#     desc "stop spec_server."
+#     task :stop do
+#       unless File.exist?(daemonized_server_pid)
+#         $stderr.puts "No server running."
+#       else
+#         $stderr.puts "Shutting down spec_server ..."
+#         system("kill", "-s", "TERM", File.read(daemonized_server_pid).strip) && 
+#         File.delete(daemonized_server_pid)
+#       end
+#     end
+
+#     desc "restart spec_server."
+#     task :restart => [:stop, :start]
+    
+#     desc "check if spec server is running"
+#     task :status do
+#       if File.exist?(daemonized_server_pid)
+#         $stderr.puts %Q{spec_server is running (PID: #{File.read(daemonized_server_pid).gsub("\n","")})}
+#       else
+#         $stderr.puts "No server running."
+#       end
+#     end
+#   end
+# end
+
+# end