resque-smtp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cda4d7d88ad9db0fed99be98995835730f64bcb1
+  data.tar.gz: b009ba831cdcc2d84793475d1f8e650e9e39a9df
+SHA512:
+  metadata.gz: be8bcbbcb970df3961c4584982fc2209f5152c82ea3e841e24b495b1f638c6d351fb0408c4541b495f00b5fd7a67682f24db48fa8d6df3616c5ed9d4f79dee3a
+  data.tar.gz: 910bf8f344f5f42356d252587420e7596a0f969bb41cb2627ae3f539c9e8bcc1cfc97b1eeb57cbd20d3b487fd0f9498e7f2d577bd71d803c9e02c610e18d5bfd

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in resque-smtp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Restorando
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,76 @@
+# Resque::SMTP
+
+This gem allows you to do the mail delivery inside a Resque job.
+
+What's the difference with other gems that send the email in Resque jobs?
+
+The other gems aim to render and deliver the mail inside the job. Resque::SMTP only handles the deliver, this allows you to have workers that don't have all your dependencies (eg. Rails mailers), but can be retried if your mail provider fails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'resque-smtp'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-smtp
+
+## Usage
+
+### Rails users
+
+1. Configure wich mails you want to use resque-smtp.
+   This can be done to all your emails with in your `application.rb` (or in a per environment basis)
+
+   ```ruby
+   config.action_mailer.delivery_method = :resque_smtp
+   ```
+
+2. The default Resque queue name is: `mailing`, this can be changed with:
+
+   ```ruby
+   config.action_mailer.resque_smtp_settings = { queue: "default" }
+   ```
+
+3. Done!
+
+resque-smtp will use the `action_mailer.smtp_settings` to send the mails in the queue.
+
+### Mail gem users
+
+1. Configure your smtp settings in `Resque::SMTP.smtp_settings`
+   eg.
+
+    ```ruby
+    Resque::SMTP.smtp_settings = { :address              => "smtp.me.com",
+                                   :port                 => 587,
+                                   :domain               => 'your.host.name',
+                                   :user_name            => '<username>',
+                                   :password             => '<password>',
+                                   :authentication       => 'plain',
+                                   :enable_starttls_auto => true  }
+    ```
+2. Configure Mail defaults to use Resque::SMTP (the queue parameter is optional, it defaults
+   to `"mailing"`)
+  eg.
+
+    ```ruby
+    Mail.defaults do
+      delivery_method Resque::SMTP::DeliveryMethod, queue: "default"
+    end
+    ```
+
+3. Done!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+task default: :test

data/lib/resque/smtp.rb

@@ -0,0 +1,15 @@
+require 'resque/smtp/version'
+
+module Resque
+  module SMTP
+    autoload :EmailJob,       'resque/smtp/email_job'
+    autoload :DeliveryMethod, 'resque/smtp/delivery_method'
+
+    class << self
+      attr_accessor :smtp_settings
+    end
+
+  end
+end
+
+require 'resque/smtp/railtie' if defined? Rails

data/lib/resque/smtp/delivery_method.rb

@@ -0,0 +1,30 @@
+require 'resque/smtp'
+require 'resque'
+
+module Resque::SMTP
+
+  # Enqueues emails in Resque.
+  #
+  # Just set action_mailer delivery method to :resque_smtp and all
+  # emails will be enqueued.
+  #
+  # Delivery settings are not used as they are extracted from RCore.config
+  # at the moment emails are really delivered.
+  #
+  # If you want to have dedicated settings for this method you can set
+  # config.action_mailer.smtp_resque_settings in the application config.
+  #
+  class DeliveryMethod
+
+    def initialize(settings)
+      @settings = settings
+      EmailJob.queue = settings[:queue] if settings[:queue]
+    end
+
+    def deliver!(mail)
+      # Enqueue email dumped as string
+      Resque.enqueue(EmailJob, mail.encoded)
+    end
+
+  end
+end

data/lib/resque/smtp/email_job.rb

