mq 0.1.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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.textile

@@ -0,0 +1,54 @@
+h2. mq
+
+A Rails gem that generates an MVC stack that does email queuing
+
+h3. What it does
+
+mq is a generator that generates an MVC stack for queuing emails. It has a UI too.
+I got tired of dealing with crappy email queuing systems in Rails, so I wrote my own.
+
+h3. Requirements
+
+None.
+
+h3. How to Install
+
+<pre>sudo gem install mq -s http://gemcutter.com</pre>
+
+h3. How to Use
+
+Assuming you'd like to name your mq table @Email@, and your Mailer model is named @Notifier@
+
+Generate the files necessary for your app:
+<pre>./script/generate mq Email Notifier</pre>
+
+mq requires your Mailer methods accept an email address as its first parameter, so a Mailer method should look like:
+<pre>Notifier.send_email_method(email_address)</pre>
+
+Of course, you can pass as many parameters as you'd like:
+<pre>Notifier.send_email_method(email_address, some_object, some_other_object, ...)</pre>
+
+Queue an email by calling @Email.queue@ with the name of your Notifier method as the first parameter, and the recipient email address as the second parameter, followed by anything else you'd like to pass.
+<pre>Email.queue(:send_email_method, "matt@matt-darby.com")</pre>
+
+You can pass multiple email addresses to the @Email.queue@ method and mq will automatically generate individual emails for the recipients.
+<pre>Email.queue(:send_email_method, ["matt@matt-darby.com", "foo@bar.com"], ...)</pre>
+
+h3. Delivery of queued email
+
+You can create a cronjob (this on runs every five minutes)
+<pre>*/5 * * * * cd /path/to/your/app && ./script/runner/Email.deliver_all</pre>
+
+h3. How to Test
+
+Complete Rspec specs are included automatically. Well, complete aside from view specs as you'll just change the damned things anyway.
+
+h3. Help
+
+Add a ticket to "MQ's Lighthouse Account":http://mdarby.lighthouseapp.com/projects/28699-mq/overview
+
+h3. About the Author
+
+My name is Matt Darby. I'm the Lead Web Developer and IT Manager at "Dynamix Engineering":http://dynamix-ltd.com and hold a Master's Degree in Computer Science from "Franklin University":http://franklin.edu in Columbus, OH.
+
+Feel free to check out my "blog":http://blog.matt-darby.com or to "recommend me":http://www.workingwithrails.com/recommendation/new/person/10908-matt-darby

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the mq plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the mq plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Mq'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/mq/mq_generator.rb

