emailbutler 0.7.6 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7a1a7e4cc9dad6d9958abcb9e832e85d6c74a2c44a71c63bc42e7e3be59debc
-  data.tar.gz: 490337b5946df84317357c9f22d9d189d0434ff215726533b3dc934479b99eb3
+  metadata.gz: e06b545b530403687a7844d31538ea50de73cffbc8f225ab5a849fe13d7678b0
+  data.tar.gz: c6fdc2b0fcf1afb430c0b1c80b2b1b89f9273007a54f97b3c96ddbad44a1bef2
 SHA512:
-  metadata.gz: 53580acc1672780cc1b5eca024fc68868cf8ab3f3d2cadc6a02f4edb70787ba1c87b583a04703a1bca718ecc9ef80254d6f6a5d288824cb7a05247ef38c30a50
-  data.tar.gz: 7565afd9b680a42d2dee0b500b39773e696b2e80a53d7eb7e1f8ddb3f686dca7ef65af0548471416d18cbe2cb4bfd68e6b07128007439341a6e611a29d2e73a8
+  metadata.gz: 71919a2533d61eb98ea21ef74266c261f1569acaf8ae2193fa30eef083b2ae06c659ec38af299d86d67d5b09f06ed9391b7fd63ba143687bd2592d071bbac916
+  data.tar.gz: ea46055aa238b71c0c237138caf69e2ed8b4580d0956e95274e3762071b7ae72e273ddf6fc43147634d0723d8b5966b31b8a25d89b8ed71901937fa7c1f9e12a

data/README.md

@@ -1,6 +1,6 @@
 # Emailbutler
 Simple email tracker for Ruby on Rails applications.
-Emailbutler allows you to track delivery status of emails sent by your app through Sendgrid and/or SMTP2GO.
+Emailbutler allows you to track delivery status of emails sent by your app through Sendgrid, SMTP2GO, Resend.
 
 There are situations when you need to check whether a certain letter or certain type of letters was successfully sent from the application, and through the UI of some providers you can try to find such a letter by the recipient or the subject of the letter, but sometimes it's not enough.
 
@@ -27,16 +27,17 @@ $ rails db:migrate
 
 Add configuration line to config/initializers/emailbutler.rb:
 
-#### ActiveRecord
+#### For ActiveRecord
 
 ```ruby
 require 'emailbutler/adapters/active_record'
 
 Emailbutler.configure do |config|
-  config.adapter = Emailbutler::Adapters::ActiveRecord.new
-  config.ui_username = 'username'
-  config.ui_password = 'password'
-  config.ui_secured_environments = ['production']
+  config.adapter = Emailbutler::Adapters::ActiveRecord.new # required
+  config.providers = %w[sendgrid smtp2go resend] # optional
+  config.ui_username = 'username' # optional
+  config.ui_password = 'password' # optional
+  config.ui_secured_environments = ['production'] # optional
 end
 ```
 
@@ -59,9 +60,9 @@ class SendgridController < ApplicationController
   def create
     ... you can add some logic here
 
