courrier 0.6.0 → 0.8.0

data/lib/courrier/subscriber/loops.rb

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

data/lib/courrier/subscriber/mailchimp.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "courrier/subscriber/base"
+
+module Courrier
+  class Subscriber
+    class Mailchimp < Base
+      def create(email)
+        dc = Courrier.configuration.subscriber[:dc]
+        list_id = Courrier.configuration.subscriber[:list_id]
+
+        raise Courrier::ConfigurationError, "Mailchimp requires `dc` and `list_id` in subscriber configuration" unless dc && list_id
+
+        request(:post, "https://#{dc}.api.mailchimp.com/3.0/lists/#{list_id}/members", {
+          "email_address" => email,
+          "status" => "subscribed"
+        })
+      end
+
+      def destroy(email)
+        dc = Courrier.configuration.subscriber[:dc]
+        list_id = Courrier.configuration.subscriber[:list_id]
+
+        raise Courrier::ConfigurationError, "Mailchimp requires `dc` and `list_id` in subscriber configuration" unless dc && list_id
+
+        request(:delete, "https://#{dc}.api.mailchimp.com/3.0/lists/#{list_id}/members/#{email}")
+      end
+
+      private
+
+      def headers
+        {
+          "Authorization" => "Bearer #{@api_key}",
+          "Content-Type" => "application/json"
+        }
+      end
+    end
+  end
+end

data/lib/courrier/subscriber/mailerlite.rb

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

data/lib/courrier/subscriber/result.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Subscriber
+    class Result
+      attr_reader :success, :response, :data, :error
+
+      def initialize(response: nil, error: nil)
+        @response = response
+        @error = error
+        @data = parsed(@response&.body)
+        @success = successful?
+      end
+
+      def success? = @success
+
+      private
+
+      def parsed(body)
+        return {} if @response.nil?
+
+        begin
+          JSON.parse(body)
+        rescue JSON::ParserError
+          {}
+        end
+      end
+
+      def successful?
+        return false if response_failed?
+        return @data["success"] if @data.key?("success")
+
+        (200..299).cover?(status_code)
+      end
+
+      def response_failed? = @error || @response.nil?
+
+      def status_code = @response.code.to_i
+    end
+  end
+end

data/lib/courrier/subscriber.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Courrier
+  class Subscriber
+    class << self
+      def create(email)
+        provider.create(email)
+      end
+      alias_method :add, :create
+
+      def destroy(email)
+        provider.destroy(email)
+      end
+      alias_method :delete, :destroy
+
+      private
+
+      def provider
+        @provider ||= provider_class.new(
+          api_key: Courrier.configuration.subscriber[:api_key]
+        )
+      end
+
+      def provider_class
+        provider_name = Courrier.configuration.subscriber[:provider]
+
+        return provider_name if provider_name.is_a?(Class)
+        require "courrier/subscriber/#{provider_name}"
+
+        Object.const_get("Courrier::Subscriber::#{provider_name.capitalize}")
+      end
+    end
+  end
+end

data/lib/courrier/tasks/courrier.rake

@@ -1,13 +1,13 @@
 namespace :tmp do
   task :courrier do
-    rm_rf Dir["#{Courrier.configuration.preview.destination}/[^.]*"], verbose: false
+    rm_rf Dir["#{Courrier.configuration.inbox.destination}/[^.]*"], verbose: false
   end
 
   task clear: :courrier
 end
 
 namespace :courrier do
-  desc "Clear preview email files from `#{Courrier.configuration.preview.destination}`"
+  desc "Clear email files from `#{Courrier.configuration.inbox.destination}`"
 
   task clear: "tmp:courrier"
 end

data/lib/courrier/version.rb

@@ -1,3 +1,3 @@
 module Courrier
-  VERSION = "0.6.0"
+  VERSION = "0.8.0"
 end

data/lib/courrier.rb

@@ -4,6 +4,8 @@ require "courrier/version"
 require "courrier/errors"
 require "courrier/configuration"
 require "courrier/email"