@@ -0,0 +1,86 @@
+class MqGenerator < Rails::Generator::NamedBase
+  
+  @@mailer_name = nil
+  
+  def initialize(*runtime_args)
+    super(*runtime_args) if @@mailer_name = runtime_args[0][1]
+  end
+
+  def manifest
+    record do |m|
+      install_routes(m)
+      
+      m.directory(File.join('app/models'))
+      m.directory(File.join('app/controllers'))
+      m.directory(File.join('app/helpers'))
+      m.directory(File.join('app/views'))
+      m.directory(File.join("app/views/#{table_name}"))
+      m.directory(File.join('db/migrate'))
+      
+      if has_rspec?
+        m.directory(File.join('spec/controllers'))
+        m.directory(File.join('spec/models'))
+        m.directory(File.join('spec/helpers'))
+        m.directory(File.join('spec/views'))
+        m.directory(File.join("spec/views/#{table_name}"))
+        
+        # Controllers
+        m.template "spec/emails_controller_spec.rb", File.join('spec/controllers', "#{table_name}_controller_spec.rb")
+        m.template "spec/emails_routing_spec.rb", File.join('spec/controllers', "#{table_name}_routing_spec.rb")
+        
+        # Models
+        m.template "spec/email_spec.rb", File.join('spec/models', "#{table_name.singularize}_spec.rb")
+      end
+      
+      # Controllers
+      m.template "emails_controller.rb", File.join('app/controllers', "#{table_name}_controller.rb")
+      
+      # Models
+      m.template "email.rb", File.join('app/models', "#{table_name.singularize}.rb")
+
+      # Migrations
+      m.migration_template "create_email_table.rb", "db/migrate", :migration_file_name => "create_#{object_name}_table"
+      
+      # Views
+      m.template "views/index.html.erb", File.join("app/views/#{table_name}", "index.html.erb")
+      m.template "views/_email.html.erb", File.join("app/views/#{table_name}", "_#{object_name}.html.erb")
+      
+    end
+  end
+  
+  def mailer_name
+    @@mailer_name
+  end
+    
+  def table_name
+    class_name.tableize
+  end
+  
+  def model_name
+    class_name.demodulize
+  end
+  
+  def object_name
+    table_name.singularize
+  end
+  
+  def install_routes(m)
+    route_string = ":#{table_name}, :member => {:deliver => :get}, :collection => {:deliver_all => :get, :destroy_all => :get}"
+    def route_string.to_sym; to_s; end
+    def route_string.inspect; to_s; end
+    m.route_resources route_string
+  end
+  
+  def has_rspec?
+    spec_dir = File.join(RAILS_ROOT, 'spec')
+    options[:rspec] ||= (File.exist?(spec_dir) && File.directory?(spec_dir)) unless (options[:rspec] == false)
+  end
+  
+  
+  protected
+  
+    def banner
+      "Usage: #{$0} #{spec.name} ModelName MailerModelName"
+    end
+    
+end

data/generators/mq/templates/create_email_table.rb

@@ -0,0 +1,16 @@
+class CreateEmailTable < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      t.text :tmail
+      t.string :mailer_method
+      t.integer :attempts, :default => 0
+      t.datetime :last_attempt_at
+      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/generators/mq/templates/email.rb

@@ -0,0 +1,42 @@
+class <%= class_name %> < ActiveRecord::Base
+
+  serialize :tmail
+
+  def self.queue(method, to, *args)
+    method = method.to_s if method.is_a?(Symbol)
+    [*to].each{|address| self.generate_mail(method, address, args)}
+  end
+
+  def self.deliver_all
+    all.each{|m| m.deliver}
+  end
+
+  def to
+    to = tmail.to.to_s
+    to.blank? ? bcc : to
+  end
+
+  def bcc
+    tmail.bcc.to_s
+  end
+
+  def from
+    tmail.from.to_s
+  end
+
+  def deliver
+    if <%= mailer_name %>.deliver(tmail)
+      self.destroy
+    else
+      self.update_attributes({:attempts => self.attempts += 1, :last_attempt_at => Time.now})
+    end
+  end
+  
+  
+  private
+
+    def self.generate_mail(method, address, args)
+      create!(:mailer_method => method, :tmail => <%= mailer_name %>.send("create_#{method}".to_sym, address, *args))
+    end
+
+end

data/generators/mq/templates/emails_controller.rb

@@ -0,0 +1,34 @@
+class <%= class_name %>sController < ApplicationController
+  
+  before_filter :load_items
+  
+  
+  def load_items
+    @<%= object_name %> = <%= class_name %>.find(params[:id]) if params[:id]
+  end
+  
+  def index
+    @<%= object_name %>s = <%= class_name %>.all(:order => "created_at")
+  end
+  
+  def deliver
+    @<%= object_name %>.deliver
+    redirect_to :back
+  end
+  
+  def deliver_all
+    <%= class_name %>.deliver_all
+    redirect_to :back
+  end
+  
+  def destroy
+    @<%= object_name %>.destroy
+    redirect_to :back
+  end
+  
+  def destroy_all
+    <%= class_name %>.destroy_all
+    redirect_to :back
+  end
+  
+end

data/generators/mq/templates/spec/email_spec.rb

