emailbutler 0.7.5 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d52c909134e2f3b77b2458f302694c82774d99e8b2796228e68b4c0a89bba8d
-  data.tar.gz: e4d8414a09f7ba180ba92afb6296d538a279a226256bfe835bc3e19f67f13d8f
+  metadata.gz: fb57bd8a59942207f28941dd14e91f17cd5d74982877773415a38b925d49ccaa
+  data.tar.gz: 0fc748f32a49291175cccdff3a9e89dfe2aefafaacd1c357df38c545d18d768a
 SHA512:
-  metadata.gz: 44aeeefa0da557fe1c2393ae6df65e0d560bd2a840e334e4123204dd459dc355b3c6b8bdbcc5180b18c6c85c4ebcec9403d4d4fc909c2c7231c854b2a3a00d39
-  data.tar.gz: 74a4bd2dbc4bcd2aa8bb54adb757cce56d5c8bb408332e7acb639ae7bb80c15a083d597d4e3272bd6ae71de84666b856722cde6088456b52c9f29c4f651d34cf
+  metadata.gz: 0b5a8e3d1c292ff847623e7f404c5535d4324d9f206b0a15905b982fda3c42bd566039cb6e01727b085b7f924899ec07ffdd8a2d05e5fa418eba4d048f7012f1
+  data.tar.gz: d1bed20baaadc9b02fe3b8e8f8d4412e575977121d376f2077e18adc35349f5db261c7216f98b0cd0b87a7f875041c7f5614d70cd0c5dc6fe0fd8c6f42091045

data/README.md

@@ -27,16 +27,17 @@ $ rails db:migrate
 
 Add configuration line to config/initializers/emailbutler.rb:
 
-#### ActiveRecord
+#### For ActiveRecord
 
 ```ruby
 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']
+  config.adapter = Emailbutler::Adapters::ActiveRecord.new # required
+  config.providers = %w[sendgrid smtp2go] # required at least 1 provider since 0.8
+  config.ui_username = 'username' # optional
+  config.ui_password = 'password' # optional
+  config.ui_secured_environments = ['production'] # optional
 end
 ```
 
@@ -59,9 +60,9 @@ class SendgridController < ApplicationController
   def create
     ... you can add some logic here
 
