brevo-extras 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a72266c6461dcf2931b8e1db860f7c2b292fb67a12e447974f8f3f2fe38232b7
+  data.tar.gz: 8a0179c5cb72befd993590538b828dd2149e8c24c02fb0249e30e9868f8df2ea
+SHA512:
+  metadata.gz: 5dcd2ea1fbd345dd700c4746390cb608203bc4a3dd12bbe7f8b02eef8c03e37e460364816325e4c466da61a58a0abad8991828854ff95b40b4532f0610e20daf
+  data.tar.gz: c9a2f577a21cd4a3ac4126d8b194ed1b6aa2fa634cd24d89a96441ac02d3230e18fae8893632ed34c3eb7fb7823a13a1b2957f021242ed353aee7b6b2cde3f37

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Bruno Perles
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,113 @@
+[![CI](https://github.com/atnos/brevo-extras/actions/workflows/ci.yml/badge.svg)](https://github.com/atnos/brevo-extras/actions/workflows/ci.yml)
+[![CodeQL](https://github.com/atnos/brevo-extras/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/atnos/brevo-extras/actions/workflows/github-code-scanning/codeql)
+[![Dependabot Updates](https://github.com/atnos/brevo-extras/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/atnos/brevo-extras/actions/workflows/dependabot/dependabot-updates)
+
+# Brevo::Extras
+
+A Rails engine that provides a clean abstraction layer for sending transactional emails via the [Brevo](https://www.brevo.com/) API, with built-in safety features to prevent accidental email delivery in development and test environments.
+
+## Features
+
+- Abstract base class for creating email sender classes
+- Asynchronous delivery via Active Job
+- Automatic retry on API errors with polynomial backoff
+- **Sandbox mode** - prevents actual email delivery (enabled by default)
+- **Safe mode** - filters recipients by allowed domains (enabled by default in local environments)
+- Template-based emails with parameters
+- Reply-to address support
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "brevo-extras", github: "atnos/brevo-extras"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Configuration
+
+The engine is configured through environment variables:
+
+| Variable | Default | Description |
+|---|---|---|
+| `BREVO_SANDBOX_MODE` | `"1"` | When enabled, adds `X-Sib-Sandbox: drop` header so Brevo accepts the request but does not send the email |
+| `BREVO_SAFE_MODE` | `"1"` | When enabled, filters recipients to only allowed domains. Always active in local Rails environments (`development`, `test`) regardless of this setting |
+| `BREVO_SAFE_MODE_ALLOWED_DOMAINS` | `""` | Comma-separated list of allowed email domains (e.g. `"example.com,mycompany.com"`) |
+
+You also need to configure the Brevo API key as required by the [brevo gem](https://github.com/getbrevo/brevo-ruby).
+
+## Usage
+
+### Creating an email sender
+
+Subclass `Brevo::Extras::Base` and implement the `#call` method:
+
+```ruby
+class WelcomeEmail < Brevo::Extras::Base
+  def call
+    send_email(
+      template_id: 1,
+      to: [{ email: params[:email], name: params[:name] }]
+    )
+  end
+end
+```
+
+### Sending an email
+
+```ruby
+WelcomeEmail.call(email: "user@example.com", name: "John")
+```
+
+The email is enqueued as an Active Job and delivered asynchronously.
+
+### Reply-to support
+
+```ruby
+send_email(
+  template_id: 1,
+  to: [{ email: params[:email], name: params[:name] }],
+  reply_to: { email: "support@example.com" }
+)
+```
+
+### Template parameters
+
+Parameters passed to `.call` are forwarded to the Brevo template as `params`:
+
+```ruby
+# These params will be available in your Brevo template
+OrderConfirmation.call(
+  email: "user@example.com",
+  order_id: "12345",
+  total: "$99.00"
+)
+```
+
+### Retry behavior
+
+The `DeliveryJob` automatically retries on `Brevo::ApiError` with polynomial backoff, up to 5 attempts.
+
+## Development
+
+### Running tests
+
+```bash
+bin/rails test
+```
+
+### Linting
+
+```bash
+bin/rubocop
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"

data/app/helpers/brevo/extras/application_helper.rb

@@ -0,0 +1,6 @@
+module Brevo
+  module Extras
+    module ApplicationHelper
+    end
+  end
+end

data/app/jobs/brevo/extras/application_job.rb

@@ -0,0 +1,6 @@
+module Brevo
+  module Extras
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/jobs/brevo/extras/delivery_job.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Brevo
+  module Extras
+    class DeliveryJob < ApplicationJob
+      retry_on Brevo::ApiError, wait: :polynomially_longer, attempts: 5
+
+      def perform(data)
+        api_instance = Brevo::TransactionalEmailsApi.new
+        api_instance.send_transac_email(
+          Brevo::SendSmtpEmail.new(data)
+        )
+      end
+    end
+  end
+end

data/app/mailers/brevo/extras/application_mailer.rb

@@ -0,0 +1,8 @@
+module Brevo
+  module Extras
+    class ApplicationMailer < ActionMailer::Base
+      default from: "from@example.com"
+      layout "mailer"
+    end
+  end
+end

data/app/models/brevo/extras/application_record.rb

@@ -0,0 +1,7 @@
+module Brevo
+  module Extras
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Brevo::Extras::Engine.routes.draw do
+end

data/lib/brevo/extras/base.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Brevo
+  module Extras
+    class Base
+      class << self
+        def call(params)
+          new(params).call
+        end
+      end
+
+      def initialize(params)
+        @params = params
+      end
+
+      def call
+        raise NotImplementedError, "Subclasses must implement #call"
+      end
+
+      protected
+
+      def send_email(template_id:, to:, reply_to: nil)
+        data = build_email_data(template_id:, to:, reply_to:)
+        data[:to] = safe_mode_recipients(data[:to])
+        data[:headers] = { "X-Sib-Sandbox" => "drop" } if sandbox_mode?
+        deliver_later(data)
+      end
+
+      private
+
+      def build_email_data(template_id:, to:, reply_to:)
+        {
+          templateId: template_id,
+          to: to,
+          replyTo: reply_to,
+          params: @params
+        }.tap do |data|
+          data.delete(:replyTo) if reply_to.nil?
+        end
+      end
+
+      def safe_mode_recipients(recipients)
+        return recipients unless safe_mode?
+
+        recipients = recipients.is_a?(Array) ? recipients : [ recipients ]
+        recipients.select do |recipient|
+          email = recipient[:email].to_s.gsub(/\s/, "").downcase
+          safe_mode_domains.any? { |domain| email.end_with?("@#{domain}") }
+        end
+      end
+
+      def sandbox_mode?
+        ActiveModel::Type::Boolean.new.cast(
+          ENV.fetch("BREVO_SANDBOX_MODE", "1")
+        )
+      end
+
+      def safe_mode_domains
+        ENV.fetch("BREVO_SAFE_MODE_ALLOWED_DOMAINS", "").split(",").map(&:strip)
+      end
+
+      def safe_mode?
+        ActiveModel::Type::Boolean.new.cast(
+          ENV.fetch("BREVO_SAFE_MODE", "1")
+        ) || Rails.env.local?
+      end
+
+      def deliver_later(data)
+        DeliveryJob.perform_later(data)
+      end
+    end
+  end
+end

data/lib/brevo/extras/engine.rb

@@ -0,0 +1,7 @@
+module Brevo
+  module Extras
+    class Engine < ::Rails::Engine
+      isolate_namespace Brevo::Extras
+    end
+  end
+end

data/lib/brevo/extras/version.rb

@@ -0,0 +1,5 @@
+module Brevo
+  module Extras
+    VERSION = "0.1.0"
+  end
+end

data/lib/brevo/extras.rb

@@ -0,0 +1,10 @@
+require "brevo/extras/version"
+require "brevo/extras/engine"
+require "brevo/extras/base"
+require "brevo"
+
+module Brevo
+  module Extras
+    # Your code goes here...
+  end
+end

data/lib/tasks/brevo/extras_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :brevo_extras do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: brevo-extras
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruno Perles
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.2
+- !ruby/object:Gem::Dependency
+  name: brevo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: A Rails engine that provides a clean abstraction layer for sending transactional
+  emails via the Brevo API, with built-in sandbox and safe modes, async delivery via
+  Active Job, and automatic retry with polynomial backoff.
+email:
+- contact@atnos.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/helpers/brevo/extras/application_helper.rb
+- app/jobs/brevo/extras/application_job.rb
+- app/jobs/brevo/extras/delivery_job.rb
+- app/mailers/brevo/extras/application_mailer.rb
+- app/models/brevo/extras/application_record.rb
+- config/routes.rb
+- lib/brevo/extras.rb
+- lib/brevo/extras/base.rb
+- lib/brevo/extras/engine.rb
+- lib/brevo/extras/version.rb
+- lib/tasks/brevo/extras_tasks.rake
+homepage: https://github.com/atnos/brevo-extras
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/atnos/brevo-extras
+  source_code_uri: https://github.com/atnos/brevo-extras
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: A Rails engine for sending transactional emails via the Brevo API.
+test_files: []