brevo-rails 0.0.6.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d7fad1139fd4c77d3008d8b7e6076e491ba9ce80ad4b46d48c1fa0cfa8334a6
-  data.tar.gz: 4a50af13145ad5153c332f70a63e808a4991a8a0ce6857257ea4cf30c0162ea8
+  metadata.gz: f38c8e0d586324f814cc56cc4d4e15e3bfc25f8bad4825910ed3cd6d3a3d0d48
+  data.tar.gz: 563e8f88f66b57c3484d22630315f7e41816251d2d9c6f3d4654689ce3b540c0
 SHA512:
-  metadata.gz: e015063069a4f2bb7c2d62e9d8fdd90e8a754dc723b5ffef6f988925c6129e7984003348fd9a4be4f1c481dde46c05f00ed68034982d0501c191d7e746c545b0
-  data.tar.gz: 33fb4da44a7b890755a875ca3764d1f588ec65b011de51375efff68574238e5dccdfbbcba0cbc1dd41867bb742265a17ced6578c5bb25f2ed55158eec9840542
+  metadata.gz: 216694871f682f0dfeb9adf44f8601c6caa6d496aabb3cacf90f47a8c141efa101669a4ad9ce91a69c5cae6ba6f427ff2aadfbb66dc7ef3bcf8a3b1e939a7629
+  data.tar.gz: dd25cde5e9364be90405b4adee32de1a94e4aa64d635170ee25135701856ce76456d20952d2b67ea76a0a9b8c49210db986d3d97c161d987150825d88d897b16

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -0,0 +1,24 @@
+# Unofficial Brevo Action Mailer adapter
+
+brevo_rails is an Action Mailer adapter for using Brevo in Ruby on Rails application. It uses Brevo gem to make API request to Brevo service.
+
+## Installation
+
+In your Gemfile
+
+```ruby
+gem 'brevo-rails'
+```
+
+## Usage
+
+Add these lines in your configuration file.
+
+```ruby
+config.action_mailer.delivery_method = :brevo
+config.action_mailer.brevo_settings = {
+  api_key: ENV.fetch('BREVO_API_KEY'),
+}
+```
+
+

data/brevo_rails.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'lib/brevo_rails/version'
+
+Gem::Specification.new do |s|
+  s.name        = "brevo-rails"
+  s.version = BrevoRails::VERSION
+  s.summary     = "Send transactional email with Brevo"
+  s.description = "Send transactional email with Brevo"
+  s.authors     = ["Franck D'agostini"]
+  s.email       = "franck.dagostini@gmail.com"
+  s.files       = ["lib/brevo_rails.rb"]
+  s.homepage    = "https://rubygems.org/gems/brevo_rails"
+  s.license       = "MIT"
+  s.required_ruby_version = '>= 2.7.0'
+  s.require_paths = ['lib']
+
+  s.files = `git ls-files -z`.split("\x0")
+
+  s.add_development_dependency 'debug', '~> 1.0'
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'mail', '~> 2.5', '>= 2.5.4'
+  s.add_runtime_dependency "brevo", "~> 2.0"
+  s.add_runtime_dependency "activesupport", "> 4.3"
+
+end

data/lib/brevo_rails/action_mailer/delivery_method.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module BrevoRails
+  module ActionMailer
+    class DeliveryMethod
+      attr_accessor :settings
+
+      ALLOWED_PARAMS = %i[api_key].freeze
+
+      def initialize(settings)
+        self.settings = settings
+      end
+
+      def deliver!(message)
+        mail = BrevoRails::Mail.from_message(message)
+
+        api.send_transac_email(mail)
+      end
+
+      private
+
+        def api
+          @api ||= Brevo::TransactionalEmailsApi.new(api_client)
+        end
+
+        def api_client
+          @api_client ||= Brevo::ApiClient.new(configuration)
+        end
+
+        def configuration
+          @configuration ||= Brevo::Configuration.new.tap do |config|
+            config.api_key['api-key'] = settings.fetch(:api_key)
+            config.debugging = settings.fetch(:debugging, false)
+          end
+        end
+    end
+  end
+end

data/lib/brevo_rails/action_mailer/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module BrevoRails
+  module ActionMailer
+    class Railtie < Rails::Railtie
+      initializer 'brevo_action_mailer.add_delivery_method', before: 'action_mailer.set_configs' do
+        ActiveSupport.on_load(:action_mailer) do
+          ::ActionMailer::Base.add_delivery_method(:brevo, BrevoRails::ActionMailer::DeliveryMethod)
+        end
+      end
+    end
+  end
+end

data/lib/brevo_rails/action_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'action_mailer/delivery_method'
+require_relative 'action_mailer/railtie' if defined? Rails
+
+module BrevoRails
+  module ActionMailer; end
+end

data/lib/brevo_rails/mail.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'active_support/core_ext/hash/keys'
+
+module BrevoRails
+  class Mail
+
+    class << self
+      def from_message(message)
+        params = {
+          sender: prepare_sender(address_list(message['from'])&.addresses&.first),
+          to: prepare_to(address_list(message['to'])&.addresses),
+          subject: message.subject,
+          'textContent': prepare_text_part(message),
+          'htmlContent': prepare_html_part(message),
+          headers: prepare_headers(message),
+        }.stringify_keys
+
+        params['cc'] = prepare_cc(address_list(message['cc'])&.addresses) if message['cc']
+        params['bcc'] = prepare_bcc(address_list(message['bcc'])&.addresses) if message['bcc']
+        params['attachment'] = prepare_attachments(message.attachments) if message.attachments.any?
+
+        Brevo::SendSmtpEmail.new(params)
+      end
+
+      private
+
+        PROCESSED_HEADERS = %w[
+          from
+          to
+          cc
+          bcc
+          subject
+        ].freeze
+
+        def prepare_headers(message)
+          message
+            .header_fields
+            .reject { |header| PROCESSED_HEADERS.include?(header.name.downcase.delete('-')) }
+            .to_h { |header| [header.name, header.value] }
+            .compact
+        end
+
+        def prepare_sender(sender)
+          Brevo::SendSmtpEmailSender.new(prepare_address(sender))
+        end
+
+        def prepare_to(addresses=[])
+          Array(addresses).map do |address|
+            Brevo::SendSmtpEmailTo.new(prepare_address(address))
+          end
+        end
+
+        def prepare_cc(addresses=[])
+          Array(addresses).map do |address|
+            Brevo::SendSmtpEmailCc.new(prepare_address(address))
+          end
+        end
+
+        def prepare_bcc(addresses=[])
+          Array(addresses).map do |address|
+            Brevo::SendSmtpEmailBcc.new(prepare_address(address))
+          end
+        end
+
+        def prepare_address(address)
+          {
+            email: address.address,
+            name: address.display_name,
+          }.stringify_keys.compact
+        end
+
+        def address_list(header)
+          header.respond_to?(:element) ? header.element : header&.address_list
+        end
+
+        # def prepare_addresses(addresses)
+        #   Array(addresses).map { |address| prepare_address(address) }
+        # end
+
+        def prepare_html_part(message)
+          return message.body.decoded if message.mime_type == 'text/html'
+
+          message.html_part&.decoded
+        end
+
+        def prepare_text_part(message)
+          return message.body.decoded if message.mime_type == 'text/plain' || message.mime_type.nil?
+
+          message.text_part&.decoded
+        end
+
+        def prepare_attachments(attachments_list = [])
+          attachments_list.map do |attachment|
+            params = {
+              content: Base64.strict_encode64(attachment.body.decoded),
+              name: attachment.filename,
+            }.stringify_keys
+            Brevo::SendSmtpEmailAttachment.new(params)
+          end
+        end
+
+    end
+  end
+end

data/lib/brevo_rails/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BrevoRails
+  VERSION = '1.0.0'
+end

data/spec/brevo_rails/action_mailer/delivery_method_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+require 'brevo_rails/action_mailer/delivery_method'
+
+RSpec.describe BrevoRails::ActionMailer::DeliveryMethod do
+  let(:message) do
+    Mail.new do
+      from    'Tester <test@example.com>'
+      to      'you@example.com, her@example.com'
+      subject 'This is a test email'
+    end
+  end
+
+  describe '#initialize' do
+    it 'sets the api_key' do
+      subject = described_class.new(api_key: '123')
+      expect(subject.settings[:api_key]).to eq('123')
+    end
+  end
+
+  describe '#deliver!' do
+    it 'calls send_transac_email' do
+      mail = double(Mail)
+      expect(BrevoRails::Mail).to receive(:from_message).and_return(mail)
+      expect_any_instance_of(Brevo::TransactionalEmailsApi).to receive(:send_transac_email).with(mail)
+      described_class.new(api_key: '123').deliver!(message)
+    end
+  end
+
+end

