RubyGems - courrier - Versions diffs - 0.6.0 → 0.8.0 - Mend

courrier 0.6.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (41) hide show

checksums.yaml +4 -4
data/Gemfile.lock +1 -1
data/README.md +159 -26
data/app/controllers/courrier/previews/cleanups_controller.rb +13 -0
data/app/controllers/courrier/previews_controller.rb +23 -0
data/app/views/courrier/previews/index.html.erb +171 -0
data/config/routes.rb +8 -0
data/courrier.gemspec +3 -3
data/lib/courrier/configuration/{preview.rb → inbox.rb} +3 -3
data/lib/courrier/configuration.rb +32 -6
data/lib/courrier/email/options.rb +15 -0
data/lib/courrier/email/provider.rb +22 -17
data/lib/courrier/email/providers/base.rb +2 -1
data/lib/courrier/email/providers/{preview → inbox}/default.html.erb +13 -6
data/lib/courrier/email/providers/inbox.rb +83 -0
data/lib/courrier/email/providers/logger.rb +22 -3
data/lib/courrier/email/providers/loops.rb +1 -8
data/lib/courrier/email/providers/resend.rb +32 -0
data/lib/courrier/email/providers/userlist.rb +13 -13
data/lib/courrier/email.rb +54 -11
data/lib/courrier/engine.rb +7 -0
data/lib/courrier/errors.rb +3 -1
data/lib/courrier/jobs/email_delivery_job.rb +23 -0
data/lib/courrier/subscriber/base.rb +51 -0
data/lib/courrier/subscriber/beehiiv.rb +45 -0
data/lib/courrier/subscriber/buttondown.rb +28 -0
data/lib/courrier/subscriber/kit.rb +36 -0
data/lib/courrier/subscriber/loops.rb +32 -0
data/lib/courrier/subscriber/mailchimp.rb +39 -0
data/lib/courrier/subscriber/mailerlite.rb +28 -0
data/lib/courrier/subscriber/result.rb +41 -0
data/lib/courrier/subscriber.rb +34 -0
data/lib/courrier/tasks/courrier.rake +2 -2
data/lib/courrier/version.rb +1 -1
data/lib/courrier.rb +2 -0
data/lib/generators/courrier/email_generator.rb +24 -1
data/lib/generators/courrier/templates/email/password_reset.rb.tt +29 -0
data/lib/generators/courrier/templates/email/welcome.rb.tt +43 -0
data/lib/generators/courrier/templates/initializer.rb.tt +10 -5
metadata +26 -8
data/lib/courrier/email/providers/preview.rb +0 -51

data/lib/courrier/email/provider.rb CHANGED Viewed

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 require "courrier/email/providers/base"
+require "courrier/email/providers/inbox"
 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/resend"
 require "courrier/email/providers/sendgrid"
 require "courrier/email/providers/sparkpost"
 require "courrier/email/providers/userlist"
@@ -15,39 +16,43 @@ require "courrier/email/providers/userlist"
 module Courrier
   class Email
     class Provider
-      def initialize(provider: nil, api_key: nil, options: {}, provider_options: {})
+      PROVIDERS = {
+        inbox: Courrier::Email::Providers::Inbox,
+        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,
+        resend: Courrier::Email::Providers::Resend,
+        sendgrid: Courrier::Email::Providers::Sendgrid,
+        sparkpost: Courrier::Email::Providers::Sparkpost,
+        userlist: Courrier::Email::Providers::Userlist
+      }
+      def initialize(provider: nil, api_key: nil, options: {}, provider_options: {}, context_options: {})
         @provider = provider
         @api_key = api_key
         @options = options
         @provider_options = provider_options
+        @context_options = context_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?
+        raise Courrier::ConfigurationError, "Unknown provider. Choose one of `#{comma_separated_providers}` or provide your own." if @provider.nil? || @provider.to_s.strip.empty?
         provider_class.new(
           api_key: @api_key,
           options: @options,
-          provider_options: @provider_options
+          provider_options: @provider_options,
+          context_options: @context_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,
-        userlist: Courrier::Email::Providers::Userlist
-      }.freeze
       def configuration_missing_in_production?
         production? && required_attributes_blank?
       end

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

@@ -6,10 +6,11 @@ module Courrier
   class Email
     module Providers
       class Base
-        def initialize(api_key: nil, options: {}, provider_options: {})
+        def initialize(api_key: nil, options: {}, provider_options: {}, context_options: {})
           @api_key = api_key
           @options = options
           @provider_options = provider_options
