add temporary urls

brecht.vermeersch · brecht.vermeersch · commit 82c48267ec9f · 2024-07-04T20:46:51.000+02:00
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ The connection string can be obtained from the azure portal.
 ```php
 <?php
 
-use AzureOss\FlysystemAzureBlobStorage\AzureBlobStorageAdapter;
+use AzureOss\src\AzureBlobStorageAdapter;
 use AzureOss\Storage\Blob\BlobServiceClient;
 use League\Flysystem\Filesystem;
 
diff --git a/composer.json b/composer.json
@@ -11,7 +11,7 @@
     ],
     "autoload": {
         "psr-4": {
-            "AzureOss\\FlysystemAzureBlobStorage\\": "FlysystemAzureBlobStorage/"
+            "AzureOss\\FlysystemAzureBlobStorage\\": "src/"
         }
     },
     "autoload-dev": {
diff --git a/pint.json b/pint.json
@@ -1,5 +1,5 @@
 {
-  "preset": "psr12",
+  "preset": "per",
   "rules": {
     "declare_strict_types": true
   }
diff --git a/src/AzureBlobStorageAdapter.php b/src/AzureBlobStorageAdapter.php
@@ -4,17 +4,13 @@
 
 namespace AzureOss\FlysystemAzureBlobStorage;
 
-use AzureOss\Storage\Blob\ContainerClient;
+use AzureOss\Storage\Blob\Clients\ContainerClient;
 use AzureOss\Storage\Blob\Options\ListBlobsOptions;
 use AzureOss\Storage\Blob\Options\UploadBlockBlobOptions;
-use AzureOss\Storage\Common\SAS\BlobSASPermission;
-use AzureOss\Storage\Common\SAS\BlobSASSignatureValues;
-use AzureOss\Storage\Common\SAS\SasIpRange;
-use AzureOss\Storage\Common\SAS\SasProtocol;
-use AzureOss\Storage\Common\SAS\SharedAccessSignatureHelper;
-use DateTimeInterface;
-use League\Flysystem\CalculateChecksumFromStream;
-use League\Flysystem\ChecksumProvider;
+use AzureOss\Storage\Blob\SAS\BlobSASPermissions;
+use AzureOss\Storage\Blob\SAS\BlobSASQueryParameters;
+use AzureOss\Storage\Blob\SAS\BlobSASSignatureValues;
+use AzureOss\Storage\Common\SAS\SASProtocol;
 use League\Flysystem\Config;
 use League\Flysystem\DirectoryAttributes;
 use League\Flysystem\FileAttributes;
@@ -29,15 +25,12 @@
 use League\Flysystem\UnableToRetrieveMetadata;
 use League\Flysystem\UnableToSetVisibility;
 use League\Flysystem\UnableToWriteFile;
-use League\Flysystem\UrlGeneration\PublicUrlGenerator;
 use League\Flysystem\UrlGeneration\TemporaryUrlGenerator;
 use League\MimeTypeDetection\FinfoMimeTypeDetector;
 use League\MimeTypeDetection\MimeTypeDetector;
 
-class AzureBlobStorageAdapter implements FilesystemAdapter, ChecksumProvider, PublicUrlGenerator, TemporaryUrlGenerator
+class AzureBlobStorageAdapter implements FilesystemAdapter, TemporaryUrlGenerator
 {
-    use CalculateChecksumFromStream;
-
     private readonly MimeTypeDetector $mimeTypeDetector;
 
     public function __construct(
@@ -62,7 +55,7 @@ public function directoryExists(string $path): bool
             $options = new ListBlobsOptions(
                 prefix: $this->getPrefix($path),
                 maxResults: 1,
-                delimiter: "/"
+                delimiter: "/",
             );
 
             $response = $this->containerClient->listBlobs($options);
@@ -200,7 +193,7 @@ private function fetchMetadata(string $path): FileAttributes
             $path,
             fileSize: $response->contentLength,
             lastModified: $response->lastModified->getTimestamp(),
-            mimeType: $response->contentType
+            mimeType: $response->contentType,
         );
     }
 
@@ -262,49 +255,31 @@ private function getPrefix(string $path): ?string
         return $path === "" ? null : rtrim($path, "/") . "/";
     }
 
-    public function checksum(string $path, Config $config): string
-    {
-        return $this->calculateChecksumFromStream($path, $config);
-    }
-
-    public function publicUrl(string $path, Config $config): string
+    public function temporaryUrl(string $path, \DateTimeInterface $expiresAt, Config $config): string
     {
         $url = $this->containerClient->getBlobClient($path)->getUrl();
 
-        $sasValues = new BlobSASSignatureValues(
-            $path,
-            $config->get("cache_control"),
-            $config->get("container_name"),
-            $config->get("content_disposition"),
-            $config->get("content_encoding"),
-            $config->get("content_language"),
-            $config->get("content_type"),
-            $config->get("correlation_id"),
-            $config->get("encryption_scope"),
-            $config->get("expires_on"),
-            $config->get("identifier"),
-            $config->get("ip_range"),
-            $config->get("permissions", [BlobSASPermission::READ]),
-            $config->get("preauthorized_agent_object_id"),
-            $config->get("protocol"),
-            $config->get("snapshot_time"),
-            $config->get("starts_on"),
-            $config->get("version"),
-            $config->get("version_id"),
+        $values = new BlobSASSignatureValues(
+            containerName: $this->containerClient->containerName,
+            expiresOn: $expiresAt,
+            blobName: $path,
+            permissions: $config->get("permissions", (string) new BlobSASPermissions(read: true)),
+            identifier: $config->get("identifier"),
+            startsOn: $config->get("starts_on"),
+            cacheControl: $config->get("cache_control"),
+            contentDisposition: $config->get("content_disposition"),
+            contentEncoding: $config->get("content_encoding"),
+            contentLanguage: $config->get("content_language"),
+            contentType: $config->get("content_type"),
+            encryptionScope: $config->get("encryption_scope"),
+            ipRange: $config->get("ip_range"),
+            snapshotTime: $config->get("snapshot_time"),
+            protocol: $config->get("protocol", SASProtocol::HTTPS_AND_HTTP),
+            version: $config->get("version"),
         );
 
-        $sas = SharedAccessSignatureHelper::generateBlobSASQueryParameters(
-            $sasValues,
-            $this->containerClient->sharedKeyCredentials,
-        );
+        $sas = BlobSASQueryParameters::generate($values, $this->containerClient->sharedKeyCredentials);
 
         return sprintf("%s?%s", $url, $sas);
     }
-
-    public function temporaryUrl(string $path, DateTimeInterface $expiresAt, Config $config): string
-    {
-        $config->withSetting("expires_on", $expiresAt);
-
-        return $this->publicUrl($path, $config);
-    }
 }
diff --git a/tests/AzureBlobStorageTest.php b/tests/AzureBlobStorageTest.php
@@ -5,8 +5,8 @@
 namespace AzureOss\FlysystemAzureBlobStorage\Tests;
 
 use AzureOss\FlysystemAzureBlobStorage\AzureBlobStorageAdapter;
-use AzureOss\Storage\Blob\BlobServiceClient;
-use AzureOss\Storage\Blob\ContainerClient;
+use AzureOss\Storage\Blob\Clients\BlobServiceClient;
+use AzureOss\Storage\Blob\Clients\ContainerClient;
 use League\Flysystem\AdapterTestUtilities\FilesystemAdapterTestCase as TestCase;
 use League\Flysystem\Config;
 use League\Flysystem\FilesystemAdapter;
@@ -32,13 +32,6 @@ private static function createContainerClient(): ContainerClient
         return BlobServiceClient::fromConnectionString($connectionString)->getContainerClient('flysystem');
     }
 
-    public function clearStorage(): void
-    {
-        $containerClient = self::createContainerClient();
-        $containerClient->deleteIfExists();
-        $containerClient->create();
-    }
-
     public function overwriting_a_file(): void
     {
         $this->runScenario(
@@ -50,7 +43,7 @@ function () {
 
                 $contents = $adapter->read('path.txt');
                 $this->assertEquals('new contents', $contents);
-            }
+            },
         );
     }
 
@@ -76,7 +69,7 @@ public function copying_a_file(): void
             $adapter->write(
                 'source.txt',
                 'contents to be copied',
-                new Config([Config::OPTION_VISIBILITY => Visibility::PUBLIC])
+                new Config([Config::OPTION_VISIBILITY => Visibility::PUBLIC]),
             );
 
             $adapter->copy('source.txt', 'destination.txt', new Config());
@@ -94,16 +87,16 @@ public function moving_a_file(): void
             $adapter->write(
                 'source.txt',
                 'contents to be copied',
-                new Config([Config::OPTION_VISIBILITY => Visibility::PUBLIC])
+                new Config([Config::OPTION_VISIBILITY => Visibility::PUBLIC]),
             );
             $adapter->move('source.txt', 'destination.txt', new Config());
             $this->assertFalse(
                 $adapter->fileExists('source.txt'),
-                'After moving a file should no longer exist in the original location.'
+                'After moving a file should no longer exist in the original location.',
             );
             $this->assertTrue(
                 $adapter->fileExists('destination.txt'),
-                'After moving, a file should be present at the new location.'
+                'After moving, a file should be present at the new location.',
             );
             $this->assertEquals('contents to be copied', $adapter->read('destination.txt'));
         });
@@ -116,7 +109,7 @@ public function copying_a_file_again(): void
             $adapter->write(
                 'source.txt',
                 'contents to be copied',
-                new Config()
+                new Config(),
             );
 
             $adapter->copy('source.txt', 'destination.txt', new Config());

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`],`
`12`	`12`	`"autoload": {`
`13`	`13`	`"psr-4": {`
`14`		`- "AzureOss\\FlysystemAzureBlobStorage\\": "FlysystemAzureBlobStorage/"`
	`14`	`+ "AzureOss\\FlysystemAzureBlobStorage\\": "src/"`
`15`	`15`	`}`
`16`	`16`	`},`
`17`	`17`	`"autoload-dev": {`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "preset": "psr12",`
	`2`	`+ "preset": "per",`
`3`	`3`	`"rules": {`
`4`	`4`	`"declare_strict_types": true`
`5`	`5`	`}`