send_grid_mailer 0.5.0 → 2.0.0

data/.ruby-version

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

data/CHANGELOG.md

@@ -2,6 +2,45 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+### 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
+
+* Detailed API errors
+
+### v1.0.0
+
+##### Added
+
+* Implement "a version" of Recipients Interceptor https://github.com/croaky/recipient_interceptor compatible with SendGrid.
+* Raise exceptions when api fails.
+
+##### Removed
+
+* Remove ability to set templates by name
+
 ### v0.5.0
 
 ##### Changed

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:
@@ -141,11 +151,6 @@ class TestMailer < ApplicationMailer
     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
@@ -164,7 +169,53 @@ class TestMailer < ApplicationMailer
 end
 ```
 
-> Remember: you need to specify al least: `body`, `template`, `template name` or a Rails template.
+#### 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
+
+This gem is compatible with [Recipient Interceptor gem](https://github.com/croaky/recipient_interceptor/tree/v0.1.2).
+However, this gem only uses its configuration. Internally, we modify the behaviour to play nice with [sengrid-ruby](https://github.com/sendgrid/sendgrid-ruby) gem.
+So, the current code is based on [Recipient Interceptor v0.1.2](https://github.com/croaky/recipient_interceptor/tree/v0.1.2). New versions may not work.
+
+To make it work...
+
+Add to your Gemfile:
+
+```ruby
+gem "send_grid_mailer"
+gem "recipient_interceptor"
+```
+
+In, for example, your `/my-project/config/environments/development.rb` file:
+
+```ruby
+Mail.register_interceptor RecipientInterceptor.new(
+  ENV["EMAIL_RECIPIENTS"],
+  subject_prefix: '[STAGING]'
+)
+```
 
 ## Testing
 
@@ -176,6 +227,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

@@ -0,0 +1,42 @@
+module SendGridMailer
+  class Api
+    include Logger
+
+    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, :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, api_call_type)
+      status_code = response.status_code.to_i
+      if status_code.between?(400, 600)
+        errors = response_errors(response)
+        log_api_error_response(status_code, errors, api_call_type)
+        raise SendGridMailer::ApiError.new(status_code, errors)
+      end
+
+      log_api_success_response(status_code, api_call_type)
+      response
+    end
+
+    def response_errors(response)
+      body = JSON.parse(response.body)
+      body["errors"] || [{ "message" => body["error"] }]
+    end
+
+    def sg_api
+      @sg_api ||= SendGrid::API.new(api_key: @api_key)
+    end
+  end
+end

data/lib/send_grid_mailer/definition.rb

@@ -2,36 +2,36 @@ module SendGridMailer
   class Definition
     METHODS = [
       :substitute,
+      :dynamic_template_data,
       :set_template_id,
-      :set_template_name,
       :set_sender,
       :set_recipients,
       :set_subject,
       :set_content,
       :add_attachment,
-      :add_header
+      :add_header,
+      :add_category
     ]
 
-    attr_reader :template_name
-
     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 set_template_id(value)
-      return unless value
-      mail.template_id = value
+    def dynamic_template_data(object)
+      personalization.add_dynamic_template_data(object)
     end
 
-    def set_template_name(value)
+    def set_template_id(value)
       return unless value
-      @template_name = value
+
+      mail.template_id = value
     end
 
     def set_sender(email)
       return unless email
+
       matched_format = email.match(/<(.+)>/)
       if matched_format
         address = matched_format[1]
@@ -45,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)
@@ -67,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
 
@@ -84,20 +94,22 @@ module SendGridMailer
       @mail ||= SendGrid::Mail.new
     end
 
+    def clean_recipients(mode)
+      personalization.instance_variable_set("@#{mode}s", [])
+    end
+
     def personalization
       @personalization ||= SendGrid::Personalization.new
     end
 
     def personalization?; !personalization.to_json.empty? end
 
-    def content?; !mail.contents.blank? end
-
-    def sender?; !mail.from.blank? end
+    def content?; mail.contents.present? end
 
-    def subject?; !personalization.subject.blank? end
+    def sender?; mail.from.present? end
 
-    def template_id?; !mail.template_id.blank? end
+    def subject?; personalization.subject.present? end
 
-    def template_name?; !template_name.blank? end
+    def template_id?; mail.template_id.present? end
   end
 end

data/lib/send_grid_mailer/deliverer.rb

@@ -1,47 +1,24 @@
 module SendGridMailer
   class Deliverer
-    attr_accessor :settings
+    include InterceptorsHandler
+    include Logger
 
-    def initialize(settings)
-      self.settings = settings.merge(return_response: true)
-    end
-
-    def api_key
-      settings[:api_key] || raise(SendGridMailer::Exception.new("Missing sendgrid API key"))
-    end
-
-    def deliver!(msg)
-      set_template_id_from_name(msg.sg_definition)
-      logger = SendGridMailer::Logger.new(msg.sg_definition)
-      logger.log_definition
-      response = sg_api.client.mail._('send').post(request_body: msg.sg_definition.to_json)
-      logger.log_result(response)
-      response
+    def deliver!(sg_definition)
+      execute_interceptors(sg_definition)
+      log_definition(sg_definition)
+      sg_api.send_mail(sg_definition)
     end
 
     private
 
-    def set_template_id_from_name(definition)
-      return unless definition.template_name
-      response = sg_api.client.templates.get
-
-      if response.status_code != "200"
-        m = "Error trying to get templates. Status Code: #{response.status_code}"
-        raise SendGridMailer::Exception.new(m)
-      end
-
-      JSON.parse(response.body)["templates"].each do |tpl|
-        definition.set_template_id(tpl["id"]) if tpl["name"] == definition.template_name
-      end
-
-      if !definition.template_id?
-        m = "No template with name #{definition.template_name}"
-        raise SendGridMailer::Exception.new(m)
-      end
+    def sg_api
+      @sg_api ||= Api.new(api_key)
     end
 
-    def sg_api
-      @sg_api ||= SendGrid::API.new(api_key: api_key)
+    def api_key
+      Rails.application.config.action_mailer.sendgrid_settings[:api_key]
+    rescue
+      nil
     end
   end
 end

data/lib/send_grid_mailer/dev_deliverer.rb

@@ -0,0 +1,70 @@
+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
+      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