rollbar 0.8.0

data/lib/rollbar/sidekiq.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module Rollbar
+  class Sidekiq
+    def call(worker, msg, queue)
+      begin
+        yield
+      rescue => e
+        msg.delete('backtrace')
+        msg.delete('error_backtrace')
+        msg.delete('error_message')
+        msg.delete('error_class')
+
+        Rollbar.report_exception(e, :params => msg)
+        raise
+      end
+    end
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Rollbar::Sidekiq
+  end
+end

data/lib/rollbar/version.rb

@@ -0,0 +1,3 @@
+module Rollbar
+  VERSION = "0.8.0"
+end

data/rollbar.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rollbar/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brian Rue"]
+  gem.email         = ["brian@rollbar.com"]
+  gem.description   = %q{Rails plugin to catch and send exceptions to Rollbar}
+  gem.summary       = %q{Reports exceptions to Rollbar}
+  gem.homepage      = "https://github.com/rollbar/rollbar-gem"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.name          = "rollbar"
+  gem.require_paths = ["lib"]
+  gem.version       = Rollbar::VERSION
+
+  gem.add_runtime_dependency 'multi_json', '~> 1.6.0'
+
+  gem.add_development_dependency 'rails', '~> 3.2.12'
+  gem.add_development_dependency 'devise', '>= 2.1.2'
+  gem.add_development_dependency 'rspec-rails', '~> 2.12.0'
+  gem.add_development_dependency 'database_cleaner', '>= 0.9.1'
+  gem.add_development_dependency 'girl_friday', '>= 0.11.1'
+end

data/spec/controllers/home_controller_spec.rb

