pusher 0.15.1 → 0.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b64af09f091d43ed13e921406e0108b6a90b0cd9
-  data.tar.gz: 9fd33f0354fe6fd52e47802844c73b00ee6deee9
+  metadata.gz: 32c8fccc91671ec6b53af1f72c215d04507549af
+  data.tar.gz: 95456eb8133e6c1228196428c2f60ca49db3dcab
 SHA512:
-  metadata.gz: efd9f7930352cc46a0cee275122cea94f3a283beeb44b8b9448b2908ec87963b83f1b6cf1dd2a13e2fa6dccf58c8ca81fb93d5b67ec88bc51bb677e842785297
-  data.tar.gz: ce20cb134cf093a8c9a9f6bf47169e9cc3a26b65b7e697655deb62479f91092c68cd11bb888c60f56f1b056c59c443484b5c96e2cf90c59f7c390d45d57326cb
+  metadata.gz: b28ce47523b183090c7807f5fae7b9f8428a2bb54706991dc4291e8a38be0bcca3e17905d9d3771f40e397a5c9edb39a2b32c00fa9105b9f4648728f6e18162a
+  data.tar.gz: c9d5a22d38f543f77ee7d3b64d76abdfaeda4ab716a0ec686f8e40b6f9a2cf50f0ad5f91e7f22e041b54a17676506b5a406673f3627ea202e79157d5265952df

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.15.2 / 2015-12-03
+==================
+
+  * Documented `Pusher.channel_info`, `Pusher.channels`
+  * Added `Pusher.channel_users`
+
 0.15.1 / 2015-11-03
 ==================
 

data/README.md

@@ -63,7 +63,18 @@ pusher_client = Pusher::Client.new({
 
 This `client` will have all the functionality listed on the main Pusher class (which proxies to a client internally).
 
+If you want to set the `host` value for your client then you can do so when instantiating a Pusher client like so:
 
+``` ruby
+pusher_client = Pusher::Client.new({
+  app_id: 'your-pusher-app-id',
+  key: 'your-pusher-key',
+  secret: 'your-pusher-secret',
+  host: 'your-pusher-host'
+})
+```
+
+This is useful if, for example, you've created an app on the EU cluster and wish to set the host to be `api-eu.pusher.com`.
 
 ## Interacting with the Pusher service
 
@@ -114,21 +125,17 @@ Pusher['a_channel'].trigger('an_event', {:some => 'data'})
 
 This will continue to work, but has been replaced by `Pusher.trigger` which supports one or multiple channels.
 
-### Generic requests to the Pusher REST API
+### Using the Pusher REST API
 
-Aside from triggering events, the REST API also supports a number of operations for querying the state of the system. A reference of the available methods is available at <http://pusher.com/docs/rest_api>.
+This gem provides methods for accessing information from the [Pusher REST API](https://pusher.com/docs/rest_api). The documentation also shows an example of the responses from each of the API endpionts.
 
-All requests must be signed by using your secret key, which is handled automatically using these methods:
+The following methods are provided by the gem.
 
-``` ruby
-# using the Pusher class
-Pusher.get('url_without_app_id', params)
+- `Pusher.channel_info('channel_name')` returns information about that channel.
 
-# using a client
-pusher_client.post('url_without_app_id', params)
-```
+- `Pusher.channel_users('channel_name')` returns a list of all the users subscribed to the channel.
 
-Note that you don't need to specify your app_id in the URL, as this is inferred from your credentials.
+- `Pusher.channels` returns information about all the channels in your Pusher application.
 
 ### Asynchronous requests
 

data/lib/pusher.rb

@@ -31,7 +31,7 @@ module Pusher
     def_delegators :default_client, :timeout=, :connect_timeout=, :send_timeout=, :receive_timeout=, :keep_alive_timeout=
 
     def_delegators :default_client, :get, :get_async, :post, :post_async
-    def_delegators :default_client, :channels, :channel_info, :trigger, :trigger_async
+    def_delegators :default_client, :channels, :channel_info, :channel_users, :trigger, :trigger_async
     def_delegators :default_client, :authenticate, :webhook, :channel, :[]
 
     attr_writer :logger

data/lib/pusher/client.rb

@@ -209,6 +209,22 @@ module Pusher
       get("/channels/#{channel_name}", params)
     end
 
+    # Request info for users of a channel
+    #
+    # GET /apps/[id]/channels/[channel_name]/users
+    #
+    # @param channel_name [String] Channel name (max 200 characters)
+    # @param params [Hash] Hash of parameters for the API - see REST API docs
+    #
+    # @return [Hash] See Pusher API docs
+    #
+    # @raise [Pusher::Error] Unsuccessful response - see the error message
+    # @raise [Pusher::HTTPError] Error raised inside http client. The original error is wrapped in error.original_error
+    #
+    def channel_users(channel_name, params = {})
+      get("/channels/#{channel_name}/users", params)
+    end
+
     # Trigger an event on one or more channels
     #
     # POST /apps/[app_id]/events

data/pusher.gemspec

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

data/spec/client_spec.rb

@@ -128,6 +128,21 @@ describe Pusher do
         end
       end
 
+      describe '#channel_users' do
+        it "should call correct URL and symbolise response" do
+          api_path = %r{/apps/20/channels/mychannel/users}
+          stub_request(:get, api_path).to_return({
+            :status => 200,
+            :body => MultiJson.encode({
+              'users' => [{ 'id' => 1 }]
+            })
+          })
+          expect(@client.channel_users('mychannel')).to eq({
+            :users => [{ 'id' => 1}]
+          })
+        end
+      end
+
       describe '#authenticate' do
         before :each do
           @custom_data = {:uid => 123, :info => {:name => 'Foo'}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pusher
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.15.2
 platform: ruby
 authors:
 - Pusher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-03 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json