+require "courrier/subscriber"
+require "courrier/engine" if defined?(Rails)
 require "courrier/railtie" if defined?(Rails)
 
 module Courrier

data/lib/generators/courrier/email_generator.rb

@@ -1,5 +1,7 @@
 module Courrier
   class EmailGenerator < Rails::Generators::NamedBase
+    AVAILABLE_TEMPLATES = %w[welcome password_reset]
+
     desc "Create a new Courrier Email class"
 
     source_root File.expand_path("templates", __dir__)
@@ -7,13 +9,34 @@ module Courrier
     check_class_collision suffix: "Email"
 
     class_option :skip_suffix, type: :boolean, default: false
+    class_option :template, type: :string, desc: "Template type (#{AVAILABLE_TEMPLATES.join(", ")})"
 
     def copy_mailer_file
-      template "email.rb", File.join(Courrier.configuration.email_path, class_path, "#{file_name}#{options[:skip_suffix] ? "" : "_email"}.rb")
+      template template_file, destination_path
     end
 
     private
 
+    def file_name = super.delete_suffix("_email")
+
     def parent_class = defined?(ApplicationEmail) ? ApplicationEmail : Courrier::Email
+
+    def template_file
+      if options[:template] && template_exists?("email/#{options[:template]}.rb.tt")
+        "email/#{options[:template]}.rb.tt"
+      else
+        "email.rb.tt"
+      end
+    end
+
+    def destination_path
+      File.join(Courrier.configuration.email_path, class_path, "#{file_name}#{options[:skip_suffix] ? "" : "_email"}.rb")
+    end
+
+    def template_exists?(path)
+      find_in_source_paths(path)
+    rescue
+      nil
+    end
   end
 end

data/lib/generators/courrier/templates/email/password_reset.rb.tt

@@ -0,0 +1,29 @@
+# Usage:
+#
+# PasswordResetEmail.deliver to: user.email, reset_url: edit_password_url(user.password_reset_token)
+#
+class <%= class_name %><%= options[:skip_suffix] ? "" : "Email" %> < <%= parent_class %>
+  def subject = "Reset your password"
+
+  def text
+    <<~TEXT
+      You can reset your password within the next 15 minutes on this password reset page:
+      #{reset_url}
+
+      If you didn't request a password reset, please ignore this email.
+    TEXT
+  end
+
+  def html
+    <<~HTML
+      <p>
+        You can reset your password within the next 15 minutes on
+        <a href="#{reset_url}">this password reset page</a>.
+      </p>
+
+      <p>
+        If you didn't request a password reset, please ignore this email.
+      </p>
+    HTML
+  end
+end

data/lib/generators/courrier/templates/email/welcome.rb.tt

@@ -0,0 +1,43 @@
+# Usage:
+#
+# WelcomeEmail.deliver to: user.email, name: "John", login_url: "https://example.com/login"
+#
+class <%= class_name %><%= options[:skip_suffix] ? "" : "Email" %> < <%= parent_class %>
+  def subject = "Welcome to My First App, #{name}!"
+
+  def text
+    <<~TEXT
+      Welcome, #{name}!
+
+      We're excited to have you on board. Here's how to get started:
+
+      1. Log in to your account: #{login_url}
+      2. Complete your profile
+      3. Explore our features
+
+      If you have any questions, our help center is available to assist you.
+
+      Thanks for joining us!
+    TEXT
+  end
+
+  def html
+    <<~HTML
+      <p>Welcome, #{name}!</p>
+
+      <p>We're excited to have you on board. Here's how to get started:</p>
+
+      <ol>
+        <li><a href="#{login_url}">Log in to your account</a></li>
+        <li>Complete your profile</li>
+        <li>Explore our features</li>
+      </ol>
+
+      <p>If you have any questions, our help center is available to assist you.</p>
+
+      <p>
+        Thanks for joining us!
+      </p>
+    HTML
+  end
+end

data/lib/generators/courrier/templates/initializer.rb.tt

@@ -1,12 +1,17 @@
 Courrier.configure do |config|
   include Courrier::Email::Address
 
