courrier 0.9.0 → 0.11.0

data/lib/courrier/email/providers/cloudflare.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Cloudflare < Base
+        def body
+          {
+            "from" => @options.from,
+            "to" => @options.to,
+            "reply_to" => @options.reply_to,
+            "cc" => @options.cc,
+            "bcc" => @options.bcc,
+            "subject" => @options.subject,
+            "text" => @options.text,
+            "html" => @options.html
+          }.compact
+        end
+
+        private
+
+        def endpoint_url
+          account_id = @provider_options.account_id
+          raise Courrier::ArgumentError, "Cloudflare requires an `account_id`" unless account_id
+
+          "https://api.cloudflare.com/client/v4/accounts/#{account_id}/email/sending/send"
+        end
+
+        def default_headers
+          {"Authorization" => "Bearer #{@api_key}"}
+        end
+      end
+    end
+  end
+end

data/lib/courrier/email/providers/lettermint.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Lettermint < Base
+        ENDPOINT_URL = "https://api.lettermint.co/v1/send"
+
+        def body
+          {
+            "route" => @provider_options.route,
+            "from" => @options.from,
+            "to" => @options.to.to_s.split(",").map(&:strip),
+            "cc" => @options.cc&.split(",")&.map(&:strip),
+            "bcc" => @options.bcc&.split(",")&.map(&:strip),
+            "reply_to" => @options.reply_to&.split(",")&.map(&:strip),
+            "subject" => @options.subject,
+            "html" => @options.html,
+            "text" => @options.text
+          }.compact
+        end
+
+        private
+
+        def default_headers
+          {"x-lettermint-token" => @api_key}
+        end
+      end
+    end
+  end
+end

data/lib/courrier/email/providers/loops.rb

@@ -16,7 +16,7 @@ module Courrier
 
         private
 
-        def headers
+        def default_headers
           {
             "Authorization" => "Bearer #{@api_key}"
           }

data/lib/courrier/email/providers/mailgun.rb

@@ -29,7 +29,7 @@ module Courrier
 
         def content_type = "multipart/form-data"
 
-        def headers
+        def default_headers
           {
             "Authorization" => "Basic #{Base64.strict_encode64("api:#{@api_key}")}"
           }

data/lib/courrier/email/providers/mailjet.rb

@@ -31,7 +31,7 @@ module Courrier
 
         private
 
-        def headers
+        def default_headers
           {
             "Authorization" => "Basic " + Base64.strict_encode64("#{@api_key}:#{@provider_options.api_secret}")
           }

data/lib/courrier/email/providers/mailpace.rb

@@ -21,7 +21,7 @@ module Courrier
 
         private
 
-        def headers
+        def default_headers
           {
             "MailPace-Server-Token" => @api_key
           }

data/lib/courrier/email/providers/postmark.rb

@@ -23,7 +23,7 @@ module Courrier
 
         private
 
-        def headers
+        def default_headers
           {
             "X-Postmark-Server-Token" => @api_key
           }

data/lib/courrier/email/providers/resend.rb

@@ -21,7 +21,7 @@ module Courrier
 
         private
 
-        def headers
+        def default_headers
           {
             "Authorization" => "Bearer #{@api_key}"
           }

data/lib/courrier/email/providers/sendgrid.rb

@@ -38,7 +38,7 @@ module Courrier
 
         private
 
-        def headers
+        def default_headers
           {
             "Authorization" => "Bearer #{@api_key}"
           }

