sendgrid 0.0.1 → 1.2.4

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+
+gem "json"
+
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  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

@@ -0,0 +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

@@ -0,0 +1,127 @@
+sendgrid
+=========
+
+_Now updated to work with Rails 3._
+
+What is SendGrid?
+-----------------
+
+SendGrid is an awesome service that helps you send large amounts of email (bells and whistles included) without spending large amounts of money. This gem allows for painless integration between ActionMailer and the SendGrid SMTP API. The current scope of this gem is focused around setting configuration options for outgoing email (essentially, setting categories, filters and the settings that can accompany those filters). SendGrid's service allows for some other cool stuff (such as postback notification of unsubscribes, bounces, etc.), but those features are currently outside the scope of this gem.
+
+Visit [SendGrid](http://sendgrid.com) to learn more.
+
+Getting Started
+---------------
+
+First of all, you'll need the gem. It's at http://rubygems.org/gems/sendgrid. If you're using Bundler, just add the following to your Gemfile.
+
+    gem 'sendgrid'
+
+
+Before you can do anything with the sendgrid gem, you'll need to create your very own SendGrid account. Go ahead and do so at [http://sendgrid.com](http://sendgrid.com) (there's even a FREE account option).
+
+Next, update your application's SMTP settings to use SendGrid's servers (see [SendGrid's getting started guide](http://wiki.sendgrid.com/doku.php?id=get_started) for instructions).
+
+Example:
+
+    ActionMailer::Base.smtp_settings = {
+      :address => "smtp.sendgrid.net",
+      :port => 25,
+      :domain => "mysite.com",
+      :authentication => :plain,
+      :user_name => "sendgrd_username",
+      :password => "sendgrid_password"
+    }
+
+Using the sendgrid Gem
+----------------------
+
+If you do not already have an ActionMailer class up and running, then check out [this guide.](http://guides.rubyonrails.org/action_mailer_basics.html#walkthrough-to-generating-a-mailer)
+
+1) add the following line within your mailer class:
+
+    include SendGrid
+
+
+2) customize your sendgrid settings:
+
+There are 2 main types of settings
+
+* Category settings
+* Enable/disable settings
+
+You can set both global and per-email settings - the same syntax is used in either case.
+Here is an example of what typical usage may look like:
+
+    class MyMailer < ActionMailer::Base
+      include SendGrid
+      sendgrid_category :use_subject_lines
+      sendgrid_enable   :ganalytics, :opentrack
+      sendgrid_unique_args :key1 => "value1", :key2 => "value2"
+
+      def welcome_message(user)
+        sendgrid_category "Welcome"
+        sendgrid_unique_args :key2 => "newvalue2", :key3 => "value3"
+        mail :to => user.email, :subject => "Welcome #{user.name} :-)"
+      end
+
+      def goodbye_message(user)
+        sendgrid_disable :ganalytics
+        mail :to => user.email, :subject => "Fare thee well :-("
+      end
+    end
+
+Category settings can be any text you like and SendGrid's website will allow you to view email statistics per-category (very nice). There is also a custom global setting that will automatically use the subject line of each email as the sendgrid\_category:
+
+    sendgrid_category :use_subject_lines
+
+If you have any dynamic subject lines, you'll want to override this setting within the mailer method. Calling sendgrid\_category from within one of your mailer methods will override this global setting. Similarly, calling sendgrid\_enable/sendgrid\_disable from within a mailer method will add or remove from any defaults that may have been set globally.
+
+Here are a list of supported options for sendgrid\_enable and sendgrid\_disable:
+
+* :opentrack
+* :clicktrack
+* :ganalytics
+  * Call sendgrid\_ganalytics\_options(:utm_source => 'welcome_email', :utm_medium => 'email', :utm_campaign => 'promo', :utm_term => 'intro+text', :utm_content => 'header_link') to set custom Google Analytics variables.
+* :gravatar
+* :subscriptiontrack
+  * Call sendgrid\_subscriptiontrack\_text(:html => 'Unsubscribe <% Here %>', :plain => 'Unsubscribe Here: <% %>') to set a custom format for html/plain or both.
+  * OR Call sendgrid\_subscriptiontrack\_text(:replace => '|unsubscribe\_link|') to replace all occurrences of |unsubscribe\_link| with the url of the unsubscribe link
+* :footer
+  * Call sendgrid\_footer\_text(:html => 'My HTML footer rocks!', :plain => 'My plain text footer is so-so.') to set custom footer text for html, plain or both.
+* :spamcheck
+  * Call sendgrid\_spamcheck\_maxscore(4.5) to set a custom SpamAssassin threshold at which SendGrid drops emails (default value is 5.0).
+
+For further explanation see [SendGrid's wiki page on filters.](http://wiki.sendgrid.com/doku.php?id=filters)
+
+Custom parameters can be set using the sendgrid_unique_args methods.  Any key/value pairs defined thusly will
+be included as parameters in SendGrid post backs.  These are especially useful in cases where the recipient's
+email address is not unique or when multiple applications/environments are using the same SendGrid account.
+
+
+Delivering to multiple recipients
+---------------------------------
+
+There is a per-mailer-method setting that can be used to deliver campaigns to multiple (many) recipients in a single delivery/SMTP call.
+It is quite easy to build a robust mass-delivery system utilizing this feature, and it is quite difficult to deliver a large email campaign quickly without this feature.
+Note: While it may be worth asking yourself, a SendGrid engineer told me it's best to keep the number of recipients to <= 1,000 per delivery.
+
+
+    sendgrid_recipients ["email1@blah.com", "email2@blah.com", "email3@blah.com", ...]
+
+
+One issue that arises when delivering multiple emails at once is custom content. Luckily, there is also a per-mailer-method setting that can be used to substitute custom content.
+
+
+    sendgrid_substitute "|subme|", ["sub text for 1st recipient", "sub text for 2nd recipient", "sub text for 3rd recipient", ...]
+
+
+In this example, if <code>|subme|</code> is in the body of your email SendGrid will automatically substitute it for the string corresponding the recipient being delivered to. NOTE: You should ensure that the length of the substitution array is equal to the length of the recipients array.
+
+
+TODO
+----
+
+* Test coverage (I would appreciate help writing tests).
+* Possibly integrate with SendGrid's Event API and some of the other goodies they provide.
+

data/Rakefile

@@ -10,8 +10,8 @@ begin
                          SendGrid is an email deliverability API that is affordable and has lots of bells and whistles.}
     gem.email = "stephenrb@gmail.com"
     gem.homepage = "http://github.com/stephenb/sendgrid"
-    gem.authors = ["Stephen Blankenship"]
-    # gem.add_development_dependency "thoughtbot-shoulda"
+    gem.authors = ["Stephen Blankenship", "Marc Tremblay", "Bob Burbach"]
+    gem.add_dependency "json"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -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 @@
-0.0.1
+1.2.4

data/lib/sendgrid/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module SendGrid
+  class Railtie < Rails::Railtie # :nodoc:
+
+    initializer "send_grid.action_mailer" do
+      ActiveSupport.on_load(:action_mailer) { ActionMailer::Base.send(:include, SendGrid) }
+    end
+
+  end
+end

data/lib/sendgrid/version.rb

@@ -0,0 +1,3 @@
+module SendGrid #:nodoc:
+  VERSION = "2.0.0"
+end

data/lib/sendgrid.rb

@@ -9,22 +9,40 @@ module SendGrid
     :gravatar,
     :subscriptiontrack,
     :footer,
-    :spamcheck
+    :spamcheck,
+    :bypass_list_management
   ]
