Adding support for AsyncAws (#639)

* Adding support for AsyncAws

* Added PHPSpec test

* cs

* Update doc/adapters/async-aws-s3.md

Co-authored-by: Jérémy Derussé <jeremy@derusse.com>

* Fixes

* cs

* cs

* Minors

* cs

* fixes

* minor

* fix

* Update make files

Co-authored-by: Jérémy Derussé <jeremy@derusse.com>

Author: Nyholm

.github/workflows/ci.yml

@@ -42,6 +42,7 @@ jobs:
       max-parallel: 10
       matrix:
         run:
+          - { php: '7.3', packages: 'async-aws/simple-s3:^0.1.1', phpspec: 'spec/Gaufrette/Adapter/AsyncAwsS3Spec.php' }
           - { php: '7.3', packages: 'aws/aws-sdk-php:^2.4.12', phpspec: 'spec/Gaufrette/Adapter/AwsS3Spec.php' }
           - { php: '7.4', packages: 'aws/aws-sdk-php:^3.158', phpspec: 'spec/Gaufrette/Adapter/AwsS3Spec.php' }
           - { php: '7.4', packages: 'rackspace/php-opencloud:^1.9.2', phpspec: 'spec/Gaufrette/Adapter/OpenCloudSpec.php' }

.travis.yml

@@ -39,7 +39,7 @@ before_install:
   - docker exec -it ftpd_server sh -c "(echo ${FTP_PASSWORD}; echo ${FTP_PASSWORD}) | pure-pw useradd ${FTP_USER} -f /etc/pure-ftpd/passwd/pureftpd.passwd -m -u ftpuser -d /home/ftpusers/${FTP_USER}"
 
 install:
-  - make require-all
+  - make require-all-legacy
   - composer update --prefer-dist --no-progress --no-suggest --ansi
 
 script:

Makefile

@@ -33,6 +33,7 @@ php-cs-fix:
 	docker/run-task php${PHP_VERSION} vendor/bin/php-cs-fixer fix
 
 remove-phpspec:
+	rm spec/Gaufrette/Adapter/AsyncAwsS3Spec.php
 	rm spec/Gaufrette/Adapter/AwsS3Spec.php
 	rm spec/Gaufrette/Adapter/OpenCloudSpec.php
 	rm spec/Gaufrette/Adapter/GoogleCloudStorageSpec.php
@@ -42,7 +43,7 @@ remove-phpspec:
 	rm spec/Gaufrette/Adapter/GridFSSpec.php
 	rm spec/Gaufrette/Adapter/PhpseclibSftpSpec.php
 
-require-all:
+require-all-legacy:
 	composer require --no-update \
 		aws/aws-sdk-php:^3.158 \
 		rackspace/php-opencloud:^1.9.2 \
@@ -54,3 +55,7 @@ require-all:
 		mongodb/mongodb:^1.1 \
 		symfony/event-dispatcher:^4.4
 
+
+require-all: require-all-legacy
+	composer require --no-update async-aws/simple-s3:^0.1.1
+

README.md

@@ -47,6 +47,7 @@ your issue or pull request in a timely manner, ping us:
 
 | Adapter            | Referent                    |
 |--------------------|-----------------------------|
+| AsyncAws S3        | @Nyholm                     |
 | AwsS3              | @NiR-                       |
 | AzureBlobStorage   | @NiR-                       |
 | DoctrineDbal       | @pedrotroller, @NicolasNSSM |

appveyor.yml

@@ -61,7 +61,7 @@ install:
   - IF %PHP%==1 echo openssl.cafile=c:\php\cacert.pem >> php.ini
   - cd C:\projects\gaufrette
   - curl -fsSL -o composer.phar https://getcomposer.org/composer.phar
-  - php composer.phar require --no-update aws/aws-sdk-php:^3.158 rackspace/php-opencloud:^1.9.2 google/apiclient:^1.1.3 doctrine/dbal:^2.3 league/flysystem:^1.0 microsoft/azure-storage-blob:^1.0 phpseclib/phpseclib:^2.0 mongodb/mongodb:^1.1 symfony/event-dispatcher:^4.4
+  - php composer.phar require --no-update async-aws/simple-s3:^0.1.1 aws/aws-sdk-php:^3.158 rackspace/php-opencloud:^1.9.2 google/apiclient:^1.1.3 doctrine/dbal:^2.3 league/flysystem:^1.0 microsoft/azure-storage-blob:^1.0 phpseclib/phpseclib:^2.0 mongodb/mongodb:^1.1 symfony/event-dispatcher:^4.4
   - php composer.phar update --prefer-dist --no-interaction --no-progress --no-suggest --ansi
 
 test_script:

doc/adapters/async-aws-s3.md

@@ -0,0 +1,31 @@
+---
+currentMenu: async-aws-s3
+---
+
+# AsyncAws S3
+
+First, you will need to install the simple S3 client:
+```bash
+composer require async-aws/simple-s3
+```
+
+In order to use this adapter you'll need an access key and a secret key.
+
+## Example
+
+```php
+<?php
+
+use AsyncAws\SimpleS3\SimpleS3Client;
+use Gaufrette\Adapter\AsyncAwsS3 as AwsS3Adapter;
+use Gaufrette\Filesystem;
+
+$s3client = new SimpleS3Client([
+    'accessKeyId'     => 'your_key_here',
+    'accessKeySecret'  => 'your_secret',
+    'region'  => 'eu-west-1',
+]);
+
+$adapter = new AwsS3Adapter($s3client, 'your-bucket-name');
+$filesystem = new Filesystem($adapter);
+```

spec/Gaufrette/Adapter/AsyncAwsS3Spec.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace spec\Gaufrette\Adapter;
+
+use AsyncAws\SimpleS3\SimpleS3Client;
+use Gaufrette\Adapter\MimeTypeProvider;
+use PhpSpec\ObjectBehavior;
+
+class AsyncAwsS3Spec extends ObjectBehavior
+{
+    /**
+     * @param \AsyncAws\SimpleS3\SimpleS3Client $service
+     */
+    function let(SimpleS3Client $service)
+    {
+        $this->beConstructedWith($service, 'bucketName');
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('Gaufrette\Adapter\AsyncAwsS3');
+    }
+
+    function it_is_adapter()
+    {
+        $this->shouldHaveType('Gaufrette\Adapter');
+    }
+
+    function it_supports_metadata()
+    {
+        $this->shouldHaveType('Gaufrette\Adapter\MetadataSupporter');
+    }
+
+    function it_supports_sizecalculator()
+    {
+        $this->shouldHaveType('Gaufrette\Adapter\SizeCalculator');
+    }
+
+    function it_provides_mime_type()
+    {
+        $this->shouldHaveType(MimeTypeProvider::class);
+    }
+}