Merge branch '1-0-0' into 'main'

1-0-0

See merge request fluxlabs/flux-eco/open-api-client!3

README.md

@@ -2,6 +2,25 @@
 
 This component is supposed to assist in querying openapis.
 
+## Functional Usage
+
+```
+fluxDotEnv\loadDotEnv(__DIR__);
+
+$result = fluxOpenApiClient\query('/api/ilias/accounts', [], 'EXAMPLE_');
+print_r($result); exit;
+```
+
+outputs:
+```
+Array
+(
+  [firstname] => Emmett
+  [lastname] => Brown
+  [lastChanged] => 2021-01-15T05:30:10+01:00
+)
+```
+
 ## Contributing :purple_heart:
 
 Please ...

composer.json

@@ -32,9 +32,15 @@
     "swoole/ide-helper": ">=4.6"
   },
   "autoload": {
+    "files": [
+      "fn/query.php"
+    ],
     "psr-4": {
       "FluxEco\\OpenApiClient\\": [
         "src/"
+      ],
+      "fluxOpenApiClient\\": [
+        "fn/"
       ]
     }
   },

examples/query.php

@@ -2,16 +2,7 @@
 
 require_once __DIR__ . '/../vendor/autoload.php';
 
-fluxy\loadDotEnv(__DIR__);
+fluxDotEnv\loadDotEnv(__DIR__);
 
-$client = FluxEco\OpenApiClient\OpenApiClientApi::new(
-    FluxEco\OpenApiClient\OpenApiClientConfig::new(
-        getenv('EXAMPLE_OPEN_API_CLIENT_ID'),
-        getenv('EXAMPLE_OPEN_API_SECRET'),
-        getenv('EXAMPLE_OPEN_API_SCOPE'),
-        getenv('EXAMPLE_OPEN_API_API_URL'),
-        getenv('EXAMPLE_OPEN_API_AUTHENTICATION_URL'),
-    )
-);
-$result = $client->query('/api/ilias/accounts');
+$result = fluxOpenApiClient\query('/api/ilias/accounts', [], 'EXAMPLE_');
 print_r($result); exit;

fn/query.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace fluxOpenApiClient;
+
+use FluxEco\OpenApiClient;
+
+function query(string $endpoint, array $filter = [], string $envPrefix = '') : array
+{
+    return OpenApiClient\Api::newFromEnv($envPrefix)->query($endpoint, $filter);
+}

src/Adapters/Outbounds.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace FluxEco\OpenApiClient\Adapters;
+use FluxEco\OpenApiClient\Core\Ports;
+
+class Outbounds implements Ports\Outbounds
+{
+    private Ports\Config $config;
+
+    private function __construct(Ports\Config $config)
+    {
+        $this->config = $config;
+    }
+
+    public static function new(Ports\Config $config): self
+    {
+        return new self($config);
+    }
+
+    final public function getConfig(): Ports\Config
+    {
+        return $this->config;
+    }
+
+}

src/OpenApiClientApi.php → src/Api.php

@@ -2,7 +2,9 @@
 
 namespace FluxEco\OpenApiClient;
 
