sendgrid-rails 1.0.0 → 1.1.0

data/README.rdoc

@@ -7,15 +7,14 @@ It extends ActionMailer with next methods:
     substitute(patters_string, array_of_substitunion_strings)
     uniq_args(hash_of_unique_args)
     category(category_string)
+    open_tracking(enabled = true)
     add_filter_setting(filter_name, setting_name, value)
 
-== Examples
-
-=== Rails 3 configuration
+== Rails 3 configuration
 
 In your Gemfile:
 
-    gem 'sendgrid-rails', '>=1.0.0', :git => 'git://github.com/PavelTyk/sendgrid-rails.git'
+    gem 'sendgrid-rails', '>=1.0.0'
 
 In your config/environment.rb:
 
@@ -28,7 +27,9 @@ In your config/environment.rb:
       :password => 'your password'
     }
 
-==== Adding multiple recipients:
+== Usage examples
+
+=== Adding multiple recipients:
 
     class Mailer < ActionMailer::Base
       default :from => 'no-reply@example.com',
@@ -36,7 +37,7 @@ In your config/environment.rb:
 
       def email_with_multiple_recipients
         add_recipients %w(email1@email.com email2@email.com)
-        mail :body => 'Hello.'
+        mail
       end
     end
 
@@ -48,14 +49,29 @@ Mailer class definition:
       default :from => 'no-reply@example.com',
               :subject => 'An email sent via SendGrid with substitutions'
 
-      def mail_with_substitutions
-        emails = %w(email1@email.com email2@email.com)
-        names = %w(User1 User2)
+      def email_with_substitutions
+        add_recipients %w(email1@email.com email2@email.com)
+        substitute '-user_name-', %w(User1 User2)
+
+        mail :body => "Hello, -user_name-!"
+      end
+    end
+
+== Apps (formerly called Filters)
 
-        add_recipients emails
-        substitute '-user_name-', names
+Apps can be applied to any of your email messages and can be configured through SendGrid gem.
+
+=== Open Tracking
+
+Add an invisible image at the end of the email to track e-mail opens. If the email recipient has images enabled on the email client, a request to server for the invisible image is executed and an open is logged.
+
+    class Mailer < ActionMailer::Base
+      default :from => 'no-reply@example.com',
+              :subject => 'An email sent via SendGrid'
 
-        mail :body => "Hello, -user_name-."
+      def email_with_open_tracking_enabled
+        open_tracking true
+        mail :to => 'email@email.com'
       end
     end
 

data/lib/send_grid.rb

@@ -22,9 +22,13 @@ module SendGrid
 
     def mail_with_send_grid(headers={}, &block)
       headers[:to] ||= send_grid_stub_for_recipient_email
-      headers['X-SMTPAPI'] = send_grid_header.to_json
+      headers['X-SMTPAPI'] = send_grid_header.to_json if send_grid_header.data.present?
       mail_without_send_grid(headers, &block)
     end
+
+    def open_tracking(enabled = true)
+      add_filter_setting(:opentrack, :enabled, enabled ? 1 : 0) unless enabled.nil?
+    end
   end
 end
 

data/lib/send_grid/api_header.rb

@@ -1,4 +1,6 @@
 class SendGrid::ApiHeader
+  attr_reader :data
+
   def initialize
     @data = {}
   end

data/lib/send_grid/version.rb

@@ -1,4 +1,4 @@
 module SendGrid
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end
 

data/spec/fixtures/mailers/mailer.rb

@@ -4,7 +4,12 @@ class Mailer < ActionMailer::Base
 
   def email_with_multiple_recipients(recipients)
     add_recipients recipients
-    mail
+    mail :body => "Hello!"
+  end
+
+  def email_open_tracking(opentrack_enabled = true)
+    open_tracking opentrack_enabled
+    mail :to => 'email@email.com', :body => 'Hello!'
   end
 end
 

data/spec/mailer_spec.rb

@@ -16,5 +16,20 @@ describe Mailer do
       mail.to.should eq ['group-delivery@sendgrid.com']
     end
   end
+
+  describe '#open_tracking' do
+
+    it 'set correct open tracking enabled X-SMTAPI header' do
+      Mailer.email_open_tracking.to_s.should include('X-SMTPAPI: {"filters":{"opentrack":{"settings":{"enabled":1}}}}')
+    end
+
+    it 'set correct open tracking disabled X-SMTAPI header' do
+      Mailer.email_open_tracking(false).to_s.should include('X-SMTPAPI: {"filters":{"opentrack":{"settings":{"enabled":0}}}}')
+    end
+
+    it 'set correct open tracking nil X-SMTAPI header' do
+      Mailer.email_open_tracking(nil).to_s.should_not include('X-SMTPAPI: {"filters":{"opentrack')
+    end
+  end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sendgrid-rails
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - PavelTyk
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-17 00:00:00 +02:00
+date: 2011-03-22 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -88,7 +88,6 @@ files:
 - send_grid.gemspec
 - spec/api_header_spec.rb
 - spec/fixtures/mailers/mailer.rb
-- spec/fixtures/views/mailer/email_with_multiple_recipients.text.erb
 - spec/mailer_spec.rb
 - spec/spec_helper.rb
 - spec/version_spec.rb