Merge pull request #21 from ably/fix/capability-validation

Refactor capability key for a channel

README.md

@@ -106,18 +106,20 @@ npm run dev
 ## Configure advanced features
 
 **1. Modify private/presence channel capability. Default: Full capability**
-- Channel access can be changed as per [Channel Capabilities](https://ably.com/docs/core-features/authentication#capability-operations)
+- Channel access control rights are granted for each individual user separately using `ably-capability`. It defines list of access claims as per [Channel Capabilities](https://ably.com/docs/core-features/authentication#capability-operations).
+
 ```php
   // file - routes/channels.php
-
-  // for private channel (Access is allowed for truthy values and denied for falsy values)
+  // User authentication is allowed for private/presence channel returning truthy values and denied for falsy values.
+
+  // for private channel
   Broadcast::channel('channel1', function ($user) {
-      return ['capability' => ["subscribe", "history"]];
+      return ['ably-capability' => ["subscribe", "history"]];
   });
 
   // for presence channel
   Broadcast::channel('channel2', function ($user) {
-      return ['id' => $user->id, 'name' => $user->name, 'capability' => ["subscribe", "presence"]];
+      return ['id' => $user->id, 'name' => $user->name, 'ably-capability' => ["subscribe", "presence"]];
   });
 ```
 

src/AblyBroadcaster.php

@@ -130,7 +130,10 @@ public function auth($request)
             }
             try {
                 $userChannelMetaData = parent::verifyUserCanAccessChannel($request, $normalizedChannelName);
-                if (is_array($userChannelMetaData) && array_key_exists('capability', $userChannelMetaData)) {
+                if (is_array($userChannelMetaData) && array_key_exists('ably-capability', $userChannelMetaData)) {
+                    $guardedChannelCapability = $userChannelMetaData['ably-capability'];
+                    unset($userChannelMetaData['ably-capability']);
+                } else if (is_array($userChannelMetaData) && array_key_exists('capability', $userChannelMetaData)) { // deprecated, will be removed in future versions
                     $guardedChannelCapability = $userChannelMetaData['capability'];
                     unset($userChannelMetaData['capability']);
                 }

tests/AblyBroadcasterTest.php

@@ -257,7 +257,7 @@ public function testCustomChannelCapability()
 
         $this->broadcaster->shouldReceive('validAuthenticationResponse')
                           ->times(1)
-                          ->andReturn(['userid' => 'user1234', 'info' => 'Hello there', 'capability' => ['publish', 'subscribe', 'presence']]);
+                          ->andReturn(['userid' => 'user1234', 'info' => 'Hello there', 'ably-capability' => ['publish', 'subscribe', 'presence']]);
 
         $response = $this->broadcaster->auth(
             $this->getMockRequestWithUserForChannel('private:test1', null)