exception_notification-squash_notifier 0.1.1.2 → 0.1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e595cb83373abc990d47bce7578a850bc72398f
-  data.tar.gz: fcb8da7dd0df40d685332efc05ccb160d46b188f
+  metadata.gz: 2b71edc1bca114c09a3f718c18e31b0ad36f2454
+  data.tar.gz: 2687ab743009ba8a776c7e3f9ab1dc64797e65fd
 SHA512:
-  metadata.gz: 80c6e278a302da807e72f73bc0808b8d9fe87687d1fe1729214a0a2daf27a110b1afabf1e26ece84b8c47bcf64dee5a15448e02a2a25a682e3f9eb11e006ead7
-  data.tar.gz: 7c41ba391581c0009a12b7bcbaa2e05bbb25e3d3e51a8308b0ec5435744bef57c964256b27bc664ed72150c8237ae2ba1690610fa346dc9b7273da5b9bbb19f6
+  metadata.gz: 21b4fd84ae9c1fc2b5c4d847ace7355863d6d0d827b2c54b93b69ea889da0a50133f6696df1b55946727506abd30a7470f9aad7d35c05dc450d7c08e04db8fd7
+  data.tar.gz: 64fec832378419250d23b5c99493268f08fcb37c807979b012a69525defbfee94808deab1e740382519e3c2fe3ab5677f30f7bc4e099aeccf5afb37cc9db7ffa

data/lib/exception_notifier/squash_notifier/base.rb

@@ -0,0 +1,50 @@
+module ExceptionNotifier
+  class SquashNotifier
+    # Factory class:
+    def self.new(*args, &p)
+      return SquashRailsNotifier.new(*args, &p) if defined? Rails
+      SquashRubyNotifier.new(*args, &p)
+    end
+
+    class BaseNotifier
+      cattr_accessor :whitelisted_env_vars
+      # This accepts RegEx, so to not-whitelist, add an entry of /.*/
+      self.whitelisted_env_vars = []
+
+      def self.default_options
+        {
+          filter_env_vars: self.whitelist_env_filter
+        }
+      end
+
+      def default_options
+        self.class.default_options
+      end
+
+      def self.whitelist_env_filter
+        # Remove any entries from the 'env' var that are not in the 'whitelisted_env_var' list
+        lambda do |env|
+          env.select do |key, val|
+            #NB: we want to close-over `self` so we can access the class var
+            #NB:
+            # - When `allowed` is a Regexp, === is like ((a =~ b) ? true : false)
+            # - When `allowed` is a String, === is like (a == b.to_str)
+            # - When `allowed` is a Symbol, === is (a == b)
+            self.whitelisted_env_vars.any? {|allowed|  allowed === key }
+          end
+        end
+      end
+
+      #####
+
+      def initialize(options)
+        Squash::Ruby.configure default_options.merge(options)
+        Squash::Ruby.configure disabled: !Squash::Ruby.configuration(:api_key)
+      end
+
+      def call(exception, data={})
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/exception_notifier/squash_notifier/rails.rb

@@ -2,7 +2,7 @@
 
 require 'pp'
 
-class ExceptionNotifier::SquashNotifier
+class ExceptionNotifier::SquashNotifier::SquashRailsNotifier < ExceptionNotifier::SquashNotifier::SquashRubyNotifier
   self.whitelisted_env_vars += [
     'action_dispatch.request.parameters',
     'action_dispatch.request.path_parameters',
@@ -26,6 +26,12 @@ class ExceptionNotifier::SquashNotifier
     'SERVER_SOFTWARE',
   ]
 
+  def call(exception, data={})
+    super(exception, munge_env(data))
+  end
+
+  protected
+
   def munge_env(data)
     return data unless data.has_key?(:env)
 
@@ -45,8 +51,6 @@ class ExceptionNotifier::SquashNotifier
     ))
   end
 
-  private
-
   def occurence_data(request: nil, session: nil, rack_env: {})
     #TODO: Remove when done:
     # flash_key = defined?(ActionDispatch) ? ActionDispatch::Flash::KEY : 'flash'

data/lib/exception_notifier/squash_notifier/ruby.rb

@@ -0,0 +1,23 @@
+class ExceptionNotifier::SquashNotifier::SquashRubyNotifier < ExceptionNotifier::SquashNotifier::BaseNotifier
+  self.whitelisted_env_vars += [
+    'BUNDLE_BIN_PATH',
+    'BUNDLE_GEMFILE',
+    'CONTENT_LENGTH',
+    'CONTENT_TYPE',
+    'DOCUMENT_ROOT',
+    'GEM_HOME',
+    'HOME',
+    'ORIGINAL_FULLPATH',
+    'PATH',
+    'PATH_INFO',
+    'PWD',
+    'RUBYOPT',
+    'TMPDIR',
+    'USER',
+  ]
+
+  def call(exception, data={})
+    #NB: You can pass a `user_data` hash to #notify, and most attr's will be placed into a `user_data` field
+    Squash::Ruby.notify(exception, data)
+  end
+end

data/lib/exception_notifier/squash_notifier/version.rb

@@ -1,5 +1,5 @@
 module ExceptionNotifier
   class SquashNotifier
-    VERSION = "0.1.1.2"
+    VERSION = "0.1.1.3"
   end
 end

data/lib/exception_notifier/squash_notifier.rb

