courrier 0.11.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d793cbc73ad9612cbb5e010e6aed85f9885e41fc8b672d16f82a6d155f63b726
-  data.tar.gz: 1143fc17abc330c3f94192ec95aea7618583266491f109b62aee3178826ede97
+  metadata.gz: b0a97b8804b294b065433077d025cde44716b87821214649a6421cac278beca5
+  data.tar.gz: 814110bf00d835bfacb15bc8f59bdeb04a0cb7f7b572d4418c3fd901e98c1115
 SHA512:
-  metadata.gz: 64991e00fdb46c81164c29ffc7dc9de6078bcbc6cad12407355424f19f54e3a767e8732abf1438105d1f14b3ebe8ecf8367aa88bd7e53fadd7787fa8dd163609
-  data.tar.gz: eed7664f6a7211fc98e8cd53e0dc24ad1784e5373575c006feb04fb7d3a2706da3127c0db801b3c960697f774cd3df68df3622b975f365ed5fdfa211327aa3d3
+  metadata.gz: fc4503ec4cef48dbd12f67f093ccb3df9b29834d34b26f99af90b8020f9be2f7207b7629be79d50ba90af9b7b01c47e104568c1813b7b5296211ed788f453831
+  data.tar.gz: d50436d4e7417f481f3f2ad2cc59962b30f42fd60d471f7226128e02e04c0378c117968a8c64c8346a735af2e1dae843d1d0447bdb9ce91153850d9e67af1d83

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    courrier (0.11.0)
+    courrier (1.0.0)
       logger (>= 1.5, < 3)
       nokogiri (>= 1.18, < 2)
 

data/README.md

@@ -121,12 +121,10 @@ OrderEmail.deliver to: "recipient@railsdesigner.com",\
 ```
 
 
-Provider and API key settings can be overridden using environment variables (`COURRIER_PROVIDER` and `COURRIER_API_KEY`) for both global configuration and email class defaults.
-
 
 ## Custom headers
 
-Email classes can define custom HTTP headers that are sent with every email:
+Email classes can define custom headers that are sent with every email:
 ```ruby
 class OrderEmail < Courrier::Email
   headers list_unsubscribe_post: "List-Unsubscribe=One-Click"