data/lib/courrier/email/providers/ses.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Ses < Base
+        def deliver
+          uri = URI.parse("https://email.#{@provider_options[:region]}.amazonaws.com/v2/email/outbound-emails")
+
+          request = Net::HTTP::Post.new(uri)
+          default_headers.merge(@custom_headers).each { |name, value| request[name] = value }
+
+          sign!(request)
+
+          request.body = JSON.dump(body)
+
+          options = {use_ssl: uri.scheme == "https"}
+          response = Net::HTTP.start(uri.hostname, uri.port, options) { it.request(request) }
+
+          Courrier::Email::Result.new(response: response)
+        rescue => error
+          Courrier::Email::Result.new(error: error)
+        end
+
+        def body
+          {
+            "FromEmailAddress" => @options.from,
+            "Destination" => {
+              "ToAddresses" => Array(@options.to),
+              "CcAddresses" => @options.cc ? Array(@options.cc) : nil,
+              "BccAddresses" => @options.bcc ? Array(@options.bcc) : nil
+            }.compact,
+
+            "ReplyToAddresses" => @options.reply_to ? Array(@options.reply_to) : nil,
+            "Content" => {
+              "Simple" => {
+                "Subject" => {"Data" => @options.subject},
+
+                "Body" => {
+                  "Text" => {"Data" => @options.text},
+                  "Html" => {"Data" => @options.html}
+                }.compact
+              }
+            }
+          }.compact
+        end
+
+        private
+
+        def default_headers
+          {
+            "Content-Type" => "application/json",
+            "Accept" => "application/json"
+          }
+        end
+
+        def sign!(request)
+          require "aws-sigv4"
+
+          Aws::Sigv4::Signer.new(
+            service: "ses",
+            region: @provider_options[:region],
+            access_key_id: @provider_options[:access_key_id],
+            secret_access_key: @provider_options[:secret_access_key],
+            session_token: @provider_options[:session_token]
+          ).sign_request(
+            http_method: request.method,
+            url: request.uri.to_s,
+            headers: request.to_hash
+          ).headers.each { |name, value| request[name] = value }
+        end
+      end
+    end
+  end
+end

data/lib/courrier/email/providers/smtp2go.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Smtp2go < Base
+        ENDPOINT_URL = "https://api.smtp2go.com/v3/email/send"
+
+        def body
+          {
+            "sender" => @options.from,
+            "to" => @options.to.to_s.split(",").map(&:strip),
+            "cc" => @options.cc&.split(",")&.map(&:strip),
+            "bcc" => @options.bcc&.split(",")&.map(&:strip),
+            "subject" => @options.subject,
+            "html_body" => @options.html,
+            "text_body" => @options.text
+          }.compact
+        end
+
+        private
+
+        def default_headers
+          {"X-Smtp2go-Api-Key" => @api_key}
+        end
+      end
+    end
+  end
+end

data/lib/courrier/email/providers/sparkpost.rb

@@ -27,7 +27,7 @@ module Courrier
 
         private
 
-        def headers
+        def default_headers
           {
             "Authorization" => @api_key
           }

data/lib/courrier/email/providers/userlist.rb

@@ -17,7 +17,7 @@ module Courrier
 
         private
 
-        def headers
+        def default_headers
           {
             "Authorization" => "Push #{@api_key}"
           }

data/lib/courrier/email/request.rb

@@ -25,7 +25,7 @@ module Courrier
         options = {use_ssl: uri.scheme == "https"}
 
         begin
-          response = Net::HTTP.start(uri.hostname, uri.port, options) { _1.request(request) }
+          response = Net::HTTP.start(uri.hostname, uri.port, options) { it.request(request) }
 
           Result.new(response: response)
         rescue => error

data/lib/courrier/email/transformer.rb

@@ -11,30 +11,30 @@ module Courrier
 
       def to_text
         Nokogiri::HTML(@content)
-          .then { remove_unwanted_elements(_1) }
-          .then { process_links(_1) }
-          .then { preserve_line_breaks(_1) }
-          .then { clean_up(_1) }
+          .then { remove_unwanted_elements(it) }
+          .then { process_links(it) }
+          .then { preserve_line_breaks(it) }
+          .then { clean_up(it) }
       end
 
       private
 
       BLOCK_ELEMENTS = %w[p div h1 h2 h3 h4 h5 h6 pre blockquote li]
 
-      def remove_unwanted_elements(html) = html.tap { _1.css("script, style").remove }
+      def remove_unwanted_elements(html) = html.tap { it.css("script, style").remove }
 
       def process_links(html)
         html.tap do |document|
           document.css("a")
-            .select { valid?(_1) }
-            .reject { _1.text.strip.empty? || _1.text.strip == _1["href"] }
-            .each { _1.content = "#{_1.text.strip} (#{_1["href"]})" }
+            .select { valid?(it) }
+            .reject { it.text.strip.empty? || it.text.strip == it["href"] }
+            .each { it.content = "#{it.text.strip} (#{it["href"]})" }
         end
       end
 
       def preserve_line_breaks(html)
         html.tap do |document|
-          document.css(BLOCK_ELEMENTS.join(",")).each { _1.after("\n") }
+          document.css(BLOCK_ELEMENTS.join(",")).each { it.after("\n") }
         end
       end
 

data/lib/courrier/email.rb

@@ -3,8 +3,8 @@
 require "erb"
 
 require "courrier/email/address"
-require "courrier/jobs/email_delivery_job" if defined?(Rails)
 require "courrier/email/layouts"
