exception_notification-squash_notifier 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c430db5ff29ad03510cbf68c9522c52fac229732
+  data.tar.gz: 2f4b0a4858cba1c1bad75cfb15c87cd1e4bfa20d
+SHA512:
+  metadata.gz: 4f5093d0882cd1e6ca3d686b368e8f1844f81ff9c73547d6b1b0e87097075fa4638287b38dd692ec46db04b8060ae8116bfa5676a716c5f4b67eac3454d00697
+  data.tar.gz: 45c57a3fa5bd0169bf1e11c5e59bd120bc2dfd0a8f862199eafa10a1abdc71040c53aecca29753c15b85ef8b7c9b71f6feaecb63334751aca26ec5cf22ba9c27

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exception-notifier-squash-notifier.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Powershop
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# ExceptionNotifier::SquashNotifier
+
+This is a plugin for the ExceptionNotification gem to allow it to use the SquareSquash/ruby gem
+for cpaturing and forwarding exceptions to SquareSquash/web server
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exception-notifier-squash-notifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exception-notifier-squash-notifer
+
+## Usage
+
+Simply configure Squash client as normal (see SquareSquash/ruby gem for details).
+
+## Contributing
+
+1. Fork it ( https://github.com/powershop/exception-notifier-squash-notifier/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/TODO.org

@@ -0,0 +1,2 @@
+* Tasks
+* Checklist

data/bin/exception-notifier-squash-notifier

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'exception_notifier/squash'

data/exception-notification-squash-notifier.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exception_notifier/squash_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exception_notification-squash_notifier"
+  spec.version       = ExceptionNotifier::SquashNotifier::VERSION
+  spec.authors       = ["Will Robertson"]
+  spec.email         = ["will.robertson@powershop.co.nz"]
+  spec.summary       = %q{Exception Notifier plugin for Squash}
+  spec.description   = %q{Plugin to use Squash with ExceptionNotification}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "pry-byebug", "~> 3.0"
+  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 "squash_ruby", "~> 2.0"
+end

data/lib/exception_notifier/squash_notifier/version.rb

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

data/lib/exception_notifier/squash_notifier.rb

@@ -0,0 +1,84 @@
+require "exception_notifier/squash_notifier/version"
+
+require "active_support/core_ext/module/attribute_accessors"
+require "exception_notifier"
+
+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',
+      'BUNDLE_BIN_PATH',
+      'BUNDLE_GEMFILE',
+      'CONTENT_LENGTH',
+      'CONTENT_TYPE',
+      '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
+      {
+        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, options={})
+      #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)
+    end
+  end
+end

data/lib/exception_notifier/squash_ruby.rb

@@ -0,0 +1,25 @@
+require "squash/ruby"
+
+module Squash::Ruby
+
+  # You need to set a configuration :filter_env_vars and :filter_argv
+  # 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
+
+    alias :environment_data__original :environment_data
+
+    def environment_data
+      no_filtering = lambda {|val| val }
+      filter_env_vars = configuration(:filter_env_vars) || no_filtering
+      filter_argv = configuration(:filter_argv) || no_filtering
+
+      ev_orig = environment_data__original
+      ev_orig.merge({
+        'env_vars' => filter_env_vars.call(ev_orig['env_vars']),  # The original "valueifies" ENV for us
+        'arguments' => filter_argv.call(ARGV).join(' ')  # The original munges into a string, which is less-easy to filter
+      })
+    end
+  end
+end

data/spec/exception_notifier/squash_notifier_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+RSpec.shared_context "squash_ruby" do
+  let(:squash_ruby) do
+    class_double("Squash::Ruby").
+      as_stubbed_const(:transfer_nested_constants => true)
+  end
+end
+
+describe ExceptionNotifier::SquashNotifier do
+  include_context "squash_ruby"
+
+  let(:squash_notifier) { ExceptionNotifier.registered_exception_notifier(:squash) }
+
+  describe "with a valid instance" do
+    before(:context) do
+      @squash_config_options = {
+        api_host: 'https://no-such-host.noncom',
+        api_key: '00000000-0000-0000-0000-000000000000',
+        environment: 'development'
+      }
+
+      env = ExceptionNotifier::SquashNotifier.whitelisted_env_vars.map do |k|
+        k = k.to_s.sub(/^(\(.*:)(.*)(\))$/, '\2') if k.is_a? Regexp
+        [k.to_s, "val #{k}"]
+      end
+      @captured_env_vars = Hash[env]
+    end
+
+    describe "created directly" do
+      it "can create a SquashNotifier from a const" do
+        expect(squash_ruby).to receive(:configure).with(
+          @squash_config_options.merge(filter_env_vars: duck_type(:call))
+        )
+        expect(squash_ruby).to receive(:configuration).with(:api_key).and_return(true)
+        expect(squash_ruby).to receive(:configure).with(disabled: false)
+        expect(ExceptionNotifier::SquashNotifier.new(@squash_config_options)).to be_an ExceptionNotifier::SquashNotifier
+      end
+
+    end
+
+    describe "created via ExceptionNotifier" do
+      around(:context) do |eg|
+        ExceptionNotification.configure {|c| c.add_notifier :squash, @squash_config_options }
+        eg.run
+        ExceptionNotification.configure {|c| c.unregister_exception_notifier :squash }
+      end
+      let(:squash_notifier) { ExceptionNotifier.registered_exception_notifier(:squash) }
+
+      #Time.stubs(:current).returns('Sat, 20 Apr 2013 20:58:55 UTC +00:00')
+
+      it "has a version number" do
+        expect(ExceptionNotifier::SquashNotifier::VERSION).not_to be_nil
+      end
+
+      it "notifies Squash of an exception" do
+        begin
+          1/0
+        rescue => e
+          expect(squash_ruby).to receive(:notify).with(e, {})
+          ExceptionNotifier.notify_exception(e, {})
+        end
+      end
+
+      context "whitelisting" do
+        it "should be the same at class and instance level" do
+          #NB: Need to use #class_eval, as the underlying is dynamically extended
+          expect(squash_notifier.whitelisted_env_vars).to eq(ExceptionNotifier::SquashNotifier.class_eval { self.whitelisted_env_vars })
+        end
+
+        context "with faked ENV" do
+          around do |eg|
+            ENV["NOSUCHVAR"] = "Test"
+            eg.run
+            ENV.delete("NOSUCHVAR")
+          end
+
+          it do
+            expect(Squash::Ruby.class_eval { environment_data['env_vars'] }).to include("HOME" => String)
+          end
+
+          it do
+            expect(Squash::Ruby.class_eval { environment_data['env_vars'] }).not_to include("NOSUCHVAR" => "Test")
+          end
+        end
+      end
+    end
+  end
+
+  describe "with Squash unregistered" do
+    it "should note find a Squash notifier" do
+      expect(squash_notifier).to be_nil
+    end
+  end
+end

data/spec/exception_notifier/squash_ruby_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Squash::Ruby do
+  describe "with a valid instance" do
+    context "with a key-replacement env-var filter" do
+      around(:all) do |eg|
+        @key_prefix = '@@ '
+        @val_prefix = '== '
+        filter_env_vars = lambda do |env_vars|
+          Hash[env_vars.map {|h, v| [@key_prefix + h.to_s, @val_prefix + v.to_s] }]
+        end
+
+        Squash::Ruby.configure(filter_env_vars: filter_env_vars)
+        eg.run
+        Squash::Ruby.configure(filter_env_vars: nil)
+      end
+
+      it "should return prefaced keys and val's for ENV" do
+        Squash::Ruby.class_eval { environment_data['env_vars'] }.each do |k, v|
+          expect(k).to match(/^#{@key_prefix}/),
+            "expected ENV[#{k}].key to start with #{@key_prefix.inspect}"
+          expect(v).to match(/^#{@val_prefix}/),
+            "expected ENV[#{k}].val to start with #{@val_prefix.inspect}"
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/.bundle/"
+end
+
+require 'pry'
+
+#####
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'exception_notification'
+require 'exception_notifier/squash_notifier'

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: exception_notification-squash_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Will Robertson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: exception_notification
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+- !ruby/object:Gem::Dependency
+  name: squash_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Plugin to use Squash with ExceptionNotification
+email:
+- will.robertson@powershop.co.nz
+executables:
+- exception-notifier-squash-notifier
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.org
+- bin/exception-notifier-squash-notifier
+- exception-notification-squash-notifier.gemspec
+- lib/exception_notifier/squash_notifier.rb
+- lib/exception_notifier/squash_notifier/version.rb
+- lib/exception_notifier/squash_ruby.rb
+- spec/exception_notifier/squash_notifier_spec.rb
+- spec/exception_notifier/squash_ruby_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Exception Notifier plugin for Squash
+test_files:
+- spec/exception_notifier/squash_notifier_spec.rb
+- spec/exception_notifier/squash_ruby_spec.rb
+- spec/spec_helper.rb
+has_rdoc: