mailgun-tracking 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cffbc8bee4968f3230841a2a75da150ef6d17bb2e4d860d05897aef61e55f2e1
-  data.tar.gz: be71a2d5a143a49d4ada8d050ffd402e09917e31cacc83da954654adfeae358d
+  metadata.gz: 6b812299fdcd198f08dd868a8b7c19f862637d68cad9be5af788867b98f53522
+  data.tar.gz: 705758e31e1ce4e8527edba0c2d172627298aacf0d156363f5ccb6ed02466556
 SHA512:
-  metadata.gz: 4451ebb90204a5a887ad09afaac2187b0e86591e880a1bf944a7c671056c93999a8d6ec89920c38928a230e0b86a161eb472f0d57e320085865f12f33dcde843
-  data.tar.gz: efda62e3aa07d4fbe150dbfb48d2f2cbaa6204b49de9f0bb7278e473723ed85515dc56cfe84b503bf9c94b18a70cdfec5e94642ed5b927942381852babceb37e
+  metadata.gz: 84e5e69c832f3c3f19f775c47d35d675d2a150e5564e41899bc8a7e79858e25c70fabd27e4c20e49543c65a4c423e0cd2406ca70fafefd898b6bcbb5c29bf08e
+  data.tar.gz: a341aec22ff80fa7c0edb22706aa4f72631155e4fe8606cd0493043aed9c72f5830655c82373d5976064e159f91b96ac5cd6de1c5399b0f3ef6813b391481b2e

data/lib/generators/mailgun/tracking/templates/mailgun_tracking.rb.erb

@@ -6,7 +6,7 @@ Mailgun::Tracking.configure do |config|
   config.api_key = ENV['MAILGUN_API_KEY']
 <% end -%>
 
-  # Mailgun Webhook API endpoint. Default is '/mailgun'.
+  # Mailgun callback URL. Default is '/mailgun-tracking'.
 <% if endpoint -%>
   config.endpoint = <%= endpoint %>
 <% else -%>

data/lib/mailgun-tracking.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'mailgun/tracking'

data/lib/mailgun/tracking.rb

@@ -1,66 +1,98 @@
 # frozen_string_literal: true
 
-require_relative 'tracking/configuration'
-require_relative 'tracking/exceptions'
-require_relative 'tracking/listener'
-require_relative 'tracking/middleware'
-require_relative 'tracking/notifier'
-require_relative 'tracking/payload'
-require_relative 'tracking/signature'
-require_relative 'tracking/subscriber'
-require_relative 'tracking/util'
-require_relative 'tracking/version'
-require_relative 'tracking/railtie' if defined?(Rails)
-require_relative 'tracking/request'
+require 'mailgun/tracking/configuration'
+require 'mailgun/tracking/middleware'
+require 'mailgun/tracking/version'
+require 'mailgun/tracking/railtie' if defined?(::Rails)
+require 'mailgun/tracking/fanout'
 
-# Module for interacting with the Mailgun.
 module Mailgun
-  # Namespace for classes and modules that handle Mailgun Webhooks.
+  # The namespace for classes and modules that handle Mailgun webhooks.
   module Tracking
     module_function
 
-    # Default way to setup Mailgun Tracking.
+    # The default way to set up Mailgun Tracking.
+    #
+    # @yield [self] block yields itself.
     #
     # @example
     #   Mailgun::Tracking.configure do |config|
     #     config.api_key = ENV['MAILGUN_API_KEY']
+    #
     #     config.endpoint = '/mailgun-tracking'
     #
-    #     config.notifier.subscribe :delivered do |payload|
+    #     config.on 'delivered' do |payload|
     #       # Do something with the incoming data.
     #     end
     #
-    #     config.notifier.subscribe :bounced, Bounced.new
+    #     # The object should respond to #call
+    #     config.on 'bounced', Bounced.new
     #
-    #     config.notifier.all do |payload|
-    #       # Handle all event types.
+    #     config.all do |payload|
+    #       # Do something with the incoming data.
     #     end
     #   end
-    #
-    # @return [void]
     def configure
       yield(self)
     end
 
-    # A Notifier instance.
+    # Subscribe to an event.
     #
-    # @return [Mailgun::Tracking::Notifier]
-    def notifier
-      @notifier ||= Notifier.new
+    # @param event [Symbol, String] the event identifier.
+    # @param callable [#call] the event handler.
+    #
+    # @example
+    #   Mailgun::Tracking.configure do |config|
+    #     config.on 'delivered' do |payload|
+    #       # Do something with the incoming data.
+    #     end
+    #
+    #     # The object should respond to #call
+    #     config.on 'bounced', Bounced.new
+    #   end
+    def on(event, callable = nil, &block)
+      ::Mailgun::Tracking::Fanout.on(
+        event.to_s.dup.freeze,
+        callable || block
+      )
     end
 
