pusher 0.5.3 → 0.6.0

data/README.md

@@ -38,6 +38,15 @@ To avoid blocking in a typical web application, if you are running inside eventm
       # error is a pusher exception
     }
 
+Private channels
+-----------------------
+The Pusher Gem also deals with signing requests for authenticated private channels. A quick Rails controller example:
+
+    reponse = Pusher['private-my_channel'].authenticate(params[:socket_id])
+    render :json => response
+    
+Read more about private channels in [the docs](http://pusherapp.com/docs/private_channels).
+
 Copyright
 ---------
 

data/Rakefile

@@ -15,6 +15,7 @@ begin
     gem.add_dependency "crack"
     gem.add_dependency "ruby-hmac"
     gem.add_dependency 'signature'
+    # gem.add_dependency 'em-http-request', ">= 0.2.7"
     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.5.3
+0.6.0

data/lib/pusher.rb

@@ -63,5 +63,6 @@ module Pusher
   end
 end
 
+require 'pusher/json'
 require 'pusher/channel'
 require 'pusher/request'

data/lib/pusher/channel.rb

@@ -61,17 +61,33 @@ module Pusher
     rescue StandardError => e
       handle_error e
     end
-
-    def socket_auth(socket_id)
+    
+    # Auth string is:
+    # if custom data provided:
+    # socket_id:channel_name:[JSON-encoded custom data]
+    # if no custom data:
+    # socket_id:channel_name
+    def socket_auth(socket_id, custom_string = nil)
       raise "Invalid socket_id" if socket_id.nil? || socket_id.empty?
+      raise 'Custom argument must be a string' unless custom_string.nil? || custom_string.kind_of?(String)
 
-      string_to_sign = "#{socket_id}:#{name}"
+      string_to_sign = [socket_id, name, custom_string].compact.map{|e|e.to_s}.join(':')
       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
+    
+    # Custom data is sent to server as JSON-encoded string in the :data key
+    # If :data present, server must include it in auth check
+    def authenticate(socket_id, custom_data = nil)
+      custom_data = Pusher::JSON.generate(custom_data) if custom_data
+      auth = socket_auth(socket_id, custom_data)
+      r = {:auth => auth}
+      r[:channel_data] = custom_data if custom_data
+      r
+    end
 
     private
 

data/lib/pusher/json.rb

@@ -0,0 +1,15 @@
+require 'json'
+
+module Pusher
+  module JSON
+    
+    def self.generate(data)
+      if Object.const_defined?('ActiveSupport')
+        ActiveSupport::JSON.encode(data)
+      else
+        ::JSON.generate(data)
+      end
+    end
+    
+  end
+end

data/lib/pusher/request.rb

@@ -1,6 +1,5 @@
 require 'signature'
 require 'digest/md5'
-require 'json'
 
 module Pusher
   class Request
@@ -17,7 +16,7 @@ module Pusher
         data
       else
         begin
-          self.class.turn_into_json(data)
+          Pusher::JSON.generate(data)
         rescue => e
           Pusher.logger.error("Could not convert #{data.inspect} into JSON")
           raise e
@@ -31,12 +30,5 @@ module Pusher
       @query = params.merge(auth_hash)
     end
 
-    def self.turn_into_json(data)
-      if Object.const_defined?('ActiveSupport')
-        ActiveSupport::JSON.encode(data)
-      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.5.3"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["New Bamboo"]
-  s.date = %q{2010-06-01}
+  s.date = %q{2010-08-09}
   s.description = %q{Wrapper for pusherapp.com REST api}
   s.email = %q{support@pusherapp.com}
   s.extra_rdoc_files = [
@@ -19,13 +19,13 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
-     "CHANGELOG",
      "LICENSE",
      "README.md",
      "Rakefile",
      "VERSION",
      "lib/pusher.rb",
      "lib/pusher/channel.rb",
+     "lib/pusher/json.rb",
      "lib/pusher/request.rb",
      "pusher.gemspec",
      "spec/channel_spec.rb",

data/spec/channel_spec.rb

@@ -235,5 +235,52 @@ describe Pusher::Channel do
         }.should raise_error
       end
     end
+    
+    describe 'with extra string argument' do
+      
+      it 'should be a string or nil' do
+        lambda {
+          @channel.socket_auth('socketid', 'boom')
+        }.should_not raise_error
+        
+        lambda {
+          @channel.socket_auth('socketid', 123)
+        }.should raise_error
+        
+        lambda {
+          @channel.socket_auth('socketid', nil)
+        }.should_not raise_error
+        
+        lambda {
+          @channel.socket_auth('socketid', {})
+        }.should raise_error
+      end
+      
+      it "should return an authentication string given a socket id and custom args" do
+        auth = @channel.socket_auth('socketid', 'foobar')
+
+        auth.should == "12345678900000001:#{HMAC::SHA256.hexdigest(Pusher.secret, "socketid:test_channel:foobar")}"
+      end
+      
+    end
+  end
+  
+  describe '#authenticate' do
+    
+    before :each do
+      @channel = Pusher['test_channel']
+      @custom_data = {:uid => 123, :info => {:name => 'Foo'}}
+    end
+    
+    it 'should return a hash with signature including custom data and data as json string' do
+      Pusher::JSON.stub!(:generate).with(@custom_data).and_return 'a json string'
+      
+      response = @channel.authenticate('socketid', @custom_data)
+      
+      response.should == {
+        :auth => "12345678900000001:#{HMAC::SHA256.hexdigest(Pusher.secret, "socketid:test_channel:a json string")}",
+        :channel_data => 'a json string'
+      }
+    end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 3
-  version: 0.5.3
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - New Bamboo
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-01 00:00:00 +01:00
+date: 2010-08-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -103,13 +103,13 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
-- CHANGELOG
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
 - lib/pusher.rb
 - lib/pusher/channel.rb
+- lib/pusher/json.rb
 - lib/pusher/request.rb
 - pusher.gemspec
 - spec/channel_spec.rb

data/CHANGELOG

@@ -1,11 +0,0 @@
-* master *
-
-* Pusher v0.5.1 (20th May, 2010) *
-
-* Use ActiveSupport::JSON.encode instead of #to_json to avoid conflicts with JSON gem. [OL]
-* Support loading Pusher credentials from a PUSHER_URL environment variable. [ML]
-
-* Pusher v0.5.2 (25th May, 2010) *
-
-* Bugfix: required uri correctly
-* Bugfix: channel objects not being reused