exception_notification-squash_notifier 0.1.1 → 0.1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c430db5ff29ad03510cbf68c9522c52fac229732
-  data.tar.gz: 2f4b0a4858cba1c1bad75cfb15c87cd1e4bfa20d
+  metadata.gz: a7ec2b5af8dd752ed7db38ab8986d6ff23840285
+  data.tar.gz: 22931676072bd8c10d45b1c334c597920ace15dc
 SHA512:
-  metadata.gz: 4f5093d0882cd1e6ca3d686b368e8f1844f81ff9c73547d6b1b0e87097075fa4638287b38dd692ec46db04b8060ae8116bfa5676a716c5f4b67eac3454d00697
-  data.tar.gz: 45c57a3fa5bd0169bf1e11c5e59bd120bc2dfd0a8f862199eafa10a1abdc71040c53aecca29753c15b85ef8b7c9b71f6feaecb63334751aca26ec5cf22ba9c27
+  metadata.gz: 7235e19a31f9f636d671cf02a184b82e2092d1076619fd0dcbacfe8729860933dc2329b984db4e7b70cf635600d8f6bcf7659a35d0073dc908ebdf47ee971e5f
+  data.tar.gz: def3e87c18f5eab7ae12fb6d60a9f5753b6e221f6b2e4da6afa3fd8c31ae82e91ee47781a811746988d185bdeb14d1f3e7e7d8e6da954ec849a4ed2254a9657c

data/README.md