@@ -0,0 +1,114 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+module <%= class_name %>Attributes
+  def valid_attributes
+    {
+      :mailer_method   => "send_some_email",
+      :attempts        => 0,
+      :last_attempt_at => nil,
+      :created_at      => Date.parse("2009-02-11"),
+      :updated_at      => Date.parse("2009-02-11")
+    }
+  end
+end
+
+describe <%= class_name %> do
+
+  include <%= class_name %>Attributes
+
+  before do
+    @<%= object_name %> = <%= class_name %>.create!(valid_attributes)
+    @tmail = mock_model(TMail)
+    @<%= object_name %>.stub!(:tmail => @tmail)
+
+    @obj = mock("something")
+  end
+
+  it "should be valid" do
+    @<%= object_name %>.should be_valid
+  end
+
+  it "should know how to queue an <%= object_name %> with a singular recipient" do
+    <%= class_name %>.should_receive(:generate_mail).with("send_some_<%= object_name %>", "foo@bar.com", [@obj])
+    <%= class_name %>.queue("send_some_<%= object_name %>", "foo@bar.com", @obj)
+  end
+
+  it "should know how to queue an <%= object_name %> with a multiple recipients" do
+    <%= class_name %>.should_receive(:generate_mail).with("send_some_<%= object_name %>", "foo@bar.com", [@obj])
+    <%= class_name %>.should_receive(:generate_mail).with("send_some_<%= object_name %>", "bar@foo.com", [@obj])
+    <%= class_name %>.queue("send_some_<%= object_name %>", ["foo@bar.com", "bar@foo.com"], @obj)
+  end
+
+  it "should convert the method parameter to a String if its a Symbol" do
+    <%= class_name %>.should_receive(:generate_mail).with("send_some_<%= object_name %>", "foo@bar.com", [@obj])
+    <%= class_name %>.queue(:send_some_<%= object_name %>, "foo@bar.com", @obj)
+  end
+
+  it "should be able to deliver all queued <%= object_name %>s" do
+    <%= class_name %>.stub!(:all => [@<%= object_name %>])
+    @<%= object_name %>.should_receive(:deliver)
+
+    <%= class_name %>.deliver_all
+  end
+
+  it "should tell us who the <%= object_name %> is for" do
+    @tmail.stub!(:to => "foo@bar.com")
+    @<%= object_name %>.to.should == "foo@bar.com"
+  end
+
+  it "should tell us who the <%= object_name %> is for (via the BCC field)" do
+    @tmail.stub!(:to => "", :bcc => "foo@bar.com")
+    @<%= object_name %>.to.should == "foo@bar.com"
+  end
+
+  it "should tell us who the <%= object_name %> is from" do
+    @tmail.stub!(:from => "foo@bar.com")
+    @<%= object_name %>.from.should == "foo@bar.com"
+  end
+
+  it "should be able to deliver its self" do
+    @<%= object_name %>.should respond_to(:deliver)
+    <%= mailer_name %>.should_receive(:deliver).with(@tmail).and_return(true)
+    @<%= object_name %>.deliver
+  end
+
+
+  describe " when it is successfully delivered" do
+    before do
+      <%= mailer_name %>.stub!(:deliver => true)
+    end
+
+    it "should commit suicide" do
+      @<%= object_name %>.should_receive(:destroy)
+      @<%= object_name %>.deliver
+    end
+  end
+
+  describe " when it is not successfully delivered" do
+    before do
+      <%= mailer_name %>.stub!(:deliver => false)
+    end
+
+    it "should increment the attempts attribute" do
+      @<%= object_name %>.deliver
+      @<%= object_name %>.attempts.should == 1
+    end
+
+    it "should set the #last_attempt_at attribute" do
+      now = Time.now
+      Time.stub!(:now => now)
+      @<%= object_name %>.deliver
+      @<%= object_name %>.last_attempt_at.should == now
+    end
+  end
+
+  describe " the #generate_mail method" do
+    it "should create a new <%= class_name %> object" do
+      <%= mailer_name %>.should_receive("create_send_some_<%= object_name %>").with("foo@bar.com", @obj).and_return(@tmail)
+      <%= class_name %>.should_receive(:create!).with(:mailer_method => "send_some_<%= object_name %>", :tmail => @tmail)
+
+      <%= class_name %>.queue("send_some_<%= object_name %>", "foo@bar.com", @obj)
+    end
+  end
+
+end

