mailgun-tracking 2.0.0 → 3.0.0

data/lib/mailgun/tracking/notifier.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module Mailgun
-  module Tracking
-    # Wraps the {Listener} which gives a friendlier way to subscribe or broadcast.
-    class Notifier
-      # Initializes a new Notifier object.
-      #
-      # @param listener [Mailgun::Tracking::Listener] Event listener.
-      #
-      # @return [Mailgun::Tracking::Notifier]
-      def initialize(listener = Listener.new)
-        @listener = listener
-      end
-
-      # Returns true if there is  at least one subscriber.
-      #
-      # @return [Boolean]
-      def empty?
-        listener.subscribers.empty?
-      end
-
-      # Adds subscriber 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 [NilClass]
-      def subscribe(event, callable = Proc.new)
-        listener.add_subscriber(event, callable)
-      end
-
-      # Adds a subscriber for all events.
-      #
-      # @param callable [Proc, Class] The listener of event.
-      #   The callable objects should respond to call.
-      #
-      # @return [NilClass]
-      def all(callable = Proc.new)
-        listener.add_subscriber(nil, callable)
-      end
-
-      # Broadcasts parameters to event subscribers.
-      #
-      # @param event [String] The name of event.
-      # @param payload [Hash] The response parameters.
-      #
-      # @return [NilClass]
-      def broadcast(event, payload)
-        Signature.verify!(payload)
-        listener.broadcast(event, payload)
-      end
-
-      private
-
-      # @return [Mailgun::Tracking::Listener]
-      attr_reader :listener
-    end
-  end
-end

data/lib/mailgun/tracking/payload.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-require 'set'
-
-module Mailgun
-  module Tracking
-    # Payload object.
-    class Payload
-      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
-
-      # Returns a value of the payload with the given key.
-      #
-      # @param key [String]
-      #
-      # @return a value of the payload.
-      def [](key)
-        @values[key]
-      end
-
-      # @return [Boolean]
-      def ==(other)
-        return false unless other.is_a?(Payload)
-
-        values == other.values
-      end
-
-      alias eql? ==
-
-      # @return [Integer] The object's hash value (for equality checking)
-      def hash
-        values.hash
-      end
-
-      # @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
-
-      # @return [String] The string representation of the payload.
-      def to_s
-        JSON.pretty_generate(to_hash)
-      end
-
-      private
-
-      # @return [Class]
-      def __metaclass__
-        class << self
-          self
-        end
-      end
-
-      # @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

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require 'rack/request'
-
-module Mailgun
-  module Tracking
-    # Provides a convenient interface to a Rack environment.
-    class Request < ::Rack::Request
-      # Checks if the request is respond to the specified URL.
-      #
-      # @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]
-      def payload
-        @payload ||= Payload.new(params)
-      end
-
-      # A Mailgun::Tracking::Request::JSON is used to parsing JSON requests.
-      module JSON
-        APPLICATION_JSON = 'application/json'
-        FORM_HASH = 'rack.request.form_hash'
-        FORM_INPUT = 'rack.request.form_input'
-
-        # Returns the data received in the request body.
-        #
-        # @return [Hash]
-        def POST
-          return super unless media_type == APPLICATION_JSON
-
-          body = self.body.read
-          self.body.rewind
-          env.update(FORM_HASH => ::JSON.parse(body), FORM_INPUT => body)
-
-          env[FORM_HASH]
-        end
-      end
-
-      include JSON
-    end
-  end
-end

data/lib/mailgun/tracking/signature.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require 'openssl'
-
-module Mailgun
-  module Tracking
-    # A Mailgun::Tracking::Signature object is used to verify the signature.
-    class Signature
-      # Verify the signature of the response parameters.
-      #
-      # @param payload [Mailgun::Tracking::Payload]
-      # @raise [InvalidSignature] Error raised when signature is invalid.
-      #
-      # @return [Boolean]
-      #   Always returns true.
-      def self.verify!(payload)
-        signature = new(payload)
-        raise InvalidSignature unless signature.valid?
-
-        true
-      end
-
-      # Initializes a new Signature object.
-      #
-      # @param payload [Mailgun::Tracking::Payload]
-      #
-      # @return [Mailgun::Tracking::Signature]
-      def initialize(payload)
-        @payload = payload
-      end
-
-      # @return [Boolean]
-      def valid?
-        @payload.signature.signature == \
-          OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA256.new, Configuration.instance.api_key, data)
-      end
-
-      private
-
-      # Joins the timestamp and the response token.
-      #
-      # @return [String]
-      def data
-        [@payload.signature.timestamp, @payload.signature.token].join
-      end
-    end
-  end
-end

