Merge pull request #209 from pusher/add-get-users-info-method

Add get_users_info method

Author: WillSewell

README.md

@@ -306,6 +306,13 @@ var_dump($subscription_counts);
 
 ### Get user information from a presence channel
 
+```php
+$results = $pusher->get_users_info( 'presence-channel-name' );
+$users_count = count($results->users); // $users is an Array
+```
+
+This can also be achieved using the generic `pusher->get` function:
+
 ```php
 $response = $pusher->get( '/channels/presence-channel-name/users' )
 ```

src/Pusher.php

@@ -662,6 +662,26 @@ public function get_channels($params = array())
         return false;
     }
 
+    /**
+     * Fetch user ids currently subscribed to a presence channel.
+     *
+     * @param string $channel The name of the channel
+     *
+     * @throws PusherException Throws exception if curl wasn't initialized correctly
+     *
+     * @return array|bool
+     */
+    public function get_users_info($channel)
+    {
+        $response = $this->get('/channels/'.$channel.'/users');
+
+        if ($response['status'] === 200) {
+            return json_decode($response['body']);
+        }
+
+        return false;
+    }
+
     /**
      * GET arbitrary REST API resource using a synchronous http client.
      * All request signing is handled automatically.

tests/acceptance/channelQueryTest.php

@@ -67,6 +67,15 @@ public function testFilterByPrefixOneChannel()
         $this->assertEquals(1, count($channels), 'channels have a single test-channel present. For this test to pass you must have the "Getting Started" page open on the dashboard for the app you are testing against');
     }
 
+    public function testUsersInfo()
+    {
+        $response = $this->pusher->get_users_info('presence-channel-test');
+
+        // print_r( $response );
+
+        $this->assertObjectHasAttribute('users', $response, 'class has users attribute');
+    }
+
     public function test_providing_info_parameter_with_prefix_query_fails_for_public_channel()
     {
         $options = array(