feat: improve docs and unify uninstall to delete

docs/01-getting_started.md

@@ -2,13 +2,15 @@
 
 ## Installation
 
+Install the Shopware APP SDK via composer:
+
 ```bash
-composer req shopware/app-php-sdk
+composer require shopware/app-php-sdk
 ```
 
-The dependency `php-http/discovery` will automatically install a missing HTTP Client
+After the package installation, Composer will automatically install http client if missing
 
-## Registration
+## Registration process
 
 ```php
 $app = new AppConfiguration('Foo', 'test', 'http://localhost:6001/register/callback');

docs/02-lifecycle.md

@@ -11,9 +11,20 @@ To track correctly the state in our Database, we need to implement some lifecycl
 - `deactivate`
 - `uninstall`
 
+The lifecycle registration in the `manifest.xml` would look like this:
+
+```xml
+<webhooks>
+    <webhook name="appActivate" url="https://app-server.com/app/activate" event="app.activated"/>
+    <webhook name="appDeactivated" url="https://app-server.com/app/deactivated" event="app.deactivated"/>
+    <webhook name="appDelete" url="https://app-server.com/app/delete" event="app.deleted"/>
+</webhooks>
+```
+
 ## Usage
 
-The implementation is similar to [Registration](./getting_started.md)
+The implementation is similar to [Registration](./01-getting_started.md)
+and wraps the RegistrationService to inject only one controller for all lifecycle methods.
 
 ```php
 $app = new AppConfiguration('Foo', 'test', 'http://localhost:6001/register/callback');
@@ -32,7 +43,7 @@ $response = match ($_SERVER['REQUEST_URI']) {
     '/app/register/confirm' => $lifecycle->registerConfirm($psrRequest),
     '/app/activate' => $lifecycle->activate($psrRequest),
     '/app/deactivate' => $lifecycle->deactivate($psrRequest),
-    '/app/uninstall' => $lifecycle->uninstall($psrRequest),
+    '/app/delete' => $lifecycle->delete($psrRequest),
     default => throw new \RuntimeException('Unknown route')
 };
 

docs/04-signing.md

@@ -10,7 +10,7 @@ The signing is required for the following actions:
 - Payment
 
 
-To sign the response, you need to create a `ResponseSigner` and call the `signResponse` method.
+To sign the response, you need to create a `ResponseSigner` and call the `signResponse` method with our PSR 7 Response.
 
 ```php
 $app = new AppConfiguration('Foo', 'test', 'http://localhost:6001/register/callback');

docs/05-http-client.md

@@ -22,7 +22,7 @@ $httpClient = $clientFactory->createClient($shop);
 $response = $httpClient->sendRequest($psrHttpRequest);
 ```
 
-The client will automatically fetch the oauth token for the shop and add it to the request.
+The client will automatically fetch the OAuth2 token for the shop and add it to the request.
 
 ## SimpleHttpClient
 
@@ -31,7 +31,11 @@ The SimpleHttpClient is a wrapper around the PSR18 ClientInterface and provides
 ```php
 $simpleClient = new \Shopware\App\SDK\HttpClient\SimpleHttpClient\SimpleHttpClient($httpClient);
 
-$simpleClient->get('https://shop.com/api/_info/version');
+$response = $simpleClient->get('https://shop.com/api/_info/version');
+$response->getHeader('Content-Type'); // application/json
+$response->ok(); // true when 200 <= status code < 300
+$body = $response->json(); // json decoded body
+echo $body['version'];
 
 $simpleClient->post('https://shop.com/api/_action/sync', [
     'entity' => 'product',

examples/index.php

@@ -44,7 +44,7 @@
 } elseif (str_starts_with($serverRequest->getUri()->getPath(), '/register/callback')) {
     send($appLifecycle->registerConfirm($serverRequest));
 } elseif (str_starts_with($serverRequest->getUri()->getPath(), '/webhook/app.deleted')) {
-    send($appLifecycle->uninstall($serverRequest));
+    send($appLifecycle->delete($serverRequest));
 } elseif (str_starts_with($serverRequest->getUri()->getPath(), '/webhook/app.activated')) {
     send($appLifecycle->activate($serverRequest));
 } elseif (str_starts_with($serverRequest->getUri()->getPath(), '/webhook/app.deactivated')) {

src/AppLifecycle.php

@@ -57,9 +57,9 @@ public function deactivate(RequestInterface $request): ResponseInterface
     }
 
     /**
-     * Handles the app.uninstalled Hook to remove the shop from the repository
+     * Handles the app.deleted Hook to remove the shop from the repository
      */
-    public function uninstall(RequestInterface $request): ResponseInterface
+    public function delete(RequestInterface $request): ResponseInterface
     {
         $psrFactory = new Psr17Factory();
         $response = $psrFactory->createResponse(204);

src/HttpClient/SimpleHttpClient/Response.php

@@ -23,7 +23,7 @@ public function getContent(): string
     /**
      * @return array<mixed>
      */
-    public function toArray(): array
+    public function json(): array
     {
         $data = \json_decode($this->getContent(), true, flags: JSON_THROW_ON_ERROR);
 

tests/AppLifecycleTest.php

@@ -108,7 +108,7 @@ public function testUninstall(): void
     {
         $this->shopRepository->createShop(new MockShop('123', 'https://foo.com', '1234567890'));
 
-        $response = $this->appLifecycle->uninstall(new Request("POST", '/?shop-id=123', [], '{}'));
+        $response = $this->appLifecycle->delete(new Request("POST", '/?shop-id=123', [], '{}'));
         static::assertSame(204, $response->getStatusCode());
 
         static::assertNull($this->shopRepository->getShopFromId('123'));
@@ -122,7 +122,7 @@ public function testUninstall(): void
 
     public function testUninstallNotExisting(): void
     {
-        $response = $this->appLifecycle->uninstall(new Request("POST", '/?shop-id=123', [], '{}'));
+        $response = $this->appLifecycle->delete(new Request("POST", '/?shop-id=123', [], '{}'));
         static::assertSame(204, $response->getStatusCode());
 
         static::assertNull($this->shopRepository->getShopFromId('123'));
@@ -141,7 +141,7 @@ public function testUninstallWithoutEventDispatcher(): void
         );
 
         $this->shopRepository->createShop(new MockShop('123', 'https://foo.com', '1234567890'));
-        $response = $appLifeCycle->uninstall(new Request("POST", '/?shop-id=123', [], '{}'));
+        $response = $appLifeCycle->delete(new Request("POST", '/?shop-id=123', [], '{}'));
         static::assertSame(204, $response->getStatusCode());
 
         static::assertNull($this->shopRepository->getShopFromId('123'));
@@ -165,7 +165,7 @@ public function testUninstallLogs(): void
             null
         );
 
-        $response = $appLifeCycle->uninstall(new Request("POST", '/?shop-id=123', [], '{}'));
+        $response = $appLifeCycle->delete(new Request("POST", '/?shop-id=123', [], '{}'));
         static::assertSame(204, $response->getStatusCode());
     }
 

tests/HttpClient/SimpleHttpClient/ResponseTest.php

@@ -19,7 +19,7 @@ public function testResponse(): void
         static::assertSame(200, $response->getStatusCode());
         static::assertSame('application/json', $response->getHeader('Content-Type'));
         static::assertSame('{"foo": "bar", "baz": 1}', $response->getContent());
-        static::assertSame(['foo' => 'bar', 'baz' => 1], $response->toArray());
+        static::assertSame(['foo' => 'bar', 'baz' => 1], $response->json());
         static::assertTrue($response->ok());
         static::assertSame($raw, $response->getRawResponse());
     }
@@ -33,7 +33,7 @@ public function testNonArrayResponse(): void
         static::assertSame('application/json', $response->getHeader('Content-Type'));
         static::expectException(\RuntimeException::class);
         static::expectExceptionMessage('Response is not a valid JSON array');
-        $response->toArray();
+        $response->json();
     }
     /**
      * @dataProvider okDataProvider

tests/HttpClient/SimpleHttpClient/SimpleHttpClientTest.php

@@ -42,7 +42,7 @@ public function testGetJSON(): void
         $resp = $simpleHttpClient->get('https://example.com');
 
         static::assertTrue($resp->ok());
-        static::assertSame(['foo' => 'bar'], $resp->toArray());
+        static::assertSame(['foo' => 'bar'], $resp->json());
     }
 
     #[DataProvider('provideMethods')]