delayed_mailhopper 0.0.2 → 0.0.4

data/README.md

@@ -0,0 +1,77 @@
+# DelayedMailhopper [![Build Status](https://secure.travis-ci.org/cerebris/delayed_mailhopper.png)](http://travis-ci.org/cerebris/delayed_mailhopper)
+
+DelayedMailhopper provides a simple solution to queue, deliver and archive emails in Rails apps. It extends Mailhopper and uses DelayedJob to queue delivery jobs asynchronously.
+
+## Requirements
+
+ * Rails 3.1+
+ * DelayedJob
+ * Mailhopper
+
+## Installation
+
+Add to your project's Gemfile:
+
+```
+gem 'delayed_mailhopper'
+```
+
+Install with bundler (note: also installs dependencies such as DelayedJob and Mailhopper):
+
+```
+bundle install
+```
+
+## Configure Mailhopper
+
+If you haven't already, you'll need to run generators for Mailhopper and then migrate your database.
+
+```
+rails g mailhopper
+rake db:migrate
+```
+
+## Configure DelayedJob
+
+### ActiveRecord Backend
+
+Add the gem to your Gemfile:
+
+```
+gem 'delayed_job_active_record'
+```
+
+Run the generator to create the migration for the delayed_job table.
+
+```
+rails g delayed_job:active_record
+rake db:migrate
+```
+
+see the README: https://github.com/collectiveidea/delayed_job_active_record
+
+### Mongoid backend
+
+Add the gem to your Gemfile:
+
+```
+gem 'delayed_job_mongoid'
+```
+
+Create the indexes (and don't forget to do this on your production database):
+
+```
+script/rails runner 'Delayed::Backend::Mongoid::Job.create_indexes'
+```
+
+see the README: https://github.com/collectiveidea/delayed_job_mongoid
+
+## References
+
+Please see the README for Mailhopper: https://github.com/cerebris/mailhopper
+
+And for DelayedJob: https://github.com/collectiveidea/delayed_job/
+
+## Copyright
+
+Copyright (c) 2011 Cerebris Corporation. This is free software released under the MIT License (see MIT-LICENSE for details).

data/Rakefile

@@ -5,36 +5,11 @@ begin
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'DelayedMailhopper'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task :default => :test
+task :default => :spec

data/lib/delayed_mailhopper/version.rb

@@ -1,3 +1,3 @@
 module DelayedMailhopper
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,91 +1,79 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: delayed_mailhopper
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.0.4
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Dan Gebhardt
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-02 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: mailhopper
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70244152766360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 0
-        - 0
-        - 1
+      - !ruby/object:Gem::Version
         version: 0.0.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: delayed_job
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70244152766360
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: &70244152765800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *70244152765800
+- !ruby/object:Gem::Dependency
   name: sqlite3
+  requirement: &70244152755020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :development
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70244152755020
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70244152754600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: shoulda
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70244152754600
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: &70244152754120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-description: DelayedMailhopper extends Mailhopper to deliver emails asynchronously with DelayedJob.
-email: 
+  prerelease: false
+  version_requirements: *70244152754120
+description: DelayedMailhopper extends Mailhopper to deliver emails asynchronously
+  with DelayedJob.
+email:
 - support@cerebris.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - app/models/delayed_mailhopper/email.rb
 - app/models/delayed_mailhopper/send_job.rb
 - config/routes.rb
@@ -95,123 +83,31 @@ files:
 - lib/tasks/delayed_mailhopper_tasks.rake
 - MIT-LICENSE
 - Rakefile
-- README.rdoc
-- test/delayed_mailhopper_test.rb
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/mailers/sample_mailer.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/sample_mailer/hello.text.erb
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mailhopper.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config.ru
-- test/dummy/db/development.sqlite3
-- test/dummy/db/migrate/20110804223859_create_emails.rb
-- test/dummy/db/migrate/20110804224806_create_delayed_jobs.rb
-- test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/log/development.log
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/script/delayed_job
-- test/dummy/script/rails
-- test/integration/navigation_test.rb
-- test/test_helper.rb
-- test/unit/email_test.rb
-has_rdoc: true
+- README.md
 homepage: https://github.com/cerebris/delayed_mailhopper
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: A simple solution that uses ActiveRecord and DelayedJob to queue, deliver and archive emails in Rails apps.
-test_files: 
-- test/delayed_mailhopper_test.rb
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/mailers/sample_mailer.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/sample_mailer/hello.text.erb
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mailhopper.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config.ru
-- test/dummy/db/development.sqlite3
-- test/dummy/db/migrate/20110804223859_create_emails.rb
-- test/dummy/db/migrate/20110804224806_create_delayed_jobs.rb
-- test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/log/development.log
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/script/delayed_job
-- test/dummy/script/rails
-- test/integration/navigation_test.rb
-- test/test_helper.rb
-- test/unit/email_test.rb
+summary: A simple solution that uses ActiveRecord and DelayedJob to queue, deliver
+  and archive emails in Rails apps.
+test_files: []
+has_rdoc: 

data/README.rdoc

@@ -1,35 +0,0 @@
-= DelayedMailhopper
-
-DelayedMailhopper provides a simple solution to queue, deliver and archive emails in Rails apps. It extends Mailhopper and uses DelayedJob to queue delivery jobs asynchronously.
-
-== Requirements
-
-Rails 3.1+
-DelayedJob
-Mailhopper
-
-== Installation
-
-Add to your project's Gemfile:
-
-  gem 'delayed_mailhopper'
-
-Install with bundler (note: also installs dependencies such as DelayedJob and Mailhopper):
-
-  bundle install
-
-== Install and Configure Mailhopper and DelayedJob
-
-If you haven't already, you'll need to run generators for both Mailhopper and DelayedJob and then migrate your database.
-
-  rails g mailhopper
-  rails g delayed_job
-  rake db:migrate
-
-Please see the README for Mailhopper: https://github.com/cerebris/mailhopper
-
-And for DelayedJob: https://github.com/collectiveidea/delayed_job/
-
-== Copyright
-
-Copyright (c) 2011 Cerebris Corporation. This is free software released under the MIT License (see MIT-LICENSE for details).

data/test/delayed_mailhopper_test.rb

@@ -1,7 +0,0 @@
-require 'test_helper'
-
-class DelayedMailhopperTest < ActiveSupport::TestCase
-  test "truth" do
-    assert_kind_of Module, DelayedMailhopper
-  end
-end

data/test/dummy/Rakefile

@@ -1,7 +0,0 @@
-#!/usr/bin/env rake
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('../config/application', __FILE__)
-
-Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -1,9 +0,0 @@
-// This is a manifest file that'll be compiled into including all the files listed below.
-// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
-// be included in the compiled file accessible from http://example.com/assets/application.js
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// the compiled file.
-//
-//= require jquery
-//= require jquery_ujs
-//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -1,7 +0,0 @@
-/*
- * This is a manifest file that'll automatically include all the stylesheets available in this directory
- * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
- * the top of the compiled file, but it's generally better to create a new file per style scope.
- *= require_self
- *= require_tree . 
-*/

data/test/dummy/app/controllers/application_controller.rb

@@ -1,3 +0,0 @@
-class ApplicationController < ActionController::Base
-  protect_from_forgery
-end

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +0,0 @@
-module ApplicationHelper
-end

data/test/dummy/app/mailers/sample_mailer.rb

@@ -1,8 +0,0 @@
-class SampleMailer < ActionMailer::Base
-  ActionMailer::Base.delivery_method = :mailhopper
-
-  def hello(headers, content)
-    @content = content
-    mail(headers)
-  end
-end

data/test/dummy/app/views/layouts/application.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    "application" %>
-  <%= javascript_include_tag "application" %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/test/dummy/app/views/sample_mailer/hello.text.erb

@@ -1 +0,0 @@
-<%= @content %>

data/test/dummy/config/application.rb

@@ -1,42 +0,0 @@
-require File.expand_path('../boot', __FILE__)
-
-require 'rails/all'
-
-Bundler.require
-require "delayed_mailhopper"
-
-module Dummy
-  class Application < Rails::Application
-    # Settings in config/environments/* take precedence over those specified here.
-    # Application configuration should go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded.
-
-    # Custom directories with classes and modules you want to be autoloadable.
-    # config.autoload_paths += %W(#{config.root}/extras)
-
-    # Only load the plugins named here, in the order given (default is alphabetical).
-    # :all can be used as a placeholder for all plugins not explicitly named.
-    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
-
-    # Activate observers that should always be running.
-    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
-
-    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
-    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
-    # config.time_zone = 'Central Time (US & Canada)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-
-    # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
-
-    # Configure sensitive parameters which will be filtered from the log file.
-    config.filter_parameters += [:password]
-
-    # Enable the asset pipeline
-    config.assets.enabled = true
-  end
-end
-

data/test/dummy/config/boot.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
-
-if File.exist?(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
-  Bundler.setup
-end
-
-$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -1,25 +0,0 @@
-# SQLite version 3.x
-#   gem install sqlite3
-#
-#   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
-development:
-  adapter: sqlite3
-  database: db/development.sqlite3
-  pool: 5
-  timeout: 5000
-
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
-test:
-  adapter: sqlite3
-  database: db/test.sqlite3
-  pool: 5
-  timeout: 5000
-
-production:
-  adapter: sqlite3
-  database: db/production.sqlite3
-  pool: 5
-  timeout: 5000

data/test/dummy/config/environment.rb

@@ -1,5 +0,0 @@
-# Load the rails application
-require File.expand_path('../application', __FILE__)
-
-# Initialize the rails application
-Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -1,27 +0,0 @@
-Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
-
-  # In the development environment your application's code is reloaded on
-  # every request.  This slows down response time but is perfect for development
-  # since you don't have to restart the web server when you make code changes.
-  config.cache_classes = false
-
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
-
-  # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
-  config.action_controller.perform_caching = false
-
-  # Don't care if the mailer can't send
-  config.action_mailer.raise_delivery_errors = false
-
-  # Print deprecation notices to the Rails logger
-  config.active_support.deprecation = :log
-
-  # Only use best-standards-support built into browsers
-  config.action_dispatch.best_standards_support = :builtin
-
-  # Do not compress assets
-  config.assets.compress = false
-end