emailbutler 0.2.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c998b3d9e29ae064f2b2881b392661d785534883a28f40cb7fd5e846e5cf69
-  data.tar.gz: 4952983e5fc06ea2e90f2d2504d66d6c7ea083281796d30b7e71154096235e1d
+  metadata.gz: 97c7cc6c31716442ed040ee06b451d2a3a6abdac9262c08e5fee1c9c6de4f385
+  data.tar.gz: '048cacc8bb87d36cd5bd7b5ccced2b726dcde665ec3398adc348a605a2dd6774'
 SHA512:
-  metadata.gz: eedddd11e3d27324ceeb712c3f9821ede81fe3a02970166c6d7c67b546333ffdd8ce5ffc9cf885879a8020c966233c6aa51088d683546dda472645156f77c3d2
-  data.tar.gz: da1e97498ff6853525d05a8cfe988aef95cccd3b82e39803c966218945904a45c2830b17bd3a5eea5a728b02eb0e47faf0e4d3b9fdd2e503c87423f3d816df6d
+  metadata.gz: ed85dfd33c8f3a0e3f2a091db4921f1a70d696abbfd0869408bca4a1fa66f6f90bfd3d542a88f204b29c0e2c2c9b0a328e9252d1ba5183b7de8edeafc889abb1
+  data.tar.gz: 688b1af36d7eaa8ce68f5467ed4a7c22cdd442e0d126e013ac1b9c890f1ff1e308079fe9ee32696403aa21921d1f04f7b78ed3ca68f643bd735981cef571d4c4

data/README.md

