sendgrid_smtpapi 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.3
+  - ree
+
+script: rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in send_grid.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,111 @@
+= SendGrid SMTP API gem for Rails {<img src="https://secure.travis-ci.org/kylejginavan/sendgrid_smtpapi.png"/>}[http://travis-ci.org/kylejginavan/sendgrid_smtpapi]
+
+SendGrid SMTP API gem provides ActionMailer::Base extensions to use SendGrid API features in you emails.
+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)
+    standard_smtp(enabled = false)
+
+== Rails 3 configuration
+
+In your Gemfile:
+
+    gem 'sendgrid_smtpapi'
+
+In your config/environment.rb:
+
+    ActionMailer::Base.register_interceptor(SendGridSmtpApi::MailInterceptor)
+
+    ActionMailer::Base.smtp_settings = {
+      :address => 'smtp.sendgrid.net',
+      :port => '25',
+      :domain => 'example.com',
+      :authentication => :plain,
+      :user_name => 'login@example.com',
+      :password => 'your password'
+    }
+
+== Usage examples
+
+=== Adding multiple recipients:
+
+    class Mailer < ActionMailer::Base
+      default :from => 'no-reply@example.com',
+              :subject => 'An email sent via SendGridSmtpApi'
+
+      def email_with_multiple_recipients
+        mail :to => %w(email1@email.com email2@email.com)
+      end
+    end
+
+=== Adding substitution vars
+
+Mailer class definition:
+
+    class Mailer < ActionMailer::Base
+      default :from => 'no-reply@example.com',
+              :subject => 'An email sent via SendGridSmtpApi with substitutions'
+
+      def email_with_substitutions
+        substitute '-user_name-', %w(User1 User2)
+
+        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 SendGridSmtpApi with substitutions'
+
+          def email_with_category
+            category 'SendGridSmtpApiRocks'
+            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 SendGridSmtpApi 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 SendGridSmtpApi'
+
+      def email_with_open_tracking_enabled
+        open_tracking true
+        mail :to => 'email@email.com'
+      end
+    end
+
+
+=== Use Standard SMTP
+
+if you want to customize the header for sendgrids api but you need keep standard SMTP see below:
+
+    class Mailer < ActionMailer::Base
+      default :from => 'no-reply@example.com',
+              :subject => 'An email sent via SendGridSmtpApi'
+
+      def email_standard_smtp
+        standard_smtp true
+        open_tracking true
+        mail :to => 'email@email.com'
+      end
+    end
+
+== CONTRIBUTORS:
+
+* Kyle J. Ginavan.
+* Mauro Torres - http://github.com/chebyte

data/Rakefile

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

@@ -0,0 +1,30 @@
+module SendGridSmtpApi
+  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 :substitute, :uniq_args, :category, :add_filter_setting, :standard_smtp, :to => :sendgrid_header
+      alias_method_chain :mail, :sendgrid
+      alias_method :sendgrid_header, :send_grid_header
+    end
+  end
+
+  module InstanceMethods
+    def send_grid_header
+      @send_grid_header ||= SendGridSmtpApi::ApiHeader.new
+    end
+
+    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)
+      add_filter_setting(:opentrack, :enabled, enabled ? 1 : 0) unless enabled.nil?
+    end
+  end
+end

data/lib/send_grid/api_header.rb

@@ -0,0 +1,37 @@
+class SendGridSmtpApi::ApiHeader
+  attr_reader :data
+
+  def initialize
+    @data = Hash.new { |h,k| h[k] = Hash.new(&h.default_proc) }
+  end
+
+  def add_recipients(recipients)
+    @data[:to] = [] unless @data[:to].instance_of?(Array)
+    @data[:to] |= Array.wrap(recipients)
+  end
+
+  def substitute(var, val)
+    @data[:sub][var] = Array.wrap(val)
+  end
+
+  def uniq_args(val)
+    @data[:unique_args] = val if val.instance_of?(Hash)
+  end
+
+  def category(cat)
+    @data[:category] = cat
+  end
+
+  def add_filter_setting(fltr, setting, val)
+    @data[:filters][fltr][:settings][setting] = val
+  end
+
+  def to_json
+    @data.to_json
+  end
+
+  def standard_smtp(enabled = false)
+    @standard_smtp = enabled
+  end
+
+end

data/lib/send_grid/mail_interceptor.rb

@@ -0,0 +1,14 @@
+module SendGridSmtpApi
+  class MailInterceptor
+    def self.delivering_email(mail)
+      sendgrid_header = mail.instance_variable_get(:@sendgrid_header)
+      standard_smtp   = sendgrid_header.instance_variable_get(:@standard_smtp)
+
+      unless standard_smtp
+        sendgrid_header.add_recipients(mail.to)
+        mail.header['to'] = 'dummy@email.com'
+      end
+      mail.header['X-SMTPAPI'] = sendgrid_header.to_json if sendgrid_header.data.present?
+    end
+  end
+end

data/lib/send_grid/version.rb

@@ -0,0 +1,3 @@
+module SendGridSmtpApi
+  VERSION = "0.0.1"
+end

data/lib/sendgrid_smtpapi.rb

@@ -0,0 +1,8 @@
+require 'send_grid'
+require 'active_support'
+require 'active_support/core_ext'
+require 'action_mailer'
+
+autoload :ActionMailer, 'action_mailer'
+
+ActionMailer::Base.send :include, SendGridSmtpApi

