Additinal docs and testing for Grants

auth0 · Feb 25, 2019 · 195190b · 195190b
1 parent ffbb272
commit 195190b
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 4 deletions.
diff --git a/src/API/Management/Grants.php b/src/API/Management/Grants.php
@@ -11,7 +11,7 @@
 class Grants extends GenericResource
 {
     /**
-     * Get all Grants by page.
+     * Get all Grants with pagination.
      * Required scope: "read:grants"
      *
      * @param integer      $page     Page number to return, zero-based.
@@ -21,6 +21,8 @@ class Grants extends GenericResource
      * @return mixed
      *
      * @throws \Exception Thrown by the HTTP client when there is a problem with the API call.
+     *
+     * @link https://auth0.com/docs/api/management/v2#!/Grants/get_grants
      */
     public function getAll($page = 0, $per_page = null, array $params = [])
     {
@@ -39,7 +41,7 @@ public function getAll($page = 0, $per_page = null, array $params = [])
     }
 
     /**
-     * Get Grants by Client ID.
+     * Get Grants by Client ID with pagination.
      * Required scope: "read:grants"
      *
      * @param string       $client_id Client ID to filter Grants.
@@ -50,6 +52,8 @@ public function getAll($page = 0, $per_page = null, array $params = [])
      *
      * @throws CoreException If $client_id is empty or not a string.
      * @throws \Exception Thrown by the HTTP client when there is a problem with the API call.
+     *
+     * @link https://auth0.com/docs/api/management/v2#!/Grants/get_grants
      */
     public function getByClientId($client_id, $page = 0, $per_page = null)
     {
@@ -61,7 +65,7 @@ public function getByClientId($client_id, $page = 0, $per_page = null)
     }
 
     /**
-     * Get Grants by Audience.
+     * Get Grants by Audience with pagination.
      * Required scope: "read:grants"
      *
      * @param string       $audience Audience to filter Grants.
@@ -72,6 +76,8 @@ public function getByClientId($client_id, $page = 0, $per_page = null)
      *
      * @throws CoreException If $audience is empty or not a string.
      * @throws \Exception Thrown by the HTTP client when there is a problem with the API call.
+     *
+     * @link https://auth0.com/docs/api/management/v2#!/Grants/get_grants
      */
     public function getByAudience($audience, $page = null, $per_page = null)
     {
@@ -83,7 +89,7 @@ public function getByAudience($audience, $page = null, $per_page = null)
     }
 
     /**
-     * Get Grants by User ID.
+     * Get Grants by User ID with pagination.
      * Required scope: "read:grants"
      *
      * @param string       $user_id  User ID to filter Grants.
@@ -94,6 +100,8 @@ public function getByAudience($audience, $page = null, $per_page = null)
      *
      * @throws CoreException If $user_id is empty or not a string.
      * @throws \Exception Thrown by the HTTP client when there is a problem with the API call.
+     *
+     * @link https://auth0.com/docs/api/management/v2#!/Grants/get_grants
      */
     public function getByUserId($user_id, $page = 0, $per_page = null)
     {
@@ -114,6 +122,8 @@ public function getByUserId($user_id, $page = 0, $per_page = null)
      *
      * @throws CoreException If $id is empty or not a string.
      * @throws \Exception Thrown by the HTTP client when there is a problem with the API call.
+     *
+     * @link https://auth0.com/docs/api/management/v2#!/Grants/delete_grants_by_id
      */
     public function delete($id)
     {

diff --git a/tests/API/Management/GrantsTestMocked.php b/tests/API/Management/GrantsTestMocked.php
@@ -165,6 +165,15 @@ public function testThatGrantsGetByClientIdThrowsException()
         }
 
         $this->assertTrue( $caught_exception );
+
+        try {
+            $caught_exception = false;
+            $api->grants->getByClientId( [ '__not_empty__' ] );
+        } catch (CoreException $e) {
+            $caught_exception = $this->errorHasString( $e, 'Empty or invalid "client_id" parameter' );
+        }
+
+        $this->assertTrue( $caught_exception );
     }
 
     /**
@@ -220,6 +229,15 @@ public function testThatGrantsGetByAudienceThrowsException()
         }
 
         $this->assertTrue( $caught_exception );
+
+        try {
+            $caught_exception = false;
+            $api->grants->getByAudience( [ '__not_empty__' ] );
+        } catch (CoreException $e) {
+            $caught_exception = $this->errorHasString( $e, 'Empty or invalid "audience" parameter' );
+        }
+
+        $this->assertTrue( $caught_exception );
     }
 
     /**
@@ -275,6 +293,15 @@ public function testThatGrantsGetByUserIdThrowsException()
         }
 
         $this->assertTrue( $caught_exception );
+
+        try {
+            $caught_exception = false;
+            $api->grants->getByUserId( [ '__not_empty__' ] );
+        } catch (CoreException $e) {
+            $caught_exception = $this->errorHasString( $e, 'Empty or invalid "user_id" parameter' );
+        }
+
+        $this->assertTrue( $caught_exception );
     }
 
     /**
@@ -319,5 +346,14 @@ public function testGrantsDeleteThrowsException()
         }
 
         $this->assertTrue( $caught_exception );
+
+        try {
+            $caught_exception = false;
+            $api->grants->delete( [ '__not_empty__' ] );
+        } catch (CoreException $e) {
+            $caught_exception = $this->errorHasString( $e, 'Empty or invalid "id" parameter' );
+        }
+
+        $this->assertTrue( $caught_exception );
     }
 }