@@ -29,6 +29,9 @@ 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']
 end
 ```
 
@@ -63,5 +66,10 @@ end
 1. Each event with sending email will create new record with message params in database.
 2. Each webhook event will update status of message in database.
 
+### UI
+
+Emailbutler provides UI with rendering email tracking statistics - /emailbutler/ui.
+And with opportunity to resend and/or destroy emails.
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/config/emailbutler_manifest.js

@@ -1 +1 @@
-//= link_directory ../stylesheets/emailbutler .css
+//= link_directory ../stylesheets .css

data/app/assets/stylesheets/emailbutler/core/base.scss

@@ -0,0 +1,42 @@
+@import url('https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600&display=swap&subset=cyrillic');
+
+#emailbutler, #emailbutler body {
+  margin: 0;
+  padding: 0;
+  min-height: 100vh;
+  height: 100%;
+}
+
+#emailbutler {
+  font-family: "Source Sans Pro", "Helvetica", "Open Sans", sans-serif;
+  box-sizing: border-box;
+
+  body {
+    position: relative;
+    display: flex;
+    flex-direction: column;
+
+    * {
+      box-sizing: border-box;
+
+      &:focus {
+        outline: none;
+      }
+    }
+
+    p {
+      margin: 0;
+    }
+
+    .content {
+      flex: 1;
+      width: 100%;
+      max-width: 90rem;
+      margin: 0 auto;
+    }
+
+    h1, h2, h3, h4, h5, h6 {
+      margin: 0;
+    }
+  }
+}

data/app/assets/stylesheets/emailbutler/shared/footer.scss

@@ -0,0 +1,10 @@
+footer {
+  border-top: 1px solid #e5e7eb;
+
+  .footer-wrapper {
+    width: 100%;
+    max-width: 90rem;
+    margin: 0 auto;
+    padding: .5rem 1rem;
+  }
+}

data/app/assets/stylesheets/emailbutler/shared/header.scss

@@ -0,0 +1,26 @@
+header {
+  border-bottom: 1px solid #e5e7eb;
+
+  .header-wrapper {
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+    width: 100%;
+    max-width: 90rem;
+    margin: 0 auto;
+    padding: .5rem 0;
+
+    a {
+      text-decoration: none;
+      color: #000;
+    }
+  }
+}
+
+@media screen and (max-width: 48rem) {
+  header {
+    .header-wrapper {
+      flex-direction: column;
+    }
+  }
+}

data/app/assets/stylesheets/emailbutler/views/dashboard.scss

@@ -0,0 +1,121 @@
+#emailbutler {
+  #dashboard {
+    padding-top: 1rem;
+    display: flex;
+
+    .summary {
+      list-style: none;
+      flex: 1;
+      display: flex;
+      flex-direction: row;
+      padding: .75rem 1rem;
+      background: #e5e7eb;
+      border-radius: .125rem;
+      margin: 0;
+
+      li {
+        flex: 1;
+        text-align: center;
+
+        a {
+          text-decoration: none;
+        }
+      }
+
+      .status-summary {
+        display: flex;
+        flex-direction: column;
+        color: #000;
+        padding: .5rem 0;
+
+        &:hover {
+          background: #d1d5db;
+        }
+
+        span:nth-of-type(1) {
+          margin-bottom: .25rem;
+          font-weight: 600;
+        }
+      }
+    }
+
+    .search-form {
+      width: 20rem;
+      padding-right: 2rem;
+
+      .form-field {
+        display: flex;
+        flex-direction: column;
+        margin-bottom: .5rem;
+
+        label {
+          margin-bottom: .25rem;
+        }
+
+        input {
+          padding: .25rem;
+        }
+      }
+    }
+
+    .messages {
+      flex: 1;
+      height: 100%;
+
+      thead {
+        tr {
+          th {
+            text-align: left;
+            padding: .125rem .25rem;
+          }
+        }
+      }
+
+      tbody {
+        tr {
+          &:nth-of-type(odd) {
+            background: #e5e7eb;
+          }
+
+          &:hover {
+            background: #d1d5db;
+          }
+
+          td {
+            padding: .125rem .25rem;
+
+            &.actions {
+              display: flex;
+
+              button {
+                &:nth-of-type(1) {
+                  margin-right: .5rem;
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+
+  .button {
+    box-shadow: none;
+    border: none;
+    cursor: pointer;
+    padding: .25rem;
+    background: #bbf7d0;
+
+    &:hover {
+      background: #86efac;
+    }
+
+    &.warning {
+      background: #fecaca;
+
+      &:hover {
+        background: #fca5a5;
+      }
+    }
+  }
+}

data/app/assets/stylesheets/emailbutler.scss

@@ -0,0 +1,4 @@
+@import 'emailbutler/core/base';
+@import 'emailbutler/shared/header';
+@import 'emailbutler/shared/footer';
+@import 'emailbutler/views/dashboard';

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Emailbutler
+  module Ui
+    class MessagesController < Emailbutler::UiController
+      before_action :find_message
+
+      def update
+        Emailbutler.resend_message(@message)
+        redirect_to ui_index_path
+      end
+
+      def destroy
+        Emailbutler.destroy_message(@message)
+        redirect_to ui_index_path
+      end
+
+      private
+
+      def find_message
+        @message = Emailbutler.find_message_by(uuid: params[:id])
+      end
+    end
+  end
+end

data/app/controllers/emailbutler/ui_controller.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Emailbutler
+  class UiController < Emailbutler::ApplicationController
+    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
+    end
+
+    def show
+      @messages = Emailbutler.find_messages_by(search_condition)
+    end
+
+    private
+
+    def search_condition
+      {
+        status: params[:id],
+        mailer: params[:mailer_name].presence,
+        action: params[:action_name].presence,
+        send_to: [params[:receiver].presence].compact.presence
+      }.compact
+    end
+
+    def basic_auth_enabled?
+      configuration = Emailbutler.configuration
+
+      return false if configuration.ui_username.blank?
+      return false if configuration.ui_password.blank?
+
+      configuration.ui_secured_environments.include?(Rails.env)
+    end
+  end
+end

data/app/controllers/emailbutler/webhooks_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Emailbutler
-  class WebhooksController < ApplicationController
+  class WebhooksController < Emailbutler::ApplicationController
     skip_before_action :verify_authenticity_token
 
     def create

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

@@ -0,0 +1,16 @@
+<div id="dashboard">
+  <ul class="summary">
+    <li class="status-summary">
+      <span><%= @summary.values.sum %></span>
+      <span>Total</span>
+    </li>
+    <% 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>
+          <span><%= status.capitalize %></span>
+        <% end %>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/app/views/emailbutler/ui/shared/_footer.html.erb

@@ -0,0 +1,8 @@
+<footer>
+  <div class="footer-wrapper flex flex-row justify-between">
+    <div>
+    </div>
+    <div>
+    </div>
+  </div>
+</footer>

data/app/views/emailbutler/ui/shared/_header.html.erb

@@ -0,0 +1,9 @@
+<header>
+  <div class="header-wrapper flex justify-between items-center">
+    <%= link_to ui_index_path do %>
+      <h1>Emailbutler</h1>
+    <% end %>
+    <nav>
+    </nav>
+  </div>
+</header>

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

@@ -0,0 +1,52 @@
+<div id="dashboard">
+  <section class="search-form">
+    <%= form_with url: ui_path(params[:id]), method: :get do |form| %>
+      <div class="form-field">
+        <%= form.label :mailer_name, 'Mailer', class: 'form-label' %>
+        <%= form.text_field :mailer_name, class: 'form-value', value: params[:mailer_name] %>
+      </div>
+      <div class="form-field">
+        <%= form.label :action_name, 'Action', class: 'form-label' %>
+        <%= form.text_field :action_name, class: 'form-value', value: params[:action_name] %>
+      </div>
+      <div class="form-field">
+        <%= form.label :receiver, 'Receiver', class: 'form-label' %>
+        <%= form.text_field :receiver, class: 'form-value', value: params[:receiver] %>
+      </div>
+      <%= form.submit 'Search', class: 'button' %>
+    <% end %>
+  </section>
+  <table class="messages" cellspacing="0">
+    <thead>
+      <tr>
+        <th>ID</th>
+        <th>Mailer</th>
+        <th>Action</th>
+        <th>Send to</th>
+        <th>Action params</th>
+        <th>Mailer params</th>
+        <th></th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @messages.each do |message| %>
+        <tr>
+          <td><%= message.id %></td>
+          <td><%= message.mailer %></td>
+          <td><%= message.action %></td>
+          <td>
+            <% message.send_to.each do |receiver| %>
+              <p><%= receiver %></p>
+            <% end %>
+          </td>
+          <td><%= message.params['action_params'] %></td>
+          <td><%= message.params['mailer_params'] %></td>
+          <td class="actions">
+            <%= button_to 'Resend', ui_message_path(message.uuid), method: :patch, class: 'button' %>
+            <%= button_to 'Destroy', ui_message_path(message.uuid), method: :delete, class: 'button warning' %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/app/views/layouts/emailbutler/application.html.erb

@@ -1,12 +1,16 @@
 <!DOCTYPE html>
-<html>
+<html id="emailbutler">
   <head>
     <title>Emailbutler</title>
     <%= csrf_meta_tags %>
     <%= csp_meta_tag %>
-    <%= stylesheet_link_tag 'emailbutler/application', media: 'all' %>
+    <%= stylesheet_link_tag 'emailbutler', media: 'all' %>
   </head>
-  <body>
-    <%= yield %>
+  <body id="emailbutler-body">
+    <%= render 'emailbutler/ui/shared/header' %>
+    <div class="content">
+      <%= yield %>
+    </div>
+    <%= render 'emailbutler/ui/shared/footer' %>
   </body>
 </html>

data/config/routes.rb

@@ -2,4 +2,9 @@
 
 Emailbutler::Engine.routes.draw do
   post '/webhooks', to: 'webhooks#create'
+
+  resources :ui, only: %i[index show]
+  namespace :ui do
+    resources :messages, only: %i[update destroy]
+  end
 end

data/lib/emailbutler/adapters/active_record.rb

@@ -5,6 +5,8 @@ require 'active_record'
 module Emailbutler
   module Adapters
     class ActiveRecord
+      include Emailbutler::Helpers
+
       # Abstract base class for internal models
       class Model < ::ActiveRecord::Base
         self.abstract_class = true
@@ -68,6 +70,29 @@ module Emailbutler
       rescue ::ActiveRecord::StaleObjectError
         update_message(message.reload, args)
       end
+
+      # Public: Groups messages by status and count them.
+      def count_messages_by_status
+        @message_class.group(:status).count
+      end
+
+      # Public: Finds messages by args.
+      def find_messages_by(args={})
+        @message_class.where(args).order(created_at: :desc)
+      end
+
+      # Public: Resends the message.
+      def resend_message(message)
+        ::ActiveRecord::Base.transaction do
+          message.destroy
+          resend_message_with_mailer(message)
+        end
+      end
+
+      # Public: Destroy the message.
+      def destroy_message(message)
+        message.destroy
+      end
     end
   end
 end

data/lib/emailbutler/configuration.rb

@@ -2,10 +2,17 @@
 
 module Emailbutler
   class Configuration
-    attr_accessor :adapter
+    attr_accessor :adapter, :ui_username, :ui_password, :ui_secured_environments
 
     def initialize
       @adapter = nil
+
+      # 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 = []
     end
   end
 end

data/lib/emailbutler/dsl.rb

@@ -35,5 +35,25 @@ module Emailbutler
     def update_message(message, args={})
       adapter.update_message(message, args)
     end
+
+    # Public: Groups messages by status and count them.
+    def count_messages_by_status
+      adapter.count_messages_by_status
+    end
+
+    # Public: Finds messages by args.
+    def find_messages_by(args={})
+      adapter.find_messages_by(args)
+    end
+
+    # Public: Resends the message.
+    def resend_message(message)
+      adapter.resend_message(message)
+    end
+
+    # Public: Destroys the message.
+    def destroy_message(message)
+      adapter.destroy_message(message)
+    end
   end
 end

data/lib/emailbutler/helpers.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Emailbutler
+  module Helpers
+    private
+
+    def resend_message_with_mailer(message)
+      params = message.params
+
+      mailer = message.mailer.constantize
+      mailer = mailer.with(serialize(params['mailer_params'])) if params['mailer_params'].present?
+      mailer = mailer.method(message.action)
+      mailer = params['action_params'] ? mailer.call(*serialize(params['action_params'])) : mailer.call
+      mailer.deliver_now
+    end
+
+    def serialize(value, reverse=true)
+      return value.map { |element| serialize(element, reverse) } if value.is_a?(Array)
+      return value.transform_values { |element| serialize(element, reverse) } if value.is_a?(Hash)
+
+      reverse ? deserialize_value(value) : serialize_value(value)
+    end
+
+    def serialize_value(value)
+      return value.to_global_id.to_s if value.respond_to?(:to_global_id)
+
+      value
+    end
+
+    def deserialize_value(value)
+      return GlobalID::Locator.locate(value) if value.is_a?(String) && value.starts_with?('gid://')
+
+      value
+    end
+  end
+end

data/lib/emailbutler/mailers/helpers.rb

@@ -4,6 +4,7 @@ module Emailbutler
   module Mailers
     module Helpers
       extend ActiveSupport::Concern
+      include Emailbutler::Helpers
 
       included do
         after_action :save_emailbutler_message
@@ -21,18 +22,10 @@ module Emailbutler
         @message = Emailbutler.build_message(
           mailer: self.class.to_s,
           action: action_name,
-          params: serialize_params(mailer_params: params, action_params: args[1..])
+          params: serialize({ mailer_params: params, action_params: args[1..] }, false)
         )
       end
 
-      def serialize_params(value)
-        return value.map { |element| serialize_params(element) } if value.is_a?(Array)
-        return value.transform_values { |element| serialize_params(element) } if value.is_a?(Hash)
-        return value.to_global_id.to_s if value.respond_to?(:to_global_id)
-
-        value
-      end
-
       def save_emailbutler_message
         Emailbutler.set_message_attribute(@message, :send_to, mail.to)
         Emailbutler.save_message(@message)

data/lib/emailbutler/version.rb

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

data/lib/emailbutler.rb

@@ -7,6 +7,7 @@ require 'emailbutler/engine'
 require 'emailbutler/configuration'
 require 'emailbutler/dsl'
 require 'emailbutler/webhooks/receiver'
+require 'emailbutler/helpers'
 require 'emailbutler/mailers/helpers'
 
 module Emailbutler
@@ -42,5 +43,5 @@ module Emailbutler
   # Public: All the methods delegated to instance. These should match the interface of Emailbutler::DSL.
   def_delegators :instance,
                  :adapter, :build_message, :set_message_attribute, :save_message, :find_message_by,
-                 :update_message
+                 :update_message, :count_messages_by_status, :find_messages_by, :resend_message, :destroy_message
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emailbutler
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-16 00:00:00.000000000 Z
+date: 2022-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 6.0.0
 - !ruby/object:Gem::Dependency
-  name: sprockets-rails
+  name: sass-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.39'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.39'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +150,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Write a longer description or delete this line.
+description: Emailbutler allows you to track delivery status of emails sent by your
+  app.
 email:
 - kortirso@gmail.com
 executables: []
@@ -161,17 +162,27 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/emailbutler_manifest.js
-- app/assets/stylesheets/emailbutler/application.css
+- app/assets/stylesheets/emailbutler.scss
+- app/assets/stylesheets/emailbutler/core/base.scss
+- app/assets/stylesheets/emailbutler/shared/footer.scss
+- app/assets/stylesheets/emailbutler/shared/header.scss
+- app/assets/stylesheets/emailbutler/views/dashboard.scss
 - app/controllers/emailbutler/application_controller.rb
+- app/controllers/emailbutler/ui/messages_controller.rb
+- app/controllers/emailbutler/ui_controller.rb
 - app/controllers/emailbutler/webhooks_controller.rb
+- app/views/emailbutler/ui/index.html.erb
+- app/views/emailbutler/ui/shared/_footer.html.erb
+- app/views/emailbutler/ui/shared/_header.html.erb
+- app/views/emailbutler/ui/show.html.erb
 - app/views/layouts/emailbutler/application.html.erb
 - config/routes.rb
-- db/migrate/20220916162720_create_emailbutler_tables.rb
 - lib/emailbutler.rb
 - lib/emailbutler/adapters/active_record.rb
 - lib/emailbutler/configuration.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/sendgrid.rb
@@ -204,5 +215,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: Email tracker for Ruby on Rails applications.
 test_files: []

data/app/assets/stylesheets/emailbutler/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/db/migrate/20220916162720_create_emailbutler_tables.rb

@@ -1,23 +0,0 @@
-class CreateEmailbutlerTables < ActiveRecord::Migration[7.0]
-  def self.up
-    enable_extension 'pgcrypto' unless extensions.include?('pgcrypto')
-    enable_extension 'uuid-ossp' unless extensions.include?('uuid-ossp')
-
-    create_table :emailbutler_messages do |t|
-      t.uuid :uuid, null: false, default: ''
-      t.string :mailer, null: false
-      t.string :action, null: false
-      t.jsonb :params, null: false, default: {}
-      t.string :send_to, array: true
-      t.integer :status, null: false, default: 0
-      t.datetime :timestamp
-      t.integer :lock_version
-      t.timestamps
-    end
-    add_index :emailbutler_messages, :uuid, unique: true
-  end
-
-  def self.down
-    drop_table :emailbutler_messages
-  end
-end