sendwithus_ruby_action_mailer 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b5ed4fd380e163f80dcfa9072963cb10ffa2c0e
-  data.tar.gz: decd4114b665b03bd3d9c6aa360201e11ea16845
+  metadata.gz: f252eb70f4fcd2d85986136d8c9499d3d351d653
+  data.tar.gz: 3c49269296138883a73eab6bbbaad233f3e52d2d
 SHA512:
-  metadata.gz: 17749e64d882871acb621e98708531d0983feaa815485c1b0d80e79b33286586304668cbdb5d38fe3e495b6a3f8f1b97c060e0b7f016a120eab76cecd8ecdcdf
-  data.tar.gz: b9619fcb4f91c8fb1249427c7bb5a1c92121849e0004e8f67a28a6661814bc9680679b4eed1fa20c65340221e30c6466d7fd8b6c36267f911da5c1756e32aa0c
+  metadata.gz: 4a07c488dfd89616b7d2c311448330a19eefec96b0799eb96429949f0c5bb7ce0c620963be4cba0d05e865c9d7ee107e9bf3e2e547bfe5dd105bef6105029f79
+  data.tar.gz: 6913518eb2496016f241d0869bfcbc21ad3b846381704bee0e0eedc51958844c240d96b38638c0cf3c68d44e0178674d00c69fe85254e2421835e3e42a48377d

data/.github/ISSUE_TEMPLATE

@@ -0,0 +1,7 @@
+### Client version
+
+### Expected behaviour
+
+### Actual behaviour
+
+### Steps to reproduce

data/.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,28 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+<!--- Describe your changes in detail if necessary -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+## Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] My code follows the code style of this project.
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.

data/README.md

@@ -47,7 +47,7 @@ class Notifier < SendWithUsMailer::Base
 
     def welcome(recipient)
         assign(:account, recipient)
-
+        #=> in sendwithus email template {{ account }}
         assign(:captain_name, recipient.name)
         #=> in sendwithus email template {{ captain_name }}
         assign :team, {team_name: recipient.team_name, captain: recipient.name}
@@ -93,10 +93,21 @@ mail.deliver                    # sends the email
 You never instantiate your mailer class. Rather, you just call the method you defined
 on the class itself.
 
+### Sending mail asynchronously with ActiveJob
+
+`````Ruby
+Notifier.welcome(nick).deliver_later # sends the email asynchronously
+
+mail = Notifier.welcome(david)  # => a SendWithUsMailer::MailParams object
+mail.deliver_later              # sends the email asynchronously
+`````
+
+You never instantiate your mailer class. Rather, you just call the method you defined
+on the class itself.
 
 ### Conditional Delivery
 
-If you have to check for a condition for senting the email (useful when it's a scheduled sending with Sidekiq for instance), you can simply not call the mail method and the email won't be sent out.
+If you have to check for a condition for sending the email (useful when it's a scheduled sending with Sidekiq for instance), you can simply not call the mail method and the email won't be sent out.
 
 `````Ruby
 class Notifier < SendWithUsMailer::Base

data/lib/sendwithus_ruby_action_mailer.rb

@@ -1,3 +1,4 @@
 require "sendwithus_ruby_action_mailer/version"
 require "sendwithus_ruby_action_mailer/base"
 require "sendwithus_ruby_action_mailer/mail_params"
+require "sendwithus_ruby_action_mailer/jobs/mail_job"

data/lib/sendwithus_ruby_action_mailer/jobs/mail_job.rb

@@ -0,0 +1,15 @@
+require "active_job"
+
+module SendWithUsMailer
+  module Jobs
+    # The <tt>SendWithUsMailer::Jobs::MailJob</tt> class is used when you
+    # want to send transactional emails outside of the request-response cycle.
+    class MailJob < ActiveJob::Base
+      queue_as :mailers
+
+      def perform(email_id, to, options)
+        SendWithUs::Api.new.send_email(email_id, to, options)
+      end
+    end
+  end
+end

data/lib/sendwithus_ruby_action_mailer/mail_params.rb

@@ -79,5 +79,30 @@ module SendWithUsMailer
         tags: @tags
       ) if @email_id.present?
     end
+
+    alias_method :deliver_now, :deliver
+
+    # Invoke <tt>SendWithUs::Api</tt> to deliver the message later via ActiveJob.
+    # The <tt>SendWithUs</tt> module is implemented in the +send_with_us+ gem.
+    #
+    # IMPORTANT NOTE: <tt>SendWithUs</tt> must be configured prior to calling this method.
+    # In particular, the +api_key+ must be set (following the guidelines in the
+    # +send_with_us+ documentation).
+    def deliver_later
+      Jobs::MailJob.perform_later(
+          @email_id,
+          @to,
+          data: @email_data,
+          from: @from,
+          cc: @cc,
+          bcc: @bcc,
+          esp_account: @esp_account,
+          version_name: @version_name,
+          locale: @locale,
+          files: @files,
+          headers: @headers,
+          tags: @tags
+      ) if @email_id.present?
+    end
   end
 end

data/lib/sendwithus_ruby_action_mailer/version.rb

@@ -1,3 +1,3 @@
 module SendWithUsMailer
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/sendwithus_ruby_action_mailer.gemspec

@@ -21,7 +21,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency 'send_with_us', '>= 1.9.0'
-  gem.add_development_dependency 'actionpack'
+  gem.add_runtime_dependency 'actionpack'
+  gem.add_runtime_dependency 'activejob'
+
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'minitest-colorize'
   gem.add_development_dependency 'mocha'

data/test/lib/sendwithus_ruby_action_mailer/mail_params_test.rb

@@ -1,6 +1,8 @@
 require_relative '../../test_helper'
 
 describe SendWithUsMailer::MailParams do
+  include ActiveJob::TestHelper
+
   subject { SendWithUsMailer::MailParams.new }
 
   describe "initialization" do
@@ -63,9 +65,45 @@ describe SendWithUsMailer::MailParams do
       subject.deliver
     end
 
-    it "doesnt call the send_with_us gem if mail method is not called" do
+    it "doesn't call the send_with_us gem if mail method is not called" do
       SendWithUs::Api.any_instance.expects(:send_with).never
       subject.deliver
     end
   end
+
+  describe "#deliver_now" do
+    it "method exists" do
+      subject.respond_to?(:deliver_now).must_equal true
+    end
+
+    it "calls the send_with_us gem" do
+      subject.merge!(email_id: 'x')
+      SendWithUs::Api.any_instance.expects(:send_email)
+      subject.deliver_now
+    end
+
+    it "doesn't call the send_with_us gem if mail method is not called" do
+      SendWithUs::Api.any_instance.expects(:send_with).never
+      subject.deliver_now
+    end
+  end
+
+  describe "#deliver_later" do
+    it "method exists" do
+      subject.respond_to?(:deliver_later).must_equal true
+    end
+
+    it "enqueues the job" do
+      subject.merge!(email_id: 'x')
+      assert_enqueued_with(job: SendWithUsMailer::Jobs::MailJob) do
+        subject.deliver_later
+      end
+    end
+
+    it "doesn't call the send_with_us gem if no email_id" do
+      assert_no_enqueued_jobs do
+        subject.deliver_later
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sendwithus_ruby_action_mailer
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Nicholas Rempel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2017-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: send_with_us
@@ -31,7 +31,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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:
@@ -90,6 +104,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE"
+- ".github/PULL_REQUEST_TEMPLATE"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
@@ -97,6 +113,7 @@ files:
 - Rakefile
 - lib/sendwithus_ruby_action_mailer.rb
 - lib/sendwithus_ruby_action_mailer/base.rb
+- lib/sendwithus_ruby_action_mailer/jobs/mail_job.rb
 - lib/sendwithus_ruby_action_mailer/mail_params.rb
 - lib/sendwithus_ruby_action_mailer/version.rb
 - sendwithus_ruby_action_mailer.gemspec