courrier 0.5.0

data/lib/courrier/email/options.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "courrier/email/transformer"
+
+module Courrier
+  class Email
+    class Options
+      attr_reader :from, :to, :reply_to, :cc, :bcc, :subject
+
+      def initialize(options = {})
+        @from = options.fetch(:from, nil)
+
+        @to = options.fetch(:to, nil)
+        @reply_to = options.fetch(:reply_to, nil)
+        @cc = options.fetch(:cc, nil)
+        @bcc = options.fetch(:bcc, nil)
+
+        @subject = options.fetch(:subject, "")
+        @text = options.fetch(:text, "")
+        @html = options.fetch(:html, "")
+
+        @auto_generate_text = options.fetch(:auto_generate_text, false)
+
+        @layouts = Array(options[:layouts])
+
+        raise Courrier::ArgumentError, "Recipient (`to`) is required" unless @to
+        raise Courrier::ArgumentError, "Sender (`from`) is required" unless @from
+      end
+
+      def text = wrap(transformed_text, with_layout: :text)
+
+      def html = wrap(@html, with_layout: :html)
+
+      private
+
+      def wrap(content, with_layout:)
+        return content if content.nil? || content.empty?
+
+        @layouts.reduce(content) do |wrapped, layout_options|
+          layout = layout_options[with_layout]
+
+          next wrapped if !layout
+
+          layout % {content: wrapped}
+        end
+      end
+
+      def transformed_text
+        return Courrier::Email::Transformer.new(@html).to_text if @auto_generate_text
+
+        @text
+      end
+    end
+  end
+end

