send_grid_mailer 0.5.0 → 2.0.0

data/lib/send_grid_mailer/engine.rb

@@ -4,20 +4,24 @@ 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
       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
 
-    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/errors.rb

@@ -1,2 +1,21 @@
-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
+      error_message = errors.map { |err| err['message'] }.join('. ')
+      super("Sendgrid API error. Code: #{error_code}. Errors: #{error_message}")
+    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,72 +1,75 @@
 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(status_code, api_call_type)
+      log("Succesfully called the SendGrid API :)\nStatus Code: #{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, api_call_type)
+      msg = "There was a problem calling the SendGrid API :(\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.presence || '-'}"
+      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|
         log_email(email)
       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']}"
       end.join("")
@@ -74,17 +77,14 @@ module SendGridMailer
 
     def log_pairs(hash)
       return if hash.blank?
+
       hash.keys.map do |k|
         "\n\t#{k} => #{hash[k]}"
       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 +92,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
+      deliverer&.new&.deliver!(sg_definition)
     end
 
     private
@@ -60,11 +57,12 @@ 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])
       return if sg_definition.content?
+
       set_body_from_tpl(params)
     end
 
@@ -83,7 +81,20 @@ module ActionMailer
     end
 
     def sg_definition
-      @_message.sg_definition
+      @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?
+      [: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 = "0.5.0"
+  VERSION = "2.0.0"
 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

@@ -44,11 +44,6 @@ class TestMailer < ApplicationMailer
     mail
   end
 
-  def template_name_email
-    set_template_name("my template name")
-    mail(body: "X")
-  end
-
   def template_id_params_email
     mail(template_id: "XXX")
   end
@@ -83,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