+require "courrier/markdown"
 require "courrier/email/options"
 require "courrier/email/provider"
 
@@ -36,7 +36,11 @@ module Courrier
         @queue_options ||= {}
       end
 
-      attr_writer :queue_options
+      attr_writer :queue_options, :headers
+
+      def headers(**options)
+        options.empty? ? (@headers ||= {}) : @headers = options
+      end
 
       def enqueue(**options)
         self.queue_options = options
@@ -47,23 +51,29 @@ module Courrier
         self.layouts = options
       end
 
+      def before_deliver(&block)
+        (@before_deliver ||= []) << block
+      end
+
+      def after_deliver(&block)
+        (@after_deliver ||= []) << block
+      end
+
+      def before_deliver_callbacks
+        @before_deliver || []
+      end
+
+      def after_deliver_callbacks
+        @after_deliver || []
+      end
+
       def deliver(**options)
         new(options).deliver_now
       end
       alias_method :deliver_now, :deliver
 
-      def deliver_later(**options)
-        new(options).deliver_later
-      end
-
       def inherited(subclass)
         super
-
-        # If you read this and know how to move this Rails-specific logic somewhere
-        # else, e.g. `lib/courrier/railtie.rb`, open a PR ❤️
-        if defined?(Rails) && Rails.application
-          subclass.include Rails.application.routes.url_helpers
-        end
       end
     end
 
@@ -95,39 +105,22 @@ module Courrier
         return nil
       end
 
+      return nil if self.class.before_deliver_callbacks.any? { |callback| callback.call(self) == false }
+
       Provider.new(
         provider: @provider,
         api_key: @api_key,
         options: @options,
         provider_options: Courrier.configuration&.providers&.[](@provider.to_s.downcase.to_sym),
-        context_options: @context_options
-      ).deliver
-    end
-    alias_method :deliver_now, :deliver
+        context_options: @context_options,
+        custom_headers: self.class.headers
+      ).deliver.tap do |result|
+        Test.record(self, result)
 
-    def deliver_later
-      if delivery_disabled?
-        Courrier.configuration&.logger&.info "[Courrier] Email delivery skipped: delivery is disabled via environment variable"
-
-        return nil
+        self.class.after_deliver_callbacks.each { |callback| callback.call(self, result) }
       end
-
-      data = {
-        email_class: self.class.name,
-        provider: @provider,
-        api_key: @api_key,
-        options: @options.to_h,
-        provider_options: Courrier.configuration&.providers&.[](@provider.to_s.downcase.to_sym),
-        context_options: @context_options
-      }
-
-      job = Courrier::Jobs::EmailDeliveryJob
-      job = job.set(**self.class.queue_options) if self.class.queue_options.any?
-
-      job.perform_later(data)
-    rescue => error
-      raise Courrier::BackgroundDeliveryError, "Failed to enqueue email: #{error.message}"
     end
+    alias_method :deliver_now, :deliver
 
     private
 
@@ -137,7 +130,9 @@ module Courrier
 
     def method_missing(name, *)
       if name == :text || name == :html
-        render_template(name.to_s)
+        render_template(name.to_s).tap do |result|
+          return result || markdown_rendered if name == :html
+        end
       else
         @context_options[name]
       end
@@ -149,6 +144,23 @@ module Courrier
       File.exist?(template_path) ? ERB.new(File.read(template_path)).result(binding) : nil
     end
 
+    def render_markdown_template
+      %w[md markdown].each do |ext|
+        template_path = template_file_path(ext)
+
+        return ERB.new(File.read(template_path)).result(binding) if File.exist?(template_path)
+      end
+
+      nil
+    end
+
+    def markdown_rendered
+      return unless Courrier::Markdown.available?
+
+      markdown_content = render_markdown_template || (respond_to?(:markdown, true) ? markdown : nil)
+      Courrier::Markdown.render(markdown_content) if markdown_content
+    end
+
     def template_file_path(format)
       class_path = self.class.name.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase
 

data/lib/courrier/errors.rb

@@ -8,6 +8,4 @@ module Courrier
   class ArgumentError < ::ArgumentError; end
 
   class NotImplementedError < ::NotImplementedError; end
-
-  class BackgroundDeliveryError < StandardError; end
 end

