Added sign() helper

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-cloudfront-url-signer` will be documented in this file.
 
-## 0.1.0 - 2018-02-08
+## 0.1.1 - 2018-02-09
 
-- Pre-release
+- Added `sign()` helper
+
+## 0.1.0 - 2018-02-09
+
+- Initial release

composer.json

@@ -30,7 +30,10 @@
     "autoload": {
         "psr-4": {
             "Dreamonkey\\CloudFrontUrlSigner\\": "src"
-        }
+        },
+        "files": [
+            "src/helpers.php"
+        ]
     },
     "autoload-dev": {
         "psr-4": {

src/CloudFrontUrlSigner.php

@@ -64,7 +64,7 @@ public function __construct(CloudFrontClient $cloudFrontClient, string $privateK
      * @return string
      * @throws \Dreamonkey\CloudFrontUrlSigner\Exceptions\InvalidExpiration
      */
-    public function sign($url, $expiration)
+    public function sign(string $url, $expiration): string
     {
         $resourceKey = Http::createFromString($url);
 
@@ -85,7 +85,7 @@ public function sign($url, $expiration)
      *
      * @return bool
      */
-    protected function isFuture($timestamp)
+    protected function isFuture(int $timestamp): bool
     {
         return ((int)$timestamp) >= (new DateTime())->getTimestamp();
     }
@@ -100,7 +100,7 @@ protected function isFuture($timestamp)
      * @return string
      * @throws \Dreamonkey\CloudFrontUrlSigner\Exceptions\InvalidExpiration
      */
-    protected function getExpirationTimestamp($expiration)
+    protected function getExpirationTimestamp($expiration): string
     {
         if (is_int($expiration)) {
             $expiration = (new DateTime())->modify((int)$expiration . ' days');

src/UrlSigner.php

@@ -12,5 +12,5 @@ interface UrlSigner
      *
      * @return string
      */
-    public function sign($url, $expiration);
+    public function sign(string $url, $expiration): string;
 }

src/helpers.php

@@ -0,0 +1,18 @@
+<?php
+
+use Dreamonkey\CloudFrontUrlSigner\UrlSigner;
+
+if (!function_exists('sign')) {
+    /**
+     * A helper method to sign an URL using a CloudFront canned policy.
+     *
+     * @param string $url
+     * @param \DateTime|int $expiration
+     *
+     * @return string
+     */
+    function sign(string $url, $expiration): string
+    {
+        return app(UrlSigner::class)->sign($url, $expiration);
+    }
+}

tests/SignatureGenerationTest.php

@@ -9,9 +9,9 @@
 
 class SignatureGenerationTest extends TestCase
 {
-    private $dummyUrl = 'http://myapp.com';
     private $dummyPrivateKeyPath = 'dummy/path/key.pem';
     private $dummyKeyPairId = 'dummyKeyPairId';
+    private $dummyUrl = 'http://myapp.com';
 
     private $mockCloudFrontClient;
 
@@ -54,7 +54,7 @@ public function it_will_throw_an_exception_for_an_empty_private_key_path()
     }
 
     /** @test */
-    public function it_can_sign_a_signed_url_that_expires_at_a_certain_time()
+    public function it_can_sign_an_url_that_expires_at_a_certain_time()
     {
         $expiration = DateTime::createFromFormat('d/m/Y H:i:s', '10/08/2115 18:15:44',
             new DateTimeZone('Europe/Brussels'));
@@ -70,7 +70,7 @@ public function it_can_sign_a_signed_url_that_expires_at_a_certain_time()
     }
 
     /** @test */
-    public function it_can_sign_a_signed_url_that_expires_after_a_relative_amount_of_days()
+    public function it_can_sign_an_url_that_expires_after_a_relative_amount_of_days()
     {
         $expiration = 30;