-  
+
+  VALID_GANALYTICS_OPTIONS = [
+    :utm_source,
+    :utm_medium,
+    :utm_campaign,
+    :utm_term,
+    :utm_content
+  ]
+
   def self.included(base)
     base.class_eval do
       class << self
         attr_accessor :default_sg_category, :default_sg_options, :default_subscriptiontrack_text,
-                      :default_footer_text, :default_spamcheck_score
+                      :default_footer_text, :default_spamcheck_score, :default_sg_unique_args
       end
-      attr_accessor :sg_category, :sg_options, :sg_disabled_options, :subscriptiontrack_text, :footer_text, :spamcheck_score
+      attr_accessor :sg_category, :sg_options, :sg_disabled_options, :sg_recipients, :sg_substitutions,
+                    :subscriptiontrack_text, :footer_text, :spamcheck_score, :sg_unique_args, :sg_send_at
     end
+
+    # NOTE: This commented-out approach may be a "safer" option for Rails 3, but it
+    # would cause the headers to get set during delivery, and not when the message is initialized.
+    # If base supports register_interceptor (i.e., Rails 3 ActionMailer), use it...
+    # if base.respond_to?(:register_interceptor)
+    #   base.register_interceptor(SendgridInterceptor)
+    # end
+
     base.extend(ClassMethods)
   end