-class OpenApiClientApi
+use FluxEco\OpenApiClient\Adapters\Outbounds;
+
+class Api
 {
     private Core\Ports\OpenApiService $openApiService;
 
@@ -12,9 +14,16 @@ private function __construct(
         $this->openApiService = $openApiService;
     }
 
-    public static function new(OpenApiClientConfig $openApiConfig) : self
+    public static function new(Config $config) : self
+    {
+        $outbounds = Outbounds::new($config);
+        $openApiService = Core\Ports\OpenApiService::new($outbounds);
+        return new self($openApiService);
+    }
+
+    public static function newFromEnv(string $envPrefix) : self
     {
-        $outbounds = Adapters\Configs\OpenApiOutbounds::new($openApiConfig);
+        $outbounds = Outbounds::new(Config::newFromEnv($envPrefix));
         $openApiService = Core\Ports\OpenApiService::new($outbounds);
         return new self($openApiService);
     }

src/OpenApiClientConfig.php → src/Config.php

@@ -1,11 +1,10 @@
 <?php
 
-
 namespace FluxEco\OpenApiClient;
 
 use FluxEco\OpenApiClient\Core\{Ports};
 
-class OpenApiClientConfig implements Ports\Configs\OpenApiConfig
+class Config implements Ports\Config
 {
     private string $clientId;
     private string $secret;
@@ -19,8 +18,7 @@ private function __construct(
         string $scope,
         string $apiUrl,
         string $authenticationUrl
-    )
-    {
+    ) {
         $this->clientId = $clientId;
         $this->secret = $secret;
         $this->scope = $scope;
@@ -34,8 +32,7 @@ public static function new(
         string $scope,
         string $apiUrl,
         string $authenticationUrl
-    ): self
-    {
+    ) : self {
         return new self(
             $clientId,
             $secret,
@@ -45,27 +42,39 @@ public static function new(
         );
     }
 
-    final public function getClientId(): string
+    public static function newFromEnv(string $envPrefix) : self
+    {
+        $apiEnv = Env::new($envPrefix);
+        return new self(
+            $apiEnv->getOpenApiClientId(),
+            $apiEnv->getOpenApiSecret(),
+            $apiEnv->getOpenApiScope(),
+            $apiEnv->getOpenApiUrl(),
+            $apiEnv->getOpenApiAuthenticationUrl()
+        );
+    }
+
+    final public function getClientId() : string
     {
         return $this->clientId;
     }
 
-    final public function getSecret(): string
+    final public function getSecret() : string
     {
         return $this->secret;
     }
 
-    final public function getScope(): string
+    final public function getScope() : string
     {
         return $this->scope;
     }
 
-    final public function getApiUrl(): string
+    final public function getApiUrl() : string
     {
         return $this->apiUrl;
     }
 
-    final public function getAuthenticationUrl(): string
+    final public function getAuthenticationUrl() : string
     {
         return $this->authenticationUrl;
     }

src/Core/Application/Handlers/AuthorizationHandler.php

@@ -43,8 +43,6 @@ public function handle(AuthorizationCommand $command): Domain\Models\Authorizati
 
             $status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
             if ($status !== 200) {
-                print_r($content);
-                print_r($status);
                 throw new Exception($content, $status);
             }
 

src/Core/Ports/Configs/OpenApiConfig.php → src/Core/Ports/Config.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace FluxEco\OpenApiClient\Core\Ports\Configs;
+namespace FluxEco\OpenApiClient\Core\Ports;
 
-interface OpenApiConfig
+interface Config
 {
     public function getClientId(): string;
 

src/Core/Ports/OpenApiService.php

@@ -6,27 +6,27 @@
 
 class OpenApiService
 {
-    private Ports\Configs\OpenApiConfig $openApiConfig;
+    private Ports\Config $config;
 
     private function __construct(
-        Ports\Configs\OpenApiConfig $openApiConfig
+        Ports\Config $config
     )
     {
-        $this->openApiConfig = $openApiConfig;
+        $this->config = $config;
     }
 
     public static function new(
-        Ports\Configs\OpenApiOutbounds $openApiOutbounds
+        Ports\Outbounds $openApiOutbounds
     ): self
     {
         return new self(
-            $openApiOutbounds->getOpenApiConfig()
+            $openApiOutbounds->getConfig()
         );
     }
 
     public function query(string $endpoint, array $filter): array
     {
-        $openApiConfig = $this->openApiConfig;
+        $openApiConfig = $this->config;
         $authorizationCommand = Application\Handlers\AuthorizationCommand::new(
             $openApiConfig->getClientId(),
             $openApiConfig->getSecret(),

src/Core/Ports/Outbounds.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace FluxEco\OpenApiClient\Core\Ports;
+
+interface Outbounds
+{
+    public function getConfig(): Config;
+}

src/Env.php

@@ -0,0 +1,45 @@
+<?php
+
+
+namespace FluxEco\OpenApiClient;
+
+use FluxEco\OpenApiClient\Core\{Ports};
+
+class Env
+{
+    public const OPEN_API_CLIENT_ID='OPEN_API_CLIENT_ID';
+    public const OPEN_API_SECRET='OPEN_API_SECRET';
+    public const OPEN_API_SCOPE='OPEN_API_SCOPE';
+    public const OPEN_API_API_URL='OPEN_API_API_URL';
+    public const OPEN_API_AUTHENTICATION_URL='OPEN_API_AUTHENTICATION_URL';
+
+    private string $envPrefix;
+
+    private function __construct(string $envPrefix) {
+        $this->envPrefix = $envPrefix;
+    }
+
+    public static function new(string $envPrefix = '') {
+        return new self($envPrefix);
+    }
+
+    public function getOpenApiClientId(): string {
+        return getenv($this->envPrefix.self::OPEN_API_CLIENT_ID);
+    }
+
+    public function getOpenApiSecret(): string {
+        return getenv($this->envPrefix.self::OPEN_API_SECRET);
+    }
+
+    public function getOpenApiScope(): string {
+        return getenv($this->envPrefix.self::OPEN_API_SCOPE);
+    }
+
+    public function getOpenApiUrl(): string {
+        return getenv($this->envPrefix.self::OPEN_API_API_URL);
+    }
+
+    public function getOpenApiAuthenticationUrl(): string {
+        return getenv($this->envPrefix.self::OPEN_API_AUTHENTICATION_URL);
+    }
+}