send_grid_mailer 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fc4e94f60e1028da201de83ef0e353105a1135b
-  data.tar.gz: a6e7a11542b6160bbdf77b3313bb09fca37a4d34
+  metadata.gz: d8269564f91417e0b4e8813c6be1db5f04be828a
+  data.tar.gz: b49dbc23ca7b63e7f8be14c8a47340bb0cda26ad
 SHA512:
-  metadata.gz: 18c31da2785607f422c4bacb5a4454a0852f32865f42aa1a2826f93e25d27ecf003dea9a547dceac7e3a8d44eeabbaaf45009dbdbdb2b03d7d8de19fc340f6fd
-  data.tar.gz: 22ebd4fc60adc44d42a4be3fa0fa8716248f63cc69aacb3d506a5787553145023f41234af415ec4d7c4b15bd6fc0f63fa05a2ab4160f58be3e1e5bc54b4ca234
+  metadata.gz: 420118f02069b82f5a6779f481dfb32a0181e29e191b64c31f7afed86fcd4df8b361c7433128ce1504175b3459a47e1de84de119397e4c5bdfdf5d4848290161
+  data.tar.gz: 75f581ffef9bdba13de8fa9c4790ebd0fef055d2aef4f38f987966b73d962cb678e4f67dd2a7d52497faf2bff163143d8ed56a9ea4f727ae2c68f1ddb0e33efc

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+### 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

