resque-exceptional 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48421f431f10aec6b365354e1d44dd0c66272050
-  data.tar.gz: 7dee6f702e31f801708c436121ed8de4460aae9f
+  metadata.gz: 8ffbc88a8025ed460a763e49c28497a9906edb85
+  data.tar.gz: a1bd338c3a4811726d677bc2f9ec85ef1c47ae2f
 SHA512:
-  metadata.gz: 8536ba180441cd4e048fbddb1d6c422cbda6b32439e3c6a737e19d5f9bdc01d25c107f0b2b8b7334f95e1d27880cae70d2e83ce23e200a556c084d95f6189465
-  data.tar.gz: 2ad61434db9e6ab41a623d2cf93ca44fced897310d81ecc4dd84f3a6b87cd36597ff6c7414ec1e6ccc6798f7b2d19580c85ad8904c8eb1488f75cf37e05f5a50
+  metadata.gz: 1156a381b68ea151adc95fdc8c5a74a4191f5c059bad76254cde8d40b84e0e23a891cf9d89c05b4406cb67c7e270e2403d97cb085f9cd183ed7eea77dc97a3f0
+  data.tar.gz: 1e9d27a6030d5d6864aec7114ec95ef94d0d390e708b690b571593bd5f944b99358b3e16d62ab199a235dad4ba828204faadf6280a563104e2c30db7e340e58c

data/HISTORY.md

@@ -1,3 +1,8 @@
+## 0.2.2 (2014-02-21)
+
+* Add `deliver?` helper method.
+* Improve tests and ensure they are not order order.
+
 ## 0.2.1 (2014-02-21)
 
 * Add `deliver` config option; `false` will disable delivery, good for tests.

data/README.md

@@ -53,6 +53,10 @@ Configuration Options
 
   * `api_key` - your getexceptional.com api key.
 
+**General Options** *(optional)*
+
+  * `deliver` - set `false` to disable delivery of errors to exceptional API, handy for testing (default: `true`)
+
 **HTTP Proxy Options** *(optional)*
 
   * `proxy_host` - proxy server ip / hostname.
@@ -66,18 +70,6 @@ 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
 -----------------------------
 

data/lib/resque/failure/exceptional.rb

@@ -2,7 +2,7 @@ module Resque
   module Failure
     # A Resque failure backend that sends exception data to getexceptional.com
     class Exceptional < Base
-      Version = '0.2.1' # Failure backend version number.
+      Version = '0.2.2' # Failure backend version number.
 
       # Raised if the api_key is not set.
       class APIKeyError < StandardError
@@ -34,7 +34,7 @@ module Resque
       #
       # When a job fails, a new instance is created and #save is called.
       def save
-        return nil if self.class.deliver === false
+        return unless deliver?
         return unless response = http_post_request
 
         if response.code == '200'
@@ -132,6 +132,13 @@ module Resque
         self.class.use_ssl || false
       end
 
+      # Helper method to check if errors should be submitted to exceptional API.
+      #
+      # @return [Boolean] true if deliver is enabled.
+      def deliver?
+        self.class.deliver.nil? || self.class.deliver
+      end
+
       # Adds a prefix to log messages.
       #
       # @param [String] msg your log message.

data/test/exceptional_test.rb

@@ -69,6 +69,7 @@ class ExceptionalTest < Minitest::Test
   def test_configure
     Resque::Failure::Exceptional.configure do |config|
       config.api_key = 'my api key.'
+      config.deliver = false
       # everything below are http client options.
       config.proxy_host = 'host.name.com'
       config.proxy_port = 8080
@@ -81,8 +82,8 @@ class ExceptionalTest < Minitest::Test
 
     # reset everything to nil...
     Resque::Failure::Exceptional.configure do |config|
-      options = %w{api_key proxy_host proxy_port proxy_user proxy_pass use_ssl
-                   http_open_timeout http_read_timeout}
+      options = %w{api_key deliver proxy_host proxy_port proxy_user proxy_pass
+                   use_ssl http_open_timeout http_read_timeout}
       options.each { |opt| config.send("#{opt}=", nil) }
     end
   end
@@ -117,9 +118,8 @@ class ExceptionalTest < Minitest::Test
     with_api_key '27810b263f0e11eef2f1d29be75d2f39' do
       # turn off delivery.
       Resque::Failure::Exceptional.configure { |c| c.deliver = false }
-      stub_request(:post, /.*api.exceptional.io.*/)
       @failure.save
-      assert_equal(0, @worker.log_history.length)
+      assert_equal 0, @worker.log_history.length, 'should not send any requests'
 
       # Put default setting back in place.
       Resque::Failure::Exceptional.configure { |c| c.deliver = nil }
@@ -148,19 +148,25 @@ class ExceptionalTest < Minitest::Test
     assert_match /^resque-exception - .*/, @worker.log_history.last
   end
 
-  # test our `#use_ssl?` and `#http_port` helper methods.
+  # test our `#use_ssl?`, `deliver?` 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 }
+    # disable ssl.
+    Resque::Failure::Exceptional.configure { |c| c.use_ssl = nil }
+    assert_equal false, @failure.use_ssl?, 'use_ssl? should default to false.'
+    assert_equal 80, @failure.http_port, 'http_port should default to 80.'
+
+    # disable delivery.
+    Resque::Failure::Exceptional.configure { |c| c.deliver = false }
+    assert_equal false, @failure.deliver?, 'deliver should now be false'
+
+    # enable delivery.
+    Resque::Failure::Exceptional.configure { |c| c.deliver = nil }
+    assert_equal true, @failure.deliver?, 'deliver should now be true'
   end
 
   # returns nil if the backtrace is empty.
@@ -212,8 +218,10 @@ class ExceptionalTest < Minitest::Test
 
   # raise exception if api key is not set.
   def test_http_path_query_without_api_key_raises_exception
-    assert_raises Resque::Failure::Exceptional::APIKeyError, 'should raise APIKeyError if api key is not set' do
-      @failure.http_path_query
+    with_api_key nil do
+      assert_raises Resque::Failure::Exceptional::APIKeyError, 'should raise APIKeyError if api key is not set' do
+        @failure.http_path_query
+      end
     end
   end
 
@@ -263,4 +271,4 @@ class ExceptionalTest < Minitest::Test
     end
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-exceptional
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Luke Antins