data/sendgrid_smtpapi.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "send_grid/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sendgrid_smtpapi"
+  s.version     = SendGridSmtpApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["kylejginavan", "chebyte"]
+  s.email       = ["kylejginavan@gmail.com", "maurotorres@gmail.com"]
+  s.homepage    = "https://github.com/kylejginavan/sendgrid_smtpapi"
+  s.summary     = %q{SendGrid SMTP API gem fo Rails 3}
+  s.description = %q{Gem to extend ActionMailer with SendGrid SMTP API support}
+
+  s.rubyforge_project = "sendgrid_smtpapi"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_development_dependency "rspec", "~> 2.5.0"
+  s.add_dependency "actionmailer", ">= 3.0.0"
+  s.add_dependency "activesupport", ">= 2.1.0"
+end

data/spec/api_header_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe SendGridSmtpApi::ApiHeader do
+  let(:header) { SendGridSmtpApi::ApiHeader.new }
+  describe "#to_json" do
+    it "returns valid json if no data was set" do
+      header.to_json.should eql "{}"
+    end
+
+    it "contains 1 recipient (as array)" do
+      header.add_recipients 'email@email.com'
+      header.to_json.should eql '{"to":["email@email.com"]}'
+    end
+
+    it "contaions an array of recipients" do
+      header.add_recipients %w(email1@email.com email2@email.com)
+      header.to_json.should eql '{"to":["email1@email.com","email2@email.com"]}'
+    end
+
+    it "contains substitution" do
+      header.substitute :var1, 'Hello'
+      header.to_json.should eql '{"sub":{"var1":["Hello"]}}'
+    end
+
+    it "contains uniq args" do
+      header.uniq_args :arg1 => 'val1'
+      header.to_json.should eql '{"unique_args":{"arg1":"val1"}}'
+    end
+
+    it "contains category" do
+      header.category 'category_name'
+      header.to_json.should eql '{"category":"category_name"}'
+    end
+
+    it "contains filter settings" do
+      header.add_filter_setting :filter1, :setting1, 'val1'
+      header.to_json.should eql '{"filters":{"filter1":{"settings":{"setting1":"val1"}}}}'
+    end
+  end
+end

data/spec/fixtures/mailers/mailer.rb

@@ -0,0 +1,19 @@
+class Mailer < ActionMailer::Base
+  default :from => 'no-reply@sendgrid.com',
+          :subject => 'Test email'
+
+  def email_with_multiple_recipients(recipients)
+    mail :to => recipients, :body => "Hello!"
+  end
+
+  def email_open_tracking(opentrack_enabled = true)
+    open_tracking opentrack_enabled
+    mail :to => 'email@email.com', :body => 'Hello!'
+  end
+
+  def email_standard_smtp(enabled = false)
+    standard_smtp enabled
+    mail :to => 'email@email.com', :body => 'Hello!'
+  end
+
+end

data/spec/mailer_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Mailer do
+  describe 'email with multiple recipients' do
+    it 'set correct recipients in X-SMTAPI header' do
+      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
+
+    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.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).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).deliver.header.to_s.
+        should_not include('"filters":{"opentrack')
+    end
+  end
+
+  describe '#standard_smtp' do
+    it 'enable standard smpt to' do
+      Mailer.email_standard_smtp(true).deliver.header.to_s.
+        should include('To: email@email.com')
+    end
+
+    it 'disable standard smtp to' do
+      Mailer.email_standard_smtp(false).deliver.header.to_s.
+        should include('To: dummy@email.com')
+    end
+
+    it 'disable by default standard smtp to' do
+      Mailer.email_standard_smtp.deliver.header.to_s.
+        should include('To: dummy@email.com')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'sendgrid_smtpapi'
+
+ActionMailer::Base.register_interceptor(SendGridSmtpApi::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 }

data/spec/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'SendGridSmtpApi::VERSION' do
+  it "returns string" do
+    SendGridSmtpApi::VERSION.should be_an_instance_of(String)
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: sendgrid_smtpapi
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+  - kylejginavan
+  - chebyte
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-17 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: rspec
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !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 
+      none: false
+      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 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 2.1.0
+    type: :runtime
+    version_requirements: *id003
+description: Gem to extend ActionMailer with SendGrid SMTP API support
+email: 
+  - kylejginavan@gmail.com
+  - maurotorres@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+  - .gitignore
+  - .rspec
+  - .travis.yml
+  - Gemfile
+  - README.rdoc
+  - Rakefile
+  - lib/send_grid.rb
+  - lib/send_grid/.DS_Store
+  - lib/send_grid/api_header.rb
+  - lib/send_grid/mail_interceptor.rb
+  - lib/send_grid/version.rb
+  - lib/sendgrid_smtpapi.rb
+  - sendgrid_smtpapi.gemspec
+  - spec/api_header_spec.rb
+  - spec/fixtures/mailers/mailer.rb
+  - spec/mailer_spec.rb
+  - spec/spec_helper.rb
+  - spec/version_spec.rb
+homepage: https://github.com/kylejginavan/sendgrid_smtpapi
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+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: sendgrid_smtpapi
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: SendGrid SMTP API gem fo Rails 3
+test_files: 
+  - spec/api_header_spec.rb
+  - spec/fixtures/mailers/mailer.rb
+  - spec/mailer_spec.rb
+  - spec/spec_helper.rb
+  - spec/version_spec.rb