data/lib/courrier/email/provider.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "courrier/email/providers/base"
+require "courrier/email/providers/logger"
+require "courrier/email/providers/loops"
+require "courrier/email/providers/mailgun"
+require "courrier/email/providers/mailjet"
+require "courrier/email/providers/mailpace"
+require "courrier/email/providers/postmark"
+require "courrier/email/providers/preview"
+require "courrier/email/providers/sendgrid"
+require "courrier/email/providers/sparkpost"
+
+module Courrier
+  class Email
+    class Provider
+      def initialize(provider: nil, api_key: nil, options: {}, provider_options: {})
+        @provider = provider
+        @api_key = api_key
+        @options = options
+        @provider_options = provider_options
+      end
+
+      def deliver
+        raise Courrier::ConfigurationError, "`provider` and `api_key` must be configured for production environment" if configuration_missing_in_production?
+        raise Courrier::ConfigurationError, "Unknown provider. Choose one of `#{comma_separated_providers}` or provide your own." if @provider.empty? || @provider.nil?
+
+        provider_class.new(
+          api_key: @api_key,
+          options: @options,
+          provider_options: @provider_options
+        ).deliver
+      end
+
+      private
+
+      PROVIDERS = {
+        logger: Courrier::Email::Providers::Logger,
+        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,
+        preview: Courrier::Email::Providers::Preview,
+        sendgrid: Courrier::Email::Providers::Sendgrid,
+        sparkpost: Courrier::Email::Providers::Sparkpost
+      }.freeze
+
+      def configuration_missing_in_production?
+        production? && required_attributes_blank?
+      end
+
+      def comma_separated_providers = PROVIDERS.keys.join(", ")
+
+      def provider_class
+        return PROVIDERS[@provider.to_sym] if PROVIDERS.key?(@provider.to_sym)
+
+        Object.const_get(@provider)
+      end
+
+      def required_attributes_blank? = @api_key.empty?
+
+      def production?
+        defined?(Rails) && Rails.env.production?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "courrier/email/request"
+
+module Courrier
+  class Email
+    module Providers
+      class Base
+        def initialize(api_key: nil, options: {}, provider_options: {})
+          @api_key = api_key
+          @options = options
+          @provider_options = provider_options
+        end
+
+        def deliver
+          Request.new(
+            endpoint_url: endpoint_url,
+            body: body,
+            provider: provider,
+            headers: headers,
+            content_type: content_type
+          ).post
+        end
+
+        def body = raise Courrier::NotImplementedError, "Provider class must implement `body`"
+
+        private
+
+        def endpoint_url = self.class::ENDPOINT_URL
+
+        def content_type = "application/json"
+
+        def headers = {}
+
+        def provider = self.class.name.split("::").last
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module Courrier
+  class Email
+    module Providers
+      class Logger < Base
+        def deliver
+          logger = Courrier.configuration.logger
+          logger.formatter = proc do |_severity, _datetime, _progname, message|
+            "#{format_email_using(message)}\n"
+          end
+
+          logger.info(@options)
+        end
+
+        private
+
+        def format_email_using(options)
+          <<~EMAIL
+            #{separator}
+            Timestamp: #{Time.now.strftime("%Y-%m-%d %H:%M:%S %z")}
+            From:      #{@options.from}
+            To:        #{@options.to}
+            Subject:   #{@options.subject}
+
+            Text:
+            #{@options.text || "(empty)"}
+
+            HTML:
+            #{@options.html || "(empty)"}
+            #{separator}
+          EMAIL
+        end
+
+        def separator = "-" * 80
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Loops < Base
+        ENDPOINT_URL = "https://app.loops.so/api/v1/transactional"
+
+        def body
+          {
+            "email" => @options.to,
+            "transactionalId" => @provider_options.transactional_id || raise(Courrier::ArgumentError, "Loops requires a `transactionalId`"),
+            "dataVariables" => data_variables
+          }.compact
+        end
+
+        private
+
+        def headers
+          {
+            "Authorization" => "Bearer #{@api_key}"
+          }
+        end
+
+        def data_variables
+          {
+            "from" => @options.from,
+            "subject" => @options.subject,
+            "text_content" => @options.text,
+            "html_content" => @options.html
+          }.compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Mailgun < Base
+        ENDPOINT_URL = "https://api.mailgun.net/v3/%{domain}/messages"
+
+        def body
+          {
+            "from" => @options.from,
+
+            "to" => @options.to,
+            "h:Reply-To" => @options.reply_to,
+
+            "subject" => @options.subject,
+            "text" => @options.text,
+            "html" => @options.html
+          }.compact
+        end
+
+        private
+
+        def endpoint_url
+          domain = @provider_options.domain || raise(Courrier::ArgumentError, "Mailgun requires a `domain`")
+
+          ENDPOINT_URL % {domain: domain}
+        end
+
+        def content_type = "multipart/form-data"
+
+        def authentication_for(request) = request.basic_auth("api", @api_key)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Mailjet < Base
+        ENDPOINT_URL = "https://api.mailjet.com/v3.1/send"
+
+        def body
+          {
+            "Messages" => [
+              {
+                "From" => {
+                  "Email" => @options.from
+                },
+
+                "To" => [
+                  {
+                    "Email" => @options.to
+                  }
+                ],
+                "ReplyTo" => reply_to_object,
+
+                "Subject" => @options.subject,
+                "TextPart" => @options.text,
+                "HTMLPart" => @options.html
+              }.compact
+            ]
+          }
+        end
+
+        private
+
+        def headers
+          {
+            "Authorization" => "Basic " + Base64.strict_encode64("#{@api_key}:#{@provider_options.api_secret}")
+          }
+        end
+
+        def reply_to_object
+          return if @options.reply_to.nil?
+
+          {
+            "Email" => @options.reply_to
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Mailpace < Base
+        ENDPOINT_URL = "https://app.mailpace.com/api/v1/send"
+
+        def body
+          {
+            "from" => @options.from,
+
+            "to" => @options.to,
+            "replyto" => @options.reply_to,
+
+            "subject" => @options.subject,
+            "textbody" => @options.text,
+            "htmlbody" => @options.html
+          }.compact
+        end
+
+        private
+
+        def headers
+          {
+            "MailPace-Server-Token" => @api_key
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Postmark < Base
+        ENDPOINT_URL = "https://api.postmarkapp.com/email"
+
+        def body
+          {
+            "From" => @options.from,
+
+            "To" => @options.to,
+            "ReplyTo" => @options.reply_to,
+
+            "Subject" => @options.subject,
+            "TextBody" => @options.text,
+            "HtmlBody" => @options.html,
+
+            "MessageStream" => @provider_options.message_stream || "outbound"
+          }.compact
+        end
+
+        private
+
+        def headers
+          {
+            "X-Postmark-Server-Token" => @api_key
+          }
+        end
+      end
+    end
+  end
+end

data/lib/courrier/email/providers/preview/default.html.erb

@@ -0,0 +1,119 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title><%= @options.subject %></title>
+    <style>
+      *, *::before, *::after { box-sizing: border-box; }
+      * { margin: 0; padding: 0; }
+      body { margin: 0; padding: .5rem; line-height: 1.5; font-family: ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; background-color: rgb(241,  245, 249); }
+      pre { margin: 0; white-space: pre-wrap; }
+      .email {
+        width: 100%;
+        max-width: 65rem;
+        margin-left: auto; margin-right: auto;
+        background-color: #fff;
+        box-shadow: 0 20px 25px -5px rgba(0, 0, 0, 0.1), 0 8px 10px -6px rgb(0 0 0 / 0.1);
+        border-radius: 1rem;
+      }
+
+      .email__header { display: flex; align-items: center; padding: 1rem .75rem; -moz-column-gap: .75rem; column-gap: .75rem; }
+
+      .email__avatar {
+        flex-shrink: 0;
+        padding: .25rem;
+        width: 2.5rem; height: 2.5rem;
+        background-color: rgb(203, 213, 225);
+        color: rgb(51, 65, 85);
+        border-radius: 9999px;
+      }
+
+      .email__recipient { flex-grow: 1; font-size: .875rem; line-height: 1.25rem; }
+
+      .email__recipient-name { font-weight: 600; color: rgb(51, 65, 85); }
+
+      .email__metadata { display: flex; align-items: center; justify-content: space-between; }
+
+      .email__recipient-email { color: rgb(100, 116, 139); }
+
+      .email__datetime { font-size: .75rem; line-height: 1rem; color: rgb(148, 163, 184); }
+
+      .email__subject {
+        margin-left: 4rem;
+        font-size: 1.25rem; line-height: 1.75rem;
+        font-weight: 700;
+        letter-spacing: -.025em;
+        color: rgb(30, 41, 59)
+      }
+
+      .email__preview { margin-top: .75rem; margin-left: 4rem; padding: .5rem .25rem; }
+
+      .preview-toggle { display: none; }
+      .preview-toggle-label {
+        display: inline-block;
+        padding: .25rem .875rem;
+        font-size: .75rem; line-height: 1rem;
+        font-weight: 600;
+        color: rgb(30, 41, 59);
+        background-color: rgb(255, 255, 255);
+        border: 1px solid rgb(226, 232, 240);
+        border-radius: .375rem;
+        box-shadow: 0 1px 3px 0 rgb(0 0 0 / 0.1), 0 1px 2px -1px rgb(0 0 0 / 0.1);
+        cursor: pointer;
+
+        &:hover { border-color: rgb(203, 213, 225); }
+        &:active { transform: scale(.98); }
+      }
+      .preview-toggle[disabled] + .preview-toggle-label { opacity: 0.5; cursor: not-allowed; }
+
+      .email__preview-html, .email__preview-text { margin-top: 1.5rem;}
+      .email__preview-html { display: none; }
+      .preview-toggle:checked ~ .email__preview-text { display: none; }
+      .preview-toggle:checked ~ .email__preview-html { display: block; }
+    </style>
+  </head>
+  <body>
+    <article class="email">
+      <header class="email__header">
+        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="currentColor" aria-hidden="true" data-slot="icon" class="email__avatar">
+          <path fill-rule="evenodd" d="M7.5 6a4.5 4.5 0 1 1 9 0 4.5 4.5 0 0 1-9 0ZM3.751 20.105a8.25 8.25 0 0 1 16.498 0 .75.75 0 0 1-.437.695A18.683 18.683 0 0 1 12 22.5c-2.786 0-5.433-.608-7.812-1.7a.75.75 0 0 1-.437-.695Z" clip-rule="evenodd"/>
+        </svg>
+
+        <div class="email__recipient">
+          <% if name %>
+            <p class="email__recipient-name">
+              <%= name %>
+            </p>
+          <% end %>
+
+          <div class="email__metadata">
+            <p class="email__recipient-email">
+              <%= email %>
+            </p>
+
+            <time class="email__datetime" datetime="#{Time.now.strftime("%Y-%m-%d %H:%M:%S %z")}">
+              <%= Time.now.strftime("%Y-%m-%d %H:%M:%S %z") %>
+            </time>
+          </div>
+        </div>
+      </header>
+
+      <p class="email__subject">
+        <%= @options.subject %>
+      </p>
+
+      <div class="email__preview">
+        <input type="checkbox" id="preview-toggle" class="preview-toggle" <%= html ? "" : "disabled" %>>
+        <label for="preview-toggle" class="preview-toggle-label">Toggle HTML/Text</label>
+
+        <div class="email__preview-text">
+          <pre><%= text || "(no text content)" %></pre>
+        </div>
+
+        <div class="email__preview-html">
+          <%= html || "<p>(no HTML content)</p>" %>
+        </div>
+      </div>
+    </article>
+  </body>
+</html>

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "tmpdir"
+require "fileutils"
+require "launchy"
+
+module Courrier
+  class Email
+    module Providers
+      class Preview < Base
+        def deliver
+          FileUtils.mkdir_p(config.destination)
+
+          file_path = File.join(config.destination, "#{Time.now.to_i}.html")
+
+          File.write(file_path, ERB.new(File.read(config.template_path)).result(binding))
+
+          Launchy.open(file_path)
+
+          "Preview email saved to #{file_path}#{config.auto_open ? " and opened in browser" : ""}"
+        end
+
+        def name = extract(@options.to)[:name]
+
+        def email = extract(@options.to)[:email]
+
+        def text = prepare(@options.text)
+
+        def html = prepare(@options.html)
+
+        private
+
+        def extract(to)
+          if to.to_s =~ /(.*?)\s*<(.+?)>/
+            {name: $1.strip, email: $2.strip}
+          else
+            {name: nil, email: to.to_s.strip}
+          end
+        end
+
+        def prepare(content)
+          content.to_s.gsub(URI::DEFAULT_PARSER.make_regexp(%w[http https])) do |url|
+            %(<a href="#{url}">#{url}</a>)
+          end
+        end
+
+        def config = @config ||= Courrier.configuration.preview
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Sendgrid < Base
+        ENDPOINT_URL = "https://api.sendgrid.com/v3/mail/send"
+
+        def body
+          {
+            "from" => {
+              "email" => @options.from
+            },
+            "personalizations" => [
+              {
+                "to" => [
+                  {
+                    "email" => @options.to
+                  }
+                ]
+              }
+            ],
+            "reply_to" => reply_to_object,
+
+            "subject" => @options.subject,
+            "content" => [
+              {
+                "type" => "text/plain",
+                "value" => @options.text
+              },
+              {
+                "type" => "text/html",
+                "value" => @options.html
+              }
+            ].compact
+          }.compact
+        end
+
+        private
+
+        def headers
+          {
+            "Authorization" => "Bearer #{@api_key}"
+          }
+        end
+
+        def reply_to_object
+          return if @options.reply_to.nil?
+
+          {
+            "email" => @options.reply_to
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Email
+    module Providers
+      class Sparkpost < Base
+        ENDPOINT_URL = "https://api.sparkpost.com/api/v1/transmissions"
+
+        def body
+          {
+            "content" => {
+              "reply_to" => @options.reply_to,
+              "from" => @options.from,
+              "subject" => @options.subject,
+              "text" => @options.text,
+              "html" => @options.html
+            }.compact,
+            "recipients" => [
+              {
+                "address" => {
+                  "email" => @options.to
+                }
+              }
+            ]
+          }
+        end
+
+        private
+
+        def headers
+          {
+            "Authorization" => @api_key
+          }
+        end
+      end
+    end
+  end
+end