emailbutler 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70bf205c00cb4bf8907b43c549d763cee107e138e61bca507c130677726d7d86
-  data.tar.gz: 9bd2eeb375ef2d02e0dff933586ac46093be662bafd3aa767a3441963678c6f7
+  metadata.gz: 612e4bc27184b6105020c585995ebb90cf6bc7f1d1d18cdd8833d22e762cc7c1
+  data.tar.gz: fc6c91f52ffdde4dba4585d685b7a5c4173793aa2c355d9593b2fcf852189781
 SHA512:
-  metadata.gz: 7a694d31890e57a695aaf380c664a25a2cac922b3b89d6dc196e19a07b3119fb62eb72501999da5c2e2fd48365c43e8b26718d38907f5fa68394b83df53faee9
-  data.tar.gz: 9100a4c42424bc8a6a1c1b1ef899dd3f02fef8f4c88592c958e1da0fb52e16d545e66ef0bc081551b62fe77c8a9f647bd3876036877cdf3e38ca0f68735c8a6f
+  metadata.gz: 9fb3f49d372b3bc87a0131913796bd0073d95a41521f53f351420223dbf14e0067d62d6e3f58b4bc9efee591736fc6e922d7e97d21aae4b373a32e92d446b317
+  data.tar.gz: a7930ffe63ac272075fe9af8bb1201b388bda1045c228815cb26ad64885c1189bdf84a2d610addcbeaa0c5bb73d6e2187aea1cb375d1b3a2e8a3773f455a5816

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.
+Emailbutler allows you to track delivery status of emails sent by your app through Sendgrid and/or SMTP2GO.
 
 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.
 
@@ -36,6 +36,7 @@ Emailbutler.configure do |config|
   config.ui_username = 'username'
   config.ui_password = 'password'
   config.ui_secured_environments = ['production']
+  config.skip_before_actions = %i[verify_authenticity_token]
 end
 ```
 
@@ -59,7 +60,7 @@ class SendgridController < ApplicationController
     ... you can add some logic here
 
     ::Emailbutler::Webhooks::Receiver.call(
-      user_agent: ::Emailbutler::Webhooks::Receiver::SENDGRID_USER_AGENT,
+      user_agent: request.headers['HTTP_USER_AGENT'],
       payload: receiver_params.to_h
     )
 
@@ -69,7 +70,10 @@ class SendgridController < ApplicationController
   private
 
   def receiver_params
-    params.permit('_json' => %w[smtp-id event timestamp sg_message_id])
+    params.permit(
+      'event', 'sendtime', 'message-id',
+      '_json' => %w[event timestamp smtp-id sg_message_id]
+    )
   end
 end
 ```
@@ -106,6 +110,14 @@ end
 - select all deliverability data,
 - save settings.
 
+#### SMTP2GO
+
+- 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,
+- 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,7 +2,7 @@
 
 module Emailbutler
   class WebhooksController < Emailbutler::ApplicationController
-    skip_before_action :verify_authenticity_token
+    skip_before_action(*Emailbutler.configuration.skip_before_actions)
 
     def create
       ::Emailbutler::Webhooks::Receiver.call(
@@ -16,7 +16,10 @@ module Emailbutler
     private
 
     def receiver_params
-      params.permit('_json' => %w[smtp-id event timestamp sg_message_id])
+      params.permit(
+        'event', 'sendtime', 'message-id',
+        '_json' => %w[event timestamp smtp-id sg_message_id]
+      )
     end
   end
 end

data/lib/emailbutler/configuration.rb

@@ -2,7 +2,7 @@
 
 module Emailbutler
   class Configuration
-    attr_accessor :adapter, :ui_username, :ui_password, :ui_secured_environments
+    attr_accessor :adapter, :ui_username, :ui_password, :ui_secured_environments, :skip_before_actions
 
     def initialize
       @adapter = nil
@@ -10,9 +10,11 @@ module Emailbutler
       # It's required to specify these 3 variables to enable basic auth to UI
       @ui_username = ''
       @ui_password = ''
-
       # Secured environments variable must directly contains environment names
       @ui_secured_environments = []
+
+      # Skip before_actions from your ApplicationController
+      @skip_before_actions = %i[verify_authenticity_token]
     end
   end
 end

data/lib/emailbutler/version.rb

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

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Emailbutler
+  module Webhooks
+    module Mappers
+      class Smtp2Go
+        DELIVERABILITY_MAPPER = {
+          'processed' => 'processed',
+          'delivered' => 'delivered',
+          'open' => 'delivered',
+          'click' => 'delivered',
+          'bounce' => 'failed',
+          'reject' => 'failed',
+          'spam' => 'failed'
+        }.freeze
+
+        def self.call(...)
+          new.call(...)
+        end
+
+        def call(payload:)
+          payload.stringify_keys!
+          message_uuid = payload['message-id']
+          status = DELIVERABILITY_MAPPER[payload['event']]
+          return [] if message_uuid.nil? || status.nil?
+
+          [
+            {
+              message_uuid: message_uuid,
+              status: status,
+              timestamp: payload['sendtime'] ? Time.at(payload['sendtime'].to_i).utc.to_datetime : nil
+            }
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/emailbutler/webhooks/receiver.rb

@@ -1,18 +1,28 @@
 # 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:)
-        select_mapper(user_agent)
+        mapper = RECEIVERS_MAPPER[user_agent]
+        return unless mapper
+
+        mapper
           .call(payload: payload)
           .each { |event|
             message = Emailbutler.find_message_by(uuid: event.delete(:message_uuid))
@@ -21,14 +31,6 @@ module Emailbutler
             Emailbutler.update_message(message, event)
           }
       end
-
-      private
-
-      def select_mapper(user_agent)
-        case user_agent
-        when SENDGRID_USER_AGENT then Emailbutler::Webhooks::Mappers::Sendgrid
-        end
-      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emailbutler
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pagy
@@ -202,6 +202,7 @@ files:
 - lib/emailbutler/mailers/helpers.rb
 - lib/emailbutler/version.rb
 - lib/emailbutler/webhooks/mappers/sendgrid.rb
+- lib/emailbutler/webhooks/mappers/smtp2go.rb
 - lib/emailbutler/webhooks/receiver.rb
 - lib/generators/emailbutler/active_record_generator.rb
 - lib/generators/emailbutler/templates/migration.erb