more readme

Author: darragh

README

@@ -1,24 +1,46 @@
-= Exceptional plugin for Ruby on Rails
+# Exceptional plugin for Ruby on Rails
 
 This plugin posts exception data to Exceptional (http://getexceptional.com). Data about the request, session, environment and a backtrace of the exception is transmitted.
 
-= Installation
+Once installed and configured, all exceptions from web requests are reported to Exceptional.
+
+## Installation
 
 1. gem install exceptional
 2. Add config.gem 'exceptional' to 'config/environment.rb'
 3. run 'exceptional install <api-key>' using the api-key for your app from http://getexceptional.com
 
-Other ways to install:
+### Other ways to install:
 
 1. traditional rails plugin install
 2. gem bundler
 
-= Upgrading from old version of the exceptional plugin
+## Upgrading from old version of the exceptional plugin
 
 1. Delete vendor/plugins/exceptional
 2. Follow installation instructions above
 3. (optional) Simplify your config/exceptional.yml file - all it needs now is a single line with 'api-key: YOUR-KEY'
 
+
+## Usage outside web requests (Daemons etc)
+
+Exceptional.resuce do
+  something_that_you_want_to_catch_exceptions_from
+end
+
+This reports exceptions to Exceptional and re-raises them.
+
+### (Optional) Loading exceptional config
+
+You can either do something like
+
+Exceptional::Config.load("config/exceptional.yml")
+
+or
+
+Exceptional.configure('YOUR_API-KEY')
+
+
 Please send any questions or comments to [email protected].
 
 Copyright © 2008, 2009 Contrast.

lib/exceptional.rb

@@ -18,6 +18,10 @@ def self.logger
     ::Exceptional::LogFactory.logger
   end
 
+  def self.configure(api_key)
+    Exceptional::Config.api_key = api_key
+  end
+
   def self.rescue(&block)
     begin
       block.call

lib/exceptional/remote.rb

@@ -30,7 +30,7 @@ def call_remote(url, data)
         client = optional_proxy.new(config.remote_host, config.remote_port)
         client.open_timeout = config.http_open_timeout
         client.read_timeout = config.http_read_timeout
-        client.use_ssl = true if config.ssl_enabled?
+        client.use_ssl = config.ssl_enabled?
         begin
           response = client.post(url, data)
           case response

spec/exceptional/exception_data_spec.rb

@@ -63,6 +63,7 @@ class Exceptional::SomeController < ActionController::Base
     data = Exceptional::ExceptionData.new(error, @controller, @request)
     @hash = data.to_hash
   end
+
   it "captures request" do
     request_hash = @hash['request']
     request_hash['url'].should == 'http://test.host/some_path?var1=abc'

spec/standalone_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'exceptional', 'integration', 'rails')
+
+describe Exceptional do
+  it "set the api key" do
+    Exceptional.configure('api-key')
+    Exceptional::Config.api_key.should == 'api-key'
+  end
+end