resque_delivery 0.0.1

data/.gitignore

@@ -0,0 +1,13 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+Gemfile.lock
+
+*.swp
+*.DS_Store

data/README.md

@@ -0,0 +1,41 @@
+# ResqueDelivery
+
+This gem is a library that lets you easily integrate ActionMailer with Resque.  It allows you to replace your application's delivery method with a Resque backed asynchronous job.
+
+This allows you to avoid mail delivery exception handling throughout your app.  Additionally, you can retry delivery programatically via `resque-retry` or manually.
+
+## Installation
+
+In your Gemfile:
+
+``` ruby
+gem 'resque_delivery'
+```
+
+In your `config/environments/[RAILS_ENV].rb:`
+
+``` ruby
+config.action_mailer.resque_delivery_settings = {
+	:delivery_method => :smtp # your real delivery method
+}
+```
+
+It's that simple.  Your Mailer.mail_name(params).deliver will now queue the Resque job for sending that email.
+
+## Additional Configuration
+
+You can configure 2 additional options in your resque_delivery_settings hash:
+
+* :queue - which resque queue to place the job in
+* :job_class - (String or Class) - The job that will be queued. It is recommended that you inherit from the `ResqueDelivery::SendMail` class.
+
+## Notes
+
+We serialize the Mail::Message object (via to_yaml and from_yaml) so that you can pass objects to your Mailer classes.  Other similar
+implementations of asynchronous mailing, queue the Mailer name with the mail parameters, building the email parts at send time. This 
+implementation allows our workers to be unaware of any data models or views that are required to build the email.  Additionally, no further 
+code changes are required to make your mails asynchronous (well, assuming you already have Resque configured).
+
+## Changelog
+
+* 0.0.1 - Initial Version

data/lib/resque_delivery.rb

@@ -0,0 +1,45 @@
+class ResqueDelivery
+  class SettingsError < ArgumentError; end
+
+  attr_reader :delivery_method, :queue, :job_class
+
+  def initialize(options)
+    @delivery_method = options[:delivery_method]
+    @queue = options[:queue] || :medium
+    @job_class = options[:job_class] || SendMail
+    @job_class = @job_class.constantize if @job_class.is_a?(String)
+
+    @job_class.instance_variable_set(:@queue, @queue)
+
+    raise SettingsError, "you must specify config.action_mailer.resque_delivery_settings to contain a :delivery_method" unless @delivery_method
+  end
+
+  def deliver!(mail)
+    # serialize the mail object for later sending
+    Resque.enqueue_to(queue, job_class, delivery_method, mail.to_yaml)
+  end
+
+  class SendMail
+    @queue = :medium
+
+    class << self
+      def perform(delivery_method, mail_yaml)
+        real_delivery_method(delivery_method).deliver!(build_message(mail_yaml))
+      end
+      protected
+
+      # deserialize the mail object
+      def build_message(mail_yaml)
+        Mail::Message.from_yaml(mail_yaml)
+      end
+
+      def real_delivery_method(delivery_method)
+        settings = ActionMailer::Base.send(:"#{delivery_method}_settings")
+        ActionMailer::Base.delivery_methods[delivery_method.to_sym].new(settings)
+      end
+    end
+  end
+
+end
+
+ActionMailer::Base.add_delivery_method(:resque_delivery, ResqueDelivery)

data/resque_delivery.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |gem|
+  gem.name = %q{resque_delivery}
+  gem.authors = ["Jeff Ching"]
+  gem.date = %q{2012-10-15}
+  gem.description = %q{With ResqueDelivery, you can send ActionMailer messages asynchronously with Resque.}
+  gem.summary = "Basic asynchronous ActionMailer delivery through Resque."
+  gem.email = %q{ching.jeff@gmail.com}
+  gem.homepage = 'http://github.com/chingor13/resque_delivery'
+
+  gem.add_runtime_dependency 'actionmailer', '~> 3.0'
+  gem.add_runtime_dependency 'resque'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "resque_delivery"
+  gem.require_paths = ['lib']
+  gem.version       = "0.0.1"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: resque_delivery
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeff Ching
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: With ResqueDelivery, you can send ActionMailer messages asynchronously
+  with Resque.
+email: ching.jeff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- lib/resque_delivery.rb
+- resque_delivery.gemspec
+homepage: http://github.com/chingor13/resque_delivery
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Basic asynchronous ActionMailer delivery through Resque.
+test_files: []