emailbutler 0.8.1 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e06b545b530403687a7844d31538ea50de73cffbc8f225ab5a849fe13d7678b0
-  data.tar.gz: c6fdc2b0fcf1afb430c0b1c80b2b1b89f9273007a54f97b3c96ddbad44a1bef2
+  metadata.gz: d753748defc72a9be03be5ce3b5292ac438ccb040babd44955968a73515805f5
+  data.tar.gz: 6a962a4ae519be7280a0bf90ec2fa4e1283a7431967d070899164446d74a4b66
 SHA512:
-  metadata.gz: 71919a2533d61eb98ea21ef74266c261f1569acaf8ae2193fa30eef083b2ae06c659ec38af299d86d67d5b09f06ed9391b7fd63ba143687bd2592d071bbac916
-  data.tar.gz: ea46055aa238b71c0c237138caf69e2ed8b4580d0956e95274e3762071b7ae72e273ddf6fc43147634d0723d8b5966b31b8a25d89b8ed71901937fa7c1f9e12a
+  metadata.gz: e84a65be9929fee1171136cf07190c42c9d6004171ee080fb87e46ea31587252ad231d7e4530aa1ca05deac266ac0903ca5055f0e20b84d720f26549c96ab64a
+  data.tar.gz: cc7bcf25f40122b0efe390b01e8c42cf76eef2fea4894376dec8a2e872cda5ca3ba9aaee858e8666f3417a6a859842480fde431c2394ab4bf11ef61119db5089

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 through Sendgrid, SMTP2GO, Resend.
+Emailbutler allows you to track delivery status of emails sent by your app through Sendgrid, SMTP2GO, Resend, Mailjet.
 
 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.
 
@@ -34,7 +34,7 @@ require 'emailbutler/adapters/active_record'
 
 Emailbutler.configure do |config|
   config.adapter = Emailbutler::Adapters::ActiveRecord.new # required
-  config.providers = %w[sendgrid smtp2go resend] # optional
+  config.providers = %w[sendgrid smtp2go resend mailjet] # optional
   config.ui_username = 'username' # optional
   config.ui_password = 'password' # optional
   config.ui_secured_environments = ['production'] # optional

data/app/controllers/emailbutler/webhooks_controller.rb

@@ -2,22 +2,9 @@
 
 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::Container.resolve(:webhooks_receiver).call(
         mapper: receiver_mapper,
@@ -38,6 +25,7 @@ module Emailbutler
       when 'sendgrid' then Emailbutler::Container.resolve(:sendgrid_mapper)
       when 'smtp2go' then Emailbutler::Container.resolve(:smtp2go_mapper)
       when 'resend' then Emailbutler::Container.resolve(:resend_mapper)
+      when 'mailjet' then Emailbutler::Container.resolve(:mailjet_mapper)
       end
     end
 
@@ -46,6 +34,7 @@ module Emailbutler
       when 'sendgrid' then sendgrid_params
       when 'smtp2go' then smtp2go_params
       when 'resend' then resend_params
+      when 'mailjet' then mailjet_params
       end
     end
 
@@ -61,18 +50,8 @@ module Emailbutler
       params.permit('type', 'created_at', 'data' => %w[email_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]
-      )
+    def mailjet_params
+      params.permit('event', 'time', 'Message_GUID')
     end
   end
 end

data/config/routes.rb

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

data/lib/emailbutler/configuration.rb

@@ -7,7 +7,7 @@ module Emailbutler
     AVAILABLE_ADAPTERS = %w[
       Emailbutler::Adapters::ActiveRecord
     ].freeze
-    AVAILABLE_PROVIDERS = %w[sendgrid smtp2go resend].freeze
+    AVAILABLE_PROVIDERS = %w[sendgrid smtp2go resend mailjet].freeze
 
     attr_accessor :adapter, :providers, :ui_username, :ui_password, :ui_secured_environments
 

data/lib/emailbutler/container.rb

@@ -4,6 +4,7 @@ require 'dry/container'
 require 'emailbutler/webhooks/mappers/sendgrid'
 require 'emailbutler/webhooks/mappers/smtp2go'
 require 'emailbutler/webhooks/mappers/resend'
+require 'emailbutler/webhooks/mappers/mailjet'
 require 'emailbutler/webhooks/receiver'
 
 module Emailbutler
@@ -22,6 +23,7 @@ module Emailbutler
     register(:sendgrid_mapper) { Emailbutler::Webhooks::Mappers::Sendgrid.new }
     register(:smtp2go_mapper) { Emailbutler::Webhooks::Mappers::Smtp2Go.new }
     register(:resend_mapper) { Emailbutler::Webhooks::Mappers::Resend.new }
+    register(:mailjet_mapper) { Emailbutler::Webhooks::Mappers::Mailjet.new }
 
     # webhook receiver
     register(:webhooks_receiver) { Emailbutler::Webhooks::Receiver.new }

data/lib/emailbutler/version.rb

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

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Emailbutler
+  module Webhooks
+    module Mappers
+      class Mailjet
+        DELIVERABILITY_MAPPER = {
+          'sent' => 'processed',
+          'open' => 'delivered',
+          'click' => 'delivered',
+          'unsub' => 'failed',
+          'blocked' => 'failed',
+          'bounce' => 'failed',
+          'spam' => 'failed'
+        }.freeze
+
+        def call(payload:)
+          payload.stringify_keys!
+          # message-id contains data like <uuid>
+          message_uuid = payload['Message_GUID']
+          status = DELIVERABILITY_MAPPER[payload['event']]
+          return [] if message_uuid.nil? || status.nil?
+
+          [
+            {
+              message_uuid: message_uuid,
+              status: status,
+              timestamp: payload['time'] ? Time.at(payload['time'].to_i).utc.to_datetime : nil
+            }
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -16,7 +16,6 @@ module Emailbutler
 
         def call(payload:)
           payload.stringify_keys!
-          # message-id contains data like <uuid>
           message_uuid = payload.dig('data', 'email_id')
           status = DELIVERABILITY_MAPPER[payload['type']]
           return [] if message_uuid.nil? || status.nil?

data/lib/emailbutler.rb

@@ -24,12 +24,6 @@ module Emailbutler
   #   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emailbutler
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.3
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-04 00:00:00.000000000 Z
+date: 2024-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-container
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.39'
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +180,20 @@ dependencies:
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -216,6 +244,7 @@ files:
 - lib/emailbutler/helpers.rb
 - lib/emailbutler/mailers/helpers.rb
 - lib/emailbutler/version.rb
+- lib/emailbutler/webhooks/mappers/mailjet.rb
 - lib/emailbutler/webhooks/mappers/resend.rb
 - lib/emailbutler/webhooks/mappers/sendgrid.rb
 - lib/emailbutler/webhooks/mappers/smtp2go.rb