@@ -0,0 +1,33 @@
+require 'resque/smtp'
+require 'mail'
+
+module Resque::SMTP
+  # Class for sending emails enqueued in Resque.
+  #
+  # If you want to enqueue emails to be delivered later by this class
+  # you can do:
+  #
+  #   mail = Mail.new(to: 'cosme@example.com')
+  #   Resque.enqueue(Resque::SMTP::EmailJob, mail.encoded)
+  #
+  class EmailJob
+
+    class << self
+      attr_accessor :queue
+    end
+
+    @queue = 'mailing'
+
+    def self.perform(encoded_mail)
+
+      mail = Mail.new(encoded_mail)
+      mail.delivery_method :smtp, Resque::SMTP.smtp_settings || {}
+
+      # Send without informing observers and interceptors and bypass
+      # checking perform_deliveries and raise_delivery_errors.
+      mail.delivery_method.deliver! mail
+
+    end
+
+  end
+end

data/lib/resque/smtp/railtie.rb

@@ -0,0 +1,19 @@
+require 'resque/smtp'
+
+module Resque::SMTP
+
+  class Railtie < Rails::Railtie
+    initializer "resque-smtp.action_mailer" do
+
+      ActiveSupport.on_load(:action_mailer) do
+
+        ActionMailer::Base.add_delivery_method :resque_smtp, Resque::SMTP::DeliveryMethod
+
+        Resque::SMTP.smtp_settings = ActionMailer::Base.smtp_settings
+
+      end
+
+    end
+  end
+
+end

data/lib/resque/smtp/version.rb

@@ -0,0 +1,5 @@
+module Resque
+  module SMTP
+    VERSION = "0.1.0"
+  end
+end

data/resque-smtp.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque/smtp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resque-smtp"
+  spec.version       = Resque::SMTP::VERSION
+  spec.authors       = ["Restoradno"]
+  spec.email         = ["dev@restorando.com"]
+  spec.description   = %q{Deliver mail in a resque job}
+  spec.summary       = %q{Adds a new delivery method to mail to allow delivering mails inside a job}
+  spec.homepage      = "https://github.com/restorando/resque-smtp"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "resque", "~> 1.22"
+  spec.add_dependency "mail", "~> 2.5.4"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "actionmailer", ">= 3.2"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "resque_unit"
+end

data/test/delivery_method_test.rb

@@ -0,0 +1,27 @@
+require_relative 'test_helper'
+require 'mail'
+
+module Resque::SMTP
+
+  describe DeliveryMethod do
+
+    before do
+      @mail = Mail.new do
+        from "someone@somewhere.com"
+        to   "someone_else@somewhere.com"
+        body "Some text"
+        delivery_method Resque::SMTP::DeliveryMethod
+      end
+    end
+
+    describe '#deliver' do
+      it 'enqueues a new email job with the encoded mail' do
+        @mail.deliver
+
+        assert_queued EmailJob, [@mail.encoded]
+      end
+    end
+
+  end
+
+end

data/test/email_job_test.rb

@@ -0,0 +1,32 @@
+require_relative 'test_helper'
+require 'minitest/mock'
+
+module Resque::SMTP
+
+  describe EmailJob do
+
+    let(:encoded_mail) { "some encoded email" }
+    let(:mail) { MiniTest::Mock.new }
+    let(:smtp_delivery_method) { MiniTest::Mock.new }
+
+    describe 'running the job' do
+
+      it 'creates a new email with smtp as delivery method and delivers it' do
+        Mail.stub(:new, mail) do
+          mail.expect(:delivery_method, smtp_delivery_method, [:smtp, Hash])
+          mail.expect(:delivery_method, smtp_delivery_method)
+          smtp_delivery_method.expect(:deliver!, true, [mail])
+
+          EmailJob.perform("some encoded email")
+
+          smtp_delivery_method.verify
+          mail.verify
+        end
+      end
+
+    end
+
+  end
+
+end
+

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/mock'
+
+require 'resque'
+require 'resque_unit'
+
+require 'resque/smtp'
+
+MiniTest::Unit::TestCase.send :include, ResqueUnit::Assertions

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: resque-smtp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Restoradno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque_unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Deliver mail in a resque job
+email:
+- dev@restorando.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resque/smtp.rb
+- lib/resque/smtp/delivery_method.rb
+- lib/resque/smtp/email_job.rb
+- lib/resque/smtp/railtie.rb
+- lib/resque/smtp/version.rb
+- resque-smtp.gemspec
+- test/delivery_method_test.rb
+- test/email_job_test.rb
+- test/test_helper.rb
+homepage: https://github.com/restorando/resque-smtp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Adds a new delivery method to mail to allow delivering mails inside a job
+test_files:
+- test/delivery_method_test.rb
+- test/email_job_test.rb
+- test/test_helper.rb