ratchetio 0.4.3 → 0.4.4

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+**0.4.4**
+- Add `enabled` runtime config flag. When `false`, no data (messages or exceptions) will be reported.
+
 **0.4.3**
 - Add RSpec test suite. A few minor code changes.
 

data/lib/ratchetio/configuration.rb

@@ -3,6 +3,7 @@ module Ratchetio
 
     attr_accessor :access_token
     attr_accessor :branch
+    attr_accessor :enabled
     attr_accessor :endpoint
     attr_accessor :exception_level_filters
     attr_accessor :environment
@@ -17,6 +18,7 @@ module Ratchetio
     DEFAULT_ENDPOINT = 'https://submit.ratchet.io/api/1/item/'
 
     def initialize
+      @enabled = true
       @endpoint = DEFAULT_ENDPOINT
       @framework = 'Plain'
       @exception_level_filters = {

data/lib/ratchetio/version.rb

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

data/lib/ratchetio.rb

@@ -46,6 +46,10 @@ module Ratchetio
     # @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)
+      unless configuration.enabled
+        return
+      end
+
       filtered_level = configuration.exception_level_filters[exception.class.name]
       if filtered_level == 'ignore'
         # ignored - do nothing
@@ -74,6 +78,10 @@ module Ratchetio
     # @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 = {})
+      unless configuration.enabled
+        return
+      end
+      
       data = message_data(message, level, extra_data)
       payload = build_payload(data)
       send_payload(payload)

data/spec/controllers/home_controller_spec.rb

@@ -10,6 +10,110 @@ describe HomeController do
     
   let(:logger_mock) { double("Rails.logger").as_null_object }
 
+  context "ratchetio controller methods" do
+    # TODO run these for a a more-real request
+    it "should build valid request data" do
+      data = @controller.ratchetio_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.ratchetio_person_data
+      data.should == {}
+    end
+
+    context "ratchetio_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(:ratchetio_filter_params, 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(:ratchetio_filter_params, 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
+    end
+
+    context "ratchetio_request_url" do
+      it "should build simple http urls" do
+        req = controller.request
+        req.host = 'ratchet.io'
+
+        controller.send(:ratchetio_request_url).should == 'http://ratchet.io'
+      end
+    end
+
+    context "ratchetio_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(:ratchetio_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(:ratchetio_user_ip).should == '1.2.3.4'
+      end
+
+      it "should use the remote_addr when neither is set" do
+        controller.send(:ratchetio_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('[Ratchet.io] Sending payload')

data/spec/dummyapp/.gitignore

@@ -28,7 +28,6 @@ db/*.sqlite3
 .redcar/
 .sass-cache
 /config/config.yml
-/config/database.yml
 /coverage.data
 /coverage/
 /db/*.javadb/

data/spec/dummyapp/config/database.yml

@@ -0,0 +1,28 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test: &test
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000
+
+cucumber:
+  <<: *test

data/spec/ratchetio_spec.rb

@@ -3,8 +3,6 @@ require 'spec_helper'
 
 describe Ratchetio do
 
-  it 'controller methods'
-  
   context 'report_exception' do
     before(:each) do
       configure
@@ -26,6 +24,19 @@ describe Ratchetio do
       Ratchetio.report_exception(@exception)
     end
 
+    it 'should not report anything when disabled' do
+      logger_mock.should_not_receive(:info).with('[Ratchet.io] Sending payload')
+      Ratchetio.configure do |config|
+        config.enabled = false
+      end
+      
+      Ratchetio.report_exception(@exception)
+      
+      Ratchetio.configure do |config|
+        config.enabled = true
+      end
+    end
+
     it 'should report exceptions with request and person data' do
       logger_mock.should_receive(:info).with('[Ratchet.io] Sending payload')
       request_data = {
@@ -78,6 +89,19 @@ describe Ratchetio do
       Ratchetio.report_message("Test message")
     end
 
+    it 'should not report anything when disabled' do
+      logger_mock.should_not_receive(:info).with('[Ratchet.io] Sending payload')
+      Ratchetio.configure do |config|
+        config.enabled = false
+      end
+      
+      Ratchetio.report_message("Test message that should be ignored")
+      
+      Ratchetio.configure do |config|
+        config.enabled = true
+      end
+    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",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratchetio
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-21 00:00:00.000000000 Z
+date: 2012-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -276,6 +276,7 @@ files:
 - spec/dummyapp/config/application.rb
 - spec/dummyapp/config/boot.rb
 - spec/dummyapp/config/cucumber.yml
+- spec/dummyapp/config/database.yml
 - spec/dummyapp/config/environment.rb
 - spec/dummyapp/config/environments/development.rb
 - spec/dummyapp/config/environments/production.rb
@@ -371,6 +372,7 @@ test_files:
 - spec/dummyapp/config/application.rb
 - spec/dummyapp/config/boot.rb
 - spec/dummyapp/config/cucumber.yml
+- spec/dummyapp/config/database.yml
 - spec/dummyapp/config/environment.rb
 - spec/dummyapp/config/environments/development.rb
 - spec/dummyapp/config/environments/production.rb
@@ -408,4 +410,3 @@ test_files:
 - spec/ratchetio_spec.rb
 - spec/spec_helper.rb
 - spec/support/devise.rb
-has_rdoc: