qc-mailer 0.0.1

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/.rvmrc

@@ -0,0 +1,2 @@
+rvm_gemset_create_on_use_flag=1
+rvm use 1.9.2@qc-mailer

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+notifications:
+  email: false
+  webhooks:
+    on_success: always
+    on_failure: always
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+
+script: bundle exec rake test
+
+before_script:
+  - psql -c 'create database queue_classic_test;' -U postgres
+  

data/Gemfile

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

data/README.md

@@ -0,0 +1,53 @@
+QueueClassic Mailer
+==================
+
+Add to a Rails 3.x project to send email in the background using QueueClassic.
+
+This gem was inspired by ResqueMailer, https://github.com/zapnap/resque_mailer
+
+**WARNING: USE AT OWN RISK! THIS GEM IS CONSIDERED EXTREME ALPHA!**
+
+[![Build Status](https://secure.travis-ci.org/zerobearing2/qc-mailer.png)](http://travis-ci.org/zerobearing2/qc-mailer)
+
+Usage
+-----
+
+Install as gem
+    
+    gem install qc-mailer
+
+Add to Gemfile
+
+    gem "qc-mailer"
+
+Include QC::Mailer in your ActionMailer subclass(es) like this:
+
+```ruby
+class MyMailer < ActionMailer::Base
+  include QC::Mailer
+end
+```
+
+Now, when ```MyMailer.subject_email(params).deliver``` is called, an entry will be created in the job queue.
+
+Note that you can still have mail delivered synchronously by using the bang method variant:
+```ruby
+MyMailer.subject_email(params).deliver!
+```
+
+If you want to set a different default queue name for your mailer, you can change the default_queue property like so:
+```ruby
+# config/initializers/qc_mailer.rb
+QC::Mailer.default_queue = 'application_specific_mailer'
+```
+
+TODO
+----
+
+ - TBD
+
+
+Meta
+----
+
+Released under the [MIT license](http://www.opensource.org/licenses/mit-license.php).

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList[File.expand_path('../test/**/*_test.rb', __FILE__)]
+  t.verbose = true
+end
+

data/lib/qc-mailer/message_decoy.rb

@@ -0,0 +1,33 @@
+require "queue_classic"
+
+module QC
+  module Mailer
+
+    class MessageDecoy
+      delegate :to_s, :to => :actual_message
+
+      def initialize(mailer_class, method_name, *args)
+        @mailer_class   = mailer_class
+        @method_name    = method_name.to_s
+        *@args          = *args
+      end
+
+      def actual_message
+        @actual_message ||= @mailer_class.send(:new, @method_name, *@args).message
+      end
+
+      def deliver
+        @mailer_class.queue.enqueue("#{@mailer_class}.deliver", @method_name, *@args)
+      end
+
+      def deliver!
+        actual_message.deliver
+      end
+
+      def method_missing(method_name, *args)
+        actual_message.send(method_name, *args)
+      end
+    end
+  
+  end
+end

data/lib/qc-mailer/version.rb

@@ -0,0 +1,5 @@
+module QC
+  module Mailer
+    VERSION = "0.0.1"
+  end
+end

data/lib/qc-mailer.rb

@@ -0,0 +1,47 @@
+require "active_support/concern"
+require "qc-mailer/version"
+require "qc-mailer/message_decoy"
+
+module QC
+  module Mailer
+    extend ActiveSupport::Concern
+
+    included do 
+      extend(ClassMethods)
+    end
+      
+    # ModuleMethods
+    mattr_accessor :default_queue
+    def self.default_queue
+      @@default_queue || QC::QUEUE || "default"
+    end
+
+    # ClassMethods
+    module ClassMethods
+      def queue_name
+        @queue_name || QC::Mailer.default_queue
+      end
+
+      def queue_name=(val)
+        @queue_name = val
+      end
+
+      def queue
+        @queue ||= QC::Queue.new(queue_name)
+      end
+
+      def deliver(method, *args)
+        send(method, *args).deliver!
+      end
+
+      def method_missing(method_name, *args)
+        if action_methods.include?(method_name.to_s)
+          MessageDecoy.new(self, method_name, *args)
+        else
+          super
+        end
+      end
+    end
+
+  end
+end

data/qc-mailer.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/qc-mailer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Bradford"]
+  gem.email         = ["david@zerobearing.com"]
+  gem.description   = %q{Rails plugin for sending asynchronous email with ActionMailer and QueueClassic.}
+  gem.summary       = %q{Rails plugin for sending asynchronous email with ActionMailer and QueueClassic.}
+  gem.homepage      = "https://github.com/zerobearing2/qc-mailer"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "qc-mailer"
+  gem.require_paths = ["lib"]
+  gem.version       = QC::Mailer::VERSION
+
+  # specify any dependencies here; for example:
+  gem.add_runtime_dependency "activesupport",   "~> 3.0"
+  gem.add_runtime_dependency "actionmailer",    "~> 3.0"
+  gem.add_runtime_dependency "i18n",            "~> 0.6.0"
+  gem.add_runtime_dependency "queue_classic",   "~> 2.0.1"
+
+  gem.add_development_dependency "minitest", "~> 3.3.0"
+  gem.add_development_dependency "minitest-reporters"
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency "pry"
+end

data/test/qc_mailer_test.rb

@@ -0,0 +1,101 @@
+require_relative "./test_helper"
+
+class Rails3Mailer < ActionMailer::Base
+  include QC::Mailer
+  default :from => "from@example.org", :subject => "Subject"
+
+  def test_mail(*params)
+    mail(*params)
+  end
+end
+
+class PriorityMailer < Rails3Mailer
+  self.queue_name = 'priority-mailer'
+end
+
+
+describe 'QC::Mailer' do
+  include QCHelper
+  
+  before do
+    ActionMailer::Base.deliveries = []
+    @test_mail = Rails3Mailer.test_mail( 'to' => "testme@example.org" )
+  end
+
+  describe "default_queue" do
+    it "should be 'default'" do
+      QC::Mailer.default_queue.must_equal("default")
+    end
+  end
+
+  describe "queue_name" do
+    before do
+      QC::Mailer.default_queue = nil
+      Rails3Mailer.queue_name = nil
+    end
+
+    it "allows overriding of the default queue target" do
+      QC::Mailer.default_queue = "my-queue"
+      Rails3Mailer.queue_name.must_equal("my-queue")
+    end
+
+    it "set queue_name manually" do
+      Rails3Mailer.queue_name = "testing"
+      Rails3Mailer.queue_name.must_equal("testing")
+    end
+
+    it "set at class level" do
+      QC::Mailer.default_queue.must_equal("default")
+      Rails3Mailer.queue_name.must_equal("default")
+      PriorityMailer.queue_name.must_equal('priority-mailer')
+    end
+  end
+
+  describe "queue" do
+    it "should be a QC::Queue" do
+      Rails3Mailer.queue.must_be_instance_of(QC::Queue)
+    end
+  end
+
+  describe '#deliver' do
+    it 'should not deliver the email synchronously' do
+      @test_mail.deliver
+      ActionMailer::Base.deliveries.must_be_empty
+    end
+
+    it 'should place the deliver action on the QC "mailer" queue' do
+      Rails3Mailer.queue.count.must_equal(0)
+      @test_mail.deliver
+      Rails3Mailer.queue.count.must_equal(1)
+    end
+  end
+
+  describe "#deliver job" do
+    it "should process the job" do
+      Rails3Mailer.queue.stub(:enqueue, enqueue_stub) do
+        ActionMailer::Base.deliveries.must_be_empty
+        @test_mail.deliver
+        ActionMailer::Base.deliveries.wont_be_empty
+      end
+    end
+  end
+
+  describe '#deliver!' do
+    it "should send synchronously" do
+      @test_mail.deliver!
+      ActionMailer::Base.deliveries.wont_be_empty
+    end
+  end
+
+  describe 'original mail methods' do
+    it 'should be preserved' do
+      @test_mail.subject.must_equal 'Subject'
+      @test_mail.from.must_include 'from@example.org'
+      @test_mail.to.must_include 'testme@example.org'
+    end
+
+    it "to_s should have Content-Type" do
+      @test_mail.to_s.must_include "Content-Type:"
+    end
+  end
+end

data/test/support/qc_helper.rb

@@ -0,0 +1,31 @@
+module QCHelper
+
+  def setup
+    init_db
+    silence_logger
+  end
+
+  def teardown
+    QC.delete_all
+  end
+
+  def silence_logger
+    QC.define_singleton_method :log do |*args| nil; end # silence QC logger
+  end
+
+  def init_db(table_name="queue_classic_jobs")
+    QC::Conn.execute("SET client_min_messages TO 'warning'")
+    QC::Setup.drop
+    QC::Setup.create
+    QC::Conn.disconnect
+  end
+
+  def enqueue_stub
+    proc do |method, *args| 
+      klass = eval(method.split(".").first)
+      msg = method.split(".").last
+      klass.send(msg, *args)
+    end 
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+# test/test_helper.rb
+
+ENV["TEST"] = 'true'
+ENV["DATABASE_URL"] ||= "postgres:///queue_classic_test"
+
+$:.unshift File.expand_path("../../lib")
+require 'rubygems'
+require 'minitest/autorun'
+require "minitest/reporters"
+require 'pry'
+require 'time'
+require 'action_mailer'
+require 'qc-mailer'
+
+MiniTest::Reporters.use! [MiniTest::Reporters::SpecReporter.new]
+
+ActionMailer::Base.delivery_method = :test
+# ActionMailer::Base.perform_deliveries = false
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: qc-mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Bradford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: 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: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: queue_classic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails plugin for sending asynchronous email with ActionMailer and QueueClassic.
+email:
+- david@zerobearing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/qc-mailer.rb
+- lib/qc-mailer/message_decoy.rb
+- lib/qc-mailer/version.rb
+- qc-mailer.gemspec
+- test/qc_mailer_test.rb
+- test/support/qc_helper.rb
+- test/test_helper.rb
+homepage: https://github.com/zerobearing2/qc-mailer
+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'
+      segments:
+      - 0
+      hash: -851662944801137892
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -851662944801137892
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rails plugin for sending asynchronous email with ActionMailer and QueueClassic.
+test_files:
+- test/qc_mailer_test.rb
+- test/support/qc_helper.rb
+- test/test_helper.rb