mail_safe-sendgrid 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage/*
+.yardoc/*
+doc/*

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec
+
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run specs"
+RSpec::Core::RakeTask.new { |t| t.rspec_opts = "--color" }
+
+task :default => :spec

data/lib/core_ext/kernel.rb

@@ -0,0 +1,8 @@
+module Kernel
+  def silence_warnings
+    verbosity = $VERBOSE
+    result = yield
+    $VERBOSE = verbosity
+    result
+  end
+end

data/lib/mail_safe-sendgrid.rb

@@ -0,0 +1,81 @@
+module MailSafe
+  class AddressReplacer
+    require 'json'
+    class << self
+
+      @@replaced_addresses = {}
+      @@address_types = ADDRESS_TYPES.dup
+
+      def add_body_postscript_with_mail_header(part, replaced_addresses, call_super = false)
+        # we don't want to call add_body_postscript until after we've added the SendGrid SMTPAPI
+        # replaced addresses to the list of all addresses replaced by Mail Safe
+        @@replaced_addresses.reverse_merge! replaced_addresses
+        if call_super or replaced_addresses[:X_SMTPAPI]
+          add_xsmtpapi_to_address_types
+          add_body_postscript_without_mail_header(part, @@replaced_addresses)
+          remove_xsmtpapi_from_address_types
+        end
+      end
+      alias_method_chain :add_body_postscript, :mail_header
+
+
+      def replace_external_addresses_with_mail_header(mail)
+        replace_external_addresses_without_mail_header(mail)
+        # load X-SMTPAPI headers (json)
+        x_smtpapi = JSON.parse mail.header['X-SMTPAPI'].to_s
+
+        external_indices = []
+        # get a list of indices for external addresses
+        x_smtpapi['to'].each_with_index do |address, index|
+          external_indices << index if !MailSafe::Config.is_internal_address?(address)
+        end
+        deleted_cnt = 0
+        deleted_addresses = []
+        external_indices.each do |i|
+          # remove any external address from :to
+          deleted_addresses << x_smtpapi['to'].delete_at(i - deleted_cnt)
+          # remove the related tokens for every array in :sub
+          x_smtpapi['sub'].each do |k, v|
+            v.delete_at(i-deleted_cnt)
+            x_smtpapi['sub'][k] = v
+          end
+          # the indices decrement as we remove elements, deleted_cnt accounts for this
+          deleted_cnt += 1
+        end
+        # save the headers back to X-SMTPAPI
+        mail.header['X-SMTPAPI'].value = x_smtpapi.to_json.gsub(/(["\]}])([,:])(["\[{])/, '\\1\\2 \\3')
+
+        add_body_postscript(mail,{:X_SMTPAPI=>deleted_addresses}, true)
+        # we need to override add_text_postscript to include sendgrid x-smtpapi and not ADDRESS_TYPES only
+
+      end
+      alias_method_chain :replace_external_addresses, :mail_header
+
+      # ADDRESS_TYPES is frozen but we want to add :X_SMTPAPI to it
+      # so the original add_[text|html]_postscript functions have
+      # the SendGrid specific addresses that MailSafe removed as well
+      # when generating their message. Otherwise we would have to
+      # override these functions entirely.
+      def add_xsmtpapi_to_address_types
+        modified_address_types = @@address_types.dup
+        modified_address_types << :X_SMTPAPI
+        # silence already initialized constant ADDRESS_TYPES
+        silence_warnings do
+          MailSafe::AddressReplacer.singleton_class.const_set(:ADDRESS_TYPES,modified_address_types.uniq)
+        end
+      end
+
+      # We then need to reset ADDRESS_TYPES back to the frozen value
+      # for MailSafe to be able to process the next message properly
+      def remove_xsmtpapi_from_address_types
+
+        # silence already initialized constant ADDRESS_TYPES
+        silence_warnings do
+          MailSafe::AddressReplacer.singleton_class.const_set(:ADDRESS_TYPES,@@address_types)
+          end
+      end
+    end
+
+
+  end
+end

data/mail_safe-sendgrid.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name        = 'mail_safe-sendgrid'
+  s.version     = '0.0.1'
+  s.date        = '2012-03-13'
+  s.summary     = 'Sendgrid support for Mail Safe'
+  s.description = 'Extends Mail Safe to look for and sanitize Sendgrid specific X-SMTPAPI headers'
+  s.authors     = ['Ed Shadi', 'Vijay Ramesh']
+  s.email       = ['ed@change.org', 'vijay@change.org']
+
+  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_runtime_dependency 'json'
+  s.add_runtime_dependency 'mail_safe'
+  s.add_runtime_dependency 'sendgrid'
+
+  s.add_development_dependency 'actionmailer'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+
+end

data/spec/mail_safe-sendgrid_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe MailSafe::AddressReplacer do
+  before do
+    default_internal_address = /.*@internal\.com/i
+
+    if defined?(MailSafe::Config)
+      MailSafe::Config.internal_address_definition = lambda { |addr|
+        addr =~ default_internal_address
+      }
+      MailSafe::Config.replacement_address = "replacement@internal.com"
+    end
+  end
+  describe '#replace_external_addresses' do
+    before(:each) do
+      @mail = TestMailer.create_test
+      MailSafe::AddressReplacer.replace_external_addresses(@mail)
+    end
+
+    it "should generate one email using the content's template, and with Sendgrid SMTP headers for each user's info" do
+
+      sendgrid_header = JSON.parse(@mail['X-SMTPAPI'].to_s)
+      sendgrid_header['sub']['{username}'].should       == ['internal_1','internal_2']
+      sendgrid_header['sub']['{email_address}'].should  == ['internal_1@internal.com', 'internal_2@internal.com']
+
+    end
+
+    it "should create the appropriate postscript including X-SMTPAPI addresses that were removed" do
+      postscript = %r(The original recipients were:\s*- to:\s*- donotreply@foobar.com\s*- X_SMTPAPI:\s*- external_1@external.com\s*- external_2@external.com)
+      @mail.parts[0].body.should =~ postscript
+    end
+  end
+
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require 'rubygems'
+require 'mail_safe'
+require 'sendgrid'
+require 'mail_safe-sendgrid'
+require 'action_mailer'
+require 'json'
+
+class TestMailer < ActionMailer::Base
+  include SendGrid
+  public
+  def create_test
+    user_data = [
+      {:email_address =>'external_1@external.com', :name =>'external_1'},
+      {:email_address =>'external_2@external.com', :name =>'external_2'},
+      {:email_address =>'internal_1@internal.com', :name =>'internal_1'},
+      {:email_address =>'internal_2@internal.com', :name =>'internal_2'}
+    ]
+    subject = 'Test'
+    content = 'This is a test email.'
+
+    email_addresses, usernames = transpose_user_data(user_data)
+
+    sendgrid_recipients email_addresses
+    sendgrid_substitute '{username}', usernames
+    sendgrid_substitute '{email_address}', email_addresses
+    sendgrid_category   'Test Email'
+
+    mail(:to => 'donotreply@foobar.com', :from => 'donotreply@foobar.com', :subject  => subject) do |format|
+      format.text { render :text => content }
+      format.html { render :text => content }
+    end
+  end
+
+  def transpose_user_data(user_data)
+    user_data.collect { |u| [ u[:email_address], u[:name]] }.transpose
+  end
+
+end
+
+

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: mail_safe-sendgrid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ed Shadi
+- Vijay Ramesh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70275505733960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70275505733960
+- !ruby/object:Gem::Dependency
+  name: mail_safe
+  requirement: &70275505733020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70275505733020
+- !ruby/object:Gem::Dependency
+  name: sendgrid
+  requirement: &70275505732220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70275505732220
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: &70275505731220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70275505731220
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70275505749140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70275505749140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70275505747520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70275505747520
+description: Extends Mail Safe to look for and sanitize Sendgrid specific X-SMTPAPI
+  headers
+email:
+- ed@change.org
+- vijay@change.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/core_ext/kernel.rb
+- lib/mail_safe-sendgrid.rb
+- mail_safe-sendgrid.gemspec
+- spec/mail_safe-sendgrid_spec.rb
+- spec/spec_helper.rb
+homepage: 
+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: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Sendgrid support for Mail Safe
+test_files:
+- spec/mail_safe-sendgrid_spec.rb
+- spec/spec_helper.rb