mail_manager 3.0.0 → 3.2.0

data/lib/mail_manager/lock.rb

@@ -38,4 +38,5 @@ if ActiveRecord::Base.connection.adapter_name =~ /mysql/i
 else
   require 'with_lock'
   MailManager::Lock = WithLock::Client
+  MailManager::LockException = WithLock::LockException
 end

data/lib/mail_manager/version.rb

@@ -1,3 +1,3 @@
 module MailManager
-  VERSION = "3.0.0"
+  VERSION = "3.2.0"
 end

data/lib/tasks/mail_manager.rake

@@ -4,48 +4,15 @@ require File.join(Rails.root,'config','environment')
 initializer = File.join(MailManager::PLUGIN_ROOT,'config','initializers','delayed_job.rb')
 load initializer 
 
-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)
+def get_config(env,filename='config/mail_manager.yml')
+  begin
+    app_config = YAML.load_file('config/mail_manager.yml')
+  rescue => e
+    app_config = Hash.new
   end
+end
 
+namespace :mail_manager do
   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"
@@ -55,26 +22,95 @@ namespace :mail_manager do
       app_config = Hash.new
     end
     File.open('config/mail_manager.yml','w') do |file|
+      table_prefix = args.table_prefix || 'mail_manager_'
+      file.write <<EOT
+# this file is used to configure the mail_manager gem
+# it works like an older gem called AppConfig
+# all environments start with settings from the 'common' section
+# and are overridden by the section that matches the environment's name
+# also .. if you create a 'config/mail_manager.local.yml' it will override
+# what is in 'config/mail_manager.yml' such that you can keep a  version 
+# for local settings and not overwrite one that you include in your source control
+# also ... these files allow the use of erb syntax to set variables with ruby thus
+# allowing ENV variables and such to be used
+# here are the valid settings and what they are for:
+# site_url: used in various places to get the url of the site (such as in mailings templates)
+# public_layout: layout used for public facing pages like unsubscribing and opt-in pages
+# layout: layout used for mail manager administratin pages
+# site_path: used in case your rails site is at a sub-path of the site url
+# exception_notification: (grouping for who gets notified of exceptions)
+#   to_addresses: an array of recipients for exceptions
+#   from_address: who the exception appears to be from
+# requires_authentication: whether the mail manager app requires login
+# authorized_roles: array of role names that can administer the mail manager
+# roles_method: the method that your "current_user" object defines its role names(returns a list of strings)
+# unsubscribe_path: public url for unsubscribing ... this is a prefix and is followed by a message 'guid', defaults to '/listmgr' and routes as '/listmgr/:guid'
+# dont_include_images_domains: a list of domains that won't include images in the email, whether or not the mailing is set to include them
+# sleep_time_between_messages: a timeout between messages to slow the output of emails to your email server; you should probably limit with your mail server itself if possible
+# path_prefix: a prefix to the mail manager routes(defaults to /admin)
+# table_prefix: prefixes all mail manager tables with a string to avoid collisions with your app - should be set BEFORE running migrations
+# default_from_email_address: where any public messages from the app default to for the "FROM:" header
+# secret: a secret for encrypting tokens and guids
+# bounce: (a grouping for 'POP' settings for bounce messages and the RETURN_PATH: header)
+#   email_address: the account for POPing bounces and RETURN_PATH
+#   login: login for account for POPing
+#   password: password for account for POPing
+#   pop_server: POP server
+#   port: PORT of pop server
+#   ssl: true/false whether you want to enable ssl for pop
+# subscribe_path: public path for double-opt-in 'subscribe' step which sends the email
+# honey_pot_field: used to set a field name which will ignore submissions to the subscribe action if filled
+# double_opt_in_path: path to route the double-opt-in confirmation action to
+# signup_email_address: email address for the FROM: of a double opt in/subscribe email
+#
+# The following 2 might be deprecated soon
+# show_title: can be used in templates/layouts to see whether you should show a title
+# use_show_for_resources: whether to have links to "show" actions - we don't use them really in this app..
+# and the 'show' actions aren't really currently supported
+#
+EOT
       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' => 'Contact <contact@example.com>',
-            'secret' => SecureRandom.hex(15).to_s,
-            'bounce' => {
-                'email_address' => 'bounces@example.com',
-                'login' => 'test',
-                'password' => 'secret',
-                'pop_server' => 'pop.example.com'
-            }
+          'public_layout' => 'layout',
+          'site_path' => '/',
+          'use_show_for_resources' => false,
+          'exception_notification' => {
+            'to_addresses' => ['bobo@example.com'],
+            'from_address' => 'Mail Manager Exception <admin@example.com>'
+          },
+          'requires_authentication' => false,
+          'roles_method' => nil,
+          'authorized_roles' => [],
+          'unsubscribe_path' => '/listmgr',
+          'subscribe_path' => '/listmgr/subscribe',
+          'subscribe_thank_you_path' => '/listmgr/subscribe_thank_you',
+          'double_opt_in_path' => '/listmgr/confirm',
+          'honey_pot_field' => 'company_name',
+          'signup_email_address' => 'Register <signup@example.com>',
+          'dont_include_images_domains' => [
+            'yahoo.com', 'google.com', 'hotmail.com', 'aol.com', 'gmail.com',
+            'outlook.com'
+          ],
+          'sleep_time_between_messages' => 0.3,
+          'path_prefix' => '/admin',
+          'table_prefix' => table_prefix,
+          'default_from_email_address' => 'Contact <contact@example.com>',
+          'secret' => SecureRandom.hex(15).to_s,
+          'bounce' => {
+              'email_address' => 'bounces@example.com',
+              'login' => 'test',
+              'password' => 'secret',
+              'pop_server' => 'pop.example.com'
           }
+        },
+        'development' => {
+          'site_url' => 'http://example.dev',
+          'secret' => SecureRandom.hex(15).to_s
+        },
+        'test' => {
+          'site_url' => 'http://example.lvh.me:4000',
+          'secret' => SecureRandom.hex(15).to_s
         }
       }.deep_merge(app_config))
     end

data/mail_manager.gemspec

@@ -8,11 +8,15 @@ Gem::Specification.new do |gem|
   gem.version       = MailManager::VERSION
   gem.authors       = ["Lone Star Internet"]
   gem.email         = ["biz@lone-star.net"]
+  gem.licenses      = ["MIT"]
   gem.description   = %q{Manages the delivery of mailable items. Handles bounces, unsubscribe, opt-in, etc.}
   gem.summary       = %q{Mailing list management tool}
   gem.homepage      = "http://ireach.com"
 
   gem.add_dependency "rails", "~>3.2"
+  gem.add_dependency 'jquery-rails', "~>3.1"
+  gem.add_dependency 'jquery-ui-rails', "~>5.0"
+  gem.add_dependency 'jquery-ui-themes', "~>0.0"
   gem.add_dependency "daemons", "~>1.1"
   gem.add_dependency "with_lock", "~>0.1"
   gem.add_dependency "mini_magick", "~>4.1"

data/spec/rails_helper.rb

@@ -0,0 +1,50 @@
+## This file is copied to spec/ when you run 'rails generate rspec:install'
+#ENV['RAILS_ENV'] ||= 'test'
+#require 'spec_helper'
+#require File.expand_path('../../config/environment', __FILE__)
+#require 'rspec/rails'
+#require 'capybara/rails'
+#require 'factory_girl_rails'
+#FactoryGirl.definition_file_paths = [File.expand_path('../factories', __FILE__)]
+#FactoryGirl.find_definitions
+## Add additional requires below this line. Rails is not loaded until this point!
+#
+## Requires supporting ruby files with custom matchers and macros, etc, in
+## spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+## run as spec files by default. This means that files in spec/support that end
+## in _spec.rb will both be required and run as specs, causing the specs to be
+## run twice. It is recommended that you do not name files matching this glob to
+## end with _spec.rb. You can configure this pattern with the --pattern
+## option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+##
+## The following line is provided for convenience purposes. It has the downside
+## of increasing the boot-up time by auto-requiring all files in the support
+## directory. Alternatively, in the individual `*_spec.rb` files, manually
+## require only the support files necessary.
+##
+## Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+#
+#RSpec.configure do |config|
+#  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+#  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+#
+#  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+#  # examples within a transaction, remove the following line or assign false
+#  # instead of true.
+#  config.use_transactional_fixtures = true
+#
+#  # RSpec Rails can automatically mix in different behaviours to your tests
+#  # based on their file location, for example enabling you to call `get` and
+#  # `post` in specs under `spec/controllers`.
+#  #
+#  # You can disable this behaviour by removing the line below, and instead
+#  # explicitly tag your specs with their type, e.g.:
+#  #
+#  #     RSpec.describe UsersController, :type => :controller do
+#  #       # ...
+#  #     end
+#  #
+#  # The different available types are documented in the features, such as in
+#  # https://relishapp.com/rspec/rspec-rails/docs
+#  config.infer_spec_type_from_file_location!
+#end

data/spec/spec_helper.rb

@@ -1,48 +1,87 @@
-# This file is copied to spec/ when you run 'rails generate rspec:install'
-ENV["RAILS_ENV"] ||= 'test'
-
-require File.expand_path("../../spec/test_app/config/environment", __FILE__)
-
-require 'database_cleaner'
-require 'rspec/rails'
-# require 'rspec/autorun'
-`rake db:schema:load`
-# Requires supporting ruby files with custom matchers and macros, etc,
-# in spec/support/ and its subdirectories.
-Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
-
-RSpec.configure do |config|
-  # ## Mock Framework
-  #
-  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
-  #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
-
-  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
-
-  # If you're not using ActiveRecord, or you'd prefer not to run each of your
-  # examples within a transaction, remove the following line or assign false
-  # instead of true.
-  config.use_transactional_fixtures = true
-
-  # If true, the base class of anonymous controllers will be inferred
-  # automatically. This will be the default behavior in future versions of
-  # rspec-rails.
-  config.infer_base_class_for_anonymous_controllers = false
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = "random"
-  # Use color in STDOUT
-  config.color_enabled = true
-
-  # Use color not only in STDOUT but also in pagers and files
-  #config.tty = true
-
-  #config.formatter = :documentation # :progress, :html, :textmate
-end
+## This file was generated by the `rails generate rspec:install` command. Conventionally, all
+## specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+## The generated `.rspec` file contains `--require spec_helper` which will cause
+## this file to always be loaded, without a need to explicitly require it in any
+## files.
+##
+## Given that it is always loaded, you are encouraged to keep this file as
+## light-weight as possible. Requiring heavyweight dependencies from this file
+## will add to the boot time of your test suite on EVERY test run, even for an
+## individual file that may not need all of that loaded. Instead, consider making
+## a separate helper file that requires the additional dependencies and performs
+## the additional setup, and require it from the spec files that actually need
+## it.
+##
+## The `.rspec` file also contains a few flags that are not defaults but that
+## users commonly want.
+##
+## See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+#RSpec.configure do |config|
+#  # rspec-expectations config goes here. You can use an alternate
+#  # assertion/expectation library such as wrong or the stdlib/minitest
+#  # assertions if you prefer.
+#  config.expect_with :rspec do |expectations|
+#    # This option will default to `true` in RSpec 4. It makes the `description`
+#    # and `failure_message` of custom matchers include text for helper methods
+#    # defined using `chain`, e.g.:
+#    #     be_bigger_than(2).and_smaller_than(4).description
+#    #     # => "be bigger than 2 and smaller than 4"
+#    # ...rather than:
+#    #     # => "be bigger than 2"
+#    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+#  end
+#
+#  # rspec-mocks config goes here. You can use an alternate test double
+#  # library (such as bogus or mocha) by changing the `mock_with` option here.
+#  config.mock_with :rspec do |mocks|
+#    # Prevents you from mocking or stubbing a method that does not exist on
+#    # a real object. This is generally recommended, and will default to
+#    # `true` in RSpec 4.
+#    mocks.verify_partial_doubles = true
+#  end
+#
+## The settings below are suggested to provide a good initial experience
+## with RSpec, but feel free to customize to your heart's content.
+#=begin
+#  # These two settings work together to allow you to limit a spec run
+#  # to individual examples or groups you care about by tagging them with
+#  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+#  # get run.
+#  config.filter_run :focus
+#  config.run_all_when_everything_filtered = true
+#
+#  # Limits the available syntax to the non-monkey patched syntax that is
+#  # recommended. For more details, see:
+#  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+#  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+#  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+#  config.disable_monkey_patching!
+#
+#  # Many RSpec users commonly either run the entire suite or an individual
+#  # file, and it's useful to allow more verbose output when running an
+#  # individual spec file.
+#  if config.files_to_run.one?
+#    # Use the documentation formatter for detailed output,
+#    # unless a formatter has already been configured
+#    # (e.g. via a command-line flag).
+#    config.default_formatter = 'doc'
+#  end
+#
+#  # Print the 10 slowest examples and example groups at the
+#  # end of the spec run, to help surface which specs are running
+#  # particularly slow.
+#  config.profile_examples = 10
+#
+#  # Run specs in random order to surface order dependencies. If you find an
+#  # order dependency and want to debug it, you can fix the order by providing
+#  # the seed, which is printed after each run.
+#  #     --seed 1234
+#  config.order = :random
+#
+#  # Seed global randomization in this process using the `--seed` CLI option.
+#  # Setting this allows you to use `--seed` to deterministically reproduce
+#  # test failures related to randomization by passing the same `--seed` value
+#  # as the one that triggered the failure.
+#  Kernel.srand config.seed
+#=end
+#end

data/spec/test_app/.env.development

@@ -0,0 +1,3 @@
+export POST_OFFICE_SMTP_PORT=25001
+export POST_OFFICE_POP_PORT=11011
+export SERVER_PORT=3010

data/spec/test_app/.env.test

@@ -0,0 +1,2 @@
+export POST_OFFICE_SMTP_PORT=25000
+export POST_OFFICE_POP_PORT=11000

data/spec/test_app/.rspec

@@ -1,2 +1,3 @@
 --color
 --format documentation
+--require spec_helper

data/spec/test_app/Procfile

@@ -0,0 +1,3 @@
+post_office: bundle exec script/post_office run
+delayed_job: bundle exec script/delayed_job run
+web:         spring rails s WEBrick

data/spec/test_app/app/controllers/application_controller.rb

@@ -1,3 +1,7 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery
+  helper_method :current_user
+  def current_user
+    @current_user ||= User.first
+  end
 end

data/spec/test_app/app/models/ability.rb

@@ -0,0 +1,7 @@
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    eval MailManager.abilities
+  end
+end

data/spec/test_app/app/models/user.rb

@@ -3,11 +3,17 @@ class User < ActiveRecord::Base
 
   validates :email, uniqueness: true, presence: true
 
+  def roles
+    return ['admin'] if last_name.include?('admin')
+    ['user']
+  end
+
   include MailManager::ContactableRegistry::Contactable
 end
 
 MailManager::ContactableRegistry.register_contactable("User",{
   first_name: :first_name,
   last_name: :last_name,
-  email_address: :email
-  })
+  email_address: :email,
+  phone: :phone
+  })

data/spec/test_app/app/models/user_with_role.rb

@@ -0,0 +1,22 @@
+class UserWithRole < ActiveRecord::Base
+  self.table_name = :users
+
+  def role
+    return 'admin' if last_name.include?('admin')
+    return 'user' if last_name.include?('user')
+    nil
+  end
+
+  attr_accessible :email, :first_name, :last_name, :phone
+
+  validates :email, uniqueness: true, presence: true
+
+  include MailManager::ContactableRegistry::Contactable
+end
+
+MailManager::ContactableRegistry.register_contactable("User",{
+  first_name: :first_name,
+  last_name: :last_name,
+  email_address: :email,
+  phone: :phone
+})