-  
+
   module ClassMethods
-    
+
     # Sets a default category for all emails.
     # :use_subject_lines has special behavior that uses the subject-line of
     # each outgoing email for the SendGrid category. This special behavior
@@ -33,7 +51,7 @@ module SendGrid
     def sendgrid_category(category)
       self.default_sg_category = category
     end
-    
+
     # Enables a default option for all emails.
     # See documentation for details.
     #
@@ -51,14 +69,17 @@ module SendGrid
     end
     
     # Sets the default text for subscription tracking (must be enabled).
-    # Should be a hash containing the html/plain text versions: 
-    #   {:html => "html version", :plain => "plan text version"}
+    # There are two options:
+    # 1. Add an unsubscribe link at the bottom of the email
+    #   {:html => "Unsubscribe <% here %>", :plain => "Unsubscribe here: <% %>"}
+    # 2. Replace given text with the unsubscribe link
+    #   {:replace => "<unsubscribe_link>" }
     def sendgrid_subscriptiontrack_text(texts)
       self.default_subscriptiontrack_text = texts
     end
-    
+
     # Sets the default footer text (must be enabled).
-    # Should be a hash containing the html/plain text versions: 
+    # Should be a hash containing the html/plain text versions:
     #   {:html => "html version", :plain => "plan text version"}
     def sendgrid_footer_text(texts)
       self.default_footer_text = texts
@@ -68,6 +89,13 @@ module SendGrid
     def sendgrid_spamcheck_maxscore(score)
       self.default_spamcheck_score = score
     end
+
+    # 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
   end
 
   # Call within mailer method to override the default value.
@@ -75,45 +103,118 @@ module SendGrid
     @sg_category = category
   end
 
+  # Call within mailer method to set send time for this mail
+  def sendgrid_send_at(utc_timestamp)
+    @sg_send_at = utc_timestamp
+  end
+
+  # 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
+
   # Call within mailer method to add an option not in the defaults.
   def sendgrid_enable(*options)
     @sg_options = Array.new unless @sg_options
     options.each { |option| @sg_options << option if VALID_OPTIONS.include?(option) }
   end
-  
+
   # Call within mailer method to remove one of the defaults.
   def sendgrid_disable(*options)
     @sg_disabled_options = Array.new unless @sg_disabled_options
     options.each { |option| @sg_disabled_options << option if VALID_OPTIONS.include?(option) }
   end
 
+  # Call within mailer method to add an array of recipients
+  def sendgrid_recipients(emails)
+    @sg_recipients = Array.new unless @sg_recipients
+    @sg_recipients = emails
+  end
+
+  # Call within mailer method to add an array of substitions
+  # NOTE: you must ensure that the length of the substitions equals the
+  #       length of the sendgrid_recipients.
+  def sendgrid_substitute(placeholder, subs)
+    @sg_substitutions = Hash.new unless @sg_substitutions
+    @sg_substitutions[placeholder] = subs
+  end
+
   # Call within mailer method to override the default value.
   def sendgrid_subscriptiontrack_text(texts)
     @subscriptiontrack_text = texts
   end
-  
+
   # Call within mailer method to override the default value.
   def sendgrid_footer_text(texts)
     @footer_text = texts
   end
-  
+
   # Call within mailer method to override the default value.
   def sendgrid_spamcheck_maxscore(score)
     @spamcheck_score = score
   end
+
+  # Call within mailer method to set custom google analytics options
+  # http://sendgrid.com/documentation/appsGoogleAnalytics
+  def sendgrid_ganalytics_options(options)
+    @ganalytics_options = []
+    options.each { |option| @ganalytics_options << option if VALID_GANALYTICS_OPTIONS.include?(option[0].to_sym) }
+  end
   
-  private
+  # only override the appropriate methods for the current ActionMailer version
+  if ActionMailer::Base.respond_to?(:mail)
+
+    protected
+
+    # 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)
+      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
+        end
+      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
+
+    # Sets the custom X-SMTPAPI header after creating the email but before delivery
+    # NOTE: This override is used for Rails 2 ActionMailer classes.
+    def create!(method_name, *parameters)
+      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
+        end
+      end
+      puts "SendGrid X-SMTPAPI: #{sendgrid_json_headers(mail)}" if Object.const_defined?("SENDGRID_DEBUG_OUTPUT") && SENDGRID_DEBUG_OUTPUT
+      @mail['X-SMTPAPI'] = sendgrid_json_headers(mail)
+    end
 
