mailgun-tracking 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9dca3bb2ecebb3b77835850e80c913df78b24c03
+  data.tar.gz: 3b468bcfc59e17b6bbad6d92dbc5f7b57d7d2be9
+SHA512:
+  metadata.gz: eb8b9b8227712aea6e298118aa98a39d9b82590b611056aa56f914072183b55c98cf53e2f14ceec8215247a690bed332f0a2fbd2eda670cf462c13b75098fd6e
+  data.tar.gz: 10652711a22a8d7c8fcee8404cc3dc4524e189cf0ea208211d7e43429bda35d831fb62a58349364d47d8afa8d97ce6c5506a012cb780cd1b0eeddd6fff9fb666

data/lib/mailgun/tracking.rb

@@ -0,0 +1,45 @@
+require 'mailgun/tracking/exceptions'
+require 'mailgun/tracking/listener'
+require 'mailgun/tracking/rack'
+require 'mailgun/tracking/signature'
+require 'mailgun/tracking/version'
+
+module Mailgun
+  module Tracking
+    DEFAULT_ENDPOINT = '/mailgun'.freeze
+
+    class << self
+      attr_accessor :api_key,
+                    :endpoint
+
+      def configure
+        yield(self)
+      end
+    end
+
+    self.endpoint = DEFAULT_ENDPOINT
+
+    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
+    end
+  end
+end

data/lib/mailgun/tracking/exceptions.rb

@@ -0,0 +1,6 @@
+module Mailgun
+  module Tracking
+    Error = Class.new(StandardError)
+    InvalidSignature = Class.new(Error)
+  end
+end

data/lib/mailgun/tracking/listener.rb

@@ -0,0 +1,19 @@
+module Mailgun
+  module Tracking
+    class Listener
+      attr_reader :subscribers
+
+      def initialize
+        @subscribers = Hash.new { |h, k| h[k] = [] }
+      end
+
+      def add_subscriber(event, &block)
+        @subscribers[event.to_sym] << block
+      end
+
+      def broadcast(event, payload)
+        @subscribers[event.to_sym].each { |subscriber| subscriber.call(payload) }
+      end
+    end
+  end
+end

data/lib/mailgun/tracking/rack.rb

@@ -0,0 +1,32 @@
+module Mailgun
+  module Tracking
+    class Rack
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @env = env
+
+        if mailgun_tracking_request?
+          Mailgun::Tracking.broadcast(request.params.fetch('event'), request.params)
+          [200, {}, []]
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      def request
+        ::Rack::Request.new(@env)
+      end
+
+      def mailgun_tracking_request?
+        return false unless request.post?
+        return false unless request.path == Mailgun::Tracking.endpoint
+        true
+      end
+    end
+  end
+end

data/lib/mailgun/tracking/signature.rb

@@ -0,0 +1,33 @@
+require 'openssl'
+
+module Mailgun
+  module Tracking
+    class Signature
+      def self.verify!(payload)
+        signature = new(payload)
+        raise InvalidSignature unless signature.valid?
+        true
+      end
+
+      def initialize(payload)
+        @token = payload.fetch('token')
+        @timestamp = payload.fetch('timestamp')
+        @signature = payload.fetch('signature')
+      end
+
+      def valid?
+        @signature == OpenSSL::HMAC.hexdigest(digest, Mailgun::Tracking.api_key, data)
+      end
+
+      private
+
+      def digest
+        OpenSSL::Digest::SHA256.new
+      end
+
+      def data
+        [@timestamp, @token].join
+      end
+    end
+  end
+end

data/lib/mailgun/tracking/version.rb

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

data/spec/fixtures/delivered.json

@@ -0,0 +1,8 @@
+{
+  "domain": "mail.example.com",
+  "Message-Id": "<20160329071939.35138.9413.6915422C@mail.example.com>",
+  "event": "delivered",
+  "timestamp": "1499697910",
+  "token": "b5751a49a024483da8d41c3684f98b8f",
+  "signature": "374e0b1a3deeb57318c783d43ff71093fbf26406a452761dab91bf346a93b49e"
+}

data/spec/mailgun/tracking/listener_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+RSpec.describe Mailgun::Tracking::Listener do
+  subject(:listener) { described_class.new }
+
+  let(:block) { proc {} }
+
+  describe '#add_subscriber' do
+    it 'adds subscriber' do
+      expect { listener.add_subscriber(:delivered, &block) }.to change(listener, :subscribers)
+        .from({})
+        .to(delivered: [block])
+    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])
+    end
+  end
+
+  describe '#broadcast' do
+    let(:payload) { fixture('delivered.json') }
+
+    before do
+      allow(block).to receive(:call)
+      listener.add_subscriber(:delivered, &block)
+    end
+
+    it 'executes block' do
+      listener.broadcast(:delivered, payload)
+      expect(block).to have_received(:call).with(payload)
+    end
+
+    it 'executes multiple blocks' do
+      listener.add_subscriber(:delivered, &block)
+      listener.broadcast('delivered', payload)
+      expect(block).to have_received(:call).with(payload).twice
+    end
+  end
+end

data/spec/mailgun/tracking/rack_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+RSpec.describe Mailgun::Tracking::Rack 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] }
+
+    before { allow(Mailgun::Tracking).to receive(:broadcast) }
+
+    context 'when a request to a endpoint with a POST method' do
+      let(:env) { env_for('http://localhost:3000/mailgun', method: :post, params: payload) }
+
+      it { expect(code).to eq(200) }
+      it do
+        code
+        expect(Mailgun::Tracking).to have_received(:broadcast).with('delivered', payload)
+      end
+    end
+
+    context 'when a request to a endpoint with a POST method' do
+      let(:env) { env_for('http://localhost:3000/mailgun', method: :get, params: payload) }
+
+      it { expect(code).to eq(200) }
+      it do
+        code
+        expect(Mailgun::Tracking).not_to have_received(:broadcast)
+      end
+    end
+
+    context 'when the request is not to the endpoint' do
+      let(:env) { env_for('http://localhost:3000') }
+      let(:code) { rack.call(env)[0] }
+
+      it { expect(code).to eq(200) }
+      it do
+        code
+        expect(Mailgun::Tracking).not_to have_received(:broadcast)
+      end
+    end
+  end
+end

data/spec/mailgun/tracking/signature_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+RSpec.describe Mailgun::Tracking::Signature do
+  subject(:signature) { described_class.new(payload) }
+
+  let(:payload) { fixture('delivered.json') }
+
+  describe '.verify!' do
+    context 'when the signature comparison is successful' do
+      it { expect(described_class.verify!(payload)).to be true }
+    end
+
+    context 'when the signature comparison is unsuccessful' do
+      before { payload.merge!('timestamp' => '') }
+
+      it { expect { described_class.verify!(payload) }.to raise_error(Mailgun::Tracking::InvalidSignature) }
+    end
+  end
+
+  describe '#valid?' do
+    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.merge!('timestamp' => '') }
+
+      it { is_expected.not_to be_valid }
+    end
+  end
+end

data/spec/mailgun/tracking_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+RSpec.describe Mailgun::Tracking do
+  describe '.configure' do
+    it 'setup block yields self' do
+      described_class.configure do |config|
+        expect(described_class).to eq(config)
+      end
+    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)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rack'
+require 'simplecov'
+require 'bundler/setup'
+require 'mailgun/tracking'
+
+require_relative 'support/fixture'
+require_relative 'support/rack_helpers'
+
+SimpleCov.start
+
+Mailgun::Tracking.configure do |config|
+  config.api_key = 'key-qblubkqnkdn4lfes5oscf57ryllaia42'
+end
+
+RSpec.configure do |config|
+  config.include(RackHelpers)
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.order = :random
+end

data/spec/support/fixture.rb

@@ -0,0 +1,17 @@
+require 'json'
+
+class FixtureFinder
+  FIXTURE_PATH = File.expand_path('../fixtures', __dir__)
+
+  def initialize(file)
+    @file = file
+  end
+
+  def find
+    File.read(FIXTURE_PATH + '/' + @file)
+  end
+end
+
+def fixture(file)
+  JSON.parse(FixtureFinder.new(file).find)
+end

data/spec/support/rack_helpers.rb

@@ -0,0 +1,5 @@
+module RackHelpers
+  def env_for(url, options = {})
+    Rack::MockRequest.env_for(url, options)
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: mailgun-tracking
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Artem Chubchenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-14 00:00:00.000000000 Z
+dependencies: []
+description: Integration for Mailgun Webhooks
+email:
+- artem.chubchenko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mailgun/tracking.rb
+- lib/mailgun/tracking/exceptions.rb
+- lib/mailgun/tracking/listener.rb
+- lib/mailgun/tracking/rack.rb
+- lib/mailgun/tracking/signature.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/signature_spec.rb
+- spec/mailgun/tracking_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixture.rb
+- spec/support/rack_helpers.rb
+homepage: https://github.com/chubchenko/mailgun-tracking
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Integration for 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/signature_spec.rb
+- spec/support/fixture.rb
+- spec/support/rack_helpers.rb