making the service provider Laravel 5 compatible

tomschlick · tomschlick · commit 79c87cc88e33 · 2015-02-14T20:13:48.000-05:00
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![Latest Stable Version](https://poser.pugx.org/aws/aws-sdk-php-laravel/v/stable.png)](https://packagist.org/packages/aws/aws-sdk-php-laravel)
 [![Total Downloads](https://poser.pugx.org/aws/aws-sdk-php-laravel/downloads.png)](https://packagist.org/packages/aws/aws-sdk-php-laravel)
 
-A simple [Laravel 4](http://laravel.com/) service provider for including the [AWS SDK for PHP](https://github.com/aws/aws-sdk-php).
+A simple [Laravel 5](http://laravel.com/) service provider for including the [AWS SDK for PHP](https://github.com/aws/aws-sdk-php).
 
 ## Installation
 
@@ -13,7 +13,7 @@ The AWS Service Provider can be installed via [Composer](http://getcomposer.org)
 ```json
 {
     "require": {
-        "aws/aws-sdk-php-laravel": "1.*"
+        "aws/aws-sdk-php-laravel": "~2.0"
     }
 }
 ```
@@ -27,21 +27,29 @@ php composer.phar update
 
 To use the AWS Service Provider, you must register the provider when bootstrapping your Laravel application.
 
-Publish the package configuration using Artisan.
+By default, the package uses the following environment variables to auto-configure the plugin without modification:
+```
+AWS_ACCESS_KEY_ID
+AWS_SECRET_ACCESS_KEY
+AWS_REGION              // default = us-east-1
+AWS_CONFIG_FILE         // default = null
+```
+
+To customize the configuration file, publish the package configuration using Artisan.
 
 ```sh
-php artisan config:publish aws/aws-sdk-php-laravel
+php artisan vendor:publish
 ```
 
-Update your settings in the generated `app/config/packages/aws/aws-sdk-php-laravel` configuration file.
+Update your settings in the generated `app/config/aws.php` configuration file.
 
 ```php
-return array(
+return [
     'key'         => 'YOUR_AWS_ACCESS_KEY_ID',
     'secret'      => 'YOUR_AWS_SECRET_KEY',
     'region'      => 'us-east-1',
     'config_file' => null,
-);
+];
 ```
 
 Find the `providers` key in your `app/config/app.php` and register the AWS Service Provider.
diff --git a/composer.json b/composer.json
@@ -1,8 +1,8 @@
 {
     "name": "aws/aws-sdk-php-laravel",
     "homepage": "http://aws.amazon.com/sdkforphp2",
-    "description": "A simple Laravel 4 service provider for including the AWS SDK for PHP.",
-    "keywords": ["laravel","laravel 4","aws","amazon","sdk","s3","ec2","dynamodb"],
+    "description": "A simple Laravel 5 service provider for including the AWS SDK for PHP.",
+    "keywords": ["laravel", "laravel 5", "aws", "amazon", "sdk", "s3", "ec2", "dynamodb"],
     "type":"library",
     "license":"Apache-2.0",
     "authors":[
@@ -14,13 +14,12 @@
     "require": {
         "php": ">=5.3.3",
         "aws/aws-sdk-php": "~2.2",
-        "illuminate/foundation": "4.*",
-        "illuminate/support": "4.*"
+        "illuminate/support": "~5.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "3.7.*"
+        "phpunit/phpunit": "~4.0"
     },
     "autoload": {
-        "psr-0": { "Aws\\Laravel": "src/" }
+        "psr-4": { "Aws\\Laravel\\": "src/" }
     }
 }
diff --git a/config/config.php b/config/config.php
@@ -14,7 +14,7 @@
  * permissions and limitations under the License.
  */
 
-return array(
+return [
 
     /*
     |--------------------------------------------------------------------------
@@ -30,8 +30,8 @@
     | http://docs.aws.amazon.com/aws-sdk-php-2/guide/latest/configuration.html
     |
     */
-    'key'    => null, // Your AWS Access Key ID
-    'secret' => null, // Your AWS Secret Access Key
+    'key'    => env('AWS_ACCESS_KEY_ID'),
+    'secret' => env('AWS_SECRET_ACCESS_KEY'),
 
     /*
     |--------------------------------------------------------------------------
@@ -46,7 +46,7 @@
     | eu-west-1, sa-east-1, ap-northeast-1, ap-southeast-1, ap-southeast-2
     |
     */
-    'region' => 'us-east-1',
+    'region' => env('AWS_REGION', 'us-east-1'),
 
     /*
     |--------------------------------------------------------------------------
@@ -61,6 +61,6 @@
     | information: http://docs.aws.amazon.com/aws-sdk-php-2/guide/latest/configuration.html#using-a-custom-configuration-file
     |
     */
-    'config_file' => null,
+    'config_file' => env('AWS_CONFIG_FILE'),
 
-);
+];
diff --git a/src/AwsFacade.php b/src/AwsFacade.php
diff --git a/src/AwsServiceProvider.php b/src/AwsServiceProvider.php
@@ -28,7 +28,31 @@
  */
 class AwsServiceProvider extends ServiceProvider
 {
-    const VERSION = '1.1.0';
+
+    const VERSION = '2.0.0';
+
+    /**
+     * Indicates if loading of the provider is deferred.
+     *
+     * @var bool
+     */
+    protected $defer = true;
+
+    /**
+     * Bootstrap the configuration
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        $config = realpath(__DIR__ . '/../config/config.php');
+
+        $this->mergeConfigFrom($config, 'aws');
+
+        $this->publishes([
+            $config => config_path('aws.php'),
+        ], 'config');
+    }
 
     /**
      * Register the service provider.
@@ -37,38 +61,26 @@ class AwsServiceProvider extends ServiceProvider
      */
     public function register()
     {
-        $this->app['aws'] = $this->app->share(function ($app) {
-            // Retrieve the config
-            $config = $app['config']['aws'] ?: $app['config']['aws::config'];
-            if (isset($config['config_file'])) {
-                $config = $config['config_file'];
-            }
+        $this->app->singleton('aws', function ($app) {
 
             // Instantiate the AWS service builder
-            $aws = Aws::factory($config);
+            $aws = Aws::factory($app['config']->get('aws'));
 
             // 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) ?: array();
-                $userAgentSuffix = 'Laravel/' . Application::VERSION . ' L4MOD/' . AwsServiceProvider::VERSION;
-                $clientConfig->set(Client::COMMAND_PARAMS, array_merge_recursive($commandParams, array(
+                $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;
         });
-    }
 
-    /**
-     * Bootstrap the application events.
-     *
-     * @return void
-     */
-    public function boot()
-    {
-        $this->package('aws/aws-sdk-php-laravel', 'aws');
+        $this->app->alias('aws', 'Aws\Common\Aws');
     }
 
     /**
@@ -78,6 +90,6 @@ public function boot()
      */
     public function provides()
     {
-        return array('aws');
+        return ['aws'];
     }
 }
