mail_safe-sendgrid 0.0.2 → 0.0.3

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 by Ed Shadi and Vijay Ramesh
+
+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,54 @@
+# MailSafe Sendgrid
+
+**MailSafe Sendgrid** adds Sendgrid support to Mail Safe by extending MailSafe::AddressReplacer to check for addresses included in the Sendgrid X-SMTPAPI headers. It automatically removes any offending (i.e., non-internal) addresses and removes the corresponding entries from any Sendgrid substitutions. The addresses that are removed are also passed to Mail Safe's postscript message (along with any :to, :cc, and :bcc addresses that were removed by Mail Safe itself).
+
+## Basic usage
+
+If you always want Mail Safe turned on, simply add `mail_safe-sendgrid` to your Gemfile immediately following `mail_safe`.
+
+## Conditional usage
+For a more complicated usage case (i.e., you only want `mail_safe` turned on in demo environments and not in production) make sure to add
+
+
+```ruby
+gem "mail_safe", :require => nil
+gem "mail_safe-sendgrid", :require => nil
+```
+
+to your Gemfile and then manually require `mail_safe` and `mail_safe-sendgrid` after you do your environment checks
+
+```ruby
+module MailSafeFilter
+  def self.filter_email_addresses(environment = ['development', 'demo', 'staging'])
+    if environment.include? Rails.env
+      require 'mail_safe'
+      require 'mail_safe-sendgrid'
+      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 = "#{Rails.env}_firehose@replacement.com"
+      end
+    end
+  end
+end
+MailSafeFilter.filter_email_addresses
+```
+
+## Tests
+
+All code is tested with [RSpec](https://github.com/rspec/rspec). To run the specs, clone the repository, install the dependencies with `bundle install`, and then run `rake`.
+
+## Issues
+
+If you have any problems or suggestions for the project, please open a GitHub issue.
+
+## License
+
+MailSafe Sendgrid is available under the included MIT license.
+
+## Acknowledgements
+
+Thank you to [Change.org](http://www.change.org/) for sponsoring the project.

data/lib/mail_safe-sendgrid.rb

@@ -10,11 +10,12 @@ module MailSafe
         # 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
+        add_xsmtpapi_to_address_types if replaced_addresses[:X_SMTPAPI]
         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
+        remove_xsmtpapi_from_address_types if replaced_addresses[:X_SMTPAPI]
+
       end
       alias_method_chain :add_body_postscript, :mail_header
 
@@ -26,26 +27,30 @@ module MailSafe
 
         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
+        if x_smtpapi['to']
+          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
-          # the indices decrement as we remove elements, deleted_cnt accounts for this
-          deleted_cnt += 1
+          # 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)
+        else
+          add_body_postscript(mail,{}, true)
         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

data/mail_safe-sendgrid.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'mail_safe-sendgrid'
-  s.version     = '0.0.2'
+  s.version     = '0.0.3'
   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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mail_safe-sendgrid
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70314957771680 !ruby/object:Gem::Requirement
+  requirement: &70096727984760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70314957771680
+  version_requirements: *70096727984760
 - !ruby/object:Gem::Dependency
   name: mail_safe
-  requirement: &70314957770420 !ruby/object:Gem::Requirement
+  requirement: &70096727983560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70314957770420
+  version_requirements: *70096727983560
 - !ruby/object:Gem::Dependency
   name: sendgrid
-  requirement: &70314957769600 !ruby/object:Gem::Requirement
+  requirement: &70096727980940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70314957769600
+  version_requirements: *70096727980940
 - !ruby/object:Gem::Dependency
   name: actionmailer
-  requirement: &70314957768340 !ruby/object:Gem::Requirement
+  requirement: &70096727979900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314957768340
+  version_requirements: *70096727979900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70314957786940 !ruby/object:Gem::Requirement
+  requirement: &70096727977420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314957786940
+  version_requirements: *70096727977420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70314957785980 !ruby/object:Gem::Requirement
+  requirement: &70096728003320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +77,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314957785980
+  version_requirements: *70096728003320
 description: Extends Mail Safe to look for and sanitize Sendgrid specific X-SMTPAPI
   headers
 email:
@@ -89,6 +89,8 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- LICENSE
+- README.md
 - Rakefile
 - lib/core_ext/kernel.rb
 - lib/mail_safe-sendgrid.rb