data/lib/mailgun/tracking/subscriber.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'subscriber/all_messages'
-require_relative 'subscriber/evented'
-
-module Mailgun
-  module Tracking
-    # Namespace for classes that wraps subscribers.
-    module Subscriber
-      # Determines the type of subscription.
-      #
-      # @param name [Symbol, String] The name of event.
-      # @param callable [Proc, Class] The callable object.
-      #   The callable objects should respond to call.
-      #
-      # @return [Mailgun::Tracking::Subscriber::Evented, Mailgun::Tracking::Subscriber::AllMessages]
-      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

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Mailgun
-  module Tracking
-    module Subscriber
-      # Wraps the subscriber for events.
-      class AllMessages
-        # Initializes a new AllMessages object.
-        #
-        # @param callable [Proc, Class] The callable object.
-        #   The callable objects should respond to call.
-        #
-        # @return [Mailgun::Tracking::Subscriber::AllMessages]
-        def initialize(callable)
-          @callable = callable
-        end
-
-        # Invokes the callable object.
-        #
-        # @param payload [Hash] The response parameters.
-        #
-        # @return [void]
-        def call(payload)
-          @callable.call(payload)
-        end
-
-        # Checks if a callable object is a subscribed to the specified event.
-        #
-        # @return [Boolean]
-        #   Always returns true.
-        def subscribed_to?(*)
-          true
-        end
-      end
-    end
-  end
-end

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

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Mailgun
-  module Tracking
-    module Subscriber
-      # Wraps the evented subscriber.
-      class Evented
-        # Initializes a new Evented object.
-        #
-        # @param name [Symbol, String] The name of event.
-        # @param callable [Proc, Class] The callable object.
-        #   The callable objects should respond to call.
-        #
-        # @return [Mailgun::Tracking::Subscriber::Evented]
-        def initialize(name, callable)
-          @name = name.to_sym
-          @callable = callable
-        end
-
-        # Invokes the callable object.
-        #
-        # @param payload [Hash] The response parameters.
-        #
-        # @return [void]
-        def call(payload)
-          @callable.call(payload)
-        end
-
-        # Checks if a callable object is a subscribed to the specified event.
-        #
-        # @param name [String] The name of event.
-        #
-        # @return [Boolean]
-        def subscribed_to?(name)
-          @name == name.to_sym
-        end
-      end
-    end
-  end
-end

data/lib/mailgun/tracking/util.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-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.
-        #
-        # @param options [Hash]
-        #
-        # @return [Hash]
-        def normalize(options = {})
-          object = normalize_keys(options.dup)
-          object
-        end
-
-        private
-
-        def normalize_keys(options)
-          return from_h(options) if options.is_a?(Hash)
-          return from_ary(options) if options.is_a?(Array)
-
-          options
-        end
-
-        def from_h(options)
-          Hash[options.map do |key, value|
-            [underscore(key), normalize_keys(value)]
-          end]
-        end
-
-        def from_ary(options)
-          options.map(&method(:normalize_keys))
-        end
-
-        def underscore(key)
-          return key unless key.respond_to?(:to_sym)
-
-          key.to_s
-             .dup
-             .tr('-', '_')
-             .downcase
-             .to_sym
-        end
-      end
-    end
-  end
-end

data/spec/mailgun/tracking/listener_spec.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Mailgun::Tracking::Listener do
-  subject(:listener) { described_class.new }
-
-  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, callable) }.to change(listener, :subscribers)
-        .from([])
-        .to([subscriber])
-    end
-
-    it 'adds multiple subscribers with the same name' do
-      expect do
-        listener.add_subscriber(:delivered, callable)
-        listener.add_subscriber('delivered', callable)
-      end.to change(listener, :subscribers).from([]).to([subscriber, subscriber])
-    end
-  end
-
-  describe '#broadcast' do
-    let(:payload) { fixture('delivered.json') }
-
-    before do
-      allow(subscriber).to receive(:call)
-      allow(subscriber).to receive(:subscribed_to?).with(/delivered/).and_return(true)
-      allow(Mailgun::Tracking::Subscriber).to receive(:for).with(:delivered, callable) { subscriber }
-
-      listener.add_subscriber(:delivered, callable)
-    end
-
-    it 'executes subscriber' do
-      listener.broadcast(:delivered, payload)
-      expect(subscriber).to have_received(:call).with(payload)
-    end
-
-    it 'executes multiple subscribers' do
-      listener.add_subscriber(:delivered, callable)
-      listener.broadcast('delivered', payload)
-      expect(subscriber).to have_received(:call).with(payload).twice
-    end
-  end
-end