emailbutler 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97c7cc6c31716442ed040ee06b451d2a3a6abdac9262c08e5fee1c9c6de4f385
-  data.tar.gz: '048cacc8bb87d36cd5bd7b5ccced2b726dcde665ec3398adc348a605a2dd6774'
+  metadata.gz: 66b96f7ab9361587e0c960875903a0c85cece5ed19ed6891a2acac9027600735
+  data.tar.gz: 93d341ed01c2a44c50b84bcdcbce9bb174a6aae6f88e896ac4f8e2a298a9cb2b
 SHA512:
-  metadata.gz: ed85dfd33c8f3a0e3f2a091db4921f1a70d696abbfd0869408bca4a1fa66f6f90bfd3d542a88f204b29c0e2c2c9b0a328e9252d1ba5183b7de8edeafc889abb1
-  data.tar.gz: 688b1af36d7eaa8ce68f5467ed4a7c22cdd442e0d126e013ac1b9c890f1ff1e308079fe9ee32696403aa21921d1f04f7b78ed3ca68f643bd735981cef571d4c4
+  metadata.gz: 2c3b0c916fc98bde2ab88bc1b0a226288ab1bb5123faac70b121b6d025e22e6892bfc56d55bbffb96f0c9370b15be8b4f096f3d3c773b1afd4baa614aa687fc6
+  data.tar.gz: b844827b40c941522993c4993a4c0aa2ab75d789a703189ed1f47c92733166a34d1c16f9b93d7e599d3a699d88e82655024146d4f879c7f28ce880457d1f9986

data/README.md

@@ -42,6 +42,13 @@ Add this line to config/routes.rb
 mount Emailbutler::Engine => '/emailbutler'
 ```
 
+### UI styles
+
+For adding styles for UI you need to add this line to assets/config/manifest.js
+```js
+//= link emailbutler.css
+```
+
 ### Mailers
 
 Update you application mailer
@@ -68,8 +75,12 @@ end
 
 ### UI
 
-Emailbutler provides UI with rendering email tracking statistics - /emailbutler/ui.
-And with opportunity to resend and/or destroy emails.
+Emailbutler provides UI with rendering email tracking statistics - /emailbutler/ui, with opportunity to search, resend and/or destroy emails.
+
+<img width="1463" alt="ui_index" src="https://user-images.githubusercontent.com/6195394/202743189-19d1845d-7991-494f-93c1-0dd92b0b5dac.png">
+
+<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/assets/stylesheets/emailbutler/views/dashboard.scss

@@ -62,34 +62,52 @@
       flex: 1;
       height: 100%;
 
-      thead {
-        tr {
-          th {
-            text-align: left;
-            padding: .125rem .25rem;
+      .pagination {
+        margin-bottom: 1rem;
+
+        .page {
+          padding: .25rem .5rem;
+          background: #bbf7d0;
+          color: #000;
+
+          a {
+            color: #000;
           }
         }
       }
 
-      tbody {
-        tr {
-          &:nth-of-type(odd) {
-            background: #e5e7eb;
-          }
+      table {
+        width: 100%;
 
-          &:hover {
-            background: #d1d5db;
+        thead {
+          tr {
+            th {
+              text-align: left;
+              padding: .125rem .25rem;
+            }
           }
+        }
+
+        tbody {
+          tr {
+            &:nth-of-type(odd) {
+              background: #e5e7eb;
+            }
+
+            &:hover {
+              background: #d1d5db;
+            }
 
-          td {
-            padding: .125rem .25rem;
+            td {
+              padding: .125rem .25rem;
 
-            &.actions {
-              display: flex;
+              &.actions {
+                display: flex;
 
-              button {
-                &:nth-of-type(1) {
-                  margin-right: .5rem;
+                button {
+                  &:nth-of-type(1) {
+                    margin-right: .5rem;
+                  }
                 }
               }
             }

data/app/controllers/emailbutler/ui_controller.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require 'pagy'
+
 module Emailbutler
   class UiController < Emailbutler::ApplicationController
+    include Pagy::Backend
+
     http_basic_authenticate_with name: Emailbutler.configuration.ui_username,
                                  password: Emailbutler.configuration.ui_password,
                                  if: -> { basic_auth_enabled? }
@@ -11,14 +15,14 @@ module Emailbutler
     end
 
     def show
-      @messages = Emailbutler.find_messages_by(search_condition)
+      @pagy, @messages = pagy(Emailbutler.find_messages_by(search_condition))
     end
 
     private
 
     def search_condition
       {
-        status: params[:id],
+        status: params[:id] == 'all' ? nil : params[:id],
         mailer: params[:mailer_name].presence,
         action: params[:action_name].presence,
         send_to: [params[:receiver].presence].compact.presence

data/app/helpers/emailbutler/application_helper.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Emailbutler
+  module ApplicationHelper
+    include Pagy::Frontend
+  end
+end

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

@@ -1,8 +1,10 @@
 <div id="dashboard">
   <ul class="summary">
-    <li class="status-summary">
-      <span><%= @summary.values.sum %></span>
-      <span>Total</span>
+    <li>
+      <%= link_to ui_path(:all), class: 'status-summary' do %>
+        <span><%= @summary.values.sum %></span>
+        <span>Total</span>
+      <% end %>
     </li>
     <% Emailbutler.adapter.message_class.statuses.each_key do |status| %>
       <li>

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

@@ -16,37 +16,46 @@
       <%= 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| %>
+  <section class="messages">
+    <%== pagy_nav(@pagy) %>
+    <table cellspacing="0">
+      <thead>
         <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>
+          <th>ID</th>
+          <th>Mailer</th>
+          <th>Action</th>
+          <th>Send to</th>
+          <% if params[:id] == 'all' %>
+            <th>Status</th>
+          <% end %>
+          <th>Action params</th>
+          <th>Mailer params</th>
+          <th></th>
         </tr>
-      <% end %>
-    </tbody>
-  </table>
+      </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>
+            <% if params[:id] == 'all' %>
+              <td><%= message.status %></td>
+            <% end %>
+            <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>
+  </section>
 </div>

data/lib/emailbutler/version.rb

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

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

@@ -12,8 +12,8 @@ module Emailbutler
           'dropped' => 'failed'
         }.freeze
 
-        def self.call(args={})
-          new.call(**args)
+        def self.call(...)
+          new.call(...)
         end
 
         def call(payload:)

data/lib/emailbutler/webhooks/receiver.rb

@@ -7,8 +7,8 @@ module Emailbutler
     class Receiver
       SENDGRID_USER_AGENT = 'SendGrid Event API'
 
-      def self.call(args={})
-        new.call(**args)
+      def self.call(...)
+        new.call(...)
       end
 
       def call(user_agent:, payload:)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: emailbutler
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +185,7 @@ files:
 - app/controllers/emailbutler/ui/messages_controller.rb
 - app/controllers/emailbutler/ui_controller.rb
 - app/controllers/emailbutler/webhooks_controller.rb
+- app/helpers/emailbutler/application_helper.rb
 - app/views/emailbutler/ui/index.html.erb
 - app/views/emailbutler/ui/shared/_footer.html.erb
 - app/views/emailbutler/ui/shared/_header.html.erb