exception_notification-squash_notifier 0.1.1.3 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b71edc1bca114c09a3f718c18e31b0ad36f2454
-  data.tar.gz: 2687ab743009ba8a776c7e3f9ab1dc64797e65fd
+  metadata.gz: 49df10a4b82e71ad0829544c5adeac202ab40884
+  data.tar.gz: 52715ca0a077f47f2c810b690b3a36e1ce778d8a
 SHA512:
-  metadata.gz: 21b4fd84ae9c1fc2b5c4d847ace7355863d6d0d827b2c54b93b69ea889da0a50133f6696df1b55946727506abd30a7470f9aad7d35c05dc450d7c08e04db8fd7
-  data.tar.gz: 64fec832378419250d23b5c99493268f08fcb37c807979b012a69525defbfee94808deab1e740382519e3c2fe3ab5677f30f7bc4e099aeccf5afb37cc9db7ffa
+  metadata.gz: f308ec8684dae55a9d353ea1c6229bdc5bce7b5fc0a8ffcf086fe5b73d233e7ede63c9a6f2c3f41ac2780f62fee3ab4be8dc9182bbe0a57bac8a4d6a22e24ef1
+  data.tar.gz: d320ce946935fc66341dc8d72514a144b4001cac4b2e26a4ddd2c3798f6d3c7e9b104e366bd56a5872deef7a3ec9dce1da7e70f5d83cf6b4827ee87242007b02

data/lib/exception_notifier/squash_notifier.rb

@@ -3,7 +3,7 @@ require "exception_notifier/squash_notifier/version"
 require "active_support/core_ext/module/attribute_accessors"
 require "exception_notifier"
 
-require "exception_notifier/squash_ruby"
+require "exception_notifier/squash_ruby/ruby"
 # Extend class if you find Rails is being used:
 require 'exception_notifier/squash_ruby/rails'  if defined? Rails
 

data/lib/exception_notifier/squash_notifier/base.rb

@@ -1,25 +1,17 @@
 module ExceptionNotifier
   class SquashNotifier
-    # Factory class:
+    # Factory class
+
+    cattr_accessor :enable_rails
+    self.enable_rails = true
+
     def self.new(*args, &p)
-      return SquashRailsNotifier.new(*args, &p) if defined? Rails
+      return SquashRailsNotifier.new(*args, &p) if self.enable_rails && 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
+      cattr_accessor :whitelisted_env_vars, :default_options
 
       def self.whitelist_env_filter
         # Remove any entries from the 'env' var that are not in the 'whitelisted_env_var' list
@@ -35,6 +27,13 @@ module ExceptionNotifier
         end
       end
 
+      # This accepts RegEx, so to not-whitelist, add an entry of /.*/
+      self.whitelisted_env_vars = []
+
+      self.default_options = {
+        filter_env_vars: self.whitelist_env_filter
+      }
+
       #####
 
       def initialize(options)

data/lib/exception_notifier/squash_notifier/rails.rb

@@ -52,6 +52,8 @@ class ExceptionNotifier::SquashNotifier::SquashRailsNotifier < ExceptionNotifier
   end
 
   def occurence_data(request: nil, session: nil, rack_env: {})
+    fail "No 'request' supplied" unless request
+
     #TODO: Remove when done:
     # flash_key = defined?(ActionDispatch) ? ActionDispatch::Flash::KEY : 'flash'
 

data/lib/exception_notifier/squash_notifier/version.rb

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

data/spec/exception_notifier/squash_notifier_rails_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper_rails'
+
+describe ExceptionNotifier::SquashNotifier do
+  #pending { expect(true).to be(false) }
+end

data/spec/exception_notifier/squash_notifier_spec.rb

@@ -1,50 +1,58 @@
 require 'spec_helper'
 
-RSpec.shared_context "squash_ruby" do
-  let(:squash_ruby) do
-    class_double("Squash::Ruby").
-      as_stubbed_const(:transfer_nested_constants => true)
+RSpec.shared_context "squash_notifier_creation" do
+  let(:squash_notifier) { ExceptionNotifier.registered_exception_notifier(:squash) }
+
+  before(:context) do
+    @squash_config_options = {
+      api_host: 'https://no-such-host.noncom',
+      api_key: '00000000-0000-0000-0000-000000000000',
+      environment: 'development'
+    }
+
+    env = described_class.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 #{described_class} 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 described_class
+    end
   end
 end
 
-describe ExceptionNotifier::SquashNotifier do
+describe ExceptionNotifier::SquashNotifier::SquashRubyNotifier do
   include_context "squash_ruby"
 
-  let(:squash_notifier) { ExceptionNotifier.registered_exception_notifier(:squash) }
+  around(:context) do |eg|
+    saved = ExceptionNotifier::SquashNotifier.enable_rails
+    ExceptionNotifier::SquashNotifier.enable_rails = false
 
-  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
+    eg.run
 
-    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
+    ExceptionNotifier::SquashNotifier.enable_rails = saved
+  end
 
-    end
+  describe "with a valid instance" do
+    include_context "squash_notifier_creation"
 
     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')
@@ -57,15 +65,19 @@ describe ExceptionNotifier::SquashNotifier do
         begin
           1/0
         rescue => e
