mdarby-mq 0.1.1 → 0.1.2

data/README.textile

@@ -4,26 +4,51 @@ A Rails gem that generates an MVC stack that does email queuing
 
 h3. What it does
 
-I got tire of crappy attempts at queuing emails, so I wrote my own. mq is a generator that generates an MVC stack for queuing emails. It has a UI too.
+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
 
-An existing Mailer
+None.
 
 h3. How to Install
 
-<pre>sudo gem install mdarby-mq</pre>
+<pre>sudo gem install mdarby-mq -s http://gems.github.com</pre>
 
 h3. How to Use
 
-<pre>./script/generate mq EmailModelName MailerModelName</pre>
+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
+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/generators/mq/mq_generator.rb

@@ -39,7 +39,7 @@ class MqGenerator < Rails::Generator::NamedBase
       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_mq_table"
+      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")

data/generators/mq/templates/email.rb

@@ -36,7 +36,7 @@ class <%= class_name %> < ActiveRecord::Base
   private
 
     def self.generate_mail(method, address, args)
-      create!(:mailer_method => method, :tmail => <% mailer_name %>.send("create_#{method}".to_sym, address, *args))
+      create!(:mailer_method => method, :tmail => <%= mailer_name %>.send("create_#{method}".to_sym, address, *args))
     end
 
 end

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

@@ -1,10 +1,10 @@
-<tr id="<%%= dom_id(<%= object_name %>) %>
-  <td><%= object_name %>.to</td>
-  <td><%= object_name %>.mailer_method</td>
+<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><%%=<%= object_name %>.attempts %></td>
     <td><%%= time_ago_in_words(<%= object_name %>.last_attempt_at) %> ago</td>
   <%% else %>
     <td>&nbsp;</td>
@@ -12,4 +12,4 @@
   <%% end %>
   
   <td><%%= link_to "Deliver", deliver_<%= object_name %>_path(<%= object_name %>), :method => :get %></td>
-  <td><%%= link_to 'Delete', <%= object_name %>_path(@<%= object_name %>), :method => :destroy %></td>
+  <td><%%= link_to 'Delete', <%= object_name %>_path(<%= object_name %>), :method => :delete %></td>

data/mq.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name     = "mq"
-  s.version  = "0.1.1"
-  s.date     = "2009-02-11"
+  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"
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
     "generators/mq/templates/create_email_table.rb",
     "generators/mq/templates/email.rb",
     "generators/mq/templates/emails_controller.rb",
-    "generators/mq/templates/spec/email_routing_spec.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",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mdarby-mq
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Matt Darby
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-11 00:00:00 -08:00
+date: 2009-07-11 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -29,7 +29,7 @@ files:
 - generators/mq/templates/create_email_table.rb
 - generators/mq/templates/email.rb
 - generators/mq/templates/emails_controller.rb
-- generators/mq/templates/spec/email_routing_spec.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