Add more support to entity builder and authorisation setup command

Author: DannyvdSluijs

DevTools/Command/AuthorisationSetupCommand.php

@@ -2,6 +2,7 @@
 
 namespace DevTools\Command;
 
+use DevTools\ValueObjects\OAuthClient;
 use DevTools\ValueObjects\OAuthTokenSet;
 use GuzzleHttp\Client;
 use GuzzleHttp\HandlerStack;
@@ -59,11 +60,10 @@ protected function initialize(InputInterface $input, OutputInterface $output): v
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $this->checkRedirectUriValue();
-        $clientId = $this->askClientId();
-        $clientSecret = $this->askClientSecret();
-        $authorisationCode = $this->getAuthorisationCode($clientId);
-        $tokenSet = $this->fetchTokens($clientId, $clientSecret, $authorisationCode);
-        $this->writeTokenSetToFile($tokenSet);
+        $client = $this->askClientDetails();
+        $authorisationCode = $this->getAuthorisationCode($client);
+        $tokenSet = $this->fetchTokens($client, $authorisationCode);
+        $this->writeToFile($client, $tokenSet);
 
         return 0;
     }
@@ -78,24 +78,29 @@ private function checkRedirectUriValue(): void
         }
     }
 
-    private function askClientId(): string
+    private function askClientDetails(): OAuthClient
     {
-        $question = new Question('What is the Client ID (Can be found in the Exact App Center)? ');
-        return $this->questionHelper->ask($this->input, $this->output, $question);
-    }
+        $clientId = $this->questionHelper->ask(
+            $this->input,
+            $this->output,
+            new Question('What is the Client ID (Can be found in the Exact App Center)? ')
+        );
 
-    private function askClientSecret(): string
-    {
-        $question = new Question('What is the Client secret (Can be found in the Exact App Center)? ');
-        return $this->questionHelper->ask($this->input, $this->output, $question);
+        $clientSecret = $this->questionHelper->ask(
+            $this->input,
+            $this->output,
+            new Question('What is the Client secret (Can be found in the Exact App Center)? ')
+        );
+
+        return new OAuthClient($clientId, $clientSecret);
     }
 
-    private function getAuthorisationCode(string $clientId): string
+    private function getAuthorisationCode(OAuthClient $client): string
     {
         $this->startHttpListening();
 
         $url = self::$baseUrl . self::$authUrl . '?' . http_build_query([
-            'client_id' => $clientId,
+            'client_id' => $client->getId(),
             'redirect_uri' => self::$redirectUri,
             'response_type' => 'code'
         ]);
@@ -115,7 +120,7 @@ private function getAuthorisationCode(string $clientId): string
                 $i++;
             } else {
                 $code = file_get_contents($filename);
-                if ($code === null) {
+                if ($code === false) {
                     $this->output->writeln('Unable to read code from file, halting!');
                     $this->stopHttpListening();
                     exit(1);
@@ -143,7 +148,7 @@ private function stopHttpListening(): void
         shell_exec(sprintf('kill %d 2>&1', $this->pid));
     }
 
-    private function fetchTokens(string $clientId, string $clientSecret, string $authorisationCode): OAuthTokenSet
+    private function fetchTokens(OAuthClient $client, string $authorisationCode): OAuthTokenSet
     {
         $this->output->writeln('Requesting access and refresh tokens.');
 
@@ -152,8 +157,8 @@ private function fetchTokens(string $clientId, string $clientSecret, string $aut
             'form_params' => [
                 'redirect_uri' => self::$redirectUri,
                 'grant_type' => 'authorization_code',
-                'client_id' => $clientId,
-                'client_secret' => $clientSecret,
+                'client_id' => $client->getId(),
+                'client_secret' => $client->getSecret(),
                 'code' => $authorisationCode
             ]
         ];
@@ -177,12 +182,18 @@ private function getFullDestinationPath(string $destination): string
         return getcwd() . DIRECTORY_SEPARATOR . $destination;
     }
 
-    private function writeTokenSetToFile(OAuthTokenSet $tokenSet): void
+    private function writeToFile(OAuthClient $client, OAuthTokenSet $tokenSet): void
     {
-        $path = $this->getFullDestinationPath($this->input->getOption('output'));
+        $output = $this->input->getOption('output');
+
+        if (! is_string($output)) {
+            throw new \InvalidArgumentException('Output parameter should be a string');
+        }
+
+        $path = $this->getFullDestinationPath($output);
         $fileName = $path . DIRECTORY_SEPARATOR . 'oauth.json';
 
-        file_put_contents($fileName, json_encode($tokenSet, JSON_PRETTY_PRINT));
+        file_put_contents($fileName, json_encode(array_merge($client->jsonSerialize(), $tokenSet->jsonSerialize()), JSON_PRETTY_PRINT));
 
         $this->output->writeln('Access and refresh tokens are available in: ' . $fileName);
     }

DevTools/TwigExtension.php

@@ -24,6 +24,9 @@ public function getFilters(): array
             new TwigFilter('derivePropertyName', function (Property $property) : string {
                 return $this->derivePropertyName($property);
             }),
+            new TwigFilter('deriveEndpointUri', function (Endpoint $endpoint) : string {
+                return $this->deriveEndpointUri($endpoint);
+            }),
         ];
     }
 
