emailbutler 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96c47554b3dff802186e976ac920a6eed359a1456ae92f8ee2b83c69d2b40888
-  data.tar.gz: 2535b2f6382d82ce758ef66d284464fa3d4efb3ad25ff8cbe6aa6149239f9216
+  metadata.gz: 612e4bc27184b6105020c585995ebb90cf6bc7f1d1d18cdd8833d22e762cc7c1
+  data.tar.gz: fc6c91f52ffdde4dba4585d685b7a5c4173793aa2c355d9593b2fcf852189781
 SHA512:
-  metadata.gz: 9005a677eae021cffbd41b445a16f94b456fbdcff225817d926c956e77936972360197acf158146c44a4e1f8b9f75aa510c42278f4e3af4fb26b9ed1d173ffa4
-  data.tar.gz: 5b6744301569fd37cb366bb06f571f741c8316eb42df73a9576ff9827cd90cbf599e2b17f28a9b51ac4ad53c900d47a600e076f7712d3dfbd9c648dc4361eb0d
+  metadata.gz: 9fb3f49d372b3bc87a0131913796bd0073d95a41521f53f351420223dbf14e0067d62d6e3f58b4bc9efee591736fc6e922d7e97d21aae4b373a32e92d446b317
+  data.tar.gz: a7930ffe63ac272075fe9af8bb1201b388bda1045c228815cb26ad64885c1189bdf84a2d610addcbeaa0c5bb73d6e2187aea1cb375d1b3a2e8a3773f455a5816

data/README.md

@@ -1,6 +1,10 @@
 # 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.
+
+Emailbutler allows you to monitor the sending of letters, collects notifications from providers about the success of delivery and adds an UI for monitoring deliveries with filtering by recipients, mailers and actions.
 
 ## Installation
 
@@ -32,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
 ```
 
@@ -42,6 +47,37 @@ Add this line to config/routes.rb
 mount Emailbutler::Engine => '/emailbutler'
 ```
 
+#### Custom routes
+
+If you need some custom behaviour you can specify your own route and use custom controller, something like
+
+```ruby
+class SendgridController < ApplicationController
+  skip_before_action :basic_authentication
+  skip_before_action :verify_authenticity_token
+
+  def create
+    ... you can add some logic here
+
+    ::Emailbutler::Webhooks::Receiver.call(
+      user_agent: request.headers['HTTP_USER_AGENT'],
+      payload: receiver_params.to_h
+    )
+
+    head :ok
+  end
+
+  private
+
+  def receiver_params
+    params.permit(
+      'event', 'sendtime', 'message-id',
+      '_json' => %w[event timestamp smtp-id sg_message_id]
+    )
+  end
+end
+```
+
 ### UI styles
 
 For adding styles for UI you need to add this line to assets/config/manifest.js
@@ -49,6 +85,12 @@ For adding styles for UI you need to add this line to assets/config/manifest.js
 //= link emailbutler.css
 ```
 
+Or in some cases you can specify it in assets/javascript/application.js
+
+```js
+//= require emailbutler_manifest
+````
+
 ### Mailers
 
 Update you application mailer
@@ -68,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.
@@ -81,6 +131,5 @@ Emailbutler provides UI with rendering email tracking statistics - /emailbutler/
 
 <img width="1461" alt="ui_show" src="https://user-images.githubusercontent.com/6195394/202743225-b0ba0ca2-d373-428c-973d-5ec4566a3784.png">
 
-
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/emailbutler/ui/messages_controller.rb

@@ -6,19 +6,19 @@ module Emailbutler
       before_action :find_message
 
       def update
-        Emailbutler.resend_message(@message)
+        ::Emailbutler.resend_message(@message)
         redirect_to ui_index_path
       end
 
       def destroy
-        Emailbutler.destroy_message(@message)
+        ::Emailbutler.destroy_message(@message)
         redirect_to ui_index_path
       end
 
       private
 
       def find_message
-        @message = Emailbutler.find_message_by(uuid: params[:id])
+        @message = ::Emailbutler.find_message_by(uuid: params[:id])
       end
     end
   end

data/app/controllers/emailbutler/ui_controller.rb

@@ -4,18 +4,18 @@ require 'pagy'
 
 module Emailbutler
   class UiController < Emailbutler::ApplicationController
-    include Pagy::Backend
+    include ::Pagy::Backend
 
-    http_basic_authenticate_with name: Emailbutler.configuration.ui_username,
-                                 password: Emailbutler.configuration.ui_password,
+    http_basic_authenticate_with name: ::Emailbutler.configuration.ui_username,
+                                 password: ::Emailbutler.configuration.ui_password,
                                  if: -> { basic_auth_enabled? }
 
     def index
-      @summary = Emailbutler.count_messages_by_status
+      @summary = ::Emailbutler.count_messages_by_status
     end
 
     def show
-      @pagy, @messages = pagy(Emailbutler.find_messages_by(search_condition))
+      @pagy, @messages = pagy(::Emailbutler.find_messages_by(search_condition))
     end
 
     private
@@ -30,7 +30,7 @@ module Emailbutler
     end
 
     def basic_auth_enabled?
-      configuration = Emailbutler.configuration
+      configuration = ::Emailbutler.configuration
 
       return false if configuration.ui_username.blank?
       return false if configuration.ui_password.blank?

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])
+      params.permit(
+        'event', 'sendtime', 'message-id',
+        '_json' => %w[event timestamp smtp-id sg_message_id]
+      )
     end
   end
 end

data/app/helpers/emailbutler/application_helper.rb

@@ -2,6 +2,6 @@
 
 module Emailbutler
   module ApplicationHelper
-    include Pagy::Frontend
+    include ::Pagy::Frontend
   end
 end

data/app/views/emailbutler/ui/index.html.erb

@@ -6,7 +6,7 @@
         <span>Total</span>
       <% end %>
     </li>
-    <% Emailbutler.adapter.message_class.statuses.each_key do |status| %>
+    <% ::Emailbutler.adapter.message_class.statuses.each_key do |status| %>
       <li>
         <%= link_to ui_path(status), class: 'status-summary' do %>
           <span><%= @summary[status].to_i %></span>

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.0'
+  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.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-19 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