Merge pull request #11 from Daanra/prepare-0.3

Release v0.3.0

Author: Daanra

README.md

@@ -60,6 +60,28 @@ Creating a new SSL certificate for a specific domain is easy:
 \Daanra\LaravelLetsEncrypt\Facades\LetsEncrypt::createNow('mydomain.com');
 ```
 
+Alternative syntax available from v0.3.0:
+
+```php
+LetsEncrypt::certificate('mydomain.com')
+            ->chain([
+                new SomeJob()
+            ])
+            ->delay(5)
+            ->retryAfter(4)
+            ->setTries(4)
+            ->setRetryList([1, 5, 10])
+            ->create(); // or ->renew()
+```
+
+Where you can specify values for all jobs:
+
+- tries (The number of times the job may be attempted)
+- retryAfter (The number of seconds to wait before retrying the job)
+- retryList (The list of seconds to wait before retrying the job)
+- chain (Chain some jobs after the certificate has successfully been obtained)
+- delay (Set the desired delay for the job)
+
 You could also achieve the same by using an artisan command:
 ```bash
 php artisan lets-encrypt:create -d mydomain.com
@@ -84,6 +106,23 @@ $certificate->delete();
 $certificate->forceDelete();
 ```
 
+## Failure events
+
+If one of the jobs fails, one of the following events will be dispatched:
+```php
+Daanra\LaravelLetsEncrypt\Events\CleanUpChallengeFailed
+Daanra\LaravelLetsEncrypt\Events\ChallengeAuthorizationFailed
+Daanra\LaravelLetsEncrypt\Events\RegisterAccountFailed
+Daanra\LaravelLetsEncrypt\Events\RequestAuthorizationFailed
+Daanra\LaravelLetsEncrypt\Events\RequestCertificateFailed
+Daanra\LaravelLetsEncrypt\Events\StoreCertificateFailed
+Daanra\LaravelLetsEncrypt\Events\RenewExpiringCertificatesFailed
+```
+
+Every event implements the `Daanra\LaravelLetsEncrypt\Interfaces\LetsEncryptCertificateFailed` interface so you can listen for that as well.
+
+## Automatically renewing certificates
+
 Certificates are valid for 90 days. Before those 90 days are over, you will want to renew them. To do so, you
 could add the following to your `App\Console\Kernel`:
 ```php

src/Events/ChallengeAuthorizationFailed.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Daanra\LaravelLetsEncrypt\Events;
+
+use Daanra\LaravelLetsEncrypt\Interfaces\LetsEncryptCertificateFailed;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class ChallengeAuthorizationFailed implements LetsEncryptCertificateFailed
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /** @var \Throwable */
+    protected $exception;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(\Throwable $exception)
+    {
+        $this->exception = $exception;
+    }
+
+    public function getException(): \Throwable
+    {
+        return $this->exception;
+    }
+}

src/Events/CleanUpChallengeFailed.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Daanra\LaravelLetsEncrypt\Events;
+
+use Daanra\LaravelLetsEncrypt\Interfaces\LetsEncryptCertificateFailed;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class CleanUpChallengeFailed implements LetsEncryptCertificateFailed
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /** @var \Throwable */
+    protected $exception;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(\Throwable $exception)
+    {
+        $this->exception = $exception;
+    }
+
+    public function getException(): \Throwable
+    {
+        return $this->exception;
+    }
+}

src/Events/RegisterAccountFailed.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Daanra\LaravelLetsEncrypt\Events;
+
+use Daanra\LaravelLetsEncrypt\Interfaces\LetsEncryptCertificateFailed;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class RegisterAccountFailed implements LetsEncryptCertificateFailed
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /** @var \Throwable */
+    protected $exception;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(\Throwable $exception)
+    {
+        $this->exception = $exception;
+    }
+
+    public function getException(): \Throwable
+    {
+        return $this->exception;
+    }
+}