-          expect(squash_ruby).to receive(:notify).with(e, {})
+          expect(squash_ruby).to receive(:notify).with(e, {}).and_return(nil)
           ExceptionNotifier.notify_exception(e, {})
         end
       end
 
       context "whitelisting" do
+        it "should have a whitelisting filter" do
+          expect(Squash::Ruby.configuration(:filter_env_vars)).not_to be_nil
+        end
+
         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 })
+          expect(squash_notifier.whitelisted_env_vars).to eq(described_class.class_eval { self.whitelisted_env_vars })
         end
 
         context "with faked ENV" do
@@ -88,8 +100,67 @@ describe ExceptionNotifier::SquashNotifier do
   end
 
   describe "with Squash unregistered" do
-    it "should note find a Squash notifier" do
+    include_context "squash_notifier_creation"
+
+    it "should not find a Squash notifier" do
       expect(squash_notifier).to be_nil
     end
   end
 end
+
+#####
+
+describe ExceptionNotifier::SquashNotifier::SquashRailsNotifier do
+  include_context "squash_ruby"
+
+  around(:context) do |eg|
+    saved = ExceptionNotifier::SquashNotifier.enable_rails
+    ExceptionNotifier::SquashNotifier.enable_rails = true
+
+    eg.run
+
+    ExceptionNotifier::SquashNotifier.enable_rails = saved
+  end
+
+  describe "with a valid instance" do
+    include_context "squash_notifier_creation"
+
+    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')
+
+      xit "notifies Squash of an standard exception when no rack-env data supplied" do
+        pending("Providing rack-complete data to the :env option")
+
+        begin
+          1/0
+        rescue => e
+          expect(squash_ruby).to receive(:notify).with(e, {}).and_return(nil)
+          ExceptionNotifier.notify_exception(e, {})
+        end
+      end
+
+      xit "notifies Squash of an Rails exception when rack-env data supplied" do
+        pending("Providing rack-complete data to the :env option")
+
+        begin
+          1/0
+        rescue => e
+          expect(squash_ruby).to receive(:configuration).with(:filter_env_vars).and_return(squash_notifier.default_options[:filter_env_vars])
+          #expect(squash_ruby).to receive(:notify).with(e, {env: "TEST"}).and_return(nil)
+
+          ExceptionNotifier.notify_exception(e, {env: {a: "TEST"}})
+        end
+      end
+    end
+  end
+end

data/spec/exception_notifier/squash_ruby_rails_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper_rails'
+
+describe Squash::Ruby do
+  it do
+    #NB: It may never be possible to make this pass, with Squash::Ruby
+    #    monkey-patching style
+    expect(Squash::Ruby.client_name).to eq('squash-notifier-rails')
+  end
+end

data/spec/exception_notifier/squash_ruby_spec.rb

@@ -2,7 +2,10 @@ require 'spec_helper'
 
 describe Squash::Ruby do
   it do
-    expect(Squash::Ruby.client_name).to eq('squash')
+    pending("monkey-patching makes me sad")
+    #NB: It may never be possible to make this pass, with Squash::Ruby
+    #    monkey-patching style
+    expect(Squash::Ruby.client_name).to eq('squash-notifier')
   end
 
   describe "with a valid instance" do

data/spec/spec_helper.rb

@@ -11,3 +11,10 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'exception_notification'
 require 'exception_notifier/squash_notifier'
+
+RSpec.shared_context "squash_ruby" do
+  let(:squash_ruby) do
+    class_double("Squash::Ruby").
+      as_stubbed_const(:transfer_nested_constants => true)
+  end
+end

data/spec/spec_helper_rails.rb

@@ -0,0 +1,9 @@
+require 'rails'
+require 'spec_helper'
+
+RSpec.shared_context "rails" do
+  let(:rails) do
+    class_double("Rails").
+      as_stubbed_const(:transfer_nested_constants => true)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exception_notification-squash_notifier
 version: !ruby/object:Gem::Version
-  version: 0.1.1.3
+  version: 0.1.2
 platform: ruby
 authors:
 - Will Robertson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-29 00:00:00.000000000 Z
+date: 2015-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,11 +158,14 @@ files:
 - 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
+- lib/exception_notifier/squash_ruby/ruby.rb
+- spec/exception_notifier/squash_notifier_rails_spec.rb
 - spec/exception_notifier/squash_notifier_spec.rb
+- spec/exception_notifier/squash_ruby_rails_spec.rb
 - spec/exception_notifier/squash_ruby_spec.rb
 - spec/spec_helper.rb
+- spec/spec_helper_rails.rb
 homepage: ''
 licenses:
 - MIT
@@ -188,7 +191,10 @@ signing_key:
 specification_version: 4
 summary: Exception Notifier plugin for Squash
 test_files:
+- spec/exception_notifier/squash_notifier_rails_spec.rb
 - spec/exception_notifier/squash_notifier_spec.rb
+- spec/exception_notifier/squash_ruby_rails_spec.rb
 - spec/exception_notifier/squash_ruby_spec.rb
 - spec/spec_helper.rb
+- spec/spec_helper_rails.rb
 has_rdoc: