sendgrid-rails 1.0.0

data/.gitignore

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

data/.rspec

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

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,61 @@
+= SendGrid gem for Rails
+
+SendGrid gem provides ActionMailer 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)
+    add_filter_setting(filter_name, setting_name, value)
+
+== Examples
+
+=== Rails 3 configuration
+
+In your Gemfile:
+
+    gem 'sendgrid-rails', '>=1.0.0', :git => 'git://github.com/PavelTyk/sendgrid-rails.git'
+
+In your config/environment.rb:
+
+    ActionMailer::Base.smtp_settings = {
+      :address => 'smtp.sendgrid.net',
+      :port => '25',
+      :domain => 'example.com',
+      :authentication => :plain,
+      :user_name => 'login@example.com',
+      :password => 'your password'
+    }
+
+==== Adding multiple recipients:
+
+    class Mailer < ActionMailer::Base
+      default :from => 'no-reply@example.com',
+              :subject => 'An email sent via SendGrid'
+
+      def email_with_multiple_recipients
+        add_recipients %w(email1@email.com email2@email.com)
+        mail :body => 'Hello.'
+      end
+    end
+
+=== Adding substitution vars
+
+Mailer class definition:
+
+    class Mailer < ActionMailer::Base
+      default :from => 'no-reply@example.com',
+              :subject => 'An email sent via SendGrid with substitutions'
+
+      def mail_with_substitutions
+        emails = %w(email1@email.com email2@email.com)
+        names = %w(User1 User2)
+
+        add_recipients emails
+        substitute '-user_name-', names
+
+        mail :body => "Hello, -user_name-."
+      end
+    end
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/send_grid.rb

@@ -0,0 +1,30 @@
+module SendGrid
+  autoload :ApiHeader, 'send_grid/api_header'
+  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
+    end
+  end
+
+  module InstanceMethods
+    def send_grid_header
+      @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
+      mail_without_send_grid(headers, &block)
+    end
+  end
+end
+

data/lib/send_grid/api_header.rb

@@ -0,0 +1,35 @@
+class SendGrid::ApiHeader
+  def initialize
+    @data = {}
+  end
+
+  def add_recipients(recipients)
+    @data[:to] ||= []
+    @data[:to] |= Array.wrap(recipients)
+  end
+
+  def substitute(var, val)
+    @data[:sub] ||= {}
+    @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] ||= {}
+    @data[:filters][fltr] ||= {}
+    @data[:filters][fltr][:settings] ||= {}
+    @data[:filters][fltr][:settings][setting] = val
+  end
+
+  def to_json
+    @data.to_json
+  end
+end
+

data/lib/send_grid/version.rb

@@ -0,0 +1,4 @@
+module SendGrid
+  VERSION = "1.0.0"
+end
+

data/lib/sendgrid-rails.rb

@@ -0,0 +1,5 @@
+require 'send_grid'
+autoload :ActionMailer, 'action_mailer'
+
+ActionMailer::Base.send :include, SendGrid
+

data/send_grid.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "send_grid/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sendgrid-rails"
+  s.version     = SendGrid::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["PavelTyk"]
+  s.email       = ["paveltyk@gmail.com"]
+  s.homepage    = "https://github.com/PavelTyk/sendgrid-rails"
+  s.summary     = %q{SendGrid gem fo Rails 3}
+  s.description = %q{Gem to extend ActionMailer with SendGrid API support}
+
+  s.rubyforge_project = "sendgrid-rails"
+
+  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,41 @@
+require 'spec_helper'
+
+describe SendGrid::ApiHeader do
+  let(:header) { SendGrid::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,10 @@
+class Mailer < ActionMailer::Base
+  default :from => 'no-reply@sendgrid.com',
+          :subject => 'Test email'
+
+  def email_with_multiple_recipients(recipients)
+    add_recipients recipients
+    mail
+  end
+end
+

data/spec/mailer_spec.rb

@@ -0,0 +1,20 @@
+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"]}')
+    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']
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'sendgrid-rails'
+
+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,8 @@
+require 'spec_helper'
+
+describe 'SendGrid::VERSION' do
+  it "returns string" do
+    SendGrid::VERSION.should be_an_instance_of(String)
+  end
+end
+

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: sendgrid-rails
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- PavelTyk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-17 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        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 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        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 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :runtime
+  version_requirements: *id003
+description: Gem to extend ActionMailer with SendGrid API support
+email: 
+- paveltyk@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/send_grid.rb
+- lib/send_grid/api_header.rb
+- lib/send_grid/version.rb
+- lib/sendgrid-rails.rb
+- send_grid.gemspec
+- spec/api_header_spec.rb
+- spec/fixtures/mailers/mailer.rb
+- spec/fixtures/views/mailer/email_with_multiple_recipients.text.erb
+- 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: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: sendgrid-rails
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: SendGrid gem fo Rails 3
+test_files: []
+