raygun4ruby 0.0.5 → 0.0.6

data/README.md

@@ -0,0 +1,101 @@
+# Raygun 4 Ruby [![Build Status](https://travis-ci.org/MindscapeHQ/raygun4ruby.png?branch=master)](https://travis-ci.org/MindscapeHQ/raygun4ruby)
+
+This is the Ruby adapter for the Raygun error reporter, http://raygun.io.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'raygun4ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install raygun4ruby
+
+## Usage
+
+###Rails 3/4
+
+Run:
+
+    rails g raygun:install YOUR_API_KEY_HERE
+
+You can find your API key on your [Raygun Dashboard](https://app.raygun.io/dashboard/)
+
+You can then test your Raygun integration by running:
+
+    rake raygun:test
+
+You should see an "ItWorksException" appear in your Raygun dashboard. You're ready to zap those errors!
+
+NB: Raygun4Ruby currently requires Ruby >= 1.9
+
+Note that the generator will create a file in `config/initializers` called "raygun.rb". If you need to do any further configuration or customization of Raygun, that's the place to do it!
+
+### Rails 2
+
+Raygun4Ruby doesn't currently support Rails 2. If you'd like Rails 2 support, [drop us a line](http://raygun.io/forums).
+
+###Standalone / Manual Exception Tracking
+
+```ruby
+
+require 'rubygems'
+require 'raygun4ruby'
+
+Raygun.setup do |config|
+  config.api_key = "YOUR_RAYGUN_API_KEY"
+end
+
+begin
+  # your lovely code here
+rescue Exception => e
+  Raygun.track_exception(e)
+end
+
+```
+
+(You can also pass a Hash as the second parameter to `track_exception`. It should look like a [Rack Env Hash](http://rack.rubyforge.org/doc/SPEC.html))
+
+###Ignoring Some Errors
+
+You can ignore certain types of Exception using the `ignore` option in the setup block, like so:
+
+```ruby
+Raygun.setup do |config|
+  config.api_key = "MY_SWEET_API_KEY"
+  config.ignore  << [MyApp::AnExceptionIDontCareAbout]
+end
+```
+
+You can also check which [exceptions are ignored by default](https://github.com/MindscapeHQ/raygun4ruby/blob/master/lib/raygun/configuration.rb#L26)
+
+###Resque Error Tracking
+
+Raygun4Ruby also includes a Resque failure backend. You should include it inside your Resque initializer (usually something like `config/initializers/load_resque.rb`)
+
+```ruby
+require 'resque/failure/multiple'
+require 'resque/failure/raygun'
+require 'resque/failure/redis'
+
+Resque::Failure::Multiple.classes = [Resque::Failure::Redis, Resque::Failure::Raygun]
+Resque::Failure.backend = Resque::Failure::Multiple
+```
+
+## Found a bug?
+
+Oops! Just let us know by opening an Issue on Github.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/raygun/client.rb

@@ -7,11 +7,17 @@ module Raygun
     base_uri "https://api.raygun.io/"
 
     def initialize
+      @api_key = require_api_key!
+
       @headers = {
-        "X-ApiKey" => Raygun.configuration.api_key
+        "X-ApiKey" => @api_key
       }
     end
 
+    def require_api_key!
+      Raygun.configuration.api_key || raise(ApiKeyRequired.new("Please specify your Raygun API key using Raygun#setup (find yours at https://app.raygun.io)"))
+    end
+
     def track_exception(exception_instance, env = {})
       create_entry(build_payload_hash(exception_instance, env))
     end
@@ -53,7 +59,7 @@ module Raygun
       end
 
       def request_information(env)
-        return {} if env.blank?
+        return {} if env.nil? || env.empty?
 
         {
           hostName:    env["SERVER_NAME"],
@@ -69,7 +75,7 @@ module Raygun
 
       def headers(rack_env)
         rack_env.select do |k, v|
-          k.to_s.starts_with?("HTTP_")
+          k.to_s.start_with?("HTTP_")
         end
       end
 
@@ -103,4 +109,4 @@ module Raygun
       end
 
   end
-end
+end

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/raygun.rb

@@ -6,7 +6,6 @@ require "logger"
 require "json"
 require "socket"
 require "rack"
-require "active_support/core_ext"
 
 require "raygun/version"
 require "raygun/configuration"
@@ -21,6 +20,9 @@ module Raygun
   CLIENT_URL  = "https://github.com/MindscapeHQ/raygun4ruby"
   CLIENT_NAME = "Raygun4Ruby Gem"
 
+  # Exceptions
+  class ApiKeyRequired < StandardError; end
+
   class << self
 
     include Testable

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun4ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-04 00:00:00.000000000 Z
+date: 2013-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -44,22 +44,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +174,7 @@ files:
 - lib/raygun/testable.rb
 - lib/tasks/raygun.tasks
 - lib/resque/failure/raygun.rb
+- README.md
 homepage: http://raygun.io
 licenses:
 - MIT