feat: add BunnyCDN Storage adapter

Author: FluffyDiscord

README.md

@@ -112,6 +112,7 @@ to interact with your storage.
 5. [Creating a custom adapter](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/5-creating-a-custom-adapter.md)
 6. [MongoDB GridFS](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/6-gridfs.md)
 7. [WebDAV](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/7-webdav.md)
+8. [BunnyCDN](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/8-bunnycdn.md)
 
 * [Security issue disclosure procedure](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/A-security-disclosure-procedure.md)
 * [Configuration reference](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/B-configuration-reference.md)

composer.json

@@ -46,6 +46,7 @@
         "league/flysystem-read-only": "^3.15",
         "league/flysystem-sftp-v3": "^3.1",
         "league/flysystem-webdav": "^3.29",
+        "platformcommunity/flysystem-bunnycdn": "^3.3",
         "symfony/dotenv": "^5.4 || ^6.0 || ^7.0",
         "symfony/framework-bundle": "^5.4 || ^6.0 || ^7.0",
         "symfony/phpunit-bridge": "^5.4 || ^6.0 || ^7.0",

docs/8-bunnycdn.md

@@ -0,0 +1,33 @@
+# BunnyCDN Storage
+
+Flysystem is able to [interact with BunnyCDN Storage servers](https://bunny.net/storage/).
+To configure this bundle for such usage, you can rely on adapters in the same way you would
+for other storages.
+
+### Installation
+
+```
+composer require platformcommunity/flysystem-bunnycdn
+```
+
+### Usage
+
+```yaml
+# config/packages/flysystem.yaml
+
+services:
+  bunny_client:
+    class: PlatformCommunity\Flysystem\BunnyCDN\BunnyCDNClient
+    arguments:
+      $storage_zone_name: 'storage-zone'
+      $api_key: 'api-key'
+      $region: '!php/const:PlatformCommunity\Flysystem\BunnyCDN\BunnyCDNRegion::FALKENSTEIN'
+
+flysystem:
+    storages:
+        bunny.storage:
+            adapter: 'bunnycdn'
+            options:
+                client: 'bunny_client'
+                pull_zone: 'https://testing.b-cdn.net/' # optional
+```

src/Adapter/AdapterDefinitionFactory.php

@@ -39,6 +39,7 @@ public function __construct()
             new Builder\MemoryAdapterDefinitionBuilder(),
             new Builder\SftpAdapterDefinitionBuilder(),
             new Builder\WebDAVAdapterDefinitionBuilder(),
+            new Builder\BunnyCDNAdapterDefinitionBuilder(),
         ];
     }
 

src/Adapter/Builder/BunnyCDNAdapterDefinitionBuilder.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the flysystem-bundle project.
+ *
+ * (c) Titouan Galopin <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace League\FlysystemBundle\Adapter\Builder;
+
+use PlatformCommunity\Flysystem\BunnyCDN\BunnyCDNAdapter;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * @internal
+ */
+final class BunnyCDNAdapterDefinitionBuilder extends AbstractAdapterDefinitionBuilder
+{
+    public function getName(): string
+    {
+        return 'bunnycdn';
+    }
+
+    protected function getRequiredPackages(): array
+    {
+        return [
+            BunnyCDNAdapter::class => 'platformcommunity/flysystem-bunnycdn',
+        ];
+    }
+
+    protected function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setRequired('client');
+        $resolver->setAllowedTypes('client', 'string');
+
+        $resolver->setDefault('pull_zone', '');
+        $resolver->setAllowedTypes('pull_zone', 'string');
+    }
+
+    protected function configureDefinition(Definition $definition, array $options, ?string $defaultVisibilityForDirectories): void
+    {
+        $definition->setClass(BunnyCDNAdapter::class);
+        $definition->setArguments([
+            new Reference($options['client']),
+            $options['pull_zone'],
+        ]);
+    }
+}

tests/Adapter/Builder/BunnyCDNAdapterDefinitionBuilderTest.php

@@ -0,0 +1,57 @@
+<?php
+
+/*
+ * This file is part of the flysystem-bundle project.
+ *
+ * (c) Titouan Galopin <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Tests\League\FlysystemBundle\Adapter\Builder;
+
+use League\Flysystem\Visibility;
+use League\FlysystemBundle\Adapter\Builder\BunnyCDNAdapterDefinitionBuilder;
+use PHPUnit\Framework\TestCase;
+use PlatformCommunity\Flysystem\BunnyCDN\BunnyCDNAdapter;
+
+class BunnyCDNAdapterDefinitionBuilderTest extends TestCase
+{
+    public function createBuilder(): BunnyCDNAdapterDefinitionBuilder
+    {
+        return new BunnyCDNAdapterDefinitionBuilder();
+    }
+
+    public static function provideValidOptions(): \Generator
+    {
+        yield 'minimal' => [[
+            'client' => 'bunny_client',
+        ]];
+
+        yield 'full' => [[
+            'client' => 'bunny_client',
+            'pull_zone' => 'z1',
+        ]];
+    }
+
+    /**
+     * @dataProvider provideValidOptions
+     */
+    public function testCreateDefinition(array $options): void
+    {
+        $this->assertSame(BunnyCDNAdapter::class, $this->createBuilder()->createDefinition($options, null)->getClass());
+    }
+
+    public function testOptionsBehavior(): void
+    {
+        $definition = $this->createBuilder()->createDefinition([
+            'client' => 'bunny_client',
+            'pull_zone' => 'z1',
+        ], Visibility::PUBLIC);
+
+        $this->assertSame(BunnyCDNAdapter::class, $definition->getClass());
+        $this->assertSame('bunny_client', (string) $definition->getArgument(0));
+        $this->assertSame('z1', $definition->getArgument(1));
+    }
+}