@@ -0,0 +1,180 @@
+require 'spec_helper'
+
+describe HomeController do
+  let(:logger_mock) { double("Rails.logger").as_null_object }
+
+  before(:each) do
+    reset_configuration
+    Rollbar.configure do |config|
+      config.access_token = 'aaaabbbbccccddddeeeeffff00001111'
+      config.environment = ::Rails.env
+      config.root = ::Rails.root
+      config.framework = "Rails: #{::Rails::VERSION::STRING}"
+      config.logger = logger_mock
+    end
+  end
+
+  context "rollbar controller methods" do
+    # TODO run these for a a more-real request
+    it "should build valid request data" do
+      data = @controller.rollbar_request_data
+      data.should have_key(:params)
+      data.should have_key(:url)
+      data.should have_key(:user_ip)
+      data.should have_key(:headers)
+      data.should have_key(:GET)
+      data.should have_key(:session)
+      data.should have_key(:method)
+    end
+
+    it "should build empty person data when no one is logged-in" do
+      data = @controller.rollbar_person_data
+      data.should == {}
+    end
+
+    context "rollbar_filter_params" do
+      it "should filter files" do
+        name = "John Doe"
+        file_hash = {
+          :filename => "test.txt",
+          :type => "text/plain",
+          :head => {},
+          :tempfile => "dummy"
+        }
+        file = ActionDispatch::Http::UploadedFile.new(file_hash)
+
+        params = {
+          :name => name,
+          :a_file => file
+        }
+
+        filtered = controller.send(:rollbar_filtered_params, Rollbar.configuration.scrub_fields, params)
+
+        filtered[:name].should == name
+        filtered[:a_file].should be_a_kind_of(Hash)
+        filtered[:a_file][:content_type].should == file_hash[:type]
+        filtered[:a_file][:original_filename].should == file_hash[:filename]
+        filtered[:a_file][:size].should == file_hash[:tempfile].size
+      end
+
+      it "should filter files in nested params" do
+        name = "John Doe"
+        file_hash = {
+          :filename => "test.txt",
+          :type => "text/plain",
+          :head => {},
+          :tempfile => "dummy"
+        }
+        file = ActionDispatch::Http::UploadedFile.new(file_hash)
+
+        params = {
+          :name => name,
+          :wrapper => {
+            :wrapper2 => {
+              :a_file => file,
+              :foo => "bar"
+            }
+          }
+        }
+
+        filtered = controller.send(:rollbar_filtered_params, Rollbar.configuration.scrub_fields, params)
+
+        filtered[:name].should == name
+        filtered[:wrapper][:wrapper2][:foo].should == "bar"
+
+        filtered_file = filtered[:wrapper][:wrapper2][:a_file]
+        filtered_file.should be_a_kind_of(Hash)
+        filtered_file[:content_type].should == file_hash[:type]
+        filtered_file[:original_filename].should == file_hash[:filename]
+        filtered_file[:size].should == file_hash[:tempfile].size
+      end
+
+      it "should scrub the default scrub_fields" do
+        params = {
+          :passwd => "hidden",
+          :password => "hidden",
+          :secret => "hidden",
+          :notpass => "visible"
+        }
+
+        filtered = controller.send(:rollbar_filtered_params, Rollbar.configuration.scrub_fields, params)
+
+        filtered[:passwd].should == "******"
+        filtered[:password].should == "******"
+        filtered[:secret].should == "******"
+        filtered[:notpass].should == "visible"
+      end
+
+      it "should scrub custom scrub_fields" do
+        Rollbar.configure do |config|
+          config.scrub_fields = [:notpass, :secret]
+        end
+
+        params = {
+          :passwd => "visible",
+          :password => "visible",
+          :secret => "hidden",
+          :notpass => "hidden"
+        }
+
+        filtered = controller.send(:rollbar_filtered_params, Rollbar.configuration.scrub_fields, params)
+
+        filtered[:passwd].should == "visible"
+        filtered[:password].should == "visible"
+        filtered[:secret].should == "******"
+        filtered[:notpass].should == "******"
+      end
+    end
+
+    context "rollbar_request_url" do
+      it "should build simple http urls" do
+        req = controller.request
+        req.host = 'rollbar.com'
+
+        controller.send(:rollbar_request_data)[:url].should == 'http://rollbar.com'
+      end
+    end
+
+    context "rollbar_user_ip" do
+      it "should use X-Real-Ip when set" do
+        controller.request.env["HTTP_X_REAL_IP"] = '1.1.1.1'
+        controller.request.env["HTTP_X_FORWARDED_FOR"] = '1.2.3.4'
+        controller.send(:rollbar_request_data)[:user_ip].should == '1.1.1.1'
+      end
+
+      it "should use X-Forwarded-For when set" do
+        controller.request.env["HTTP_X_FORWARDED_FOR"] = '1.2.3.4'
+        controller.send(:rollbar_request_data)[:user_ip].should == '1.2.3.4'
+      end
+
+      it "should use the remote_addr when neither is set" do
+        controller.send(:rollbar_request_data)[:user_ip].should == '0.0.0.0'
+      end
+    end
+
+  end
+
+  describe "GET 'index'" do
+    it "should be successful and report a message" do
+      logger_mock.should_receive(:info).with('[Rollbar] Success')
+      get 'index'
+      response.should be_success
+    end
+  end
+
+  describe "GET 'report_exception'" do
+    it "should raise a NameError and report an exception" do
+      logger_mock.should_receive(:info).with('[Rollbar] Success')
+
+      get 'report_exception'
+      response.should be_success
+    end
+  end
+
+  after(:each) do
+    Rollbar.configure do |config|
+      config.logger = ::Rails.logger
+    end
+  end
+
+end

data/spec/dummyapp/.gitignore

