ratchetio 0.4.2 → 0.4.3

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.swp

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+**0.4.3**
+- Add RSpec test suite. A few minor code changes.
+
+**0.4.2**
+- Add "ignore" filter level to completely ignore exceptions by class.
+
 **0.4.1**
 - Recursively filter files out of the params hash. Thanks to [trisweb](https://github.com/trisweb) for the pull request.
 

data/README.md

@@ -105,3 +105,5 @@ If you run into any issues, please email us at `support@ratchet.io`
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+We're using RSpec for testing. Run the test suite with `rake spec`. Tests for pull requests are appreciated but not required. (If you don't include a test, we'll write one before merging.)

data/Rakefile

@@ -1,2 +1,8 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+desc 'Run tests'
+task :default => :spec

data/lib/generators/ratchetio/ratchetio_generator.rb

@@ -4,7 +4,7 @@ require 'rails/generators/named_base'
 module Ratchetio
   module Generators
     class RatchetioGenerator < ::Rails::Generators::Base
-      argument :access_token, :type => :string, :banner => "access_token"
+      argument :access_token, :type => :string, :banner => 'access_token'
 
       source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
 

data/lib/ratchetio/configuration.rb

@@ -2,20 +2,19 @@ module Ratchetio
   class Configuration
 
     attr_accessor :access_token
-    attr_accessor :environment
-    attr_accessor :root
     attr_accessor :branch
-    attr_accessor :framework
     attr_accessor :endpoint
     attr_accessor :exception_level_filters
+    attr_accessor :environment
+    attr_accessor :framework
+    attr_accessor :logger
     attr_accessor :person_method
     attr_accessor :person_id_method
     attr_accessor :person_username_method
     attr_accessor :person_email_method
+    attr_accessor :root
 
-    attr_accessor :logger
-
-    DEFAULT_ENDPOINT = "https://submit.ratchet.io/api/1/item/"
+    DEFAULT_ENDPOINT = 'https://submit.ratchet.io/api/1/item/'
 
     def initialize
       @endpoint = DEFAULT_ENDPOINT
@@ -25,10 +24,10 @@ module Ratchetio
         'AbstractController::ActionNotFound' => 'warning',
         'ActionController::RoutingError' => 'warning'
       }
-      @person_method = "current_user"
-      @person_id_method = "id"
-      @person_username_method = "username"
-      @person_email_method = "email"
+      @person_method = 'current_user'
+      @person_id_method = 'id'
+      @person_username_method = 'username'
+      @person_email_method = 'email'
     end
 
     # allow params to be read like a hash

data/lib/ratchetio/rails/controller_methods.rb

@@ -45,7 +45,7 @@ module Ratchetio
                 :size => v.tempfile.size 
               }
             rescue
-              filtered[k] = "Uploaded file"
+              filtered[k] = 'Uploaded file'
             end
           elsif v.is_a? Hash
             filtered[k] = ratchetio_filter_params v
@@ -67,11 +67,11 @@ module Ratchetio
 
       def ratchetio_user_ip
         # priority: X-Real-Ip, then X-Forwarded-For, then request.remote_ip
-        real_ip = request.env["HTTP_X_REAL_IP"]
+        real_ip = request.env['HTTP_X_REAL_IP']
         if real_ip
           return real_ip
         end
-        forwarded_for = request.env["HTTP_X_FORWARDED_FOR"]
+        forwarded_for = request.env['HTTP_X_FORWARDED_FOR']
         if forwarded_for
           return forwarded_for
         end

data/lib/ratchetio/rails/middleware/exception_catcher.rb

@@ -7,16 +7,14 @@ module Ratchetio
         end
 
         def render_exception_with_ratchetio(env, exception)
-          # wrap everything in a begin-rescue block
           begin
             controller = env['action_controller.instance']
             request_data = controller.try(:ratchetio_request_data)
             person_data = controller.try(:ratchetio_person_data)
             Ratchetio.report_exception(exception, request_data, person_data)
-          rescue Exception => exc
+          rescue => e
             # TODO use logger here?
-            puts "[Ratchet.io] Exception while reporting exception to Ratchet.io: " 
-            puts exc
+            puts "[Ratchet.io] Exception while reporting exception to Ratchet.io: #{e}" 
           end
 
           # now continue as normal

data/lib/ratchetio/version.rb

@@ -1,3 +1,3 @@
 module Ratchetio
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/lib/ratchetio.rb

@@ -7,75 +7,106 @@ require 'ratchetio/configuration'
 require 'ratchetio/railtie'
 
 module Ratchetio
-
   class << self
     attr_writer :configuration
     
+    # Configures the gem.
+    # 
+    # Call on app startup to set the `access_token` (required) and other config params.
+    # In a Rails app, this is called by `config/initializers/ratchetio.rb` which is generated
+    # with `rails generate ratchetio access-token-here`
+    #
+    # @example
+    #   Ratchetio.configure do |config|
+    #     config.access_token = 'abcdefg'
+    #   end
     def configure
       yield(configuration)
     end
 
+    # Returns the configuration object.
+    #
+    # @return [Ratchetio::Configuration] The configuration object
     def configuration
       @configuration ||= Configuration.new
     end
 
-    def report_exception(exception, request_data={}, person_data={})
-      begin
-        filtered_level = configuration.exception_level_filters[exception.class.name]
-        if filtered_level == 'ignore'
-          # ignored - do nothing
-          return
-        end
-
-        data = exception_data(exception, filtered_level)
-        if request_data
-          data[:request] = request_data
-        end
-        if person_data
-          data[:person] = person_data
-        end
-
-        payload = build_payload(data)
-        send_payload(payload)
-      rescue Exception => e
-        logger.error "[Ratchet.io] Error reporting exception to Ratchet.io: #{e}"
+    # Reports an exception to Ratchet.io
+    #
+    # @example
+    #   begin
+    #     foo = bar
+    #   rescue => e
+    #     Ratchetio.report_exception(e)
+    #   end
+    #
+    # @param exception [Exception] The exception object to report
+    # @param request_data [Hash] Data describing the request. Should be the result of calling 
+    #   `ratchetio_request_data`.
+    # @param person_data [Hash] Data describing the affected person. Should be the result of calling
+    #   `ratchetio_person_data`
+    def report_exception(exception, request_data = nil, person_data = nil)
+      filtered_level = configuration.exception_level_filters[exception.class.name]
+      if filtered_level == 'ignore'
+        # ignored - do nothing
+        return
       end
+
+      data = exception_data(exception, filtered_level)
+      data[:request] = request_data if request_data
+      data[:person] = person_data if person_data
+
+      payload = build_payload(data)
+      send_payload(payload)
+    rescue => e
+      logger.error "[Ratchet.io] Error reporting exception to Ratchet.io: #{e}"
     end
 
-    def report_message(message, level="info", extra_data={})
-      begin
-        data = base_data(level)
-        
-        data[:body] = {
-          :message => {
-            :body => message.to_s
-          }
-        }
-        data[:body][:message].merge!(extra_data)
-        data[:server] = server_data
-        
-        payload = build_payload(data)
-        send_payload(payload)
-      rescue Exception => e
-        logger.error "[Ratchet.io] Error reporting message to Ratchet.io: #{e}"
-      end
+    # Reports an arbitrary message to Ratchet.io
+    #
+    # @example
+    #   Ratchetio.report_message("User login failed", 'info', :user_id => 123)
+    #
+    # @param message [String] The message body. This will be used to identify the message within 
+    #   Ratchet. For best results, avoid putting variables in the message body; pass them as 
+    #   `extra_data` instead. 
+    # @param level [String] The level. One of: 'critical', 'error', 'warning', 'info', 'debug'
+    # @param extra_data [Hash] Additional data to include alongside the body. Don't use 'body' as 
+    #   it is reserved.
+    def report_message(message, level = 'info', extra_data = {})
+      data = message_data(message, level, extra_data)
+      payload = build_payload(data)
+      send_payload(payload)
+    rescue => e
+      logger.error "[Ratchet.io] Error reporting message to Ratchet.io: #{e}"
     end
 
-  private
+    private
+
+    def message_data(message, level, extra_data)
+      data = base_data(level)
+      
+      data[:body] = {
+        :message => {
+          :body => message.to_s
+        }
+      }
+      data[:body][:message].merge!(extra_data)
+      data[:server] = server_data
+      
+      data
+    end
 
     def exception_data(exception, force_level = nil)
       data = base_data
       
-      if force_level
-        data[:level] = force_level
-      end
+      data[:level] = force_level if force_level
 
       # parse backtrace