data/spec/brevo_rails/mail_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+
+RSpec.describe BrevoRails::Mail do
+  let(:text_part) do
+    Mail::Part.new do
+      body 'This is plain text'
+    end
+  end
+
+  let(:html_part) do
+    Mail::Part.new do
+      content_type 'text/html; charset=UTF-8'
+      body '<h1>This is HTML</h1>'
+    end
+  end
+
+  let(:message) do
+    Mail.new do
+      from    'Tester <test@example.com>'
+      to      'you@example.com, her@example.com'
+      subject 'This is a test email'
+      headers 'X-Custom-Header' => 'Custom Value'
+    end
+  end
+
+  let(:message_with_attachments) do
+    Mail.new do
+      from    'Tester <test@example.com>'
+      to      'you@example.com, her@example.com'
+      subject 'This is a test email'
+      headers 'X-Custom-Header' => 'Custom Value'
+      attachments['test.png'] = File.read('spec/fixtures/test.png')
+    end
+  end
+
+  before do
+    message.text_part = text_part
+    message.html_part = html_part
+  end
+
+  describe '.from_message' do
+    subject { BrevoRails::Mail.from_message(message) }
+
+    it 'returns a new instance of Brevo::SendSmtpEmail' do
+      expect(subject).to be_a(Brevo::SendSmtpEmail)
+    end
+
+    it 'sets the mail subject' do
+      expect(subject.subject).to eq('This is a test email')
+    end
+
+    it 'sets the mail sender' do
+      expect(subject.sender).to be_a(Brevo::SendSmtpEmailSender)
+      expect(subject.sender.email).to eq('test@example.com')
+      expect(subject.sender.name).to eq('Tester')
+    end
+
+    it 'sets the mail to' do
+      expect(subject.to).to be_a(Array)
+      expect(subject.to.first).to be_a(Brevo::SendSmtpEmailTo)
+      expect(subject.to.map(&:email)).to include('you@example.com')
+      expect(subject.to.map(&:email)).to include('her@example.com')
+    end
+
+    it 'sets the mail text content' do
+      expect(subject.text_content).to eq('This is plain text')
+      expect(subject.html_content).to eq('<h1>This is HTML</h1>')
+    end
+
+    it 'sets the mail headers' do
+      custom_header = subject.headers.fetch('X-Custom-Header')
+      expect(custom_header).to eq('Custom Value')
+    end
+
+    it 'sets attachments' do
+      expect(subject.attachment).to be_nil
+    end
+
+    context 'with attachments' do
+      subject { BrevoRails::Mail.from_message(message_with_attachments) }
+
+      it 'sets attachments' do
+        expect(subject.attachment).to be_a(Array)
+        expect(subject.attachment.size).to eq(1)
+        expect(subject.attachment.first.name).to eq('test.png')
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'mail'
+require 'brevo_rails'
+
+RSpec.configure do |config|
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brevo-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.6.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Franck D'agostini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2024-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -44,6 +44,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.4
 - !ruby/object:Gem::Dependency
   name: brevo
   requirement: !ruby/object:Gem::Requirement
@@ -78,7 +98,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- README.md
+- brevo_rails.gemspec
 - lib/brevo_rails.rb
+- lib/brevo_rails/action_mailer.rb
+- lib/brevo_rails/action_mailer/delivery_method.rb
+- lib/brevo_rails/action_mailer/railtie.rb
+- lib/brevo_rails/mail.rb
+- lib/brevo_rails/version.rb
+- spec/brevo_rails/action_mailer/delivery_method_spec.rb
+- spec/brevo_rails/mail_spec.rb
+- spec/fixtures/test.png
+- spec/spec_helper.rb
 homepage: https://rubygems.org/gems/brevo_rails
 licenses:
 - MIT