Merge pull request #5 from sjspereira/develop

Branch Merger
xray-labs · Jul 14, 2024 · 410c3ce · 410c3ce
2 parents 463e1bc + 0800305
commit 410c3ce
Show file tree

Hide file tree

Showing 70 changed files with 2,487 additions and 239 deletions.
diff --git a/.github/workflows/CI.yaml b/.github/workflows/CI.yaml
@@ -35,4 +35,4 @@ jobs:
         run: ./vendor/bin/phpstan analyse
 
       - name: Run Pest
-        run: ./vendor/bin/pest --coverage --min=100 --parallel
+        run: ./vendor/bin/pest --coverage --min=80 --parallel
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 
+[![PHP CI](https://github.com/sjspereira/azure-storage-php-sdk/actions/workflows/CI.yaml/badge.svg)](https://github.com/sjspereira/azure-storage-php-sdk/actions/workflows/CI.yaml)
+
 ## Description
 
 Integrate with Azure's cloud storage services

diff --git a/src/Authentication/MicrosoftEntraId.php b/src/Authentication/MicrosoftEntraId.php
@@ -0,0 +1,76 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sjpereira\AzureStoragePhpSdk\Authentication;
+
+use DateTime;
+use GuzzleHttp\Client;
+use Psr\Http\Client\RequestExceptionInterface;
+use Sjpereira\AzureStoragePhpSdk\BlobStorage\Enums\HttpVerb;
+use Sjpereira\AzureStoragePhpSdk\Contracts\Authentication\Auth;
+use Sjpereira\AzureStoragePhpSdk\Exceptions\RequestException;
+use Sjpereira\AzureStoragePhpSdk\Http\{Headers};
+
+final class MicrosoftEntraId implements Auth
+{
+    protected string $token = '';
+
+    protected ?DateTime $tokenExpiresAt = null;
+
+    public function __construct(
+        protected string $account,
+        protected string $directoryId,
+        protected string $applicationId,
+        protected string $applicationSecret,
+    ) {
+        //
+    }
+
+    public function getDate(): string
+    {
+        return gmdate('D, d M Y H:i:s T');
+    }
+
+    public function getAccount(): string
+    {
+        return $this->account;
+    }
+
+    public function getAuthentication(
+        HttpVerb $verb,
+        Headers $headers,
+        string $resource,
+    ): string {
+        if (!empty($this->token) && $this->tokenExpiresAt > new DateTime()) {
+            return $this->token;
+        }
+
+        $this->authenticate();
+
+        return $this->token;
+    }
+
+    protected function authenticate(): void
+    {
+        try {
+            $response = (new Client())->post("https://login.microsoftonline.com/{$this->directoryId}/oauth2/v2.0/token", [
+                'form_params' => [
+                    'grant_type'    => 'client_credentials',
+                    'client_id'     => $this->applicationId,
+                    'client_secret' => $this->applicationSecret,
+                    'scope'         => 'https://storage.azure.com/.default',
+                ],
+            ]);
+        } catch (RequestExceptionInterface $e) {
+            throw RequestException::createFromRequestException($e);
+        }
+
+        /** @var array{token_type: string, expires_in: int, access_token: string} */
+        $body = json_decode((string) $response->getBody(), true);
+
+        $this->token = "{$body['token_type']} {$body['access_token']}";
+
+        $this->tokenExpiresAt = (new DateTime())->modify("+{$body['expires_in']} seconds");
+    }
+}
diff --git a/src/Authentication/SharedKeyAuth.php b/src/Authentication/SharedKeyAuth.php
@@ -4,14 +4,13 @@
 
 namespace Sjpereira\AzureStoragePhpSdk\Authentication;
 
-use Sjpereira\AzureStoragePhpSdk\BlobStorage\Config;
 use Sjpereira\AzureStoragePhpSdk\BlobStorage\Enums\HttpVerb;
 use Sjpereira\AzureStoragePhpSdk\Contracts\Authentication\Auth;
 use Sjpereira\AzureStoragePhpSdk\Http\Headers;
 
 final class SharedKeyAuth implements Auth
 {
-    public function __construct(protected Config $config)
+    public function __construct(protected string $account, protected string $key)
     {
         //
     }
@@ -21,12 +20,17 @@ public function getDate(): string
         return gmdate('D, d M Y H:i:s T');
     }
 
+    public function getAccount(): string
+    {
+        return $this->account;
+    }
+
     public function getAuthentication(
         HttpVerb $verb,
         Headers $headers,
         string $resource,
     ): string {
-        $key = base64_decode($this->config->key);
+        $key = base64_decode($this->key);
 
         $stringToSign = $this->getSigningString(
             $verb->value,
@@ -37,11 +41,11 @@ public function getAuthentication(
 
         $signature = base64_encode(hash_hmac('sha256', $stringToSign, $key, true));
 
-        return "SharedKey {$this->config->account}:{$signature}";
+        return "SharedKey {$this->account}:{$signature}";
     }
 
     protected function getSigningString(string $verb, string $headers, string $canonicalHeaders, string $resource): string
     {
-        return "{$verb}\n{$headers}\n{$canonicalHeaders}\n/{$this->config->account}{$resource}";
+        return "{$verb}\n{$headers}\n{$canonicalHeaders}\n/{$this->account}{$resource}";
     }
 }
diff --git a/src/BlobStorage/BlobStorage.php b/src/BlobStorage/BlobStorage.php
@@ -6,10 +6,7 @@
 
 use Sjpereira\AzureStoragePhpSdk\BlobStorage\Managers\Blob\BlobManager;
 use Sjpereira\AzureStoragePhpSdk\BlobStorage\Managers\{AccountManager, ContainerManager};
-use Sjpereira\AzureStoragePhpSdk\Contracts\Authentication\Auth;
 use Sjpereira\AzureStoragePhpSdk\Contracts\Http\Request as RequestContract;
-use Sjpereira\AzureStoragePhpSdk\Contracts\{Converter, Parser};
-use Sjpereira\AzureStoragePhpSdk\Http\Request;
 
 final class BlobStorage
 {
@@ -18,14 +15,6 @@ public function __construct(protected RequestContract $request)
         //
     }
 
-    /** @param array{account: string, key: string, version?: string, parser?: Parser, converter?: Converter, auth?: Auth} $options */
-    public static function client(array $options, ?RequestContract $request = null): self
-    {
-        $config = new Config($options);
-
-        return new self($request ?? new Request($config));
-    }
-
     public function account(): AccountManager
     {
         return new AccountManager($this->request);

diff --git a/src/BlobStorage/Concerns/ValidateContainerName.php b/src/BlobStorage/Concerns/ValidateContainerName.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sjpereira\AzureStoragePhpSdk\BlobStorage\Concerns;
+
+use Sjpereira\AzureStoragePhpSdk\Exceptions\InvalidArgumentException;
+
+trait ValidateContainerName
+{
+    /** @throws InvalidArgumentException */
+    protected function validateContainerName(string $name): void
+    {
+        $replaced = preg_replace('/[^a-z0-9-]/', '', $name);
+
+        if ($replaced !== $name) {
+            throw InvalidArgumentException::create("Invalid container name: {$name}");
+        }
+    }
+}
diff --git a/src/BlobStorage/Concerns/ValidateMetadataKey.php b/src/BlobStorage/Concerns/ValidateMetadataKey.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sjpereira\AzureStoragePhpSdk\BlobStorage\Concerns;
+
+use Sjpereira\AzureStoragePhpSdk\Exceptions\InvalidArgumentException;
+
+trait ValidateMetadataKey
+{
+    /** @throws InvalidArgumentException */
+    protected function validateMetadataKey(string $key): void
+    {
+        $message = "Invalid metadata key: {$key}.";
+
+        if (is_numeric($key[0])) {
+            throw InvalidArgumentException::create("{$message} Metadata keys cannot start with a number.");
+        }
+
+        $name = preg_replace('/[^a-z0-9_]/i', '', $key);
+
+        if ($key !== $name) {
+            throw InvalidArgumentException::create("{$message} Only alphanumeric characters and underscores are allowed.");
+        }
+    }
+}
diff --git a/src/BlobStorage/Config.php b/src/BlobStorage/Config.php
@@ -4,49 +4,31 @@
 
 namespace Sjpereira\AzureStoragePhpSdk\BlobStorage;
 
-use Sjpereira\AzureStoragePhpSdk\Authentication\SharedKeyAuth;
 use Sjpereira\AzureStoragePhpSdk\Contracts\Authentication\Auth;
 use Sjpereira\AzureStoragePhpSdk\Contracts\{Converter, Parser};
 use Sjpereira\AzureStoragePhpSdk\Converter\XmlConverter;
 use Sjpereira\AzureStoragePhpSdk\Exceptions\InvalidArgumentException;
 use Sjpereira\AzureStoragePhpSdk\Parsers\XmlParser;
 
 /**
- * @phpstan-type ConfigType array{account: string, key: string, version?: string, parser?: Parser, converter?: Converter, auth?: Auth}
+ * @phpstan-type ConfigType array{version?: string, parser?: Parser, converter?: Converter}
  */
 final readonly class Config
 {
-    public string $account;
-
-    public string $key;
-
     public string $version;
 
     public Parser $parser;
 
     public Converter $converter;
 
-    public Auth $auth;
-
     /**
      * @param ConfigType $config
      * @throws InvalidArgumentException
      */
-    public function __construct(array $config)
+    public function __construct(public Auth $auth, array $config = [])
     {
-        if (empty($config['account'] ?? null)) { // @phpstan-ignore-line
-            throw InvalidArgumentException::create('Account name must be provided.');
-        }
-
-        if (empty($config['key'] ?? null)) { // @phpstan-ignore-line
-            throw InvalidArgumentException::create('Account key must be provided.');
-        }
-
-        $this->account   = $config['account'];
-        $this->key       = $config['key'];
         $this->version   = $config['version'] ?? Resource::VERSION;
         $this->parser    = $config['parser'] ?? new XmlParser();
         $this->converter = $config['converter'] ?? new XmlConverter();
-        $this->auth      = $config['auth'] ?? new SharedKeyAuth($this);
     }
 }
diff --git a/src/BlobStorage/Entities/Account/BlobStorageProperty/BlobProperty.php b/src/BlobStorage/Entities/Account/BlobStorageProperty/BlobProperty.php
@@ -43,31 +43,31 @@ public function __construct(array $blobProperty)
 
         $this->logging = isset($blobProperty['Logging'])
             ? new Logging($blobProperty['Logging'])
-            : null;
+            : null; // @codeCoverageIgnore
 
         $this->hourMetrics = isset($blobProperty['HourMetrics'])
             ? new HourMetrics($blobProperty['HourMetrics'])
-            : null;
+            : null; // @codeCoverageIgnore
 
         $this->minuteMetrics = isset($blobProperty['MinuteMetrics'])
             ? new MinuteMetrics($blobProperty['MinuteMetrics'])
-            : null;
+            : null; // @codeCoverageIgnore
 
         if (isset($blobProperty['Cors'])) {
             $this->cors = isset($blobProperty['Cors']['CorsRule'])
                 ? new Cors($blobProperty['Cors']['CorsRule'])
-                : new Cors([]);
+                : new Cors([]); // @codeCoverageIgnore
         } else {
-            $this->cors = null;
+            $this->cors = null; // @codeCoverageIgnore
         }
 
         $this->deleteRetentionPolicy = isset($blobProperty['DeleteRetentionPolicy'])
             ? new DeleteRetentionPolicy($blobProperty['DeleteRetentionPolicy'])
-            : null;
+            : null; // @codeCoverageIgnore
 
         $this->staticWebsite = isset($blobProperty['StaticWebsite'])
             ? new StaticWebsite($blobProperty['StaticWebsite'])
-            : null;
+            : null; // @codeCoverageIgnore
     }
 
     public function toArray(): array

diff --git a/src/BlobStorage/Entities/Account/BlobStorageProperty/DeleteRetentionPolicy.php b/src/BlobStorage/Entities/Account/BlobStorageProperty/DeleteRetentionPolicy.php
@@ -26,7 +26,7 @@ public function __construct(array $deleteRetentionPolicy)
         $this->allowPermanentDelete = to_boolean($deleteRetentionPolicy['AllowPermanentDelete'] ?? false);
         $this->days                 = isset($deleteRetentionPolicy['Days'])
             ? (int) $deleteRetentionPolicy['Days']
-            : null;
+            : null; // @codeCoverageIgnore
     }
 
     public function toArray(): array

diff --git a/src/BlobStorage/Entities/Account/BlobStorageProperty/HourMetrics.php b/src/BlobStorage/Entities/Account/BlobStorageProperty/HourMetrics.php
@@ -33,7 +33,7 @@ public function __construct(array $hourMetrics)
         $this->retentionPolicyEnabled = to_boolean($hourMetrics['RetentionPolicy']['Enabled'] ?? false);
         $this->retentionPolicyDays    = isset($hourMetrics['RetentionPolicy']['Days'])
             ? (int) $hourMetrics['RetentionPolicy']['Days']
-            : null;
+            : null; // @codeCoverageIgnore
     }
 
     public function toArray(): array

diff --git a/src/BlobStorage/Entities/Account/BlobStorageProperty/Logging.php b/src/BlobStorage/Entities/Account/BlobStorageProperty/Logging.php
@@ -36,7 +36,7 @@ public function __construct(array $logging)
         $this->retentionPolicyEnabled = to_boolean($logging['RetentionPolicy']['Enabled'] ?? false);
         $this->retentionPolicyDays    = isset($logging['RetentionPolicy']['Days'])
             ? (int) $logging['RetentionPolicy']['Days']
-            : null;
+            : null; // @codeCoverageIgnore
     }
 
     public function toArray(): array

diff --git a/src/BlobStorage/Entities/Account/BlobStorageProperty/MinuteMetrics.php b/src/BlobStorage/Entities/Account/BlobStorageProperty/MinuteMetrics.php
@@ -33,7 +33,7 @@ public function __construct(array $minuteMetrics)
         $this->retentionPolicyEnabled = to_boolean($minuteMetrics['RetentionPolicy']['Enabled'] ?? false);
         $this->retentionPolicyDays    = isset($minuteMetrics['RetentionPolicy']['Days'])
             ? (int) $minuteMetrics['RetentionPolicy']['Days']
-            : null;
+            : null; // @codeCoverageIgnore
     }
 
     public function toArray(): array

diff --git a/src/BlobStorage/Entities/Account/KeyInfo.php b/src/BlobStorage/Entities/Account/KeyInfo.php
@@ -23,11 +23,13 @@
      */
     public function __construct(array $keyInfo)
     {
+        // @codeCoverageIgnoreStart
         if (!isset($keyInfo['Start'], $keyInfo['Expiry'])) {
             throw RequiredFieldException::missingField(
                 !isset($keyInfo['Start']) ? 'Start' : 'Expiry'
             );
         }
+        // @codeCoverageIgnoreEnd
 
         $this->start  = new DateTimeImmutable($keyInfo['Start']);
         $this->expiry = new DateTimeImmutable($keyInfo['Expiry']);