mandrill_mailer 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79a6370588ee165bd28e0b2610236fb3bf533417
-  data.tar.gz: 52579261a95fc18eb4625cb41f9bb9c10fc09ad5
+  metadata.gz: a1044b6baf3d9a8f33f1cc09f86516c21d5228c4
+  data.tar.gz: ae3a798dacfe9294991ee3beb3755665558c26ea
 SHA512:
-  metadata.gz: fd9651725cad09ddd52c4c796a14443ac7e91165b8da44be8e965f087989f74966310bd6d3cc72fcabc1bf90d817ed7d306030679804b1061880db80b6808e9f
-  data.tar.gz: c281185967f50d1036ba767875e2321afe0ac79e33e42ee4ddd097b9a19075a9d2a892ba62086769696daf36412c7f4dcbe3c5efd9d48eedb490e7b834b4b83c
+  metadata.gz: 532a82b1c66cb927f5e36734c9fe7ec39ac040d4e976c15f3b76829745f36dee8255d48636b71b75c12b0d7497703a04a2cb74db4c29efb2f10e76221b88d24d
+  data.tar.gz: bb9e61792cffe0179339659bfdde72f87237bafe5097a4193646ffc018a309017b331ba39196b3d7938dae52bdb872d47b75e1212d0bf8f4b140619b00dbe361

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 1.2.0 - 2015-12-22
+### Added
+- Support for for deliver_later and deliver_now using ActiveJob. via @BenRuns
+
+
 ## 1.1.0 - 2015-10-02
 ### Added
 - Optional RSpec helper (`MandrillMailer::RSpecHelper`) with custom matchers

data/README.md

@@ -39,6 +39,7 @@ ActionMailer::Base.delivery_method = :smtp
 
 MandrillMailer.configure do |config|
   config.api_key = ENV['MANDRILL_API_KEY']
+  config.config.deliver_later_queue_name = :default
 end
 ```
 
@@ -97,10 +98,10 @@ end
 ```
 
 * `#default:`
