pusher 0.4.3 → 0.5.0

data/README.md

@@ -30,7 +30,7 @@ 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 = Pusher['a_channel'].trigger_async('an_event', {:some => 'data'}, socket_id)
     d.callback {
       # Do something on success
     }

data/Rakefile

@@ -14,6 +14,7 @@ begin
     gem.add_dependency "json"
     gem.add_dependency "crack"
     gem.add_dependency "ruby-hmac"
+    gem.add_dependency 'signature'
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "webmock"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.5.0

data/lib/pusher.rb

@@ -18,7 +18,7 @@ module Pusher
     end
     
     def authentication_token
-      Authentication::Token.new(@key, @secret)
+      Signature::Token.new(@key, @secret)
     end
   end
 
@@ -36,4 +36,4 @@ module Pusher
 end
 
 require 'pusher/channel'
-require 'pusher/authentication'
+require 'pusher/request'

data/lib/pusher/channel.rb

@@ -1,12 +1,17 @@
 require 'crack/core_extensions' # Used for Hash#to_params
+require 'signature'
 require 'digest/md5'
+require 'hmac-sha2'
 
 require 'json'
 require 'uri'
 
 module Pusher
   class Channel
+    attr_reader :name
+
     def initialize(app_id, name)
+      @name = name
       @uri = URI::HTTP.build({
         :host => Pusher.host,
         :port => Pusher.port,
@@ -21,13 +26,13 @@ module Pusher
       require 'em-http' unless defined?(EventMachine::HttpRequest)
       
       @http_async ||= EventMachine::HttpRequest.new(@uri)
-      
-      query, body = construct_request(event_name, data, socket_id)
-      
+
+      request = Pusher::Request.new(@uri, event_name, data, socket_id)
+
       deferrable = EM::DefaultDeferrable.new
       
       http = @http_async.post({
-        :query => query, :timeout => 2, :body => body
+        :query => request.query, :timeout => 2, :body => request.body
       })
       http.callback {
         begin
@@ -49,12 +54,11 @@ module Pusher
       require 'net/http' unless defined?(Net::HTTP)
 
       @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'
-      })
+
+      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' })
 
       handle_response(response.code.to_i, response.body.chomp)
     end
@@ -65,12 +69,15 @@ module Pusher
       handle_error e
     end
 
-    def self.turn_into_json(data)
-      if Object.const_defined?('ActiveSupport')
-        data.to_json
-      else
-        JSON.generate(data)
-      end
+    def socket_auth(socket_id)
+      raise "Invalid socket_id" if socket_id.nil? || socket_id.empty?
+
+      string_to_sign = "#{socket_id}:#{name}"
+      Pusher.logger.debug "Signing #{string_to_sign}"
+      token = Pusher.authentication_token
+      signature = HMAC::SHA256.hexdigest(token.secret, string_to_sign)
+
+      return "#{token.key}:#{signature}"
     end
 
     private
@@ -79,34 +86,7 @@ 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

data/lib/pusher/request.rb

@@ -0,0 +1,38 @@
+module Pusher
+  class Request
+    attr_reader :body, :query
+
+    def initialize(resource, event_name, data, socket_id, token = nil)
+      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 = Signature::Request.new('POST', resource.path, params)
+      auth_hash = request.sign(token || Pusher.authentication_token)
+
+      @query = params.merge(auth_hash)
+    end
+
+    def self.turn_into_json(data)
+      if Object.const_defined?('ActiveSupport')
+        data.to_json
+      else
+        JSON.generate(data)
+      end
+    end
+  end
+end

data/pusher.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pusher}
-  s.version = "0.4.3"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["New Bamboo"]
-  s.date = %q{2010-05-11}
+  s.date = %q{2010-05-14}
   s.description = %q{Wrapper for pusherapp.com REST api}
   s.email = %q{support@pusherapp.com}
   s.extra_rdoc_files = [
@@ -24,10 +24,9 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/pusher.rb",
-     "lib/pusher/authentication.rb",
      "lib/pusher/channel.rb",
+     "lib/pusher/request.rb",
      "pusher.gemspec",
-     "spec/authentication_spec.rb",
      "spec/pusher_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -38,8 +37,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Pusher App client}
   s.test_files = [
-    "spec/authentication_spec.rb",
-     "spec/pusher_spec.rb",
+    "spec/pusher_spec.rb",
      "spec/spec_helper.rb"
   ]
 
@@ -51,12 +49,14 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_runtime_dependency(%q<crack>, [">= 0"])
       s.add_runtime_dependency(%q<ruby-hmac>, [">= 0"])
+      s.add_runtime_dependency(%q<signature>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<webmock>, [">= 0"])
     else
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<crack>, [">= 0"])
       s.add_dependency(%q<ruby-hmac>, [">= 0"])
