mailgun-tracking 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9dca3bb2ecebb3b77835850e80c913df78b24c03
-  data.tar.gz: 3b468bcfc59e17b6bbad6d92dbc5f7b57d7d2be9
+  metadata.gz: 87dcc660603620c0e746e9ed5cf5cc1584149ece
+  data.tar.gz: aad18416dca8c386cb96104c67a07512f847e84c
 SHA512:
-  metadata.gz: eb8b9b8227712aea6e298118aa98a39d9b82590b611056aa56f914072183b55c98cf53e2f14ceec8215247a690bed332f0a2fbd2eda670cf462c13b75098fd6e
-  data.tar.gz: 10652711a22a8d7c8fcee8404cc3dc4524e189cf0ea208211d7e43429bda35d831fb62a58349364d47d8afa8d97ce6c5506a012cb780cd1b0eeddd6fff9fb666
+  metadata.gz: d858782b928aa9b6e4ef1025c9614001f64ada0ac7a9fd42e37ddbe24b9f08ff2d1a94428a80f67dbb08bca0d853dfbb1d06fa06f5c6784a47df75335a09844e
+  data.tar.gz: 3fb5f7a36243749311a452ea220df5dcc1fea92ac9671f54febdb9d818f64f7ebdc47c812d7c75acbc930c336b790c236f1eb1de5b810f5025d5d0e805592d8b

data/lib/mailgun/tracking.rb

@@ -1,8 +1,11 @@
 require 'mailgun/tracking/exceptions'
 require 'mailgun/tracking/listener'
-require 'mailgun/tracking/rack'
+require 'mailgun/tracking/middleware'
+require 'mailgun/tracking/notifier'
 require 'mailgun/tracking/signature'
+require 'mailgun/tracking/subscriber'
 require 'mailgun/tracking/version'
+require 'mailgun/tracking/railtie' if defined?(Rails)
 
 module Mailgun
   module Tracking
@@ -21,25 +24,8 @@ module Mailgun
 
     module_function
 
-    def subscribe(event, &block)
-      listener.add_subscriber(event, &block)
-    end
-
-    def broadcast(event, payload)
-      Signature.verify!(payload)
-      listener.broadcast(event, payload)
-    end
-
-    def clear_cached_variables
-      @listener = nil
-    end
-
-    private
-
-    module_function
-
-    def listener
-      @listener ||= Listener.new
+    def notifier
+      @notifier ||= Notifier.new
     end
   end
 end

data/lib/mailgun/tracking/listener.rb

@@ -4,15 +4,21 @@ module Mailgun
       attr_reader :subscribers
 
       def initialize
-        @subscribers = Hash.new { |h, k| h[k] = [] }
+        @subscribers = []
       end
 
-      def add_subscriber(event, &block)
-        @subscribers[event.to_sym] << block
+      def add_subscriber(event, callable)
+        @subscribers << Subscriber.for(event, callable)
       end
 
       def broadcast(event, payload)
-        @subscribers[event.to_sym].each { |subscriber| subscriber.call(payload) }
+        subscribers_for(event).each { |subscriber| subscriber.call(payload) }
+      end
+
+      private
+
+      def subscribers_for(event)
+        @subscribers.select { |subscriber| subscriber.subscribed_to?(event) }
       end
     end
   end

data/lib/mailgun/tracking/{rack.rb → middleware.rb}

@@ -1,6 +1,6 @@
 module Mailgun
   module Tracking
-    class Rack
+    class Middleware
       def initialize(app)
         @app = app
       end
@@ -9,7 +9,7 @@ module Mailgun
         @env = env
 
         if mailgun_tracking_request?
-          Mailgun::Tracking.broadcast(request.params.fetch('event'), request.params)
+          Mailgun::Tracking.notifier.broadcast(request.params.fetch('event'), request.params)
           [200, {}, []]
         else
           @app.call(env)

data/lib/mailgun/tracking/notifier.rb

@@ -0,0 +1,26 @@
+module Mailgun
+  module Tracking
+    class Notifier
+      def initialize(listener = Listener.new)
+        @listener ||= listener
+      end
+
+      def subscribe(event, callable = Proc.new)
+        listener.add_subscriber(event, callable)
+      end
+
+      def all(callable = Proc.new)
+        listener.add_subscriber(nil, callable)
+      end
+
+      def broadcast(event, payload)
+        Signature.verify!(payload)
+        listener.broadcast(event, payload)
+      end
+
+      private
+
+      attr_reader :listener
+    end
+  end
+end

data/lib/mailgun/tracking/railtie.rb

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

data/lib/mailgun/tracking/subscriber.rb