data/generators/mq/templates/spec/emails_routing_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe EmailsController do
+  describe "route generation" do
+
+    it "should map { :controller => '<%= object_name %>s', :action => 'index' } to /<%= object_name %>s" do
+      route_for(:controller => "<%= object_name %>s", :action => "index").should == "/<%= object_name %>s"
+    end
+      
+    it "should map { :controller => '<%= object_name %>s', :action => 'destroy', :id => 1} to /<%= object_name %>s/1" do
+      route_for(:controller => "<%= object_name %>s", :action => "destroy", :id => 1).should == "/<%= object_name %>s/1"
+    end
+    
+    it "should map { :controller => '<%= object_name %>s', :action => 'destroy', :id => 1} to /<%= object_name %>s/1" do
+      route_for(:controller => "<%= object_name %>s", :action => "destroy", :id => 1).should == "/<%= object_name %>s/1"
+    end
+    
+    it "should map { :controller => '<%= object_name %>s', :action => 'deliver', :id => 1} to /<%= object_name %>s/1/deliver" do
+      route_for(:controller => "<%= object_name %>s", :action => "deliver", :id => 1).should == "/<%= object_name %>s/1/deliver"
+    end
+    
+    it "should map { :controller => '<%= object_name %>s', :action => 'deliver_all'} to /<%= object_name %>s/deliver_all" do
+      route_for(:controller => "<%= object_name %>s", :action => "deliver_all").should == "/<%= object_name %>s/deliver_all"
+    end
+    
+    it "should map { :controller => '<%= object_name %>s', :action => 'destroy_all'} to /<%= object_name %>s/destroy_all" do
+      route_for(:controller => "<%= object_name %>s", :action => "destroy_all").should == "/<%= object_name %>s/destroy_all"
+    end
+  end
+
+  describe "route recognition" do
+
+    it "should generate params { :controller => '<%= object_name %>s', action => 'index' } from GET /<%= object_name %>s" do
+      params_from(:get, "/<%= object_name %>s").should == {:controller => "<%= object_name %>s", :action => "index"}
+    end
+    
+    it "should generate params { :controller => '<%= object_name %>s', action => 'destroy', id => '1' } from DELETE /<%= object_name %>s/1" do
+      params_from(:delete, "/<%= object_name %>s/1").should == {:controller => "<%= object_name %>s", :action => "destroy", :id => "1"}
+    end
+    
+    it "should generate params { :controller => '<%= object_name %>s', action => 'deliver', id => '1' } from GET /<%= object_name %>s/1/deliver" do
+      params_from(:get, "/<%= object_name %>s/1/deliver").should == {:controller => "<%= object_name %>s", :action => "deliver", :id => "1"}
+    end
+    
+    it "should generate params { :controller => '<%= object_name %>s', action => 'deliver_all' } from GET /<%= object_name %>s/deliver_all" do
+      params_from(:get, "/<%= object_name %>s/deliver_all").should == {:controller => "<%= object_name %>s", :action => "deliver_all"}
+    end
+    
+    it "should generate params { :controller => '<%= object_name %>s', action => 'destroy_all' } from GET /<%= object_name %>s/destroy_all" do
+      params_from(:get, "/<%= object_name %>s/destroy_all").should == {:controller => "<%= object_name %>s", :action => "destroy_all"}
+    end
+  end
+end

data/generators/mq/templates/views/_email.html.erb