@@ -0,0 +1,73 @@
+#----------------------------------------------------------------------------
+# Ignore these files when commiting to a git repository.
+#
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# The original version of this file is found here:
+# https://github.com/RailsApps/rails-composer/blob/master/files/gitignore.txt
+#
+# Corrections? Improvements? Create a GitHub issue: 
+# http://github.com/RailsApps/rails-composer/issues
+#----------------------------------------------------------------------------
+
+# bundler state
+/.bundle
+/vendor/bundle/
+/vendor/ruby/
+
+# minimal Rails specific artifacts
+db/*.sqlite3
+/log/*
+/tmp/*
+
+# various artifacts
+**.war
+*.rbc
+*.sassc
+.rspec
+.redcar/
+.sass-cache
+/config/config.yml
+/coverage.data
+/coverage/
+/db/*.javadb/
+/db/*.sqlite3
+/doc/api/
+/doc/app/
+/doc/features.html
+/doc/specs.html
+/public/cache
+/public/stylesheets/compiled
+/public/system/*
+/spec/tmp/*
+/cache
+/capybara*
+/capybara-*.html
+/gems
+/specifications
+rerun.txt
+pickle-email-*.html
+
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+#
+# Here are some files you may want to ignore globally:
+
+# scm revert files
+**.orig
+
+# Mac finder artifacts
+.DS_Store
+
+# Netbeans project directory
+/nbproject/
+
+# RubyMine project files
+.idea
+
+# Textmate project files
+/*.tmproj
+
+# vim artifacts
+**.swp

data/spec/dummyapp/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummyapp/app/assets/javascripts/application.js

@@ -0,0 +1,3 @@
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummyapp/app/assets/stylesheets/application.css.scss

@@ -0,0 +1,37 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/
+.brand {
+  float: left;
+  padding-right: 8px;
+}
+ul.nav {
+  list-style: none;
+  margin: 0 0 2em;
+  padding: 0;
+}
+ul.nav li {
+  display: inline;
+}
+#flash_notice, #flash_alert {
+  padding: 5px 8px;
+  margin: 10px 0;
+}
+#flash_notice {
+  background-color: #CFC;
+  border: solid 1px #6C6;
+}
+#flash_alert {
+  background-color: #FCC;
+  border: solid 1px #C66;
+}

data/spec/dummyapp/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummyapp/app/controllers/home_controller.rb

@@ -0,0 +1,25 @@
+class HomeController < ApplicationController
+  def index
+    @users = User.all
+
+    Rollbar.report_message("Test message from controller with no data", "debug")
+    Rollbar.report_message("Test message from controller with extra data", "debug",
+                             :foo => "bar", :num_users => @users.length)
+  end
+
+  def report_exception
+    begin
+      foo = bar
+    rescue => e
+      Rollbar.report_exception(e, rollbar_request_data, rollbar_person_data)
+    end
+  end
+
+  def cause_exception
+    foo = bar
+  end
+
+  def current_user
+    User.find_by_encrypted_password(cookies[:session_id])
+  end
+end

data/spec/dummyapp/app/controllers/users_controller.rb

@@ -0,0 +1,17 @@
+class UsersController < ApplicationController
+  before_filter :authenticate_user!
+
+  def index
+    @users = User.all
+  end
+
+  def show
+    @user = User.find(params[:id])
+  end
+
+  def start_session
+    @user = User.find(params[:id])
+    cookies[:session_id] = @user.encrypted_password
+  end
+
+end

data/spec/dummyapp/app/models/user.rb

@@ -0,0 +1,10 @@
+class User < ActiveRecord::Base
+  # Include default devise modules. Others available are:
+  # :token_authenticatable, :confirmable,
+  # :lockable, :timeoutable and :omniauthable
+  devise :database_authenticatable, :registerable,
+         :recoverable, :rememberable, :trackable, :validatable
+
+  # Setup accessible (or protected) attributes for your model
+  attr_accessible :name, :email, :password, :password_confirmation, :remember_me
+end

data/spec/dummyapp/app/views/devise/registrations/edit.html.erb

@@ -0,0 +1,27 @@
+<h2>Edit <%= resource_name.to_s.humanize %></h2>
+
+<%= form_for(resource, :as => resource_name, :url => registration_path(resource_name), :html => { :method => :put }) do |f| %>
+  <%= devise_error_messages! %>
+<p><%= f.label :name %><br />
+<%= f.text_field :name %></p>
+
+  <div><%= f.label :email %><br />
+  <%= f.email_field :email %></div>
+
+  <div><%= f.label :password %> <i>(leave blank if you don't want to change it)</i><br />
+  <%= f.password_field :password, :autocomplete => "off" %></div>
+
+  <div><%= f.label :password_confirmation %><br />
+  <%= f.password_field :password_confirmation %></div>
+
+  <div><%= f.label :current_password %> <i>(we need your current password to confirm your changes)</i><br />
+  <%= f.password_field :current_password %></div>
+
+  <div><%= f.submit "Update" %></div>
+<% end %>
+
+<h3>Cancel my account</h3>
+
+<p>Unhappy? <%= link_to "Cancel my account", registration_path(resource_name), :data => { :confirm => "Are you sure?" }, :method => :delete %>.</p>
+
+<%= link_to "Back", :back %>