send_grid_mailer 0.1.0

data/Rakefile

@@ -0,0 +1,10 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+Bundler::GemHelper.install_tasks

data/lib/send_grid_mailer.rb

@@ -0,0 +1,27 @@
+require "colorize"
+require "sendgrid-ruby"
+require "send_grid_mailer/engine"
+
+module SendGridMailer
+  extend self
+
+  # You can add, in this module, your own configuration options as in the example below...
+  #
+  # attr_writer :my_option
+  #
+  # def my_option
+  #   return "Default Value" unless @my_option
+  #   @my_option
+  # end
+  #
+  # Then, you can customize the default behaviour (typically in a Rails initializer) like this:
+  #
+  # SendGridMailer.setup do |config|
+  #   config.root_url = "Another value"
+  # end
+
+  def setup
+    yield self
+    require "send_grid_mailer"
+  end
+end

data/lib/send_grid_mailer/definition.rb

@@ -0,0 +1,110 @@
+module SendGridMailer
+  class Definition
+    METHODS = [
+      :substitute,
+      :set_template_id,
+      :set_template_name,
+      :set_sender,
+      :set_recipients,
+      :set_subject,
+      :set_content,
+      :add_attachment,
+      :add_header,
+      :content?,
+      :sender?,
+      :subject?
+    ]
+
+    attr_accessor :template_name
+
+    def substitute(key, value, default = "")
+      personalization.substitutions = SendGrid::Substitution.new(
+        key: key, value: value.to_s || default)
+    end
+
+    def set_template_id(value)
+      return unless value
+      mail.template_id = value
+    end
+
+    def set_template_name(value)
+      return unless value
+      self.template_name = value
+    end
+
+    def set_sender(email)
+      return unless email
+      mail.from = SendGrid::Email.new(email: email)
+    end
+
+    def set_recipients(mode, *emails)
+      emails.flatten.each do |email|
+        next unless email
+        personalization.send("#{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)
+    end
+
+    def add_attachment(file, name, type, disposition = "inline", content_id = nil)
+      attachment = SendGrid::Attachment.new
+      attachment.content = Base64.strict_encode64(file)
+      attachment.type = type
+      attachment.filename = name
+      attachment.disposition = disposition
+      attachment.content_id = content_id
+      mail.attachments = attachment
+    end
+
+    def add_header(key, value)
+      return if !key || !value
+      personalization.headers = SendGrid::Header.new(key: key, value: value)
+    end
+
+    def to_json
+      mail.personalizations = personalization if personalization?
+      mail.to_json
+    end
+
+    def mail
+      @mail ||= SendGrid::Mail.new
+    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 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

@@ -0,0 +1,46 @@
+module SendGridMailer
+  class Deliverer
+    attr_accessor :settings
+
+    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)
+    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"
+        raise(SendGridMailer::Exception.new(
+                "Error trying to get templates. Status Code: #{response.status_code}"))
+      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?
+        raise(SendGridMailer::Exception.new(
+                "No template with name #{definition.template_name}"))
+      end
+    end
+
+    def sg_api
+      @sg_api ||= SendGrid::API.new(api_key: api_key)
+    end
+  end
+end

data/lib/send_grid_mailer/engine.rb

@@ -0,0 +1,23 @@
+module SendGridMailer
+  class Engine < ::Rails::Engine
+    isolate_namespace SendGridMailer
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: "spec/factories"
+    end
+
+    initializer "initialize" do
+      require_relative "./errors"
+      require_relative "./logger"
+      require_relative "./definition"
+      require_relative "./mail_message_ext"
+      require_relative "./mailer_base_ext"
+    end
+
+    initializer "add_sendgrid_deliverer", before: "action_mailer.set_configs" do
+      require_relative "./deliverer"
+      ActionMailer::Base.add_delivery_method(:sendgrid, SendGridMailer::Deliverer)
+    end
+  end
+end

data/lib/send_grid_mailer/errors.rb

@@ -0,0 +1,2 @@
+class SendGridMailer::Exception < ::Exception
+end

data/lib/send_grid_mailer/logger.rb

