courrier 0.10.0 → 1.0.0

data/lib/courrier/email/provider.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "courrier/email/providers/base"
-require "courrier/email/providers/inbox"
+require "courrier/email/providers/brevo"
+require "courrier/email/providers/cloudflare"
+require "courrier/email/providers/lettermint"
 require "courrier/email/providers/logger"
 require "courrier/email/providers/loops"
 require "courrier/email/providers/mailgun"
@@ -9,7 +11,9 @@ require "courrier/email/providers/mailjet"
 require "courrier/email/providers/mailpace"
 require "courrier/email/providers/postmark"
 require "courrier/email/providers/resend"
+require "courrier/email/providers/ses"
 require "courrier/email/providers/sendgrid"
+require "courrier/email/providers/smtp2go"
 require "courrier/email/providers/sparkpost"
 require "courrier/email/providers/userlist"
 
@@ -17,15 +21,19 @@ module Courrier
   class Email
     class Provider
       PROVIDERS = {
-        inbox: Courrier::Email::Providers::Inbox,
+        brevo: Courrier::Email::Providers::Brevo,
+        cloudflare: Courrier::Email::Providers::Cloudflare,
         logger: Courrier::Email::Providers::Logger,
+        lettermint: Courrier::Email::Providers::Lettermint,
         loops: Courrier::Email::Providers::Loops,
         mailgun: Courrier::Email::Providers::Mailgun,
         mailjet: Courrier::Email::Providers::Mailjet,
         mailpace: Courrier::Email::Providers::Mailpace,
         postmark: Courrier::Email::Providers::Postmark,
         resend: Courrier::Email::Providers::Resend,
+        ses: Courrier::Email::Providers::Ses,
         sendgrid: Courrier::Email::Providers::Sendgrid,
+        smtp2go: Courrier::Email::Providers::Smtp2go,
         sparkpost: Courrier::Email::Providers::Sparkpost,
         userlist: Courrier::Email::Providers::Userlist
       }
@@ -72,7 +80,7 @@ module Courrier
       end
 
       def api_key_required_providers?
-        !%w[logger inbox].include?(@provider.to_s)
+        !%w[logger].include?(@provider.to_s)
       end
 
       def api_key_blank?
@@ -80,7 +88,7 @@ module Courrier
       end
 
       def production?
-        defined?(Rails) && Rails.env.production?
+        ENV["RACK_ENV"] == "production"
       end
     end
   end

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

@@ -6,6 +6,8 @@ module Courrier
   class Email
     module Providers
       class Base
+        def self.config_options = []
+
         def initialize(api_key: nil, options: {}, provider_options: {}, context_options: {}, custom_headers: {})
           @api_key = api_key
           @options = options

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Brevo < Base
+        ENDPOINT_URL = "https://api.brevo.com/v3/smtp/email"
+
+        def body
+          {
+            "sender" => email_address(@options.from),
+            "to" => email_addresses(@options.to),
+            "cc" => email_addresses(@options.cc),
+            "bcc" => email_addresses(@options.bcc),
+            "replyTo" => email_address(@options.reply_to),
+            "subject" => @options.subject,
+            "htmlContent" => @options.html,
+            "textContent" => @options.text
+          }.compact
+        end
+
+        private
+
+        def default_headers = {"api-key" => @api_key}
+
+        def email_addresses(addresses)
+          addresses&.split(",")&.map { |address| email_address(address) }
+        end
+
+        def email_address(address)
+          {"email" => address.strip} if address
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Cloudflare < Base
+        def self.config_options = %w[account_id]
+
+        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,33 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Lettermint < Base
+        def self.config_options = %w[route]
+
+        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

@@ -4,6 +4,8 @@ module Courrier
   class Email
     module Providers
       class Loops < Base
+        def self.config_options = %w[transactional_id]
+
         ENDPOINT_URL = "https://app.loops.so/api/v1/transactional"
 
         def body

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

@@ -4,6 +4,8 @@ module Courrier
   class Email
     module Providers
       class Mailgun < Base
+        def self.config_options = %w[domain]
+
         ENDPOINT_URL = "https://api.mailgun.net/v3/%{domain}/messages"
 
         def body

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

@@ -4,6 +4,8 @@ module Courrier
   class Email
     module Providers
       class Mailjet < Base
+        def self.config_options = %w[api_secret]
+
         ENDPOINT_URL = "https://api.mailjet.com/v3.1/send"
 
         def body

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

@@ -4,6 +4,8 @@ module Courrier
   class Email
     module Providers
       class Postmark < Base
+        def self.config_options = %w[message_stream]
+
         ENDPOINT_URL = "https://api.postmarkapp.com/email"
 
         def body

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Ses < Base
+        def self.config_options = %w[region access_key_id secret_access_key session_token]
+
+        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/userlist.rb

@@ -4,6 +4,8 @@ module Courrier
   class Email
     module Providers
       class Userlist < Base
+        def self.config_options = %w[theme]
+
         ENDPOINT_URL = "https://push.userlist.com/messages"
 
         def body

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,7 +3,6 @@
 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"
@@ -52,29 +51,41 @@ 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
+        return @before_deliver if @before_deliver
+        return superclass.before_deliver_callbacks if superclass.respond_to?(:before_deliver_callbacks)
+
+        []
+      end
+
+      def after_deliver_callbacks
+        return @after_deliver if @after_deliver
+        return superclass.after_deliver_callbacks if superclass.respond_to?(:after_deliver_callbacks)
+
+        []
+      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
 
     def initialize(options = {})
-      @provider = options[:provider] || ENV["COURRIER_PROVIDER"] || self.class.provider || Courrier.configuration&.email&.[](:provider)
-      @api_key = options[:api_key] || ENV["COURRIER_API_KEY"] || self.class.api_key || Courrier.configuration&.email&.[](:api_key)
+      @provider = options[:provider] || self.class.provider || Courrier.configuration&.email&.[](:provider)
+      @api_key = options[:api_key] || self.class.api_key || Courrier.configuration&.email&.[](:api_key)
 
       @default_url_options = self.class.default_url_options.merge(options[:default_url_options] || {})
       @context_options = options.except(:provider, :api_key, :from, :to, :reply_to, :cc, :bcc, :subject, :text, :html)
@@ -100,6 +111,8 @@ 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,
@@ -107,33 +120,13 @@ module Courrier
         provider_options: Courrier.configuration&.providers&.[](@provider.to_s.downcase.to_sym),
         context_options: @context_options,
         custom_headers: self.class.headers
-      ).deliver
-    end
-    alias_method :deliver_now, :deliver
+      ).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
 

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/subscriber/brevo.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "uri"
+require "courrier/subscriber/base"
+
+module Courrier
+  class Subscriber
+    class Brevo < Base
+      ENDPOINT_URL = "https://api.brevo.com/v3/contacts"
+
+      def create(email)
+        body = {
+          "email" => email,
+          "updateEnabled" => true
+        }
+
+        list_ids = Array(Courrier.configuration.subscriber[:list_ids]).compact
+        body["listIds"] = list_ids unless list_ids.empty?
+
+        request(:post, ENDPOINT_URL, body)
+      end
+
+      def destroy(email)
+        identifier = URI.encode_www_form_component(email)
+
+        request(:delete, "#{ENDPOINT_URL}/#{identifier}")
+      end
+
+      private
+
+      def headers
+        {
+          "api-key" => @api_key,
+          "Content-Type" => "application/json"
+        }
+      end
+    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.10.0"
+  VERSION = "1.0.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