mailgun-tracking 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e61daca288034107cca6ca891a80fa601016a555fb1fb2d07ab9b9755d52a12e
-  data.tar.gz: 6bc9cac63844b3190418dbf6b2fa14964bfbe372bf6eb23ef55ea6d6aaf8b739
+  metadata.gz: cffbc8bee4968f3230841a2a75da150ef6d17bb2e4d860d05897aef61e55f2e1
+  data.tar.gz: be71a2d5a143a49d4ada8d050ffd402e09917e31cacc83da954654adfeae358d
 SHA512:
-  metadata.gz: 6de25bb55ff82c27c8420111acd1c72d4ee390ead819abc2631b1196e6d37ed62637023ed5048287f0ab399b23d1b942b626d8de1c4c9c58e7d3b2cc69b94ad0
-  data.tar.gz: dcd30f8087f1fd233b33a20d843ef1517ce1678d51b79bd8570574dabca01ab8963f944501f3e3e3cff1a6f268b1f37329112e7c3392cef3e516bff2fbc7cd09
+  metadata.gz: 4451ebb90204a5a887ad09afaac2187b0e86591e880a1bf944a7c671056c93999a8d6ec89920c38928a230e0b86a161eb472f0d57e320085865f12f33dcde843
+  data.tar.gz: efda62e3aa07d4fbe150dbfb48d2f2cbaa6204b49de9f0bb7278e473723ed85515dc56cfe84b503bf9c94b18a70cdfec5e94642ed5b927942381852babceb37e

data/lib/mailgun/tracking.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
-require 'mailgun/tracking/configuration'
-require 'mailgun/tracking/exceptions'
-require 'mailgun/tracking/listener'
-require 'mailgun/tracking/middleware'
-require 'mailgun/tracking/notifier'
-require 'mailgun/tracking/payload'
-require 'mailgun/tracking/payload/legacy'
-require 'mailgun/tracking/signature'
-require 'mailgun/tracking/subscriber'
-require 'mailgun/tracking/util'
-require 'mailgun/tracking/version'
-require 'mailgun/tracking/railtie' if defined?(Rails)
-require 'mailgun/tracking/request'
+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'
 
 # Module for interacting with the Mailgun.
 module Mailgun

data/lib/mailgun/tracking/middleware.rb

@@ -46,7 +46,7 @@ module Mailgun
       end
 
       def handle_event
-        Mailgun::Tracking.notifier.broadcast(@request.payload.event, @request.payload)
+        Mailgun::Tracking.notifier.broadcast(@request.payload.event_data.event, @request.payload)
         null_response
       rescue InvalidSignature
         bad_request

data/lib/mailgun/tracking/notifier.rb

@@ -49,7 +49,7 @@ module Mailgun
       # @return [NilClass]
       def broadcast(event, payload)
         Signature.verify!(payload)
-        listener.broadcast(event, payload.body)
+        listener.broadcast(event, payload)
       end
 
       private

data/lib/mailgun/tracking/payload.rb

@@ -1,44 +1,96 @@
 # frozen_string_literal: true
 
-require_relative 'payload/legacy'
+require 'set'
 
 module Mailgun
   module Tracking
     # Payload object.
     class Payload
-      def initialize(options = {})
-        @options = options
+      TRY_TO_HASH = lambda do |value|
+        return if value.nil?
+
+        value.respond_to?(:to_hash) ? value.to_hash : value
+      end.freeze
+
+      # Initializes a new Payload object.
+      #
+      # @param values [Hash]
+      #
+      # @return [Mailgun::Tracking::Payload]
+      def initialize(values = {})
+        @values = Util.normalize(values)
+
+        @values.each do |key, value|
+          define_instance_methods([key], values) unless __metaclass__.method_defined?(key)
+          @values[key] = Util.convert_to_payload_object(value)
+        end
       end
 
-      def body
-        @options
+      # Returns a value of the payload with the given key.
+      #
+      # @param key [String]
+      #
+      # @return a value of the payload.
+      def [](key)
+        @values[key]
       end
 
-      def event
-        @event ||= __event_data.fetch('event')
+      # @return [Boolean]
+      def ==(other)
+        return false unless other.is_a?(Payload)
+
+        values == other.values
       end
 
-      def token
-        @token ||= __signature.fetch('token')
+      alias eql? ==
+
+      # @return [Integer] The object's hash value (for equality checking)
+      def hash
+        values.hash
       end
 
-      def timestamp
-        @timestamp ||= __signature.fetch('timestamp')
+      # @return [Hash] Recursively convert payload objects to the hash.
+      def to_hash
+        @values.each_with_object({}) do |(key, value), memo|
+          memo[key] =
+            case value
+            when Array
+              value.map(&TRY_TO_HASH)
+            else
+              TRY_TO_HASH.call(value)
+            end
+        end
       end
 
-      def signature
-        @signature ||= __signature.fetch('signature')
+      # @return [String] The string representation of the payload.
+      def to_s
+        JSON.pretty_generate(to_hash)
       end
 
       private
 
-      def __signature
-        @__signature ||= @options.fetch('signature')
+      # @return [Class]
+      def __metaclass__
+        class << self
+          self
+        end
       end
 
-      def __event_data
-        @__event_data ||= @options.fetch('event-data')
+      # @return [void]
+      def define_instance_methods(keys, values)
+        __metaclass__.instance_eval do
+          keys.each do |key|
+            define_method(key) { @values[key] }
+            next unless [FalseClass, TrueClass].include?(values[key].class)
+
+            define_method(:"#{key}?") { @values[key] }
+          end
+        end
       end
+
+      protected
+
+      attr_reader :values
     end
   end
 end

data/lib/mailgun/tracking/request.rb

@@ -11,19 +11,14 @@ module Mailgun
       # @return [Boolean]
       def mailgun_tracking?
         return false unless post?
+        return false unless media_type == APPLICATION_JSON
 
         path == Configuration.instance.endpoint
       end
 
-      # @return [Mailgun::Tracking::Payload, Mailgun::Tracking::Payload::Legacy]
+      # @return [Mailgun::Tracking::Payload]
       def payload
-        @payload ||= begin
-          if params.key?('timestamp')
-            ::Mailgun::Tracking::Payload::Legacy.new(params)
-          else
-            ::Mailgun::Tracking::Payload.new(params)
-          end
-        end
+        @payload ||= Payload.new(params)
       end
 
       # A Mailgun::Tracking::Request::JSON is used to parsing JSON requests.
@@ -42,7 +37,7 @@ module Mailgun
           self.body.rewind
           env.update(FORM_HASH => ::JSON.parse(body), FORM_INPUT => body)
 
-          get_header(FORM_HASH)
+          env[FORM_HASH]
         end
       end
 

data/lib/mailgun/tracking/signature.rb

@@ -8,7 +8,7 @@ module Mailgun
     class Signature
       # Verify the signature of the response parameters.
       #
-      # @param payload [Hash]
+      # @param payload [Mailgun::Tracking::Payload]
       # @raise [InvalidSignature] Error raised when signature is invalid.
       #
       # @return [Boolean]
@@ -22,7 +22,7 @@ module Mailgun
 
       # Initializes a new Signature object.
       #
-      # @param payload [Hash]
+      # @param payload [Mailgun::Tracking::Payload]
       #
       # @return [Mailgun::Tracking::Signature]
       def initialize(payload)
@@ -31,21 +31,17 @@ module Mailgun
 
       # @return [Boolean]
       def valid?
-        @payload.signature == OpenSSL::HMAC.hexdigest(digest, Configuration.instance.api_key, data)
+        @payload.signature.signature == \
+          OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA256.new, Configuration.instance.api_key, data)
       end
 
       private
 
-      # @return [OpenSSL::Digest::SHA256]
-      def digest
-        OpenSSL::Digest::SHA256.new
-      end
-
       # Joins the timestamp and the response token.
       #
       # @return [String]
       def data
-        [@payload.timestamp, @payload.token].join
+        [@payload.signature.timestamp, @payload.signature.token].join
       end
     end
   end

data/lib/mailgun/tracking/subscriber.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'mailgun/tracking/subscriber/all_messages'
-require 'mailgun/tracking/subscriber/evented'
+require_relative 'subscriber/all_messages'
+require_relative 'subscriber/evented'
 
 module Mailgun
   module Tracking

data/lib/mailgun/tracking/util.rb

@@ -4,6 +4,24 @@ module Mailgun
   module Tracking
     # Utility methods.
     module Util
+      class << self
+        # Converts a hash of fields or an array of hashes into a {Payload}.
+        #
+        # @param data [Hash, Array] Hash of fields and values to be converted into a Payload.
+        #
+        # @return [Mailgun::Tracking::Payload, Array(Mailgun::Tracking::Payload)]
+        def convert_to_payload_object(data)
+          case data
+          when Array
+            data.map { |item| convert_to_payload_object(item) }
+          when Hash
+            Payload.new(data)
+          else
+            data
+          end
+        end
+      end
+
       class << self
         # Returns a new hash with all keys converted to symbols in downcase.
         #

