errdo 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcc8bc45f83d4e56758de834b00faf00248fda69
-  data.tar.gz: d914ab5cb2923b2355b8d8556ed9ebb2a4ffb319
+  metadata.gz: afd0ced27a284c7156048fea8ea7cdbe545ef536
+  data.tar.gz: ea3ca879d18125601699fba3db1c9abef1a4af17
 SHA512:
-  metadata.gz: 81a12eabf89eb076dff857bd16ccd22e9eb0057ab79b6286a4de517d0497c350d1aab4477133ba068d0be0391724845402e023bcc1e88fb4b5b8bd7995b3377c
-  data.tar.gz: eaa11a4adbf37e7bd2bc8684b0d2428f864ee26c4f1ae107cd86982f5498d422b07917ad5b2727325f02a4bc7584bf8692ed3916baca9336264631f7c6e9fc15
+  metadata.gz: 941461a2b07d34e392b40e6c667e6c481750379ddf95a971860e4e6c3ac19a3ed9cc17557f03a4429a74b8b8e32feb8f72376978e1f8a6cdda47f1e6ed7f4828
+  data.tar.gz: 1f1ee20cb3f0d06355ee5b062ab62a8f2712e53513f9c8cbd6920ea7a68f92b5b27fd1f6df0bec41ae3524f0ce0ef03881fd826c989cd14ffea8551a68271666

data/app/models/errdo/exception.rb

@@ -5,7 +5,9 @@ module Errdo
       user_parser = Errdo::Models::UserParser.new(env)
       @env_parser = Errdo::Models::ErrorEnvParser.new(env, user_parser)
       error = create_errors(@env_parser) unless Errdo.error_name.blank?
-      send_slack_notification(error, @env_parser)
+      Errdo.notify_with.each do |notifier|
+        notifier.notify(error, @env_parser)
+      end
     end
 
     private
@@ -16,16 +18,5 @@ module Errdo
       return error
     end
 
-    def send_slack_notification(error, parser)
-      if Errdo.slack_notifier
-        messager = Errdo::Models::SlackMessager.new(error, parser)
-        begin
-          Errdo.slack_notifier.ping messager.message
-        rescue => e
-          Rails.logger.error e
-        end
-      end
-    end
-
   end
 end

data/lib/errdo/extension.rb

@@ -2,6 +2,7 @@ module Errdo
   # rubocop:disable MutableConstant
   EXTENSIONS = []
   AUTHORIZATION_ADAPTERS = {}
+  NOTIFICATION_ADAPTERS = {}
   # rubocop:enable MutableConstant
 
   # The extension may define various adapters (e.g., for authorization) and
@@ -15,4 +16,14 @@ module Errdo
       AUTHORIZATION_ADAPTERS[extension_key] = extension_definition::AuthorizationAdapter
     end
   end
+
+  def self.add_notification(notification_key, notification_definition, options = {})
+    options.assert_valid_keys(:notification)
+
+    EXTENSIONS << notification_key
+
+    if options[:notification]
+      NOTIFICATION_ADAPTERS[notification_key] = notification_definition::NotificationAdapter
+    end
+  end
 end

data/lib/errdo/notifications/slack/notification_adapter.rb

@@ -0,0 +1,64 @@
+require 'slack-notifier'
+require_relative '../../helpers/views_helper.rb'
+
+module Errdo
+  module Notifications
+    module Slack
+      # This adapter is for slack notifier
+      class NotificationAdapter
+
+        # See the slack notifier for where the initialization happens.
+        def initialize(options = {})
+          @slack_notifier = ::Slack::Notifier.new options[:webhook],
+                                                  channel: options[:channel] || nil,
+                                                  icon_emoji: options[:icon] || ':boom:',
+                                                  username: options[:name] || 'Errdo-bot'
+        end
+
+        def notify(error, parser)
+          messager = SlackMessager.new(error, parser)
+          begin
+            @slack_notifier.ping messager.message
+          rescue => e
+            Rails.logger.error e
+          end
+        end
+
+      end
+
+      class SlackMessager
+
+        include Errdo::Helpers::ViewsHelper # For the naming of the user in the message
+
+        def initialize(error, parser)
+          if error.nil?
+            @user = parser.user
+            @backtrace = parser.short_backtrace
+            @exception_name = parser.exception_name
+            @exception_message = parser.exception_message
+          else
+            @user = error.last_experiencer
+            @backtrace = error.short_backtrace
+            @exception_name = error.exception_class_name
+            @exception_message = error.exception_message
+          end
+        end
+
+        def message
+          "#{exception_string}#{user_message_addon}\n#{@backtrace}"
+        end
+
+        private
+
+        def exception_string
+          "#{@exception_name} | #{@exception_message}"
+        end
+
+        def user_message_addon
+          "\nExperienced by #{user_show_string(@user)} " if @user
+        end
+
+      end
+    end
+  end
+end

