pusher 0.14.6 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a05ddf26ee71f3e0a3d751b2889d3d1495251db
-  data.tar.gz: c9fb9b3cde9ba84f0142338f75976a48d589fd4e
+  metadata.gz: 17463be3ad5649865f88dcdc2b88156ff48f4bc2
+  data.tar.gz: 6ee8e8605ae0f9fb4b31b8e5edab80046e52aecb
 SHA512:
-  metadata.gz: cb0866fb85465274cd61ecbe4ff0aa19ac94d0c20f783838e268909b2ae0d43d9ebc16778a8a1ec24589e1c1441c347d45d84079ac6dbc3f1ef3a6e8da26fafe
-  data.tar.gz: 129331534bbe57502166e569978701dc21bad9f805f3d06c2c822ac0ea80c12f290f5366cc525fd31ca91ac3a088119460127a197b9c0e2f85cc2b5b96eaf7c6
+  metadata.gz: c3609f83552197f602b3d25150c72880bf2f586ab8d32827e0d8ecaad9a6084c970134aae7fdf98e1c080555329802d31addd1832c9acd04c652ff188d27e6e1
+  data.tar.gz: 062fdc265e90f2a55f69ff83a0b3dcd3275ce2b36891ef1f75285492da457068cc778eb8b570e3f7eb3b467333f75ca20a7fc9e89d52ae5df137f6e17aadf3e7

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.15.0 / 2015-11-02
+==================
+
+  * Added `Pusher.authenticate` method for authenticating private and presence channels.
+    This is prefered over the older `Pusher['a_channel'].authenticate(...)` style.
+
 0.14.6 / 2015-09-29
 ==================
   * Updated to use the `pusher-signature` gem instead of `signature`.

data/README.md

@@ -178,7 +178,7 @@ It's possible to use the gem to authenticate subscription requests to private or
 ### Private channels
 
 ``` ruby
-Pusher['private-my_channel'].authenticate(params[:socket_id])
+Pusher.authenticate('private-my_channel', params[:socket_id])
 ```
 
 ### Presence channels
@@ -186,7 +186,7 @@ Pusher['private-my_channel'].authenticate(params[:socket_id])
 These work in a very similar way, but require a unique identifier for the user being authenticated, and optionally some attributes that are provided to clients via presence events:
 
 ``` ruby
-Pusher['presence-my_channel'].authenticate(params[:socket_id], {
+Pusher.authenticate('presence-my_channel', params[:socket_id], {
   user_id: 'user_id',
   user_info: {} # optional
 })

data/lib/pusher/client.rb

@@ -235,6 +235,33 @@ module Pusher
       post_async('/events', trigger_params(channels, event_name, data, params))
     end
 
+    # Generate the expected response for an authentication endpoint.
+    # See http://pusher.com/docs/authenticating_users for details.
+    #
+    # @example Private channels
+    #   render :json => Pusher.authenticate('private-my_channel', params[:socket_id])
+    #
+    # @example Presence channels
+    #   render :json => Pusher.authenticate('presence-my_channel', params[:socket_id], {
+    #     :user_id => current_user.id, # => required
+    #     :user_info => { # => optional - for example
+    #       :name => current_user.name,
+    #       :email => current_user.email
+    #     }
+    #   })
+    #
+    # @param socket_id [String]
+    # @param custom_data [Hash] used for example by private channels
+    #
+    # @return [Hash]
+    #
+    # @private Custom data is sent to server as JSON-encoded string
+    #
+    def authenticate(channel_name, socket_id, custom_data = nil)
+      channel_instance = channel(channel_name)
+      channel_instance.authenticate(socket_id, custom_data)
+    end
+
     # @private Construct a net/http http client
     def sync_http_client
       @client ||= begin

data/pusher.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "pusher"
-  s.version     = "0.14.6"
+  s.version     = "0.15.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Pusher"]
   s.email       = ["support@pusher.com"]
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "em-http-request", "~> 1.1.0"
   s.add_development_dependency "rake"
   s.add_development_dependency "rack"
+  s.add_development_dependency "json"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/client_spec.rb

@@ -128,6 +128,24 @@ describe Pusher do
         end
       end
 
+      describe '#authenticate' do
+        before :each do
+          @custom_data = {:uid => 123, :info => {:name => 'Foo'}}
+        end
+
+        it 'should return a hash with signature including custom data and data as json string' do
+          allow(MultiJson).to receive(:encode).with(@custom_data).and_return 'a json string'
+
+          response = @client.authenticate('test_channel', '1.1', @custom_data)
+
+          expect(response).to eq({
+            :auth => "12345678900000001:#{hmac(@client.secret, "1.1:test_channel:a json string")}",
+            :channel_data => 'a json string'
+          })
+        end
+
+      end
+
       describe '#trigger' do
         before :each do
           @api_path = %r{/apps/20/events}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pusher
 version: !ruby/object:Gem::Version
-  version: 0.14.6
+  version: 0.15.0
 platform: ruby
 authors:
 - Pusher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-29 00:00:00.000000000 Z
+date: 2015-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Wrapper for pusher.com REST api
 email:
 - support@pusher.com
@@ -170,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Pusher API client