send_grid_mailer 1.1.0 → 2.0.1

data/.ruby-version

@@ -1 +1 @@
-2.3
+2.7

data/CHANGELOG.md

@@ -2,6 +2,34 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+### v2.0.1
+
+##### Fixed
+
+* :sendgrid_dev delivery method doesn't work with rails templates and missing api key.
+
+### v2.0.0
+
+##### Changed
+
+* Replace travis with circleci.
+
+##### Removed
+
+* Support for Ruby 2.5
+
+### v1.2.1
+
+##### Fixed
+
+* :sendgrid_dev delivery method now works with Rails templates.
+
+### v1.2.0
+
+##### Added
+
+* Add :sendgrid_dev delivery method
+
 ### v1.1.0
 
 ##### Added

data/README.md

@@ -1,6 +1,6 @@
 # SendGrid Mailer
 [![Gem Version](https://badge.fury.io/rb/send_grid_mailer.svg)](https://badge.fury.io/rb/send_grid_mailer)
-[![Build Status](https://travis-ci.org/platanus/send_grid_mailer.svg?branch=master)](https://travis-ci.org/platanus/send_grid_mailer)
+[![CircleCI](https://circleci.com/gh/platanus/send_grid_mailer.svg?style=shield)](https://app.circleci.com/pipelines/github/platanus/send_grid_mailer)
 [![Coverage Status](https://coveralls.io/repos/github/platanus/send_grid_mailer/badge.svg)](https://coveralls.io/github/platanus/send_grid_mailer)
 
 Is an Action Mailer adapter for using SendGrid in a Rails application and
@@ -18,7 +18,16 @@ gem "send_grid_mailer"
 bundle install
 ```
 
-In your environment file you need to add:
+We provide two delivery methods. For development environments, where sending the email is not required, you can use `:sendgrid_dev` to open it in the browser:
+
+```ruby
+config.action_mailer.delivery_method = :sendgrid_dev
+config.action_mailer.sendgrid_dev_settings = {
+  api_key: "YOUR-SENDGRID-API-KEY"
+}
+```
+
+Otherwise, you can use `:sendgrid` to actually send the email:
 
 ```ruby
 config.action_mailer.delivery_method = :sendgrid
@@ -27,6 +36,7 @@ config.action_mailer.sendgrid_settings = {
 }
 ```
 
+
 ## Usage
 
 With this adapter you will be able to:
@@ -134,6 +144,8 @@ end
 
 #### Set SendGrid's Template
 
+To use this functionality you need to add the SENDGRID_API_KEY and, in case you do not add the api key, the gem would not search in Sendgrid for the template.
+
 ```ruby
 class TestMailer < ApplicationMailer
   def my_email
@@ -159,6 +171,28 @@ class TestMailer < ApplicationMailer
 end
 ```
 
+#### Set Dynamic Template Data
+
+```ruby
+class TestMailer < ApplicationMailer
+  def my_email
+    dynamic_template_data({ key1: "value1", key2: "value2" })
+    mail
+  end
+end
+```
+
+#### Add Category
+
+```ruby
+class TestMailer < ApplicationMailer
+  def my_email
+    add_category("value")
+    mail
+  end
+end
+```
+
 > Remember: you need to specify al least: `body`, `template_id` or a Rails template.
 
 ## Recipient Interceptor
@@ -195,6 +229,16 @@ bundle exec guard
 
 You need to put **all your tests** in the `/send_grid_mailer/spec/dummy/spec/` directory.
 
+## Publishing
+
+On master/main branch...
+
+1. Change `VERSION` in `lib/send_grid_mailer/version.rb`.
+2. Change `Unreleased` title to current version in `CHANGELOG.md`.
+3. Commit new release. For example: `Releasing v0.1.0`.
+4. Create tag. For example: `git tag v0.1.0`.
+5. Push tag. For example: `git push origin v0.1.0`.
+
 ## Contributing
 
 1. Fork it

data/lib/send_grid_mailer/api.rb

@@ -2,32 +2,37 @@ module SendGridMailer
   class Api
     include Logger
 
-    SUCCESS_CODE = 202
-
     def initialize(api_key)
       @api_key = api_key || raise(SendGridMailer::InvalidApiKey)
     end
 
     def send_mail(sg_definition)
       response = sg_api.client.mail._('send').post(request_body: sg_definition.to_json)
-      handle_response(response)
+      handle_response(response, :mail)
+    end
+
+    def get_template(sg_definition)
+      response = sg_api.client.templates._(sg_definition.mail.template_id).get()
+      handle_response(response, :template)
     end
 
     private
 
-    def handle_response(response)
-      if response.status_code.to_i != SUCCESS_CODE
+    def handle_response(response, api_call_type)
+      status_code = response.status_code.to_i
+      if status_code.between?(400, 600)
         errors = response_errors(response)
-        log_api_error_response(response.status_code, errors)
-        raise SendGridMailer::ApiError.new(response.status_code, errors)
+        log_api_error_response(status_code, errors, api_call_type)
+        raise SendGridMailer::ApiError.new(status_code, errors)
       end
 
-      log_api_success_response(response)
+      log_api_success_response(status_code, api_call_type)
       response
     end
 
     def response_errors(response)
-      JSON.parse(response.body)["errors"]
+      body = JSON.parse(response.body)
+      body["errors"] || [{ "message" => body["error"] }]
     end
 
     def sg_api

data/lib/send_grid_mailer/definition.rb

@@ -2,28 +2,36 @@ module SendGridMailer
   class Definition
     METHODS = [
       :substitute,
+      :dynamic_template_data,
       :set_template_id,
       :set_sender,
       :set_recipients,
       :set_subject,
       :set_content,
       :add_attachment,
-      :add_header
+      :add_header,
+      :add_category
     ]
 
     def substitute(key, value, default = "")
-      personalization.substitutions = SendGrid::Substitution.new(
-        key: key, value: value.to_s || default
+      personalization.add_substitution(
+        SendGrid::Substitution.new(key: key, value: value.to_s || default)
       )
     end
 
+    def dynamic_template_data(object)
+      personalization.add_dynamic_template_data(object)
+    end
+
     def set_template_id(value)
       return unless value
+
       mail.template_id = value
     end
 
     def set_sender(email)
       return unless email
+
       matched_format = email.match(/<(.+)>/)
       if matched_format
         address = matched_format[1]
@@ -37,19 +45,22 @@ module SendGridMailer
     def set_recipients(mode, *emails)
       emails.flatten.each do |email|
         next unless email
-        personalization.send("#{mode}=", SendGrid::Email.new(email: email))
+
+        personalization.send("add_#{mode}", SendGrid::Email.new(email: email))
       end
     end
 
     def set_subject(value)
       return unless value
+
       personalization.subject = value
     end
 
     def set_content(value, type = nil)
       return unless value
-      type = "text/plain" unless type
-      mail.contents = SendGrid::Content.new(type: type, value: value)
+
+      type ||= "text/plain"
+      mail.add_content(SendGrid::Content.new(type: type, value: value))
     end
 
     def add_attachment(file, name, type, disposition = "inline", content_id = nil)
@@ -59,16 +70,23 @@ module SendGridMailer
       attachment.filename = name
       attachment.disposition = disposition
       attachment.content_id = content_id
-      mail.attachments = attachment
+      mail.add_attachment(attachment)
     end
 
     def add_header(key, value)
       return if !key || !value
-      personalization.headers = SendGrid::Header.new(key: key, value: value)
+
+      personalization.add_header(SendGrid::Header.new(key: key, value: value))
+    end
+
+    def add_category(value)
+      return unless value
+
+      mail.add_category(SendGrid::Category.new(name: value))
     end
 
     def to_json
-      mail.personalizations = personalization if personalization?
+      mail.add_personalization(personalization) if personalization?
       mail.to_json
     end
 
@@ -77,7 +95,7 @@ module SendGridMailer
     end
 
     def clean_recipients(mode)
-      personalization.instance_variable_set("@#{mode}s", nil)
+      personalization.instance_variable_set("@#{mode}s", [])
     end
 
     def personalization
@@ -86,12 +104,12 @@ module SendGridMailer
 
     def personalization?; !personalization.to_json.empty? end
 
-    def content?; !mail.contents.blank? end
+    def content?; mail.contents.present? end
 
-    def sender?; !mail.from.blank? end
+    def sender?; mail.from.present? end
 
-    def subject?; !personalization.subject.blank? end
+    def subject?; personalization.subject.present? end
 
-    def template_id?; !mail.template_id.blank? end
+    def template_id?; mail.template_id.present? end
   end
 end

data/lib/send_grid_mailer/dev_deliverer.rb

@@ -0,0 +1,72 @@
+module SendGridMailer
+  class DevDeliverer
+    include InterceptorsHandler
+    include Logger
+    require "letter_opener"
+    require "handlebars"
+
+    def deliver!(sg_definition)
+      @sg_definition = sg_definition
+      execute_interceptors(@sg_definition)
+      log_definition(@sg_definition)
+      letter_opener_delivery_method.deliver!(mail)
+    end
+
+    private
+
+    def sg_api
+      @sg_api ||= Api.new(api_key)
+    end
+
+    def api_key
+      Rails.application.config.action_mailer.sendgrid_dev_settings[:api_key]
+    rescue
+      nil
+    end
+
+    def letter_opener_delivery_method
+      @letter_opener_delivery_method ||= LetterOpener::DeliveryMethod.new(location: dev_emails_location)
+    end
+
+    def dev_emails_location
+      Rails.application.config.action_mailer.sendgrid_dev_settings[:emails_location] || "/tmp/mails"
+    rescue
+      "/tmp/mails"
+    end
+
+    def parsed_template
+      return nil if api_key.blank?
+
+      template_response = sg_api.get_template(@sg_definition)
+      template_versions = JSON.parse(template_response.body)["versions"]
+      return if template_versions.blank?
+
+      template_active_version = template_versions.find { |version| version["active"] == 1 }
+      template_content = template_active_version["html_content"]
+      @sg_definition.personalization.substitutions.each { |k, v| template_content.gsub!(k, v) }
+      template = Handlebars::Context.new.compile(template_content)
+      template_content = template.call(@sg_definition.personalization.dynamic_template_data)
+      template_content
+    end
+
+    def emails(origin)
+      @emails ||= {}
+      return @emails[origin] if @emails.has_key?(origin)
+
+      @emails[origin] = @sg_definition.personalization.send(origin)&.map {|em| em["email"]}
+    end
+
+    def mail
+      template = (parsed_template || @sg_definition.mail.contents[0]['value']).html_safe
+      m = Mail.new
+      m.html_part = template
+      m.subject = @sg_definition.personalization.subject
+      m.from = @sg_definition.mail.from["email"] if @sg_definition.mail.from.present?
+      m.to = emails(:tos) if emails(:tos).present?
+      m.cc = emails(:ccs) if emails(:ccs).present?
+      m.bcc = emails(:bccs) if emails(:bccs).present?
+
+      m
+    end
+  end
+end

data/lib/send_grid_mailer/engine.rb

@@ -4,7 +4,7 @@ module SendGridMailer
 
     config.generators do |g|
       g.test_framework :rspec, fixture: false
-      g.fixture_replacement :factory_girl, dir: "spec/factories"
+      g.fixture_replacement :factory_bot, dir: "spec/factories"
     end
 
     initializer "initialize" do
@@ -17,9 +17,11 @@ module SendGridMailer
       require_relative "./mailer_base_ext"
     end
 
-    initializer "add_sendgrid_deliverer", before: "action_mailer.set_configs" do
+    initializer "add_sendgrid_deliverers", before: "action_mailer.set_configs" do
+      require_relative "./dev_deliverer"
       require_relative "./deliverer"
       ActionMailer::Base.add_delivery_method(:sendgrid, SendGridMailer::Deliverer)
+      ActionMailer::Base.add_delivery_method(:sendgrid_dev, SendGridMailer::DevDeliverer)
     end
   end
 end

data/lib/send_grid_mailer/logger.rb

@@ -20,12 +20,12 @@ module SendGridMailer
       log(build_definition_message(data))
     end
 
-    def log_api_success_response(response)
-      log("The E-mail was successfully sent :)\nStatus Code: #{response.status_code}")
+    def log_api_success_response(status_code, api_call_type)
+      log("Succesfully called the SendGrid API :)\nStatus Code: #{status_code}")
     end
 
-    def log_api_error_response(status_code, errors)
-      msg = "The E-mail was not sent :(\nStatus Code: #{status_code}\nErrors:"
+    def log_api_error_response(status_code, errors, api_call_type)
+      msg = "There was a problem calling the SendGrid API :(\nStatus Code: #{status_code}\nErrors:"
       msg += log_errors(errors)
       log(msg)
     end
@@ -40,18 +40,20 @@ module SendGridMailer
     def build_definition_message(data)
       data = data.keys.map do |k|
         d = data[k].to_s
-        "#{k}: #{(d.blank? ? '-' : d)}"
+        "#{k}: #{d.presence || '-'}"
       end.join("\n")
     end
 
     def log_email(email)
       return if email.blank?
+
       email["email"]
     end
 
     def log_emails(personalization, origin)
       emails = personalization.send(origin)
       return if emails.blank?
+
       emails.map do |email|
         log_email(email)
       end.join(", ")
@@ -59,6 +61,7 @@ module SendGridMailer
 
     def log_attachments(mail)
       return if mail.attachments.blank?
+
       mail.attachments.map do |f|
         "\n\t#{f['filename']}"
       end.join("")
@@ -66,6 +69,7 @@ module SendGridMailer
 
     def log_contents(mail)
       return if mail.contents.blank?
+
       mail.contents.map do |content|
         "\n\ttype: #{content['type']}\n\tvalue: #{content['value']}"
       end.join("")
@@ -73,6 +77,7 @@ module SendGridMailer
 
     def log_pairs(hash)
       return if hash.blank?
+
       hash.keys.map do |k|
         "\n\t#{k} => #{hash[k]}"
       end.join("")

data/lib/send_grid_mailer/mailer_base_ext.rb

@@ -23,7 +23,7 @@ module ActionMailer
 
       define_sg_mail(headers)
 
-      SendGridMailer::Deliverer.new.deliver!(sg_definition)
+      deliverer&.new&.deliver!(sg_definition)
     end
 
     private
@@ -59,8 +59,10 @@ module ActionMailer
     def set_body(params)
       set_template_id(params[:template_id])
       return if sg_definition.template_id?
+
       set_content(params[:body], params[:content_type])
       return if sg_definition.content?
+
       set_body_from_tpl(params)
     end
 
@@ -82,8 +84,17 @@ module ActionMailer
       @sg_definition ||= SendGridMailer::Definition.new
     end
 
+    def deliverer
+      case self.class.delivery_method
+      when :sendgrid_dev
+        SendGridMailer::DevDeliverer
+      when :sendgrid
+        SendGridMailer::Deliverer
+      end
+    end
+
     def enabled_sendgrid?
-      self.class.delivery_method == :sendgrid
+      [:sendgrid, :sendgrid_dev].include?(self.class.delivery_method)
     end
   end
 end

data/lib/send_grid_mailer/version.rb

@@ -1,3 +1,3 @@
 module SendGridMailer
-  VERSION = "1.1.0"
+  VERSION = "2.0.1"
 end

data/send_grid_mailer.gemspec

@@ -19,13 +19,19 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.test_files = Dir["spec/**/*"]
 
+  s.add_dependency "handlebars", "~> 0.8.0"
+  s.add_dependency "letter_opener", "~> 1.7.0"
   s.add_dependency "rails", ">= 4.2.0"
-  s.add_dependency "sendgrid-ruby", "~> 4.0", ">= 4.0.4"
+  s.add_dependency "sendgrid-ruby", "~> 5", ">= 5.3.0"
+
+  s.add_development_dependency "coveralls"
+  s.add_development_dependency "factory_bot_rails"
+  s.add_development_dependency "guard-rspec", "~> 4.7"
   s.add_development_dependency "pry"
   s.add_development_dependency "pry-rails"
-  s.add_development_dependency "sqlite3"
-  s.add_development_dependency "rspec-rails", "~> 3.4.0"
-  s.add_development_dependency "guard-rspec", "~> 4.7"
-  s.add_development_dependency "factory_girl_rails", "~> 4.6.0"
-  s.add_development_dependency "coveralls"
+  s.add_development_dependency "rspec-rails", "~> 3.5.0"
+  s.add_development_dependency "rspec_junit_formatter"
+  s.add_development_dependency "rubocop", "0.65.0"
+  s.add_development_dependency "rubocop-rspec"
+  s.add_development_dependency "sqlite3", "~> 1.4"
 end

data/spec/dummy/Rakefile

@@ -1,6 +1,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require_relative "config/application"
 
 Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link send_grid_mailer_manifest.js

data/spec/dummy/app/assets/stylesheets/application.css

@@ -6,9 +6,9 @@
  * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
  *
  * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
  *
  *= require_tree .
  *= require_self

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -1,5 +1,2 @@
 class ApplicationController < ActionController::Base
-  # Prevent CSRF attacks by raising an exception.
-  # For APIs, you may want to use :null_session instead.
-  protect_from_forgery with: :exception
 end

data/spec/dummy/app/{assets/javascripts → javascript/packs}/application.js

@@ -5,9 +5,11 @@
 // or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
 //
 // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
 //
 // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
+//= require rails-ujs
+//= require activestorage
 //= require_tree .

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -1,4 +1,4 @@
 class ApplicationMailer < ActionMailer::Base
-  default from: "from@example.com"
+  default from: 'from@example.com'
   layout 'mailer'
 end

data/spec/dummy/app/mailers/test_mailer.rb

@@ -78,4 +78,16 @@ class TestMailer < ApplicationMailer
     substitute "%key2%", "value2"
     mail(body: "X")
   end
+
+  def template_with_substitutions_email(value)
+    set_template_id("XXX")
+    substitute "%key%", value
+    mail(to: "r1@platan.us", body: "X")
+  end
+
+  def dynamic_template_email(value)
+    set_template_id("XXX")
+    dynamic_template_data(key: value)
+    mail(to: "r1@platan.us")
+  end
 end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -1,14 +1,15 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
-  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
+  <head>
+    <title>Dummy</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
 
-<%= yield %>
+    <%= stylesheet_link_tag 'application', media: 'all' %>
+  </head>
 
-</body>
+  <body>
+    <%= yield %>
+  </body>
 </html>

data/spec/dummy/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application', __FILE__)
-require_relative '../config/boot'
-require 'rails/commands'
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/dummy/bin/rake

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require_relative '../config/boot'
-require 'rake'
+require_relative "../config/boot"
+require "rake"
 Rake.application.run