send_grid_mailer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4faec0a432af15b6398489de76957702d4ee324d
+  data.tar.gz: b7244a3bc8a5f7acf01011aff00e55db8732e68a
+SHA512:
+  metadata.gz: f429d42dc73f6c49ef54a2418be0ab25cabf85aac100f4021a12a9bd2af77f3085e95d4fed18a3ba677fac9a8bbb7d53217296439fe93adb705f8b011be97dbc
+  data.tar.gz: a5a29f1551a0968142e7dd93fc31cd2e6ffd4e4e803b71cb4bb8bc6cce1cb25773e55af641eafa57b579bd0abadef3c75b7e4224248700ea405896364922c666

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require rails_helper
+--format=doc

data/.ruby-version

@@ -0,0 +1 @@
+2.3

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+### v0.1.0
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in send_grid_mailer.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+

data/Gemfile.lock

@@ -0,0 +1,192 @@
+PATH
+  remote: .
+  specs:
+    send_grid_mailer (0.1.0)
+      colorize (~> 0.7, >= 0.7.7)
+      rails (~> 4.2, >= 4.2.0)
+      sendgrid-ruby (~> 4.0, >= 4.0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.7.1)
+      actionview (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      globalid (>= 0.3.0)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
+      builder (~> 3.1)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      arel (~> 6.0)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    coderay (1.1.1)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.2)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.6.0)
+      factory_girl (~> 4.5.0)
+      railties (>= 3.0.0)
+    ffi (1.9.14)
+    formatador (0.2.5)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    guard (2.14.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    lumberjack (1.0.10)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    nenv (0.3.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pkg-config (1.1.7)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-rails (0.3.4)
+      pry (>= 0.9.10)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.7.1)
+      actionmailer (= 4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activerecord (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.7.1)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.3.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    ruby_dep (1.4.0)
+    ruby_http_client (3.0.0)
+    sendgrid-ruby (4.0.4)
+      ruby_http_client (~> 3.0.0)
+    shellany (0.0.1)
+    slop (3.6.0)
+    sprockets (3.7.0)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  factory_girl_rails (~> 4.6.0)
+  guard-rspec (~> 4.7)
+  pry
+  pry-rails
+  rspec-rails (~> 3.4.0)
+  send_grid_mailer!
+  sqlite3
+
+BUNDLED WITH
+   1.12.5

data/Guardfile

@@ -0,0 +1,15 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  spec_dic = "spec/dummy/spec"
+  # RSpec files
+  watch("spec/spec_helper.rb") { spec_dic }
+  watch("spec/rails_helper.rb") { spec_dic }
+  watch(%r{^spec\/dummy\/spec\/support\/(.+)\.rb$}) { spec_dic }
+  watch(%r{^spec\/dummy\/spec\/.+_spec\.rb$})
+  # Engine files
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/dummy/spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.+)\.rb$}) { |m| "spec/dummy/spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb)$}) { |m| "spec/dummy/spec/#{m[1]}#{m[2]}_spec.rb" }
+  # Dummy app files
+  watch(%r{^spec\/dummy\/app/(.+)\.rb$}) { |m| "spec/dummy/spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec\/dummy\/app/(.*)(\.erb)$}) { |m| "spec/dummy/spec/#{m[1]}#{m[2]}_spec.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2016 Platanus
+
+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,209 @@
+# SendGrid Mailer
+
+Is an Action Mailer adapter for using SendGrid in a Rails application and
+It's built on top of the [sengrid-ruby](https://github.com/sendgrid/sendgrid-ruby) gem.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "send_grid_mailer"
+```
+
+```bash
+bundle install
+```
+
+In your environment file you need to add:
+
+```ruby
+config.action_mailer.delivery_method = :sendgrid
+config.action_mailer.sendgrid_settings = {
+  api_key: "YOUR-SENDGRID-API-KEY"
+}
+```
+
+## Usage
+
+With this adapter you will be able to:
+
+#### Set E-mail's Subject
+
+```ruby
+class TestMailer < ApplicationMailer
+  def my_email
+    set_subject("My Subject")
+    mail
+  end
+
+  def my_email # through mail method's params
+    mail(subject: "My Subject")
+  end
+end
+```
+
+#### Set E-mail's Body
+
+```ruby
+class TestMailer < ApplicationMailer
+  def my_email
+    set_content("Body")
+    mail
+  end
+
+  def my_email # through mail method's params
+    mail(body: "<h1>Body</h1>", content_type: "text/html")
+  end
+end
+```
+
+#### Set E-mail's Sender
+
+```ruby
+class TestMailer < ApplicationMailer
+  default from: "default-sender@platan.us"
+
+  def my_email
+    set_sender("override-default-sender@platan.us")
+    mail
+  end
+
+  def my_email # through mail method's params
+    mail(from: "override@platan.us", body: "Body")
+  end
+end
+```
+
+#### Set E-mail's Recipients
+
+```ruby
+class TestMailer < ApplicationMailer
+  def my_email
+    set_recipients(:to, "r1@platan.us", "r2@platan.us")
+    set_recipients(:cc, ["r4@platan.us"])
+    set_recipients(:bcc, "r5@platan.us")
+    mail
+  end
+
+  def my_email # through mail method's params
+    mail(
+      to: ["r1@platan.us", "r2@platan.us"],
+      cc: ["r4@platan.us"],
+      bcc: "r5@platan.us"
+    )
+  end
+end
+```
+
+#### Set E-mail's Subject
+
+```ruby
+class TestMailer < ApplicationMailer
+  def my_email
+    set_subject("My Subject")
+    mail
+  end
+
+  def my_email # through mail method's params
+    mail(subject: "My Subject")
+  end
+end
+```
+
+#### Set E-mail's Headers
+
+```ruby
+class TestMailer < ApplicationMailer
+  def my_email
+    headers["HEADER-1"] = "VALUE-1"
+    headers["HEADER-2"] = "VALUE-2"
+    mail
+  end
+
+  def my_email # through mail method's params
+    mail(headers: { "HEADER-1" => "VALUE-1", "HEADER-2" => "VALUE-2" })
+  end
+end
+```
+
+#### Set E-mail's Attachments
+
+```ruby
+class TestMailer < ApplicationMailer
+  def my_email # using Action Mailer method
+    attachments["platanus.png"] = File.read("file-path")
+    mail
+  end
+
+  def my_email # using this gem method
+    file = File.read("file-path")
+    add_attachment(file, "platanus.png", "image/png", "inline")
+    mail
+  end
+end
+```
+
+#### Set SendGrid's Template
+
+```ruby
+class TestMailer < ApplicationMailer
+  def my_email
+    set_template_id("XXX")
+    mail
+  end
+
+  def my_email # through template's name
+    set_template_name("my template name")
+    mail
+  end
+
+  def my_email # through mail method's params
+    mail(template_id: "XXX")
+  end
+end
+```
+
+#### Add Substitutions in SendGrid's Template
+
+```ruby
+class TestMailer < ApplicationMailer
+  def my_email
+    substitute "%key1%", "value1"
+    substitute "%key2%", "value2"
+    mail
+  end
+end
+```
+
+> Remember: you need to specify al least: `body`, `template`, `template name` or a Rails template.
+
+## Testing
+
+To run the specs you need to execute, **in the root path of the gem**, the following command:
+
+```bash
+bundle exec guard
+```
+
+You need to put **all your tests** in the `/send_grid_mailer/spec/dummy/spec/` directory.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+Thank you [contributors](https://github.com/platanus/send_grid_mailer/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+SendGrid Mailer is maintained by [platanus](http://platan.us).
+
+## License
+
+SendGrid Mailer is © 2016 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.