mandrill_mailer 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3566de247b51759a56fc96545c27b53abdcbc3d
-  data.tar.gz: 4d197d553c5336dd8012555a7b30c6144b95c6e6
+  metadata.gz: fcf5756ff80bf3ffe6dc8e5f7ce8e3696c2f0f02
+  data.tar.gz: 875412a838c62f216bc8d1aa918dc357d4d754eb
 SHA512:
-  metadata.gz: db36a12377d1db8420e65176ac5dd22fe5401b0fd13277598306d25e1ab0fa6249e7bc0a0d42f0c13fb4b22023d1ab02a213ec076ade23e03ed33973c1e12c0a
-  data.tar.gz: 93a04dfe2996c1680d24f9b83842d861a48c1fe9dbb2652aeca737de3b61f8b2e0a3dbd7565b095b9c2e7de5fbbc6eb5646f45f3237f5cbd33f31a7545c0d482
+  metadata.gz: adaed5b204343d14875024f50683af9863a97f0a7d7659d76022646ef80fe01d27a4f86c7eeb4b4f2596fadfda8ce56358f442cd6496e389fb1fb0bd94025397
+  data.tar.gz: bcd01547a76e87c47bcd17ce04d42685c2f8d3a9abd6ca35925db1229032047ddc0d256f0ed85688ca6cec3b05e84600898ccc3b26749070d9693b793a9c139b

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.0.0-p598
+  - 2.1.0
+  - 2.2.0
+
+script:
+  - bundle exec rspec spec/
+branches:
+  only:
+    - master
+notifications:
+  email: false

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.6.0
+- [IMPROVEMENT] Allow for default `merge_vars` to be set on the mailer class so that every method inherits them, just like the existing default `from` and `from_name`.
+
+# 0.5.2
+- [IMPROVEMENT] Allow the mandrill api gem to be more flexible in the accepted version
+  which allows for the json gem to be updated internally.
+
 # 0.5.2
 - [IMPROVEMENT] Allow the mandrill api gem to be more flexible in the accepted version
   which allows for the json gem to be updated internally.

data/README.md

@@ -1,7 +1,7 @@
 # Mandrill Mailer
-[![Gem Version](http://img.shields.io/gem/v/mandrill_mailer.svg)](rubygems.org/gems/mandrill_mailer)
+[![Build Status](https://travis-ci.org/renz45/mandrill_mailer.svg)](https://travis-ci.org/renz45/mandrill_mailer) [![Gem Version](http://img.shields.io/gem/v/mandrill_mailer.svg)](rubygems.org/gems/mandrill_mailer)
 [![Code Climate](http://img.shields.io/codeclimate/github/renz45/mandrill_mailer.svg)](https://codeclimate.com/github/renz45/mandrill_mailer)
-[![Dependencies](http://img.shields.io/gemnasium/renz45/mandrill_mailer.svg)](https://gemnasium.com/renz45/mandrill_mailer)
+[![Dependencies](http://img.shields.io/gemnasium/renz45/mandrill_mailer.svg)](https://gemnasium.com/renz45/mandrill_mailer) [![Inline Documentation](http://inch-ci.org/github/renz45/mandrill_mailer.svg?branch=master)](http://inch-ci.org/github/renz45/mandrill_mailer)
 
 Inherit the MandrillMailer class in your existing Rails mailers to send transactional emails through Mandrill using their template-based emails.
 
@@ -99,6 +99,7 @@ end
 * `#default:`
   * `:from` - set the default from email address for the mailer
   * `: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`.
 
 * `.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)

data/lib/mandrill_mailer/core_mailer.rb

@@ -4,7 +4,9 @@
 # Example usage:
 
 # class InvitationMailer < MandrillMailer::TemplateMailer
-#   default from: 'support@codeschool.com'
+#   default from: 'support@codeschool.com',
+#           from_name: 'Code School',
+#           merge_vars: { 'FOO' => 'Bar' }
 
 #   def invite(invitation)
 #     invitees = invitation.invitees.map { |invitee| { email: invitee.email, name: invitee.name } }
@@ -34,7 +36,9 @@
 # end
 
 # #default:
-#   :from - set the default from email address for the mailer
+#   :from       - set the default from email address for the mailer
+#   :from_name  - set the default from name for the mailer
+#   :merge_vars - set the default merge vars for the mailer
 
 # .mandrill_mail
 #   :template(required) - Template name from within Mandrill
@@ -123,12 +127,17 @@ module MandrillMailer
 
     # Public: Defaults for the mailer. Currently the only option is from:
     #
-    # options - The Hash options used to refine the selection (default: {}):
-    #   :from - Default from email address
+    # options       - The Hash options used to refine the selection (default: {}):
+    #   :from       - Default from email address
+    #   :from_name  - Default from name
+    #   :merge_vars - Default merge vars
     #
     # Examples
     #
-    #   default from: 'foo@bar.com'
+    #   default from: 'foo@bar.com',
+    #           from_name: 'Foo Bar',
+    #           merge_vars: {'FOO' => 'Bar'}
+    #
     #
     # Returns options
     def self.defaults
@@ -142,6 +151,7 @@ module MandrillMailer
     def self.default(args)
       @defaults ||= {}
       @defaults[:from] ||= 'example@email.com'
+      @defaults[:merge_vars] ||= {}
       @defaults.merge!(args)
     end
 
@@ -316,6 +326,8 @@ module MandrillMailer
 
     # convert a normal hash into the format mandrill needs
     def mandrill_args(args)
+      args = merge_default_merge_vars(args)
+
       return [] unless args
       args.map do |k,v|
         {'name' => k, 'content' => v}
@@ -326,10 +338,14 @@ module MandrillMailer
       return [] unless args
       args.map do |item|
         rcpt = item.keys[0]
-        {'rcpt' => rcpt, 'vars' => mandrill_args(item.fetch(rcpt))}
+        { 'rcpt' => rcpt, 'vars' => mandrill_args(item.fetch(rcpt)) }
       end
     end
 
+    def merge_default_merge_vars(args)
+      self.class.defaults[:merge_vars].merge(args)
+    end
+
     # ensure only true or false is returned given arg
     def format_boolean(arg)
       arg ? true : false

data/lib/mandrill_mailer/message_mailer.rb

@@ -168,7 +168,7 @@ module MandrillMailer
         "preserve_recipients" => args[:preserve_recipients],
         "bcc_address" => args[:bcc],
         "global_merge_vars" => mandrill_args(args[:vars]),
-        "merge_vars" => mandrill_rcpt_args(args[:recipient_vars]),
+        "merge_vars" => mandrill_rcpt_args(args[:recipient_vars] || self.class.defaults[:merge_vars]),
         "tags" => args[:tags],
         "subaccount" => args[:subaccount],
         "google_analytics_domains" => args[:google_analytics_domains],

data/lib/mandrill_mailer/template_mailer.rb

@@ -4,7 +4,9 @@
 # Example usage:
 
 # class InvitationMailer < MandrillMailer::TemplateMailer
-#   default from: 'support@codeschool.com'
+#   default from: 'support@codeschool.com',
+#           from_name: 'Code School',
+#           merge_vars: { 'FOO' => 'Bar' }
 
 #   def invite(invitation)
 #     invitees = invitation.invitees.map { |invitee| { email: invitee.email, name: invitee.name } }

data/lib/mandrill_mailer/version.rb

@@ -1,3 +1,3 @@
 module MandrillMailer
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/spec/template_mailer_spec.rb

@@ -360,35 +360,39 @@ describe MandrillMailer::TemplateMailer do
   describe 'defaults' do
     it 'should not share between different subclasses' do
       klassA = Class.new(MandrillMailer::TemplateMailer) do
-        default from_name: 'ClassA'
+        default from_name: 'ClassA', merge_vars: { 'FOO' => 'Bar' }
       end
       klassB = Class.new(MandrillMailer::TemplateMailer) do
         default from_name: 'ClassB'
       end
 
       expect(klassA.mandrill_mail({vars: {}}).message['from_name']).to eq 'ClassA'
+      expect(klassA.mandrill_mail({vars: {}}).message['global_merge_vars']).to include({"name"=>"FOO", "content"=>"Bar"})
       expect(klassB.mandrill_mail({vars: {}}).message['from_name']).to eq 'ClassB'
+      expect(klassB.mandrill_mail({vars: {}}).message['global_merge_vars']).to_not include({"name"=>"FOO", "content"=>"Bar"})
     end
 
     it 'should use defaults from the parent class' do
       klassA = Class.new(MandrillMailer::TemplateMailer) do
-        default from_name: 'ClassA'
+        default from_name: 'ClassA', merge_vars: { 'FOO' => 'Bar' }
       end
       klassB = Class.new(klassA) do
       end
 
-      expect(klassB.mandrill_mail({vars:{}}).message['from_name']).to eq 'ClassA'
+      expect(klassB.mandrill_mail({vars: {}}).message['from_name']).to eq 'ClassA'
+      expect(klassB.mandrill_mail({vars: {}}).message['global_merge_vars']).to include({"name"=>"FOO", "content"=>"Bar"})
     end
 
     it 'should allow overriding defaults from the parent' do
       klassA = Class.new(MandrillMailer::TemplateMailer) do
-        default from_name: 'ClassA'
+        default from_name: 'ClassA', merge_vars: { 'FOO' => 'Bar' }
       end
       klassB = Class.new(klassA) do
-        default from_name: 'ClassB'
+        default from_name: 'ClassB', merge_vars: { 'FOO' => 'Boo' }
       end
 
-      expect(klassB.mandrill_mail({vars:{}}).message['from_name']).to eq 'ClassB'
+      expect(klassB.mandrill_mail({vars: {}}).message['from_name']).to eq 'ClassB'
+      expect(klassB.mandrill_mail({vars: {}}).message['global_merge_vars']).to include({"name"=>"FOO", "content"=>"Boo"})
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mandrill_mailer
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Adam Rensel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - README.md