-    # Delegate other missing methods to configuration.
+    # Subscribe to all events.
+    #
+    # @param callable [#call] the event handler.
+    #
+    # @example
+    #   Mailgun::Tracking.configure do |config|
+    #     config.all do |payload|
+    #       # Do something with the incoming data.
+    #     end
+    #
+    #     # The object should respond to #call
+    #     config.all, All.new
+    #   end
+    def all(callable = nil, &block)
+      ::Mailgun::Tracking::Fanout.all(
+        callable || block
+      )
+    end
+
+    # Delegate any missing method call to the configuration.
     def method_missing(method_name, *arguments, &block)
-      if Configuration.instance.respond_to?(method_name)
-        Configuration.instance.public_send(method_name, *arguments, &block)
-      else
-        super
-      end
+      return super unless configuration.respond_to?(method_name)
+
+      configuration.public_send(method_name, *arguments, &block)
     end
 
-    # Replaces the Object.respond_to?() method.
+    # Replace the Object.respond_to?() method.
     def respond_to_missing?(method_name, include_private = false)
-      Configuration.instance.respond_to?(method_name) || super
+      configuration.respond_to?(method_name) || super
     end
+
+    # @return [Mailgun::Tracking::Configuration]
+    def configuration
+      ::Mailgun::Tracking::Configuration.instance
+    end
+
+    private_class_method :configuration
   end
 end

data/lib/mailgun/tracking/auth.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module Mailgun
+  module Tracking
+    # Used to ensure the authenticity of event requests.
+    class Auth
+      SIGNATURE = 'signature'
+
+      # @param payload [Hash] webhook payload.
+      #
+      # @return [Boolean]
+      def self.call(payload, _env = nil)
+        new(payload).valid?
+      end
+
+      # Initialize a Mailgun::Tracking::Auth object.
+      #
+      # @param payload [Hash] webhook payload.
+      #
+      # @return [Mailgun::Tracking::Auth]
+      def initialize(payload)
+        @payload = payload
+      end
+
+      # Compare the resulting hexdigest to the signature.
+      #
+      # @return [Boolean]
+      def valid?
+        @payload.dig(SIGNATURE, SIGNATURE) == \
+          ::OpenSSL::HMAC.hexdigest(
+            ::OpenSSL::Digest::SHA256.new,
+            ::Mailgun::Tracking.api_key,
+            data
+          )
+      end
+
+      private
+
+      # Concatenate timestamp and token values.
+      #
+      # @return [String]
+      def data
+        [
+          @payload.dig(SIGNATURE, 'timestamp'),
+          @payload.dig(SIGNATURE, 'token')
+        ].join
+      end
+    end
+  end
+end

data/lib/mailgun/tracking/configuration.rb

@@ -4,23 +4,19 @@ require 'singleton'
 
 module Mailgun
   module Tracking
-    # Stores configuration information.
+    # Configuration for Mailgun Tracking.
     class Configuration
-      include Singleton
+      include ::Singleton
 
       DEFAULT_ENDPOINT = '/mailgun'
 
-      # Mailgun API public key.
-      #
-      # @return [String]
+      # @return [String] Mailgun API public key.
       attr_accessor :api_key
 
-      # Mailgun Webhook API endpoint.
-      #
-      # @return [String]
+      # @return [String] Mailgun callback URL.
       attr_accessor :endpoint
 
-      # Initializes a new Configuration object.
+      # Initialize a Mailgun::Tracking::Configuration object.
       def initialize
         @endpoint = DEFAULT_ENDPOINT
       end

data/lib/mailgun/tracking/fanout.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'catch_box/fanout'
+require 'mailgun/tracking/auth'
+
+module Mailgun
+  module Tracking
+    # It broadcast the payload to all callable based on event type. Also, there is an authenticity
+    # of the webhook before each broadcast.
+    class Fanout
+      extend ::CatchBox::Fanout
+
+      event 'event-data.event'
+
+      auth ::Mailgun::Tracking::Auth
+    end
+  end
+end

data/lib/mailgun/tracking/middleware.rb

@@ -1,55 +1,18 @@
 # frozen_string_literal: true
 
+require 'catch_box/middleware'
+
 module Mailgun
   module Tracking
-    # Rack-based middleware to handle event notifications.
-    class Middleware
-      # Initializes a new Middleware object.
-      #
-      # @param app the next Rack middleware in the stack.
+    # Rack middleware to handle an HTTP POST to the callback URL when events occur with a message.
+    class Middleware < ::CatchBox::Middleware
+      # Initialize a Mailgun::Tracking::Middleware object.
       def initialize(app)
-        @app = app
-      end
-
-      # Thread-safe {call!}.
-      #
-      # @param env [Hash] Environment hash.
-      #
-      # @return [Array(Numeric,Hash,Array)] The Rack-style response.
-      def call(env)
-        dup.call!(env)
-      end
-
-      # Responds to Rack requests.
-      #
-      # @param env [Hash] Environment hash.
-      #
-      # @return [Array(Numeric,Hash,Array)] The Rack-style response.
-      def call!(env)
-        @request = Request.new(env)
-
-        return @app.call(env) unless @request.mailgun_tracking?
-
-        handle_event
-      end
-
-      private
-
-      # @return [Array(Numeric,Hash,Array)] The Rack-style response.
-      def null_response
-        [200, {}, []]
-      end
-
-      # @return [Array(Numeric,Hash,Array)] The Rack-style response.
-      def bad_request
-        [400, {}, []]
-      end
-
-      def handle_event
-        Mailgun::Tracking.notifier.broadcast(@request.payload.event_data.event, @request.payload)
-        null_response
-      rescue InvalidSignature
-        bad_request
+        super(
+          app,
+          fanout: ::Mailgun::Tracking::Fanout,
+          endpoint: ::Mailgun::Tracking.endpoint
+        )
       end
     end
   end

data/lib/mailgun/tracking/railtie.rb

@@ -3,9 +3,9 @@
 module Mailgun
   module Tracking
     # Mailgun Tracking Railtie.
-    class Railtie < Rails::Railtie
+    class Railtie < ::Rails::Railtie
       initializer 'mailgun-tracking.insert_middleware' do |app|
-        app.config.middleware.use(Mailgun::Tracking::Middleware)
+        app.config.middleware.use(::Mailgun::Tracking::Middleware)
       end
     end
   end

data/lib/mailgun/tracking/version.rb

@@ -2,17 +2,18 @@
 
 module Mailgun
   module Tracking
-    # This module holds the Mailgun Tracking version information.
+    # The module which hold version data.
     module Version
       module_function
 
       KEYS = %i[major minor patch].freeze
+      DOT = '.'
 
       # Major version.
       #
       # @return [Integer]
       def major
-        2
+        3
       end
 
       # Minor version.
@@ -29,25 +30,25 @@ module Mailgun
         0
       end
 
-      # Returns a hash representation of version.
+      # Return a hash representation of version.
       #
       # @return [Hash]
       def to_h
-        Hash[KEYS.zip(to_a)]
+        ::Hash[KEYS.zip(to_a)]
       end
 
-      # Returns a string representation of version.
+      # Return an array representation of version.
       #
       # @return [Array]
       def to_a
         [major, minor, patch]
       end
 
-      # Returns an array representation of version.
+      # Return a string representation of version.
       #
       # @return [String]
       def to_s
-        to_a.join('.')
+        to_a.join(DOT)
       end
     end
   end

data/spec/dummy/logs/test.log