data/lib/errdo/notifications/slack.rb

@@ -0,0 +1,3 @@
+require 'errdo/notifications/slack/notification_adapter'
+
+Errdo.add_notification(:slack, Errdo::Notifications::Slack, notification: true)

data/lib/errdo/version.rb

@@ -1,3 +1,3 @@
 module Errdo
-  VERSION = '0.9.1'.freeze
+  VERSION = '0.10.0'.freeze
 end

data/lib/errdo.rb

@@ -1,7 +1,7 @@
 require 'errdo/engine'
 require 'errdo/extension'
 require 'errdo/extensions/cancancan'
-require 'slack-notifier'
+require 'errdo/notifications/slack'
 
 module Errdo
   # A lot of this authorization/authentication code was heavily inspired by Rails Admin gem, which is a great gem
@@ -27,22 +27,6 @@ module Errdo
   mattr_accessor :user_show_path
   @@user_show_path = nil
 
-  # This is the webhook path for slack integration
-  mattr_accessor :slack_webhook
-  @@slack_webhook = nil
-
-  # The icon that the slack integration posts with
-  mattr_accessor :slack_icon
-  @@slack_icon = ":boom:"
-
-  # The name that the slack integration posts with
-  mattr_accessor :slack_name
-  @@slack_name = "Errdo-bot"
-
-  # The channel to post the errors to. Default is whatever the default of the integration is
-  mattr_accessor :slack_channel
-  @@slack_channel = nil
-
   mattr_accessor :dirty_words
   @@dirty_words = %w(password passwd password_confirmation secret confirm_password secret_token)
   # rubocop:enable Style/ClassVars
@@ -92,16 +76,27 @@ module Errdo
     @authorize || DEFAULT_AUTHORIZE
   end
 
-  def self.slack_notifier
-    @slack_notifier ||= nil
-    if @slack_notifier
-      @slack_notifier
-    elsif slack_webhook
-      @slack_notifier = Slack::Notifier.new slack_webhook,
-                                            channel: slack_channel || nil,
-                                            icon_emoji: slack_icon,
-                                            username: slack_name
+  # == Notifications ==
+  # Setup notifications
+  #
+  # Every configured notifier can be set here as
+  # @example
+  #   Errdo.notify_with slack: {  webhook: "WEBHOOK-URL",
+  #                               channel: "#general"
+  #                               icon: ":boom:",
+  #                               name: "Errdo-bot" }
+  #
+  #
+  # Right now, only slack is supported
+  def self.notify_with(notifiers = nil)
+    if notifiers
+      @notifiers = []
+      notifiers.each do |notifier|
+        klass = Errdo::NOTIFICATION_ADAPTERS[notifier[0]]
+        @notifiers.append(klass.new(**notifier[1])) # The options will be in the second field
+      end
     end
+    @notifiers ||= []
   end
 
   def self.setup

data/lib/generators/templates/errdo.rb

@@ -36,15 +36,15 @@ Errdo.setup do |config|
   # Default is the errdo root path
   # config.user_show_path = :user_path
 
-  ## == Slack Integration ====================
+  ## == Notification Integration ====================
   # See the github page at https://github.com/erichaydel/errdo for more info on how to set up slack
-  # If you want to set up slack, this is the only required parameter
-  # config.slack_webhook = 'YOUR-WEBHOOK-HERE'
-
-  # You can customize what icon and name the notification posts with. Default is an explosion and "Errdo-bot"
-  # config.slack_icon = ':boom:'
-  # config.slack_name = 'Errdo-bot'
+  # If you want to set up slack, this is the only required parameter.
+  # The rest are totally optional, and default to the values here
+  #
+  #   Errdo.notify_with slack: {  webhook: "WEBHOOK-URL",
+  #                               channel: nil
+  #                               icon: ":boom:",
+  #                               name: "Errdo-bot" }
 
-  # This configures the channel to post error notifications to.  If nothing is set, it will post the the default
-  # config.slack_channel = '#channel'
+  # For now, slack is the only integration. More coming soon!
 end

data/test/dummy/config/initializers/errdo.rb

@@ -15,4 +15,6 @@ Errdo.setup do |config|
   # Note: The model name "{name}_instance" should also be free
   #
   config.error_name = :errors
+
+  # config.notify_with slack: { webhook: "https://hooks.slack.com/services/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" }
 end