@@ -8,7 +8,7 @@ for cpaturing and forwarding exceptions to SquareSquash/web server
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'exception-notifier-squash-notifier'
+gem 'exception-notifier-squash-notifier', require: 'exception_notifier/squash_notifier'
 ```
 
 And then execute:

data/exception-notification-squash-notifier.gemspec

@@ -25,6 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov", "~> 0.9"
   spec.add_development_dependency "exception_notification", "~> 4.0"
 
-  spec.add_dependency "activesupport", ">= 3.0.4"
+  spec.add_dependency "activesupport", "~> 3.0"
   spec.add_dependency "squash_ruby", "~> 2.0"
 end

data/lib/exception_notifier/squash_notifier/rails.rb

@@ -0,0 +1,99 @@
+# Extend SquashNotifier with Rails support
+
+require 'pp'
+
+class ExceptionNotifier::SquashNotifier
+  self.whitelisted_env_vars += [
+    'action_dispatch.request.parameters',
+    'action_dispatch.request.path_parameters',
+    'action_dispatch.request.query_parameters',
+    'action_dispatch.request.request_parameters',
+    /HTTP_/,
+    'PASSENGER_APP_TYPE',
+    'PASSENGER_ENV',
+    'PASSENGER_RUBY',
+    'PASSENGER_SPAWN_METHOD',
+    'PASSENGER_USER',
+    'RAILS_ENV',
+    'REMOTE_ADDR',
+    'REMOTE_PORT',
+    'REQUEST_METHOD',
+    'REQUEST_URI',
+    'SERVER_ADDR',
+    'SERVER_NAME',
+    'SERVER_PORT',
+    'SERVER_PROTOCOL',
+    'SERVER_SOFTWARE',
+  ]
+
+  def munge_env(data)
+    return data unless data.has_key?(:env)
+
+    env = data.delete(:env)
+
+    request = ActionDispatch::Request.new(env)
+
+    whitelist_env = Squash::Ruby.configuration(:filter_env_vars)
+    parameter_filter = ActionDispatch::Http::ParameterFilter.new(env["action_dispatch.parameter_filter"])
+    filtered_env = whitelist_env.call(request.try(:filtered_env) || parameter_filter.filter(env))
+
+    data.merge(occurence_data(
+      request: request,
+      session: parameter_filter.filter(request.session.to_hash),
+      cookies: env['rack.request.cookie_hash'],
+      rack_env: filtered_env
+    ))
+  end
+
+  private
+
+  def occurence_data(request: nil, session: nil, cookies: {}, rack_env: {})
+    flash_key = defined?(ActionDispatch) ? ActionDispatch::Flash::KEY : 'flash'
+
+    # raw_session_id = request.session['session_id'] || (request.env["rack.session.options"] and request.env["rack.session.options"][:id])
+    # session_id = request.ssl? ? "[FILTERED]" : raw_session_id.inspect
+
+    #NB: If you update this hash, make sure to update TOP_LEVEL_USER_DATA in
+    #    squash_ruby/rails.rb
+    {
+      :environment    => environment_name,
+      :root           => root_path,
+
+      # Squash Server recreates the URL from these:
+      :request_method => request.request_method.to_s,
+      :schema         => request.protocol.sub('://', ''),
+      :host           => request.host,
+      :port           => request.port,
+      :path           => request.path,
+      :query          => request.query_string,
+      :headers        => request_headers(rack_env),
+
+      # :controller  ## Rails Controller
+      # :action  ## Rails Action
+      :params         => request.filtered_parameters,
+      # :session_id     => session_id,
+      :session        => session,
+      :flash          => session[flash_key],
+      :cookies        => cookies,
+
+      # User Data:
+      :host_ip        => request.remote_ip,
+      :host_name      => Socket.gethostname,
+      :"rack.env"     => rack_env.to_hash
+    }
+  end
+
+  def environment_name
+    return ::Rails.env.to_s if defined?(::Rails)
+    ENV['RAILS_ENV'] || ENV['RACK_ENV']
+  end
+
+  # Extract any rack key/value pairs where the key begins with HTTP_*
+  def request_headers(env)
+    env.select { |key, _| key[0, 5] == 'HTTP_' }
+  end
+
+  def root_path
+    defined?(::Rails) ? ::Rails.root.to_s : ENV['RAILS_ROOT']
+  end
+end

data/lib/exception_notifier/squash_notifier/version.rb

@@ -1,5 +1,5 @@
 module ExceptionNotifier
   class SquashNotifier
-    VERSION = "0.1.1"
+    VERSION = "0.1.1.1"
   end
 end

data/lib/exception_notifier/squash_notifier.rb

@@ -7,11 +7,9 @@ require "exception_notifier/squash_ruby"
 
 module ExceptionNotifier
   class SquashNotifier
-    @@whitelisted_env_vars = [
-      'action_dispatch.request.parameters',
-      'action_dispatch.request.path_parameters',
-      'action_dispatch.request.query_parameters',
-      'action_dispatch.request.request_parameters',
+    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',
@@ -19,31 +17,14 @@ module ExceptionNotifier
       'DOCUMENT_ROOT',
       'GEM_HOME',
       'HOME',
-      /HTTP_/,
       'ORIGINAL_FULLPATH',
-      'PASSENGER_APP_TYPE',
-      'PASSENGER_ENV',
-      'PASSENGER_RUBY',
-      'PASSENGER_SPAWN_METHOD',
-      'PASSENGER_USER',
       'PATH',
       'PATH_INFO',
       'PWD',
-      'RAILS_ENV',
-      'REMOTE_ADDR',
-      'REMOTE_PORT',
-      'REQUEST_METHOD',
-      'REQUEST_URI',
       'RUBYOPT',
-      'SERVER_ADDR',
-      'SERVER_NAME',
-      'SERVER_PORT',
-      'SERVER_PROTOCOL',
-      'SERVER_SOFTWARE',
       'TMPDIR',
       'USER',
     ]
-    cattr_accessor :whitelisted_env_vars
 
     def self.default_options
       {
@@ -76,9 +57,16 @@ module ExceptionNotifier
       Squash::Ruby.configure disabled: !Squash::Ruby.configuration(:api_key)
     end
 
-    def call(exception, options={})
+    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, options)
+      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

data/lib/exception_notifier/squash_ruby/rails.rb

@@ -0,0 +1,26 @@
+# Extend SquashNotifier with Rails support
+
+module Squash::Ruby
+  TOP_LEVEL_USER_DATA.concat(
+    %w[environment root xhr
+       headers
+       request_method schema host port path query
+       params session flash cookies]
+  )
+
+  def self.client_name
+    'squash-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}"
+    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

@@ -8,6 +8,10 @@ module Squash::Ruby
   class << self
     private
 
+    def client_name
+      'squash'
+    end
+
     alias :environment_data__original :environment_data
 
     def environment_data
@@ -23,3 +27,6 @@ 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification-squash_notifier
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.1.1
 platform: ruby
 authors:
 - Will Robertson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,16 +98,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.4
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.4
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: squash_ruby
   requirement: !ruby/object:Gem::Requirement
@@ -140,8 +140,10 @@ files:
 - bin/exception-notifier-squash-notifier
 - exception-notification-squash-notifier.gemspec
 - lib/exception_notifier/squash_notifier.rb
+- lib/exception_notifier/squash_notifier/rails.rb
 - lib/exception_notifier/squash_notifier/version.rb
 - lib/exception_notifier/squash_ruby.rb
+- lib/exception_notifier/squash_ruby/rails.rb
 - spec/exception_notifier/squash_notifier_spec.rb
 - spec/exception_notifier/squash_ruby_spec.rb
 - spec/spec_helper.rb