Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
dgeb committed Aug 5, 2011
0 parents commit 26e5535
Show file tree
Hide file tree
Showing 56 changed files with 943 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .gitignore
@@ -0,0 +1,6 @@
.bundle/
log/*.log
pkg/
test/dummy/db/*.sqlite3
test/dummy/log/*.log
test/dummy/tmp/
14 changes: 14 additions & 0 deletions Gemfile
@@ -0,0 +1,14 @@
source "http://rubygems.org"

# Declare your gem's dependencies in delayed_mailhopper.gemspec.
# Bundler will treat runtime dependencies like base dependencies, and
# development dependencies will be added by default to the :development group.
gemspec

# Declare any dependencies that are still in development here instead of in
# your gemspec. These might include edge Rails or gems from your path or
# Git. Remember to move these dependencies to your gemspec before releasing
# your gem to rubygems.org.

# To use debugger
# gem 'ruby-debug'
105 changes: 105 additions & 0 deletions Gemfile.lock
@@ -0,0 +1,105 @@
PATH
remote: .
specs:
delayed_mailhopper (0.0.1)
delayed_job
mailhopper (~> 0.0.1)
rails (~> 3.1.0.rc5)

GEM
remote: http://rubygems.org/
specs:
actionmailer (3.1.0.rc5)
actionpack (= 3.1.0.rc5)
mail (~> 2.3.0)
actionpack (3.1.0.rc5)
activemodel (= 3.1.0.rc5)
activesupport (= 3.1.0.rc5)
builder (~> 3.0.0)
erubis (~> 2.7.0)
i18n (~> 0.6)
rack (~> 1.3.2)
rack-cache (~> 1.0.2)
rack-mount (~> 0.8.1)
rack-test (~> 0.6.0)
sprockets (~> 2.0.0.beta.12)
activemodel (3.1.0.rc5)
activesupport (= 3.1.0.rc5)
bcrypt-ruby (~> 2.1.4)
builder (~> 3.0.0)
i18n (~> 0.6)
activerecord (3.1.0.rc5)
activemodel (= 3.1.0.rc5)
activesupport (= 3.1.0.rc5)
arel (~> 2.1.4)
tzinfo (~> 0.3.29)
activeresource (3.1.0.rc5)
activemodel (= 3.1.0.rc5)
activesupport (= 3.1.0.rc5)
activesupport (3.1.0.rc5)
multi_json (~> 1.0)
arel (2.1.4)
bcrypt-ruby (2.1.4)
builder (3.0.0)
daemons (1.1.4)
delayed_job (2.1.4)
activesupport (~> 3.0)
daemons
erubis (2.7.0)
hike (1.2.0)
i18n (0.6.0)
mail (2.3.0)
i18n (>= 0.4.0)
mime-types (~> 1.16)
treetop (~> 1.4.8)
mailhopper (0.0.2)
rails (~> 3.1.0.rc5)
mime-types (1.16)
multi_json (1.0.3)
polyglot (0.3.2)
rack (1.3.2)
rack-cache (1.0.2)
rack (>= 0.4)
rack-mount (0.8.1)
rack (>= 1.0.0)
rack-ssl (1.3.2)
rack
rack-test (0.6.1)
rack (>= 1.0)
rails (3.1.0.rc5)
actionmailer (= 3.1.0.rc5)
actionpack (= 3.1.0.rc5)
activerecord (= 3.1.0.rc5)
activeresource (= 3.1.0.rc5)
activesupport (= 3.1.0.rc5)
bundler (~> 1.0)
railties (= 3.1.0.rc5)
railties (3.1.0.rc5)
actionpack (= 3.1.0.rc5)
activesupport (= 3.1.0.rc5)
rack-ssl (~> 1.3.2)
rake (>= 0.8.7)
rdoc (~> 3.4)
thor (~> 0.14.6)
rake (0.9.2)
rdoc (3.9.1)
shoulda (2.11.3)
sprockets (2.0.0.beta.12)
hike (~> 1.2)
rack (~> 1.0)
tilt (!= 1.3.0, ~> 1.1)
sqlite3 (1.3.4)
thor (0.14.6)
tilt (1.3.2)
treetop (1.4.10)
polyglot
polyglot (>= 0.3.1)
tzinfo (0.3.29)

PLATFORMS
ruby

DEPENDENCIES
delayed_mailhopper!
shoulda
sqlite3
20 changes: 20 additions & 0 deletions MIT-LICENSE
@@ -0,0 +1,20 @@
Copyright 2011 YOURNAME

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35 changes: 35 additions & 0 deletions README.rdoc
@@ -0,0 +1,35 @@
= 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).
40 changes: 40 additions & 0 deletions Rakefile
@@ -0,0 +1,40 @@
#!/usr/bin/env rake
begin
require 'bundler/setup'
Bundler::GemHelper.install_tasks
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__)
load 'rails/tasks/engine.rake'


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
13 changes: 13 additions & 0 deletions app/models/delayed_mailhopper/email.rb
@@ -0,0 +1,13 @@
require 'mailhopper'
require 'delayed_job'

module DelayedMailhopper
class Email < Mailhopper::Email
after_create :enqueue

def enqueue
dj = Delayed::Job.enqueue(SendJob.new(self.id))
self.save!
end
end
end
16 changes: 16 additions & 0 deletions app/models/delayed_mailhopper/send_job.rb
@@ -0,0 +1,16 @@
module DelayedMailhopper
class SendJob < Struct.new(:id)
def perform
Email.find(id).send!
end

def success(job)
Rails::logger.info "[DelayedMailhopper::SendJob] success for email_id #{id}, delayed_job_id #{job.id}"
end

def error(job, e)
Rails::logger.error "[DelayedMailhopper::SendJob] error for email_id #{id}, delayed_job_id #{job.id}\n" +
"#{e.class}\n#{e.message}\n\n=== BACKTRACE ===\n" + e.backtrace.join("\n")
end
end
end
2 changes: 2 additions & 0 deletions config/routes.rb
@@ -0,0 +1,2 @@
Rails.application.routes.draw do
end
25 changes: 25 additions & 0 deletions delayed_mailhopper.gemspec
@@ -0,0 +1,25 @@
$:.push File.expand_path("../lib", __FILE__)

# Maintain your gem's version:
require "delayed_mailhopper/version"

# Describe your gem and declare its dependencies:
Gem::Specification.new do |s|
s.name = "delayed_mailhopper"
s.version = DelayedMailhopper::VERSION
s.authors = ["Dan Gebhardt"]
s.email = ["support@cerebris.com"]
s.homepage = "https://github.com/cerebris/delayed_mailhopper"
s.summary = "A simple solution that uses ActiveRecord and DelayedJob to queue, deliver and archive emails in Rails apps."
s.description = "DelayedMailhopper extends Mailhopper to deliver emails asynchronously with DelayedJob."

s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", "README.rdoc"]
s.test_files = Dir["test/**/*"]

s.add_dependency "rails", "~> 3.1.0.rc5"
s.add_dependency "mailhopper", "~> 0.0.1"
s.add_dependency "delayed_job"

s.add_development_dependency "sqlite3"
s.add_development_dependency "shoulda"
end
9 changes: 9 additions & 0 deletions lib/delayed_mailhopper.rb
@@ -0,0 +1,9 @@
require "delayed_mailhopper/engine"
require File.expand_path('../../app/models/delayed_mailhopper/email', __FILE__)

module DelayedMailhopper
end

::Mailhopper.setup do |config|
config.email_class = DelayedMailhopper::Email
end
4 changes: 4 additions & 0 deletions lib/delayed_mailhopper/engine.rb
@@ -0,0 +1,4 @@
module DelayedMailhopper
class Engine < Rails::Engine
end
end
3 changes: 3 additions & 0 deletions lib/delayed_mailhopper/version.rb
@@ -0,0 +1,3 @@
module DelayedMailhopper
VERSION = "0.0.1"
end
4 changes: 4 additions & 0 deletions lib/tasks/delayed_mailhopper_tasks.rake
@@ -0,0 +1,4 @@
# desc "Explaining what the task does"
# task :delayed_mailhopper do
# # Task goes here
# end
6 changes: 6 additions & 0 deletions script/rails
@@ -0,0 +1,6 @@
#!/usr/bin/env ruby
#!/usr/bin/env ruby
# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.

ENGINE_PATH = File.expand_path('../..', __FILE__)
load File.expand_path('../../test/dummy/script/rails', __FILE__)
7 changes: 7 additions & 0 deletions test/delayed_mailhopper_test.rb
@@ -0,0 +1,7 @@
require 'test_helper'

class DelayedMailhopperTest < ActiveSupport::TestCase
test "truth" do
assert_kind_of Module, DelayedMailhopper
end
end
7 changes: 7 additions & 0 deletions test/dummy/Rakefile
@@ -0,0 +1,7 @@
#!/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
9 changes: 9 additions & 0 deletions test/dummy/app/assets/javascripts/application.js
@@ -0,0 +1,9 @@
// 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 .
7 changes: 7 additions & 0 deletions test/dummy/app/assets/stylesheets/application.css
@@ -0,0 +1,7 @@
/*
* 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 .
*/
3 changes: 3 additions & 0 deletions test/dummy/app/controllers/application_controller.rb
@@ -0,0 +1,3 @@
class ApplicationController < ActionController::Base
protect_from_forgery
end
2 changes: 2 additions & 0 deletions test/dummy/app/helpers/application_helper.rb
@@ -0,0 +1,2 @@
module ApplicationHelper
end
8 changes: 8 additions & 0 deletions test/dummy/app/mailers/sample_mailer.rb
@@ -0,0 +1,8 @@
class SampleMailer < ActionMailer::Base
ActionMailer::Base.delivery_method = :mailhopper

def hello(headers, content)
@content = content
mail(headers)
end
end
Empty file added test/dummy/app/models/.gitkeep
Empty file.
14 changes: 14 additions & 0 deletions test/dummy/app/views/layouts/application.html.erb
@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html>
<head>
<title>Dummy</title>
<%= stylesheet_link_tag "application" %>
<%= javascript_include_tag "application" %>
<%= csrf_meta_tags %>
</head>
<body>

<%= yield %>

</body>
</html>
1 change: 1 addition & 0 deletions test/dummy/app/views/sample_mailer/hello.text.erb
@@ -0,0 +1 @@
<%= @content %>
4 changes: 4 additions & 0 deletions test/dummy/config.ru
@@ -0,0 +1,4 @@
# This file is used by Rack-based servers to start the application.

require ::File.expand_path('../config/environment', __FILE__)
run Dummy::Application

0 comments on commit 26e5535

Please sign in to comment.