trackets 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ab51f862a68579d25a95431d01837188a576643
-  data.tar.gz: 9ab4073d18a851ce750e1f515cf1a373dc1c792c
+  metadata.gz: e2dbf014142cf8754519141f942b30fcf611208b
+  data.tar.gz: 4d980a1f00648ab4202f6ab395529740d0c2289b
 SHA512:
-  metadata.gz: 1f3934d1d485647b2820b5145b320b0458be583ffbdc0c79069333a4432a9807c23b4846843fb2c1b5a6193e64fe2334daf86988e3bd6e2995bff5db62b804ea
-  data.tar.gz: 65d9ba622500cf4f0ed079ecf70bcafd4bec459d8c2ce916686a9f302f466d17156355a4e5afe5a88fcb3ce23bc8294fa6f69664a279ec06046a0504903ff4a5
+  metadata.gz: 33d10a87d3596d5478d29bb00a9265a109eb17297bc00ee799cd27143529b33fbd950591541dea43acdde4f486ad13e2fc961aa35e304bb63e12e4bf4e62fdf8
+  data.tar.gz: 1515bbe0dcee9a762154e948249aa21ed7dba4d3f7c2547c799e2405449349357286318e51e95b0ff9b5937d08a9ee1000567cbd44c0846aa893c930f253d545

data/README.md

@@ -16,6 +16,14 @@ And then execute:
 
     $ rails g trackets:install API_KEY
 
+## Rails
+
+To include JavaScript tracking code in your app just add this line to your `app/views/layout/application.html.erb`
+
+```erb
+<%= trackets_include_tag %>
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/trackets/fork )

data/lib/tasks/trackets.tasks

@@ -0,0 +1,15 @@
+namespace :trackets do
+
+  desc "Test Trackets integration"
+  task :test => :environment do
+    puts "Raising exception to test Trackets integration"
+
+    Trackets.send_custom_exception('Testing Trackets Gem integration via "rake trackets:test"')
+  end
+
+  desc "Send custom message defined in a MESSAGE environment variable"
+  task :notify => :environment do
+    Trackets.send_custom_exception(ENV['MESSAGE'])
+  end
+
+end

data/lib/trackets/client.rb

@@ -1,6 +1,8 @@
 require "httparty"
 require "trackets/backtrace"
 require "trackets/params"
+require "trackets/null_env"
+require "trackets/rack_env_sanitizer"
 
 module Trackets
   class Client
@@ -27,27 +29,11 @@ module Trackets
     end
 
     def params
-      @params ||= Params.new(env)
+      @params ||= env ? Params.new(env) : NullEnv.new
     end
 
-    def whitelisted_env
-      env.reject { |k,v| !Trackets.configuration.whitelisted_env.include?(k) }
-    end
-
-    def filtered_env
-      whitelisted_env.inject({}) do |result, (key, val)|
-        result[key] = filter_env_val(val) if key && val =~ /\S/
-        result
-      end
-    end
-
-    def filter_env_val(value)
-      value.scan(/(?:^|&|\?)([^=?&]+)=([^&]+)/).each do |match|
-        next unless params.blacklisted?(match[0])
-        value.gsub!(/#{match[1]}/, '[FILTERED]')
-      end
-
-      value
+    def rack_env_sanitizer
+      @rack_env_sanitizer ||= env ? RackEnvSanitizer.new(env) : NullEnv.new
     end
 
     def payload
@@ -56,7 +42,7 @@ module Trackets
         message:          exception.message,
         class_name:       exception.class.to_s,
         stacktrace:       backtrace.parse.join("\n"),
-        env:              filtered_env,
+        env:              rack_env_sanitizer.filtered,
         environment_name: config.environment_name,
         project_root:     config.project_root,
         framework:        config.framework,

data/lib/trackets/configuration.rb

@@ -35,5 +35,17 @@ module Trackets
       @blacklisted_params = DEFAULT_BLACKLISTED_PARAMS
     end
 
+    def rack_filter_keys(rack_env = nil)
+      @rack_filter_keys ||= rack_env ? Array(rack_env["action_dispatch.parameter_filter"]) : []
+    end
+
+    def blacklisted_keys(rack_env = nil)
+      @blacklisted_keys ||= (blacklisted_params + rack_filter_keys).map(&:to_s)
+    end
+
+    def blacklisted_key?(key, rack_env = nil)
+      blacklisted_keys.include?(key)
+    end
+
   end
 end

data/lib/trackets/null_env.rb

@@ -0,0 +1,9 @@
+module Trackets
+  class NullEnv
+
+    def filtered
+      nil
+    end
+
+  end
+end

data/lib/trackets/params.rb

@@ -7,10 +7,6 @@ module Trackets
       @rack_env = rack_env
     end
 
-    def rack_filter_keys
-      @rack_filter_keys ||= Array(rack_env["action_dispatch.parameter_filter"])
-    end
-
     def request
       @request ||= Rack::Request.new(rack_env)
     end
@@ -19,20 +15,12 @@ module Trackets
       @hash ||= request.params
     end
 
-    def blacklisted_keys
-      @blacklisted_keys ||= (Trackets.configuration.blacklisted_params + rack_filter_keys).map(&:to_s)
-    end
-
-    def blacklisted?(key)
-      blacklisted_keys.include?(key)
-    end
-
     def filtered
       hash.inject({}) do |ret, (key, value)|
         ret[key] = if value.kind_of?(Hash)
           self.class.new(value).filtered
         else
-          blacklisted?(key) ? "[FILTERED]" : value
+          Trackets.configuration.blacklisted_key?(key, rack_env) ? "[FILTERED]" : value
         end
 
         ret

data/lib/trackets/rack_env_sanitizer.rb

@@ -0,0 +1,32 @@
+module Trackets
+  class RackEnvSanitizer
+
+    attr_reader :rack_env
+
+    def initialize(rack_env)
+      @rack_env = rack_env
+    end
+
+    def filtered
+      whitelisted_env.inject({}) do |result, (key, val)|
+        result[key] = filter_val(val) if key && val =~ /\S/
+        result
+      end
+    end
+
+    private
+    def whitelisted_env
+      rack_env.reject { |k,v| !Trackets.configuration.whitelisted_env.include?(k) }
+    end
+
+    def filter_val(value)
+      value.scan(/(?:^|&|\?)([^=?&]+)=([^&]+)/).each do |match|
+        next unless Trackets.configuration.blacklisted_key?(match[0], rack_env)
+        value.gsub!(/#{match[1]}/, '[FILTERED]')
+      end
+
+      value
+    end
+
+  end
+end

data/lib/trackets/railtie.rb

@@ -22,5 +22,9 @@ module Trackets
       end
     end
 
+    rake_tasks do
+      load "tasks/trackets.tasks"
+    end
+
   end
 end

data/lib/trackets/version.rb

@@ -1,3 +1,3 @@
 module Trackets
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/trackets/view_helpers.rb

@@ -1,7 +1,7 @@
 module Trackets
   module ViewHelpers
     def trackets_include_tag
-      javascript_include_tag "//trackets.s3.amazonaws.com/client.js"
+      javascript_include_tag "//trackets.s3.amazonaws.com/client.js", data: { "trackets-key" => Trackets.configuration.api_key }
     end
   end
 end

data/lib/trackets.rb

@@ -14,9 +14,19 @@ module Trackets
       @configuration ||= Configuration.new
     end
 
-    def notify(exception, env)
+    def notify(exception, env = nil)
       Client.notify(exception, env)
     end
 
+    class TracketsCustomException < StandardError; end
+
+    def send_custom_exception(message = nil)
+      begin
+        raise TracketsCustomException, message
+      rescue TracketsCustomException => e
+        Trackets.notify(e)
+      end
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trackets
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jan Votava
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2014-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -142,12 +142,16 @@ files:
 - features/support/templates/trackets_interceptor.rb
 - lib/generators/trackets/install_generator.rb
 - lib/generators/trackets/templates/initializer.rb
+- lib/tasks/.keep
+- lib/tasks/trackets.tasks
 - lib/trackets.rb
 - lib/trackets/backtrace.rb
 - lib/trackets/client.rb
 - lib/trackets/configuration.rb
 - lib/trackets/middleware/rack_exception_handler.rb
+- lib/trackets/null_env.rb
 - lib/trackets/params.rb
+- lib/trackets/rack_env_sanitizer.rb
 - lib/trackets/railtie.rb
 - lib/trackets/version.rb
 - lib/trackets/view_helpers.rb