Merge pull request aws#1 from jeremeamia/laravel5

tomschlick · tomschlick · commit 37649f28f2ca · 2015-02-18T20:07:55.000-05:00
Updated tests and removed the user-agent modification code.
diff --git a/composer.json b/composer.json
@@ -13,10 +13,11 @@
     ],
     "require": {
         "php": ">=5.4.0",
-        "aws/aws-sdk-php": "~2.2",
+        "aws/aws-sdk-php": "~2.4",
         "illuminate/support": "~5.0"
     },
     "require-dev": {
+        "laravel/framework": "~5.0",
         "phpunit/phpunit": "~4.0"
     },
     "autoload": {
diff --git a/config/config.php b/config/config.php
@@ -1,32 +1,16 @@
-<?php
-/**
- * Copyright 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License").
- * You may not use this file except in compliance with the License.
- * A copy of the License is located at
- *
- * http://aws.amazon.com/apache2.0
- *
- * or in the "license" file accompanying this file. This file is distributed
- * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
- * express or implied. See the License for the specific language governing
- * permissions and limitations under the License.
- */
-
-return [
+<?php return [
 
     /*
     |--------------------------------------------------------------------------
     | Your AWS Credentials
     |--------------------------------------------------------------------------
     |
     | In order to communicate with an AWS service, you must provide your AWS
-    | credentials including your AWS Access Key ID and your AWS Secret Key.
+    | 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:
+    | 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
     |
     */
@@ -40,10 +24,8 @@
     |
     | 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.
-    |
-    | These are the regions: us-east-1, us-west-1, us-west-2, us-gov-west-1
-    | eu-west-1, sa-east-1, ap-northeast-1, ap-southeast-1, ap-southeast-2
+    | service is available in every region. To see what regions are available,
+    | see: http://docs.aws.amazon.com/general/latest/gr/rande.html
     |
     */
     'region' => env('AWS_REGION', 'us-east-1'),
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit backupGlobals="false"
          backupStaticAttributes="false"
-         bootstrap="./tests/bootstrap.php"
+         bootstrap="./vendor/autoload.php"
          colors="false"
          convertErrorsToExceptions="true"
          convertNoticesToExceptions="true"
@@ -16,6 +16,12 @@
         </testsuite>
     </testsuites>
 
+    <php>
+        <env name="AWS_ACCESS_KEY_ID" value="foo"/>
+        <env name="AWS_SECRET_ACCESS_KEY" value="bar"/>
+        <env name="AWS_REGION" value="baz"/>
+    </php>
+
     <filter>
         <whitelist addUncoveredFilesFromWhitelist="false">
             <directory suffix=".php">src</directory>
diff --git a/src/AwsFacade.php b/src/AwsFacade.php
@@ -1,20 +1,4 @@
-<?php
-/**
- * Copyright 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License").
- * You may not use this file except in compliance with the License.
- * A copy of the License is located at
- *
- * http://aws.amazon.com/apache2.0
- *
- * or in the "license" file accompanying this file. This file is distributed
- * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
- * express or implied. See the License for the specific language governing
- * permissions and limitations under the License.
- */
-
-namespace Aws\Laravel;
+<?php namespace Aws\Laravel;
 
 use Aws\Common\Client\AwsClientInterface;
 use Illuminate\Support\Facades\Facade;
@@ -24,8 +8,8 @@
  *
  * @method static AwsClientInterface get($name, $throwAway = false) Get a client from the service builder
  */
-class AwsFacade extends Facade
-{
+class AwsFacade extends Facade {
+
     /**
      * Get the registered name of the component.
      *
@@ -35,4 +19,5 @@ protected static function getFacadeAccessor()
     {
         return 'aws';
     }
+
 }
diff --git a/src/AwsServiceProvider.php b/src/AwsServiceProvider.php
@@ -1,35 +1,12 @@
-<?php
-/**
- * Copyright 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License").
- * You may not use this file except in compliance with the License.
- * A copy of the License is located at
- *
- * http://aws.amazon.com/apache2.0
- *
- * or in the "license" file accompanying this file. This file is distributed
- * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
- * express or implied. See the License for the specific language governing
- * permissions and limitations under the License.
- */
-
-namespace Aws\Laravel;
+<?php namespace Aws\Laravel;
 
 use Aws\Common\Aws;
-use Aws\Common\Client\UserAgentListener;
-use Guzzle\Common\Event;
-use Guzzle\Service\Client;
-use Illuminate\Foundation\Application;
 use Illuminate\Support\ServiceProvider;
 
 /**
  * AWS SDK for PHP service provider for Laravel applications
  */
-class AwsServiceProvider extends ServiceProvider
-{
-
-    const VERSION = '2.0.0';
+class AwsServiceProvider extends ServiceProvider {
 
     /**
      * Indicates if loading of the provider is deferred.
@@ -60,21 +37,13 @@ public function boot()
     public function register()
     {
         $this->app->singleton('aws', function ($app) {
-            // Instantiate the AWS service builder
-            $aws = Aws::factory($app['config']->get('aws'));
+            // Retrieve config.
+            $config = $app['config']->get('aws');
+            if (isset($config['config_file'])) {
+                $config = $config['config_file'];
+            }
 
-            // Attach an event listener that will append the Laravel and module version numbers to the user agent string
-            $aws->getEventDispatcher()->addListener('service_builder.create_client', function (Event $event) {
-                $clientConfig = $event['client']->getConfig();
-                $commandParams = $clientConfig->get(Client::COMMAND_PARAMS) ?: [];
-                $userAgentSuffix = 'Laravel/' . Application::VERSION . ' L5MOD/' . AwsServiceProvider::VERSION;
-
-                $clientConfig->set(Client::COMMAND_PARAMS, array_merge_recursive($commandParams, [
-                    UserAgentListener::OPTION => $userAgentSuffix,
-                ]));
-            });
-
-            return $aws;
+            return Aws::factory($config);
         });
 
         $this->app->alias('aws', 'Aws\Common\Aws');
@@ -89,4 +58,5 @@ public function provides()
     {
         return ['aws', 'Aws\Common\Aws'];
     }
+
 }
diff --git a/tests/Aws/Laravel/Test/AwsFacadeTest.php b/tests/Aws/Laravel/Test/AwsFacadeTest.php
diff --git a/tests/Aws/Laravel/Test/AwsServiceProviderTest.php b/tests/Aws/Laravel/Test/AwsServiceProviderTest.php
@@ -1,35 +1,34 @@
-<?php
-/**
- * Copyright 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License").
- * You may not use this file except in compliance with the License.
- * A copy of the License is located at
- *
- * http://aws.amazon.com/apache2.0
- *
- * or in the "license" file accompanying this file. This file is distributed
- * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
- * express or implied. See the License for the specific language governing
- * permissions and limitations under the License.
- */
-
-namespace Aws\Laravel\Test;
-
-/**
- * AwsServiceProvider test cases
- */
-class AwsServiceProviderTest extends AwsServiceProviderTestCase
-{
-    public function testRegisterAwsServiceProviderWithGlobalConfig()
+<?php namespace Aws\Laravel\Test;
+
+use Aws\Laravel\AwsFacade as AWS;
+use Aws\Laravel\AwsServiceProvider;
+use Illuminate\Config\Repository;
+use Illuminate\Foundation\Application;
+
+class AwsServiceProviderTest extends \PHPUnit_Framework_TestCase {
+
+    public function testFacadeCanBeResolvedToServiceInstance()
+    {
+        $app = $this->setupApplication();
+        $this->setupServiceProvider($app);
+
+        // Mount facades
+        AWS::setFacadeApplication($app);
+
+        // Get an instance of a client (S3) via its facade
+        $s3 = AWS::get('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', array(
+        $app['config']->set('aws', [
             'config_file' => __DIR__ . '/test_services.json'
-        ));
+        ]);
 
         // Get an instance of a client (S3)
         /** @var $s3 \Aws\S3\S3Client */
@@ -39,15 +38,9 @@ public function testRegisterAwsServiceProviderWithGlobalConfig()
         // 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());
-
-        // Make sure the user agent contains Laravel information
-        $command = $s3->getCommand('ListBuckets');
-        $request = $command->prepare();
-        $s3->dispatch('command.before_send', array('command' => $command));
-        $this->assertRegExp('/.+Laravel\/.+L4MOD\/.+/', (string) $request->getHeader('User-Agent'));
     }
 
-    public function testRegisterAwsServiceProviderWithPackageConfig()
+    public function testRegisterAwsServiceProviderWithPackageConfigAndEnv()
     {
         $app = $this->setupApplication();
         $this->setupServiceProvider($app);
@@ -58,8 +51,9 @@ public function testRegisterAwsServiceProviderWithPackageConfig()
         $this->assertInstanceOf('Aws\S3\S3Client', $s3);
 
         // Verify that the client received the credentials from the package config
-        $this->assertEquals('YOUR_AWS_ACCESS_KEY_ID', $s3->getCredentials()->getAccessKeyId());
-        $this->assertEquals('YOUR_AWS_SECRET_KEY', $s3->getCredentials()->getSecretKey());
+        $this->assertEquals('foo', $s3->getCredentials()->getAccessKeyId());
+        $this->assertEquals('bar', $s3->getCredentials()->getSecretKey());
+        $this->assertEquals('baz', $s3->getRegion());
     }
 
     public function testServiceNameIsProvided()
@@ -68,4 +62,33 @@ public function testServiceNameIsProvided()
         $provider = $this->setupServiceProvider($app);
         $this->assertContains('aws', $provider->provides());
     }
+
+    /**
+     * @return Application
+     */
+    private function setupApplication()
+    {
+        // Create the application such that the config is loaded
+        $app = new Application();
+        $app->setBasePath(sys_get_temp_dir());
+        $app->instance('config', new Repository());
+
+        return $app;
+    }
+
+    /**
+     * @param Application $app
+     *
+     * @return AwsServiceProvider
+     */
+    private function setupServiceProvider(Application $app)
+    {
+        // Create and register the provider
+        $provider = new AwsServiceProvider($app);
+        $app->register($provider);
+        $provider->boot();
+
+        return $provider;
+    }
+
 }
diff --git a/tests/Aws/Laravel/Test/AwsServiceProviderTestCase.php b/tests/Aws/Laravel/Test/AwsServiceProviderTestCase.php
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