-    ::Emailbutler::Webhooks::Receiver.call(
-      user_agent: request.headers['HTTP_USER_AGENT'],
-      payload: receiver_params.to_h
+    Emailbutler::Container.resolve(:webhooks_receiver).call(
+      mapper: Emailbutler::Container.resolve(:sendgrid_mapper),
+      payload: receiver_params
     )
 
     head :ok
@@ -70,10 +71,7 @@ class SendgridController < ApplicationController
   private
 
   def receiver_params
-    params.permit(
-      'event', 'sendtime', 'message-id',
-      '_json' => %w[event timestamp smtp-id sg_message_id]
-    )
+    params.permit('event', 'sendtime', 'message-id').to_h
   end
 end
 ```
@@ -106,7 +104,7 @@ end
 
 - go to [Mail settings](https://app.sendgrid.com/settings/mail_settings),
 - turn on Event Webhook,
-- in the HTTP POST URL field, paste the URL to webhook controller of your app,
+- in the HTTP POST URL field, paste the URL to webhook controller of your app (host/emailbutler/webhooks/sendgrid),
 - select all deliverability data,
 - save settings.
 
@@ -114,7 +112,15 @@ end
 
 - go to [Mail settings](https://app-eu.smtp2go.com/settings/webhooks),
 - turn on Webhooks,
-- in the HTTP POST URL field, paste the URL to webhook controller of your app,
+- in the HTTP POST URL field, paste the URL to webhook controller of your app (host/emailbutler/webhooks/smtp2go),
+- select all deliverability data,
+- save settings.
+
+#### Resend
+
+- go to [Mail settings](https://resend.com/webhooks),
+- add Webhook,
+- in the Endpoint URL field, paste the URL to webhook controller of your app (host/emailbutler/webhooks/resend),
 - select all deliverability data,
 - save settings.
 

data/app/controllers/emailbutler/webhooks_controller.rb

@@ -2,12 +2,26 @@
 
 module Emailbutler
   class WebhooksController < Emailbutler::ApplicationController
+    # deprecated constants
+    SENDGRID_USER_AGENT = 'SendGrid Event API'
+    SMTP2GO_USER_AGENT = 'Go-http-client/1.1'
+
     skip_before_action :verify_authenticity_token
+    before_action :validate_provider, only: %i[create]
+
+    def create_deprecated
+      Emailbutler::Container.resolve(:webhooks_receiver).call(
+        mapper: receiver_mapper_deprecated(request.headers['HTTP_USER_AGENT']),
+        payload: mapper_params_deprecated.to_h
+      )
+
+      head :ok
+    end
 
     def create
-      ::Emailbutler::Webhooks::Receiver.call(
-        user_agent: request.headers['HTTP_USER_AGENT'],
-        payload: receiver_params.to_h
+      Emailbutler::Container.resolve(:webhooks_receiver).call(
+        mapper: receiver_mapper,
+        payload: mapper_params.to_h
       )
 
       head :ok
@@ -15,7 +29,46 @@ module Emailbutler
 
     private
 
-    def receiver_params
+    def validate_provider
+      head :ok if Emailbutler.configuration.providers.exclude?(params[:provider])
+    end
+
+    def receiver_mapper
+      case params[:provider]
+      when 'sendgrid' then Emailbutler::Container.resolve(:sendgrid_mapper)
+      when 'smtp2go' then Emailbutler::Container.resolve(:smtp2go_mapper)
+      when 'resend' then Emailbutler::Container.resolve(:resend_mapper)
+      end
+    end
+
+    def mapper_params
+      case params[:provider]
+      when 'sendgrid' then sendgrid_params
+      when 'smtp2go' then smtp2go_params
+      when 'resend' then resend_params
+      end
+    end
+
+    def sendgrid_params
+      params.permit('_json' => %w[smtp-id event timestamp sg_message_id])
+    end
+
+    def smtp2go_params
+      params.permit('event', 'sendtime', 'message-id')
+    end
+
+    def resend_params
+      params.permit('type', 'created_at', 'data' => %w[email_id])
+    end
+
+    def receiver_mapper_deprecated(user_agent)
+      case user_agent
+      when SENDGRID_USER_AGENT then Emailbutler::Container.resolve(:sendgrid_mapper)
+      when SMTP2GO_USER_AGENT then Emailbutler::Container.resolve(:smtp2go_mapper)
+      end
+    end
+
+    def mapper_params_deprecated
       params.permit(
         'event', 'sendtime', 'message-id',
         '_json' => %w[event timestamp smtp-id sg_message_id]

data/config/routes.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 Emailbutler::Engine.routes.draw do
-  post '/webhooks', to: 'webhooks#create'
+  post '/webhooks', to: 'webhooks#create_deprecated'
+  post '/webhooks/:provider', to: 'webhooks#create'
 
   resources :ui, only: %i[index show]
   namespace :ui do

data/lib/emailbutler/configuration.rb

@@ -2,16 +2,65 @@
 
 module Emailbutler
   class Configuration
-    attr_accessor :adapter, :ui_username, :ui_password, :ui_secured_environments
+    InitializeError = Class.new(StandardError)
+
+    AVAILABLE_ADAPTERS = %w[
+      Emailbutler::Adapters::ActiveRecord
+    ].freeze
+    AVAILABLE_PROVIDERS = %w[sendgrid smtp2go resend].freeze
+
+    attr_accessor :adapter, :providers, :ui_username, :ui_password, :ui_secured_environments
 
     def initialize
       @adapter = nil
+      @providers = []
 
       # It's required to specify these 3 variables to enable basic auth to UI
-      @ui_username = ''
-      @ui_password = ''
+      @ui_username = nil
+      @ui_password = nil
       # Secured environments variable must directly contains environment names
       @ui_secured_environments = []
     end
+
+    def validate
+      validate_adapter
+      validate_providers
+      validate_username
+      validate_password
+      validate_secured_environments
+    end
+
+    private
+
+    def validate_adapter
+      raise InitializeError, 'Adapter must be present' if adapter.nil?
+      raise InitializeError, 'Invalid adapter' if AVAILABLE_ADAPTERS.exclude?(adapter.class.name)
+    end
+
+    def validate_providers
+      raise InitializeError, 'Providers list must be array' unless providers.is_a?(Array)
+
+      return unless providers.any? { |provider| AVAILABLE_PROVIDERS.exclude?(provider) }
+
+      raise InitializeError, 'Providers list contain invalid element'
+    end
+
+    def validate_username
+      return if ui_username.blank?
+      return if ui_username.is_a?(String)
+
+      raise InitializeError, 'Username must be nil or filled string'
+    end
+
+    def validate_password
+      return if ui_password.blank?
+      return if ui_password.is_a?(String)
+
+      raise InitializeError, 'Password must be nil or filled string'
+    end
+
+    def validate_secured_environments
+      raise InitializeError, 'Environments list must be array' unless ui_secured_environments.is_a?(Array)
+    end
   end
 end

data/lib/emailbutler/container.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'dry/container'
+require 'emailbutler/webhooks/mappers/sendgrid'
+require 'emailbutler/webhooks/mappers/smtp2go'
+require 'emailbutler/webhooks/mappers/resend'
+require 'emailbutler/webhooks/receiver'
+
+module Emailbutler
+  class Container
+    extend Dry::Container::Mixin
+
+    DEFAULT_OPTIONS = { memoize: true }.freeze
+
+    class << self
+      def register(key)
+        super(key, DEFAULT_OPTIONS)
+      end
+    end
+
+    # webhook mappers
+    register(:sendgrid_mapper) { Emailbutler::Webhooks::Mappers::Sendgrid.new }
+    register(:smtp2go_mapper) { Emailbutler::Webhooks::Mappers::Smtp2Go.new }
+    register(:resend_mapper) { Emailbutler::Webhooks::Mappers::Resend.new }
+
+    # webhook receiver
+    register(:webhooks_receiver) { Emailbutler::Webhooks::Receiver.new }
+  end
+end

data/lib/emailbutler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Emailbutler
-  VERSION = '0.7.6'
+  VERSION = '0.8.1'
 end

data/lib/emailbutler/webhooks/mappers/resend.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Emailbutler
+  module Webhooks
+    module Mappers
+      class Resend
+        DELIVERABILITY_MAPPER = {
+          'email.sent' => 'processed',
+          'email.delivered' => 'delivered',
+          'email.opened' => 'delivered',
+          'email.clicked' => 'delivered',
+          'email.delivered_delayed' => 'failed',
+          'email.bounced' => 'failed',
+          'email.complained' => 'failed'
+        }.freeze
+
+        def call(payload:)
+          payload.stringify_keys!
+          # message-id contains data like <uuid>
+          message_uuid = payload.dig('data', 'email_id')
+          status = DELIVERABILITY_MAPPER[payload['type']]
+          return [] if message_uuid.nil? || status.nil?
+
+          [
+            {
+              message_uuid: message_uuid,
+              status: status,
+              timestamp: payload['created_at'] ? DateTime.parse(payload['created_at']).utc : nil
+            }
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/emailbutler/webhooks/mappers/sendgrid.rb

@@ -15,10 +15,6 @@ module Emailbutler
           'spamreport' => 'failed'
         }.freeze
 
-        def self.call(...)
-          new.call(...)
-        end
-
         def call(payload:)
           payload['_json'].filter_map { |message|
             message.stringify_keys!

data/lib/emailbutler/webhooks/mappers/smtp2go.rb

@@ -14,10 +14,6 @@ module Emailbutler
           'spam' => 'failed'
         }.freeze
 
-        def self.call(...)
-          new.call(...)
-        end
-
         def call(payload:)
           payload.stringify_keys!
           # message-id contains data like <uuid>

data/lib/emailbutler/webhooks/receiver.rb

@@ -1,25 +1,9 @@
 # frozen_string_literal: true
 
-require 'emailbutler/webhooks/mappers/sendgrid'
-require 'emailbutler/webhooks/mappers/smtp2go'
-
 module Emailbutler
   module Webhooks
     class Receiver
-      SENDGRID_USER_AGENT = 'SendGrid Event API'
-      SMTP2GO_USER_AGENT = 'Go-http-client/1.1'
-
-      RECEIVERS_MAPPER = {
-        'SendGrid Event API' => Emailbutler::Webhooks::Mappers::Sendgrid,
-        'Go-http-client/1.1' => Emailbutler::Webhooks::Mappers::Smtp2Go
-      }.freeze
-
-      def self.call(...)
-        new.call(...)
-      end
-
-      def call(user_agent:, payload:)
-        mapper = RECEIVERS_MAPPER[user_agent]
+      def call(mapper:, payload:)
         return unless mapper
 
         mapper

data/lib/emailbutler.rb

@@ -6,38 +6,49 @@ require 'emailbutler/version'
 require 'emailbutler/engine'
 require 'emailbutler/configuration'
 require 'emailbutler/dsl'
-require 'emailbutler/webhooks/receiver'
 require 'emailbutler/helpers'
 require 'emailbutler/mailers/helpers'
+require 'emailbutler/container'
 
 module Emailbutler
   extend self
   extend Forwardable
 
-  # Public: Given an adapter returns a handy DSL to all the emailbutler goodness.
-  def new(adapter)
-    DSL.new(adapter)
-  end
-
   # Public: Configure emailbutler.
   #
+  #   require 'emailbutler/adapters/active_record'
+  #
   #   Emailbutler.configure do |config|
   #     config.adapter = Emailbutler::Adapters::ActiveRecord.new
+  #     config.providers = %i[sendgrid]
   #   end
   #
   def configure
+    ActiveSupport::Deprecation.new.warn(
+      'Webhook endpoint should receive provider name in params. ' \
+      'Please update webhook url in settings of your SMTP provider.' \
+      'Webhook without provider in params will be removed soon.'
+    )
+
     yield configuration
+
+    configuration.validate
   end
 
   # Public: Returns Emailbutler::Configuration instance.
   def configuration
-    @configuration ||= Configuration.new
+    return Emailbutler::Container.resolve(:configuration) if Emailbutler::Container.key?(:configuration)
+
+    Emailbutler::Container.register(:configuration) { Configuration.new }
+    Emailbutler::Container.resolve(:configuration)
   end
 
-  # Public: Default per thread emailbutler instance if configured.
-  # Returns Emailbutler::DSL instance.
+  # Public: Returns Emailbutler::DSL instance.
   def instance
-    Thread.current[:emailbutler_instance] ||= new(configuration.adapter)
+    return Emailbutler::Container.resolve(:instance) if Emailbutler::Container.key?(:instance)
+
+    Emailbutler::Container.register(:instance) { DSL.new(configuration.adapter) }
+    Emailbutler::Container.resolve(:instance)
   end
 
   # Public: All the methods delegated to instance. These should match the interface of Emailbutler::DSL.

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: emailbutler
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.1
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-19 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: pagy
   requirement: !ruby/object:Gem::Requirement
@@ -196,11 +210,13 @@ files:
 - lib/emailbutler.rb
 - lib/emailbutler/adapters/active_record.rb
 - lib/emailbutler/configuration.rb
+- lib/emailbutler/container.rb
 - lib/emailbutler/dsl.rb
 - lib/emailbutler/engine.rb
 - lib/emailbutler/helpers.rb
 - lib/emailbutler/mailers/helpers.rb
 - lib/emailbutler/version.rb
+- lib/emailbutler/webhooks/mappers/resend.rb
 - lib/emailbutler/webhooks/mappers/sendgrid.rb
 - lib/emailbutler/webhooks/mappers/smtp2go.rb
 - lib/emailbutler/webhooks/receiver.rb