data/lib/mailgun/tracking/version.rb

@@ -12,14 +12,14 @@ module Mailgun
       #
       # @return [Integer]
       def major
-        1
+        2
       end
 
       # Minor version.
       #
       # @return [Integer]
       def minor
-        1
+        0
       end
 
       # Patch version.

data/spec/dummy/hanami/application.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'hanami'
+
+Hanami::Environment.class_eval do
+  def root
+    @root ||= Pathname.new(__dir__)
+  end
+end
+
+Hanami.configure do
+  middleware.use(Mailgun::Tracking::Middleware)
+end

data/spec/dummy/rails/logs/test.log

@@ -1,53 +1,11 @@
-# Logfile created on 2019-10-16 14:23:57 +0300 by logger.rb/66358
-I, [2019-10-16T14:23:57.963086 #9298]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-10-16 14:23:57 +0300
-I, [2019-10-16T14:23:57.966124 #9298]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-10-16 14:23:57 +0300
-I, [2019-10-16T16:59:48.896283 #12252]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-10-16 16:59:48 +0300
-I, [2019-10-16T16:59:48.901335 #12252]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-10-16 16:59:48 +0300
-I, [2019-10-16T17:00:24.034817 #12268]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-10-16 17:00:24 +0300
-F, [2019-10-16T17:00:24.036968 #12268] FATAL -- :   
-NameError (undefined local variable or method `byebug' for #<Mailgun::Tracking::Middleware:0x00007fa1e4122950>):
-  
-lib/mailgun/tracking/middleware.rb:25:in `_call'
-lib/mailgun/tracking/middleware.rb:20:in `call'
-I, [2019-10-16T17:00:24.064195 #12268]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-10-16 17:00:24 +0300
-F, [2019-10-16T17:00:24.066858 #12268] FATAL -- :   
-NameError (undefined local variable or method `byebug' for #<Mailgun::Tracking::Middleware:0x00007fa1e51220d0>):
-  
-lib/mailgun/tracking/middleware.rb:25:in `_call'
-lib/mailgun/tracking/middleware.rb:20:in `call'
-I, [2019-10-16T17:00:40.123028 #12291]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-10-16 17:00:40 +0300
-F, [2019-10-16T17:00:40.132743 #12291] FATAL -- :   
-LoadError (cannot load such file -- byebug):
-  
-lib/mailgun/tracking/middleware.rb:25:in `_call'
-lib/mailgun/tracking/middleware.rb:20:in `call'
-I, [2019-10-16T17:00:40.154766 #12291]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-10-16 17:00:40 +0300
-F, [2019-10-16T17:00:40.157648 #12291] FATAL -- :   
-LoadError (cannot load such file -- byebug):
-  
-lib/mailgun/tracking/middleware.rb:25:in `_call'
-lib/mailgun/tracking/middleware.rb:20:in `call'
-I, [2019-10-16T17:01:20.206080 #12320]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-10-16 17:01:20 +0300
-F, [2019-10-16T17:18:16.030799 #12320] FATAL -- :   
-SystemExit (exit):
-  
-(byebug):1:in `exit'
-(byebug):1:in `_call'
-lib/mailgun/tracking/middleware.rb:29:in `_call'
-lib/mailgun/tracking/middleware.rb:22:in `call'
-I, [2019-10-16T17:18:16.198543 #12320]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-10-16 17:18:16 +0300
-I, [2019-11-07T18:53:57.134697 #53967]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-07 18:53:57 +0200
-I, [2019-11-07T18:53:57.158453 #53967]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-07 18:53:57 +0200
-F, [2019-11-07T18:53:57.160416 #53967] FATAL -- : 
-KeyError (key not found: "event"):
-  lib/mailgun/tracking/payload/legacy.rb:17:in `fetch'
-  lib/mailgun/tracking/payload/legacy.rb:17:in `event'
-  lib/mailgun/tracking/middleware.rb:60:in `handle_event'
-  lib/mailgun/tracking/middleware.rb:43:in `call!'
-  lib/mailgun/tracking/middleware.rb:20:in `call'
-
-
-I, [2019-11-07T18:55:50.036561 #53989]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-07 18:55:50 +0200
-I, [2019-11-07T18:55:50.076942 #53989]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-07 18:55:50 +0200
-I, [2019-11-07T18:56:17.648709 #53999]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-07 18:56:17 +0200
-I, [2019-11-07T18:56:17.662346 #53999]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-07 18:56:17 +0200
+# Logfile created on 2019-11-18 19:44:22 +0200 by logger.rb/66358
+I, [2019-11-18T19:44:22.794652 #78850]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-18 19:44:22 +0200
+I, [2019-11-18T19:44:22.822729 #78850]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-18 19:44:22 +0200
+I, [2019-11-18T19:45:24.283699 #78864]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-18 19:45:24 +0200
+I, [2019-11-18T19:45:24.287326 #78864]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-18 19:45:24 +0200
+I, [2019-11-18T19:45:51.702415 #78878]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-18 19:45:51 +0200
+I, [2019-11-18T19:45:51.710237 #78878]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-18 19:45:51 +0200
+I, [2019-11-18T19:46:04.908573 #78887]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-18 19:46:04 +0200
+I, [2019-11-18T19:46:04.912208 #78887]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-18 19:46:04 +0200
+I, [2019-11-18T19:58:57.597641 #78976]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-18 19:58:57 +0200
+I, [2019-11-18T19:58:57.608212 #78976]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-11-18 19:58:57 +0200

data/spec/fixtures/delivered.json

@@ -1,8 +1,8 @@
 {
   "signature": {
-    "timestamp": "1572632560",
-    "token": "e71ad7ff8d6f43b62d31615083bde85fb55e4e2b5121cb1239",
-    "signature": "9d21d1689889ec5f4ffa3c7e5e6598c8450c3eada8f6cc03e47b2342a9c9da61"
+    "timestamp": "1499697910",
+    "token": "b5751a49a024483da8d41c3684f98b8f",
+    "signature": "374e0b1a3deeb57318c783d43ff71093fbf26406a452761dab91bf346a93b49e"
   },
   "event-data": {
     "tags": [

data/spec/integration/hanami/hanami_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'dummy/hanami/application'
+
+RSpec.describe 'Hanami', type: :integration do
+  it_behaves_like 'acts as rack' do
+    let(:app) { Hanami.app }
+  end
+end

data/spec/mailgun/tracking/listener_spec.rb

@@ -24,7 +24,7 @@ RSpec.describe Mailgun::Tracking::Listener do
   end
 
   describe '#broadcast' do
-    let(:payload) { fixture('legacy/delivered.json') }
+    let(:payload) { fixture('delivered.json') }
 
     before do
       allow(subscriber).to receive(:call)

data/spec/mailgun/tracking/middleware_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Mailgun::Tracking::Middleware do
     instance_double(Mailgun::Tracking::Request, payload: payload, media_type: 'application/x-www-form-urlencoded')
   end
   let(:env) { env_for('http://localhost:3000') }
-  let(:payload) { instance_double(Mailgun::Tracking::Payload::Legacy, event: 'delivered') }
+  let(:payload) { Mailgun::Tracking::Payload.new('event-data' => { event: 'delivered' }) }
 
   before do
     allow(Mailgun::Tracking).to receive(:notifier).and_return(notifier)
@@ -32,7 +32,7 @@ RSpec.describe Mailgun::Tracking::Middleware do
     end
 
     context 'when request is respond to the specified URL and the signature comparison is unsuccessful' do
-      let(:params) { fixture('legacy/delivered.json') }
+      let(:params) { fixture('delivered.json') }
 
       before do
         allow(notifier).to receive(:broadcast).and_raise(Mailgun::Tracking::InvalidSignature)
@@ -49,7 +49,7 @@ RSpec.describe Mailgun::Tracking::Middleware do
     end
 
     context 'when request is respond to the specified URL and the signature comparison is successful' do
-      let(:params) { fixture('legacy/delivered.json') }
+      let(:params) { fixture('delivered.json') }
 
       before do
         allow(request).to receive(:mailgun_tracking?).and_return(true)

data/spec/mailgun/tracking/notifier_spec.rb

@@ -47,7 +47,7 @@ RSpec.describe Mailgun::Tracking::Notifier do
   end
 
   describe '#broadcast' do
-    let(:payload) { instance_double(Mailgun::Tracking::Payload, body: fixture('legacy/delivered.json')) }
+    let(:payload) { Mailgun::Tracking::Payload.new(fixture('delivered.json')) }
 
     before do
       allow(Mailgun::Tracking::Signature).to receive(:verify!)
@@ -60,7 +60,7 @@ RSpec.describe Mailgun::Tracking::Notifier do
     end
 
     it 'broadcasts an event' do
-      expect(listener).to have_received(:broadcast).with(:delivered, fixture('legacy/delivered.json'))
+      expect(listener).to have_received(:broadcast).with(:delivered, payload)
     end
   end
 end

data/spec/mailgun/tracking/payload_spec.rb

@@ -1,37 +1,73 @@
 # frozen_string_literal: true
 
 RSpec.describe Mailgun::Tracking::Payload do
-  subject(:payload) { described_class.new(options) }
+  subject(:payload) { described_class.new(values) }
 
-  let(:options) { fixture('delivered.json') }
+  describe '#==' do
+    let(:values) { { 'foo' => 'bar' } }
 
-  describe '#body' do
-    it 'returns body' do
-      expect(payload.body).to eq(options)
-    end
+    it { is_expected.to eq(described_class.new('foo' => 'bar')) }
+    it { is_expected.not_to eq(described_class.new('foo': 'rab')) }
+    it { is_expected.not_to eq('foo') }
   end
 
-  describe '#event' do
-    it 'returns event' do
-      expect(payload.event).to eq(options.fetch('event-data').fetch('event'))
-    end
+  describe '#respond_to?' do
+    let(:values) { { 'foo' => 'bar', 'boolean': true } }
+
+    it { is_expected.to respond_to(:foo) }
+    it { is_expected.to respond_to(:boolean?) }
+    it { is_expected.not_to respond_to(:foo?) }
   end
 
-  describe '#token' do
-    it 'returns token' do
-      expect(payload.token).to eq(options.fetch('signature').fetch('token'))
+  describe '#[]' do
+    let(:values) { { 'Message-Id' => '<payload@mailgun-tracking.com>' } }
+
+    it 'returns the value object from values' do
+      expect(payload[:message_id]).to eq('<payload@mailgun-tracking.com>')
     end
   end
 
-  describe '#timestamp' do
-    it 'returns timestamp' do
-      expect(payload.timestamp).to eq(options.fetch('signature').fetch('timestamp'))
+  describe '#hash' do
+    let(:values) { { 'foo' => 'bar' } }
+
+    it { expect(payload.hash).to eq(described_class.new('foo' => 'bar').hash) }
+    it { expect(payload.hash).not_to eq(described_class.new('foo': 'rab').hash) }
+    it { expect(payload.hash).not_to eq('foo'.hash) }
+  end
+
+  describe '#to_hash' do
+    let(:values) do
+      {
+        'foo' => 'bar',
+        'list' => [described_class.new('foo' => 'bar')],
+        'bar' => { 'foo' => 'bar', 'bar' => described_class.new('foo' => 'bar') }
+      }
+    end
+
+    it 'recursively call to_hash on its values' do
+      expect(payload.to_hash).to eql(
+        foo: 'bar',
+        list: [{ foo: 'bar' }],
+        bar: { foo: 'bar', bar: { foo: 'bar' } }
+      )
     end
   end
 
-  describe '#signature' do
-    it 'returns signature' do
-      expect(payload.signature).to eq(options.fetch('signature').fetch('signature'))
+  describe '#to_s' do
+    let(:values) do
+      {
+        'foo' => 'bar',
+        'list' => [described_class.new('foo' => 'bar')],
+        'bar' => { 'foo' => 'bar', 'bar' => described_class.new('foo' => 'bar') }
+      }
+    end
+
+    it 'will call to_s for all embedded stripe objects' do
+      expect(payload.to_s).to eql(JSON.pretty_generate(
+                                    foo: 'bar',
+                                    list: [{ foo: 'bar' }],
+                                    bar: { foo: 'bar', bar: { foo: 'bar' } }
+                                  ))
     end
   end
 end

data/spec/mailgun/tracking/request_spec.rb

@@ -4,40 +4,42 @@ RSpec.describe Mailgun::Tracking::Request do
   subject(:request) { described_class.new(env) }
 
   describe '#mailgun_tracking?' do
-    context 'when a request to a endpoint with a POST method' do
-      let(:env) { env_for('http://localhost:3000/mailgun', method: :post) }
+    context 'when a request to an endpoint without a POST method' do
+      let(:env) { env_for('http://localhost:3000/mailgun', method: :get) }
 
-      it { is_expected.to be_mailgun_tracking }
+      it { is_expected.not_to be_mailgun_tracking }
     end
 
-    context 'when a request to a endpoint with a POST method' do
-      let(:env) { env_for('http://localhost:3000/mailgun', method: :get) }
+    context 'when a request to an endpoint with not acceptable content type' do
+      let(:env) do
+        env_for('http://localhost:3000/mailgun', method: :post, 'CONTENT_TYPE' => 'application/x-www-form-urlencoded')
+      end
 
       it { is_expected.not_to be_mailgun_tracking }
     end
 
     context 'when the request is not to the endpoint' do
-      let(:env) { env_for('http://localhost:3000') }
+      let(:env) do
+        env_for('http://localhost:3000/_mailgun', method: :post, 'CONTENT_TYPE' => 'application/json; charset=utf-8')
+      end
 
       it { is_expected.not_to be_mailgun_tracking }
     end
-  end
 
-  describe '#payload' do
-    context 'when the parameters contain the timestamp' do
-      let(:env) { env_for('http://localhost:3000/mailgun', method: :post, params: { 'timestamp' => '1572632560' }) }
-
-      it 'returns legacy payload' do
-        expect(request.payload).to be_an_instance_of(Mailgun::Tracking::Payload::Legacy)
+    context 'when all the above conditions are met' do
+      let(:env) do
+        env_for('http://localhost:3000/mailgun', method: :post, 'CONTENT_TYPE' => 'application/json; charset=utf-8')
       end
+
+      it { is_expected.to be_mailgun_tracking }
     end
+  end
 
-    context 'when the parameters do not contain the timestamp' do
-      let(:env) { env_for('http://localhost:3000/mailgun', method: :post, params: { 'signature' => {} }) }
+  describe '#payload' do
+    let(:env) { env_for('http://localhost:3000/mailgun', method: :post, params: { 'signature' => {} }) }
 
-      it 'returns payload' do
-        expect(request.payload).to be_an_instance_of(Mailgun::Tracking::Payload)
-      end
+    it 'returns payload' do
+      expect(request.payload).to be_an_instance_of(Mailgun::Tracking::Payload)
     end
   end
 

data/spec/mailgun/tracking/signature_spec.rb

@@ -6,11 +6,12 @@ RSpec.describe Mailgun::Tracking::Signature do
   describe '.verify!' do
     context 'when the signature comparison is successful' do
       let(:payload) do
-        instance_double(
-          Mailgun::Tracking::Payload,
-          timestamp: '1499697910',
-          token: 'b5751a49a024483da8d41c3684f98b8f',
-          signature: '374e0b1a3deeb57318c783d43ff71093fbf26406a452761dab91bf346a93b49e'
+        Mailgun::Tracking::Payload.new(
+          signature: {
+            timestamp: '1499697910',
+            token: 'b5751a49a024483da8d41c3684f98b8f',
+            signature: '374e0b1a3deeb57318c783d43ff71093fbf26406a452761dab91bf346a93b49e'
+          }
         )
       end
 
@@ -19,11 +20,12 @@ RSpec.describe Mailgun::Tracking::Signature do
 
     context 'when the signature comparison is unsuccessful' do
       let(:payload) do
-        instance_double(
-          Mailgun::Tracking::Payload,
-          timestamp: '',
-          token: 'b5751a49a024483da8d41c3684f98b8f',
-          signature: '374e0b1a3deeb57318c783d43ff71093fbf26406a452761dab91bf346a93b49e'
+        Mailgun::Tracking::Payload.new(
+          signature: {
+            timestamp: '',
+            token: 'b5751a49a024483da8d41c3684f98b8f',
+            signature: '374e0b1a3deeb57318c783d43ff71093fbf26406a452761dab91bf346a93b49e'
+          }
         )
       end
 
@@ -34,11 +36,12 @@ RSpec.describe Mailgun::Tracking::Signature do
   describe '#valid?' do
     context 'when the signature comparison is successful' do
       let(:payload) do
-        instance_double(
-          Mailgun::Tracking::Payload,
-          timestamp: '1499697910',
-          token: 'b5751a49a024483da8d41c3684f98b8f',
-          signature: '374e0b1a3deeb57318c783d43ff71093fbf26406a452761dab91bf346a93b49e'
+        Mailgun::Tracking::Payload.new(
+          signature: {
+            timestamp: '1499697910',
+            token: 'b5751a49a024483da8d41c3684f98b8f',
+            signature: '374e0b1a3deeb57318c783d43ff71093fbf26406a452761dab91bf346a93b49e'
+          }
         )
       end
 
@@ -47,11 +50,12 @@ RSpec.describe Mailgun::Tracking::Signature do
 
     context 'when the signature comparison is unsuccessful' do
       let(:payload) do
-        instance_double(
-          Mailgun::Tracking::Payload,
-          timestamp: '',
-          token: 'b5751a49a024483da8d41c3684f98b8f',
-          signature: '374e0b1a3deeb57318c783d43ff71093fbf26406a452761dab91bf346a93b49e'
+        Mailgun::Tracking::Payload.new(
+          signature: {
+            timestamp: '',
+            token: 'b5751a49a024483da8d41c3684f98b8f',
+            signature: '374e0b1a3deeb57318c783d43ff71093fbf26406a452761dab91bf346a93b49e'
+          }
         )
       end
 

data/spec/support/shared_examples/integration/acts_as_rack.rb

@@ -6,7 +6,7 @@ end
 
 RSpec.shared_examples 'acts as rack' do
   let(:app) { Dummy::Application }
-  let(:payload) { fixture('legacy/delivered.json') }
+  let(:payload) { fixture('delivered.json') }
   let(:delivered) { instance_double(Delivered) }
 
   before do
@@ -23,15 +23,15 @@ RSpec.shared_examples 'acts as rack' do
   end
 
   it do
-    post('/mailgun', payload)
-    expect(delivered).to have_received(:call).with(payload).twice
+    post('/mailgun', payload.to_json, 'CONTENT_TYPE' => 'application/json')
+    expect(delivered).to have_received(:call).with(Mailgun::Tracking::Payload.new(payload)).twice
   end
 
   context 'when the signature comparison is unsuccessful' do
-    before { payload['timestamp'] = '' }
+    before { payload['signature']['timestamp'] = '' }
 
     it do
-      post('/mailgun', payload)
+      post('/mailgun', payload.to_json, 'CONTENT_TYPE' => 'application/json')
       expect(last_response).to be_bad_request
     end
   end

data/spec/support/shared_examples/subscriber.rb

@@ -3,7 +3,7 @@
 RSpec.shared_examples 'subscriber' do
   describe '#call' do
     let(:callable) { proc {} }
-    let(:payload) { fixture('legacy/delivered.json') }
+    let(:payload) { fixture('delivered.json') }
 
     before { allow(callable).to receive(:call).with(payload) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-tracking
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Artem Chubchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2019-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -166,7 +166,6 @@ files:
 - lib/mailgun/tracking/middleware.rb
 - lib/mailgun/tracking/notifier.rb
 - lib/mailgun/tracking/payload.rb
-- lib/mailgun/tracking/payload/legacy.rb
 - lib/mailgun/tracking/railtie.rb
 - lib/mailgun/tracking/request.rb
 - lib/mailgun/tracking/signature.rb
@@ -175,12 +174,13 @@ files:
 - lib/mailgun/tracking/subscriber/evented.rb
 - lib/mailgun/tracking/util.rb
 - lib/mailgun/tracking/version.rb
+- spec/dummy/hanami/application.rb
 - spec/dummy/rack/application.rb
 - spec/dummy/rails/application.rb
 - spec/dummy/rails/logs/test.log
 - spec/dummy/sinatra/application.rb
 - spec/fixtures/delivered.json
-- spec/fixtures/legacy/delivered.json
+- spec/integration/hanami/hanami_spec.rb
 - spec/integration/rack/rack_spec.rb
 - spec/integration/rails/rails_spec.rb
 - spec/integration/sinatra/sinatra_spec.rb
@@ -188,7 +188,6 @@ files:
 - spec/mailgun/tracking/listener_spec.rb
 - spec/mailgun/tracking/middleware_spec.rb
 - spec/mailgun/tracking/notifier_spec.rb
-- spec/mailgun/tracking/payload/legacy_spec.rb
 - spec/mailgun/tracking/payload_spec.rb
 - spec/mailgun/tracking/request_spec.rb
 - spec/mailgun/tracking/signature_spec.rb
@@ -232,23 +231,23 @@ summary: Integration with Mailgun Webhooks
 test_files:
 - spec/spec_helper.rb
 - spec/dummy/sinatra/application.rb
+- spec/dummy/hanami/application.rb
 - spec/dummy/rack/application.rb
 - spec/dummy/rails/application.rb
 - spec/dummy/rails/logs/test.log
 - spec/integration/sinatra/sinatra_spec.rb
+- spec/integration/hanami/hanami_spec.rb
 - spec/integration/rack/rack_spec.rb
 - spec/integration/rails/rails_spec.rb
 - spec/support/rack_helpers.rb
 - spec/support/fixture.rb
 - spec/support/shared_examples/integration/acts_as_rack.rb
 - spec/support/shared_examples/subscriber.rb
-- spec/fixtures/legacy/delivered.json
 - spec/fixtures/delivered.json
 - spec/mailgun/tracking_spec.rb
 - spec/mailgun/tracking/configuration_spec.rb
 - spec/mailgun/tracking/version_spec.rb
 - spec/mailgun/tracking/signature_spec.rb
-- spec/mailgun/tracking/payload/legacy_spec.rb
 - spec/mailgun/tracking/notifier_spec.rb
 - spec/mailgun/tracking/subscriber_spec.rb
 - spec/mailgun/tracking/middleware_spec.rb

data/lib/mailgun/tracking/payload/legacy.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Mailgun
-  module Tracking
-    class Payload
-      # Legacy payload object.
-      class Legacy
-        def initialize(options = {})
-          @options = options
-          warn(<<~DEPRECATION)
-            [Mailgun::Tracking] The Legacy class refers to a previous version of the API
-            which is deprecated and it will be removed in the next major version.
-          DEPRECATION
-        end
-
-        def body
-          @options
-        end
-
-        def event
-          @event ||= @options.fetch('event')
-        end
-
-        def token
-          @token ||= @options.fetch('token')
-        end
-
-        def timestamp
-          @timestamp ||= @options.fetch('timestamp')
-        end
-
-        def signature
-          @signature ||= @options.fetch('signature')
-        end
-      end
-    end
-  end
-end

data/spec/fixtures/legacy/delivered.json

@@ -1,13 +0,0 @@
-{
-  "timestamp": "1499697910",
-  "token": "b5751a49a024483da8d41c3684f98b8f",
-  "signature": "374e0b1a3deeb57318c783d43ff71093fbf26406a452761dab91bf346a93b49e",
-  "domain": "mail.example.com",
-  "my_var_1": "Mailgun Variable #1",
-  "my-var-2": "awesome",
-  "message-headers": "[[\"Received\", \"by luna.mailgun.net with SMTP mgrt 8734663311733; Fri, 03 May 2013 18:26:27 +0000\"], [\"Content-Type\", [\"multipart/alternative\", {\"boundary\": \"eb663d73ae0a4d6c9153cc0aec8b7520\"}]], [\"Mime-Version\", \"1.0\"], [\"Subject\", \"Test deliver webhook\"], [\"From\", \"Bob <bob@sandboxfb0641fa1b904bb28ba00cba62dca7f1.mailgun.org>\"], [\"To\", \"Alice <alice@example.com>\"], [\"Message-Id\", \"<20130503182626.18666.16540@sandboxfb0641fa1b904bb28ba00cba62dca7f1.mailgun.org>\"], [\"X-Mailgun-Variables\", \"{\\\"my_var_1\\\": \\\"Mailgun Variable #1\\\", \\\"my-var-2\\\": \\\"awesome\\\"}\"], [\"Date\", \"Fri, 03 May 2013 18:26:27 +0000\"], [\"Sender\", \"bob@sandboxfb0641fa1b904bb28ba00cba62dca7f1.mailgun.org\"]]",
-  "Message-Id": "<20160329071939.35138.9413.6915422C@mail.example.com>",
-  "recipient": "alice@example.com",
-  "event": "delivered",
-  "body-plain": ""
-}

data/spec/mailgun/tracking/payload/legacy_spec.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Mailgun::Tracking::Payload::Legacy do
-  subject(:legacy) { described_class.new(options) }
-
-  let(:options) { fixture('legacy/delivered.json') }
-
-  describe '#body' do
-    it 'returns body' do
-      expect(legacy.body).to eq(options)
-    end
-  end
-
-  describe '#event' do
-    it 'returns event' do
-      expect(legacy.event).to eq(options.fetch('event'))
-    end
-  end
-
-  describe '#token' do
-    it 'returns token' do
-      expect(legacy.token).to eq(options.fetch('token'))
-    end
-  end
-
-  describe '#timestamp' do
-    it 'returns timestamp' do
-      expect(legacy.timestamp).to eq(options.fetch('timestamp'))
-    end
-  end
-
-  describe '#signature' do
-    it 'returns signature' do
-      expect(legacy.signature).to eq(options.fetch('signature'))
-    end
-  end
-end