-  # Sets the custom X-SMTPAPI header before sending the email
-  def perform_delivery_smtp(mail)
-    headers['X-SMTPAPI'] = sendgrid_json_headers(mail)
-    super
   end
 
+  private
+
   # Take all of the options and turn it into the json format that SendGrid expects
   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 unless unique_args.empty?
+    end
+
     # Set category
     if @sg_category && @sg_category == :use_subject_lines
       header_opts[:category] = mail.subject
@@ -125,35 +226,59 @@ module SendGrid
       header_opts[:category] = self.class.default_sg_category
     end
 
-    # Set enables
-    header_opts[:filters] = {} unless header_opts.has_key?(:filters)
-    if (@sg_options && !@sg_options.empty?) || (@sg_disabled_options && !@sg_disabled_options.empty?)
+    #Set send_at if set by the user
+    header_opts[:send_at] = @sg_send_at unless @sg_send_at.blank?
+
+    # Set multi-recipients
+    if @sg_recipients && !@sg_recipients.empty?
+      header_opts[:to] = @sg_recipients
+    end
+
+    # Set custom substitions
+    if @sg_substitutions && !@sg_substitutions.empty?
+      header_opts[:sub] = @sg_substitutions
+    end
+
+    # Set enables/disables
+    enabled_opts = []
+    if @sg_options && !@sg_options.empty?
       # merge the options so that the instance-level "overrides"
-      merged = self.class.default_sg_options
-      merged += @sg_options if @sg_options
-      merged.reject! { |option| @sg_disabled_options.include?(option) } if @sg_disabled_options
-      header_opts[:filters] = filters_hash_from_options(merged)
-    else
-      header_opts[:filters] = filters_hash_from_options(self.class.default_sg_options)
+      merged = self.class.default_sg_options || []
+      merged += @sg_options
+      enabled_opts = merged
+    elsif self.class.default_sg_options
+      enabled_opts = self.class.default_sg_options
+    end
+    if !enabled_opts.empty? || (@sg_disabled_options && !@sg_disabled_options.empty?)
+      filters = filters_hash_from_options(enabled_opts, @sg_disabled_options)
+      header_opts[:filters] = filters if filters && !filters.empty?
     end
 