@@ -4,69 +4,9 @@ require "active_support/core_ext/module/attribute_accessors"
 require "exception_notifier"
 
 require "exception_notifier/squash_ruby"
-
-module ExceptionNotifier
-  class SquashNotifier
-    cattr_accessor :whitelisted_env_vars
-    # This accepts RegEx, so to not-whitelist, add an entry of /.*/
-    self.whitelisted_env_vars = [
-      'BUNDLE_BIN_PATH',
-      'BUNDLE_GEMFILE',
-      'CONTENT_LENGTH',
-      'CONTENT_TYPE',
-      'DOCUMENT_ROOT',
-      'GEM_HOME',
-      'HOME',
-      'ORIGINAL_FULLPATH',
-      'PATH',
-      'PATH_INFO',
-      'PWD',
-      'RUBYOPT',
-      'TMPDIR',
-      'USER',
-    ]
-
-    def self.default_options
-      {
-        filter_env_vars: self.whitelist_env_filter
-      }
-    end
-
-    def default_options
-      self.class.default_options
-    end
-
-    def self.whitelist_env_filter
-      # Remove any entries from the 'env' var that are not in the 'whitelisted_env_var' list
-      lambda do |env|
-        env.select do |key, val|
-          #NB: we want to close-over `self` so we can access the class var
-          #NB:
-          # - When `allowed` is a Regexp, === is like ((a =~ b) ? true : false)
-          # - When `allowed` is a String, === is like (a == b.to_str)
-          # - When `allowed` is a Symbol, === is (a == b)
-          self.whitelisted_env_vars.any? {|allowed|  allowed === key }
-        end
-      end
-    end
-
-    #####
-
-    def initialize(options)
-      Squash::Ruby.configure default_options.merge(options)
-      Squash::Ruby.configure disabled: !Squash::Ruby.configuration(:api_key)
-    end
-
-    def call(exception, data={})
-      #NB: You can pass a `user_data` hash to #notify, and most attr's will be placed into a `user_data` field
-      Squash::Ruby.notify(exception, munge_env(data))
-    end
-
-    def munge_env(data)
-      data
-    end
-  end
-end
-
 # Extend class if you find Rails is being used:
-require 'exception_notifier/squash_notifier/rails'  if defined? Rails
+require 'exception_notifier/squash_ruby/rails'  if defined? Rails
+
+require 'exception_notifier/squash_notifier/base'
+require 'exception_notifier/squash_notifier/ruby'
+require 'exception_notifier/squash_notifier/rails'

data/lib/exception_notifier/squash_ruby/rails.rb

@@ -8,19 +8,21 @@ module Squash::Ruby
        params session flash cookies]
   )
 
-  def self.client_name
-    'squash-notifier-rails'
-  end
+  class << self
+    def client_name
+      'squash-notifier-rails'
+    end
 
-  def self.failsafe_log(tag, message)
-    logger = Rails.respond_to?(:logger) ? Rails.logger : RAILS_DEFAULT_LOGGER
-    if (logger.respond_to?(:tagged))
-      logger.tagged(tag) { logger.error message }
-    else
-      logger.error "[#{tag}]\t#{message}"
+    def failsafe_log(tag, message)
+      logger = Rails.respond_to?(:logger) ? Rails.logger : RAILS_DEFAULT_LOGGER
+      if (logger.respond_to?(:tagged))
+        logger.tagged(tag) { logger.error message }
+      else
+        logger.error "[#{tag}]\t#{message}"
+      end
+    rescue Object => err
+      $stderr.puts "Couldn't write to failsafe log (#{err.to_s}); writing to stderr instead."
+      $stderr.puts "#{Time.now.to_s}\t[#{tag}]\t#{message}"
     end
-  rescue Object => err
-    $stderr.puts "Couldn't write to failsafe log (#{err.to_s}); writing to stderr instead."
-    $stderr.puts "#{Time.now.to_s}\t[#{tag}]\t#{message}"
   end
 end

data/lib/exception_notifier/squash_ruby.rb

@@ -6,12 +6,12 @@ module Squash::Ruby
   # These are supposed to contain lambdas/procs that will filter the contents of these arrays before sending them up to the Squash server
 
   class << self
-    private
-
     def client_name
       'squash-notifier'
     end
 
+    private
+
     alias :environment_data__original :environment_data
 
     def environment_data
@@ -27,6 +27,3 @@ module Squash::Ruby
     end
   end
 end
-
-# Extend class if you find Rails is being used:
-require 'exception_notifier/squash_ruby/rails'  if defined? Rails

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification-squash_notifier
 version: !ruby/object:Gem::Version
-  version: 0.1.1.2
+  version: 0.1.1.3
 platform: ruby
 authors:
 - Will Robertson
@@ -154,7 +154,9 @@ files:
 - bin/exception-notifier-squash-notifier
 - exception-notification-squash-notifier.gemspec
 - lib/exception_notifier/squash_notifier.rb
+- lib/exception_notifier/squash_notifier/base.rb
 - lib/exception_notifier/squash_notifier/rails.rb
+- lib/exception_notifier/squash_notifier/ruby.rb
 - lib/exception_notifier/squash_notifier/version.rb
 - lib/exception_notifier/squash_ruby.rb
 - lib/exception_notifier/squash_ruby/rails.rb