Move S3Client to the container. (#72)

Moves `S3Client` to a bound service in the container and adds a new `AwsClientConfiguration` that can be overridden to make user-land customisation easier.

Author: lukeraymonddowning

src/Clients/Configurations/AwsClientConfiguration.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Hammerstone\Sidecar\Clients\Configurations;
+
+use Hammerstone\Sidecar\Contracts\AwsClientConfiguration as AwsClientConfigurationContract;
+
+class AwsClientConfiguration implements AwsClientConfigurationContract
+{
+    public function getConfiguration()
+    {
+        $config = [
+            'version' => 'latest',
+            'region' => config('sidecar.aws_region'),
+        ];
+
+        $credentials = array_filter([
+            'key' => config('sidecar.aws_key'),
+            'secret' => config('sidecar.aws_secret'),
+        ]);
+
+        if ($credentials) {
+            $config['credentials'] = $credentials;
+        }
+
+        return $config;
+    }
+}

src/Clients/S3Client.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Hammerstone\Sidecar\Clients;
+
+use Aws\S3\S3Client as BaseClient;
+
+class S3Client extends BaseClient
+{
+}

src/Contracts/AwsClientConfiguration.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Hammerstone\Sidecar\Contracts;
+
+interface AwsClientConfiguration
+{
+    /**
+     * Retrieve an array of configuration options for Lambda,
+     * Cloudwatch and S3 AWS services.
+     *
+     * @return array
+     */
+    public function getConfiguration();
+}

src/Package.php

@@ -5,13 +5,14 @@
 
 namespace Hammerstone\Sidecar;
 
-use Aws\S3\S3Client;
+use Hammerstone\Sidecar\Clients\S3Client;
 use Hammerstone\Sidecar\Exceptions\SidecarException;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use Illuminate\Support\Traits\Macroable;
+use ZipStream\Exception;
 use ZipStream\Option\Archive;
 use ZipStream\Option\File as FileOptions;
 use ZipStream\ZipStream;
@@ -281,7 +282,7 @@ public function deploymentConfiguration()
     {
         try {
             $key = $this->upload();
-        } catch (\ZipStream\Exception $e) {
+        } catch (Exception $e) {
             throw new SidecarException('Sidecar could not create ZIP: ' . $e->getMessage());
         }
 
@@ -306,7 +307,7 @@ public function getFilename()
     /**
      * @return string
      *
-     * @throws \ZipStream\Exception
+     * @throws Exception
      */
     public function upload()
     {
@@ -442,21 +443,12 @@ protected function bucket()
     }
 
     /**
-     * @return string
+     * @return void
      */
     protected function registerStreamWrapper()
     {
         // Register the s3:// stream wrapper.
         // https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/s3-stream-wrapper.html
-        $client = new S3Client([
-            'version' => 'latest',
-            'region' => config('sidecar.aws_region'),
-            'credentials' => [
-                'key' => config('sidecar.aws_key'),
-                'secret' => config('sidecar.aws_secret'),
-            ]
-        ]);
-
-        $client->registerStreamWrapper();
+        app(S3Client::class)->registerStreamWrapper();
     }
 }

src/Providers/SidecarServiceProvider.php

@@ -6,12 +6,15 @@
 namespace Hammerstone\Sidecar\Providers;
 
 use Hammerstone\Sidecar\Clients\CloudWatchLogsClient;
+use Hammerstone\Sidecar\Clients\Configurations\AwsClientConfiguration;
 use Hammerstone\Sidecar\Clients\LambdaClient;
+use Hammerstone\Sidecar\Clients\S3Client;
 use Hammerstone\Sidecar\Commands\Activate;
 use Hammerstone\Sidecar\Commands\Configure;
 use Hammerstone\Sidecar\Commands\Deploy;
 use Hammerstone\Sidecar\Commands\Install;
 use Hammerstone\Sidecar\Commands\Warm;
+use Hammerstone\Sidecar\Contracts\AwsClientConfiguration as AwsClientConfigurationContract;
 use Hammerstone\Sidecar\Manager;
 use Illuminate\Support\ServiceProvider;
 
@@ -23,32 +26,24 @@ public function register()
 
         $this->mergeConfigFrom(__DIR__ . '/../../config/sidecar.php', 'sidecar');
 
+        $this->app->bind(AwsClientConfigurationContract::class, AwsClientConfiguration::class);
+
         $this->app->singleton(LambdaClient::class, function () {
             return new LambdaClient($this->getAwsClientConfiguration());
         });
 
         $this->app->singleton(CloudWatchLogsClient::class, function () {
             return new CloudWatchLogsClient($this->getAwsClientConfiguration());
         });
+
+        $this->app->singleton(S3Client::class, function () {
+            return new S3Client($this->getAwsClientConfiguration());
+        });
     }
 
     protected function getAwsClientConfiguration()
     {
-        $config = [
-            'version' => 'latest',
-            'region' => config('sidecar.aws_region'),
-        ];
-
-        $credentials = array_filter([
-            'key' => config('sidecar.aws_key'),
-            'secret' => config('sidecar.aws_secret'),
-        ]);
-
-        if ($credentials) {
-            $config['credentials'] = $credentials;
-        }
-
-        return $config;
+        return $this->app->make(AwsClientConfigurationContract::class)->getConfiguration();
     }
 
     public function boot()