@@ -0,0 +1,77 @@
+# Logfile created on 2019-12-20 14:25:19 +0200 by logger.rb/66358
+I, [2019-12-20T14:25:20.156536 #32357]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:25:20 +0200
+F, [2019-12-20T14:25:20.159019 #32357] FATAL -- : 
+RSpec::Mocks::ExpiredTestDoubleError (#<InstanceDouble(Delivered) (anonymous)> was originally created in one example but has leaked into another example and can no longer be used. rspec-mocks' doubles are designed to only last for one example, and you need to create a new one in each example you wish to use it for.):
+  lib/mailgun/tracking/subscriber/evented.rb:26:in `call'
+  lib/mailgun/tracking/listener.rb:39:in `block in broadcast'
+  lib/mailgun/tracking/listener.rb:39:in `each'
+  lib/mailgun/tracking/listener.rb:39:in `broadcast'
+  lib/mailgun/tracking/notifier.rb:52:in `broadcast'
+  lib/mailgun/tracking/middleware.rb:49:in `handle_event'
+  lib/mailgun/tracking/middleware.rb:33:in `call!'
+  lib/mailgun/tracking/middleware.rb:20:in `call'
+
+
+I, [2019-12-20T14:25:20.196642 #32357]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:25:20 +0200
+I, [2019-12-20T14:25:20.244510 #32357]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:25:20 +0200
+F, [2019-12-20T14:25:20.245802 #32357] FATAL -- : 
+RSpec::Mocks::ExpiredTestDoubleError (#<InstanceDouble(Delivered) (anonymous)> was originally created in one example but has leaked into another example and can no longer be used. rspec-mocks' doubles are designed to only last for one example, and you need to create a new one in each example you wish to use it for.):
+  lib/mailgun/tracking/subscriber/evented.rb:26:in `call'
+  lib/mailgun/tracking/listener.rb:39:in `block in broadcast'
+  lib/mailgun/tracking/listener.rb:39:in `each'
+  lib/mailgun/tracking/listener.rb:39:in `broadcast'
+  lib/mailgun/tracking/notifier.rb:52:in `broadcast'
+  lib/mailgun/tracking/middleware.rb:49:in `handle_event'
+  lib/mailgun/tracking/middleware.rb:33:in `call!'
+  lib/mailgun/tracking/middleware.rb:20:in `call'
+
+
+I, [2019-12-20T14:25:20.248316 #32357]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:25:20 +0200
+I, [2019-12-20T14:25:20.260350 #32357]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:25:20 +0200
+F, [2019-12-20T14:25:20.261696 #32357] FATAL -- : 
+RSpec::Mocks::ExpiredTestDoubleError (#<InstanceDouble(Delivered) (anonymous)> was originally created in one example but has leaked into another example and can no longer be used. rspec-mocks' doubles are designed to only last for one example, and you need to create a new one in each example you wish to use it for.):
+  lib/mailgun/tracking/subscriber/evented.rb:26:in `call'
+  lib/mailgun/tracking/listener.rb:39:in `block in broadcast'
+  lib/mailgun/tracking/listener.rb:39:in `each'
+  lib/mailgun/tracking/listener.rb:39:in `broadcast'
+  lib/mailgun/tracking/notifier.rb:52:in `broadcast'
+  lib/mailgun/tracking/middleware.rb:49:in `handle_event'
+  lib/mailgun/tracking/middleware.rb:33:in `call!'
+  lib/mailgun/tracking/middleware.rb:20:in `call'
+
+
+I, [2019-12-20T14:25:20.264988 #32357]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:25:20 +0200
+I, [2019-12-20T14:25:58.135206 #32391]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:25:58 +0200
+I, [2019-12-20T14:25:58.150294 #32391]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:25:58 +0200
+I, [2019-12-20T14:26:03.646734 #32397]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:26:03 +0200
+I, [2019-12-20T14:26:03.650724 #32397]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:26:03 +0200
+I, [2019-12-20T14:26:08.150452 #32407]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:26:08 +0200
+I, [2019-12-20T14:26:08.154891 #32407]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:26:08 +0200
+I, [2019-12-20T14:26:11.908915 #32414]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:26:11 +0200
+I, [2019-12-20T14:26:11.914969 #32414]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:26:11 +0200
+I, [2019-12-20T14:26:16.436839 #32421]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:26:16 +0200
+I, [2019-12-20T14:26:16.443137 #32421]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:26:16 +0200
+I, [2019-12-20T14:30:17.817726 #32588]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:17 +0200
+I, [2019-12-20T14:30:17.821355 #32588]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:17 +0200
+I, [2019-12-20T14:30:22.836667 #32594]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:22 +0200
+I, [2019-12-20T14:30:22.844164 #32594]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:22 +0200
+I, [2019-12-20T14:30:32.888089 #32611]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:32 +0200
+I, [2019-12-20T14:30:32.890907 #32611]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:32 +0200
+I, [2019-12-20T14:30:36.327917 #32616]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:36 +0200
+I, [2019-12-20T14:30:36.332494 #32616]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:36 +0200
+I, [2019-12-20T14:30:39.691402 #32622]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:39 +0200
+I, [2019-12-20T14:30:39.705041 #32622]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:39 +0200
+I, [2019-12-20T14:30:43.148966 #32628]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:43 +0200
+I, [2019-12-20T14:30:43.154670 #32628]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:43 +0200
+I, [2019-12-20T14:30:47.047963 #32633]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:47 +0200
+I, [2019-12-20T14:30:47.051108 #32633]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:47 +0200
+I, [2019-12-20T14:30:50.559295 #32639]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:50 +0200
+I, [2019-12-20T14:30:50.566124 #32639]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:30:50 +0200
+I, [2019-12-20T14:31:22.457376 #32659]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:31:22 +0200
+I, [2019-12-20T14:31:22.464730 #32659]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:31:22 +0200
+I, [2019-12-20T14:31:44.337243 #32670]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:31:44 +0200
+I, [2019-12-20T14:31:44.345211 #32670]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:31:44 +0200
+I, [2019-12-20T14:33:25.161614 #32696]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:33:25 +0200
+I, [2019-12-20T14:33:25.171927 #32696]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:33:25 +0200
+I, [2019-12-20T14:33:33.415794 #32700]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:33:33 +0200
+I, [2019-12-20T14:33:33.422618 #32700]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 14:33:33 +0200