sendgrid 1.1.0 → 1.2.0

data/Gemfile

@@ -9,8 +9,12 @@ gem "json"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  # gem "shoulda", ">= 0"
+  gem "shoulda", ">= 0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.1"
   # gem "rcov", ">= 0"
 end
+
+group :test do
+  gem "actionmailer", ">= 2.3.2"
+end

data/Gemfile.lock

@@ -1,18 +1,67 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    actionmailer (3.1.5)
+      actionpack (= 3.1.5)
+      mail (~> 2.3.3)
+    actionpack (3.1.5)
+      activemodel (= 3.1.5)
+      activesupport (= 3.1.5)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.6)
+      rack-cache (~> 1.2)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.4)
+    activemodel (3.1.5)
+      activesupport (= 3.1.5)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.5)
+      multi_json (>= 1.0, < 1.3)
+    builder (3.0.0)
+    erubis (2.7.0)
     git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
     json (1.5.1)
+    mail (2.3.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.18)
+    multi_json (1.2.0)
+    polyglot (0.3.3)
+    rack (1.3.6)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-test (0.6.1)
+      rack (>= 1.0)
     rake (0.8.7)
+    shoulda (2.10.3)
+    sprockets (2.0.4)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  actionmailer (>= 2.3.2)
   bundler (~> 1.0.0)
   jeweler (~> 1.5.1)
   json
+  shoulda

data/README.md

@@ -29,7 +29,7 @@ Example:
       :port => 25,
       :domain => "mysite.com",
       :authentication => :plain,
-      :user_name => "sendgrd_username@mysite.com",
+      :user_name => "sendgrd_username",
       :password => "sendgrid_password"
     }
 

data/Rakefile

@@ -39,20 +39,20 @@ rescue LoadError
   end
 end
 
-task :test => :check_dependencies
+task :test
 
 task :default => :test
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
+# require 'rake/rdoctask'
+# Rake::RDocTask.new do |rdoc|
+#   if File.exist?('VERSION')
+#     version = File.read('VERSION')
+#   else
+#     version = ""
+#   end
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "sendgrid #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "sendgrid #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/lib/sendgrid.rb

@@ -67,7 +67,7 @@ module SendGrid
       self.default_sg_options = Array.new unless self.default_sg_options
       options.each { |option| self.default_sg_options << option if VALID_OPTIONS.include?(option) }
     end
-
+    
     # Sets the default text for subscription tracking (must be enabled).
     # There are two options:
     # 1. Add an unsubscribe link at the bottom of the email
@@ -90,7 +90,9 @@ module SendGrid
       self.default_spamcheck_score = score
     end
 
-    # Sets the default unique arguments to send
+    # Sets unique args at the class level. Should be a hash
+    # of name, value pairs.
+    #   { :some_unique_arg => "some_value"}
     def sendgrid_unique_args(unique_args = {})
       self.default_sg_unique_args = unique_args
     end
@@ -101,7 +103,8 @@ module SendGrid
     @sg_category = category
   end
 
-  # Call within mailer method to add/override unique arguments in the defaults
+  # Call within mailer method to set unique args for this email.
+  # Merged with class-level unique args, if any exist.
   def sendgrid_unique_args(unique_args = {})
     @sg_unique_args = unique_args
   end
@@ -153,12 +156,7 @@ module SendGrid
     @ganalytics_options = []
     options.each { |option| @ganalytics_options << option if VALID_GANALYTICS_OPTIONS.include?(option[0].to_sym) }
   end
-
-  # Call within mailer method to set unique args for this email.
-  def sendgrid_unique_args(args)
-    @sg_unique_args = args
-  end
-
+  
   # only override the appropriate methods for the current ActionMailer version
   if ActionMailer::Base.respond_to?(:mail)
 
@@ -167,7 +165,7 @@ module SendGrid
     # Sets the custom X-SMTPAPI header after creating the email but before delivery
     # NOTE: This override is used for Rails 3 ActionMailer classes.
     def mail(headers={}, &block)
-      super
+      m = super
       if @sg_substitutions && !@sg_substitutions.empty?
         @sg_substitutions.each do |find, replace|
           raise ArgumentError.new("Array for #{find} is not the same size as the recipient array") if replace.size != @sg_recipients.size
@@ -175,6 +173,7 @@ module SendGrid
       end
       puts "SendGrid X-SMTPAPI: #{sendgrid_json_headers(message)}" if Object.const_defined?("SENDGRID_DEBUG_OUTPUT") && SENDGRID_DEBUG_OUTPUT
       self.headers['X-SMTPAPI'] = sendgrid_json_headers(message)
+      m
     end
 
   else
@@ -200,12 +199,15 @@ module SendGrid
   def sendgrid_json_headers(mail)
     header_opts = {}
 
+    #if not called within the mailer method, this will be nil so we default to empty hash
+    @sg_unique_args = @sg_unique_args || {}
+    
     # set the unique arguments
     if @sg_unique_args || self.class.default_sg_unique_args
       unique_args = self.class.default_sg_unique_args || {}
       unique_args = unique_args.merge(@sg_unique_args)
 
-      header_opts[:unique_args] = unique_args
+      header_opts[:unique_args] = unique_args unless unique_args.empty?
     end
 
     # Set category
@@ -230,7 +232,6 @@ module SendGrid
     end
 
     # Set enables/disables
-    header_opts[:filters] = {} unless header_opts.has_key?(:filters)
     enabled_opts = []
     if @sg_options && !@sg_options.empty?
       # merge the options so that the instance-level "overrides"
@@ -241,12 +242,8 @@ module SendGrid
       enabled_opts = self.class.default_sg_options
     end
     if !enabled_opts.empty? || (@sg_disabled_options && !@sg_disabled_options.empty?)
-      header_opts[:filters] = filters_hash_from_options(enabled_opts, @sg_disabled_options)
-    end
-
-    # Set unique_args
-    if @sg_unique_args && !@sg_unique_args.empty?
-      header_opts[:unique_args] = @sg_unique_args
+      filters = filters_hash_from_options(enabled_opts, @sg_disabled_options)
+      header_opts[:filters] = filters if filters && !filters.empty?
     end
 
     header_opts.to_json.gsub(/(["\]}])([,:])(["\[{])/, '\\1\\2 \\3')

data/sendgrid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "sendgrid"
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stephen Blankenship", "Marc Tremblay", "Bob Burbach"]
-  s.date = "2012-10-05"
+  s.date = "2013-05-15"
   s.description = "This gem allows simple integration between ActionMailer and SendGrid. \n                         SendGrid is an email deliverability API that is affordable and has lots of bells and whistles."
   s.email = "stephenrb@gmail.com"
   s.extra_rdoc_files = [
@@ -39,17 +39,20 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
     else
       s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
       s.add_dependency(%q<json>, [">= 0"])
     end
   else
     s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
     s.add_dependency(%q<json>, [">= 0"])

data/test/sendgrid_test.rb

@@ -1,7 +1,11 @@
 require 'test_helper'
 
 class SendgridTest < Test::Unit::TestCase
-  def setup    
+  def setup
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.perform_deliveries = true
+    ActionMailer::Base.deliveries = []
+    
     @options = {
       :to => ['test@example.com'],
       :from => 'test@example.com',
@@ -18,7 +22,21 @@ class SendgridTest < Test::Unit::TestCase
   
   should "require the same number of items in a substitution array as is in the recipient array" do
     assert_raise ArgumentError do
-      test_email = SendgridCampaignTestMailer.create_test(@options)
+      test_email = SendgridCampaignTestMailer.create_test(@options).deliver
     end
   end
+  
+  should "accept a hash of unique args at the class level" do
+    assert_equal ({ :test_arg => "test value" }), SendgridUniqueArgsMailer.default_sg_unique_args
+  end
+  
+  should "pass unique args from both the mailer class and the mailer method through custom headers" do
+    @options.delete(:substitutions)
+    SendgridUniqueArgsMailer.unique_args_test_email(@options).deliver
+    mail = ActionMailer::Base.deliveries.last
+    # assert({ :unique_args => {:mailer_method_unique_arg => "some value", :test_arg => "test value"} }.to_json == mail.header['X-SMTPAPI'].value)
+    expected = { 'unique_args' => {'mailer_method_unique_arg' => "some value", 'test_arg' => "test value"} }
+    actual = JSON.parse(mail.header['X-SMTPAPI'].value)
+    assert_equal(expected, actual)
+  end
 end

data/test/test_helper.rb

@@ -4,11 +4,8 @@ require 'shoulda'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'sendgrid'
 require 'action_mailer'
-
-class Test::Unit::TestCase
-end
+require 'sendgrid'
 
 class SendgridCampaignTestMailer < ActionMailer::Base
   include SendGrid
@@ -26,13 +23,9 @@ class SendgridCampaignTestMailer < ActionMailer::Base
   # array must match the :to array
   # :category the sendgrid category used for tracking
   # :html_content, :text_content, :subject
-  def test(options)
+  def create_test(options)
     handle_sendgrid_options(options)
-    recipients(options[:to])
-    from(options[:from])
-    reply_to(options[:reply_to])
-    subject(options[:subject])
-    body(options[:html_content])
+    mail(options)
   end
   
   protected
@@ -49,7 +42,16 @@ class SendgridCampaignTestMailer < ActionMailer::Base
       end
     end
     
-
     sendgrid_category(options[:category])
   end
 end
+
+class SendgridUniqueArgsMailer < ActionMailer::Base
+  include SendGrid
+  sendgrid_unique_args({ :test_arg => "test value" })
+  
+  def unique_args_test_email(options)
+    sendgrid_unique_args({ :mailer_method_unique_arg => "some value" })
+    mail(options)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-05 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -29,6 +29,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement