mailgun-tracking 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f2b53add355033fc2a5b6cc4f93dc1818fdd4f5
-  data.tar.gz: 2abd9e0afdc9621f48584160547756b721ca0e10
+  metadata.gz: de33c4232c543a5487a5f9726ce816dfed2101fe
+  data.tar.gz: 7526a256204371b3d1582b80c8e8a138c3dd23cd
 SHA512:
-  metadata.gz: 8d6781261987073ad9cee2f8bf7b516892798a8b08dd5aebfe392204fcb417e2033ac8481a4f4c17a9114c7ecaf052b1b4e4f314bb9165ebedad7752f017dcd2
-  data.tar.gz: cff2a9d86aec1d5bb1b23e39074ae3eafb8e96cdf1907b8ec63b7055119c269f2321764393622206921d8ea82849435633cf8485d2e5d92369b69d18865a6751
+  metadata.gz: 316b704da6a01bff0504a9e0cca29fc8f1cd47cbbf0f40e7d8a7bc0e94cba53a1ff6c324291a77aa57db9652ae61eeaa72b6a3848ebdbc1cc400e60afc12ac3c
+  data.tar.gz: 3baa76e24da2ddd0f569a1eb020dc1893ec2f2ea63bc216876a1d7401eea6a1f5918dec139aa6875483ac772d0f357ea18d10ac02dcbf2a76531d83754c4de80

data/lib/mailgun/tracking.rb

@@ -1,3 +1,4 @@
+require 'mailgun/tracking/configuration'
 require 'mailgun/tracking/exceptions'
 require 'mailgun/tracking/listener'
 require 'mailgun/tracking/middleware'
@@ -11,35 +12,28 @@ require 'mailgun/tracking/railtie' if defined?(Rails)
 module Mailgun
   # Namespace for classes and modules that handle Mailgun Webhooks.
   module Tracking
-    DEFAULT_ENDPOINT = '/mailgun'.freeze
-
-    class << self
-      # Mailgun API public key.
-      #
-      # @return [String]
-      attr_accessor :api_key
-
-      # Mailgun Webhook API endpoint
-      #
-      # @return [String]
-      attr_accessor :endpoint
+    module_function
 
-      # Default way to setup Mailgun Tracking.
-      #
-      # @example
-      #   Mailgun::Tracking.configure do |config|
-      #     config.api_key = ENV['MAILGUN_API_KEY']
-      #     config.endpoint = '/mailgun-tracking'
-      #   end
-      def configure
-        yield(self)
-      end
+    # Default way to setup Mailgun Tracking.
+    #
+    # @example
+    #   Mailgun::Tracking.configure do |config|
+    #     config.api_key = ENV['MAILGUN_API_KEY']
+    #     config.endpoint = '/mailgun-tracking'
+    #   end
+    #
+    # @example
+    #   Mailgun::Tracking.configure(api_key: ENV['MAILGUN_API_KEY'], endpoint: '/mailgun-tracking')
+    #
+    # @param [Hash] options the options hash.
+    # @option options [String] :api_key Mailgun API public key.
+    # @option options [String] :endpoint Mailgun Webhook API endpoint.
+    #
+    # @return [void]
+    def configure(options = {}, &block)
+      Configuration.instance.configure(options, &block)
     end
 
-    self.endpoint = DEFAULT_ENDPOINT
-
-    module_function
-
     # A Notifier instance.
     #
     # @example

data/lib/mailgun/tracking/configuration.rb

@@ -0,0 +1,40 @@
+require 'singleton'
+
+module Mailgun
+  module Tracking
+    # Stores configuration information.
+    class Configuration
+      include Singleton
+
+      DEFAULT_ENDPOINT = '/mailgun'.freeze
+
+      # Mailgun API public key.
+      #
+      # @return [String]
+      attr_accessor :api_key
+
+      # Mailgun Webhook API endpoint.
+      #
+      # @return [String]
+      attr_accessor :endpoint
+
+      # Initializes a new Configuration object.
+      def initialize
+        @endpoint = DEFAULT_ENDPOINT
+      end
+
+      # Sets configuration information.
+      #
+      # @option options [String] :api_key Mailgun API public key.
+      # @option options [String] :endpoint Mailgun Webhook API endpoint.
+      #
+      # @return [void]
+      def configure(options = {})
+        options.each_pair do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+        yield(self) if block_given?
+      end
+    end
+  end
+end

data/lib/mailgun/tracking/middleware.rb

@@ -39,7 +39,7 @@ module Mailgun
       # @return [Boolean]
       def mailgun_tracking_request?
         return false unless request.post?
-        return false unless request.path == Mailgun::Tracking.endpoint
+        return false unless request.path == Configuration.instance.endpoint
         true
       end
 

data/lib/mailgun/tracking/signature.rb

@@ -30,7 +30,7 @@ module Mailgun
 
       # @return [Boolean]
       def valid?
-        @signature == OpenSSL::HMAC.hexdigest(digest, Mailgun::Tracking.api_key, data)
+        @signature == OpenSSL::HMAC.hexdigest(digest, Configuration.instance.api_key, data)
       end
 
       private

data/lib/mailgun/tracking/version.rb

@@ -1,5 +1,5 @@
 module Mailgun
   module Tracking
-    VERSION = '0.2.1'.freeze
+    VERSION = '0.2.2'.freeze
   end
 end

data/spec/mailgun/tracking/configuration_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+RSpec.describe Mailgun::Tracking::Configuration do
+  subject(:configuration) { described_class.instance }
+
+  it 'always refers to the same instance' do
+    expect(configuration).to eql(described_class.instance)
+  end
+
+  describe '#configure' do
+    let(:options) do
+      {
+        api_key: 'key-csyaunqpfvy6buznrm9ddyu4y7jakuc6',
+        endpoint: '/new-mailgun-tracking'
+      }
+    end
+
+    let(:ensure_configuration_via_options) do
+      configuration.configure(options)
+    end
+
+    let(:ensure_configuration_via_block) do
+      configuration.configure do |config|
+        config.api_key = options[:api_key]
+        config.endpoint = options[:endpoint]
+      end
+    end
+
+    def ensure_expect_to_change_state
+      expect { yield }.to change(configuration, :api_key)
+        .to(options[:api_key]).and change(configuration, :endpoint).to(options[:endpoint])
+    end
+
+    it { ensure_expect_to_change_state { ensure_configuration_via_options } }
+    it { ensure_expect_to_change_state { ensure_configuration_via_block } }
+  end
+end

data/spec/mailgun/tracking_spec.rb

@@ -2,9 +2,27 @@ require 'spec_helper'
 
 RSpec.describe Mailgun::Tracking do
   describe '.configure' do
-    it 'setup block yields self' do
+    let(:configuration) { instance_double(Mailgun::Tracking::Configuration) }
+    let(:options) do
+      {
+        api_key: 'key-qblubkqnkdn4lfes5oscf57ryllaia42',
+        endpoint: '/mailgun-tracking'
+      }
+    end
+
+    before do
+      allow(configuration).to receive(:configure)
+      allow(Mailgun::Tracking::Configuration).to receive(:instance) { configuration }
+    end
+
+    it do
+      described_class.configure(options)
+      expect(configuration).to have_received(:configure).with(options)
+    end
+
+    it 'setup block yields Mailgun::Tracking::Configuration' do
       described_class.configure do |config|
-        expect(described_class).to eq(config)
+        expect(config).to eq(Mailgun::Tracking::Configuration.instance)
       end
     end
   end

data/spec/spec_helper.rb

@@ -9,13 +9,13 @@ require_relative 'support/shared_examples/subscriber'
 
 SimpleCov.start
 
-Mailgun::Tracking.configure do |config|
-  config.api_key = 'key-qblubkqnkdn4lfes5oscf57ryllaia42'
-end
-
 RSpec.configure do |config|
   config.include(RackHelpers)
 
+  config.before(:each) do
+    Mailgun::Tracking.configure(api_key: 'key-qblubkqnkdn4lfes5oscf57ryllaia42', endpoint: '/mailgun')
+  end
+
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-tracking
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Artem Chubchenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-23 00:00:00.000000000 Z
+date: 2017-09-01 00:00:00.000000000 Z
 dependencies: []
 description: Integration with Mailgun Webhooks
 email:
@@ -20,6 +20,7 @@ files:
 - lib/generators/mailgun/tracking/install_generator.rb
 - lib/generators/mailgun/tracking/templates/mailgun_tracking.rb.erb
 - lib/mailgun/tracking.rb
+- lib/mailgun/tracking/configuration.rb
 - lib/mailgun/tracking/exceptions.rb
 - lib/mailgun/tracking/listener.rb
 - lib/mailgun/tracking/middleware.rb
@@ -31,6 +32,7 @@ files:
 - lib/mailgun/tracking/subscriber/evented.rb
 - lib/mailgun/tracking/version.rb
 - spec/fixtures/delivered.json
+- spec/mailgun/tracking/configuration_spec.rb
 - spec/mailgun/tracking/listener_spec.rb
 - spec/mailgun/tracking/middleware_spec.rb
 - spec/mailgun/tracking/notifier_spec.rb
@@ -63,21 +65,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Integration with Mailgun Webhooks
 test_files:
+- spec/fixtures/delivered.json
+- 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/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/listener_spec.rb
-- spec/mailgun/tracking/notifier_spec.rb
-- spec/mailgun/tracking/middleware_spec.rb
 - spec/mailgun/tracking_spec.rb
-- spec/support/rack_helpers.rb
+- spec/spec_helper.rb
 - spec/support/fixture.rb
+- spec/support/rack_helpers.rb
 - spec/support/shared_examples/subscriber.rb
-- spec/fixtures/delivered.json
-- spec/spec_helper.rb