@@ -76,12 +79,17 @@ public function derivePropertyName(Property $property): string
         return lcfirst($property->getName());
     }
 
+    public function deriveEndpointUri(Endpoint $endpoint): string
+    {
+        return ltrim($endpoint->getUri(), '/api/v1/{division}');
+    }
+
     private function propertyIsApiEntity(Property $property): bool
     {
         return strpos($property->getType(), 'Exact.Web.Api.Models.') === 0;
     }
 
-    private function mapPropertyTypeToApiEntityClassName(Property $property)
+    private function mapPropertyTypeToApiEntityClassName(Property $property): string
     {
         $propertyType = ltrim($property->getType(), 'Exact.Web.Api.Models.');
         $propertyType = str_replace('.', '\\', $propertyType);

DevTools/ValueObjects/OAuthClient.php

@@ -0,0 +1,36 @@
+<?php declare(strict_types=1);
+
+namespace DevTools\ValueObjects;
+
+
+class OAuthClient implements \JsonSerializable
+{
+    /** @var string */
+    private $id;
+    /** @var string */
+    private $secret;
+
+    public function __construct(string $id, string $secret)
+    {
+        $this->id = $id;
+        $this->secret = $secret;
+    }
+
+    public function getId(): string
+    {
+        return $this->id;
+    }
+
+    public function getSecret(): string
+    {
+        return $this->secret;
+    }
+
+    public function jsonSerialize(): array
+    {
+        return [
+            'client_id' => $this->id,
+            'client_secret' => $this->secret
+        ];
+    }
+}

composer.json

@@ -34,12 +34,10 @@
         "rector/rector": "^0.5.8"
     },
     "scripts": {
-        "phpcs": [
-            "./vendor/bin/phpcs --standard=PSR2 DevTools template application.php"
-        ],
-        "phpcbf": [
-            "./vendor/bin/phpcbf --standard=PSR2 DevTools template application.php"
-        ]
+        "phpcs": ["./vendor/bin/phpcs --standard=PSR2 DevTools template application.php"],
+        "phpcbf": ["./vendor/bin/phpcbf --standard=PSR2 DevTools template application.php"],
+        "phpstan": "./vendor/bin/phpstan analyse",
+        "build-entities": ["./exact-online-api-client-dev-tools build-entities --destination entities"]
     },
     "bin": [
         "exact-online-api-client-dev-tools"

phpstan.neon.dist

@@ -0,0 +1,4 @@
+parameters:
+  level: max
+  paths:
+    - DevTools

template/entity.php.template

@@ -22,4 +22,9 @@ class {{ endpoint|className }} extends Entity
         return $this->{{ property|derivePropertyName }};
     }
 {% endfor %}
+
+    public static function getApiEndpoint(): string
+    {
+        return '{{ endpoint|deriveEndpointUri }}';
+    }
 }