pusher 0.4.2 → 0.4.3

data/README.md

@@ -25,6 +25,19 @@ Errors are logged to `Pusher.logger`. It will by default use `Logger` from stdli
 
     Pusher.logger = Rails.logger
 
+Asynchronous triggering
+-----------------------
+
+To avoid blocking in a typical web application, if you are running inside eventmachine (for example if you use the thin server), you may wish to use the `trigger_async` method which uses the em-http-request gem to make api requests to pusher. It returns a deferrable which you can optionally bind to with success and failure callbacks. This is not a gem dependency, so you will need to install it manually.
+
+    d = Pusher['a_channel'].trigger('an_event', {:some => 'data'}, socket_id)
+    d.callback {
+      # Do something on success
+    }
+    d.errback { |error|
+      # error is a pusher exception
+    }
+
 Copyright
 ---------
 

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.4.3

data/lib/pusher.rb

@@ -1,7 +1,3 @@
-require 'json'
-require 'uri'
-require 'net/http'
-
 autoload 'Logger', 'logger'
 
 module Pusher

data/lib/pusher/channel.rb

@@ -1,6 +1,9 @@
 require 'crack/core_extensions' # Used for Hash#to_params
 require 'digest/md5'
 
+require 'json'
+require 'uri'
+
 module Pusher
   class Channel
     def initialize(app_id, name)
@@ -9,48 +12,51 @@ module Pusher
         :port => Pusher.port,
         :path => "/apps/#{app_id}/channels/#{name}/events"
       })
-      @http = Net::HTTP.new(@uri.host, @uri.port)
     end
 
-    def trigger!(event_name, data, socket_id = nil)
-      params = {
-        :name => event_name,
-      }
-      params[:socket_id] = socket_id if socket_id
-
-      body = case data
-      when String
-        data
-      else
+    def trigger_async(event_name, data, socket_id = nil, &block)
+      unless defined?(EventMachine) && EventMachine.reactor_running?
+        raise Error, "In order to use trigger_async you must be running inside an eventmachine loop"
+      end
+      require 'em-http' unless defined?(EventMachine::HttpRequest)
+      
+      @http_async ||= EventMachine::HttpRequest.new(@uri)
+      
+      query, body = construct_request(event_name, data, socket_id)
+      
+      deferrable = EM::DefaultDeferrable.new
+      
+      http = @http_async.post({
+        :query => query, :timeout => 2, :body => body
+      })
+      http.callback {
         begin
-          self.class.turn_into_json(data)
+          handle_response(http.response_header.status, http.response.chomp)
+          deferrable.succeed
         rescue => e
-          Pusher.logger.error("Could not convert #{data.inspect} into JSON")
-          raise e
+          deferrable.fail(e)
         end
-      end
-      params[:body_md5] = Digest::MD5.hexdigest(body)
-
-      request = Authentication::Request.new('POST', @uri.path, params)
-      auth_hash = request.sign(Pusher.authentication_token)
+      }
+      http.errback {
+        Pusher.logger.debug("Network error connecting to pusher: #{http.inspect}")
+        deferrable.fail(Error.new("Network error connecting to pusher"))
+      }
+      
+      deferrable
+    end
 
-      query_params = params.merge(auth_hash)
-      @uri.query = query_params.to_params
+    def trigger!(event_name, data, socket_id = nil)
+      require 'net/http' unless defined?(Net::HTTP)
 