+          @context_options = context_options
         end
         def deliver

data/lib/courrier/email/providers/{preview → inbox}/default.html.erb RENAMED Viewed

@@ -1,3 +1,10 @@
+<!--
+{
+  "to": "<%= email %>",
+  "subject": "<%= @options.subject %>"
+}
+-->
 <!DOCTYPE html>
 <html>
   <head>
@@ -6,7 +13,7 @@
     <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); }
+      body { margin: 0; padding: 0; 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%;
@@ -14,15 +21,15 @@
         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;
+        border-bottom-right-radius: 1rem; border-bottom-left-radius: 1rem;
       }
-      .email__header { display: flex; align-items: center; padding: 1rem .75rem; -moz-column-gap: .75rem; column-gap: .75rem; }
+      .email__header { display: flex; align-items: center; padding: .75rem; -moz-column-gap: .75rem; column-gap: .75rem; }
       .email__avatar {
         flex-shrink: 0;
         padding: .25rem;
-        width: 2.5rem; height: 2.5rem;
+        width: 2rem; height: 2rem;
         background-color: rgb(203, 213, 225);
         color: rgb(51, 65, 85);
         border-radius: 9999px;
@@ -39,14 +46,14 @@
       .email__datetime { font-size: .75rem; line-height: 1rem; color: rgb(148, 163, 184); }
       .email__subject {
-        margin-left: 4rem;
+        margin-left: 3.5rem;
         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; }
+      .email__preview { margin-top: .75rem; margin-left: 3.5rem; padding-bottom: 1rem; }
       .preview-toggle { display: none; }
       .preview-toggle-label {

data/lib/courrier/email/providers/inbox.rb ADDED Viewed

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+require "tmpdir"
+require "fileutils"
+require "launchy"
+module Courrier
+  class Email
+    module Providers
+      class Inbox < 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) if config.auto_open
+          "📮 Email saved to #{file_path} and #{email_destination}"
+        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(URL_PARSER.make_regexp(%w[http https])) do |url|
+            %(<a href="#{url}">#{url}</a>)
+          end
+        end
+        def config = @config ||= Courrier.configuration.inbox
+        def email_destination
+          return "opened in your default browser" if config.auto_open
+          path = begin
+            Rails.application.routes.url_helpers.courrier_path
+          rescue
+            "/courrier/ (Note: Add `mount Courrier::Engine => \"/courrier\"` to your routes.rb to enable proper routing)"
+          end
+          "available at #{path}"
+        end
+        URL_PARSER = (
+          defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER
+        )
+        class Email < Data.define(:path, :filename, :metadata)
+          Metadata = Data.define(:to, :subject)
+          def self.from_file(path)
+            content = File.read(path)
+            json = content[/<!--\s*(.*?)\s*-->/m, 1]
+            metadata = JSON.parse(json, symbolize_names: true)
+            new(
+              path: path,
+              filename: File.basename(path),
+              metadata: Metadata.new(**metadata)
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -21,9 +21,7 @@ module Courrier
           <<~EMAIL
             #{separator}
             Timestamp: #{Time.now.strftime("%Y-%m-%d %H:%M:%S %z")}
-            From:      #{@options.from}
-            To:        #{@options.to}
-            Subject:   #{@options.subject}
+            #{meta_fields(from: options)}
             Text:
             #{@options.text || "(empty)"}
@@ -35,6 +33,27 @@ module Courrier
         end
         def separator = "-" * 80
+        def meta_fields(from:)
+          fields = [
+            [:from, "From"],
+            [:to, "To"],
+            [:reply_to, "Reply-To"],
+            [:cc, "Cc"],
+            [:bcc, "Bcc"],
+            [:subject, "Subject"]
+          ]
+          fields.map do |field, label|
+            value = from.send(field)
+            next if value.nil? || value.to_s.strip.empty?
+            "#{label}:".ljust(11) + value
+          rescue NoMatchingPatternError
+            nil
+          end.compact.join("\n")
+        end
       end
     end
   end

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

@@ -22,14 +22,7 @@ module Courrier
           }
         end
-        def data_variables
-          {
-            "from" => @options.from,
-            "subject" => @options.subject,
-            "text_content" => @options.text,
-            "html_content" => @options.html
-          }.compact
-        end
+        def data_variables = @context_options.compact
       end
     end
   end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module Courrier
+  class Email
+    module Providers
+      class Resend < Base
+        ENDPOINT_URL = "https://api.resend.com/emails"
+        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 headers
+          {
+            "Authorization" => "Bearer #{@api_key}"
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -33,10 +33,17 @@ module Courrier
           end
         end
-        def text_document
+        def provider_options
+          {"theme" => nil}.merge(@provider_options)
+        end
+        def multipart_document
           {
-            "type" => "text",
-            "content" => @options.text
+            "type" => "multipart",
+            "content" => [
+              html_document,
+              text_document
+            ]
           }
         end
@@ -47,19 +54,12 @@ module Courrier
           }
         end
-        def multipart_document
+        def text_document
           {
-            "type" => "multipart",
-            "content" => [
-              html_document,
-              text_document
-            ]
+            "type" => "text",
+            "content" => @options.text
           }
         end
-        def provider_options
-          {"theme" => nil}.merge(@provider_options)
-        end
       end
     end
   end

data/lib/courrier/email.rb CHANGED Viewed

@@ -1,20 +1,23 @@
 # frozen_string_literal: true
 require "courrier/email/address"
+require "courrier/jobs/email_delivery_job" if defined?(Rails)
 require "courrier/email/layouts"
 require "courrier/email/options"
 require "courrier/email/provider"
 module Courrier
   class Email
-    attr_accessor :provider, :api_key, :default_url_options, :options
+    attr_accessor :provider, :api_key, :default_url_options, :options, :queue_options
+    @queue_options = {}
     class << self
       %w[provider api_key from reply_to cc bcc layouts default_url_options].each do |attribute|
         define_method(attribute) do
           instance_variable_get("@#{attribute}") ||
             (superclass.respond_to?(attribute) ? superclass.send(attribute) : nil) ||
-            Courrier.configuration&.send(attribute)
+            (["provider", "api_key"].include?(attribute) ? Courrier.configuration&.email&.[](attribute.to_sym) : Courrier.configuration&.send(attribute))
         end
         define_method("#{attribute}=") do |value|
@@ -22,20 +25,35 @@ module Courrier
         end
       end
-      def deliver(options = {})
-        new(options).deliver_now
-      end
-      alias_method :deliver_now, :deliver
       def configure(**options)
         options.each { |key, value| send("#{key}=", value) if respond_to?("#{key}=") }
       end
       alias_method :set, :configure
-      def layout(options = {})
+      def queue_options
+        @queue_options ||= {}
+      end
+      attr_writer :queue_options
+      def enqueue(**options)
+        self.queue_options = options
+      end
+      alias_method :enqueue_with, :enqueue
+      def layout(**options)
         self.layouts = options
       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
@@ -48,8 +66,8 @@ module Courrier
     end
     def initialize(options = {})
-      @provider = options[:provider] || ENV["COURRIER_PROVIDER"] || self.class.provider || Courrier.configuration&.provider
-      @api_key = options[:api_key] || ENV["COURRIER_API_KEY"] || self.class.api_key || Courrier.configuration&.api_key
+      @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)
       @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)
