clean up

Author: dhassanali

README.md

@@ -7,12 +7,26 @@ Upload files to AWS S3 Directly from Browser
 
 ## Installation
 
-You can install the package via composer:
+- 1 Install the package via composer:
 
 ```bash
 composer require hassan/laravel-s3-browser-based-uploads
 ```
 
+- 2 Publish the config file of the package.
+
+```bash
+php artisan vendor:publish --provider="Hassan\S3BrowserBasedUploads\ServiceProvider" --tag=config
+```
+- 3 add your AWS settings
+
+```bash
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_DEFAULT_REGION=
+AWS_BUCKET=
+```
+
 ## Usage
 
 ``` php

src/S3BrowserBasedUploadsManager.php

@@ -19,11 +19,17 @@ public function __construct(
         parent::__construct($client, $bucket, $formInputs, $options, $expiration);
     }
 
+    /**
+     * @return string
+     */
     public function getEndpointUrl() : string
     {
         return $this->getFormAttributes()['action'];
     }
 
+    /**
+     * @return array
+     */
     public function getFields() : array
     {
         return $this->getFormInputs();

src/ServiceProvider.php

@@ -19,50 +19,68 @@ public function boot()
         }
     }
 
+    /**
+     * Register the application services.
+     */
+    public function register()
+    {
+        $this->mergeConfigFrom(__DIR__.'/../config/config.php', 's3-browser-based-uploads');
+
+        $this->app->bind(S3BrowserBasedUploadsManager::class, function () {
+            $adapter = $this->getS3Adapter();
+
+            return new S3BrowserBasedUploadsManager(
+                $adapter->getClient(),
+                $adapter->getBucket(),
+                $this->getInputs(),
+                $this->getConditions(),
+                $this->getExpirationTime()
+            );
+        });
+
+        $this->app->alias(S3BrowserBasedUploadsManager::class, 's3-browser-based-uploads');
+    }
+
+
+    /**
+     * @return AwsS3Adapter
+     */
     protected function getS3Adapter() : AwsS3Adapter
     {
         return $this->app['filesystem']->disk($this->getConfig('disk'))->getAdapter();
     }
 
+    /**
+     *  returns inputs from config file
+     */
     protected function getInputs() : array
     {
         return $this->getConfig('inputs', []);
     }
 
+    /**
+     *  returns conditions from config file
+     */
     protected function getConditions() : array
     {
         return $this->getConfig('conditions', []);
     }
 
+    /**
+     *  returns expiration time from config file
+     */
     protected function getExpirationTime() : string
     {
         return $this->getConfig('expiration_time', '+5 minutes');
     }
 
-    public function getConfig(string $key, $default = null)
-    {
-        return config('s3-browser-based-uploads.providers.default.' . $key, $default);
-    }
-
     /**
-     * Register the application services.
+     * @param  string  $key
+     * @param  null  $default
+     * @return mixed
      */
-    public function register()
+    protected function getConfig(string $key, $default = null)
     {
-        $this->mergeConfigFrom(__DIR__.'/../config/config.php', 's3-browser-based-uploads');
-
-        $this->app->bind(S3BrowserBasedUploadsManager::class, function () {
-            $adapter = $this->getS3Adapter();
-
-            return new S3BrowserBasedUploadsManager(
-                $adapter->getClient(),
-                $adapter->getBucket(),
-                $this->getInputs(),
-                $this->getConditions(),
-                $this->getExpirationTime()
-            );
-        });
-
-        $this->app->alias(S3BrowserBasedUploadsManager::class, 's3-browser-based-uploads');
+        return config('s3-browser-based-uploads.providers.default.' . $key, $default);
     }
 }