@@ -194,6 +192,7 @@ end
 Courrier supports these transactional email providers:
 
 - [AWS SES](https://aws.amazon.com/ses/) — requires `aws-sigv4` gem
+- [Brevo](https://www.brevo.com/)
 - [Cloudflare Email Service](https://developers.cloudflare.com/email-service/)
 - [Lettermint](https://lettermint.co)
 - [Loops](https://loops.so)
@@ -209,56 +208,14 @@ Courrier supports these transactional email providers:
 
 ## More Features
 
-Additional functionality to help with development and testing:
-
-
-### Layout support
-
-Wrap your email content using layouts:
-```ruby
-class OrderEmail < Courrier::Email
- layout text: "%{content}\n\nThanks for your order!",
-        html: "<div>\n%{content}\n</div>"
-end
-```
-
-Using a method:
-```ruby
-class OrderEmail < Courrier::Email
-  layout html: :html_layout
-
-  def html_layout
-    <<~HTML
-      <div style='font-family: ui-sans-serif, system-ui;'>
-        %{content}
-      </div>
-    HTML
-  end
-end
-```
-
-Using a separate class:
-```ruby
-class OrderEmail < Courrier::Email
-  layout html: OrderLayout
-end
-
-class OrderLayout
-  self.call
-    <<~HTML
-      <div style='font-family: ui-sans-serif, system-ui;'>
-        %{content}
-      </div>
-    HTML
-  end
-end
-```
+Additional functionality to go beyond the basics:
 
 
 ### Template files
 
 Instead of defining `text` and `html` methods, you can create ERB template files:
 ```ruby
+# courrier/emails/order_email.rb
 class OrderEmail < Courrier::Email
   def subject = "Your order is ready!"
 
@@ -291,7 +248,7 @@ end
 
 ## Markdown support
 
-Courrier supports rendering markdown content to HTML when a markdown gem is available. Simply bundle any supported markdown gem (`redcarpet`, `kramdown` or `commonmarker`) and it will be used.
+Courrier supports rendering markdown to HTML. Bundle any supported markdown gem (`redcarpet`, `kramdown` or `commonmarker`) and it will be used.
 
 
 ### Markdown methods
@@ -336,6 +293,49 @@ Your order **#<%= order_id %>** is ready for pickup.
 Method definitions take precedence over template files. You can mix approaches. For example, define `text` in a method and use a markdown template for HTML content.
 
 
+### Layout support
+
+Wrap your email content using layouts:
+```ruby
+class OrderEmail < Courrier::Email
+ layout text: "%{content}\n\nThanks for your order!",
+        html: "<div>\n%{content}\n</div>"
+end
+```
+
+Using a method:
+```ruby
+class OrderEmail < Courrier::Email
+  layout html: :html_layout
+
+  def html_layout
+    <<~HTML
+      <div style='font-family: ui-sans-serif, system-ui;'>
+        %{content}
+      </div>
+    HTML
+  end
+end
+```
+
+Using a separate class:
+```ruby
+class OrderEmail < Courrier::Email
+  layout html: OrderLayout
+end
+
+class OrderLayout
+  self.call
+    <<~HTML
+      <div style='font-family: ui-sans-serif, system-ui;'>
+        %{content}
+      </div>
+    HTML
+  end
+end
+```
+
+
 ### Auto-generate text from HTML
 
 Automatically generate plain text versions from your HTML emails:
@@ -344,6 +344,22 @@ config.auto_generate_text = true  # defaults to false
 ```
 
 
+### Delivery callbacks
+
+Hook into the email delivery lifecycle with `before_deliver` and `after_deliver` callbacks:
+```ruby
+class OrderEmail < Courrier::Email
+  before_deliver do |email|
+    puts "Sending to #{email.options.to}"  # access email options, abort delivery by returning false
+  end
+
+  after_deliver do |email, result|
+    puts "Delivered: #{result.success?}"  # access email and delivery result
+  end
+end
+```
+
+
 ### Email address helper
 
 Compose email addresses with display names:
@@ -365,7 +381,7 @@ end
 Use Ruby's built-in Logger for development and testing:
 
 ```ruby
-config.provider = "logger"  # outputs emails to STDOUT
+config.email = { provider: "logger" }  # outputs emails to STDOUT
 config.logger = custom_logger  # optional: defaults to ::Logger.new($stdout)
 ```
 
@@ -385,7 +401,7 @@ end
 
 Then configure it:
 ```ruby
-config.provider = "CustomProvider"
+config.email = { provider: "CustomProvider" }
 ```
 
 Check the [existing providers](https://github.com/Rails-Designer/courrier/tree/main/lib/courrier/email/providers) for implementation examples.
@@ -449,27 +465,9 @@ Available assertions:
 - `assert_email_delivered(email_class, to:, from:, subject:, provider:)`; assert an email matching criteria was delivered
 
 
-### Delivery callbacks
-
-Hook into the email delivery lifecycle with `before_deliver` and `after_deliver` callbacks:
-```ruby
-class OrderEmail < Courrier::Email
-  before_deliver do |email|
-    puts "Sending to #{email.options.to}"  # access email options, abort delivery by returning false
-  end
-
-  after_deliver do |email, result|
-    puts "Delivered: #{result.success?}"  # access email and delivery result
-  end
-end
-```
-
-Callbacks are isolated per class (subclasses don't inherit parent callbacks).
-
-
 ## Newsletter subscriptions
 
-Manage subscribers across popular email marketing platforms:
+Use Courrier to manage subscribers across popular email marketing platforms:
 ```ruby
 Courrier.configure do |config|
   config.subscriber = {
@@ -497,6 +495,7 @@ end
 ### Supported providers
 
 - [Beehiiv](https://www.beehiiv.com/) - requires `publication_id`
+- [Brevo](https://www.brevo.com/) - accepts optional `list_ids`
 - [Buttondown](https://buttondown.com)
 - [Kit](https://kit.com/) (formerly ConvertKit) - requires `form_id`
 - [Loops](https://loops.so/)
@@ -513,6 +512,14 @@ config.subscriber = {
 }
 ```
 
+For Brevo, pass one or more list IDs when new contacts should be added to specific lists:
+```ruby
+config.subscriber = {
+  provider: "brevo",
+  api_key: "your_api_key",
+  list_ids: [12, 34]
+}
+```
 
 ### Custom providers
 

data/courrier.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.files = Dir["{bin,lib}/**/*", "Rakefile", "README.md", "courrier.gemspec", "Gemfile", "Gemfile.lock"]
 
-  spec.required_ruby_version = ">= 4.0.0"
+  spec.required_ruby_version = ">= 3.4.0"
 
   spec.add_dependency "logger", ">= 1.5", "< 3"
   spec.add_dependency "nokogiri", ">= 1.18", "< 2"

data/lib/courrier/configuration.rb

@@ -42,30 +42,6 @@ module Courrier
       @providers = Courrier::Configuration::Providers.new
     end
 
-    def provider
-      warn "[DEPRECATION] `provider` is deprecated. Use `email = { provider: '…' }` instead. Will be removed in 1.0.0"
-
-      @email[:provider]
-    end
-
-    def provider=(value)
-      warn "[DEPRECATION] `provider=` is deprecated. Use `email = { provider: '…' }` instead. Will be removed in 1.0.0"
-
-      @email[:provider] = value
-    end
-
-    def api_key
-      warn "[DEPRECATION] `api_key` is deprecated. Use `email = { api_key: '…' }` instead. Will be removed in 1.0.0"
-
-      @email[:api_key]
-    end
-
-    def api_key=(value)
-      warn "[DEPRECATION] `api_key=` is deprecated. Use `email = { api_key: '…' }` instead. Will be removed in 1.0.0"
-
-      @email[:api_key] = value
-    end
-
     private
 
     def default_email_path

data/lib/courrier/email/provider.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "courrier/email/providers/base"
+require "courrier/email/providers/brevo"
 require "courrier/email/providers/cloudflare"
 require "courrier/email/providers/lettermint"
 require "courrier/email/providers/logger"
@@ -20,6 +21,7 @@ module Courrier
   class Email
     class Provider
       PROVIDERS = {
+        brevo: Courrier::Email::Providers::Brevo,
         cloudflare: Courrier::Email::Providers::Cloudflare,
         logger: Courrier::Email::Providers::Logger,
         lettermint: Courrier::Email::Providers::Lettermint,

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

@@ -4,6 +4,8 @@ module Courrier
   class Email
     module Providers
       class Cloudflare < Base
+        def self.config_options = %w[account_id]
+
         def body
           {
             "from" => @options.from,

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

@@ -4,6 +4,8 @@ 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

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

@@ -4,6 +4,8 @@ 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")
 

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.rb

@@ -60,11 +60,17 @@ module Courrier
       end
 
       def before_deliver_callbacks
-        @before_deliver || []
+        return @before_deliver if @before_deliver
+        return superclass.before_deliver_callbacks if superclass.respond_to?(:before_deliver_callbacks)
+
+        []
       end
 
       def after_deliver_callbacks
-        @after_deliver || []
+        return @after_deliver if @after_deliver
+        return superclass.after_deliver_callbacks if superclass.respond_to?(:after_deliver_callbacks)
+
+        []
       end
 
       def deliver(**options)
@@ -78,8 +84,8 @@ module Courrier
     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)

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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: courrier
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Rails Designer
@@ -74,6 +74,7 @@ files:
 - lib/courrier/email/options.rb
 - lib/courrier/email/provider.rb
 - lib/courrier/email/providers/base.rb
+- lib/courrier/email/providers/brevo.rb
 - lib/courrier/email/providers/cloudflare.rb
 - lib/courrier/email/providers/lettermint.rb
 - lib/courrier/email/providers/logger.rb
@@ -96,6 +97,7 @@ files:
 - lib/courrier/subscriber.rb
 - lib/courrier/subscriber/base.rb
 - lib/courrier/subscriber/beehiiv.rb
+- lib/courrier/subscriber/brevo.rb
 - lib/courrier/subscriber/buttondown.rb
 - lib/courrier/subscriber/kit.rb
 - lib/courrier/subscriber/loops.rb
@@ -118,14 +120,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 4.0.0
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 3.6.7
 specification_version: 4
 summary: API-powered email delivery for Ruby apps
 test_files: []