mailgun-tracking 2.0.0 → 3.0.0

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

@@ -1,11 +1,19 @@
-# 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
+# Logfile created on 2019-12-20 18:03:14 +0200 by logger.rb/66358
+I, [2019-12-20T18:03:15.184026 #36064]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 18:03:15 +0200
+I, [2019-12-20T18:03:15.189876 #36064]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 18:03:15 +0200
+I, [2019-12-20T18:03:41.598392 #36073]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 18:03:41 +0200
+I, [2019-12-20T18:03:41.601914 #36073]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 18:03:41 +0200
+I, [2019-12-20T18:07:46.230295 #36150]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 18:07:46 +0200
+I, [2019-12-20T18:07:46.235394 #36150]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2019-12-20 18:07:46 +0200
+I, [2020-01-21T11:50:39.988463 #10847]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2020-01-21 11:50:39 +0200
+F, [2020-01-21T11:50:39.990083 #10847] FATAL -- : 
+ArgumentError (wrong number of arguments (given 2, expected 1)):
+  lib/mailgun/tracking/auth.rb:8:in `call'
+
+
+I, [2020-01-21T11:50:40.022428 #10847]  INFO -- : Started POST "/mailgun" for 127.0.0.1 at 2020-01-21 11:50:40 +0200
+F, [2020-01-21T11:50:40.023107 #10847] FATAL -- : 
+ArgumentError (wrong number of arguments (given 2, expected 1)):
+  lib/mailgun/tracking/auth.rb:8:in `call'
+
+

data/spec/mailgun/tracking/auth_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+RSpec.describe Mailgun::Tracking::Auth do
+  let(:payload) { fixture('delivered.json') }
+
+  describe '.call' do
+    let(:auth) { instance_double(described_class) }
+
+    before do
+      allow(described_class).to receive(:new).and_return(auth).with(payload)
+      allow(auth).to receive(:valid?).and_return(true)
+      described_class.call(payload)
+    end
+
+    it { expect(auth).to have_received(:valid?) }
+  end
+
+  describe '#valid?' do
+    subject(:auth) { described_class.new(payload) }
+
+    context 'when the signature comparison is successful' do
+      it { is_expected.to be_valid }
+    end
+
+    context 'when the signature comparison is unsuccessful' do
+      before { payload['signature']['timestamp'] = '' }
+
+      it { is_expected.not_to be_valid }
+    end
+  end
+end

data/spec/mailgun/tracking/middleware_spec.rb

@@ -1,68 +1,60 @@
 # frozen_string_literal: true
 
 RSpec.describe Mailgun::Tracking::Middleware do
-  subject(:rack) { described_class.new(app) }
-
-  let(:app) { proc { [200, {}, []] } }
-  let(:notifier) { instance_double(Mailgun::Tracking::Notifier) }
-  let(:request) 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) { Mailgun::Tracking::Payload.new('event-data' => { event: 'delivered' }) }
-
-  before do
-    allow(Mailgun::Tracking).to receive(:notifier).and_return(notifier)
-    allow(Mailgun::Tracking::Request).to receive(:new).with(env).and_return(request)
+  let(:app) do
+    lambda do |_env|
+      [200, { 'Content-Type' => 'text/plain' }, ['^_^']]
+    end
   end
+  let(:middleware) { described_class.new(app) }
 
-  describe '#call' do
-    context 'when request is not respond to the specified URL' do
-      before do
-        allow(request).to receive(:mailgun_tracking?).and_return(false)
-        allow(notifier).to receive(:broadcast)
-      end
+  context 'when a request is not respond to the specified URL' do
+    let(:env) { env_for('http://localhost:3000') }
 
-      it { expect(rack.call(env)).to include(200) }
+    it { expect(middleware.call(env)).to eq([200, { 'Content-Type' => 'text/plain' }, ['^_^']]) }
+  end
 
-      it do
-        rack.call(env)
-        expect(Mailgun::Tracking).not_to have_received(:notifier)
-      end
+  context 'when a request is done not as an HTTP POST request' do
+    let(:env) do
+      env_for(
+        'http://localhost:3000/mailgun',
+        'REQUEST_METHOD' => 'GET',
+        'CONTENT_TYPE' => 'application/json',
+        input: payload.to_json
+      )
     end
+    let(:payload) { fixture('delivered.json') }
 
-    context 'when request is respond to the specified URL and the signature comparison is unsuccessful' do
-      let(:params) { fixture('delivered.json') }
-
-      before do
-        allow(notifier).to receive(:broadcast).and_raise(Mailgun::Tracking::InvalidSignature)
-        allow(request).to receive(:mailgun_tracking?).and_return(true)
-        allow(request).to receive(:params).and_return(params)
-      end
-
-      it { expect(rack.call(env)).to include(400) }
+    it { expect(middleware.call(env)).to eq([200, { 'Content-Type' => 'text/plain' }, ['^_^']]) }
+  end
 
-      it do
-        rack.call(env)
-        expect(Mailgun::Tracking).to have_received(:notifier)
-      end
+  context 'when request is respond to the specified URL, POST request and the signature comparison is unsuccessful' do
+    let(:env) do
+      env_for(
+        'http://localhost:3000/mailgun',
+        'REQUEST_METHOD' => 'POST',
+        'CONTENT_TYPE' => 'application/json',
+        input: payload.to_json
+      )
     end
+    let(:payload) { fixture('delivered.json') }
 
-    context 'when request is respond to the specified URL and the signature comparison is successful' do
-      let(:params) { fixture('delivered.json') }
-
-      before do
-        allow(request).to receive(:mailgun_tracking?).and_return(true)
-        allow(request).to receive(:params).and_return(params)
-        allow(notifier).to receive(:broadcast)
-      end
+    before { payload['signature']['timestamp'] = '' }
 
-      it { expect(rack.call(env)).to include(200) }
+    it { expect(middleware.call(env)).to eq([400, {}, []]) }
+  end
 
-      it do
-        rack.call(env)
-        expect(Mailgun::Tracking).to have_received(:notifier)
-      end
+  context 'when everything matches (URL, POST, Signature)' do
+    let(:env) do
+      env_for(
+        'http://localhost:3000/mailgun',
+        'REQUEST_METHOD' => 'POST',
+        'CONTENT_TYPE' => 'application/json',
+        input: payload.to_json
+      )
     end
+    let(:payload) { fixture('delivered.json') }
+
+    it { expect(middleware.call(env)).to eq([200, {}, []]) }
   end
 end

data/spec/mailgun/tracking_spec.rb

@@ -12,13 +12,20 @@ RSpec.describe Mailgun::Tracking do
     end.to raise_error(NoMethodError)
   end
 
+  it { is_expected.not_to respond_to(:non_existent_method) }
+
   describe '.configure' do
     before do
+      allow(Mailgun::Tracking::Fanout).to receive(:on)
+      allow(Mailgun::Tracking::Fanout).to receive(:all)
+
       described_class.configure do |config|
         config.api_key = 'dab36017-478a-4373-9378-7070eb5968b5'
         config.endpoint = '/mailgun-tracking'
 
-        config.notifier.all(proc {})
+        config.on('delivered', proc {})
+
+        config.all(proc {})
       end
     end
 
@@ -30,8 +37,8 @@ RSpec.describe Mailgun::Tracking do
       expect(described_class.endpoint).to eq('/mailgun-tracking')
     end
 
-    it 'adds subscribers' do
-      expect(described_class.notifier).not_to be_empty
-    end
+    it { expect(Mailgun::Tracking::Fanout).to have_received(:on).with('delivered', instance_of(Proc)) }
+
+    it { expect(Mailgun::Tracking::Fanout).to have_received(:all).with(instance_of(Proc)) }
   end
 end

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

@@ -13,18 +13,20 @@ RSpec.shared_examples 'acts as rack' do
     allow(delivered).to receive(:call)
     allow(Delivered).to receive(:new).and_return(delivered)
 
-    Mailgun::Tracking.notifier.subscribe(:delivered, Delivered.new)
+    Mailgun::Tracking.on(:delivered, Delivered.new)
 
-    Mailgun::Tracking.notifier.subscribe :bounced do |payload|
+    Mailgun::Tracking.on :bounced do |payload|
       Delivered.new.call(payload)
     end
 
-    Mailgun::Tracking.notifier.all(Delivered.new)
+    Mailgun::Tracking.all(Delivered.new)
   end
 
   it do
     post('/mailgun', payload.to_json, 'CONTENT_TYPE' => 'application/json')
-    expect(delivered).to have_received(:call).with(Mailgun::Tracking::Payload.new(payload)).twice
+    expect(delivered).to have_received(:call).with(
+      payload
+    ).twice
   end
 
   context 'when the signature comparison is unsuccessful' do

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-tracking
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Artem Chubchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2020-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: catch_box
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -38,32 +38,18 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -100,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: 0.79.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: 0.79.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -159,22 +145,16 @@ extra_rdoc_files: []
 files:
 - lib/generators/mailgun/tracking/install_generator.rb
 - lib/generators/mailgun/tracking/templates/mailgun_tracking.rb.erb
+- lib/mailgun-tracking.rb
 - lib/mailgun/tracking.rb
+- lib/mailgun/tracking/auth.rb
 - lib/mailgun/tracking/configuration.rb
-- lib/mailgun/tracking/exceptions.rb
-- lib/mailgun/tracking/listener.rb
+- lib/mailgun/tracking/fanout.rb
 - lib/mailgun/tracking/middleware.rb
-- lib/mailgun/tracking/notifier.rb
-- lib/mailgun/tracking/payload.rb
 - lib/mailgun/tracking/railtie.rb
-- lib/mailgun/tracking/request.rb
-- lib/mailgun/tracking/signature.rb
-- lib/mailgun/tracking/subscriber.rb
-- lib/mailgun/tracking/subscriber/all_messages.rb
-- lib/mailgun/tracking/subscriber/evented.rb
-- lib/mailgun/tracking/util.rb
 - lib/mailgun/tracking/version.rb
 - spec/dummy/hanami/application.rb
+- spec/dummy/logs/test.log
 - spec/dummy/rack/application.rb
 - spec/dummy/rails/application.rb
 - spec/dummy/rails/logs/test.log
@@ -184,17 +164,9 @@ files:
 - spec/integration/rack/rack_spec.rb
 - spec/integration/rails/rails_spec.rb
 - spec/integration/sinatra/sinatra_spec.rb
+- spec/mailgun/tracking/auth_spec.rb
 - spec/mailgun/tracking/configuration_spec.rb
-- spec/mailgun/tracking/listener_spec.rb
 - spec/mailgun/tracking/middleware_spec.rb
-- spec/mailgun/tracking/notifier_spec.rb
-- spec/mailgun/tracking/payload_spec.rb
-- spec/mailgun/tracking/request_spec.rb
-- spec/mailgun/tracking/signature_spec.rb
-- spec/mailgun/tracking/subscriber/all_messages_spec.rb
-- spec/mailgun/tracking/subscriber/evented_spec.rb
-- spec/mailgun/tracking/subscriber_spec.rb
-- spec/mailgun/tracking/util_spec.rb
 - spec/mailgun/tracking/version_spec.rb
 - spec/mailgun/tracking_spec.rb
 - spec/spec_helper.rb
@@ -232,6 +204,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/dummy/sinatra/application.rb
 - spec/dummy/hanami/application.rb
+- spec/dummy/logs/test.log
 - spec/dummy/rack/application.rb
 - spec/dummy/rails/application.rb
 - spec/dummy/rails/logs/test.log
@@ -247,13 +220,5 @@ test_files:
 - 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/notifier_spec.rb
-- spec/mailgun/tracking/subscriber_spec.rb
 - spec/mailgun/tracking/middleware_spec.rb
-- spec/mailgun/tracking/util_spec.rb
-- spec/mailgun/tracking/listener_spec.rb
-- spec/mailgun/tracking/payload_spec.rb
-- spec/mailgun/tracking/request_spec.rb
-- spec/mailgun/tracking/subscriber/evented_spec.rb
-- spec/mailgun/tracking/subscriber/all_messages_spec.rb
+- spec/mailgun/tracking/auth_spec.rb

data/lib/mailgun/tracking/exceptions.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Mailgun
-  module Tracking
-    # A general Mailgun Tracking exception.
-    Error = Class.new(StandardError)
-
-    # Raised when signature is invalid.
-    InvalidSignature = Class.new(Error)
-  end
-end

data/lib/mailgun/tracking/listener.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Mailgun
-  module Tracking
-    # Represents a mechanism for event listeners to subscribe to events and for event broadcasts.
-    class Listener
-      # List of subscribers.
-      #
-      # @return [Array<Mailgun::Tracking::Subscriber::AllMessages, Mailgun::Tracking::Subscriber::Evented>]
-      attr_reader :subscribers
-
-      # Initializes a new Listener object.
-      #
-      # @return [Mailgun::Tracking::Listener]
-      def initialize
-        @subscribers = []
-      end
-
-      # Adds a subscriber to the list of subscribers for the specified event.
-      #
-      # @param event [Symbol, String] The name of event.
-      # @param callable [Proc, Class] The listener of event.
-      #   The callable objects should respond to call.
-      #
-      # @return [Array<Mailgun::Tracking::Subscriber::AllMessages, Mailgun::Tracking::Subscriber::Evented>]
-      #   The list of subscribers.
-      def add_subscriber(event, callable)
-        @subscribers << Subscriber.for(event, callable)
-      end
-
-      # Broadcasts an event to the subscribers.
-      #
-      # @param event [String] The name of event.
-      # @param payload [Hash] The response parameters.
-      #
-      # @return [Array<Mailgun::Tracking::Subscriber::AllMessages, Mailgun::Tracking::Subscriber::Evented>]
-      #   The list of subscribers.
-      def broadcast(event, payload)
-        subscribers_for(event).each { |subscriber| subscriber.call(payload) }
-      end
-
-      private
-
-      # Selects the subscribers for the specified event.
-      #
-      # @param event [String] The name of event.
-      #
-      # @return [Array<Mailgun::Tracking::Subscriber::AllMessages, Mailgun::Tracking::Subscriber::Evented>]
-      #   The list of subscribers.
-      def subscribers_for(event)
-        @subscribers.select { |subscriber| subscriber.subscribed_to?(event) }
-      end
-    end
-  end
-end