@@ -0,0 +1,15 @@
+<tr id="<%%= dom_id(<%= object_name %>) %>">
+  <td><%%=<%= object_name %>.to %></td>
+  <td><%%=<%= object_name %>.mailer_method %></td>
+  <td><%%= time_ago_in_words(<%= object_name %>.created_at) %> ago</td>
+  
+  <%% if <%= object_name %>.attempts > 0 %>
+    <td><%%=<%= object_name %>.attempts %></td>
+    <td><%%= time_ago_in_words(<%= object_name %>.last_attempt_at) %> ago</td>
+  <%% else %>
+    <td>&nbsp;</td>
+    <td>&nbsp;</td>
+  <%% end %>
+  
+  <td><%%= link_to "Deliver", deliver_<%= object_name %>_path(<%= object_name %>), :method => :get %></td>
+  <td><%%= link_to 'Delete', <%= object_name %>_path(<%= object_name %>), :method => :delete %></td>

data/generators/mq/templates/views/index.html.erb

@@ -0,0 +1,22 @@
+<h1>Queued Emails</h1>
+
+<%% if <%= class_name %>.count > 0 %>
+  <%%= link_to "Deliver All", deliver_all_<%= object_name %>s_path %>
+  <%%= link_to "Destroy All", destroy_all_<%= object_name %>s_path, :confirm => "Are you really sure?" %>
+<%% end %>
+
+<table>
+  <thead>
+    <tr>
+      <th>To</th>
+      <th>Method</th>
+      <th>Created</th>
+      <th>Attempts</th>
+      <th>Last Attempt</th>
+    </tr>
+  </thead>
+  
+  <tbody>
+    <%%= render :partial => "<%= object_name %>", :collection => @<%= object_name %>s %>
+  </tbody>
+</table>

data/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/mq.rb

@@ -0,0 +1 @@
+# Mq

data/mq.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |s|
+  s.name     = "mq"
+  s.version  = "0.1.2"
+  s.date     = "2009-07-11"
+  s.summary  = "An email queue that actually works"
+  s.email    = "matt@matt-darby.com"
+  s.homepage = "http://github.com/mdarby/mq"
+  s.description = "A Rails gem that generates an MVC stack that does email queuing"
+  s.has_rdoc = false
+  s.authors  = ["Matt Darby"]
+  s.files    = [
+    "MIT-LICENSE",
+    "README.textile",
+    "Rakefile",
+    "generators/mq/mq_generator.rb",
+    "generators/mq/templates/create_email_table.rb",
+    "generators/mq/templates/email.rb",
+    "generators/mq/templates/emails_controller.rb",
+    "generators/mq/templates/spec/emails_routing_spec.rb",
+    "generators/mq/templates/spec/email_spec.rb",
+    "generators/mq/templates/spec/emails_controller_spec.rb",
+    "generators/mq/templates/views/_email.html.erb",
+    "generators/mq/templates/views/index.html.erb",
+    "generators/mq/USAGE",
+    "init.rb",
+    "install.rb",
+    "lib/mq.rb",
+    "mq.gemspec",
+    "uninstall.rb"
+  ]
+  
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: mq
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Matt Darby
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-11 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: A Rails gem that generates an MVC stack that does email queuing
+email: matt@matt-darby.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.textile
+- Rakefile
+- generators/mq/mq_generator.rb
+- generators/mq/templates/create_email_table.rb
+- generators/mq/templates/email.rb
+- generators/mq/templates/emails_controller.rb
+- generators/mq/templates/spec/emails_routing_spec.rb
+- generators/mq/templates/spec/email_spec.rb
+- generators/mq/templates/spec/emails_controller_spec.rb
+- generators/mq/templates/views/_email.html.erb
+- generators/mq/templates/views/index.html.erb
+- generators/mq/USAGE
+- init.rb
+- install.rb
+- lib/mq.rb
+- mq.gemspec
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/mdarby/mq
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An email queue that actually works
+test_files: []
+