src/Events/RenewExpiringCertificatesFailed.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Daanra\LaravelLetsEncrypt\Events;
+
+use Daanra\LaravelLetsEncrypt\Interfaces\LetsEncryptCertificateFailed;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class RenewExpiringCertificatesFailed implements LetsEncryptCertificateFailed
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /** @var \Throwable */
+    protected $exception;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(\Throwable $exception)
+    {
+        $this->exception = $exception;
+    }
+
+    public function getException(): \Throwable
+    {
+        return $this->exception;
+    }
+}

src/Events/RequestAuthorizationFailed.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Daanra\LaravelLetsEncrypt\Events;
+
+use Daanra\LaravelLetsEncrypt\Interfaces\LetsEncryptCertificateFailed;
+use Daanra\LaravelLetsEncrypt\Models\LetsEncryptCertificate;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class RequestAuthorizationFailed implements LetsEncryptCertificateFailed
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /** @var \Throwable */
+    protected $exception;
+
+    /** @var LetsEncryptCertificate */
+    protected $certificate;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(\Throwable $exception, LetsEncryptCertificate $certificate)
+    {
+        $this->exception = $exception;
+        $this->certificate = $certificate;
+    }
+
+    public function getException(): \Throwable
+    {
+        return $this->exception;
+    }
+
+
+    public function getCertificate(): LetsEncryptCertificate
+    {
+        return $this->certificate;
+    }
+}

src/Events/RequestCertificateFailed.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Daanra\LaravelLetsEncrypt\Events;
+
+use Daanra\LaravelLetsEncrypt\Interfaces\LetsEncryptCertificateFailed;
+use Daanra\LaravelLetsEncrypt\Models\LetsEncryptCertificate;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class RequestCertificateFailed implements LetsEncryptCertificateFailed
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /** @var \Throwable */
+    protected $exception;
+
+    /** @var LetsEncryptCertificate */
+    protected $certificate;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(\Throwable $exception, LetsEncryptCertificate $certificate)
+    {
+        $this->exception = $exception;
+        $this->certificate = $certificate;
+    }
+
+    public function getException(): \Throwable
+    {
+        return $this->exception;
+    }
+
+    public function getCertificate(): LetsEncryptCertificate
+    {
+        return $this->certificate;
+    }
+}

src/Events/StoreCertificateFailed.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Daanra\LaravelLetsEncrypt\Events;
+
+use Daanra\LaravelLetsEncrypt\Interfaces\LetsEncryptCertificateFailed;
+use Daanra\LaravelLetsEncrypt\Models\LetsEncryptCertificate;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+class StoreCertificateFailed implements LetsEncryptCertificateFailed
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    /** @var \Throwable */
+    protected $exception;
+
+    /** @var LetsEncryptCertificate */
+    protected $certificate;
+
+    /**
+     * Create a new event instance.
+     *
+     * @return void
+     */
+    public function __construct(\Throwable $exception, LetsEncryptCertificate $certificate)
+    {
+        $this->exception = $exception;
+        $this->certificate = $certificate;
+    }
+
+    public function getException(): \Throwable
+    {
+        return $this->exception;
+    }
+
+    public function getCertificate(): LetsEncryptCertificate
+    {
+        return $this->certificate;
+    }
+}

src/Facades/LetsEncrypt.php

@@ -3,6 +3,7 @@
 namespace Daanra\LaravelLetsEncrypt\Facades;
 
 use Daanra\LaravelLetsEncrypt\Models\LetsEncryptCertificate;
+use Daanra\LaravelLetsEncrypt\PendingCertificate;
 use Illuminate\Foundation\Bus\PendingDispatch;
 use Illuminate\Support\Facades\Facade;
 
@@ -12,6 +13,7 @@
  * @method static LetsEncryptCertificate createNow(string $domain)
  * @method static LetsEncryptCertificate renewNow(string|LetsEncryptCertificate $domain)
  * @method static PendingDispatch renew(string|LetsEncryptCertificate $domain, array $chain = [])
+ * @method static PendingCertificate certificate(string $domain)
  */
 class LetsEncrypt extends Facade
 {

src/Interfaces/LetsEncryptCertificateFailed.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Daanra\LaravelLetsEncrypt\Interfaces;
+
+interface LetsEncryptCertificateFailed
+{
+    public function getException(): \Throwable;
+}