-    ::Emailbutler::Webhooks::Receiver.call(
-      user_agent: request.headers['HTTP_USER_AGENT'],
-      payload: receiver_params.to_h
+    Emailbutler::Container.resolve(:webhooks_receiver).call(
+      mapper: Emailbutler::Container.resolve(:sendgrid_mapper),
+      payload: receiver_params
     )
 
     head :ok
@@ -70,10 +71,7 @@ class SendgridController < ApplicationController
   private
 
   def receiver_params
-    params.permit(
-      'event', 'sendtime', 'message-id',
-      '_json' => %w[event timestamp smtp-id sg_message_id]
-    )
+    params.permit('event', 'sendtime', 'message-id').to_h
   end
 end
 ```
@@ -106,7 +104,7 @@ end
 
 - go to [Mail settings](https://app.sendgrid.com/settings/mail_settings),
 - turn on Event Webhook,
-- in the HTTP POST URL field, paste the URL to webhook controller of your app,
+- in the HTTP POST URL field, paste the URL to webhook controller of your app (host/emailbutler/webhooks/sendgrid),
 - select all deliverability data,
 - save settings.
 
@@ -114,7 +112,7 @@ end
 
 - 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,
+- in the HTTP POST URL field, paste the URL to webhook controller of your app (host/emailbutler/webhooks/smtp2go),
 - select all deliverability data,
 - save settings.
 

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

@@ -62,6 +62,7 @@
       flex: 1;
       height: 100%;
 
+      // styles for backcompability with gem pagy < 7.0
       .pagination {
         margin-bottom: 1rem;
 
@@ -76,6 +77,19 @@
         }
       }
 
+      // styles for gem pagy >= 7.0
+      nav.pagy.nav {
+        margin-bottom: 1rem;
+
+        a {
+          padding: .25rem .5rem;
+          margin-right: .25rem;
+          background: #bbf7d0;
+          color: #000;
+          border-radius: .125rem;
+        }
+      }
+
       table {
         width: 100%;
 

data/app/controllers/emailbutler/webhooks_controller.rb

@@ -2,12 +2,26 @@
 
 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::Webhooks::Receiver.call(
-        user_agent: request.headers['HTTP_USER_AGENT'],
-        payload: receiver_params.to_h
+      Emailbutler::Container.resolve(:webhooks_receiver).call(
+        mapper: receiver_mapper,
+        payload: mapper_params.to_h
       )
 
       head :ok
@@ -15,7 +29,40 @@ module Emailbutler
 
     private
 
-    def receiver_params
+    def validate_provider
+      head :ok if Emailbutler.configuration.providers.exclude?(params[:provider])
+    end
+
+    def receiver_mapper
+      case params[:provider]
+      when 'sendgrid' then Emailbutler::Container.resolve(:sendgrid_mapper)
+      when 'smtp2go' then Emailbutler::Container.resolve(:smtp2go_mapper)
+      end
+    end
+
+    def mapper_params
+      case params[:provider]
+      when 'sendgrid' then sendgrid_params
+      when 'smtp2go' then smtp2go_params
+      end
+    end
+
+    def sendgrid_params
+      params.permit('_json' => %w[smtp-id event timestamp sg_message_id])
+    end
+
+    def smtp2go_params
+      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]

data/config/routes.rb

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

data/lib/emailbutler/configuration.rb

@@ -2,16 +2,66 @@
 
 module Emailbutler
   class Configuration
-    attr_accessor :adapter, :ui_username, :ui_password, :ui_secured_environments
+    InitializeError = Class.new(StandardError)
+
+    AVAILABLE_ADAPTERS = %w[
+      Emailbutler::Adapters::ActiveRecord
+    ].freeze
+    AVAILABLE_PROVIDERS = %w[sendgrid smtp2go].freeze
+
+    attr_accessor :adapter, :providers, :ui_username, :ui_password, :ui_secured_environments
 
     def initialize
       @adapter = nil
+      @providers = []
 
       # It's required to specify these 3 variables to enable basic auth to UI
-      @ui_username = ''
-      @ui_password = ''
+      @ui_username = nil
+      @ui_password = nil
       # Secured environments variable must directly contains environment names
       @ui_secured_environments = []
     end
+
+    def validate
+      validate_adapter
+      validate_providers
+      validate_username
+      validate_password
+      validate_secured_environments
+    end
+
+    private
+
+    def validate_adapter
+      raise InitializeError, 'Adapter must be present' if adapter.nil?
+      raise InitializeError, 'Invalid adapter' if AVAILABLE_ADAPTERS.exclude?(adapter.class.name)
+    end
+
+    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) }
+
+      raise InitializeError, 'Providers list contain invalid element'
+    end
+
+    def validate_username
+      return if ui_username.blank?
+      return if ui_username.is_a?(String)
+
+      raise InitializeError, 'Username must be nil or filled string'
+    end
+
+    def validate_password
+      return if ui_password.blank?
+      return if ui_password.is_a?(String)
+
+      raise InitializeError, 'Password must be nil or filled string'
+    end
+
+    def validate_secured_environments
+      raise InitializeError, 'Environments list must be array' unless ui_secured_environments.is_a?(Array)
+    end
   end
 end

data/lib/emailbutler/container.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'dry/container'
+require 'emailbutler/webhooks/mappers/sendgrid'
+require 'emailbutler/webhooks/mappers/smtp2go'
+require 'emailbutler/webhooks/receiver'
+
+module Emailbutler
+  class Container
+    extend Dry::Container::Mixin
+
+    DEFAULT_OPTIONS = { memoize: true }.freeze
+
+    class << self
+      def register(key)
+        super(key, DEFAULT_OPTIONS)
+      end
+    end
+
+    # webhook mappers
+    register(:sendgrid_mapper) { Emailbutler::Webhooks::Mappers::Sendgrid.new }
+    register(:smtp2go_mapper) { Emailbutler::Webhooks::Mappers::Smtp2Go.new }
+
+    # webhook receiver
+    register(:webhooks_receiver) { Emailbutler::Webhooks::Receiver.new }
+  end
+end

data/lib/emailbutler/version.rb

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

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

@@ -15,10 +15,6 @@ module Emailbutler
           'spamreport' => 'failed'
         }.freeze
 
-        def self.call(...)
-          new.call(...)
-        end
-
         def call(payload:)
           payload['_json'].filter_map { |message|
             message.stringify_keys!

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

@@ -14,10 +14,6 @@ module Emailbutler
           'spam' => 'failed'
         }.freeze
 
-        def self.call(...)
-          new.call(...)
-        end
-
         def call(payload:)
           payload.stringify_keys!
           # message-id contains data like <uuid>

data/lib/emailbutler/webhooks/receiver.rb

@@ -1,25 +1,9 @@
 # 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:)
-        mapper = RECEIVERS_MAPPER[user_agent]
+      def call(mapper:, payload:)
         return unless mapper
 
         mapper

data/lib/emailbutler.rb

@@ -6,38 +6,49 @@ require 'emailbutler/version'
 require 'emailbutler/engine'
 require 'emailbutler/configuration'
 require 'emailbutler/dsl'
-require 'emailbutler/webhooks/receiver'
 require 'emailbutler/helpers'
 require 'emailbutler/mailers/helpers'
+require 'emailbutler/container'
 
 module Emailbutler
   extend self
   extend Forwardable
 
-  # Public: Given an adapter returns a handy DSL to all the emailbutler goodness.
-  def new(adapter)
-    DSL.new(adapter)
-  end
-
   # Public: Configure emailbutler.
   #
+  #   require 'emailbutler/adapters/active_record'
+  #
   #   Emailbutler.configure do |config|
   #     config.adapter = Emailbutler::Adapters::ActiveRecord.new
+  #     config.providers = %i[sendgrid]
   #   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
   end
 
   # Public: Returns Emailbutler::Configuration instance.
   def configuration
-    @configuration ||= Configuration.new
+    return Emailbutler::Container.resolve(:configuration) if Emailbutler::Container.key?(:configuration)
+
+    Emailbutler::Container.register(:configuration) { Configuration.new }
+    Emailbutler::Container.resolve(:configuration)
   end
 
-  # Public: Default per thread emailbutler instance if configured.
-  # Returns Emailbutler::DSL instance.
+  # Public: Returns Emailbutler::DSL instance.
   def instance
-    Thread.current[:emailbutler_instance] ||= new(configuration.adapter)
+    return Emailbutler::Container.resolve(:instance) if Emailbutler::Container.key?(:instance)
+
+    Emailbutler::Container.register(:instance) { DSL.new(configuration.adapter) }
+    Emailbutler::Container.resolve(:instance)
   end
 
   # Public: All the methods delegated to instance. These should match the interface of Emailbutler::DSL.

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: emailbutler
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.8.0
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-19 00:00:00.000000000 Z
+date: 2024-05-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: pagy
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +210,7 @@ files:
 - lib/emailbutler.rb
 - lib/emailbutler/adapters/active_record.rb
 - lib/emailbutler/configuration.rb
+- lib/emailbutler/container.rb
 - lib/emailbutler/dsl.rb
 - lib/emailbutler/engine.rb
 - lib/emailbutler/helpers.rb
@@ -229,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Email tracker for Ruby on Rails applications.