mandrill_mailer 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bfa455214d0fad5180b76450327ac30b7ffcc74
-  data.tar.gz: aaa9f37d06d8c32a1d3bb0ba33490c7ce4e3b36d
+  metadata.gz: 066d9d8a41e15e942635771fdef695a54a71a667
+  data.tar.gz: c1dddaf88be75ed2ddab9165767145aace80dc1b
 SHA512:
-  metadata.gz: 3f5580807bc7f7a0c13c6bcdc8749719e7b638e141253025b93b7fb3fc33dfe5735bf5f80f1bef647b5530f971647a80f133bb054d620e84b615b727eb9b76b1
-  data.tar.gz: 6dad0436a16f92014ac77929794d5e075a547be5ce19696f8a460e97af2589a34338a3b8c3c3f0e68c164ee2eeda95533e52eb54f42920a2db7a88d712e92a5d
+  metadata.gz: 768bfe2d37ea0b516bead42c089ffdb5d2a077bb8e0300a5e721f8ec656f1fc9717e068877e5b6d5c190c2b73e6c09fdea9e67a74b47f8a2332e74a77ac8a05e
+  data.tar.gz: df0ea1de244c30e78cb3b5c8de329c2f8bc017abb01e56369dab9c7c715a280a8da9d4ada95f1538d2b8d4bcad9455868cfb07ed48cd165f3429e98d9af85e52

data/README.md

@@ -1,5 +1,5 @@
 # Mandrill Mailer gem
-MandrilMailer class for sending transactional emails through mandril.
+MandrillMailer class for sending transactional emails through Mandrill.
 Only template based emails are supported at this time.
 
 ## Usage
@@ -10,7 +10,7 @@ You don't need to add the ActionMailer stuff unless your still using ActionMaile
 This just plugs into the Mandrill smtp servers. If your doing template based emails
 through the Mandrill api you really only need the `MandrillMailer.configure` part
 
-```
+```ruby
 ActionMailer::Base.smtp_settings = {
     :address   => "smtp.mandrillapp.com",
     :port      => 587,
@@ -35,31 +35,31 @@ in your environment config files:
 ## Creating a new mailer
 Creating a new Mandrill Mailer is similar to a normal Rails mailer:
 
-```
- class InvitationMailer < MandrillMailer::TemplateMailer
-   default from: 'support@example.com'
-
-   def invite(invitation)
-     mandrill_mail template: 'Group Invite',
-       subject: I18n.t('invitation_mailer.invite.subject'),
-       to: invitation.invitees.map {|invitee| { email: invitee.email, name: invitee.name }},
-       # to: {email: invitation.email, name: 'Honored Guest'},
-       vars: {
-         'OWNER_NAME' => invitation.owner_name,
-         'PROJECT_NAME' => invitation.project_name
-       },
-       important: true,
-       inline_css: true,
-       recipient_vars: invitation.invitees.map do |invitee| # invitation.invitees is an Array                  ,
-                         { invitee.email =>
-                           {
-                             'INVITEE_NAME' => invitee.name,
-                             'INVITATION_URL' => new_invitation_url(invitee.email, secret: invitee.secret_code)
-                           }
-                         }
-                       end
-   end
- end
+```ruby
+class InvitationMailer < MandrillMailer::TemplateMailer
+  default from: 'support@example.com'
+
+  def invite(invitation)
+    mandrill_mail template: 'Group Invite',
+                  subject: I18n.t('invitation_mailer.invite.subject'),
+                  to: invitation.invitees.map {|invitee| { email: invitee.email, name: invitee.name }},
+                  # to: {email: invitation.email, name: 'Honored Guest'},
+                  vars: {
+                    'OWNER_NAME' => invitation.owner_name,
+                    'PROJECT_NAME' => invitation.project_name
+                  },
+                  important: true,
+                  inline_css: true,
+                  recipient_vars: invitation.invitees.map do |invitee| # invitation.invitees is an Array
+                    { invitee.email =>
+                      {
+                        'INVITEE_NAME' => invitee.name,
+                        'INVITATION_URL' => new_invitation_url(invitee.email, secret: invitee.secret_code)
+                      }
+                    }
+                  end
+  end
+end
  ```
 
 * `#default:`
@@ -133,7 +133,7 @@ You can test the above email by typing: `InvitationMailer.test(:invite, email:<y
 
 The test for this particular Mailer is setup like so:
 
-```
+```ruby
 test_setup_for :invite do |mailer, options|
     invitation = MandrillMailer::Mock.new({
       email: options[:email],
@@ -150,7 +150,7 @@ If in order to represent a url within a mock, make sure there is a `url` or `pat
 for example, if I had a course mock and I was using the `course_url` route helper within the mailer
 I would create the mock like so:
 
-```
+```ruby
 course = MandrillMailer::Mock.new({
   title: 'zombies',
   type: 'Ruby',
@@ -164,6 +164,29 @@ The mailer and options passed to the `.test` method are yielded to the block.
 
 The `:email` option is the only required option, make sure to add at least this to your test object.
 
+## Offline Testing
+You can turn on offline testing by requiring this file (say, in your spec_helper.rb):
+
+```ruby
+require 'mandrill_mailer/offline'
+```
+
+And then if you wish you can look at the contents of `MandrillMailer.deliveries` to see whether an email was queued up by your test:
+
+```ruby
+email = MandrillMailer::deliveries.detect { |mail|
+  mail.template_name == 'my-template' &&
+  mail.message['to'].any? { |to| to['email'] == 'my@email.com' }
+}
+expect(email).to_not be_nil
+```
+
+Don't forget to clear out deliveries:
+
+```ruby
+before :each { MandrillMailer.deliveries.clear }
+```
+
 ## Using Delayed Job
 The typical Delayed Job mailer syntax won't work with this as of now. Either create a custom job or que the mailer as you would que a method. Take a look at the following examples:
 

data/change_log.md

@@ -1,3 +1,6 @@
+* 0.4.3
+  Add the ability to look at deliveries for offline testing.
+
 * 0.4.2
   Add the ability to intercept emails before they are sent in the config
   see the specs for more info

data/lib/mandrill_mailer/offline.rb

@@ -0,0 +1,40 @@
+# Offline modifications for using MandrillMailer without actually sending
+# emails through Mandrill's API. Particularly useful for acceptance tests.
+#
+# To use, just require this file (say, in your spec_helper.rb):
+#
+#   require 'mandrill_mailer/offline'
+#
+# And then if you wish you can look at the contents of
+# MandrillMailer.deliveries to see whether an email was queued up by your test:
+#
+#   email = MandrillMailer::deliveries.detect { |mail|
+#     mail.template_name == 'my-template' &&
+#     mail.message['to'].any? { |to| to['email'] == 'my@email.com' }
+#   }
+#   expect(email).to_not be_nil
+#
+# Don't forget to clear out deliveries:
+#
+#   before :each { MandrillMailer.deliveries.clear }
+#
+require 'mandrill_mailer'
+
+module MandrillMailer
+  def self.deliveries
+    @deliveries ||= []
+  end
+
+  class TemplateMailer
+    def deliver
+      MandrillMailer.deliveries << MandrillMailer::Mock.new({
+        :template_name    => template_name,
+        :template_content => template_content,
+        :message          => message,
+        :async            => async,
+        :ip_pool          => ip_pool,
+        :send_at          => send_at
+      })
+    end
+  end
+end

data/lib/mandrill_mailer/version.rb

@@ -1,3 +1,3 @@
 module MandrillMailer
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mandrill_mailer
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Adam Rensel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-13 00:00:00.000000000 Z
+date: 2013-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,7 @@ files:
 - change_log.md
 - lib/mandrill_mailer.rb
 - lib/mandrill_mailer/mock.rb
+- lib/mandrill_mailer/offline.rb
 - lib/mandrill_mailer/railtie.rb
 - lib/mandrill_mailer/template_mailer.rb
 - lib/mandrill_mailer/version.rb