+      s.add_dependency(%q<signature>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<webmock>, [">= 0"])
     end
@@ -64,6 +64,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<crack>, [">= 0"])
     s.add_dependency(%q<ruby-hmac>, [">= 0"])
+    s.add_dependency(%q<signature>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<webmock>, [">= 0"])
   end

data/spec/pusher_spec.rb

@@ -169,7 +169,7 @@ describe Pusher do
       end
     end
 
-    describe "Channgel#trigger_async" do
+    describe "Channel#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
@@ -261,5 +261,25 @@ describe Pusher do
         }
       end
     end
+
+    describe "Channel#socket_auth" do
+      before :each do
+        @channel = Pusher['test_channel']
+      end
+
+      it "should return an authentication string given a socket id" do
+        auth = @channel.socket_auth('socketid')
+
+        auth.should == '12345678900000001:827076f551e22451357939e4c7bb1200de29f921d5bf80b40d71668f9cd61c40'
+      end
+
+      it "should raise error if authentication is invalid" do
+        [nil, ''].each do |invalid|
+          lambda {
+            @channel.socket_auth(invalid)
+          }.should raise_error
+        end
+      end
+    end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 3
-  version: 0.4.3
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - New Bamboo
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-11 00:00:00 +01:00
+date: 2010-05-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,9 +54,21 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: signature
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -66,11 +78,11 @@ dependencies:
         - 9
         version: 1.2.9
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: webmock
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -78,7 +90,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 description: Wrapper for pusherapp.com REST api
 email: support@pusherapp.com
 executables: []
@@ -96,10 +108,9 @@ files:
 - Rakefile
 - VERSION
 - lib/pusher.rb
-- lib/pusher/authentication.rb
 - lib/pusher/channel.rb
+- lib/pusher/request.rb
 - pusher.gemspec
-- spec/authentication_spec.rb
 - spec/pusher_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -134,6 +145,5 @@ signing_key:
 specification_version: 3
 summary: Pusher App client
 test_files: 
-- spec/authentication_spec.rb
 - spec/pusher_spec.rb
 - spec/spec_helper.rb

data/lib/pusher/authentication.rb