@@ -141,11 +141,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 +159,31 @@ class TestMailer < ApplicationMailer
 end
 ```
 
-> Remember: you need to specify al least: `body`, `template`, `template name` or a Rails template.
+> 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
 

data/lib/send_grid_mailer/api.rb

@@ -0,0 +1,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)
+    end
+
+    private
+
+    def handle_response(response)
+      if response.status_code.to_i != SUCCESS_CODE
+        errors = response_errors(response)
+        log_api_error_response(response.status_code, errors)
+        raise SendGridMailer::ApiError.new(response.status_code, errors)
+      end
+
+      log_api_success_response(response)
+      response
+    end
+
+    def response_errors(response)
+      JSON.parse(response.body)["errors"]
+    end
+
+    def sg_api
+      @sg_api ||= SendGrid::API.new(api_key: @api_key)
+    end
+  end
+end

data/lib/send_grid_mailer/definition.rb

@@ -3,7 +3,6 @@ module SendGridMailer
     METHODS = [
       :substitute,
       :set_template_id,
-      :set_template_name,
       :set_sender,
       :set_recipients,
       :set_subject,
@@ -12,8 +11,6 @@ module SendGridMailer
       :add_header
     ]
 
-    attr_reader :template_name
-
     def substitute(key, value, default = "")
       personalization.substitutions = SendGrid::Substitution.new(
         key: key, value: value.to_s || default
@@ -25,11 +22,6 @@ module SendGridMailer
       mail.template_id = value
     end
 
-    def set_template_name(value)
-      return unless value
-      @template_name = value
-    end
-
     def set_sender(email)
       return unless email
       matched_format = email.match(/<(.+)>/)
@@ -84,6 +76,10 @@ module SendGridMailer
       @mail ||= SendGrid::Mail.new
     end
 
+    def clean_recipients(mode)
+      personalization.instance_variable_set("@#{mode}s", nil)
+    end
+
     def personalization
       @personalization ||= SendGrid::Personalization.new
     end
@@ -97,7 +93,5 @@ module SendGridMailer
     def subject?; !personalization.subject.blank? end
 
     def template_id?; !mail.template_id.blank? end
-
-    def template_name?; !template_name.blank? 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/engine.rb

@@ -10,8 +10,10 @@ module SendGridMailer
     initializer "initialize" do
       require_relative "./errors"
       require_relative "./logger"
+      require_relative "./api"
+      require_relative "./interceptors_handler"
+      require_relative "./interceptor/recipient_interceptor"
       require_relative "./definition"
-      require_relative "./mail_message_ext"
       require_relative "./mailer_base_ext"
     end
 

data/lib/send_grid_mailer/errors.rb

@@ -1,2 +1,20 @@
-class SendGridMailer::Exception < ::Exception
+module SendGridMailer
+  class Error < RuntimeError
+  end
+
+  class InvalidApiKey < Error
+    def initialize
+      super("the SendGrid API key is invalid or missing")
+    end
+  end
+
+  class ApiError < Error
+    attr_reader :error_code, :errors
+
+    def initialize(error_code, errors)
+      @error_code = error_code
+      @errors = errors
+      super("sendgrid api error")
+    end
+  end
 end

data/lib/send_grid_mailer/interceptor/recipient_interceptor.rb

@@ -0,0 +1,42 @@
+module SendGridMailer
+  module Interceptor
+    module RecipientInterceptor
+      def self.perform(sg_definition, interceptor)
+        add_custom_headers(sg_definition)
+        add_recipients(sg_definition, interceptor)
+        add_subject_prefix(sg_definition, interceptor)
+      end
+
+      def self.exec_recipients_interceptor(sg_definition, interceptor)
+        add_custom_headers(sg_definition)
+        add_recipients(sg_definition, interceptor)
+        add_subject_prefix(sg_definition, interceptor)
+      end
+
+      def self.add_subject_prefix(sg_definition, interceptor)
+        subject_prefix = interceptor.instance_variable_get(:@subject_prefix)
+        subject = [subject_prefix, sg_definition.personalization.subject].join(" ").strip
+        sg_definition.set_subject(subject)
+      end
+
+      def self.add_recipients(sg_definition, interceptor)
+        recipients = interceptor.instance_variable_get(:@recipients)
+        sg_definition.clean_recipients(:to)
+        sg_definition.clean_recipients(:cc)
+        sg_definition.clean_recipients(:bcc)
+        sg_definition.set_recipients(:to, recipients)
+      end
+
+      def self.add_custom_headers(sg_definition)
+        {
+          'X-Intercepted-To' => sg_definition.personalization.tos || [],
+          'X-Intercepted-Cc' => sg_definition.personalization.ccs || [],
+          'X-Intercepted-Bcc' => sg_definition.personalization.bccs || []
+        }.each do |header, addresses|
+          addresses_str = addresses.map { |a| a["email"] }.join(", ")
+          sg_definition.add_header(header, addresses_str)
+        end
+      end
+    end
+  end
+end

data/lib/send_grid_mailer/interceptors_handler.rb

@@ -0,0 +1,14 @@
+module SendGridMailer
+  module InterceptorsHandler
+    def execute_interceptors(sg_definition)
+      registered_interceptors.each do |interceptor|
+        interceptor_class = "SendGridMailer::Interceptor::#{interceptor.class}".constantize
+        interceptor_class.perform(sg_definition, interceptor)
+      end
+    end
+
+    def registered_interceptors
+      ::Mail.class_variable_get(:@@delivery_interceptors)
+    end
+  end
+end

data/lib/send_grid_mailer/logger.rb

@@ -1,56 +1,55 @@
 module SendGridMailer
-  class Logger
-    attr_reader :definition
+  module Logger
+    def log_definition(definition)
+      mail = definition.mail
+      personalization = definition.personalization
 
-    def initialize(definition)
-      @definition = definition
-    end
-
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-    def log_definition
       data = {
         "Subject" => personalization.subject,
         "Template ID" => mail.template_id,
         "From" => log_email(mail.from),
-        "To" => log_emails(:tos),
-        "Cc" => log_emails(:ccs),
-        "Bcc" => log_emails(:bccs),
+        "To" => log_emails(personalization, :tos),
+        "Cc" => log_emails(personalization, :ccs),
+        "Bcc" => log_emails(personalization, :bccs),
         "Substitutions" => log_pairs(personalization.substitutions),
         "Headers" => log_pairs(personalization.headers),
-        "body" => log_contents,
-        "Attachments" => log_attachments
+        "body" => log_contents(mail),
+        "Attachments" => log_attachments(mail)
       }
 
-      data = data.keys.map do |k|
-        d = data[k].to_s
-        "#{k}: #{(d.blank? ? '-' : d)}"
-      end.join("\n")
+      log(build_definition_message(data))
+    end
 
-      Rails.logger.info("\n#{data}")
+    def log_api_success_response(response)
+      log("The E-mail was successfully sent :)\nStatus Code: #{response.status_code}")
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
-    def log_result(response)
-      msg = "The E-mail was successfully sent :)\nStatus Code: #{response.status_code}"
+    def log_api_error_response(status_code, errors)
+      msg = "The E-mail was not sent :(\nStatus Code: #{status_code}\nErrors:"
+      msg += log_errors(errors)
+      log(msg)
+    end
 
-      if response.status_code != "202"
-        msg = "The E-mail was not sent :(\nStatus Code: #{response.status_code}\nErrors:"
-        msg += log_errors(response.body)
-        msg = msg
-      end
+    private
 
+    def log(msg)
       Rails.logger.info("\n#{msg}")
       nil
     end
 
-    private
+    def build_definition_message(data)
+      data = data.keys.map do |k|
+        d = data[k].to_s
+        "#{k}: #{(d.blank? ? '-' : d)}"
+      end.join("\n")
+    end
 
     def log_email(email)
       return if email.blank?
       email["email"]
     end
 
-    def log_emails(origin)
+    def log_emails(personalization, origin)
       emails = personalization.send(origin)
       return if emails.blank?
       emails.map do |email|
@@ -58,14 +57,14 @@ module SendGridMailer
       end.join(", ")
     end
 
-    def log_attachments
+    def log_attachments(mail)
       return if mail.attachments.blank?
       mail.attachments.map do |f|
         "\n\t#{f['filename']}"
       end.join("")
     end
 
-    def log_contents
+    def log_contents(mail)
       return if mail.contents.blank?
       mail.contents.map do |content|
         "\n\ttype: #{content['type']}\n\tvalue: #{content['value']}"
@@ -79,12 +78,8 @@ module SendGridMailer
       end.join("")
     end
 
-    def mail
-      definition.mail
-    end
-
-    def log_errors(body)
-      JSON.parse(body)["errors"].map do |error|
+    def log_errors(errors)
+      errors.map do |error|
         msg = []
         msg << "#{error['field']}: " if error['field']
         msg << error['message']
@@ -92,9 +87,5 @@ module SendGridMailer
         "\n\t* #{msg.join('')}"
       end.join("")
     end
-
-    def personalization
-      definition.personalization
-    end
   end
 end

data/lib/send_grid_mailer/mailer_base_ext.rb

@@ -9,8 +9,7 @@ module ActionMailer
     end
 
     def mail(headers = {}, &_block)
-      return old_mail(headers, &_block) if self.class.delivery_method != :sendgrid
-      m = @_message
+      return old_mail(headers, &_block) unless enabled_sendgrid?
 
       # Call all the procs (if any)
       default_values = {}
@@ -24,9 +23,7 @@ module ActionMailer
 
       define_sg_mail(headers)
 
-      wrap_delivery_behavior!
-      @_mail_was_called = true
-      m
+      SendGridMailer::Deliverer.new.deliver!(sg_definition)
     end
 
     private
@@ -60,7 +57,6 @@ module ActionMailer
     end
 
     def set_body(params)
-      return if sg_definition.template_name?
       set_template_id(params[:template_id])
       return if sg_definition.template_id?
       set_content(params[:body], params[:content_type])
@@ -83,7 +79,11 @@ module ActionMailer
     end
 
     def sg_definition
-      @_message.sg_definition
+      @sg_definition ||= SendGridMailer::Definition.new
+    end
+
+    def enabled_sendgrid?
+      self.class.delivery_method == :sendgrid
     end
   end
 end