emailbutler 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb57bd8a59942207f28941dd14e91f17cd5d74982877773415a38b925d49ccaa
-  data.tar.gz: 0fc748f32a49291175cccdff3a9e89dfe2aefafaacd1c357df38c545d18d768a
+  metadata.gz: 8e223a593bef4c9075afed0fa29d31057519250a0949a589c8535232d632bc83
+  data.tar.gz: 7355cdbd47a964b9da80cbf0a80203c40865ebc5cec0af272595d105a4cbcb16
 SHA512:
-  metadata.gz: 0b5a8e3d1c292ff847623e7f404c5535d4324d9f206b0a15905b982fda3c42bd566039cb6e01727b085b7f924899ec07ffdd8a2d05e5fa418eba4d048f7012f1
-  data.tar.gz: d1bed20baaadc9b02fe3b8e8f8d4412e575977121d376f2077e18adc35349f5db261c7216f98b0cd0b87a7f875041c7f5614d70cd0c5dc6fe0fd8c6f42091045
+  metadata.gz: 0d92a36b9c851110c9c038f7ef077119cde85fed6f1731531db011649cbbe83fa8d2d1ab1db310a5e8df513014277fb074a9445088ff195d5f649ac7d385a97a
+  data.tar.gz: 5313f1e26f096577cbc2ad07be23842862ebf9a24b1ccc358a51469130bce50e416b9ffe5e6895b3e14962e43a1f389b271daeca0a0cdedd0516564d270ef632

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.
 
@@ -34,7 +34,7 @@ require 'emailbutler/adapters/active_record'
 
 Emailbutler.configure do |config|
   config.adapter = Emailbutler::Adapters::ActiveRecord.new # required
-  config.providers = %w[sendgrid smtp2go] # required at least 1 provider since 0.8
+  config.providers = %w[sendgrid smtp2go resend] # optional
   config.ui_username = 'username' # optional
   config.ui_password = 'password' # optional
   config.ui_secured_environments = ['production'] # optional
@@ -116,6 +116,14 @@ end
 - 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.
+
 ## Usage
 
 1. Each event with sending email will create new record with message params in database.

data/app/controllers/emailbutler/webhooks_controller.rb

@@ -2,22 +2,9 @@
 
 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::Container.resolve(:webhooks_receiver).call(
         mapper: receiver_mapper,
@@ -37,6 +24,7 @@ module Emailbutler
       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
 
@@ -44,6 +32,7 @@ module Emailbutler
       case params[:provider]
       when 'sendgrid' then sendgrid_params
       when 'smtp2go' then smtp2go_params
+      when 'resend' then resend_params
       end
     end
 
@@ -55,18 +44,8 @@ module Emailbutler
       params.permit('event', 'sendtime', 'message-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]
-      )
+    def resend_params
+      params.permit('type', 'created_at', 'data' => %w[email_id])
     end
   end
 end

data/config/routes.rb

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

data/lib/emailbutler/configuration.rb

@@ -7,7 +7,7 @@ module Emailbutler
     AVAILABLE_ADAPTERS = %w[
       Emailbutler::Adapters::ActiveRecord
     ].freeze
-    AVAILABLE_PROVIDERS = %w[sendgrid smtp2go].freeze
+    AVAILABLE_PROVIDERS = %w[sendgrid smtp2go resend].freeze
 
     attr_accessor :adapter, :providers, :ui_username, :ui_password, :ui_secured_environments
 
@@ -39,7 +39,6 @@ module Emailbutler
 
     def validate_providers
       raise InitializeError, 'Providers list must be array' unless providers.is_a?(Array)
-      raise InitializeError, 'At least 1 provider must be present' if providers.blank?
 
       return unless providers.any? { |provider| AVAILABLE_PROVIDERS.exclude?(provider) }
 

data/lib/emailbutler/container.rb

@@ -3,6 +3,7 @@
 require 'dry/container'
 require 'emailbutler/webhooks/mappers/sendgrid'
 require 'emailbutler/webhooks/mappers/smtp2go'
+require 'emailbutler/webhooks/mappers/resend'
 require 'emailbutler/webhooks/receiver'
 
 module Emailbutler
@@ -20,6 +21,7 @@ module Emailbutler
     # 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 }

data/lib/emailbutler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Emailbutler
-  VERSION = '0.8.0'
+  VERSION = '0.8.2'
 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.rb

@@ -24,12 +24,6 @@ module Emailbutler
   #   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emailbutler
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-11 00:00:00.000000000 Z
+date: 2024-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-container
@@ -216,6 +216,7 @@ files:
 - 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