@@ -1,142 +0,0 @@
-require 'hmac-sha2'
-require 'base64'
-
-module Authentication
-  class AuthenticationError < RuntimeError; end
-
-  class Token
-    attr_reader :key, :secret
-
-    def initialize(key, secret)
-      @key, @secret = key, secret
-    end
-
-    def sign(request)
-      request.sign(self)
-    end
-  end
-
-  class Request
-    attr_accessor :path, :query_hash
-
-    # http://www.w3.org/TR/NOTE-datetime
-    ISO8601 = "%Y-%m-%dT%H:%M:%SZ"
-
-    def initialize(method, path, query)
-      raise ArgumentError, "Expected string" unless path.kind_of?(String)
-      raise ArgumentError, "Expected hash" unless query.kind_of?(Hash)
-
-      query_hash = {}
-      auth_hash = {}
-      query.each do |key, v|
-        k = key.to_s.downcase
-        k[0..4] == 'auth_' ? auth_hash[k] = v : query_hash[k] = v
-      end
-
-      @method = method.upcase
-      @path, @query_hash, @auth_hash = path, query_hash, auth_hash
-    end
-
-    def sign(token)
-      @auth_hash = {
-        :auth_version => "1.0",
-        :auth_key => token.key,
-        :auth_timestamp => Time.now.to_i
-      }
-
-      @auth_hash[:auth_signature] = signature(token)
-
-      return @auth_hash
-    end
-
-    # Authenticates the request with a token
-    #
-    # Timestamp check: Unless timestamp_grace is set to nil (which will skip
-    # the timestamp check), an exception will be raised if timestamp is not
-    # supplied or if the timestamp provided is not within timestamp_grace of
-    # the real time (defaults to 10 minutes)
-    #
-    # Signature check: Raises an exception if the signature does not match the
-    # computed value
-    #
-    def authenticate_by_token!(token, timestamp_grace = 600)
-      validate_version!
-      validate_timestamp!(timestamp_grace)
-      validate_signature!(token)
-      true
-    end
-
-    def authenticate_by_token(token, timestamp_grace = 600)
-      authenticate_by_token!(token, timestamp_grace)
-    rescue AuthenticationError
-      false
-    end
-
-    def authenticate(timestamp_grace = 600, &block)
-      key = @auth_hash['auth_key']
-      raise AuthenticationError, "Authentication key required" unless key
-      token = yield key
-      unless token && token.secret
-        raise AuthenticationError, "Invalid authentication key"
-      end
-      authenticate_by_token!(token, timestamp_grace)
-      return token
-    end
-
-    def auth_hash
-      raise "Request not signed" unless @auth_hash && @auth_hash[:auth_signature]
-      @auth_hash
-    end
-
-    private
-
-      def signature(token)
-        HMAC::SHA256.hexdigest(token.secret, string_to_sign)
-      end
-
-      def string_to_sign
-        [@method, @path, parameter_string].join("\n")
-      end
-
-      def parameter_string
-        param_hash = @query_hash.merge(@auth_hash || {})
-
-        # Convert keys to lowercase strings
-        hash = {}; param_hash.each { |k,v| hash[k.to_s.downcase] = v }
-
-        # Exclude signature from signature generation!
-        hash.delete("auth_signature")
-
-        hash.keys.sort.map { |k| "#{k}=#{hash[k]}" }.join("&")
-      end
-
-      def validate_version!
-        version = @auth_hash["auth_version"]
-        raise AuthenticationError, "Version required" unless version
-        raise AuthenticationError, "Version not supported" unless version == '1.0'
-      end
-
-      def validate_timestamp!(grace)
-        return true if grace.nil?
-
-        timestamp = @auth_hash["auth_timestamp"]
-        error = (timestamp.to_i - Time.now.to_i).abs
-        raise AuthenticationError, "Timestamp required" unless timestamp
-        if error >= grace
-          raise AuthenticationError, "Timestamp expired: Given timestamp "\
-            "(#{Time.at(timestamp.to_i).utc.strftime(ISO8601)}) "\
-            "not within #{grace}s of server time "\
-            "(#{Time.now.utc.strftime(ISO8601)})"
-        end
-        return true
-      end
-
-      def validate_signature!(token)
-        unless @auth_hash["auth_signature"] == signature(token)
-          raise AuthenticationError, "Invalid signature: you should have "\
-            "sent HmacSHA256Hex(#{string_to_sign.inspect}, your_secret_key)"
-        end
-        return true
-      end
-  end
-end

data/spec/authentication_spec.rb