@@ -0,0 +1,99 @@
+module SendGridMailer
+  class Logger
+    attr_reader :definition
+
+    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),
+        "Substitutions" => log_pairs(personalization.substitutions),
+        "Headers" => log_pairs(personalization.headers),
+        "body" => log_contents,
+        "Attachments" => log_attachments
+      }
+
+      data = data.keys.map do |k|
+        d = data[k].to_s
+        "#{k.light_blue}: #{(d.blank? ? '-' : d).light_yellow}"
+      end.join("\n")
+
+      Rails.logger.info("\n#{data}")
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+    def log_result(response)
+      msg = "The E-mail was successfully sent :)\nStatus Code: #{response.status_code}".green
+
+      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.red
+      end
+
+      Rails.logger.info("\n#{msg}")
+      nil
+    end
+
+    private
+
+    def log_email(email)
+      email["email"]
+    end
+
+    def log_emails(origin)
+      emails = personalization.send(origin)
+      return if emails.blank?
+      emails.map do |email|
+        log_email(email)
+      end.join(", ")
+    end
+
+    def log_attachments
+      return if mail.attachments.blank?
+      mail.attachments.map do |f|
+        "\n\t#{f['filename']}"
+      end.join("")
+    end
+
+    def log_contents
+      return if mail.contents.blank?
+      mail.contents.map do |content|
+        "\n\ttype: #{content['type']}\n\tvalue: #{content['value']}"
+      end.join("")
+    end
+
+    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|
+        msg = []
+        msg << "#{error['field']}: " if error['field']
+        msg << error['message']
+        msg << " - help: #{error['help']}" if error['help']
+        "\n\t* #{msg.join('')}"
+      end.join("")
+    end
+
+    def personalization
+      definition.personalization
+    end
+  end
+end

data/lib/send_grid_mailer/mail_message_ext.rb

@@ -0,0 +1,7 @@
+module Mail
+  class Message
+    def sg_definition
+      @sg_definition ||= SendGridMailer::Definition.new
+    end
+  end
+end

data/lib/send_grid_mailer/mailer_base_ext.rb

@@ -0,0 +1,88 @@
+module ActionMailer
+  class Base < AbstractController::Base
+    alias_method :old_mail, :mail
+
+    SendGridMailer::Definition::METHODS.each do |method_name|
+      define_method(method_name) do |*args|
+        sg_definition.send(method_name, *args)
+      end
+    end
+
+    def mail(headers = {}, &_block)
+      return old_mail(headers, &_block) if self.class.delivery_method != :sendgrid
+      m = @_message
+
+      # Call all the procs (if any)
+      default_values = {}
+      self.class.default.each do |k, v|
+        default_values[k] = v.is_a?(Proc) ? instance_eval(&v) : v
+      end
+
+      # Handle defaults
+      headers = headers.reverse_merge(default_values)
+      headers[:subject] ||= default_i18n_subject
+
+      define_sg_mail(headers)
+
+      wrap_delivery_behavior!
+      @_mail_was_called = true
+      m
+    end
+
+    private
+
+    def define_sg_mail(params = {})
+      set_sender(params[:from]) unless sender?
+      set_recipients(:to, params[:to])
+      set_recipients(:cc, params[:cc])
+      set_recipients(:bcc, params[:bcc])
+      set_subject(params[:subject]) unless subject?
+      set_body(params)
+      add_attachments
+      add_headers(params.fetch(:headers, {}))
+    end
+
+    def add_attachments
+      attachments.each do |attachment|
+        add_attachment(
+          attachment.read,
+          attachment.filename,
+          attachment.content_type.to_s.split(";").first,
+          ((attachment.content_disposition =~ /inline/) ? 'inline' : 'attachment'),
+          attachment.content_id
+        )
+      end
+    end
+
+    def add_headers(heads = {})
+      heads.keys.each { |key| add_header(key, heads[key]) }
+      @_message.header.fields.each { |field| add_header(field.name, field.value) }
+    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
+
+    def set_body_from_tpl(params)
+      templates_path = params.delete(:template_path) || self.class.mailer_name
+      templates_name = params.delete(:template_name) || action_name
+
+      paths = Array(templates_path)
+      template = lookup_context.find_all(templates_name, paths).first
+
+      raise ActionView::MissingTemplate.new(
+        paths, templates_name, paths, false, 'mailer') unless template
+
+      set_content(render(template: template), template.type.to_s)
+    end
+
+    def sg_definition
+      @_message.sg_definition
+    end
+  end
+end

data/lib/send_grid_mailer/version.rb

@@ -0,0 +1,3 @@
+module SendGridMailer
+  VERSION = "0.1.0"
+end

data/lib/tasks/send_grid_mailer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :send_grid_mailer do
+#   # Task goes here
+# end

data/send_grid_mailer.gemspec

@@ -0,0 +1,31 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem"s version:
+require "send_grid_mailer/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name          = "send_grid_mailer"
+  s.version       = SendGridMailer::VERSION
+  s.authors       = ["Platanus", "Leandro Segovia"]
+  s.email         = ["rubygems@platan.us", "ldlsegovia@gmail.com"]
+  s.homepage      = "https://github.com/platanus/send_grid_mailer"
+  s.summary       = "Action Mailer adapter for using SendGrid"
+  s.description   = "Is an Action Mailer adapter for using SendGrid in a Rails application"
+  s.license       = "MIT"
+
+  s.files = `git ls-files`.split($/).reject { |fn| fn.start_with? "spec" }
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.test_files = Dir["spec/**/*"]
+
+  s.add_dependency "rails", "~> 4.2", ">= 4.2.0"
+  s.add_dependency "sendgrid-ruby", "~> 4.0", ">= 4.0.4"
+  s.add_dependency "colorize", "~> 0.7", ">= 0.7.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"
+end