sendgrid-rails 1.1.1 → 2.0

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
 .bundle
+.rvmrc
 Gemfile.lock
 pkg/*

data/README.rdoc

@@ -1,9 +1,8 @@
 = SendGrid gem for Rails
 
-SendGrid gem provides ActionMailer extensions to use SendGrid API features in you emails.
+SendGrid gem provides ActionMailer::Base extensions to use SendGrid API features in you emails.
 It extends ActionMailer with next methods:
 
-    add_recipients(array_of_emails)
     substitute(patters_string, array_of_substitunion_strings)
     uniq_args(hash_of_unique_args)
     category(category_string)
@@ -14,10 +13,12 @@ It extends ActionMailer with next methods:
 
 In your Gemfile:
 
-    gem 'sendgrid-rails', '>=1.0.0'
+    gem 'sendgrid-rails', '~> 2.0'
 
 In your config/environment.rb:
 
+    ActionMailer::Base.register_interceptor(SendGrid::MailInterceptor)
+    
     ActionMailer::Base.smtp_settings = {
       :address => 'smtp.sendgrid.net',
       :port => '25',
@@ -36,8 +37,7 @@ In your config/environment.rb:
               :subject => 'An email sent via SendGrid'
 
       def email_with_multiple_recipients
-        add_recipients %w(email1@email.com email2@email.com)
-        mail
+        mail :to => %w(email1@email.com email2@email.com)
       end
     end
 
@@ -50,13 +50,26 @@ Mailer class definition:
               :subject => 'An email sent via SendGrid with substitutions'
 
       def email_with_substitutions
-        add_recipients %w(email1@email.com email2@email.com)
         substitute '-user_name-', %w(User1 User2)
 
-        mail :body => "Hello, -user_name-!"
+        mail :to => %w(email1@email.com email2@email.com), :body => "Hello, -user_name-!"
       end
     end
 
+=== Adding category
+
+    Mailer class definition:
+
+        class Mailer < ActionMailer::Base
+          default :from => 'no-reply@example.com',
+                  :subject => 'An email sent via SendGrid with substitutions'
+
+          def email_with_category
+            category 'SendGridRocks'
+            mail :to => 'email1@email.com'
+          end
+        end
+
 == Apps (formerly called Filters)
 
 Apps can be applied to any of your email messages and can be configured through SendGrid gem.
@@ -75,3 +88,10 @@ Add an invisible image at the end of the email to track e-mail opens. If the ema
       end
     end
 
+== Change log
+
+*v2.0*
+
+* Using mail interceptor
+* ActionMailer::Base#add_recipients - removed
+* Standard SMTP To attribute get nullified after recipients added to X-SMTPAPI header

data/Rakefile

@@ -1,2 +1,5 @@
 require 'bundler'
+require 'rspec/core/rake_task'
 Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/send_grid/mail_interceptor.rb

@@ -0,0 +1,10 @@
+module SendGrid
+  class MailInterceptor
+    def self.delivering_email(mail)
+      sendgrid_header = mail.instance_variable_get(:@sendgrid_header)
+      sendgrid_header.add_recipients(mail.to)
+      mail.header['X-SMTPAPI'] = sendgrid_header.to_json if sendgrid_header.data.present?
+      mail.header['to'] = nil
+    end
+  end
+end

data/lib/send_grid/version.rb

@@ -1,4 +1,4 @@
 module SendGrid
-  VERSION = "1.1.1"
+  VERSION = "2.0"
 end
 

data/lib/send_grid.rb

@@ -1,12 +1,14 @@
 module SendGrid
   autoload :ApiHeader, 'send_grid/api_header'
+  autoload :MailInterceptor, 'send_grid/mail_interceptor'
   autoload :VERSION, 'send_grid/version'
 
   def self.included(base)
     base.class_eval do
       include InstanceMethods
-      delegate :add_recipients, :substitute, :uniq_args, :category, :add_filter_setting, :to => :send_grid_header
-      alias_method_chain :mail, :send_grid
+      delegate :substitute, :uniq_args, :category, :add_filter_setting, :to => :sendgrid_header
+      alias_method_chain :mail, :sendgrid
+      alias_method :sendgrid_header, :send_grid_header
     end
   end
 
@@ -15,15 +17,10 @@ module SendGrid
       @send_grid_header ||= SendGrid::ApiHeader.new
     end
 
-    def send_grid_stub_for_recipient_email
-      smtp_domain = self.class.smtp_settings[:domain]
-      self.class.smtp_settings[:user_name] || "group-delivery@#{smtp_domain}"
-    end
-
-    def mail_with_send_grid(headers={}, &block)
-      headers[:to] ||= send_grid_stub_for_recipient_email
-      headers['X-SMTPAPI'] = send_grid_header.to_json if send_grid_header.data.present?
-      mail_without_send_grid(headers, &block)
+    def mail_with_sendgrid(headers={}, &block)
+      mail_without_sendgrid(headers, &block).tap do |message|
+        message.instance_variable_set :@sendgrid_header, sendgrid_header
+      end
     end
 
     def open_tracking(enabled = true)
@@ -31,4 +28,3 @@ module SendGrid
     end
   end
 end
-

data/lib/sendgrid-rails.rb

@@ -1,5 +1,6 @@
 require 'send_grid'
+require 'active_support'
+require 'active_support/core_ext'
 autoload :ActionMailer, 'action_mailer'
 
 ActionMailer::Base.send :include, SendGrid
-

data/spec/fixtures/mailers/mailer.rb

@@ -3,8 +3,7 @@ class Mailer < ActionMailer::Base
           :subject => 'Test email'
 
   def email_with_multiple_recipients(recipients)
-    add_recipients recipients
-    mail :body => "Hello!"
+    mail :to => recipients, :body => "Hello!"
   end
 
   def email_open_tracking(opentrack_enabled = true)

data/spec/mailer_spec.rb

@@ -2,34 +2,31 @@ require 'spec_helper'
 
 describe Mailer do
   describe 'email with multiple recipients' do
-    let(:recipients) { %w(email1@email.com email2@email.com) }
-    let(:mail) { Mailer.email_with_multiple_recipients recipients }
-
     it 'set correct recipients in X-SMTAPI header' do
-      mail.to_s.should include('X-SMTPAPI: {"to":["email1@email.com","email2@email.com"]}')
+      Mailer.email_with_multiple_recipients(%w(em1@email.com em2@email.com)).deliver.header.to_s.
+        should include('X-SMTPAPI: {"to":["em1@email.com","em2@email.com"]}')
     end
 
-    # Send Grid will ignore this attr any way, but ActionMailer will raise error
-    # if :to attr is blank
-    it 'set default :to header if it was nil' do
-      ActionMailer::Base.smtp_settings = { :domain => 'sendgrid.com' }
-      mail.to.should eq ['group-delivery@sendgrid.com']
+    it 'removes original TO header part' do
+      Mailer.email_with_multiple_recipients(%w(em1@email.com em2@email.com)).deliver.header.to_s.
+        should_not include("To: em1@email.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}}}}')
+      Mailer.email_open_tracking.deliver.header.to_s.
+        should include('"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}}}}')
+      Mailer.email_open_tracking(false).deliver.header.to_s.
+        should include('"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')
+      Mailer.email_open_tracking(nil).deliver.header.to_s.
+        should_not include('"filters":{"opentrack')
     end
   end
 end
-

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require 'sendgrid-rails'
 
+ActionMailer::Base.register_interceptor(SendGrid::MailInterceptor)
 ActionMailer::Base.delivery_method = :test
 ActionMailer::Base.prepend_view_path File.join(File.dirname(__FILE__), "fixtures", "views")
 
 Dir["#{File.dirname(__FILE__)}/fixtures/mailers/*.rb"].each { |f| require f }
-

metadata

@@ -1,81 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sendgrid-rails
-version: !ruby/object:Gem::Version 
-  hash: 17
+version: !ruby/object:Gem::Version
+  version: '2.0'
   prerelease: 
-  segments: 
-  - 1
-  - 1
-  - 1
-  version: 1.1.1
 platform: ruby
-authors: 
+authors:
 - PavelTyk
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-05 00:00:00 +03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70309266084920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 5
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: actionmailer
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70309266084920
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: &70309266079020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70309266079020
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70309266078560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 1
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.1.0
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *70309266078560
 description: Gem to extend ActionMailer with SendGrid API support
-email: 
+email:
 - paveltyk@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - Gemfile
@@ -83,6 +58,7 @@ files:
 - Rakefile
 - lib/send_grid.rb
 - lib/send_grid/api_header.rb
+- lib/send_grid/mail_interceptor.rb
 - lib/send_grid/version.rb
 - lib/sendgrid-rails.rb
 - send_grid.gemspec
@@ -91,39 +67,33 @@ files:
 - spec/mailer_spec.rb
 - spec/spec_helper.rb
 - spec/version_spec.rb
-has_rdoc: true
 homepage: https://github.com/PavelTyk/sendgrid-rails
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: sendgrid-rails
-rubygems_version: 1.5.0
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: SendGrid gem fo Rails 3
-test_files: []
-
+test_files:
+- spec/api_header_spec.rb
+- spec/fixtures/mailers/mailer.rb
+- spec/mailer_spec.rb
+- spec/spec_helper.rb
+- spec/version_spec.rb