wip

Author: chrisbbreuer

.gitattributes

@@ -4,7 +4,6 @@
 # Ignore all test and documentation with "export-ignore".
 /.gitattributes     export-ignore
 /.gitignore         export-ignore
-/.travis.yml        export-ignore
 /phpunit.xml.dist   export-ignore
 /.scrutinizer.yml   export-ignore
 /tests              export-ignore

README.md

@@ -8,7 +8,7 @@
 <!-- [[![Test](https://github.com/meemaio/laravel-cloudfront/workflows/Test/badge.svg?branch=master)](https://github.com/meemaio/laravel-cloudfront/actions) -->
 <!-- [[![Build Status](wip)](ghactions) -->
 
-This is a wrapper package for AWS CloudFront.
+This is a wrapper package for AWS CloudFront. Please note that while this package is used in production environments and is completely functional, it is not feature-complete. PRs & ideas are more than welcome! 
 
 ![laravel-cloudfront package image](https://banners.beyondco.de/CloundFront.png?theme=light&packageManager=composer+require&packageName=meema%2Flaravel-cloudfront&pattern=endlessClouds&style=style_1&description=Easily+%26+quickly+integrate+your+application+with+AWS+CloudFront.&md=1&showWatermark=1&fontSize=150px&images=https%3A%2F%2Flaravel.com%2Fimg%2Flogomark.min.svg)
 
@@ -18,7 +18,10 @@ This is a wrapper package for AWS CloudFront.
 use Meema\CloudFront\Facades\CloudFront;
 
 // run any of the following CloudFront methods:
-$result = CloudFront::invalidateCache(string $id);
+$client = CloudFront::getClient(); // exposes the AWS CloudFront client
+$result = CloudFront::invalidate(array $items, int $quantity = 1, string $distributionId = null);
+$message = CloudFront::getInvalidation(string $invalidationId, string $distributionId = null);
+$messages = CloudFront::listInvalidations(string $distributionId = null)
 ```
 
 ## Installation
@@ -56,8 +59,20 @@ return [
         'secret' => env('AWS_SECRET_ACCESS_KEY'),
     ],
 
+    'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
+
+    /**
+     * Specify the version of the CloudFront API you would like to use.
+     * Please only adjust this value if you know what you are doing.
+     */
     'version' => 'latest',
 
+    /**
+     * Specify the CloudFront Distribution ID.
+     * Example format: EBCYQAQALNSKL
+     */
+    'distribution_id' => env('AWS_CLOUDFRONT_DISTRIBUTION_ID'),
+
 ];
 ```
 

config/config.php

@@ -10,26 +10,17 @@
     ],
 
     'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
-    'version' => 'latest',
 
     /**
-     * Specify the IAM Role ARN.
-     *
-     * You can find the Role ARN visiting the following URL:
-     * https://console.aws.amazon.com/iam/home?region=us-east-1#/roles
-     * Please note to adjust the "region" in the URL above.
-     * Tip: in case you need to create a new Role, you may name it `CloudFront_Default_Role`
-     * by making use of this name, AWS CloudFront will default to using this IAM Role.
+     * Specify the version of the CloudFront API you would like to use.
+     * Please only adjust this value if you know what you are doing.
      */
-    'iam_arn' => env('AWS_IAM_ARN'),
+    'version' => 'latest',
 
     /**
-     * Specify the queue you would like use.
-     *
-     * It can be found by visiting the following URL:
-     * https://us-east-1.console.aws.amazon.com/CloudFront/home?region=us-east-1#/queues/details/Default
-     * Please note to adjust the "region" in the URL above.
+     * Specify the CloudFront Distribution ID.
+     * Example format: EBCYQAQALNSKL
      */
-    'queue_arn' => env('AWS_QUEUE_ARN'),
+    'distribution_id' => env('AWS_CLOUDFRONT_DISTRIBUTION_ID'),
 
 ];

src/CloudFront.php

@@ -4,6 +4,7 @@
 
 use Aws\Credentials\Credentials;
 use Aws\CloudFront\CloudFrontClient;
+use Aws\Exception\AwsException;
 use Meema\CloudFront\Contracts\CloudFront as CloudFrontInterface;
 
 class CloudFront implements CloudFrontInterface
@@ -24,7 +25,7 @@ public function __construct(CloudFrontClient $client)
     {
         $config = config('cloudfront');
 
-        $this->client = new CloudFrontClient([
+        $this->client = new $client([
             'version' => $config['version'],
             'region' => $config['region'],
             'credentials' => new Credentials($config['credentials']['key'], $config['credentials']['secret']),
@@ -42,15 +43,95 @@ public function getClient(): CloudFrontClient
     }
 
     /**
-     * Bust an item in CloudFront's cache.
+     * Bust an item/s in CloudFront's cache.
      *
-     * @param string $id
+     * @param array $items
+     * @param int $quantity
+     * @param string|null $distributionId
      * @return \Aws\Result
      */
-    public function invalidateCache(string $id)
+    public function invalidate(array $items, int $quantity = 1, string $distributionId = null)
     {
         return $this->client->createInvalidation([
-            'Id' => $id,
+            'DistributionId' => $distributionId ?? config('cloudfront.distribution_id'),
+            'InvalidationBatch' => [
+                // CallerReference is a unique value that you provide and that CloudFront uses to prevent replays of your request.
+                // You must provide a new caller reference value and other new information in the request for CloudFront to create a new invalidation request.
+                'CallerReference' => microtime(true),
+                'Paths' => [
+                    'Items' => $items,
+                    'Quantity' => $quantity,
+                ],
+            ],
         ]);
     }
+
+    /**
+     * Get a cache "invalidation".
+     *
+     * @param string $invalidationId
+     * @param string|null $distributionId
+     * @return string
+     */
+    public function getInvalidation(string $invalidationId, string $distributionId = null)
+    {
+        try {
+            $result = $this->client->getInvalidation([
+                'DistributionId' => $distributionId ?? config('cloudfront.distribution_id'),
+                'Id' => $invalidationId,
+            ]);
+
+            $message = '';
+
+            if (isset($result['Invalidation']['Status'])) {
+                $message = 'The status for the invalidation with the ID of '.$result['Invalidation']['Id'].' is '.$result['Invalidation']['Status'];
+            }
+
+            if (isset($result['@metadata']['effectiveUri'])) {
+                $message .= ', and the effective URI is '.$result['@metadata']['effectiveUri'].'.';
+            } else {
+                $message = 'Error: Could not get information about '.'the invalidation. The invalidation\'s status '.'was not available.';
+            }
+
+            return $message;
+        } catch (AwsException $e) {
+            throw($e->getAwsErrorMessage());
+        }
+    }
+
+    /**
+     * List all of the cache invalidations.
+     *
+     * @param string|null $distributionId
+     * @return array
+     */
+    public function listInvalidations(string $distributionId = null)
+    {
+        try {
+            $invalidations = $this->client->listInvalidations([
+                'DistributionId' => $distributionId ?? config('cloudfront.distribution_id') ,
+            ]);
+
+            $messages = [];
+
+            if (isset($invalidations['InvalidationList'])) {
+                if ($invalidations['InvalidationList']['Quantity'] > 0) {
+                    foreach ($invalidations['InvalidationList']['Items'] as $invalidation) {
+                        $message = 'The invalidation with the ID of '.$invalidation['Id'].' has the status of '.$invalidation['Status'].'.';
+                        $messages[$invalidation['Id']] = $message;
+                    }
+                } else {
+                    $message = 'Could not find any invalidations for the specified distribution.';
+                    array_push($messages, $message);
+                }
+            } else {
+                $message = 'Error: Could not get invalidation information. Could not get information about the specified distribution.';
+                array_push($messages, $message);
+            }
+
+            return $messages;
+        } catch (AwsException $e) {
+            throw($e->getAwsErrorMessage());
+        }
+    }
 }

src/CloudFrontManager.php

@@ -6,7 +6,6 @@
 use Aws\CloudFront\CloudFrontClient;
 use Exception;
 use Illuminate\Support\Manager;
-use Meema\CloudFront\CloudFront;
 
 class CloudFrontManager extends Manager
 {

src/Contracts/CloudFront.php

@@ -5,10 +5,29 @@
 interface CloudFront
 {
     /**
-     * Cancels an active job.
+     * Delete items in your CloudFront cache .
      *
-     * @param string $id
+     * @param array $items
+     * @param int $quantity
+     * @param string|null $distributionId
      * @return \Aws\Result
      */
-    public function createInvalidation(string $id);
+    public function invalidate(array $items, int $quantity = 1, string $distributionId = null);
+
+    /**
+     * Delete items in your CloudFront cache .
+     *
+     * @param string $invalidationId
+     * @param string|null $distributionId
+     * @return \Aws\Result
+     */
+    public function getInvalidation(string $invalidationId, string $distributionId = null);
+
+    /**
+     * Delete items in your CloudFront cache .
+     *
+     * @param string|null $distributionId
+     * @return \Aws\Result
+     */
+    public function listInvalidations(string $distributionId = null);
 }

src/Facades/CloudFront.php

@@ -5,7 +5,10 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @method static \Aws\Result invalidateCache(string $id)
+ * @method static \Aws\CloudFront\CloudFrontClient getClient()
+ * @method static \Aws\Result invalidate(array $items, int $quantity = 1, string $distributionId = null)
+ * @method static string getInvalidation(string $invalidationId, string $distributionId = null)
+ * @method static array listInvalidations(string $distributionId = null)
  */
 class CloudFront extends Facade
 {