data/lib/courrier/markdown.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Markdown
+    class << self
+      def available?
+        defined?(::Redcarpet) || defined?(::Kramdown) || defined?(::Commonmarker)
+      end
+
+      def render(text)
+        return unless available?
+
+        parser.parse(text.to_s)
+      end
+
+      private
+
+      def parser
+        @parser ||= available_parser.new
+      end
+
+      def available_parser
+        return RedcarpetParser if defined?(::Redcarpet)
+        return KramdownParser if defined?(::Kramdown)
+        return CommonmarkerParser if defined?(::Commonmarker)
+
+        Parser
+      end
+    end
+
+    class Parser
+      def parse(text) = text.to_s
+    end
+
+    class RedcarpetParser < Parser
+      def parse(text)
+        renderer = Redcarpet::Render::HTML.new
+        markdown = Redcarpet::Markdown.new(renderer)
+
+        markdown.render(text)
+      end
+    end
+
+    class KramdownParser < Parser
+      def parse(text) = Kramdown::Document.new(text).to_html
+    end
+
+    class CommonmarkerParser < Parser
+      def parse(text) = Commonmarker.to_html(text)
+    end
+  end
+end

data/lib/courrier/test.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Courrier
+  module Test
+    Delivery = Data.define(:email_class, :to, :from, :reply_to, :cc, :bcc, :subject, :body, :headers, :provider, :result, :timestamp) do
+      def success?
+        result.success?
+      end
+    end
+
+    class << self
+      def deliveries
+        @deliveries ||= []
+      end
+
+      def clear!
+        @deliveries = []
+      end
+
+      def record(email, result)
+        deliveries << Delivery.new(
+          email_class: email.class.name,
+          to: email.options.to,
+          from: email.options.from,
+          reply_to: email.options.reply_to,
+          cc: email.options.cc,
+          bcc: email.options.bcc,
+          subject: email.options.subject,
+          body: {text: email.options.text, html: email.options.html},
+          headers: email.class.headers,
+          provider: email.provider,
+          result: result,
+          timestamp: Time.now
+        )
+      end
+    end
+  end
+end

data/lib/courrier/test_helper.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Courrier
+  module TestHelper
+    def assert_emails_delivered(count)
+      actual = Test.deliveries.size
+
+      assert_equal count, actual, "Expected #{count} email(s) to be delivered, but #{actual} were delivered"
+    end
+
+    def assert_no_emails_delivered
+      assert_emails_delivered(0)
+    end
+
+    def assert_email_delivered(email_class = nil, to: nil, from: nil, subject: nil, provider: nil)
+      deliveries = Test.deliveries
+
+      matching = deliveries.find do |delivery|
+        match_email_class(email_class, delivery.email_class) &&
+          match_recipient(to, delivery.to) &&
+          match_recipient(from, delivery.from) &&
+          match_subject(subject, delivery.subject) &&
+          match_provider(provider, delivery.provider)
+      end
+
+      assert matching, assertion_message(email_class, to: to, from: from, subject: subject, provider: provider, deliveries: deliveries)
+    end
+
+    private
+
+    def match_email_class(expected, actual)
+      return true if expected.nil?
+
+      expected == actual || (expected.is_a?(Class) && actual == expected.name)
+    end
+
+    def match_recipient(expected, actual)
+      return true if expected.nil?
+
+      actual.to_s.include?(expected.to_s)
+    end
+
+    def match_subject(expected, actual)
+      return true if expected.nil?
+
+      actual.to_s.include?(expected.to_s)
+    end
+
+    def match_provider(expected, actual)
+      return true if expected.nil?
+
+      actual.to_s == expected.to_s
+    end
+
+    def assertion_message(email_class, to:, from:, subject:, provider:, deliveries:)
+      "Expected email matching #{[].tap do |criteria|
+        criteria << "email_class=#{email_class}" if email_class
+        criteria << "to=#{to}" if to
+        criteria << "from=#{from}" if from
+        criteria << "subject=#{subject}" if subject
+        criteria << "provider=#{provider}" if provider
+      end.join(", ")} but none found. #{deliveries.size} email(s) delivered."
+    end
+  end
+end

data/lib/courrier/version.rb

@@ -1,3 +1,3 @@
 module Courrier
-  VERSION = "0.9.0"
+  VERSION = "0.11.0"
 end

data/lib/courrier.rb

@@ -5,8 +5,8 @@ require "courrier/errors"
 require "courrier/configuration"
 require "courrier/email"
 require "courrier/subscriber"
-require "courrier/engine" if defined?(Rails)
-require "courrier/railtie" if defined?(Rails)
+require "courrier/test"
+require "courrier/test_helper"
 
 module Courrier
 end