@@ -0,0 +1,16 @@
+require 'mailgun/tracking/subscriber/all_messages'
+require 'mailgun/tracking/subscriber/evented'
+
+module Mailgun
+  module Tracking
+    module Subscriber
+      def self.for(name, callable)
+        if name
+          Evented.new(name, callable)
+        else
+          AllMessages.new(callable)
+        end
+      end
+    end
+  end
+end

data/lib/mailgun/tracking/subscriber/all_messages.rb

@@ -0,0 +1,19 @@
+module Mailgun
+  module Tracking
+    module Subscriber
+      class AllMessages
+        def initialize(callable)
+          @callable = callable
+        end
+
+        def call(payload)
+          @callable.call(payload)
+        end
+
+        def subscribed_to?(*)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/mailgun/tracking/subscriber/evented.rb

@@ -0,0 +1,20 @@
+module Mailgun
+  module Tracking
+    module Subscriber
+      class Evented
+        def initialize(name, callable)
+          @name = name.to_sym
+          @callable = callable
+        end
+
+        def call(payload)
+          @callable.call(payload)
+        end
+
+        def subscribed_to?(name)
+          @name == name.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/mailgun/tracking/version.rb

@@ -1,5 +1,5 @@
 module Mailgun
   module Tracking
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

data/spec/mailgun/tracking/listener_spec.rb

@@ -3,20 +3,23 @@ require 'spec_helper'
 RSpec.describe Mailgun::Tracking::Listener do
   subject(:listener) { described_class.new }
 
-  let(:block) { proc {} }
+  let(:callable) { proc {} }
+  let(:subscriber) { instance_double(Mailgun::Tracking::Subscriber::Evented) }
 
   describe '#add_subscriber' do
+    before { allow(Mailgun::Tracking::Subscriber).to receive(:for).with(/delivered/, callable) { subscriber } }
+
     it 'adds subscriber' do
-      expect { listener.add_subscriber(:delivered, &block) }.to change(listener, :subscribers)
-        .from({})
-        .to(delivered: [block])
+      expect { listener.add_subscriber(:delivered, callable) }.to change(listener, :subscribers)
+        .from([])
+        .to([subscriber])
     end
 
     it 'adds multiple subscribers with the same name' do
       expect do
-        listener.add_subscriber(:delivered, &block)
-        listener.add_subscriber('delivered', &block)
-      end.to change(listener, :subscribers).from({}).to(delivered: [block, block])
+        listener.add_subscriber(:delivered, callable)
+        listener.add_subscriber('delivered', callable)
+      end.to change(listener, :subscribers).from([]).to([subscriber, subscriber])
     end
   end
 
@@ -24,19 +27,22 @@ RSpec.describe Mailgun::Tracking::Listener do
     let(:payload) { fixture('delivered.json') }
 
     before do
-      allow(block).to receive(:call)
-      listener.add_subscriber(:delivered, &block)
+      allow(subscriber).to receive(:call)
+      allow(subscriber).to receive(:subscribed_to?).with(/delivered/) { true }
+      allow(Mailgun::Tracking::Subscriber).to receive(:for).with(:delivered, callable) { subscriber }
+
+      listener.add_subscriber(:delivered, callable)
     end
 
-    it 'executes block' do
+    it 'executes subscriber' do
       listener.broadcast(:delivered, payload)
-      expect(block).to have_received(:call).with(payload)
+      expect(subscriber).to have_received(:call).with(payload)
     end
 
-    it 'executes multiple blocks' do
-      listener.add_subscriber(:delivered, &block)
+    it 'executes multiple subscribers' do
+      listener.add_subscriber(:delivered, callable)
       listener.broadcast('delivered', payload)
-      expect(block).to have_received(:call).with(payload).twice
+      expect(subscriber).to have_received(:call).with(payload).twice
     end
   end
 end

data/spec/mailgun/tracking/{rack_spec.rb → middleware_spec.rb}

@@ -1,14 +1,18 @@
 require 'spec_helper'
 
-RSpec.describe Mailgun::Tracking::Rack do
+RSpec.describe Mailgun::Tracking::Middleware do
   subject(:rack) { described_class.new(app) }
 
   describe '#call' do
     let(:app) { proc { [200, {}, []] } }
     let(:payload) { fixture('delivered.json') }
     let(:code) { rack.call(env)[0] }
+    let(:notifier) { instance_double(Mailgun::Tracking::Notifier) }
 
-    before { allow(Mailgun::Tracking).to receive(:broadcast) }
+    before do
+      allow(notifier).to receive(:broadcast)
+      allow(Mailgun::Tracking).to receive(:notifier) { notifier }
+    end
 
     context 'when a request to a endpoint with a POST method' do
       let(:env) { env_for('http://localhost:3000/mailgun', method: :post, params: payload) }
@@ -16,7 +20,7 @@ RSpec.describe Mailgun::Tracking::Rack do
       it { expect(code).to eq(200) }
       it do
         code
-        expect(Mailgun::Tracking).to have_received(:broadcast).with('delivered', payload)
+        expect(notifier).to have_received(:broadcast).with('delivered', payload)
       end
     end
 
@@ -26,7 +30,7 @@ RSpec.describe Mailgun::Tracking::Rack do
       it { expect(code).to eq(200) }
       it do
         code
-        expect(Mailgun::Tracking).not_to have_received(:broadcast)
+        expect(Mailgun::Tracking).not_to have_received(:notifier)
       end
     end
 
@@ -37,7 +41,7 @@ RSpec.describe Mailgun::Tracking::Rack do
       it { expect(code).to eq(200) }
       it do
         code
-        expect(Mailgun::Tracking).not_to have_received(:broadcast)
+        expect(Mailgun::Tracking).not_to have_received(:notifier)
       end
     end
   end

data/spec/mailgun/tracking/notifier_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+RSpec.describe Mailgun::Tracking::Notifier do
+  subject(:notifier) { described_class.new(listener) }
+
+  let(:listener) { instance_double(Mailgun::Tracking::Listener) }
+
+  describe '#subscribe' do
+    let(:callable) { proc {} }
+
+    before { allow(listener).to receive(:add_subscriber) }
+
+    it 'subscribes on event' do
+      notifier.subscribe(:delivered, callable)
+
+      expect(listener).to have_received(:add_subscriber)
+        .with(:delivered, callable)
+    end
+  end
+
+  describe '#all' do
+    let(:callable) { proc {} }
+
+    before { allow(listener).to receive(:add_subscriber) }
+
+    it 'subscribes on all events' do
+      notifier.all(callable)
+
+      expect(listener).to have_received(:add_subscriber).with(nil, callable)
+    end
+  end
+
+  describe '#broadcast' do
+    let(:payload) { fixture('delivered.json') }
+
+    before do
+      allow(Mailgun::Tracking::Signature).to receive(:verify!)
+      allow(listener).to receive(:broadcast)
+      notifier.broadcast(:delivered, payload)
+    end
+
+    it 'verify signature' do
+      expect(Mailgun::Tracking::Signature).to have_received(:verify!).with(payload)
+    end
+
+    it 'broadcasts an event' do
+      expect(listener).to have_received(:broadcast).with(:delivered, payload)
+    end
+  end
+end

data/spec/mailgun/tracking/subscriber/all_messages_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+RSpec.describe Mailgun::Tracking::Subscriber::AllMessages do
+  subject(:subscriber) { described_class.new(callable) }
+
+  it_behaves_like :subscriber
+
+  describe '#subscribed_to?' do
+    let(:callable) { proc {} }
+
+    it { is_expected.to be_subscribed_to(:any_event) }
+  end
+end

data/spec/mailgun/tracking/subscriber/evented_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+RSpec.describe Mailgun::Tracking::Subscriber::Evented do
+  subject(:subscriber) { described_class.new('delivered', callable) }
+
+  it_behaves_like :subscriber
+
+  describe '#subscribed_to?' do
+    let(:callable) { proc {} }
+
+    it { is_expected.to be_subscribed_to(:delivered) }
+    it { is_expected.not_to be_subscribed_to(:any_event) }
+  end
+end

data/spec/mailgun/tracking/subscriber_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+RSpec.describe Mailgun::Tracking::Subscriber do
+  describe '.for' do
+    let(:callable) { proc {} }
+
+    it 'returns an instance of Mailgun::Tracking::Subscriber::AllMessages' do
+      expect(described_class.for(nil, callable)).to be_instance_of(Mailgun::Tracking::Subscriber::AllMessages)
+    end
+
+    it 'returns an instance of Mailgun::Tracking::Subscriber::Evented' do
+      expect(described_class.for('delivered', callable)).to be_instance_of(Mailgun::Tracking::Subscriber::Evented)
+    end
+  end
+end

data/spec/mailgun/tracking_spec.rb

@@ -9,41 +9,9 @@ RSpec.describe Mailgun::Tracking do
     end
   end
 
-  describe '.subscribe' do
-    let(:listener) { instance_double(Mailgun::Tracking::Listener) }
-
-    before do
-      described_class.clear_cached_variables
-      allow(listener).to receive(:add_subscriber)
-      allow(Mailgun::Tracking::Listener).to receive(:new) { listener }
-    end
-
-    it 'subscribes on event' do
-      described_class.subscribe(:delivered) {}
-
-      expect(listener).to have_received(:add_subscriber)
-        .with(:delivered)
-    end
-  end
-
-  describe '.broadcast' do
-    let(:payload) { fixture('delivered.json') }
-    let(:listener) { instance_double(Mailgun::Tracking::Listener) }
-
-    before do
-      described_class.clear_cached_variables
-      allow(Mailgun::Tracking::Signature).to receive(:verify!)
-      allow(listener).to receive(:broadcast)
-      allow(Mailgun::Tracking::Listener).to receive(:new) { listener }
-      described_class.broadcast(:delivered, payload)
-    end
-
-    it 'verify signature' do
-      expect(Mailgun::Tracking::Signature).to have_received(:verify!).with(payload)
-    end
-
-    it 'broadcasts an event' do
-      expect(listener).to have_received(:broadcast).with(:delivered, payload)
+  describe '.notifier' do
+    it 'returns an instance of Mailgun::Tracking::Notifier' do
+      expect(described_class.notifier).to be_instance_of(Mailgun::Tracking::Notifier)
     end
   end
 end

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ require 'mailgun/tracking'
 
 require_relative 'support/fixture'
 require_relative 'support/rack_helpers'
+require_relative 'support/shared_examples/subscriber'
 
 SimpleCov.start
 

data/spec/support/fixture.rb

@@ -1,14 +1,19 @@
 require 'json'
 
 class FixtureFinder
-  FIXTURE_PATH = File.expand_path('../fixtures', __dir__)
-
   def initialize(file)
     @file = file
+    @fixture_path = File.expand_path('../fixtures', dir)
   end
 
   def find
-    File.read(FIXTURE_PATH + '/' + @file)
+    File.read(@fixture_path + '/' + @file)
+  end
+
+  private
+
+  def dir
+    File.dirname(__FILE__)
   end
 end
 

data/spec/support/shared_examples/subscriber.rb

@@ -0,0 +1,14 @@
+RSpec.shared_examples :subscriber do
+  describe '#call' do
+    let(:callable) { proc {} }
+    let(:payload) { fixture('delivered.json') }
+
+    before { allow(callable).to receive(:call).with(payload) }
+
+    it 'calls the callable' do
+      subscriber.call(payload)
+
+      expect(callable).to have_received(:call).with(payload)
+    end
+  end
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-tracking
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Artem Chubchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-14 00:00:00.000000000 Z
+date: 2017-07-16 00:00:00.000000000 Z
 dependencies: []
-description: Integration for Mailgun Webhooks
+description: Integration with Mailgun Webhooks
 email:
 - artem.chubchenko@gmail.com
 executables: []
@@ -20,17 +20,27 @@ files:
 - lib/mailgun/tracking.rb
 - lib/mailgun/tracking/exceptions.rb
 - lib/mailgun/tracking/listener.rb
-- lib/mailgun/tracking/rack.rb
+- lib/mailgun/tracking/middleware.rb
+- lib/mailgun/tracking/notifier.rb
+- lib/mailgun/tracking/railtie.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/version.rb
 - spec/fixtures/delivered.json
 - spec/mailgun/tracking/listener_spec.rb
-- spec/mailgun/tracking/rack_spec.rb
+- spec/mailgun/tracking/middleware_spec.rb
+- spec/mailgun/tracking/notifier_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_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixture.rb
 - spec/support/rack_helpers.rb
+- spec/support/shared_examples/subscriber.rb
 homepage: https://github.com/chubchenko/mailgun-tracking
 licenses:
 - MIT
@@ -43,7 +53,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -54,13 +64,18 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Integration for Mailgun Webhooks
+summary: Integration with Mailgun Webhooks
 test_files:
 - spec/fixtures/delivered.json
 - spec/spec_helper.rb
 - spec/mailgun/tracking_spec.rb
 - spec/mailgun/tracking/listener_spec.rb
-- spec/mailgun/tracking/rack_spec.rb
+- spec/mailgun/tracking/middleware_spec.rb
+- spec/mailgun/tracking/notifier_spec.rb
+- spec/mailgun/tracking/subscriber_spec.rb
 - spec/mailgun/tracking/signature_spec.rb
+- spec/mailgun/tracking/subscriber/evented_spec.rb
+- spec/mailgun/tracking/subscriber/all_messages_spec.rb
 - spec/support/fixture.rb
 - spec/support/rack_helpers.rb
+- spec/support/shared_examples/subscriber.rb