resque-exceptional 0.0.1 → 0.1.0

data/HISTORY.md

@@ -1,3 +1,9 @@
+## 0.1.0 (2010-10-16)
+
+* Added more unit tests.
+* Added yardoc code comments.
+* Had a couple days production testing ;-) Initial version to be announced.
+
 ## 0.0.1 (2010-10-13)
 
 * Initial release.

data/README.md

@@ -1,13 +1,13 @@
 resque-exceptional
 ==================
 
-resque-exceptional provides a Resque failure backend that sends exceptions
-raised by jobs to http://getexceptional.com
+resque-exceptional provides a [Resque][re] failure backend that sends exceptions
+raised by jobs to [getexceptional.com][ge]
 
 Install & Quick Start
 ---------------------
 
-Before you jump into code, you'll need a http://getexceptional.com account.
+Before you jump into code, you'll need a getexceptional.com account.
 
 To install:
 
@@ -64,6 +64,18 @@ Configuration Options
   * `http_open_timeout` - timeout in seconds to establish the connection. (default: `2`)
   * `http_read_timeout` - timeout in seconds to wait for a reply. (default: `5`)
 
+Screenshots
+-----------
+
+Below are some screenshots of the getexceptional.com web interface, showing
+Resque exceptions.
+
+**App Overview**
+![Get Exceptional - Overview](http://img.skitch.com/20101013-k7hgurmaqew6sn8cik5gywbt2.png)
+
+**Detailed Information**
+![Get Exceptional - Details](http://img.skitch.com/20101013-ftjrjhh3fegcqr9mig9kttmwi4.png)
+
 Note on Patches/Pull Requests
 -----------------------------
 
@@ -79,4 +91,8 @@ Note on Patches/Pull Requests
 Author
 ------
 
-Luke Antins :: http://lividpenguin.com :: @lantins
+Luke Antins :: [http://lividpenguin.com][lp] :: @lantins
+
+[re]: http://github.com/defunkt/resque
+[lp]: http://lividpenguin.com
+[ge]: http://getexceptional.com

data/Rakefile

@@ -18,8 +18,8 @@ end
 # docs task.
 YARD::Rake::YardocTask.new :yardoc do |t|
     t.files   = ['lib/**/*.rb']
-    t.options = ['--output-dir', "doc/",
-                 '--files', 'LICENSE HISTORY.md',
+    t.options = ['--output-dir', 'doc/',
+                 '--files', 'LICENSE,HISTORY.md',
                  '--readme', 'README.md',
                  '--title', 'resque-exceptional documentation']
 end

data/lib/resque/failure/exceptional.rb

@@ -1,26 +1,30 @@
 module Resque
   module Failure
-
-    # A resque failure backend that sends exception data to getexceptional.com
+    # A Resque failure backend that sends exception data to getexceptional.com
     class Exceptional < Base
+      Version = '0.1.0' # Failure backend version number.
+
       # Raised if the api_key is not set.
       class APIKeyError < StandardError
       end
 
-      # Our version number =)
-      Version = '0.0.1'
-
       class << self
-        # API Settings.
-        attr_accessor :api_key
-        # HTTP Proxy Options.
+        attr_accessor :api_key # your getexceptional api key.
+        attr_accessor :use_ssl # enable/disable SSL.
+        # HTTP proxy option
         attr_accessor :proxy_host, :proxy_port, :proxy_user, :proxy_pass
-        # HTTP Client Options.
-        attr_accessor :use_ssl, :http_open_timeout, :http_read_timeout
+        # HTTP client option
+        attr_accessor :http_open_timeout, :http_read_timeout
       end
 
       # Configures the failure backend. At a minimum you will need to set
       # an api_key.
+      #
+      # @example Setting your API Key and enabling SSL:
+      #   Resque::Failure::Exceptional.configure do |config|
+      #     config.api_key = '505f2518c41866bb0be7ba434bb2b079'
+      #     config.use_ssl = true
+      #   end
       def self.configure
         yield self
       end
@@ -60,7 +64,11 @@ module Resque
       #
       # @return [Hash] http headers.
       def http_headers
-        { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }
+        { 
+          'Content-Type' => 'application/json',
+          'Accept'       => 'application/json',
+          'User-Agent'   => "resque-exceptional/#{Version}"
+        }
       end
 
       # Returns the compressed request data.
@@ -82,6 +90,9 @@ module Resque
       #
       # nb. this isn't documented in the public api... not sure if we should
       # use it or not...
+      #
+      # @return [String] md5sum of the backtrace.
+      # @return [nil] if we don't have a backtrace available.
       def uniqueness_hash
         return nil if (exception.backtrace.nil? || exception.backtrace.empty?)
         Digest::MD5.hexdigest(exception.backtrace.join)
@@ -104,17 +115,24 @@ module Resque
         http
       end
 
-      # Helper method to return the correct HTTP port number.
+      # Helper method to return the correct HTTP port number, depending on
+      # if were using SSL or not.
+      #
+      # @return [Fixnum] HTTP port number.
       def http_port
         use_ssl? ? 443 : 80
       end
 
       # Helper method to check if were using SSL or not.
+      #
+      # @return [Boolean] true if ssl is enabled.
       def use_ssl?
         self.class.use_ssl || false
       end
 
       # Adds a prefix to log messages.
+      #
+      # @param [String] msg your log message.
       def log(msg)
         super("resque-exception - #{msg}")
       end
@@ -154,6 +172,5 @@ module Resque
       end
 
     end
-
   end
-end
+end

data/test/exceptional_test.rb

@@ -8,6 +8,8 @@ class ExceptionalTest < Test::Unit::TestCase
     @queue = 'test_queue'
     @payload = { 'class' => 'TestJob', 'args' => ['foo', 'bar'] }
     @failure = Resque::Failure::Exceptional.new(@exception, @worker, @queue, @payload)
+    WebMock.disable_net_connect!
+    WebMock.reset_webmock
   end
 
   # test we can build a hash to send to the api.
@@ -90,29 +92,161 @@ class ExceptionalTest < Test::Unit::TestCase
     assert_equal true, @failure.respond_to?(:save)
   end
 
-  # we need a Net::HTTP client setup to send the data.
-  def test_http_client
-    
+  # test save success.
+  def test_save_success
+    with_api_key '27810b263f0e11eef2f1d29be75d2f39' do
+      stub_request(:post, /.*api.getexceptional.com.*/)
+      @failure.save
+      assert_requested(:post, /.*api.getexceptional.com.*/)
+      assert_match /^(resque-exception).*(success).*$/, @worker.log_history.first
+    end
   end
 
-  # perform a test with the real api.
-  def test_live_fire
-    #omit 'comment this line, set your api key, test with real api!'
-    Resque::Failure::Exceptional.configure { |c| c.api_key = 'e6bee67c9a45ae41c8318e7d9a0e9d8d0dd9bc20' }
-    @failure.save
-    assert_match /^(resque-exception).*(success).*$/, @worker.log_history.first
-    # reset.
-    Resque::Failure::Exceptional.configure { |c| c.api_key = nil }
+  # test save fail.
+  def test_save_fail
+    with_api_key '27810b263f0e11eef2f1d29be75d2f39' do
+      stub_request(:post, /.*api.getexceptional.com.*/).to_return(:status => [500, 'Internal Server Error'])
+      @failure.save
+      assert_requested(:post, /.*api.getexceptional.com.*/)
+      assert_match /^(resque-exception).*(fail).*(500).*$/, @worker.log_history.first
+    end
+  end
+
+  # we need a Net::HTTP client setup to send the data.
+  def test_http_client
+    assert_kind_of Net::HTTP, @failure.http_client
   end
 
   # we should fail if the api_key is not set.
   def test_fail_if_api_key_nil
     # should already be nil, but lets just be sure...
-    Resque::Failure::Exceptional.configure { |c| c.api_key = nil }
-    @failure.save
-    assert_match /^(resque-exception).*(error).*(api_key).*$/, @worker.log_history.first
+    with_api_key nil do
+      @failure.save
+      assert_match /^(resque-exception).*(error).*(api_key).*$/, @worker.log_history.first
+    end
+  end
+
+  # test we prefix our log messages.
+  def test_log_adds_prefix
+    @failure.log('test message')
+    @failure.log('123 another msg bud!')
+    assert_match /^resque-exception - .*/, @worker.log_history.first
+    assert_match /^resque-exception - .*/, @worker.log_history.last
+  end
+
+  # test our `#use_ssl?` and `#http_port` helper methods.
+  def test_helper_methods
+    # check defaults
+    assert_equal false, @failure.use_ssl?, 'use_ssl? should default to false.'
+    assert_equal 80, @failure.http_port, 'http_port should default to 80.'
+
+    # enable ssl.
+    Resque::Failure::Exceptional.configure { |c| c.use_ssl = true }
+    assert_equal true, @failure.use_ssl?, 'use_ssl? should now be true'
+    assert_equal 443, @failure.http_port, 'http_port should now be 443.'
+
+    # put the config back.
+    Resque::Failure::Exceptional.configure { |c| c.use_ssl = false }
+  end
+
+  # returns nil if the backtrace is empty.
+  def test_uniqueness_hash_returns_nil_when_empty_backtrace
+    mock(@failure.exception).backtrace.times(any_times) { Array.new }
+    assert_equal nil, @failure.uniqueness_hash
+  end
+
+  # returns nil if the backtrace is empty.
+  def test_uniqueness_hash_returns_nil_when_nil_backtrace
+    mock(@failure.exception).backtrace.times(any_times) { nil }
+    assert_equal nil, @failure.uniqueness_hash
+  end
+
+  # uniqueness_hash builds a md5sum.
+  def test_uniqueness_hash_returns_a_md5_of_the_backtrace
+    # fake backtrace.
+    fake_backtrace = ['fake', 'backtrace', 'that_wont_change']
+    mock(@failure.exception).backtrace.times(any_times) { fake_backtrace }
+
+    assert_equal '27810b263f0e11eef2f1d29be75d2f39', @failure.uniqueness_hash
+  end
+
+  # return the HTTP path and query string with uniqueness hash.
+  def test_http_path_query
+    # fake backtrace.
+    fake_backtrace = ['fake', 'backtrace', 'that_wont_change']
+    mock(@failure.exception).backtrace.times(any_times) { fake_backtrace }
+
+    with_api_key '27810b263f0e11eef2f1d29be75d2f39' do
+      path, query = *@failure.http_path_query.split('?', 2)
+      assert_match /^api_key=27810b263f0e11eef2f1d29be75d2f39/, query, 'query should have api_key.'
+      assert_match /protocol_version=\d{1}/, query, 'query should have protocol_version.'
+      assert_match /hash=27810b263f0e11eef2f1d29be75d2f39$/, query, 'query should have a uniqueness hash.'
+    end
+  end
+
+  # build a path & query without a uniqueness hash.
+  def test_http_path_query_without_uniqueness_hash
+    # fake empty backtrace.
+    mock(@failure.exception).backtrace.times(any_times) { Array.new }
+
+    with_api_key '27810b263f0e11eef2f1d29be75d2f39' do
+      path, query = *@failure.http_path_query.split('?', 2)
+      assert_match /^api_key=27810b263f0e11eef2f1d29be75d2f39/, query, 'query should have api_key.'
+      assert_match /protocol_version=\d{1}$/, query, 'query should have protocol_version.'
+    end
+  end
+
+  # raise exception if api key is not set.
+  def test_http_path_query_without_api_key_raises_exception
+    assert_raise Resque::Failure::Exceptional::APIKeyError, 'should raise APIKeyError if api key is not set' do
+      @failure.http_path_query
+    end
+  end
+
+  # should return http response if successful.
+  def test_http_post_request
+    with_api_key '27810b263f0e11eef2f1d29be75d2f39' do
+      stub_request(:post, /.*api.getexceptional.com.*/)
+
+      response = @failure.http_post_request
+      assert_requested(:post, /.*api.getexceptional.com.*/)
+      assert_equal '200', response.code, 'should be a successful http request'
+    end
   end
 
   # should handle exceptions raised during the HTTP Post.
-  # should return and not raise anything if we were successful.
+  def test_http_post_request_handles_exceptions_and_returns_nil
+    response = @failure.http_post_request
+    assert_equal nil, @failure.http_post_request, 'should be nil, APIKeyError should have been caught.'
+
+    with_api_key '27810b263f0e11eef2f1d29be75d2f39' do
+      WebMock.reset_webmock
+      stub_request(:post, /.*api.getexceptional.com.*/).to_raise(StandardError)
+      assert_equal nil, @failure.http_post_request, 'should be nil, StandardError should have been caught.'
+      assert_requested(:post, /.*api.getexceptional.com.*/)
+    end
+  end
+
+  # make sure we catch timeout errors.
+  def test_http_post_request_timeout
+    with_api_key '27810b263f0e11eef2f1d29be75d2f39' do
+      stub_request(:post, /.*api.getexceptional.com.*/).to_timeout
+      assert_equal nil, @failure.http_post_request, 'should be nil, TimeoutError should have been caught.'
+      assert_requested(:post, /.*api.getexceptional.com.*/)
+    end
+  end
+
+  # perform a test with the real api.
+  def test_live_fire_with_real_api!
+    unless ENV['EXCEPTIONAL_API_KEY']
+      omit 'Test with the REAL API. Example: `EXCEPTIONAL_API_KEY=27810b263f0e11eef2f1d29be75d2f39 rake test`'
+    end
+
+    with_api_key ENV['EXCEPTIONAL_API_KEY'] do
+      WebMock.allow_net_connect!
+      @failure.save
+      assert_match /^(resque-exception).*(success).*$/, @worker.log_history.first
+    end
+  end
+
 end

data/test/test_helper.rb

@@ -1,22 +1,32 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/test/'
+end
+
 dir = File.dirname(File.expand_path(__FILE__))
 $LOAD_PATH.unshift dir + '/../lib'
 $TESTING = true
 
 require 'test/unit'
 require 'rubygems'
-require 'simplecov'
 require 'rr'
+require 'webmock'
+require 'webmock/test_unit'
 
-SimpleCov.start do
-  add_filter "/test/"
-end
+# require our failure backend to test.
+require 'resque-exceptional'
 
 class Test::Unit::TestCase
   include RR::Adapters::TestUnit
-end
+  include WebMock::API
 
-# require our failure backend to test.
-require 'resque-exceptional'
+  # periodicly set the api key.
+  def with_api_key(key, &block)
+    Resque::Failure::Exceptional.api_key = key
+    yield
+    Resque::Failure::Exceptional.api_key = nil
+  end
+end
 
 # fake worker.
 class FakeWorker
@@ -28,7 +38,7 @@ class FakeWorker
 
   def log(msg)
     @log_history << msg
-    p msg
+    p msg if ENV['VERBOSE']
   end
 
   def to_s

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resque-exceptional
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Luke Antins
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-13 00:00:00 +01:00
+date: 2010-10-16 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,7 +65,7 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: yard
+  name: webmock
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -79,9 +79,23 @@ dependencies:
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: simplecov
+  name: yard
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -93,7 +107,7 @@ dependencies:
         - 0
         version: 0.3.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 description: "  resque-exceptional provides a Resque failure backend that sends exceptions\n  raised by jobs to getexceptional.com.\n"
 email: luke@lividpenguin.com
 executables: []