@@ -1,176 +0,0 @@
-require File.expand_path('../spec_helper', __FILE__)
-
-describe Authentication do
-  before :each do
-    Time.stub!(:now).and_return(Time.at(1234))
-
-    @token = Authentication::Token.new('key', 'secret')
-
-    @request = Authentication::Request.new('POST', '/some/path', {
-      "query" => "params",
-      "go" => "here"
-    })
-    @signature = @request.sign(@token)[:auth_signature]
-  end
-
-  it "should generate base64 encoded signature from correct key" do
-    @request.send(:string_to_sign).should == "POST\n/some/path\nauth_key=key&auth_timestamp=1234&auth_version=1.0&go=here&query=params"
-    @signature.should == '3b237953a5ba6619875cbb2a2d43e8da9ef5824e8a2c689f6284ac85bc1ea0db'
-  end
-
-  it "should make auth_hash available after request is signed" do
-    request = Authentication::Request.new('POST', '/some/path', {
-      "query" => "params"
-    })
-    lambda {
-      request.auth_hash
-    }.should raise_error('Request not signed')
-
-    request.sign(@token)
-    request.auth_hash.should == {
-      :auth_signature => "da078fcedd72941b6c873caa40d0d6b2000ebfc700cee802b128dd20f72e74e9",
-      :auth_version => "1.0",
-      :auth_key => "key",
-      :auth_timestamp => 1234
-    }
-  end
-
-  it "should cope with symbol keys" do
-    @request.query_hash = {
-      :query => "params",
-      :go => "here"
-    }
-    @request.sign(@token)[:auth_signature].should == @signature
-  end
-
-  it "should cope with upcase keys (keys are lowercased before signing)" do
-    @request.query_hash = {
-      "Query" => "params",
-      "GO" => "here"
-    }
-    @request.sign(@token)[:auth_signature].should == @signature
-  end
-
-  it "should use the path to generate signature" do
-    @request.path = '/some/other/path'
-    @request.sign(@token)[:auth_signature].should_not == @signature
-  end
-
-  it "should use the query string keys to generate signature" do
-    @request.query_hash = {
-      "other" => "query"
-    }
-    @request.sign(@token)[:auth_signature].should_not == @signature
-  end
-
-  it "should use the query string values to generate signature" do
-    @request.query_hash = {
-      "key" => "notfoo",
-      "other" => 'bar'
-    }
-    @request.sign(@token)[:signature].should_not == @signature
-  end
-
-  describe "verification" do
-    before :each do
-      Time.stub!(:now).and_return(Time.at(1234))
-      @request.sign(@token)
-      @params = @request.query_hash.merge(@request.auth_hash)
-    end
-
-    it "should verify requests" do
-      request = Authentication::Request.new('POST', '/some/path', @params)
-      request.authenticate_by_token(@token).should == true
-    end
-
-    it "should raise error if signature is not correct" do
-      @params[:auth_signature] =  'asdf'
-      request = Authentication::Request.new('POST', '/some/path', @params)
-      lambda {
-        request.authenticate_by_token!(@token)
-      }.should raise_error('Invalid signature: you should have sent HmacSHA256Hex("POST\n/some/path\nauth_key=key&auth_timestamp=1234&auth_version=1.0&go=here&query=params", your_secret_key)')
-    end
-
-    it "should raise error if timestamp not available" do
-      @params.delete(:auth_timestamp)
-      request = Authentication::Request.new('POST', '/some/path', @params)
-      lambda {
-        request.authenticate_by_token!(@token)
-      }.should raise_error('Timestamp required')
-    end
-
-    it "should raise error if timestamp has expired (default of 600s)" do
-      request = Authentication::Request.new('POST', '/some/path', @params)
-      Time.stub!(:now).and_return(Time.at(1234 + 599))
-      request.authenticate_by_token!(@token).should == true
-      Time.stub!(:now).and_return(Time.at(1234 - 599))
-      request.authenticate_by_token!(@token).should == true
-      Time.stub!(:now).and_return(Time.at(1234 + 600))
-      lambda {
-        request.authenticate_by_token!(@token)
-      }.should raise_error("Timestamp expired: Given timestamp (1970-01-01T00:20:34Z) not within 600s of server time (1970-01-01T00:30:34Z)")
-      Time.stub!(:now).and_return(Time.at(1234 - 600))
-      lambda {
-        request.authenticate_by_token!(@token)
-      }.should raise_error("Timestamp expired: Given timestamp (1970-01-01T00:20:34Z) not within 600s of server time (1970-01-01T00:10:34Z)")
-    end
-
-    it "should be possible to customize the timeout grace period" do
-      grace = 10
-      request = Authentication::Request.new('POST', '/some/path', @params)
-      Time.stub!(:now).and_return(Time.at(1234 + grace - 1))
-      request.authenticate_by_token!(@token, grace).should == true
-      Time.stub!(:now).and_return(Time.at(1234 + grace))
-      lambda {
-        request.authenticate_by_token!(@token, grace)
-      }.should raise_error("Timestamp expired: Given timestamp (1970-01-01T00:20:34Z) not within 10s of server time (1970-01-01T00:20:44Z)")
-    end
-
-    it "should be possible to skip timestamp check by passing nil" do
-      request = Authentication::Request.new('POST', '/some/path', @params)
-      Time.stub!(:now).and_return(Time.at(1234 + 1000))
-      request.authenticate_by_token!(@token, nil).should == true
-    end
-    
-    it "should check that auth_version is supplied" do
-      @params.delete(:auth_version)
-      request = Authentication::Request.new('POST', '/some/path', @params)
-      lambda {
-        request.authenticate_by_token!(@token)
-      }.should raise_error('Version required')
-    end
-
-    it "should check that auth_version equals 1.0" do
-      @params[:auth_version] = '1.1'
-      request = Authentication::Request.new('POST', '/some/path', @params)
-      lambda {
-        request.authenticate_by_token!(@token)
-      }.should raise_error('Version not supported')
-    end
-
-    describe "when used with optional block" do
-      it "should optionally take a block which yields the signature" do
-        request = Authentication::Request.new('POST', '/some/path', @params)
-        request.authenticate do |key|
-          key.should == @token.key
-          @token
-        end.should == @token
-      end
-
-      it "should raise error if no auth_key supplied to request" do
-        @params.delete(:auth_key)
-        request = Authentication::Request.new('POST', '/some/path', @params)
-        lambda {
-          request.authenticate { |key| nil }
-        }.should raise_error('Authentication key required')
-      end
-
-      it "should raise error if block returns nil (i.e. key doesn't exist)" do
-        request = Authentication::Request.new('POST', '/some/path', @params)
-        lambda {
-          request.authenticate { |key| nil }
-        }.should raise_error('Invalid authentication key')
-      end
-    end
-  end
-end