@@ -79,11 +97,36 @@ module Courrier
         provider: @provider,
         api_key: @api_key,
         options: @options,
-        provider_options: Courrier.configuration&.providers&.[](@provider.to_s.downcase.to_sym)
+        provider_options: Courrier.configuration&.providers&.[](@provider.to_s.downcase.to_sym),
+        context_options: @context_options
       ).deliver
     end
     alias_method :deliver_now, :deliver
+    def deliver_later
+      if delivery_disabled?
+        Courrier.configuration&.logger&.info "[Courrier] Email delivery skipped: delivery is disabled via environment variable"
+        return nil
+      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
     private
     def delivery_disabled?

data/lib/courrier/engine.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module Courrier
+  class Engine < ::Rails::Engine
+    isolate_namespace Courrier
+  end
+end

data/lib/courrier/errors.rb CHANGED Viewed

@@ -3,9 +3,11 @@
 module Courrier
   class Error < StandardError; end
+  class ConfigurationError < Error; end
   class ArgumentError < ::ArgumentError; end
   class NotImplementedError < ::NotImplementedError; end
-  class ConfigurationError < Error; end
+  class BackgroundDeliveryError < StandardError; end
 end

data/lib/courrier/jobs/email_delivery_job.rb ADDED Viewed

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module Courrier
+  module Jobs
+    class EmailDeliveryJob < ActiveJob::Base
+      def perform(data)
+        email_class = data[:email_class].constantize
+        email_class.new(
+          provider: data[:provider],
+          api_key: data[:api_key],
+          from: data[:options][:from],
+          to: data[:options][:to],
+          reply_to: data[:options][:reply_to],
+          cc: data[:options][:cc],
+          bcc: data[:options][:bcc],
+          provider_options: data[:provider_options],
+          context_options: data[:context_options]
+        ).deliver_now
+      end
+    end
+  end
+end

data/lib/courrier/subscriber/base.rb ADDED Viewed

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+require "courrier/subscriber/result"
+module Courrier
+  class Subscriber
+    class Base
+      def initialize(api_key:)
+        @api_key = api_key
+      end
+      def create(email)
+        raise NotImplementedError
+      end
+      def destroy(email)
+        raise NotImplementedError
+      end
+      private
+      def request(method, url, body = nil)
+        uri = URI(url)
+        request_class = case method
+        when :post then Net::HTTP::Post
+        when :delete then Net::HTTP::Delete
+        when :put then Net::HTTP::Put
+        when :patch then Net::HTTP::Patch
+        when :get then Net::HTTP::Get
+        end
+        request = request_class.new(uri)
+        request.body = body.to_json if body
+        headers.each { |key, value| request[key] = value }
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(request)
+        end
+        Courrier::Subscriber::Result.new(response: response)
+      rescue => error
+        Courrier::Subscriber::Result.new(error: error)
+      end
+      def headers
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/courrier/subscriber/beehiiv.rb ADDED Viewed

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require "courrier/subscriber/base"
+module Courrier
+  class Subscriber
+    class Beehiiv < Base
+      ENDPOINT_URL = "https://api.beehiiv.com/v2/publications"
+      def create(email)
+        publication_id = Courrier.configuration.subscriber[:publication_id]
+        raise Courrier::ConfigurationError, "Beehiiv requires `publication_id` in subscriber configuration" unless publication_id
+        request(:post, "#{ENDPOINT_URL}/#{publication_id}/subscriptions", {"email" => email})
+      end
+      def destroy(email)
+        publication_id = Courrier.configuration.subscriber[:publication_id]
+        raise Courrier::ConfigurationError, "Beehiiv requires `publication_id` in subscriber configuration" unless publication_id
+        subscription_id = subscription_id(publication_id, email)
+        return Courrier::Subscriber::Result.new(error: StandardError.new("Subscription not found")) unless subscription_id
+        request(:delete, "#{ENDPOINT_URL}/#{publication_id}/subscriptions/#{subscription_id}")
+      end
+      private
+      def subscription_id(publication_id, email)
+        response = request(:get, "#{ENDPOINT_URL}/#{publication_id}/subscriptions?email=#{email}")
+        return nil unless response.success?
+        response.data.dig("data", 0, "id")
+      end
+      def headers
+        {
+          "Authorization" => "Bearer #{@api_key}",
+          "Content-Type" => "application/json"
+        }
+      end
+    end
+  end
+end

data/lib/courrier/subscriber/buttondown.rb ADDED Viewed

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require "courrier/subscriber/base"
+module Courrier
+  class Subscriber
+    class Buttondown < Base
+      ENDPOINT_URL = "https://api.buttondown.email/v1/subscribers"
+      def create(email)
+        request(:post, ENDPOINT_URL, {"email" => email})
+      end
+      def destroy(email)
+        request(:delete, "#{ENDPOINT_URL}/#{email}")
+      end
+      private
+      def headers
+        {
+          "Authorization" => "Token #{@api_key}",
+          "Content-Type" => "application/json"
+        }
+      end
+    end
+  end
+end

data/lib/courrier/subscriber/kit.rb ADDED Viewed

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require "courrier/subscriber/base"
+module Courrier
+  class Subscriber
+    class Kit < Base
+      ENDPOINT_URL = "https://api.convertkit.com/v3/forms"
+      def create(email)
+        form_id = Courrier.configuration.subscriber[:form_id]
+        raise Courrier::ConfigurationError, "Kit requires `form_id` in subscriber configuration" unless form_id
+        request(:post, "#{ENDPOINT_URL}/#{form_id}/subscribe", {
+          "api_key" => @api_key,
+          "email" => email
+        })
+      end
+      def destroy(email)
+        request(:put, "https://api.convertkit.com/v3/unsubscribe", {
+          "api_secret" => @api_key,
+          "email" => email
+        })
+      end
+      private
+      def headers
+        {
+          "Content-Type" => "application/json"
+        }
+      end
+    end
+  end
+end