feat: AJDA-2680 add detailSubscription() to SubscriptionClient

Author: ondrajodas

README.md

@@ -69,6 +69,9 @@ foreach ($subscriptions as $subscription) {
     echo $subscription->getId() . ': ' . $subscription->getEvent() . "\n";
 }
 
+// fetch a single subscription by ID
+$detail = $subscriptionClient->detailSubscription($created->getId());
+
 // delete a subscription
 $subscriptionClient->deleteSubscription($created->getId());
 ```

src/SubscriptionClient.php

@@ -51,6 +51,15 @@ public function deleteSubscription(string $id): void
         $this->sendRequest($request);
     }
 
+    public function detailSubscription(string $id): ResponseSubscription
+    {
+        $request = new Request(
+            'GET',
+            'project-subscriptions/' . rawurlencode($id),
+        );
+        return new ResponseSubscription($this->sendRequest($request));
+    }
+
     /**
      * @return array<ResponseSubscription>
      */

tests/SubscriptionClientFunctionalTest.php

@@ -146,6 +146,51 @@ public function testDeleteSubscriptionHeaders(): void
         );
     }
 
+    public function testDetailSubscriptionHeaders(): void
+    {
+        $mock = new MockHandler([
+            new Response(
+                200,
+                ['Content-Type' => 'application/json'],
+                (string) json_encode([
+                    'id' => 'subscription-123',
+                    'event' => 'job-failed',
+                    'filters' => [
+                        ['field' => 'project.id', 'value' => '123'],
+                    ],
+                    'recipient' => ['channel' => 'email', 'address' => 'a@example.com'],
+                ]),
+            ),
+        ]);
+        $requestHistory = [];
+        $history = Middleware::history($requestHistory);
+        $stack = HandlerStack::create($mock);
+        $stack->push($history);
+        $client = new SubscriptionClient(
+            'https://example.com/',
+            'testToken',
+            ['handler' => $stack, 'backoffMaxTries' => 3, 'userAgent' => 'Test'],
+        );
+
+        $result = $client->detailSubscription('subscription-123');
+
+        /** @var Request $request */
+        $request = $requestHistory[0]['request'];
+        self::assertSame('GET', $request->getMethod());
+        self::assertSame('https://example.com/project-subscriptions/subscription-123', (string) $request->getUri());
+        self::assertSame(
+            ['User-Agent', 'X-StorageApi-Token', 'Host'],
+            array_keys($request->getHeaders()),
+        );
+
+        self::assertSame('subscription-123', $result->getId());
+        self::assertSame('job-failed', $result->getEvent());
+        self::assertSame('project.id', $result->getFilters()[0]->getField());
+        self::assertSame('123', $result->getFilters()[0]->getValue());
+        self::assertSame('email', $result->getRecipientChannel());
+        self::assertSame('a@example.com', $result->getRecipientAddress());
+    }
+
     public function testListSubscriptionsHeaders(): void
     {
         $responseBody = json_encode([
@@ -217,6 +262,11 @@ public function testListAndDeleteSubscriptionLifecycle(): void
         ));
         self::assertNotEmpty($created->getId());
 
+        // detail — must return the same subscription
+        $detail = $client->detailSubscription($created->getId());
+        self::assertSame($created->getId(), $detail->getId());
+        self::assertSame('job-failed', $detail->getEvent());
+
         // list — must contain the new subscription
         $beforeDelete = $client->listSubscriptions();
         self::assertContainsOnlyInstancesOf(