Merge pull request #72 from aws/sdk3

Updating the service provider to work with SDKv3 and Laravel 5.1

Author: jeremeamia

.travis.yml

@@ -1,8 +1,7 @@
 language: php
 
 php:
-  - 5.4
-  - 5.5
+  - 5.5.9
   - 5.6
   - 7.0
   - hhvm
@@ -13,8 +12,3 @@ install: travis_retry composer install --no-interaction --prefer-source
 
 script: vendor/bin/phpunit
 
-matrix:
-  allow_failures:
-    - php: 7.0
-    - php: hhvm
-  fast_finish: true

README.md

@@ -6,9 +6,16 @@
 [![Total Downloads](https://img.shields.io/packagist/dt/aws/aws-sdk-php-laravel.svg)](https://packagist.org/packages/aws/aws-sdk-php-laravel)
 [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/aws/aws-sdk-php?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
-A simple [Laravel 5](http://laravel.com/) service provider for making it easier to include the official [AWS SDK for PHP](https://github.com/aws/aws-sdk-php) into your Laravel application.
+This is a simple [Laravel](http://laravel.com/) service provider for making it easy to include the official
+[AWS SDK for PHP](https://github.com/aws/aws-sdk-php) in your Laravel and Lumen applications.
 
-_(Looking for the Laravel 4 service provider? It's still available in the [1.0 branch](https://github.com/aws/aws-sdk-php-laravel/tree/1.0).)_
+The master branch of this repository and this README are for version 3.x of the service provider, which is implemented
+to work with Version 3 of the AWS SDK for PHP and Laravel 5.1+.
+
+Past Versions:
+
+* [2.0 branch](https://github.com/aws/aws-sdk-php-laravel/tree/2.0) - For Laravel 5.0 and Version 2 of the AWS SDK for PHP
+* [1.0 branch](https://github.com/aws/aws-sdk-php-laravel/tree/1.0) - For Laravel 4.x and Version 2 of the AWS SDK for PHP
 
 ## Installation
 
@@ -18,7 +25,7 @@ The AWS Service Provider can be installed via [Composer](http://getcomposer.org)
 ```json
 {
     "require": {
-        "aws/aws-sdk-php-laravel": "~2.0"
+        "aws/aws-sdk-php-laravel": "~3.0"
     }
 }
 ```
@@ -54,8 +61,7 @@ By default, the package uses the following environment variables to auto-configu
 ```
 AWS_ACCESS_KEY_ID
 AWS_SECRET_ACCESS_KEY
-AWS_REGION              // default = us-east-1
-AWS_CONFIG_FILE         // default = null
+AWS_REGION (default = us-east-1)
 ```
 
 To customize the configuration file, publish the package configuration using Artisan.
@@ -68,13 +74,23 @@ Update your settings in the generated `app/config/aws.php` configuration file.
 
 ```php
 return [
-    'key'         => 'YOUR_AWS_ACCESS_KEY_ID',
-    'secret'      => 'YOUR_AWS_SECRET_KEY',
-    'region'      => 'us-east-1',
-    'config_file' => null,
+    'credentials' => [
+        'key'    => 'YOUR_AWS_ACCESS_KEY_ID',
+        'secret' => 'YOUR_AWS_SECRET_ACCESS_KEY',
+    ],
+    'region' => 'us-west-2',
+    'version' => 'latest',
+    
+    // You can override settings for specific services
+    'Ses' => [
+        'region' => 'us-east-1',
+    ],
 ];
 ```
 
+Learn more about [configuring the SDK](http://docs.aws.amazon.com/aws-sdk-php/v3/guide/guide/configuration.html) on
+the SDK's User Guide.
+
 ## Usage
 
 In order to use the AWS SDK for PHP within your app, you need to retrieve it from the [Laravel IoC

composer.json

@@ -12,15 +12,18 @@
         }
     ],
     "require": {
-        "php": ">=5.4.0",
-        "aws/aws-sdk-php": "~2.4",
-        "illuminate/support": "~5.0"
+        "php": ">=5.5.9",
+        "aws/aws-sdk-php": "~3.0",
+        "illuminate/support": "~5.1"
     },
     "require-dev": {
-        "laravel/framework": "~5.0",
+        "laravel/framework": "~5.1",
         "phpunit/phpunit": "~4.0"
     },
     "autoload": {
         "psr-4": { "Aws\\Laravel\\": "src/" }
+    },
+    "autoload-dev": {
+        "psr-4": { "Aws\\Laravel\\Test\\": "tests/" }
     }
 }

config/aws.php

@@ -4,47 +4,21 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Your AWS Credentials
+    | AWS SDK Configuration
     |--------------------------------------------------------------------------
     |
-    | In order to communicate with an AWS service, you must provide your AWS
-    | credentials including your AWS Access Key ID and AWS Secret Access Key.
-    |
-    | To use credentials from your credentials file or environment or to use
-    | IAM Instance Profile credentials, please remove these config settings from
-    | your config or make sure they are null. For more information, see:
-    | http://docs.aws.amazon.com/aws-sdk-php-2/guide/latest/configuration.html
-    |
-    */
-    'key'    => env('AWS_ACCESS_KEY_ID'),
-    'secret' => env('AWS_SECRET_ACCESS_KEY'),
-
-    /*
-    |--------------------------------------------------------------------------
-    | AWS Region
-    |--------------------------------------------------------------------------
-    |
-    | Many AWS services are available in multiple regions. You should specify
-    | the AWS region you would like to use, but please remember that not every
-    | service is available in every region. To see what regions are available,
-    | see: http://docs.aws.amazon.com/general/latest/gr/rande.html
+    | The configuration options set in this file will be passed directly to the
+    | `Aws\Sdk` object, from which all client objects are created. The minimum
+    | required options are declared here, but the full set of possible options
+    | are documented at:
+    | http://docs.aws.amazon.com/aws-sdk-php/v3/guide/guide/configuration.html
     |
     */
+    'credentials' => [
+        'key'    => env('AWS_ACCESS_KEY_ID'),
+        'secret' => env('AWS_SECRET_ACCESS_KEY'),
+    ],
     'region' => env('AWS_REGION', 'us-east-1'),
-
-    /*
-    |--------------------------------------------------------------------------
-    | AWS Config File Location
-    |--------------------------------------------------------------------------
-    |
-    | Instead of specifying your credentials and region here, you can specify
-    | the location of an AWS SDK for PHP config file to use. These files provide
-    | more granular control over what credentials and regions you are using for
-    | each service. If you specify a filepath for this configuration setting,
-    | the others in this file will be ignored. See the SDK user guide for more
-    | information: http://docs.aws.amazon.com/aws-sdk-php-2/guide/latest/configuration.html#using-a-custom-configuration-file
-    |
-    */
-    'config_file' => env('AWS_CONFIG_FILE'),
+    'version' => 'latest',
 
 ];

src/AwsFacade.php

@@ -1,14 +1,15 @@
 <?php namespace Aws\Laravel;
 
-use Aws\Common\Client\AwsClientInterface;
+use Aws\AwsClientInterface;
 use Illuminate\Support\Facades\Facade;
 
 /**
  * Facade for the AWS service
  *
- * @method static AwsClientInterface get($name, $throwAway = false) Get a client from the service builder
+ * @method static AwsClientInterface createClient($name, array $args = []) Get a client from the service builder.
  */
-class AwsFacade extends Facade {
+class AwsFacade extends Facade
+{
 
     /**
      * Get the registered name of the component.

src/AwsServiceProvider.php

@@ -1,12 +1,13 @@
 <?php namespace Aws\Laravel;
 
-use Aws\Common\Aws;
+use Aws\Sdk;
 use Illuminate\Support\ServiceProvider;
 
 /**
  * AWS SDK for PHP service provider for Laravel applications
  */
-class AwsServiceProvider extends ServiceProvider {
+class AwsServiceProvider extends ServiceProvider
+{
 
     /**
      * Indicates if loading of the provider is deferred.
@@ -39,15 +40,10 @@ public function boot()
     public function register()
     {
         $this->app->singleton('aws', function ($app) {
-            $config = $app['config']->get('aws');
-            if (isset($config['config_file'])) {
-                $config = $config['config_file'];
-            }
-
-            return Aws::factory($config);
+            return new Sdk($app['config']->get('aws'));
         });
 
-        $this->app->alias('aws', 'Aws\Common\Aws');
+        $this->app->alias('aws', 'Aws\Sdk');
     }
 
     /**
@@ -57,7 +53,7 @@ public function register()
      */
     public function provides()
     {
-        return ['aws', 'Aws\Common\Aws'];
+        return ['aws', 'Aws\Sdk'];
     }
 
 }

tests/Aws/Laravel/Test/test_services.json

@@ -5,7 +5,8 @@
 use Illuminate\Config\Repository;
 use Illuminate\Foundation\Application;
 
-class AwsServiceProviderTest extends \PHPUnit_Framework_TestCase {
+class AwsServiceProviderTest extends \PHPUnit_Framework_TestCase
+{
 
     public function testFacadeCanBeResolvedToServiceInstance()
     {
@@ -15,44 +16,26 @@ public function testFacadeCanBeResolvedToServiceInstance()
         // Mount facades
         AWS::setFacadeApplication($app);
 
-        // Get an instance of a client (S3) via its facade
-        $s3 = AWS::get('s3');
+        // Get an instance of a client (S3) via the facade.
+        $s3 = AWS::createClient('S3');
         $this->assertInstanceOf('Aws\S3\S3Client', $s3);
     }
 
-    public function testRegisterAwsServiceProviderWithConfigFile()
-    {
-        $app = $this->setupApplication();
-        $this->setupServiceProvider($app);
-
-        // Simulate global config; specify config file
-        $app['config']->set('aws', [
-            'config_file' => __DIR__ . '/test_services.json'
-        ]);
-
-        // Get an instance of a client (S3)
-        /** @var $s3 \Aws\S3\S3Client */
-        $s3 = $app['aws']->get('s3');
-        $this->assertInstanceOf('Aws\S3\S3Client', $s3);
-
-        // Verify that the client received the credentials from the global config
-        $this->assertEquals('change_me', $s3->getCredentials()->getAccessKeyId());
-        $this->assertEquals('change_me', $s3->getCredentials()->getSecretKey());
-    }
-
     public function testRegisterAwsServiceProviderWithPackageConfigAndEnv()
     {
         $app = $this->setupApplication();
         $this->setupServiceProvider($app);
 
-        // Get an instance of a client (S3)
+        // Get an instance of a client (S3).
         /** @var $s3 \Aws\S3\S3Client */
-        $s3 = $app['aws']->get('s3');
+        $s3 = $app['aws']->createClient('S3');
         $this->assertInstanceOf('Aws\S3\S3Client', $s3);
 
-        // Verify that the client received the credentials from the package config
-        $this->assertEquals('foo', $s3->getCredentials()->getAccessKeyId());
-        $this->assertEquals('bar', $s3->getCredentials()->getSecretKey());
+        // Verify that the client received the credentials from the package config.
+        /** @var \Aws\Credentials\CredentialsInterface $credentials */
+        $credentials = $s3->getCredentials()->wait();
+        $this->assertEquals('foo', $credentials->getAccessKeyId());
+        $this->assertEquals('bar', $credentials->getSecretKey());
         $this->assertEquals('baz', $s3->getRegion());
     }
 
@@ -68,7 +51,7 @@ public function testServiceNameIsProvided()
      */
     private function setupApplication()
     {
-        // Create the application such that the config is loaded
+        // Create the application such that the config is loaded.
         $app = new Application();
         $app->setBasePath(sys_get_temp_dir());
         $app->instance('config', new Repository());
@@ -83,7 +66,7 @@ private function setupApplication()
      */
     private function setupServiceProvider(Application $app)
     {
-        // Create and register the provider
+        // Create and register the provider.
         $provider = new AwsServiceProvider($app);
         $app->register($provider);
         $provider->boot();