-      response = @http.post("#{@uri.path}?#{@uri.query}", body, {
+      @http_sync ||= Net::HTTP.new(@uri.host, @uri.port)
+      
+      query, body = construct_request(event_name, data, socket_id)
+      
+      response = @http_sync.post("#{@uri.path}?#{query.to_params}", body, {
         'Content-Type'=> 'application/json'
       })
 
-      case response.code
-      when "202"
-        return true
-      when "401"
-        raise AuthenticationError, response.body.chomp
-      when "404"
-        raise Error, "Resource not found: app_id is probably invalid"
-      else
-        raise Error, "Unknown error in Pusher: #{response.body.chomp}"
-      end
+      handle_response(response.code.to_i, response.body.chomp)
     end
 
     def trigger(event_name, data, socket_id = nil)
@@ -73,5 +79,47 @@ module Pusher
       Pusher.logger.error("#{e.message} (#{e.class})")
       Pusher.logger.debug(e.backtrace.join("\n"))
     end
+    
+    def construct_request(event_name, data, socket_id)
+      params = {
+        :name => event_name,
+      }
+      params[:socket_id] = socket_id if socket_id
+
+      body = case data
+      when String
+        data
+      else
+        begin
+          self.class.turn_into_json(data)
+        rescue => e
+          Pusher.logger.error("Could not convert #{data.inspect} into JSON")
+          raise e
+        end
+      end
+      params[:body_md5] = Digest::MD5.hexdigest(body)
+
+      request = Authentication::Request.new('POST', @uri.path, params)
+      auth_hash = request.sign(Pusher.authentication_token)
+
+      query_params = params.merge(auth_hash)
+      
+      return query_params, body
+    end
+    
+    def handle_response(status_code, body)
+      case status_code
+      when 202
+        return true
+      when 400
+        raise Error, "Bad request: #{body}"
+      when 401
+        raise AuthenticationError, body
+      when 404
+        raise Error, "Resource not found: app_id is probably invalid"
+      else
+        raise Error, "Unknown error in Pusher: #{body}"
+      end
+    end
   end
 end

data/pusher.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pusher}
-  s.version = "0.4.2"
+  s.version = "0.4.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["New Bamboo"]
-  s.date = %q{2010-05-05}
+  s.date = %q{2010-05-11}
   s.description = %q{Wrapper for pusherapp.com REST api}
   s.email = %q{support@pusherapp.com}
   s.extra_rdoc_files = [

data/spec/pusher_spec.rb

@@ -1,6 +1,8 @@
 require File.expand_path('../spec_helper', __FILE__)
 
 require 'webmock/rspec'
+require 'em-http'
+require 'em-http/mock'
 
 describe Pusher do
   describe 'configuration' do
@@ -166,5 +168,98 @@ describe Pusher do
         Pusher['test_channel'].trigger('new_event', 'Some data')
       end
     end
+
+    describe "Channgel#trigger_async" do
+      #in order to match URLs when testing http requests
+      #override the method that converts query hash to string
+      #to include a sort so URL is consistent
+      module EventMachine
+        module HttpEncoding
+                  def encode_query(path, query, uri_query)
+            encoded_query = if query.kind_of?(Hash)
+              query.sort{|a, b| a.to_s <=> b.to_s}.
+              map { |k, v| encode_param(k, v) }.
+              join('&')
+            else
+              query.to_s
+            end
+            if !uri_query.to_s.empty?
+              encoded_query = [encoded_query, uri_query].reject {|part| part.empty?}.join("&")
+            end
+            return path if encoded_query.to_s.empty?
+            "#{path}?#{encoded_query}"
+          end
+        end
+      end
+      
+      before :each do
+        EM::HttpRequest = EM::MockHttpRequest
+        EM::HttpRequest.reset_registry!
+        EM::HttpRequest.reset_counts!
+        EM::HttpRequest.pass_through_requests = false
+      end
+
+      it "should return a deferrable which succeeds in success case" do
+        # Yeah, mocking EM::MockHttpRequest isn't that feature rich :)
+        Time.stub(:now).and_return(123)
+
+        url = 'http://api.pusherapp.com:80/apps/20/channels/test_channel/events?auth_key=12345678900000001&auth_signature=0ffe2a3749f886ca69c3f516a30c7bc9a12d2ebd8bda5b718b90ad58507c8261&auth_timestamp=123&auth_version=1.0&body_md5=5b82f8bf4df2bfb0e66ccaa7306fd024&name=new_event'
+
+        data = <<-RESPONSE.gsub(/^ +/, '')
+          HTTP/1.1 202 Accepted
+          Content-Type: text/html
+          Content-Length: 13
+          Connection: keep-alive
+          Server: thin 1.2.7 codename No Hup
+
+          202 ACCEPTED
+        RESPONSE
+
+        EM::HttpRequest.register(url, :post, data)
+
+        EM.run {
+          d = Pusher['test_channel'].trigger_async('new_event', 'Some data')
+          d.callback {
+            EM::HttpRequest.count(url, :post).should == 1
+            EM.stop
+          }
+          d.errback {
+            fail
+            EM.stop
+          }
+        }
+      end
+
+      it "should return a deferrable which fails (with exception) in fail case" do
+        # Yeah, mocking EM::MockHttpRequest isn't that feature rich :)
+        Time.stub(:now).and_return(123)
+
+        url = 'http://api.pusherapp.com:80/apps/20/channels/test_channel/events?auth_key=12345678900000001&auth_signature=0ffe2a3749f886ca69c3f516a30c7bc9a12d2ebd8bda5b718b90ad58507c8261&auth_timestamp=123&auth_version=1.0&body_md5=5b82f8bf4df2bfb0e66ccaa7306fd024&name=new_event'
+
+        data = <<-RESPONSE.gsub(/^ +/, '')
+          HTTP/1.1 401 Unauthorized
+          Content-Type: text/html
+          Content-Length: 130
+          Connection: keep-alive
+          Server: thin 1.2.7 codename No Hup
+
+          401 UNAUTHORIZED: Timestamp expired: Given timestamp (2010-05-05T11:24:42Z) not within 600s of server time (2010-05-05T11:51:42Z)
+        RESPONSE
+
+        EM::HttpRequest.register(url, :post, data)
+
+        EM.run {
+          d = Pusher['test_channel'].trigger_async('new_event', 'Some data')
+          d.callback {
+            fail
+          }
+          d.errback { |error|
+            EM::HttpRequest.count(url, :post).should == 1
+            error.should be_kind_of(Pusher::AuthenticationError)
+            EM.stop
+          }
+        }
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'pusher'
+require 'eventmachine'
 
 Spec::Runner.configure do |config|
   

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 2
-  version: 0.4.2
+  - 3
+  version: 0.4.3
 platform: ruby
 authors: 
 - New Bamboo
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-05 00:00:00 +01:00
+date: 2010-05-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency