trackets 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57945f5d2b533f59570edf167b351a93f0865ade
-  data.tar.gz: 6b9cb0d7cb672064e578814112303c20337a9954
+  metadata.gz: 0ab51f862a68579d25a95431d01837188a576643
+  data.tar.gz: 9ab4073d18a851ce750e1f515cf1a373dc1c792c
 SHA512:
-  metadata.gz: 7452d325e39df95ffa2f4d449fa095cdca8ffea0cad84bdd222253b9b8b312703d69b80e2ee746fba814fa7eff39149c533a4b1bfe020b9bfca00a62ff507c71
-  data.tar.gz: 3ccb2799e4bab794ece8d7b060bfa220887b5af9fb74bc14cff7d83e1e42ac2fc092c982e3d9e2ad93959065ab0151825793e3f9d3750e875abb55323884410d
+  metadata.gz: 1f3934d1d485647b2820b5145b320b0458be583ffbdc0c79069333a4432a9807c23b4846843fb2c1b5a6193e64fe2334daf86988e3bd6e2995bff5db62b804ea
+  data.tar.gz: 65d9ba622500cf4f0ed079ecf70bcafd4bec459d8c2ce916686a9f302f466d17156355a4e5afe5a88fcb3ce23bc8294fa6f69664a279ec06046a0504903ff4a5

data/features/rails.feature

@@ -0,0 +1,27 @@
+Feature: Gem works in Rails application
+
+  Background:
+    Given I'm in a new Rails application named "trackets_test"
+
+  Scenario: Rescue an exception in a controller
+    When I configure an app to use Trackets
+    And I define action "test#index" to
+      """
+      raise "This is testing error"
+      """
+    And I define route "/test" to "test#index"
+    And I request "http://foo.bar:31337/test"
+    Then I should receive notification to Trackets server
+
+  Scenario: Send filtered params to Trackets when there's exception in Rails
+    When I configure an app to use Trackets
+    And I define action "test#index" to
+      """
+      raise "This is testing error"
+      """
+    And I define route "/test" to "test#index"
+    And I request "http://foo.bar:31337/test?cvv=7739&name=John"
+    Then I should receive notification to Trackets server
+    And last notice params for key "name" is "John"
+    And last notice params for key "cvv" is "[FILTERED]"
+    And last notice params should not contain "7739"

data/features/step_definitions/rails_steps.rb

@@ -0,0 +1,62 @@
+require 'active_support/core_ext/string/inflections'
+
+Given(/^I'm in a new Rails application named "(.*?)"$/) do |app_name|
+  step "I successfully run `rails new #{app_name} --skip-gemfile -O -T`"
+  step %{I cd to "#{app_name}"}
+  @app_name = app_name
+end
+
+When(/^I configure an app to use Trackets$/) do
+  step %{I copy "trackets_interceptor.rb" to apps "config/initializers"}
+  step "I successfully run `rails g trackets:install my-api-key`"
+
+  additions =<<-EOS
+    config.api_url = "http://trackets.com"
+  EOS
+
+  replace_in_file(File.join(@dirs, "config", "initializers", "trackets.rb"), /^end$/, "#{additions}\nend")
+end
+
+When(/^I copy "(.*?)" to apps "(.*?)"$/) do |template_name, target_path|
+  template = File.join(TEMPLATES_DIR, template_name)
+  target = File.join(@dirs, target_path)
+
+  FileUtils.cp(template, target)
+end
+
+When(/^I define action "(.*?)" to$/) do |controller_and_action, code|
+  define_controller_action_to(controller_and_action, code)
+end
+
+When(/^I define route "(.*?)" to "(.*?)"$/) do |route, target|
+  route_definition = %{get "#{route}", to: "#{target}"}
+  replace_in_file(File.join(@dirs, "config", "routes.rb"), /^end$/, "#{route_definition}\nend")
+end
+
+When(/^I request "(.*?)"$/) do |url|
+  script =<<-EOS
+  require File.expand_path('../config/environment', __FILE__)
+
+  env = Rack::MockRequest.env_for(#{url.inspect})
+  p #{@app_name.classify}::Application.call(env)
+  EOS
+
+  File.open(File.join(@dirs, "script.rb"), "w") { |f| f.write(script) }
+  step "I run `rails r script.rb`"
+end
+
+Then(/^I should receive notification to Trackets server$/) do
+  expect(requests.size).to be > 0
+end
+
+Then(/^last notice params should (?:(not ))?contain "(.*?)"$/) do |negator, string|
+  if negator
+    last_notice_serialized_data.should_not match string
+  else
+    last_notice_serialized_data.should match string
+  end
+end
+
+Then(/^last notice params for key "(.*?)" is "(.*?)"$/) do |key, val|
+  last_notice_params_for(key).should eq val
+end

data/features/support/common.rb

@@ -0,0 +1,11 @@
+module CommonHelpers
+  def replace_in_file(path, from, to)
+    File.open(path, "r+") do |f|
+      newstr = f.read.sub(from, to)
+      f.rewind
+      f.write(newstr)
+    end
+  end
+end
+
+World(CommonHelpers)

data/features/support/env.rb

@@ -0,0 +1,9 @@
+require 'aruba/cucumber'
+
+ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..')).freeze
+TEMPLATES_DIR = File.join(ROOT, 'features', 'support', 'templates')
+
+Before do
+  @dirs = ["tmp", "aruba"]
+  @aruba_timeout_seconds = 5
+end

data/features/support/rails.rb

@@ -0,0 +1,43 @@
+module RailsHelpers
+
+  def requests
+    path = File.join(@dirs, "request_log.txt")
+
+    if File.exist?(path)
+      File.foreach(path).map { |l| JSON.parse(l) }
+    else
+      []
+    end
+  end
+
+  def last_notice
+    requests.last
+  end
+
+  def last_notice_serialized_data
+    last_notice["rack.input"].first
+  end
+
+  def last_notice_form_data
+    CGI::parse(last_notice_serialized_data)
+  end
+
+  def last_notice_params_for(key)
+    last_notice_form_data["error[params][#{key}]"].first
+  end
+
+  def define_controller_action_to(controller_and_action, code)
+    controller, action = controller_and_action.split("#")
+
+    File.open(File.join(@dirs, "app", "controllers", "#{controller}_controller.rb"), "w") do |f|
+      f.puts "class #{controller.classify}Controller < ApplicationController"
+      f.puts "  def #{action}"
+      f.puts code
+      f.puts "  end"
+      f.puts "end"
+    end
+  end
+
+end
+
+World(RailsHelpers)

data/features/support/templates/trackets_interceptor.rb

@@ -0,0 +1,9 @@
+require 'sham_rack'
+
+ShamRack.at("trackets.com") do |env|
+  File.open(Rails.root.join("request_log.txt"), "w") { |f| f.puts(env.to_json) }
+
+  ["200 OK", { "Content-type" => "text/json" }, [{
+      hello: "something"
+    }]]
+end

data/lib/trackets/client.rb

@@ -1,5 +1,6 @@
 require "httparty"
 require "trackets/backtrace"
+require "trackets/params"
 
 module Trackets
   class Client
@@ -25,20 +26,41 @@ module Trackets
       @backtrace ||= Backtrace.new(exception.backtrace)
     end
 
+    def params
+      @params ||= Params.new(env)
+    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
+    end
+
     def payload
       {
         language:         "ruby",
         message:          exception.message,
         class_name:       exception.class.to_s,
         stacktrace:       backtrace.parse.join("\n"),
-        env:              whitelisted_env,
+        env:              filtered_env,
         environment_name: config.environment_name,
         project_root:     config.project_root,
-        framework:        config.framework
+        framework:        config.framework,
+        params:           params.filtered
       }
     end
 

data/lib/trackets/configuration.rb

@@ -23,14 +23,16 @@ module Trackets
       "REMOTE_PORT",
       "ORIGINAL_FULLPATH"
     ].freeze
+    DEFAULT_BLACKLISTED_PARAMS = ["password", "password_confirmation", "card_number", "cvv"].freeze
 
-    DEFAULT_API_URL = "https://trackets.dev"
+    DEFAULT_API_URL = "https://trackets.com"
 
-    attr_accessor :api_url, :api_key, :environment_name, :project_root, :framework, :whitelisted_env
+    attr_accessor :api_url, :api_key, :environment_name, :project_root, :framework, :whitelisted_env, :blacklisted_params
 
     def initialize
       @api_url = DEFAULT_API_URL
       @whitelisted_env = DEFAULT_WHITELISTED_ENV_KEYS
+      @blacklisted_params = DEFAULT_BLACKLISTED_PARAMS
     end
 
   end

data/lib/trackets/params.rb

@@ -0,0 +1,43 @@
+module Trackets
+  class Params
+
+    attr_reader :rack_env
+
+    def initialize(rack_env)
+      @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
+
+    def hash
+      @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
+        end
+
+        ret
+      end
+    end
+
+  end
+end

data/lib/trackets/version.rb

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

data/trackets.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["votava@deployment.cz"]
   spec.summary       = %q{Trackets.com Ruby support GEM}
   spec.description   = %q{Helpers for Trackets.com error tracking service}
-  spec.homepage      = ""
+  spec.homepage      = "http://www.trackets.com"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -23,5 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "rack"
 
   spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "cucumber-rails", "~> 1.4.1"
+  spec.add_development_dependency "aruba", "~> 0.5.4"
+  spec.add_development_dependency "sham_rack"
   spec.add_development_dependency "rake"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trackets
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jan Votava
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -66,6 +66,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: cucumber-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+- !ruby/object:Gem::Dependency
+  name: sham_rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +134,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- features/rails.feature
+- features/step_definitions/rails_steps.rb
+- features/support/common.rb
+- features/support/env.rb
+- features/support/rails.rb
+- features/support/templates/trackets_interceptor.rb
 - lib/generators/trackets/install_generator.rb
 - lib/generators/trackets/templates/initializer.rb
 - lib/trackets.rb
@@ -99,11 +147,12 @@ files:
 - lib/trackets/client.rb
 - lib/trackets/configuration.rb
 - lib/trackets/middleware/rack_exception_handler.rb
+- lib/trackets/params.rb
 - lib/trackets/railtie.rb
 - lib/trackets/version.rb
 - lib/trackets/view_helpers.rb
 - trackets.gemspec
-homepage: ''
+homepage: http://www.trackets.com
 licenses:
 - MIT
 metadata: {}
@@ -127,4 +176,10 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Trackets.com Ruby support GEM
-test_files: []
+test_files:
+- features/rails.feature
+- features/step_definitions/rails_steps.rb
+- features/support/common.rb
+- features/support/env.rb
+- features/support/rails.rb
+- features/support/templates/trackets_interceptor.rb