-      frames = []
-      exception.backtrace.each { |frame|
+      frames = exception.backtrace.map { |frame|
         # parse the line
         match = frame.match(/(.*):(\d+)(?::in `([^']+)')?/)
-        frames.push({ :filename => match[1], :lineno => match[2].to_i, :method => match[3] })
+        { :filename => match[1], :lineno => match[2].to_i, :method => match[3] }
       }
       # reverse so that the order is as ratchet expects
       frames.reverse!
@@ -100,7 +131,7 @@ module Ratchetio
     end
 
     def send_payload(payload)
-      logger.info "[Ratchet.io] Sending payload"
+      logger.info '[Ratchet.io] Sending payload'
 
       uri = URI.parse(configuration.endpoint)
       http = Net::HTTP.new(uri.host, uri.port)
@@ -112,11 +143,10 @@ module Ratchetio
       response = http.request(request)
 
       if response.code == '200'
-        logger.info "[Ratchet.io] Success"
+        logger.info '[Ratchet.io] Success'
       else
-        logger.warn "[Ratchet.io] Got unexpected status code from Ratchet.io api: " + response.code
-        logger.info "[Ratchet.io] Response:"
-        logger.info response.body
+        logger.warn "[Ratchet.io] Got unexpected status code from Ratchet.io api: #{response.code}"
+        logger.info "[Ratchet.io] Response: #{response.body}"
       end
     end
 
@@ -128,16 +158,16 @@ module Ratchetio
       ActiveSupport::JSON.encode(payload)
     end
 
-    def base_data(level="error")
+    def base_data(level = 'error')
       config = configuration
       {
         :timestamp => Time.now.to_i,
         :environment => config.environment,
         :level => level,
-        :language => "ruby",
+        :language => 'ruby',
         :framework => config.framework,
         :notifier => {
-          :name => "ratchetio-gem",
+          :name => 'ratchetio-gem',
           :version => VERSION
         }
       }
@@ -145,18 +175,15 @@ module Ratchetio
 
     def server_data
       config = configuration
+      
       data = {
         :host => Socket.gethostname
       }
-      if config.root
-        data[:root] = config.root.to_s
-      end
-      if config.branch
-        data[:branch] = config.branch
-      end
+      data[:root] = config.root.to_s if config.root
+      data[:branch] = config.branch if config.branch
+      
       data
     end
   
   end
 end
-

data/ratchetio.gemspec

@@ -15,5 +15,20 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Ratchetio::VERSION
 
-  #gem.add_development_dependency "rspec", "~> 2.6"
+  gem.add_development_dependency 'rspec-rails', '~> 2.12'
+  gem.add_development_dependency 'rails', '~> 3.2.9'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'jquery-rails'
+  gem.add_development_dependency 'jquery-rails'
+
+  gem.add_development_dependency 'rspec-rails', '>= 2.11.4'
+  gem.add_development_dependency 'database_cleaner', '>= 0.9.1'
+  gem.add_development_dependency 'email_spec', '>= 1.4.0'
+  gem.add_development_dependency 'cucumber-rails', '>= 1.3.0'
+  gem.add_development_dependency 'launchy', '>= 2.1.2'
+  #gem.add_development_dependency 'capybara', '>= 1.1.3'
+  gem.add_development_dependency 'factory_girl_rails', '>= 4.1.0'
+  gem.add_development_dependency 'devise', '>= 2.1.2'
+  gem.add_development_dependency 'quiet_assets', '>= 1.0.1'
+
 end

data/spec/controllers/home_controller_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe HomeController do
+  
+  before(:each) do
+    Ratchetio.configure do |config|
+      config.logger = logger_mock
+    end
+  end
+    
+  let(:logger_mock) { double("Rails.logger").as_null_object }
+
+  describe "GET 'index'" do
+    it "should be successful and report a message" do
+      logger_mock.should_receive(:info).with('[Ratchet.io] Sending payload')
+      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('[Ratchet.io] Sending payload')
+
+      get 'report_exception'
+      response.should be_success
+    end
+  end
+
+  # TODO need to figure out how to make a test request that uses enough of the middleware
+  # that it invokes the ratchetio exception catcher. just plain "get 'some_url'" doesn't
+  # seem to work.
+  it "should report uncaught exceptions"
+  
+  after(:each) do
+    Ratchetio.configure do |config|
+      config.logger = ::Rails.logger
+    end
+  end
+  
+end

data/spec/dummyapp/.gitignore

@@ -0,0 +1,74 @@
+#----------------------------------------------------------------------------
+# 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
+/config/database.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/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+gem 'rails', '3.2.9'
+gem 'sqlite3'
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+  gem 'uglifier', '>= 1.0.3'
+end
+gem 'jquery-rails'
+gem "rspec-rails", ">= 2.11.4", :group => [:development, :test]
+gem "database_cleaner", ">= 0.9.1", :group => :test
+gem "email_spec", ">= 1.4.0", :group => :test
+gem "cucumber-rails", ">= 1.3.0", :group => :test, :require => false
+gem "launchy", ">= 2.1.2", :group => :test
+gem "capybara", ">= 1.1.3", :group => :test
+gem "factory_girl_rails", ">= 4.1.0", :group => [:development, :test]
+gem "devise", ">= 2.1.2"
+gem "quiet_assets", ">= 1.0.1", :group => :development
+gem "ratchetio", :path => "../.."

data/spec/dummyapp/README

@@ -0,0 +1,19 @@
+Dummyapp
+========================
+
+This application was generated with the rails_apps_composer gem:
+https://github.com/RailsApps/rails_apps_composer
+provided by the RailsApps Project:
+http://railsapps.github.com/
+
+________________________
+
+Recipes:
+["controllers", "core", "email", "extras", "frontend", "gems", "git", "init", "models", "prelaunch", "railsapps", "readme", "routes", "saas", "setup", "testing", "views"]
+
+Preferences:
+{:git=>true, :railsapps=>"rails3-devise-rspec-cucumber", :database=>"sqlite", :unit_test=>"rspec", :integration=>"cucumber", :fixtures=>"factory_girl", :frontend=>"none", :email=>"gmail", :authentication=>"devise", :devise_modules=>"default", :authorization=>"none", :starter_app=>"users_app", :form_builder=>"none", :quiet_assets=>true, :dev_webserver=>"webrick", :templates=>"erb"}
+
+________________________
+
+License

data/spec/dummyapp/README.textile

@@ -0,0 +1,80 @@
+h1. Dummyapp
+
+This application was generated with the "rails_apps_composer":https://github.com/RailsApps/rails_apps_composer gem provided by the "RailsApps Project":http://railsapps.github.com/.
+
+h2. Diagnostics
+
+This application was built with recipes that are known to work together.
+
+This application was built with preferences that are known to work together.
+
+If the application doesn't work as expected, please "report an issue":https://github.com/RailsApps/rails_apps_composer/issues and include these diagnostics:
+
+We'd also like to know if you've found combinations of recipes or preferences that do work together.
+
+Recipes:
+["controllers", "core", "email", "extras", "frontend", "gems", "git", "init", "models", "prelaunch", "railsapps", "readme", "routes", "saas", "setup", "testing", "views"]
+
+Preferences:
+{:git=>true, :railsapps=>"rails3-devise-rspec-cucumber", :database=>"sqlite", :unit_test=>"rspec", :integration=>"cucumber", :fixtures=>"factory_girl", :frontend=>"none", :email=>"gmail", :authentication=>"devise", :devise_modules=>"default", :authorization=>"none", :starter_app=>"users_app", :form_builder=>"none", :quiet_assets=>true, :dev_webserver=>"webrick", :templates=>"erb"}
+
+h2. Ruby on Rails
+
+This application requires:
+
+* Ruby version 1.9.3
+* Rails version 3.2.9
+
+Learn more about "Installing Rails":http://railsapps.github.com/installing-rails.html.
+
+h2. Database
+
+This application uses SQLite with ActiveRecord.
+
+h2. Development
+
+* Template Engine: ERB
+* Testing Framework: RSpec and Factory Girl and Cucumber
+* Front-end Framework: None
+* Form Builder: None
+* Authentication: Devise
+* Authorization: None
+
+h2. Email
+
+The application is configured to send email using a Gmail account.
+
+h2. Getting Started
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+
+h2. Documentation and Support
+
+This is the only documentation.
+
+h4. Issues
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+
+h2. Similar Projects
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+
+h2. Contributing
+
+If you make improvements to this application, please share with others.
+
+* Fork the project on GitHub.
+* Make your feature addition or bug fix.
+* Commit with Git.
+* Send the author a pull request.
+
+If you add functionality to this application, create an alternative implementation, or build an application that is similar, please contact me and I'll add a note to the README so that others can find your work.
+
+h2. Credits
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+
+h2. License
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.

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__)
+
+Dummyapp::Application.load_tasks

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

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummyapp/app/assets/javascripts/home.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://jashkenas.github.com/coffee-script/