-  # Choose your email delivery provider
-  # Default: `logger`
-  # config.provider = ""
+  # Set your email delivery provider
+  # config.email = {
+    # provider = "", # default, `logger`, choose from: <%= Courrier::Email::Provider::PROVIDERS.keys.join(", ") %>
+    # api_key = "" your transactional email provider's API key
+  }
+
+  # Set your marketing email provider
+  # config.subscriber = {
+    # provider = ""
+  }
 
-  # Add your email provider's API key
-  # config.api_key = ""
 
   # Configure provider-specific settings
   # config.providers.loops.transactional_id = ""

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: courrier
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Rails Designer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-12 00:00:00.000000000 Z
+date: 2025-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: launchy
@@ -50,8 +50,8 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
-description: Modern, API-powered email delivery for Ruby apps with support for Postmark,
-  SendGrid, Mailgun and more.
+description: API-powered email delivery for Ruby apps with support for Postmark, SendGrid,
+  Mailgun and more.
 email:
 - devs@railsdesigner.com
 executables: []
@@ -62,13 +62,17 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- app/controllers/courrier/previews/cleanups_controller.rb
+- app/controllers/courrier/previews_controller.rb
+- app/views/courrier/previews/index.html.erb
 - bin/console
 - bin/release
 - bin/setup
+- config/routes.rb
 - courrier.gemspec
 - lib/courrier.rb
 - lib/courrier/configuration.rb
-- lib/courrier/configuration/preview.rb
+- lib/courrier/configuration/inbox.rb
 - lib/courrier/configuration/providers.rb
 - lib/courrier/email.rb
 - lib/courrier/email/address.rb
@@ -76,27 +80,41 @@ files:
 - lib/courrier/email/options.rb
 - lib/courrier/email/provider.rb
 - lib/courrier/email/providers/base.rb
+- lib/courrier/email/providers/inbox.rb
+- lib/courrier/email/providers/inbox/default.html.erb
 - lib/courrier/email/providers/logger.rb
 - lib/courrier/email/providers/loops.rb
 - lib/courrier/email/providers/mailgun.rb
 - lib/courrier/email/providers/mailjet.rb
 - lib/courrier/email/providers/mailpace.rb
 - lib/courrier/email/providers/postmark.rb
-- lib/courrier/email/providers/preview.rb
-- lib/courrier/email/providers/preview/default.html.erb
+- lib/courrier/email/providers/resend.rb
 - lib/courrier/email/providers/sendgrid.rb
 - lib/courrier/email/providers/sparkpost.rb
 - lib/courrier/email/providers/userlist.rb
 - lib/courrier/email/request.rb
 - lib/courrier/email/result.rb
 - lib/courrier/email/transformer.rb
+- lib/courrier/engine.rb
 - lib/courrier/errors.rb
+- lib/courrier/jobs/email_delivery_job.rb
 - lib/courrier/railtie.rb
+- lib/courrier/subscriber.rb
+- lib/courrier/subscriber/base.rb
+- lib/courrier/subscriber/beehiiv.rb
+- lib/courrier/subscriber/buttondown.rb
+- lib/courrier/subscriber/kit.rb
+- lib/courrier/subscriber/loops.rb
+- lib/courrier/subscriber/mailchimp.rb
+- lib/courrier/subscriber/mailerlite.rb
+- lib/courrier/subscriber/result.rb
 - lib/courrier/tasks/courrier.rake
 - lib/courrier/version.rb
 - lib/generators/courrier/email_generator.rb
 - lib/generators/courrier/install_generator.rb
 - lib/generators/courrier/templates/email.rb.tt
+- lib/generators/courrier/templates/email/password_reset.rb.tt
+- lib/generators/courrier/templates/email/welcome.rb.tt
 - lib/generators/courrier/templates/initializer.rb.tt
 homepage: https://railsdesigner.com/courrier/
 licenses:
@@ -122,5 +140,5 @@ requirements: []
 rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
-summary: Modern, API-powered email delivery for Rails apps
+summary: API-powered email delivery for Ruby apps
 test_files: []

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

@@ -1,51 +0,0 @@
-# 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