Merge pull request #52 from runmybusiness/laravel5

Laravel 5 Compatibility

Author: jeremeamia

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.

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":[
@@ -12,15 +12,15 @@
         }
     ],
     "require": {
-        "php": ">=5.3.3",
-        "aws/aws-sdk-php": "~2.2",
-        "illuminate/foundation": "4.*",
-        "illuminate/support": "4.*"
+        "php": ">=5.4.0",
+        "aws/aws-sdk-php": "~2.4",
+        "illuminate/support": "~5.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "3.7.*"
+        "laravel/framework": "~5.0",
+        "phpunit/phpunit": "~4.0"
     },
     "autoload": {
-        "psr-0": { "Aws\\Laravel": "src/" }
+        "psr-4": { "Aws\\Laravel\\": "src/" }
     }
 }

src/config/config.php renamed to config/config.php

@@ -1,37 +1,21 @@
-<?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 array(
+<?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
     |
     */
-    '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'),
 
     /*
     |--------------------------------------------------------------------------
@@ -40,13 +24,11 @@
     |
     | 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' => 'us-east-1',
+    'region' => env('AWS_REGION', 'us-east-1'),
 
     /*
     |--------------------------------------------------------------------------
@@ -61,6 +43,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'),
 
-);
+];

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>

src/Aws/Laravel/AwsFacade.php

@@ -0,0 +1,23 @@
+<?php namespace Aws\Laravel;
+
+use Aws\Common\Client\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
+ */
+class AwsFacade extends Facade {
+
+    /**
+     * Get the registered name of the component.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor()
+    {
+        return 'aws';
+    }
+
+}

src/Aws/Laravel/AwsServiceProvider.php

@@ -0,0 +1,62 @@
+<?php namespace Aws\Laravel;
+
+use Aws\Common\Aws;
+use Illuminate\Support\ServiceProvider;
+
+/**
+ * AWS SDK for PHP service provider for Laravel applications
+ */
+class AwsServiceProvider extends ServiceProvider {
+
+    /**
+     * 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.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->singleton('aws', function ($app) {
+            // Retrieve config.
+            $config = $app['config']->get('aws');
+            if (isset($config['config_file'])) {
+                $config = $config['config_file'];
+            }
+
+            return Aws::factory($config);
+        });
+
+        $this->app->alias('aws', 'Aws\Common\Aws');
+    }
+
+    /**
+     * Get the services provided by the provider.
+     *
+     * @return array
+     */
+    public function provides()
+    {
+        return ['aws', 'Aws\Common\Aws'];
+    }
+
+}