mailgun_catcher 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e89041e32d638b9278e4c9b597d032a1028489f07e46aa399cb49dbb1e6b71d3
-  data.tar.gz: 414f84ca5f27c6ea9b219e4db47d2c5b22ca899c971ba191639ed35a9195dcf8
+  metadata.gz: dacfa3890b0f1b49041cfcc6d749170d864471977c402a7bf3e8973a8ef287bf
+  data.tar.gz: b547f7780d0d99c576197568564cec4dad806bc62c858ee7c7370506b59f5074
 SHA512:
-  metadata.gz: 776709eabd0f17164fbf155e5af9b2579d9c1fc1c5b753166ee258f7f79218cf2fd74c9c3b6ea228604f4ec16e2aa07996fbd52950d35bf25b622db8a37b55e7
-  data.tar.gz: 2537ad6fcec36b4eab9ad84b19c08ce15aca5259cff02158c9094dfd20a14545d6c7a3cd2f4e39b72a35b8abae24b846b668790a0965437d02f0fc1f789d6a4d
+  metadata.gz: 7354b7c497078d2e64cf1b197e6f9a7ba0f95e85ceff64a2be66c8947baf5549b71af32f8abdc4cac69498678f5a45be9197483ba0d0c3150024bff46d43e504
+  data.tar.gz: 237dc959296bd08b553f052dce12935c7788be43332c400c590ed00ad2fd835ca6569529f31c3e64c032d185ea34b5df4c1e1754ad10a545809fece5e63e9c55

data/README.md

@@ -18,9 +18,33 @@ Add to routes:
 mount MailgunCatcher::Engine, at: "/mailgun_catcher"
 ```
 
-Configire webhook on mailgun:
+To configure an exact path for the webhooks controller create an initializer (`mailgun_catcher.rb`) with the following content:
+```ruby
+MailgunCatcher::Engine.config.webhooks_path = 'custom_path'
+```
+This will allow you change the default webhook route from `/webhooks` to `/custom_path`.
+
+Configure webhook on mailgun:
 ![](http://take.ms/HZRmm)
 
+## Notifiers
+Library supports event dispatching via notifier. Notifier is any object that responds to `notify` message. By default, events are notified on Bugsnag service, but you can provide your own notifier implementation by configuring `MailgunCatcher.config.notifier`.
+
+### Configuring custom notifier
+```ruby
+class MailgunNotifier
+  def notify(event)
+    puts event
+  end
+end
+```
+
+register custom notifier implementation through initializer
+```ruby
+MailgunCatcher.setup do |config|
+  config.notifiers = ["MailgunCatcher::Notifier::Bugsnag", "MailgunNotifier"]
+end
+```
 
 ## Contributing
 Contribution directions go here.

data/app/controllers/mailgun_catcher/webhooks_controller.rb

@@ -1,7 +1,7 @@
 module MailgunCatcher
   class WebhooksController < MailgunCatcher::ApplicationController
     def create
-      MailgunCatcher::Event.new(params).notify_bugsnag
+      MailgunCatcher::Event.new(params).notify
       head :ok
     end
   end

data/config/routes.rb

@@ -1,3 +1,3 @@
 MailgunCatcher::Engine.routes.draw do
-  resources :webhooks, only: [:create]
+  resources :webhooks, only: [:create], path: MailgunCatcher::Engine.config.webhooks_path
 end

data/lib/mailgun_catcher.rb

@@ -1,7 +1,14 @@
+require 'dry-configurable'
 require 'mailgun_catcher/engine'
 require 'mailgun_catcher/event'
-require 'mailgun_catcher/event_error'
+require 'mailgun_catcher/notifier/bugsnag'
 
 module MailgunCatcher
-  # Your code goes here...
+  extend Dry::Configurable
+
+  setting(:notifiers, ["MailgunCatcher::Notifier::Bugsnag"])
+
+  def self.setup
+    yield config
+  end
 end

data/lib/mailgun_catcher/engine.rb

@@ -1,5 +1,9 @@
 module MailgunCatcher
   class Engine < ::Rails::Engine
+    extend Dry::Configurable
+
+    setting :webhooks_path, 'webhooks'
+
     isolate_namespace MailgunCatcher
   end
 end

data/lib/mailgun_catcher/event.rb

@@ -6,20 +6,28 @@ module MailgunCatcher
       @params = params.to_unsafe_h
     end
 
-    def notify_bugsnag
-      Bugsnag.notify(EventError.new(self))
+    def notify
+      notifiers.each { |notifier| notifier.notify(self) }
     end
 
     def error_message
       "[#{severity}] [#{reason}] #{recipient}: #{delivery_status}"
     end
 
+    def grouping_error_message
+      "[#{severity}] [#{reason}] #{recipient}"
+    end
+
     def event_data
       params.fetch('event-data', {})
     end
 
     private
 
+    def notifiers
+      MailgunCatcher.config.notifiers.map { |notifier| notifier.constantize.new }
+    end
+
     def delivery_status
       return delivery_status_message if delivery_status_message.present?
       return delivery_status_description if delivery_status_description.present?

data/lib/mailgun_catcher/notifier/bugsnag.rb

@@ -0,0 +1,31 @@
+module MailgunCatcher
+  module Notifier
+    class Bugsnag
+      def notify(event)
+        error_event = EventError.new(event)
+        ::Bugsnag.notify(error_event)
+      end
+    end
+
+    class EventError < StandardError
+      attr_reader :event
+
+      def initialize(event)
+        @event = event
+        super(event.error_message)
+      end
+
+      def bugsnag_meta_data
+        { event_details: event.event_data }
+      end
+
+      def bugsnag_context
+        'mailgun'
+      end
+
+      def bugsnag_grouping_hash
+        event.grouping_error_message
+      end
+    end
+  end
+end

data/lib/mailgun_catcher/version.rb

@@ -1,3 +1,3 @@
 module MailgunCatcher
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailgun_catcher
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Stjepan Hadjić
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-01 00:00:00.000000000 Z
+date: 2020-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bugsnag
@@ -24,21 +24,35 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '5.0'
-description: Engine for maingun hooks
+        version: '4'
+description: Engine for mailgun hooks
 email:
 - d4be4st@gmail.com
 executables: []
@@ -54,14 +68,14 @@ files:
 - lib/mailgun_catcher.rb
 - lib/mailgun_catcher/engine.rb
 - lib/mailgun_catcher/event.rb
-- lib/mailgun_catcher/event_error.rb
+- lib/mailgun_catcher/notifier/bugsnag.rb
 - lib/mailgun_catcher/version.rb
-homepage: https://github.com/infinum/rails-infinum-maingun_catcher
+homepage: https://github.com/infinum/rails-infinum-mailgun_catcher
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,9 +90,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
-summary: Engine for maingun hooks
+summary: Engine for mailgun hooks
 test_files: []

data/lib/mailgun_catcher/event_error.rb

@@ -1,22 +0,0 @@
-module MailgunCatcher
-  class EventError < StandardError
-    attr_reader :event
-
-    def initialize(event)
-      @event = event
-      super(event.error_message)
-    end
-
-    def bugsnag_meta_data
-      { event_details: event.event_data }
-    end
-
-    def bugsnag_context
-      'mailgun'
-    end
-
-    def bugsnag_grouping_hash
-      event.error_message
-    end
-  end
-end