brightbytes-sendgrid 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTI3NjE1NjIxNDJjNGEyZGUxZGUyMDJlOTMwNjQxMTEyOTk5MWFmMA==
+  data.tar.gz: !binary |-
+    YTlhNDdiYjUyYjRkZTY3ZjBiMmE3ZjNkZTJkMjViMTVmODkwNDY5Ng==
+SHA512:
+  metadata.gz: !binary |-
+    ZWNhZjJhMWYwY2U3NGFlNjIwM2FmZGVlMGQ1MjczZmYwYzVmODAwODZmZjc3
+    ZDk2M2IzMDUxYWE3Nzg2OTY3NzhlY2Y2ZDhmZjUwMGY2ZTZiYTMxOTEwMDdl
+    ZDhiMTkxYTQwZjA5OTgxZmIzN2U5NmI4NjVkMDQ2MzQ1NTM0ZjU=
+  data.tar.gz: !binary |-
+    M2VmOGI0MGFlZTI0Yzg0MzRiYTRhNWEzOTZiOTFiMGZjOWI4MjQ4M2MwNjY5
+    MGJhNmJmNDJkNDNkMGQyNGZiYjNhODZiOGM5YzBmZjQyNTE5NDZhMmZhMmIx
+    ZTAyZTdjNDM0MjE2MDE4ODM0NWYwNGVkOWZjMzBkYjc1MTcwZDU=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+brightbytes-sendgrid

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p484

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in brightbytes-sendgrid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Serhiy Rozum
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 BrightBytes Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# Brightbytes::Sendgrid
+
+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 to automatically include Unsubscribe link into your emails. Unfortunately, SendGrid doesn't manage multiple unsubscriptions lists based on your's emails categories.
+
+Visit [SendGrid SMTP API](http://sendgrid.com/docs/API_Reference/SMTP_API/index.html) to learn more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'brightbytes-sendgrid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brightbytes-sendgrid
+    
+In your config/initializers/sendgrid.rb:
+
+    ActionMailer::Base.send :include, Brightbytes::Sendgrid
+    
+    Brightbytes::Sendgrid.configure do |config|
+      config.default_categories :system
+      config.unsubscribe_categories :system, :onboarding
+      config.unsubscribe_url 'http://brightbytes.net/unsubscribe'
+    end
+
+Or use it with selected mailers:
+
+    Brightbytes::Sendgrid
+
+## Usage
+
+You can use following methods to set both global and per-email SendGrid SMTP API header options:
+
+**sendgrid_substitute**
+
+    sendgrid_substitute :full_name, ['Jack', 'John']
+    sendgrid_substitute '{{some_text}}', 'another text'
+    
+**sendgrid_section**
+
+    sendgrid_section :greeting, I18n.translate('Hello')
+    
+**sendgrid_unique_args**
+
+    sendgrid_unique_args email_id: 12345
+
+**sendgrid_categories**
+
+    sendgrid_categories :newsletter
+    
+**sendgrid_recipients**
+
+    sendgrid_recipients 'email1@email.com', 'email2@email.com'
+
+**sendgrid_enable**
+
+    sendgrid_enable :opentrack
+    
+**sendgrid_disable**
+  
+    sendgrid_disable :clicktrack
+    
+## Auto generated unsubscribe link
+
+It is not a SendGrid **subscriptiontrack** filter!
+
+What we diong here is just collecting recipients and generating unsubscribe links for every recipient.
+Those links will be sent as a substitutions to SendGrid.
+
+So, to make this feature work, you have to:
+
+1. Configure unsubscribe categories. It will trigger link generator
+2. Configure an unsubscribe_url. The resulting URL will be composed of unsubscribe_url and email and category parameters.
+3. Put {{unsubscribe}} placeholder somewhere in your email body
+
+##Contributors
+
+This gem is written using code samples from:
+
+* [http://github.com/stephenb/sendgrid](http://github.com/stephenb/sendgrid)
+* [https://github.com/kylejginavan/sendgrid_smtpapi](https://github.com/kylejginavan/sendgrid_smtpapi)
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/brightbytes-sendgrid.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brightbytes/sendgrid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "brightbytes-sendgrid"
+  spec.version       = Brightbytes::Sendgrid::VERSION
+  spec.authors       = ["Serhiy Rozum"]
+  spec.email         = ["serhiy@brightbytes.net"]
+  spec.summary       = %q{BrightBytes and Sendgrid integration gem}
+  spec.description   = %q{Gem to extend ActionMailer with SMTP API support}
+  spec.homepage      = "https://github.com/brightbytes/brightbytes-sendgrid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "actionmailer", "~> 3.2"
+  
+  spec.add_dependency "activesupport", "~> 3.2"
+end

data/lib/brightbytes/sendgrid.rb

@@ -0,0 +1,61 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'brightbytes/sendgrid/smtp_api_header'
+require 'brightbytes/sendgrid/config'
+require 'brightbytes/sendgrid/unsubscribe'
+require 'brightbytes/sendgrid/version'
+
+module Brightbytes
+  module Sendgrid
+    extend ActiveSupport::Concern
+
+    autoload :SmtpApiHeader, 'sendgrid/smtp_api_header'
+    autoload :Config, 'sendgrid/config'
+    autoload :Unsubscribe, 'sendgrid/unsubscribe'
+    autoload :VERSION, 'sendgrid/version'
+
+    included do
+      delegate *Brightbytes::Sendgrid::SmtpApiHeader::DELEGATE_METHODS, to: :sendgrid, prefix: true
+      alias_method_chain :mail, :sendgrid
+    end
+    
+    protected
+    
+    def sendgrid
+      @sendgrid ||= Brightbytes::Sendgrid::SmtpApiHeader.new(self.class.sendgrid.data)
+    end
+    
+    def mail_with_sendgrid(headers={}, &block)
+      mail_without_sendgrid(headers, &block).tap do |message|
+        # Add Unsubscribe links
+        Brightbytes::Sendgrid::Unsubscribe.add_links(sendgrid, message)
+        # Store Sendgrid in Message for future use
+        message.instance_variable_set :@sendgrid, sendgrid
+        # Add X-SMTPAPI Header
+        message.header['X-SMTPAPI'] = sendgrid.to_json if sendgrid.data.present?
+      end
+    end
+    
+    module ClassMethods
+
+      delegate *Brightbytes::Sendgrid::SmtpApiHeader::DELEGATE_METHODS, to: :sendgrid, prefix: true
+
+      def sendgrid
+        @sendgrid ||= Brightbytes::Sendgrid::SmtpApiHeader.new(Brightbytes::Sendgrid.config.sendgrid.data)
+      end
+      
+    end
+    
+    class << self
+
+      def config
+        Brightbytes::Sendgrid::Config.instance
+      end
+
+      def configure
+        yield(self.config) if block_given?
+      end
+    end
+    
+  end
+end

data/lib/brightbytes/sendgrid/config.rb

@@ -0,0 +1,34 @@
+require 'singleton'
+
+module Brightbytes
+  module Sendgrid
+    class Config
+      include Singleton
+
+      # Sendgrid default settings storage
+      
+      delegate *Brightbytes::Sendgrid::SmtpApiHeader::DELEGATE_METHODS, to: :sendgrid, prefix: :default
+
+      def sendgrid
+        @sendgrid ||= Brightbytes::Sendgrid::SmtpApiHeader.new
+      end
+
+      # Unsubscribe default settings storage
+
+      class UnsubscribeConfig < Struct.new(:categories, :url); end
+      
+      def unsubscribe
+        @unsubscribe ||= UnsubscribeConfig.new([],nil)
+      end
+
+      def unsubscribe_categories(*categories)
+        unsubscribe.categories = categories.flatten.map(&:to_sym)
+      end
+
+      def unsubscribe_url(url)
+        unsubscribe.url = url
+      end
+
+    end
+  end
+end

data/lib/brightbytes/sendgrid/smtp_api_header.rb

@@ -0,0 +1,130 @@
+require 'json'
+
+module Brightbytes
+  module Sendgrid
+    class SmtpApiHeader
+      
+      DELEGATE_METHODS = [
+        :substitute,
+        :add_substitute,
+        :section, 
+        :unique_args,
+        :categories, 
+        :add_categories,
+        :recipients,
+        :add_recipients,
+        :filter_setting, 
+        :enable, 
+        :disable, 
+        :ganalytics_options
+      ]
+      
+      VALID_FILTERS = [
+        :bcc,
+        :dkim,
+        :domainkeys,
+        :forwardspam,
+        :opentrack,
+        :clicktrack,
+        :ganalytics,
+        :gravatar,
+        :subscriptiontrack,
+        :template,
+        :footer,
+        :spamcheck,
+        :bypass_list_management
+      ]
+      
+      VALID_GANALYTICS_OPTIONS = [
+        :utm_source,
+        :utm_medium,
+        :utm_campaign,
+        :utm_term,
+        :utm_content
+      ]
+      
+      SUBST_PATTERN = '{{\1}}'
+      
+      attr_reader :data
+            
+      def initialize(default_data = nil)
+        @data = default_data.instance_of?(Hash) ? default_data.dup : Hash.new { |h,k| h[k] = Hash.new(&h.default_proc) }
+      end
+                  
+      def substitute(key, values)
+        @data[:sub][key_to_tag(key)] = Array.wrap(values)
+      end
+
+      def add_substitute(key, values)
+        @data[:sub][key_to_tag(key)] = [] unless @data[:sub][key_to_tag(key)].instance_of?(Array)
+        @data[:sub][key_to_tag(key)] += Array.wrap(values)
+      end
+
+      def section(key, value)
+        @data[:section][key_to_tag(key)] = value.to_s
+      end
+
+      def unique_args(value)
+        @data[:unique_args] = value if value.instance_of?(Hash)
+      end
+
+      # getter/setter
+      def categories(*categories)
+        @data[:category] = categories.flatten.map(&:to_sym) if categories.flatten.present?
+        @data.fetch(:category, [])
+      end
+
+      def add_categories(*categories)
+        init_array_key :category
+        @data[:category] |= categories.flatten.map(&:to_sym)
+      end
+
+      # getter/setter
+      def recipients(*recipients)
+        @data[:to] = recipients.flatten if recipients.flatten.present?
+        @data.fetch(:to, [])
+      end
+
+      def add_recipients(*recipients)
+        init_array_key :to
+        @data[:to] += recipients.flatten
+      end
+
+      def filter_setting(filter, setting, value)
+        return unless VALID_FILTERS.include? filter
+        @data[:filters][filter][:settings][setting] = value
+      end
+
+      def enable(*filters)
+        filters.flatten.each { |filter| filter_setting filter, :enabled, 1 }
+      end
+
+      def disable(*filters)
+        filters.flatten.each { |filter| filter_setting filter, :enabled, 0 }
+      end
+            
+      def ganalytics_options(options = {})
+        options.reject! { |k,v| !VALID_GANALYTICS_OPTIONS.include?(k) }
+        if options.present?
+          options.each { |setting, value| filter_setting :ganalytics, setting, value }
+          enable :ganalytics
+        end
+      end
+      
+      def to_json
+        JSON.generate(@data, {indent: '', space: ' ', space_before: '', object_nl: '', array_nl: ''})
+      end
+      
+      private
+                
+      def key_to_tag(key)
+        key.is_a?(Symbol) ? key.to_s.sub(/(.*)/, SUBST_PATTERN) : key.to_s
+      end
+      
+      def init_array_key(key)
+        @data[key] = [] unless @data[key].instance_of?(Array)
+      end
+        
+    end
+  end
+end

data/lib/brightbytes/sendgrid/unsubscribe.rb

@@ -0,0 +1,78 @@
+# Unsubscribe feature have some conventions:
+# - {{unsubscribe}} substitution variable must be placed somewhere in email template or body
+# 
+module Brightbytes
+  module Sendgrid
+    class Unsubscribe
+      
+      class << self
+      
+        def add_links(sendgrid, message)
+          new(sendgrid, message).add_links
+        end
+        
+      end
+      
+      attr_reader :sendgrid
+      attr_reader :message
+            
+      def initialize(sendgrid, message)
+        @sendgrid, @message = sendgrid, message
+      end
+      
+      def add_links
+        return unless feature_active?
+        if categories.present?
+          sendgrid.section :unsubscribe, "<a href=\"{{unsubscribe_link}}\">Unsubscribe</a>"
+          emails.each do |email|
+            sendgrid.add_substitute :unsubscribe_link, unsubscribe_link(email)
+          end
+        else
+          sendgrid.section :unsubscribe, ''
+          sendgrid.add_substitute :unsubscribe_link, Array.new(emails.size, '')
+        end
+      end
+            
+      private
+      
+      def config
+        Brightbytes::Sendgrid.config.unsubscribe
+      end
+      
+      delegate :categories, :url, to: :config, prefix: :unsubscribe
+      
+      def feature_active?
+        unsubscribe_categories.present? || unsubscribe_url.present?
+      end
+            
+      def categories
+        @categories ||= unsubscribe_categories & sendgrid.categories
+      end
+
+      def emails
+        @emails ||= recipients.map{ |e| e =~ /([^<]+)\s<(.*)>|(.*)/; $2 || $3 }
+      end
+      
+      def recipients
+        sendgrid.recipients + message_recipients
+      end
+      
+      def message_recipients
+        Array.wrap(message.to) + Array.wrap(message.cc) + Array.wrap(message.bcc)
+      end
+      
+      def unsubscribe_link(email)
+        if unsubscribe_url.instance_of? Proc
+          unsubscribe_url.call(email: email, category: categories)
+        else
+          "#{unsubscribe_url}#{unsubscribe_url[-1] == '?' ? '' : '?'}#{url_parameters(email)}"
+        end
+      end
+      
+      def url_parameters(email)
+        URI.encode_www_form(email: email, category: categories)
+      end
+            
+    end
+  end
+end

data/lib/brightbytes/sendgrid/version.rb

@@ -0,0 +1,5 @@
+module Brightbytes
+  module Sendgrid
+    VERSION = "0.0.1"
+  end
+end

data/spec/brightbytes/sendgrid/smtp_api_header_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Brightbytes::Sendgrid::SmtpApiHeader do
+
+  let(:header) { described_class.new }
+  
+  subject { header.to_json }
+
+  it { should eql '{}' }
+  
+  it "contains substitution" do
+    header.substitute :key, 'Hello'
+    should eql '{"sub": {"{{key}}": ["Hello"]}}'
+  end
+
+  it "adds substitution" do
+    header.substitute :key, 'Hello'
+    header.add_substitute :key, ['Again', 'And Again']
+    should eql '{"sub": {"{{key}}": ["Hello","Again","And Again"]}}'
+  end
+
+  it "contains section" do
+    header.section :key, 'Hello'
+    should eql '{"section": {"{{key}}": "Hello"}}'
+  end
+
+  it "contains category" do
+    header.categories :category_name
+    should eql '{"category": ["category_name"]}'
+  end
+
+  it "adds category" do
+    header.categories :category_name
+    header.add_categories :new_category, :category_name
+    should eql '{"category": ["category_name","new_category"]}'
+  end
+
+  it "contains 1 recipient (as array)" do
+    header.recipients 'email1@email.com'
+    should eql '{"to": ["email1@email.com"]}'
+  end
+
+  it "adds recipients" do
+    header.recipients 'email1@email.com'
+    header.add_recipients 'email2@email.com'
+    should eql '{"to": ["email1@email.com","email2@email.com"]}'
+  end
+
+  it "contains unique args" do
+    header.unique_args arg1: 'val1'
+    should eql '{"unique_args": {"arg1": "val1"}}'
+  end
+
+  it "contains valid filter settings" do
+    header.filter_setting :opentrack, :setting, 'value'
+    should eql '{"filters": {"opentrack": {"settings": {"setting": "value"}}}}'
+  end
+
+  it "skips invalid filter settings" do
+    header.filter_setting :somefilter, :setting, 'value'
+    should eql '{}'
+  end
+    
+  it "enables filters" do
+    header.enable :opentrack, :bcc
+    should eql '{"filters": {"opentrack": {"settings": {"enabled": 1}},"bcc": {"settings": {"enabled": 1}}}}'
+  end
+
+  it "disables filters" do
+    header.disable :opentrack, :bcc
+    should eql '{"filters": {"opentrack": {"settings": {"enabled": 0}},"bcc": {"settings": {"enabled": 0}}}}'
+  end
+  
+end

data/spec/brightbytes/sendgrid/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Brightbytes::Sendgrid::VERSION do
+  it "should be a version number" do
+    should_not be_nil
+  end
+end

data/spec/brightbytes/sendgrid_mailer_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe SendgridMailer do
+
+  let(:header) { subject.header.to_s.gsub(/\r|\n/, "") }
+  
+  describe "when sendgrid default category is set" do
+    subject(:message) { described_class.default_category }
+
+    it 'header should have category' do
+      header.should include('"category": ["system"]')
+    end
+  end
+
+  describe "when sendgrid category is set" do
+    subject(:message) { described_class.new_category }
+
+    it 'header should have new category' do
+      header.should include('"category": ["new_category"]')
+    end
+  end
+
+  describe "when sendgrid recipients are set" do
+    subject(:message) { described_class.with_recipients }
+
+    it 'header should have recipients' do
+      header.should include('"to": ["email1@email.com","email2@email.com"]')
+    end
+  end
+
+  describe "when unsubscribe not required" do
+    subject(:message) { described_class.unsubscribe_not_required }
+    
+    before(:each) { sendgrid_config_setup }
+  
+    it 'unsubscribe section should be empty' do
+      header.should include('"{{unsubscribe}}": ""')
+    end
+  end
+  
+  describe "when unsubscribe required" do
+    subject(:message) { described_class.unsubscribe_required }
+    
+    before(:each) { sendgrid_config_setup }
+  
+    it 'unsubscribe section should be set' do
+      header.should include('"{{unsubscribe}}": "<a href=\"{{unsubscribe_link}}\">Unsubscribe</a>"')
+    end
+  
+    it 'unsubscribe link should be set' do
+      header.should include('"{{unsubscribe_link}}": ["http://example.com/u?email=email1%40email.com&category=unsubscribe","http://example.com/u?email=email2%40email.com&category=unsubscribe","http://example.com/u?email=email%40email.com&category=unsubscribe"]')
+    end
+  end
+    
+end

data/spec/brightbytes/sendgrid_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Brightbytes::Sendgrid do
+
+  describe "config" do
+    
+    subject { described_class.config }
+
+    it "should be an instance of Config " do
+      should be_instance_of Brightbytes::Sendgrid::Config
+    end
+    
+  end
+
+end

data/spec/brightbytes/standard_mailer_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe StandardMailer do
+
+  let(:header) { subject.header.to_s.gsub(/\r|\n/, "") }
+  
+  describe "when sendgrid not engaged" do
+    subject(:message) { described_class.sendgrid_not_engaged }
+
+    it 'header should not be set' do
+      header.should_not include('X-SMTPAPI:')
+    end
+  end
+
+  describe "when unsubscribe not required" do
+    subject(:message) { described_class.unsubscribe_not_required }
+    
+    before(:each) { sendgrid_config_setup }
+
+    it 'unsubscribe section should be empty' do
+      header.should include('"{{unsubscribe}}": ""')
+    end
+  end
+
+  describe "when unsubscribe required" do
+    subject(:message) { described_class.unsubscribe_required }
+    
+    before(:each) { sendgrid_config_setup }
+
+    it 'unsubscribe section should be set' do
+      header.should include('"{{unsubscribe}}": "<a href=\"{{unsubscribe_link}}\">Unsubscribe</a>"')
+    end
+
+    it 'unsubscribe link should be set' do
+      header.should include('"{{unsubscribe_link}}": ["http://example.com/u?email=email%40email.com&category=unsubscribe"]')
+    end
+  end
+    
+end

data/spec/mailers/sendgrid_mailer.rb

@@ -0,0 +1,33 @@
+class SendgridMailer < ActionMailer::Base
+  default from: 'noreply@brightbytes.net',
+          subject: 'Clarity'
+
+  sendgrid_categories :system
+
+  def default_category
+    mail to: 'email@email.com', body: 'Hello!'
+  end
+
+  def new_category
+    sendgrid_categories :new_category
+    mail to: 'email@email.com', body: 'Hello!'
+  end
+
+  def with_recipients
+    sendgrid_recipients 'email1@email.com', 'email2@email.com'
+    mail to: 'email@email.com', body: 'Hello!'
+  end
+
+  def unsubscribe_not_required
+    sendgrid_recipients 'email1@email.com', 'email2@email.com'
+    mail to: 'email@email.com', body: 'Hello!'
+  end
+
+  def unsubscribe_required
+    sendgrid_recipients 'email1@email.com', 'email2@email.com'
+    sendgrid_categories :unsubscribe
+    mail to: 'email@email.com', body: 'Hello!'
+  end
+
+
+end

data/spec/mailers/standard_mailer.rb

@@ -0,0 +1,18 @@
+class StandardMailer < ActionMailer::Base
+  default from: 'noreply@brightbytes.net',
+          subject: 'Clarity'
+          
+  def sendgrid_not_engaged
+    mail to: 'email@email.com', body: 'Hello!'
+  end
+
+  def unsubscribe_not_required
+    mail to: 'email@email.com', body: 'Hello!'
+  end
+
+  def unsubscribe_required
+    sendgrid_categories :unsubscribe
+    mail to: 'email@email.com', body: 'Hello!'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'action_mailer'
+require 'brightbytes/sendgrid'
+
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true
+ActionMailer::Base.deliveries = []
+
+ActionMailer::Base.send :include, Brightbytes::Sendgrid
+
+Dir["#{File.dirname(__FILE__)}/mailers/*.rb"].each { |f| require f }
+
+def sendgrid_config_setup
+  Brightbytes::Sendgrid.configure do |config|
+    config.unsubscribe_categories :unsubscribe
+    config.unsubscribe_url 'http://example.com/u'
+  end
+end
+
+def sendgrid_config_reset
+  Brightbytes::Sendgrid.configure do |config|
+    config.unsubscribe_categories []
+    config.unsubscribe_url nil
+  end
+end
+
+RSpec.configure do |config|
+
+  config.after(:each) do
+    Brightbytes::Sendgrid.configure do |config|
+      config.unsubscribe_categories []
+      config.unsubscribe_url nil
+    end
+  end
+
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: brightbytes-sendgrid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Serhiy Rozum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Gem to extend ActionMailer with SMTP API support
+email:
+- serhiy@brightbytes.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- MIT-LICENSE
+- README.md
+- Rakefile
+- brightbytes-sendgrid.gemspec
+- lib/brightbytes/sendgrid.rb
+- lib/brightbytes/sendgrid/config.rb
+- lib/brightbytes/sendgrid/smtp_api_header.rb
+- lib/brightbytes/sendgrid/unsubscribe.rb
+- lib/brightbytes/sendgrid/version.rb
+- spec/brightbytes/sendgrid/smtp_api_header_spec.rb
+- spec/brightbytes/sendgrid/version_spec.rb
+- spec/brightbytes/sendgrid_mailer_spec.rb
+- spec/brightbytes/sendgrid_spec.rb
+- spec/brightbytes/standard_mailer_spec.rb
+- spec/mailers/sendgrid_mailer.rb
+- spec/mailers/standard_mailer.rb
+- spec/spec_helper.rb
+homepage: https://github.com/brightbytes/brightbytes-sendgrid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: BrightBytes and Sendgrid integration gem
+test_files:
+- spec/brightbytes/sendgrid/smtp_api_header_spec.rb
+- spec/brightbytes/sendgrid/version_spec.rb
+- spec/brightbytes/sendgrid_mailer_spec.rb
+- spec/brightbytes/sendgrid_spec.rb
+- spec/brightbytes/standard_mailer_spec.rb
+- spec/mailers/sendgrid_mailer.rb
+- spec/mailers/standard_mailer.rb
+- spec/spec_helper.rb