ratchetio 0.4.2 → 0.4.3

data/spec/dummyapp/public/humans.txt

@@ -0,0 +1,20 @@
+/* the humans responsible & colophon */
+/* humanstxt.org */
+
+
+/* TEAM */
+  <your title>: <your name>
+  Site:
+  Twitter:
+  Location:
+
+/* THANKS */
+  Daniel Kehoe (@rails_apps) for the RailsApps project
+
+/* SITE */
+  Standards: HTML5, CSS3
+  Components: jQuery
+  Software: Ruby on Rails
+
+/* GENERATED BY */
+	RailsApps application template: http://railsapps.github.com/

data/spec/dummyapp/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/spec/dummyapp/script/cucumber

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+vendored_cucumber_bin = Dir["#{File.dirname(__FILE__)}/../vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+if vendored_cucumber_bin
+  load File.expand_path(vendored_cucumber_bin)
+else
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'cucumber'
+  load Cucumber::BINARY
+end

data/spec/dummyapp/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/ratchetio_spec.rb

@@ -1,3 +1,235 @@
-describe Ratchetio::Ratchet do
+require 'socket'
+require 'spec_helper'
+
+describe Ratchetio do
+
+  it 'controller methods'
+  
+  context 'report_exception' do
+    before(:each) do
+      configure
+      Ratchetio.configure do |config|
+        config.logger = logger_mock
+      end
+      
+      begin
+        foo = bar
+      rescue => e
+        @exception = e
+      end
+    end
+   
+    let(:logger_mock) { double("Rails.logger").as_null_object }
+
+    it 'should report exceptions without person or request data' do
+      logger_mock.should_receive(:info).with('[Ratchet.io] Sending payload')
+      Ratchetio.report_exception(@exception)
+    end
+
+    it 'should report exceptions with request and person data' do
+      logger_mock.should_receive(:info).with('[Ratchet.io] Sending payload')
+      request_data = {
+        :params => { :foo => "bar" },
+        :url => 'http://localhost/',
+        :user_ip => '127.0.0.1',
+        :headers => {},
+        :GET => { "baz" => "boz" },
+        :session => { :user_id => 123 },
+        :method => "GET",
+      }
+      person_data = {
+        :id => 1,
+        :username => "test",
+        :email => "test@example.com"
+      }
+      Ratchetio.report_exception(@exception, request_data, person_data)
+    end
+
+    it 'should ignore ignored exception classes' do
+      saved_filters = Ratchetio.configuration.exception_level_filters
+      Ratchetio.configure do |config|
+        config.exception_level_filters = { 'NameError' => 'ignore' }
+      end
+
+      logger_mock.should_not_receive(:info)
+      logger_mock.should_not_receive(:warn)
+      logger_mock.should_not_receive(:error)
+      
+      Ratchetio.report_exception(@exception)
+      
+      Ratchetio.configure do |config|
+        config.exception_level_filters = saved_filters
+      end
+    end
+  end
+  
+  context 'report_message' do
+    before(:each) do
+      configure
+      Ratchetio.configure do |config|
+        config.logger = logger_mock
+      end
+    end
+    
+    let(:logger_mock) { double("Rails.logger").as_null_object }
+
+    it 'should report simple messages' do
+      logger_mock.should_receive(:info).with('[Ratchet.io] Sending payload')
+      Ratchetio.report_message("Test message")
+    end
+
+    it 'should report messages with extra data' do
+      logger_mock.should_receive(:info).with('[Ratchet.io] Sending payload')
+      Ratchetio.report_message("Test message with extra data", 'debug', :foo => "bar",
+                               :hash => { :a => 123, :b => "xyz" })
+    end
+
+    it 'should not crash with circular extra_data' do
+      a = { :foo => "bar" }
+      b = { :a => a }
+      c = { :b => b }
+      a[:c] = c
+
+      logger_mock.should_receive(:error).with('[Ratchet.io] Error reporting message to Ratchet.io: object references itself')
+      Ratchetio.report_message("Test message with extra data", 'debug', a)
+    end
+
+    after(:each) do
+      Ratchetio.configure do |config|
+        config.logger = ::Rails.logger
+      end
+    end
+  end
+
+  context 'message_data' do
+    before(:each) do
+      configure
+      @message_body = "This is a test"
+      @level = 'debug'
+    end
+
+    it 'should build a message' do
+      data = Ratchetio.send(:message_data, @message_body, @level, {})
+      data[:body][:message][:body].should == @message_body
+      data[:level].should == @level
+    end
+
+    it 'should accept extra_data' do
+      user_id = 123
+      name = "Tester"
+
+      data = Ratchetio.send(:message_data, @message_body, 'info', 
+                            :user_id => user_id, :name => name)
+      
+      message = data[:body][:message]
+      message[:body].should == @message_body
+      message[:user_id].should == user_id
+      message[:name].should == name
+    end
+  end
+  
+  context 'exception_data' do
+    before(:each) do
+      configure
+      begin
+        foo = bar
+      rescue => e
+        @exception = e
+      end
+    end
+    
+    it 'should accept force_level' do
+      level = 'critical'
+      data = Ratchetio.send(:exception_data, @exception, level)
+      data[:level].should == level
+    end
+
+    it 'should build valid exception data' do
+      data = Ratchetio.send(:exception_data, @exception)
+      
+      data[:level].should_not be_nil
+      
+      trace = data[:body][:trace]
+      
+      frames = trace[:frames]
+      frames.should be_a_kind_of(Array)
+      frames.each do |frame|
+        frame[:filename].should be_a_kind_of(String)
+        frame[:method].should be_a_kind_of(String)
+        frame[:lineno].should be_a_kind_of(Fixnum)
+      end
+      
+      trace[:exception][:class].should == 'NameError'
+      trace[:exception][:message].should match(/^undefined local variable or method `bar' for/)
+    end
+  end
+  
+  context 'logger' do
+    it 'should have its logger configured' do
+      configure
+      Ratchetio.send(:logger).should == ::Rails.logger
+    end
+  end
+  
+  context 'build_payload' do
+    it 'should build valid json' do
+      json = Ratchetio.send(:build_payload, {:foo => {:bar => "baz"}})
+      hash = ActiveSupport::JSON.decode(json)
+      hash["data"]["foo"]["bar"].should == "baz"
+    end
+  end
+
+  context 'base_data' do
+    before(:each) do
+      configure
+    end
+
+    it 'should have the correct notifier name' do
+      Ratchetio.send(:base_data)[:notifier][:name].should == 'ratchetio-gem'
+    end
+    
+    it 'should have the correct notifier version' do
+      Ratchetio.send(:base_data)[:notifier][:version].should == Ratchetio::VERSION
+    end
+
+    it 'should have all the required keys' do
+      data = Ratchetio.send(:base_data)
+      data[:timestamp].should_not be_nil
+      data[:environment].should_not be_nil
+      data[:level].should_not be_nil
+      data[:language].should == 'ruby'
+      data[:framework].should match(/^Rails/)
+    end
+  end
+
+  context 'server_data' do
+    it 'should have the right hostname' do
+      Ratchetio.send(:server_data)[:host] == Socket.gethostname
+    end
+
+    it 'should have root and branch set when configured' do
+      configure
+      Ratchetio.configure do |config|
+        config.root = '/path/to/root'
+        config.branch = 'master'
+      end
+
+      data = Ratchetio.send(:server_data)
+      data[:root].should == '/path/to/root'
+      data[:branch].should == 'master'
+    end
+  end
+
+  # configure with some basic params
+  def configure
+    Ratchetio.configure do |config|
+      # special test access token
+      config.access_token = 'aaaabbbbccccddddeeeeffff00001111'
+      config.logger = ::Rails.logger
+      config.environment = ::Rails.env
+      config.root = ::Rails.root
+      config.framework = "Rails: #{::Rails::VERSION::STRING}"
+    end
+  end
 
 end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+#require 'rspec'
+#require 'ratchetio'
+
+require 'rubygems'
+
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../dummyapp/config/environment', __FILE__)
+require 'rspec/rails'
+require 'factory_girl_rails'
+require 'database_cleaner'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| puts f; require f }
+FactoryGirl.definition_file_paths = [ File.join(Rails.root, '../factories') ]
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = 'documentation'
+
+  config.use_transactional_fixtures = true
+  config.order = "random"
+  
+  config.before(:suite) do
+    FactoryGirl.reload
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+    DatabaseCleaner.clean
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+

data/spec/support/devise.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include Devise::TestHelpers, :type => :controller
+end