-  * `:from` - set the default from email address for the mailer
+  * `:from` - set the default from email address for the mailer.  Defaults to `'example@email.com'`.
   * `:from_name` - set the default from name for the mailer. If not set, defaults to from email address. Setting :from_name in the .mandrill_mail overrides the default.
   * `:merge_vars` - set some default `merge_vars` that will be sent with every mailer method (in `global_merge_vars` so there's no risk of collision with method-specific `merge_vars`.
-  * `:view_content_link` - set a default to be able to access individual mailer messages in the Mandrill dashboard
+  * `:view_content_link` - set a default to be able to access individual mailer messages in the Mandrill dashboard. Defaults to `false`.
 
 * `.mandrill_mail`
    * `:template`(required) - Template slug from within Mandrill (for backwards-compatibility, the template name may also be used but the immutable slug is preferred)
@@ -216,7 +217,9 @@ end
 
 You can send the email by using the familiar syntax:
 
-`InvitationMailer.invite(invitation).deliver`
+`InvitationMailer.invite(invitation).deliver_now`
+`InvitationMailer.invite(invitation).deliver_later(wait: 1.hour)`
+For deliver_later, Active Job will need to be configured 
 
 ## Creating a test method
 When switching over to Mandrill for transactional emails we found that it was hard to setup a mailer in the console to send test emails easily (those darn designers), but really, you don't want to have to setup test objects everytime you want to send a test email. You can set up a testing 'mock' once and then call the `.test` method to send the test email.

data/lib/mandrill_mailer.rb

@@ -1,4 +1,5 @@
 require 'action_view'
+require 'active_job'
 require 'mandrill_mailer/railtie'
 require 'mandrill_mailer/mock'
 require 'mandrill_mailer/template_mailer'

data/lib/mandrill_mailer/core_mailer.rb

@@ -216,7 +216,14 @@ module MandrillMailer
     def deliver
       raise NotImplementedError.new("#{self.class.name}#deliver is not implemented.")
     end
-
+    
+    def deliver_now
+      raise NotImplementedError.new("#{self.class.name}#deliver_now is not implemented.")
+    end
+    
+    def deliver_later
+      raise NotImplementedError.new("#{self.class.name}#deliver_later is not implemented.")
+    end
 
     def mandrill_mail_handler(args)
       args

data/lib/mandrill_mailer/mandrill_message_later.rb

@@ -0,0 +1,15 @@
+require 'mandrill_mailer/message_mailer'
+module MandrillMailer
+  class MandrillMessageJob < ActiveJob::Base
+    queue_as { MandrillMailer.config.deliver_later_queue_name }
+ 
+    def perform(message, async, ip_pool, send_at)
+      mailer = MandrillMailer::MessageMailer.new
+      mailer.message = message
+      mailer.async = async
+      mailer.ip_pool = ip_pool 
+      mailer.send_at = send_at
+      mailer.deliver_now
+    end
+  end
+end

data/lib/mandrill_mailer/mandrill_template_later.rb

@@ -0,0 +1,17 @@
+require 'mandrill_mailer/template_mailer'
+module MandrillMailer
+  class MandrillTemplateJob < ActiveJob::Base
+    queue_as { MandrillMailer.config.deliver_later_queue_name }
+
+    def perform(template_name, template_content, message, async, ip_pool, send_at)
+      mailer = MandrillMailer::TemplateMailer.new
+      mailer.template_name = template_name
+      mailer.template_content = template_content
+      mailer.message = message
+      mailer.async = async
+      mailer.ip_pool = ip_pool 
+      mailer.send_at = send_at
+      mailer.deliver_now
+    end
+  end
+end

data/lib/mandrill_mailer/message_mailer.rb

@@ -92,12 +92,20 @@
 
 # :important - whether or not this message is important, and should be delivered ahead of non-important messages
 require 'mandrill_mailer/core_mailer'
-
+require 'mandrill_mailer/mandrill_message_later'
 module MandrillMailer
   class MessageMailer < MandrillMailer::CoreMailer
     # Public: Triggers the stored Mandrill params to be sent to the Mandrill api
     def deliver
+      deliver_now
+    end
+
+    def deliver_now
       mandrill_api.messages.send(message, async, ip_pool, send_at)
-    end
+    end
+
+    def deliver_later(options={})
+      MandrillMailer::MandrillMessageJob.set(options).perform_later(message, async, ip_pool, send_at)
+    end
   end
 end

data/lib/mandrill_mailer/offline.rb

@@ -27,6 +27,22 @@ module MandrillMailer
 
   class TemplateMailer
     def deliver
+      deliver_now
+    end
+    
+    def deliver_now
+      MandrillMailer::Mock.new({
+        :template_name    => template_name,
+        :template_content => template_content,
+        :message          => message,
+        :async            => async,
+        :ip_pool          => ip_pool,
+        :send_at          => send_at
+      }).tap do |mock|
+         MandrillMailer.deliveries << mock
+      end
+    end
+    def deliver_later
       MandrillMailer::Mock.new({
         :template_name    => template_name,
         :template_content => template_content,
@@ -42,6 +58,19 @@ module MandrillMailer
 
   class MessageMailer
     def deliver
+      deliver_now
+    end
+    def deliver_now
+      MandrillMailer::Mock.new({
+        :message          => message,
+        :async            => async,
+        :ip_pool          => ip_pool,
+        :send_at          => send_at
+      }).tap do |mock|
+         MandrillMailer.deliveries << mock
+      end
+    end
+    def deliver_later
       MandrillMailer::Mock.new({
         :message          => message,
         :async            => async,

data/lib/mandrill_mailer/template_mailer.rb

@@ -106,6 +106,7 @@
 # :important - whether or not this message is important, and should be delivered ahead of non-important messages
 require 'mandrill_mailer/core_mailer'
 require 'mandrill_mailer/arg_formatter'
+require 'mandrill_mailer/mandrill_template_later'
 
 module MandrillMailer
   class TemplateMailer < MandrillMailer::CoreMailer
@@ -118,9 +119,17 @@ module MandrillMailer
 
     # Public: Triggers the stored Mandrill params to be sent to the Mandrill api
     def deliver
+      deliver_now
+    end
+
+    def deliver_now
       mandrill_api.messages.send_template(template_name, template_content, message, async, ip_pool, send_at)
     end
 
+    def deliver_later(options={})
+      MandrillMailer::MandrillTemplateJob.set(options).perform_later(template_name, template_content, message, async, ip_pool, send_at)
+    end
+
     # Handle template mailer specifics before formating the given args
     def mandrill_mail_handler(args)
       # Mandrill requires template content to be there, set default value

data/lib/mandrill_mailer/version.rb

@@ -1,3 +1,3 @@
 module MandrillMailer
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/mandrill_mailer.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activesupport'
   s.add_dependency 'actionpack'
+  s.add_dependency 'activejob'
   s.add_runtime_dependency 'mandrill-api', '~> 1.0.9'
 
   s.add_development_dependency 'pry'

data/spec/message_mailer_spec.rb

@@ -8,20 +8,42 @@ describe MandrillMailer::MessageMailer do
     MandrillMailer.config.api_key = api_key
   end
 
-  describe "#deliver" do
+  describe "#deliver_now" do
     let(:async) { double(:async) }
     let(:ip_pool) { double(:ip_pool) }
     let(:send_at) { double(:send_at) }
     let(:message) { double(:message) }
 
-    it "calls the messages api with #send" do
+    before do 
       mailer.async = async
       mailer.ip_pool = ip_pool
       mailer.send_at = send_at
       mailer.message = message
+    end
 
+    it "calls the messages api with #send" do
+      expect_any_instance_of(Mandrill::Messages).to receive(:send).with(message, async, ip_pool, send_at)
+      mailer.deliver_now
+    end
+    it "has an alias deliver" do
       expect_any_instance_of(Mandrill::Messages).to receive(:send).with(message, async, ip_pool, send_at)
       mailer.deliver
     end
   end
+  describe "#deliver_later" do
+    let(:async) { 'async' }
+    let(:ip_pool) { 'ip_pool' }
+    let(:send_at) { 'send_at'}
+    let(:message) { 'this is a message'}
+
+    it "calls the messages api with #send" do
+      mailer.async = async
+      mailer.ip_pool = ip_pool
+      mailer.send_at = send_at
+      mailer.message = message
+
+      expect_any_instance_of(Mandrill::Messages).to receive(:send).with(message, async, ip_pool, send_at)
+      mailer.deliver_later
+    end
+  end
 end

data/spec/template_mailer_spec.rb

@@ -30,7 +30,7 @@ describe MandrillMailer::TemplateMailer do
     end
   end
 
-  describe "#deliver" do
+  describe "#deliver_now" do
     let(:async) { double(:async) }
     let(:ip_pool) { double(:ip_pool) }
     let(:send_at) { double(:send_at) }
@@ -38,16 +38,43 @@ describe MandrillMailer::TemplateMailer do
     let(:template_name) { double(:template_name) }
     let(:template_content) { double(:template_content) }
 
-    it "calls the messages api with #send_template" do
+    before do
       mailer.async = async
       mailer.ip_pool = ip_pool
       mailer.send_at = send_at
       mailer.message = message
       mailer.template_content = template_content
       mailer.template_name = template_name
+    end
 
+    it "calls the messages api with #send_template" do
+      expect_any_instance_of(Mandrill::Messages).to receive(:send_template).with(template_name, template_content, message, async, ip_pool, send_at)
+      mailer.deliver_now
+    end
+
+    it "has an alias deliver" do
       expect_any_instance_of(Mandrill::Messages).to receive(:send_template).with(template_name, template_content, message, async, ip_pool, send_at)
       mailer.deliver
     end
   end
+  describe "#deliver_later" do
+    let(:async) { false }
+    let(:ip_pool) { 1 }
+    let(:send_at) { '100'}
+    let(:message) { 'message' }
+    let(:template_name) { 'fake_template' }
+    let(:template_content) { 'content' }
+
+    it "calls the messages api with #send_template" do
+      mailer.async = async
+      mailer.ip_pool = ip_pool
+      mailer.send_at = send_at
+      mailer.message = message
+      mailer.template_content = template_content
+      mailer.template_name = template_name
+
+      expect_any_instance_of(Mandrill::Messages).to receive(:send_template).with(template_name, template_content, message, async, ip_pool, send_at)
+      mailer.deliver_later
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mandrill_mailer
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Adam Rensel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-02 00:00:00.000000000 Z
+date: 2015-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mandrill-api
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +110,8 @@ files:
 - lib/mandrill_mailer.rb
 - lib/mandrill_mailer/arg_formatter.rb
 - lib/mandrill_mailer/core_mailer.rb
+- lib/mandrill_mailer/mandrill_message_later.rb
+- lib/mandrill_mailer/mandrill_template_later.rb
 - lib/mandrill_mailer/message_mailer.rb
 - lib/mandrill_mailer/mock.rb
 - lib/mandrill_mailer/offline.rb
@@ -137,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Transactional Mailer for Mandrill