Scopes will now carry with @api-see annotations.

#140
erunion · May 26, 2018 · cfe90af · cfe90af
1 parent fab58e7
commit cfe90af
Show file tree

Hide file tree

Showing 12 changed files with 109 additions and 42 deletions.
diff --git a/resources/examples/Showtimes/Representations/Movie.php b/resources/examples/Showtimes/Representations/Movie.php
@@ -86,6 +86,7 @@ public function create()
             'showtimes' => $this->getShowtimes(),
 
             /**
+             * @api-scope public
              * @api-data external_urls (object) - External URLs
              * @api-version >=1.1
              * @api-see self::getExternalUrls external_urls

diff --git a/resources/examples/Showtimes/blueprints/1.1.1/api.apib b/resources/examples/Showtimes/blueprints/1.1.1/api.apib
@@ -262,10 +262,10 @@ This action requires a bearer token with the `create` scope.
         + `X`
 - `description` (string) - Description
 - `director` (Person) - Director. This data requires a bearer token with the `public` scope.
-- `external_urls` (object) - External URLs
-    - `imdb` (string) - IMDB URL
-    - `tickets` (string) - Tickets URL
-    - `trailer` (string) - Trailer URL
+- `external_urls` (object) - External URLs. This data requires a bearer token with the `public` scope.
+    - `imdb` (string) - IMDB URL. This data requires a bearer token with the `public` scope.
+    - `tickets` (string) - Tickets URL. This data requires a bearer token with the `public` scope.
+    - `trailer` (string) - Trailer URL. This data requires a bearer token with the `public` scope.
 - `genres` (array[string]) - Genres
 - `id` (number) - Unique ID
 - `kid_friendly`: `false` (boolean) - Kid friendly?

diff --git a/resources/examples/Showtimes/blueprints/1.1.1/representations/Movie.apib b/resources/examples/Showtimes/blueprints/1.1.1/representations/Movie.apib
@@ -12,10 +12,10 @@
         + `X`
 - `description` (string) - Description
 - `director` (Person) - Director. This data requires a bearer token with the `public` scope.
-- `external_urls` (object) - External URLs
-    - `imdb` (string) - IMDB URL
-    - `tickets` (string) - Tickets URL
-    - `trailer` (string) - Trailer URL
+- `external_urls` (object) - External URLs. This data requires a bearer token with the `public` scope.
+    - `imdb` (string) - IMDB URL. This data requires a bearer token with the `public` scope.
+    - `tickets` (string) - Tickets URL. This data requires a bearer token with the `public` scope.
+    - `trailer` (string) - Trailer URL. This data requires a bearer token with the `public` scope.
 - `genres` (array[string]) - Genres
 - `id` (number) - Unique ID
 - `kid_friendly`: `false` (boolean) - Kid friendly?

diff --git a/resources/examples/Showtimes/blueprints/1.1.2/api.apib b/resources/examples/Showtimes/blueprints/1.1.2/api.apib
@@ -260,10 +260,10 @@ This action requires a bearer token with the `create` scope.
         + `X`
 - `description` (string) - Description
 - `director` (Person) - Director. This data requires a bearer token with the `public` scope.
-- `external_urls` (object) - External URLs
-    - `imdb` (string) - IMDB URL
-    - `tickets` (string) - Tickets URL
-    - `trailer` (string) - Trailer URL
+- `external_urls` (object) - External URLs. This data requires a bearer token with the `public` scope.
+    - `imdb` (string) - IMDB URL. This data requires a bearer token with the `public` scope.
+    - `tickets` (string) - Tickets URL. This data requires a bearer token with the `public` scope.
+    - `trailer` (string) - Trailer URL. This data requires a bearer token with the `public` scope.
 - `genres` (array[string]) - Genres
 - `id` (number) - Unique ID
 - `kid_friendly`: `false` (boolean) - Kid friendly?

diff --git a/resources/examples/Showtimes/blueprints/1.1.2/representations/Movie.apib b/resources/examples/Showtimes/blueprints/1.1.2/representations/Movie.apib
@@ -12,10 +12,10 @@
         + `X`
 - `description` (string) - Description
 - `director` (Person) - Director. This data requires a bearer token with the `public` scope.
-- `external_urls` (object) - External URLs
-    - `imdb` (string) - IMDB URL
-    - `tickets` (string) - Tickets URL
-    - `trailer` (string) - Trailer URL
+- `external_urls` (object) - External URLs. This data requires a bearer token with the `public` scope.
+    - `imdb` (string) - IMDB URL. This data requires a bearer token with the `public` scope.
+    - `tickets` (string) - Tickets URL. This data requires a bearer token with the `public` scope.
+    - `trailer` (string) - Trailer URL. This data requires a bearer token with the `public` scope.
 - `genres` (array[string]) - Genres
 - `id` (number) - Unique ID
 - `kid_friendly`: `false` (boolean) - Kid friendly?

diff --git a/resources/examples/Showtimes/blueprints/1.1.3/api.apib b/resources/examples/Showtimes/blueprints/1.1.3/api.apib
@@ -268,9 +268,9 @@ This action requires a bearer token with the `create` scope.
         + `X`
 - `description` (string) - Description
 - `director` (Person) - Director. This data requires a bearer token with the `public` scope.
-- `external_urls` (object) - External URLs
-    - `imdb` (string) - IMDB URL
-    - `trailer` (string) - Trailer URL
+- `external_urls` (object) - External URLs. This data requires a bearer token with the `public` scope.
+    - `imdb` (string) - IMDB URL. This data requires a bearer token with the `public` scope.
+    - `trailer` (string) - Trailer URL. This data requires a bearer token with the `public` scope.
 - `genres` (array[string]) - Genres
 - `id` (number) - Unique ID
 - `kid_friendly`: `false` (boolean) - Kid friendly?

diff --git a/resources/examples/Showtimes/blueprints/1.1.3/representations/Movie.apib b/resources/examples/Showtimes/blueprints/1.1.3/representations/Movie.apib
@@ -12,9 +12,9 @@
         + `X`
 - `description` (string) - Description
 - `director` (Person) - Director. This data requires a bearer token with the `public` scope.
-- `external_urls` (object) - External URLs
-    - `imdb` (string) - IMDB URL
-    - `trailer` (string) - Trailer URL
+- `external_urls` (object) - External URLs. This data requires a bearer token with the `public` scope.
+    - `imdb` (string) - IMDB URL. This data requires a bearer token with the `public` scope.
+    - `trailer` (string) - Trailer URL. This data requires a bearer token with the `public` scope.
 - `genres` (array[string]) - Genres
 - `id` (number) - Unique ID
 - `kid_friendly`: `false` (boolean) - Kid friendly?

diff --git a/resources/examples/Showtimes/blueprints/1.1/api.apib b/resources/examples/Showtimes/blueprints/1.1/api.apib
@@ -261,10 +261,10 @@ This action requires a bearer token with the `create` scope.
         + `X`
 - `description` (string) - Description
 - `director` (Person) - Director. This data requires a bearer token with the `public` scope.
-- `external_urls` (object) - External URLs
-    - `imdb` (string) - IMDB URL
-    - `tickets` (string) - Tickets URL
-    - `trailer` (string) - Trailer URL
+- `external_urls` (object) - External URLs. This data requires a bearer token with the `public` scope.
+    - `imdb` (string) - IMDB URL. This data requires a bearer token with the `public` scope.
+    - `tickets` (string) - Tickets URL. This data requires a bearer token with the `public` scope.
+    - `trailer` (string) - Trailer URL. This data requires a bearer token with the `public` scope.
 - `genres` (array[string]) - Genres
 - `id` (number) - Unique ID
 - `kid_friendly`: `false` (boolean) - Kid friendly?

diff --git a/resources/examples/Showtimes/blueprints/1.1/representations/Movie.apib b/resources/examples/Showtimes/blueprints/1.1/representations/Movie.apib
@@ -12,10 +12,10 @@
         + `X`
 - `description` (string) - Description
 - `director` (Person) - Director. This data requires a bearer token with the `public` scope.
-- `external_urls` (object) - External URLs
-    - `imdb` (string) - IMDB URL
-    - `tickets` (string) - Tickets URL
-    - `trailer` (string) - Trailer URL
+- `external_urls` (object) - External URLs. This data requires a bearer token with the `public` scope.
+    - `imdb` (string) - IMDB URL. This data requires a bearer token with the `public` scope.
+    - `tickets` (string) - Tickets URL. This data requires a bearer token with the `public` scope.
+    - `trailer` (string) - Trailer URL. This data requires a bearer token with the `public` scope.
 - `genres` (array[string]) - Genres
 - `id` (number) - Unique ID
 - `kid_friendly`: `false` (boolean) - Kid friendly?

diff --git a/src/Parser/Representation/RepresentationParser.php b/src/Parser/Representation/RepresentationParser.php
@@ -160,6 +160,12 @@ public function parseAnnotations(array $tags, string $original_content): array
                         }
                     }
 
+                    // If this `@api-see` is being used with `@api-scope` annotations, the scope should filter down
+                    // the pipe.
+                    if (!empty($scopes)) {
+                        $annotation->setScopes($scopes);
+                    }
+
                     // If this `@api-see` has a prefix to attach to found annotation identifiers, do so.
                     if (!empty($prefix)) {
                         $see_annotations[$prefix . '.' . $name] = $annotation->setIdentifierPrefix($prefix);

diff --git a/tests/Parser/Representation/DocumentationTest.php b/tests/Parser/Representation/DocumentationTest.php
@@ -141,7 +141,12 @@ public function providerParseDocumentationReturnsRepresentation(): array
                             'identifier' => 'external_urls',
                             'nullable' => false,
                             'sample_data' => false,
-                            'scopes' => [],
+                            'scopes' => [
+                                [
+                                    'description' => false,
+                                    'scope' => 'public'
+                                ]
+                            ],
                             'subtype' => false,
                             'type' => 'object',
                             'values' => [],
@@ -153,7 +158,12 @@ public function providerParseDocumentationReturnsRepresentation(): array
                             'identifier' => 'external_urls.imdb',
                             'nullable' => false,
                             'sample_data' => false,
-                            'scopes' => [],
+                            'scopes' => [
+                                [
+                                    'description' => false,
+                                    'scope' => 'public'
+                                ]
+                            ],
                             'subtype' => false,
                             'type' => 'string',
                             'values' => [],
@@ -165,7 +175,12 @@ public function providerParseDocumentationReturnsRepresentation(): array
                             'identifier' => 'external_urls.tickets',
                             'nullable' => false,
                             'sample_data' => false,
-                            'scopes' => [],
+                            'scopes' => [
+                                [
+                                    'description' => false,
+                                    'scope' => 'public'
+                                ]
+                            ],
                             'subtype' => false,
                             'type' => 'string',
                             'values' => [],
@@ -179,7 +194,12 @@ public function providerParseDocumentationReturnsRepresentation(): array
                             'identifier' => 'external_urls.trailer',
                             'nullable' => false,
                             'sample_data' => false,
-                            'scopes' => [],
+                            'scopes' => [
+                                [
+                                    'description' => false,
+                                    'scope' => 'public'
+                                ]
+                            ],
                             'subtype' => false,
                             'type' => 'string',
                             'values' => [],
@@ -389,7 +409,12 @@ public function providerParseDocumentationReturnsRepresentation(): array
                                 'identifier' => 'external_urls',
                                 'nullable' => false,
                                 'sample_data' => false,
-                                'scopes' => [],
+                                'scopes' => [
+                                    [
+                                        'description' => false,
+                                        'scope' => 'public'
+                                    ]
+                                ],
                                 'subtype' => false,
                                 'type' => 'object',
                                 'values' => [],
@@ -402,7 +427,12 @@ public function providerParseDocumentationReturnsRepresentation(): array
                                     'identifier' => 'external_urls.imdb',
                                     'nullable' => false,
                                     'sample_data' => false,
-                                    'scopes' => [],
+                                    'scopes' => [
+                                        [
+                                            'description' => false,
+                                            'scope' => 'public'
+                                        ]
+                                    ],
                                     'subtype' => false,
                                     'type' => 'string',
                                     'values' => [],
@@ -416,7 +446,12 @@ public function providerParseDocumentationReturnsRepresentation(): array
                                     'identifier' => 'external_urls.tickets',
                                     'nullable' => false,
                                     'sample_data' => false,
-                                    'scopes' => [],
+                                    'scopes' => [
+                                        [
+                                            'description' => false,
+                                            'scope' => 'public'
+                                        ]
+                                    ],
                                     'subtype' => false,
                                     'type' => 'string',
                                     'values' => [],
@@ -432,7 +467,12 @@ public function providerParseDocumentationReturnsRepresentation(): array
                                     'identifier' => 'external_urls.trailer',
                                     'nullable' => false,
                                     'sample_data' => false,
-                                    'scopes' => [],
+                                    'scopes' => [
+                                        [
+                                            'description' => false,
+                                            'scope' => 'public'
+                                        ]
+                                    ],
                                     'subtype' => false,
                                     'type' => 'string',
                                     'values' => [],

diff --git a/tests/Parser/Representation/RepresentationParserTest.php b/tests/Parser/Representation/RepresentationParserTest.php
@@ -255,7 +255,12 @@ public function providerParseAnnotations(): array
                             'identifier' => 'external_urls',
                             'nullable' => false,
                             'sample_data' => false,
-                            'scopes' => [],
+                            'scopes' => [
+                                [
+                                    'description' => false,
+                                    'scope' => 'public'
+                                ]
+                            ],
                             'subtype' => false,
                             'type' => 'object',
                             'values' => [],
@@ -267,7 +272,12 @@ public function providerParseAnnotations(): array
                             'identifier' => 'external_urls.imdb',
                             'nullable' => false,
                             'sample_data' => false,
-                            'scopes' => [],
+                            'scopes' => [
+                                [
+                                    'description' => false,
+                                    'scope' => 'public'
+                                ]
+                            ],
                             'subtype' => false,
                             'type' => 'string',
                             'values' => [],
@@ -279,7 +289,12 @@ public function providerParseAnnotations(): array
                             'identifier' => 'external_urls.tickets',
                             'nullable' => false,
                             'sample_data' => false,
-                            'scopes' => [],
+                            'scopes' => [
+                                [
+                                    'description' => false,
+                                    'scope' => 'public'
+                                ]
+                            ],
                             'subtype' => false,
                             'type' => 'string',
                             'values' => [],
@@ -293,7 +308,12 @@ public function providerParseAnnotations(): array
                             'identifier' => 'external_urls.trailer',
                             'nullable' => false,
                             'sample_data' => false,
-                            'scopes' => [],
+                            'scopes' => [
+                                [
+                                    'description' => false,
+                                    'scope' => 'public'
+                                ]
+                            ],
                             'subtype' => false,
                             'type' => 'string',
                             'values' => [],