-    header_opts.to_json
+    header_opts.to_json.gsub(/(["\]}])([,:])(["\[{])/, '\\1\\2 \\3')
   end
-  
-  def filters_hash_from_options(opts)
+
+  def filters_hash_from_options(enabled_opts, disabled_opts)
     filters = {}
-    opts.each do |opt|
+    enabled_opts.each do |opt|
       filters[opt] = {'settings' => {'enable' => 1}}
       case opt.to_sym
         when :subscriptiontrack
           if @subscriptiontrack_text
-            filters[:subscriptiontrack]['settings']['text/html'] = @subscriptiontrack_text[:html]
-            filters[:subscriptiontrack]['settings']['text/plain'] = @subscriptiontrack_text[:plain]
+            if @subscriptiontrack_text[:replace]
+              filters[:subscriptiontrack]['settings']['replace'] = @subscriptiontrack_text[:replace]
+            else
+              filters[:subscriptiontrack]['settings']['text/html'] = @subscriptiontrack_text[:html]
+              filters[:subscriptiontrack]['settings']['text/plain'] = @subscriptiontrack_text[:plain]
+            end
           elsif self.class.default_subscriptiontrack_text
-            filters[:subscriptiontrack]['settings']['text/html'] = self.class.default_subscriptiontrack_text[:html]
-            filters[:subscriptiontrack]['settings']['text/plain'] = self.class.default_subscriptiontrack_text[:plain]
+            if self.class.default_subscriptiontrack_text[:replace]
+              filters[:subscriptiontrack]['settings']['replace'] = self.class.default_subscriptiontrack_text[:replace]
+            else
+              filters[:subscriptiontrack]['settings']['text/html'] = self.class.default_subscriptiontrack_text[:html]
+              filters[:subscriptiontrack]['settings']['text/plain'] = self.class.default_subscriptiontrack_text[:plain]
+            end
           end
-  
+
         when :footer
           if @footer_text
             filters[:footer]['settings']['text/html'] = @footer_text[:html]
@@ -162,14 +287,28 @@ module SendGrid
             filters[:footer]['settings']['text/html'] = self.class.default_footer_text[:html]
             filters[:footer]['settings']['text/plain'] = self.class.default_footer_text[:plain]
           end
-  
+
         when :spamcheck
           if self.class.default_spamcheck_score || @spamcheck_score
             filters[:spamcheck]['settings']['maxscore'] = @spamcheck_score || self.class.default_spamcheck_score
           end
+
+        when :ganalytics
+          if @ganalytics_options
+            @ganalytics_options.each do |key, value|
+              filters[:ganalytics]['settings'][key.to_s] = value
+            end
+          end
+      end
+    end
+
+    if disabled_opts
+      disabled_opts.each do |opt|
+        filters[opt] = {'settings' => {'enable' => 0}}
       end
     end
+
     return filters
   end
-  
+
 end

data/sendgrid.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "sendgrid"
+  s.version = "1.2.4"
+
+  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 = "2016-01-08"
+  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 = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/sendgrid.rb",
+    "lib/sendgrid/railtie.rb",
+    "lib/sendgrid/version.rb",
+    "sendgrid.gemspec",
+    "test/sendgrid_test.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = "http://github.com/stephenb/sendgrid"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "A gem that allows simple integration of ActionMailer with SendGrid (http://sendgrid.com)"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    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"])
+  end
+end
+

data/test/sendgrid_test.rb

@@ -1,7 +1,42 @@
 require 'test_helper'
 
 class SendgridTest < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  def setup
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.perform_deliveries = true
+    ActionMailer::Base.deliveries = []
+
+    @options = {
+      :to => ['test@example.com'],
+      :from => 'test@example.com',
+      :reply_to => 'reply-to@example.com',
+      :subject => 'The Subject',
+      :body => '<html>content</html>',
+      :category => 'MyCategory',
+      :substitutions => {
+        'first_name' => ['Joe'],
+        'last_name' => ['Schmoe', 'Cool']
+      }
+    }
+  end
+
+  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).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,7 +4,54 @@ require 'shoulda'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'action_mailer'
 require 'sendgrid'
 
-class Test::Unit::TestCase
+class SendgridCampaignTestMailer < ActionMailer::Base
+  include SendGrid
+  
+  sendgrid_enable :opentrack, :clicktrack, :subscriptiontrack, :bypass_list_management
+    
+  REQUIRED_OPTIONS = [:to, :from, :category, :html_content, :subject]
+  
+  ##
+  # options are:
+  # :from the from address
+  # :to an array of recipients
+  # :substitutions a hash of substitutions of the form: 'text to be
+  # replaced' => [replacements]. The order and size of the replacement
+  # array must match the :to array
+  # :category the sendgrid category used for tracking
+  # :html_content, :text_content, :subject
+  def create_test(options)
+    handle_sendgrid_options(options)
+    mail(options)
+  end
+  
+  protected
+  def handle_sendgrid_options(options)
+    REQUIRED_OPTIONS.each do |option|
+      raise ArgumentError.new("Required sendgrid option ':#{option}' missing") unless options[option]
+    end
+    
+    sendgrid_recipients(options[:to])
+    
+    if options[:substitutions]
+      options[:substitutions].each do |find, replace|
+        sendgrid_substitute(find, replace)
+      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,67 +1,143 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sendgrid
-version: !ruby/object:Gem::Version 
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 1.2.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Stephen Blankenship
+- Marc Tremblay
+- Bob Burbach
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-11-08 00:00:00 -07:00
-default_executable: 
-dependencies: []
-
-description: |-
-  This gem allows simple integration between ActionMailer and SendGrid. 
-                           SendGrid is an email deliverability API that is affordable and has lots of bells and whistles.
+date: 2016-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !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
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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."
 email: stephenrb@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
-- README.textile
-files: 
+- README.md
+files:
 - .document
-- .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
-- README.textile
+- README.md
 - Rakefile
 - VERSION
 - lib/sendgrid.rb
+- lib/sendgrid/railtie.rb
+- lib/sendgrid/version.rb
+- sendgrid.gemspec
 - test/sendgrid_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/stephenb/sendgrid
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A gem that allows simple integration of ActionMailer with SendGrid (http://sendgrid.com)
-test_files: 
-- test/sendgrid_test.rb
-- test/test_helper.rb
+test_files: []

data/.gitignore

@@ -1,5 +0,0 @@
-*.sw?
-.DS_Store
-coverage
-rdoc
-pkg

data/README.textile

@@ -1,95 +0,0 @@
-h1. sendgrid
-
-h3. What is SendGrid?
-
-SendGrid is an awesome way to send large amounts of email (bells and whistles included) without spending large amounts of money. This gem allows for painless integration between ActionMailer and the SendGrid SMTP API. The current scope of this gem is focused around setting configuration options for outgoing email (essentially, setting categories, filters and the settings that can accompany those filters). SendGrid's service allows for some other cool stuff (such as postback notification of unsubscribes, bounces, etc.), but you'll have to integrate those features on your own.
-
-Visit "SendGrid":http://sendgrid.com to learn more.
-
-h3. Getting Started
-
-First of all, you'll need the gem. "Click here to get it from gemcutter":http://gemcutter.org/gems/sendgrid.
-
-Before you can do anything with the sendgrid gem, you'll need to create your very own SendGrid account. Go ahead and do so at "http://sendgrid.com":http://sendgrid.com (there's even a FREE account option).
-
-Next, update your application's SMTP settings to use SendGrid's servers (see "SendGrid's getting started guide":http://wiki.sendgrid.com/doku.php?id=get_started for instructions).
-
-Example:
-<pre>
-ActionMailer::Base.smtp_settings = {
-  :address => "smtp.sendgrid.net",
-  :port => 25,
-  :domain => "mysite.com",
-  :authentication => :plain,
-  :user_name => "sendgrd_username@mysite.com",
-  :password => "sendgrid_password"
-}
-</pre>
-
-h3. Using the sendgrid Gem
-
-If you do not already have an ActionMailer class up and running, then check out "this guide.":http://guides.rubyonrails.org/action_mailer_basics.html#walkthrough-to-generating-a-mailer
-
-1) add the following line within your mailer class:
-<pre>
-  include SendGrid
-</pre>
-
-2) customize your sendgrid settings:
-
-There are 2 types of settings
-- Category settings
-- Enable/disable settings
-
-You can set both global and per-email settings - the same syntax is used in either case.
-Here is an example of what typical usage may look like:
-
-<pre>
-class MyMailer < ActionMailer::Base
-  include SendGrid
-  sendgrid_category :use_subject_lines
-  sendgrid_enable   :ganalytics, :opentracking
-  
-  def welcome_message(to_user)
-    sendgrid_category "Welcome"
-    
-    recipients to_user.email
-    subject "Welcome :-)"
-    body :to_user => to_user
-  end
-  
-  def goodbye_message(to_user)
-    sendgrid_disable :ganalytics
-    
-    recipients to_user.email
-    subject "Fare thee well :-("
-    body :to_user => to_user
-  end
-end
-</pre>
-
-Category settings can be any text you like and will allow you to view statistics per-category (very nice). There is also a custom global setting that will automatically use the subject-line of your email as the sendgrid_category:
-<pre>
-  sendgrid_category :use_subject_lines
-</pre>
-Calling sendgrid_cateogry from within one of your mailer methods will override this global setting. Similarly, calling sendgrid_enable/sendgrid_disable from within a mailer method will add or remove from any defaults that may have been set globally.
-
-Here are a list of supported options for sendgrid_enable and sendgrid_disable:
-* :opentrack
-* :clicktrack
-* :ganalytics
-* :gravatar
-* :subscriptiontrack
-** Call sendgrid_subscriptiontrack_text(:html => 'Unsubscribe <% Here %>', :plain => 'Unsubscribe Here: <% %>') to set a custom format for html/plain or both.
-* :footer
-** Call sendgrid_footer_text(:html => 'My HTML footer rocks!', :plain => 'My plain text footer is so-so.') to set custom footer text for html/plain or both.
-* :spamcheck
-** Call sendgrid_spamcheck_maxscore(4.5) to set a custom SpamAssassin threshold at which SendGrid drops emails (default value is 5.0).
-  
-For further explanation see "SendGrid's wiki page on filters.":http://wiki.sendgrid.com/doku.php?id=filters
-
-h3. TODO
-
-* Test coverage (I would appreciate help writing tests).
-* Possibly integrate with SendGrid's Event API and some of the other goodies they provide.
-