pusher 0.7.1 → 0.8.0

data/README.md

@@ -10,13 +10,25 @@ After registering at <http://pusherapp.com> configure your app with the security
     Pusher.key = 'your-pusher-key'
     Pusher.secret = 'your-pusher-secret'
 
-Trigger an event. Channel and event names may only contain alphanumeric characters, '-' and '_'.
+Trigger an event
 
-    Pusher['a_channel'].trigger('an_event', {:some => 'data'})
+    Pusher['a_channel'].trigger!('an_event', {:some => 'data'})
+
+Handle errors by rescuing `Pusher::Error` (all Pusher errors are descendants of this error)
+
+    begin
+      Pusher['a_channel'].trigger!('an_event', {:some => 'data'})
+    rescue Pusher::Error => e
+      # (Pusher::AuthenticationError, Pusher::HTTPError, or Pusher::Error)
+    end
 
-Optionally a socket id may be provided. This will prevent the event from being triggered on this specific socket id (see <http://pusherapp.com/docs/duplicates> for more info).
+Optionally a socket id may be provided. This will exclude the event from being triggered on this socket id (see <http://pusherapp.com/docs/duplicates> for more info).
 
-    Pusher['a_channel'].trigger('an_event', {:some => 'data'}, socket_id)
+    Pusher['a_channel'].trigger!('an_event', {:some => 'data'}, socket_id)
+
+If you don't need to handle failure cases, then you can simply use the `trigger` method, which will rescue and log any errors for you
+
+    Pusher['a_channel'].trigger('an_event', {:some => 'data'})
 
 Logging
 -------

data/lib/pusher.rb

@@ -16,6 +16,7 @@ module Pusher
   class Error < RuntimeError; end
   class AuthenticationError < Error; end
   class ConfigurationError < Error; end
+  class HTTPError < Error; attr_accessor :original_error; end
 
   class << self
     attr_accessor :scheme, :host, :port

data/lib/pusher/channel.rb

@@ -85,10 +85,19 @@ module Pusher
 
       request = Pusher::Request.new(@uri, event_name, data, socket_id)
 
-      response = @http_sync.post("#{@uri.path}?#{request.query.to_params}",
-        request.body, { 'Content-Type'=> 'application/json' })
+      begin
+        response = @http_sync.post("#{@uri.path}?#{request.query.to_params}",
+          request.body, { 'Content-Type'=> 'application/json' })
+      rescue Errno::EINVAL, Errno::ECONNRESET, Errno::ECONNREFUSED,
+             Timeout::Error, EOFError,
+             Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+             Net::ProtocolError => e
+        error = Pusher::HTTPError.new("#{e.message} (#{e.class})")
+        error.original_error = e
+        raise error
+      end
 
-      handle_response(response.code.to_i, response.body.chomp)
+      return handle_response(response.code.to_i, response.body.chomp)
     end
 
     # Trigger event, catching and logging any errors.
@@ -98,7 +107,7 @@ module Pusher
     #
     def trigger(event_name, data, socket_id = nil)
       trigger!(event_name, data, socket_id)
-    rescue StandardError => e
+    rescue Pusher::Error => e
       Pusher.logger.error("#{e.message} (#{e.class})")
       Pusher.logger.debug(e.backtrace.join("\n"))
     end

data/pusher.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "pusher"
-  s.version     = "0.7.1"
+  s.version     = "0.8.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["New Bamboo"]
   s.email       = ["support@pusherapp.com"]

data/spec/channel_spec.rb

@@ -8,6 +8,11 @@ describe Pusher::Channel do
     Pusher.host = 'api.pusherapp.com'
     Pusher.port = 80
     Pusher.encrypted = false
+
+    WebMock.reset!
+    WebMock.disable_net_connect!
+
+    @pusher_url_regexp = %r{/apps/20/channels/test_channel/events}
   end
 
   after do
@@ -18,10 +23,8 @@ describe Pusher::Channel do
   
   describe 'trigger!' do
     before :each do
-      WebMock.disable_net_connect!
-      WebMock.stub_request(
-        :post, %r{/apps/20/channels/test_channel/events}
-      ).to_return(:status => 202)
+      WebMock.stub_request(:post, @pusher_url_regexp).
+        to_return(:status => 202)
       @channel = Pusher['test_channel']
     end
 
@@ -71,13 +74,20 @@ describe Pusher::Channel do
       }.should raise_error(JSON::GeneratorError)
     end
 
-    it "should propagate exception if exception raised" do
+    it "should catch all Net::HTTP exceptions and raise a Pusher::HTTPError, exposing the original error if required" do
       WebMock.stub_request(
         :post, %r{/apps/20/channels/test_channel/events}
-      ).to_raise(RuntimeError)
-      lambda {
+      ).to_raise(Timeout::Error)
+
+      error_raised = nil
+      begin
         Pusher['test_channel'].trigger!('new_event', 'Some data')
-      }.should raise_error(RuntimeError)
+      rescue => e
+        error_raised = e
+      end
+      error_raised.class.should == Pusher::HTTPError
+      error_raised.message.should == 'Exception from WebMock (Timeout::Error)'
+      error_raised.original_error.class.should == Timeout::Error
     end
 
     it "should raise AuthenticationError if pusher returns 401" do
@@ -110,34 +120,23 @@ describe Pusher::Channel do
   end
 
   describe 'trigger' do
-    before :each do
-      @http = mock('HTTP', :post => 'posting')
-      Net::HTTP.stub!(:new).and_return @http
-    end
-
-    it "should log failure if exception raised" do
-      @http.should_receive(:post).and_raise("Fail")
-      Pusher.logger.should_receive(:error).with("Fail (RuntimeError)")
+    it "should log failure if error raised in Net::HTTP call" do
+      stub_request(:post, @pusher_url_regexp).to_raise(Net::HTTPBadResponse)
+      Pusher.logger.should_receive(:error).with("Exception from WebMock (Net::HTTPBadResponse) (Pusher::HTTPError)")
       Pusher.logger.should_receive(:debug) #backtrace
       Pusher::Channel.new(Pusher.url, 'test_channel').trigger('new_event', 'Some data')
     end
 
-    it "should log failure if exception raised" do
-      @http.should_receive(:post).and_raise("Fail")
-      Pusher.logger.should_receive(:error).with("Fail (RuntimeError)")
+    it "should log failure if Pusher returns an error response" do
+      stub_request(:post, @pusher_url_regexp).to_return(:status => 401)
+      # @http.should_receive(:post).and_raise(Net::HTTPBadResponse)
+      Pusher.logger.should_receive(:error).with(" (Pusher::AuthenticationError)")
       Pusher.logger.should_receive(:debug) #backtrace
       Pusher::Channel.new(Pusher.url, 'test_channel').trigger('new_event', 'Some data')
     end
   end
 
   describe "trigger_async" do
-    before :each do
-      WebMock.reset!
-      WebMock.disable_net_connect!
-
-      @pusher_url_regexp = %r{/apps/20/channels/test_channel/events}
-    end
-
     it "should by default POST to http api" do
       EM.run {
         stub_request(:post, @pusher_url_regexp).to_return(:status => 202)

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 7
-  - 1
-  version: 0.7.1
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - New Bamboo