sendgrid 0.1.1 → 0.1.2

data/README.textile

@@ -93,6 +93,8 @@ Here are a list of supported options for sendgrid_enable and sendgrid_disable:
 * :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

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/sendgrid.rb

@@ -9,7 +9,8 @@ module SendGrid
     :gravatar,
     :subscriptiontrack,
     :footer,
-    :spamcheck
+    :spamcheck,
+    :bypass_list_management
   ]
   
   def self.included(base)
@@ -51,8 +52,11 @@ 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
@@ -119,6 +123,11 @@ module SendGrid
   # Sets the custom X-SMTPAPI header after creating the email but before delivery
   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 != mail.to.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
@@ -165,7 +174,7 @@ module SendGrid
       header_opts[:filters] = filters_hash_from_options(enabled_opts, @sg_disabled_options)
     end
     
-    header_opts.to_json
+    header_opts.to_json.gsub(/(["\]}])([,:])(["\[{])/, '\\1\\2 \\3')
   end
   
   def filters_hash_from_options(enabled_opts, disabled_opts)
@@ -175,11 +184,19 @@ module SendGrid
       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 @subscription_text[:replace]
+              filters[:subscriptiontrack]['settings']['replace'] = @subscription_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

data/test/sendgrid_test.rb

@@ -1,7 +1,24 @@
 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    
+    @options = {
+      :to => ['test@example.com'],
+      :from => 'test@example.com',
+      :reply_to => 'reply-to@example.com',
+      :subject => 'The Subject',
+      :html_content => '<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)
+    end
   end
 end

data/test/test_helper.rb

@@ -5,6 +5,51 @@ 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
+
+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 test(options)
+    handle_sendgrid_options(options)
+    recipients(options[:to])
+    from(options[:from])
+    reply_to(options[:reply_to])
+    subject(options[:subject])
+    body(options[:html_content])
+  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

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: sendgrid
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Stephen Blankenship
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-02 00:00:00 -07:00
+date: 2010-03-24 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -47,18 +52,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A gem that allows simple integration of ActionMailer with SendGrid (http://sendgrid.com)