smoke_detector 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: beac5b3fa1290a4d289c18f6b21e642b8588cf77
-  data.tar.gz: 34be662f60eadf8723c41c844056b236ca18ae42
+  metadata.gz: 9539101ddc9c4b9edb48332bb8aa1e1261cf44fb
+  data.tar.gz: 6369af09d39456576eda2a3f3a27e41698b45e6a
 SHA512:
-  metadata.gz: 2f3ae8cfb7e1d9187069f5e5678cb4ce8d8a728453da5668a8e4f23c920f8e2c4d6ec9d21452c10c1afa0b236bb10d4837fd173008850faa22f2677743b4c56f
-  data.tar.gz: 7bfbffbf840d2fb3b7a2dae2215fec7a0f8f8eab41426d70e9961097660e3c265673feb3dbd53e89ecece34dbac68ca6a5448193a66aef83f78f543c46ec7efc
+  metadata.gz: c6bb76bf4122dc930759b1d4b80c3089c5880d388bd5c03e5d22d18ff0a55e8d6deb3d4b385ec793e99cfa269ce2fbce68a2d228a81c7ef57d198c4e5639960c
+  data.tar.gz: 90cde341fae602a40906b703a83bdadc76418f3141898b9c01d345bf81dc10f330292367fab85eeaaca5384db96bd633d2c87f32e276135bfc4222b520ce30d7

data/README.md

@@ -13,7 +13,6 @@ Add the following to your `Gemfile`:
 ```
 gem 'smoke_detector'
 ```
-This assumes you're using Lumos Labs' gemfury account.
 
 Then add the provider's gem to your gemfile. Smoke Detector currently supports Rollbar and Airbrake. For example,
 ```
@@ -67,8 +66,10 @@ by Rollbar.js unless you do some additional filtering.
 
 The following config demonstrates how to filter JavaScript exceptions by
 the exception's message, and also, by the offending exception's source host url.
-You can choose to filter by `host_whitelist` or `ignored_messages` or both. It's
-up to you.
+You can choose to filter by `hostWhitelist` or `ignoredMessages` or both. It's
+up to you. Note the lower, camel-case of the setting keys. They should match
+[rollbar.js's](https://github.com/rollbar/rollbar.js) documentation in order to
+be passed-along to the rollbar.js framework appropriately.
 
 ```
 config.providers = [
@@ -77,13 +78,23 @@ config.providers = [
     api_key: ENV['ROLLBAR_KEY'],
     client_settings: {
       api_key: ENV['ROLLBAR_CLIENT_KEY'],
-      ignored_messages: ["Error: Clippy.bmp not found. The end is nigh."],
-      host_whitelist: ["yourdomain.com", "cdn.anotherdomain.com"]
+      ignoredMessages: ["Error: Clippy.bmp not found. The end is nigh."],
+      hostWhitelist: ["yourdomain.com", "cdn.anotherdomain.com"]
     }
   }
 ]
 ```
 
+All key-value pairs under `client_settings` will be passed along to the javascript
+client tracking library (in this case, Rollbar).
+
+### Rollbar.js Person data
+
+By default, there is no person data sent to rollbar. In order to do that, you will have to override the rollbar person data config:
+
+```javascript
+window._rollbarConfig.payload.person = { id: 1, email: 'someemail@example.com', username: 'someuser' }
+```
 
 TODO
 ----

data/lib/smoke_detector/providers/provider.rb

@@ -2,6 +2,7 @@ module SmokeDetector::Providers
 
   class Provider
     attr_accessor :controller_proc
+    attr_reader :client_settings
 
     def initialize(api_key, client_settings = {}, settings = {})
       @client_settings = client_settings || {}
@@ -20,6 +21,10 @@ module SmokeDetector::Providers
       ''
     end
 
+    def default_client_settings
+      {}
+    end
+
     private
 
     def client_api_key

data/lib/smoke_detector/providers/rollbar.rb

@@ -1,9 +1,7 @@
+require 'json'
 module SmokeDetector::Providers
 
   class Rollbar < Provider
-
-    attr_accessor :client_host_whitelist, :client_ignore_partial_messages
-
     def initialize(api_key, client_settings = {}, settings = {})
       super
       ::Rollbar.configure do |c|
@@ -19,8 +17,9 @@ module SmokeDetector::Providers
         c.filepath ||= ::Rails.application.class.parent_name + '.rollbar'
       end
 
-      @client_host_whitelist  = @client_settings[:host_whitelist] || []
-      @client_ignored_messages = @client_settings[:ignored_messages] || []
+      @client_settings = default_client_settings
+      migrate_old_client_setting_syntax(client_settings)
+      @client_settings.deep_merge!(client_settings) if client_settings.present?
     end
 
     def alert(exception, options = {})
@@ -36,20 +35,19 @@ module SmokeDetector::Providers
       ::Rollbar.report_message(message, level, options)
     end
 
+    def default_client_settings
+      { captureUncaught: true, payload: { environment: ::Rails.env } }
+    end
+
     def client_monitoring_code
-      return '' if client_api_key.blank?
+      return '' if client_settings[:api_key].blank?
+      client_settings[:accessToken] = client_settings.delete(:api_key)
       @client_monitoring_code ||= <<-JS
         <script>
-          var _rollbarConfig = {
-              accessToken: "#{@client_api_key}",
-              captureUncaught: true,
-              payload: {
-                  environment: "#{::Rails.env}"
-              },
-              hostWhiteList: #{@client_host_whitelist.to_s},
-              ignoredMessages: #{@client_ignored_messages.to_s}
-          };
-          !function(a,b){function c(b){this.shimId=++h,this.notifier=null,this.parentShim=b,this.logger=function(){},a.console&&void 0===a.console.shimId&&(this.logger=a.console.log)}function d(b,c,d){!d[4]&&a._rollbarWrappedError&&(d[4]=a._rollbarWrappedError,a._rollbarWrappedError=null),b.uncaughtError.apply(b,d),c&&c.apply(a,d)}function e(b){var d=c;return g(function(){if(this.notifier)return this.notifier[b].apply(this.notifier,arguments);var c=this,e="scope"===b;e&&(c=new d(this));var f=Array.prototype.slice.call(arguments,0),g={shim:c,method:b,args:f,ts:new Date};return a._rollbarShimQueue.push(g),e?c:void 0})}function f(a,b){if(b.hasOwnProperty&&b.hasOwnProperty("addEventListener")){var c=b.addEventListener;b.addEventListener=function(b,d,e){c.call(this,b,a.wrap(d),e)};var d=b.removeEventListener;b.removeEventListener=function(a,b,c){d.call(this,a,b&&b._wrapped?b._wrapped:b,c)}}}function g(a,b){return b=b||this.logger,function(){try{return a.apply(this,arguments)}catch(c){b("Rollbar internal error:",c)}}}var h=0;c.init=function(a,b){var e=b.globalAlias||"Rollbar";if("object"==typeof a[e])return a[e];a._rollbarShimQueue=[],a._rollbarWrappedError=null,b=b||{};var h=new c;return g(function(){if(h.configure(b),b.captureUncaught){var c=a.onerror;a.onerror=function(){var a=Array.prototype.slice.call(arguments,0);d(h,c,a)};var g,i,j=["EventTarget","Window","Node","ApplicationCache","AudioTrackList","ChannelMergerNode","CryptoOperation","EventSource","FileReader","HTMLUnknownElement","IDBDatabase","IDBRequest","IDBTransaction","KeyOperation","MediaController","MessagePort","ModalWindow","Notification","SVGElementInstance","Screen","TextTrack","TextTrackCue","TextTrackList","WebSocket","WebSocketWorker","Worker","XMLHttpRequest","XMLHttpRequestEventTarget","XMLHttpRequestUpload"];for(g=0;g<j.length;++g)i=j[g],a[i]&&a[i].prototype&&f(h,a[i].prototype)}return a[e]=h,h},h.logger)()},c.prototype.loadFull=function(a,b,c,d){var e=g(function(){var a=b.createElement("script"),e=b.getElementsByTagName("script")[0];a.src=d.rollbarJsUrl,a.async=!c,a.onload=f,e.parentNode.insertBefore(a,e)},this.logger),f=g(function(){if(void 0===a._rollbarPayloadQueue)for(var b,c,d,e,f=new Error("rollbar.js did not load");b=a._rollbarShimQueue.shift();)for(d=b.args,e=0;e<d.length;++e)if(c=d[e],"function"==typeof c){c(f);break}},this.logger);g(function(){c?e():a.addEventListener?a.addEventListener("load",e,!1):a.attachEvent("onload",e)},this.logger)()},c.prototype.wrap=function(b){try{if("function"!=typeof b)return b;if(b._isWrap)return b;if(!b._wrapped){b._wrapped=function(){try{return b.apply(this,arguments)}catch(c){throw a._rollbarWrappedError=c,c}},b._wrapped._isWrap=!0;for(var c in b)b.hasOwnProperty(c)&&(b._wrapped[c]=b[c])}return b._wrapped}catch(d){return b}};for(var i="log,debug,info,warn,warning,error,critical,global,configure,scope,uncaughtError".split(","),j=0;j<i.length;++j)c.prototype[i[j]]=e(i[j]);var k="//d37gvrvc0wt4s1.cloudfront.net/js/v1.1/rollbar.min.js";_rollbarConfig.rollbarJsUrl=_rollbarConfig.rollbarJsUrl||k;var l=c.init(a,_rollbarConfig);l.loadFull(a,b,!1,_rollbarConfig)}(window,document);
+          var _rollbarConfig = #{client_settings.to_json};
+        </script>
+        <script>
+        !function(a,b){function c(b){this.shimId=++h,this.notifier=null,this.parentShim=b,this.logger=function(){},a.console&&void 0===a.console.shimId&&(this.logger=a.console.log)}function d(b,c,d){a._rollbarWrappedError&&(d[4]||(d[4]=a._rollbarWrappedError),d[5]||(d[5]=a._rollbarWrappedError._rollbarContext),a._rollbarWrappedError=null),b.uncaughtError.apply(b,d),c&&c.apply(a,d)}function e(b){var d=c;return g(function(){if(this.notifier)return this.notifier[b].apply(this.notifier,arguments);var c=this,e="scope"===b;e&&(c=new d(this));var f=Array.prototype.slice.call(arguments,0),g={shim:c,method:b,args:f,ts:new Date};return a._rollbarShimQueue.push(g),e?c:void 0})}function f(a,b){if(b.hasOwnProperty&&b.hasOwnProperty("addEventListener")){var c=b.addEventListener;b.addEventListener=function(b,d,e){c.call(this,b,a.wrap(d),e)};var d=b.removeEventListener;b.removeEventListener=function(a,b,c){d.call(this,a,b&&b._wrapped?b._wrapped:b,c)}}}function g(a,b){return b=b||this.logger,function(){try{return a.apply(this,arguments)}catch(c){b("Rollbar internal error:",c)}}}var h=0;c.init=function(a,b){var e=b.globalAlias||"Rollbar";if("object"==typeof a[e])return a[e];a._rollbarShimQueue=[],a._rollbarWrappedError=null,b=b||{};var h=new c;return g(function(){if(h.configure(b),b.captureUncaught){var c=a.onerror;a.onerror=function(){var a=Array.prototype.slice.call(arguments,0);d(h,c,a)};var g,i,j="EventTarget,Window,Node,ApplicationCache,AudioTrackList,ChannelMergerNode,CryptoOperation,EventSource,FileReader,HTMLUnknownElement,IDBDatabase,IDBRequest,IDBTransaction,KeyOperation,MediaController,MessagePort,ModalWindow,Notification,SVGElementInstance,Screen,TextTrack,TextTrackCue,TextTrackList,WebSocket,WebSocketWorker,Worker,XMLHttpRequest,XMLHttpRequestEventTarget,XMLHttpRequestUpload".split(",");for(g=0;g<j.length;++g)i=j[g],a[i]&&a[i].prototype&&f(h,a[i].prototype)}return a[e]=h,h},h.logger)()},c.prototype.loadFull=function(a,b,c,d,e){var f=g(function(){var a=b.createElement("script"),e=b.getElementsByTagName("script")[0];a.src=d.rollbarJsUrl,a.async=!c,a.onload=h,e.parentNode.insertBefore(a,e)},this.logger),h=g(function(){var b;if(void 0===a._rollbarPayloadQueue){var c,d,f,g;for(b=new Error("rollbar.js did not load");c=a._rollbarShimQueue.shift();)for(f=c.args,g=0;g<f.length;++g)if(d=f[g],"function"==typeof d){d(b);break}}"function"==typeof e&&e(b)},this.logger);g(function(){c?f():a.addEventListener?a.addEventListener("load",f,!1):a.attachEvent("onload",f)},this.logger)()},c.prototype.wrap=function(b,c){try{var d;if(d="function"==typeof c?c:function(){return c||{}},"function"!=typeof b)return b;if(b._isWrap)return b;if(!b._wrapped){b._wrapped=function(){try{return b.apply(this,arguments)}catch(c){throw c._rollbarContext=d(),c._rollbarContext._wrappedSource=b.toString(),a._rollbarWrappedError=c,c}},b._wrapped._isWrap=!0;for(var e in b)b.hasOwnProperty(e)&&(b._wrapped[e]=b[e])}return b._wrapped}catch(f){return b}};for(var i="log,debug,info,warn,warning,error,critical,global,configure,scope,uncaughtError".split(","),j=0;j<i.length;++j)c.prototype[i[j]]=e(i[j]);var k="//d37gvrvc0wt4s1.cloudfront.net/js/v1.1/rollbar.min.js";_rollbarConfig.rollbarJsUrl=_rollbarConfig.rollbarJsUrl||k;var l=c.init(a,_rollbarConfig);l.loadFull(a,b,!1,_rollbarConfig)}(window,document);
         </script>
       JS
     end
@@ -65,5 +63,16 @@ module SmokeDetector::Providers
         ::Rollbar.report_exception(exception, rollbar_request_data, rollbar_person_data)
       end
     end
+
+    private
+    def migrate_old_client_setting_syntax(settings)
+      return unless settings.present?
+      whitelist    = settings.delete(:host_whitelist)
+      ignored_msgs = settings.delete(:ignored_messages)
+
+      settings[:hostWhiteList]   = whitelist if whitelist
+      settings[:ignoredMessages] = ignored_msgs if ignored_msgs
+      settings
+    end
   end
 end

data/lib/smoke_detector/version.rb

@@ -1,3 +1,3 @@
 module SmokeDetector
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end