From 9948722b35a80b8c097d611cdaddc18df4dac1ca Mon Sep 17 00:00:00 2001
From: Brian Stoop <brian.stoop@moveagency.com>
Date: Fri, 8 Nov 2024 11:46:20 +0100
Subject: [PATCH] Corona: Add http exception for temporarily disabled API's

Reviewed at https://reviews.lunr.nl/r/1227/
---
 .../TemporarilyDisabledException.php          | 34 ++++++++
 .../TemporarilyDisabledExceptionBaseTest.php  | 48 +++++++++++
 .../TemporarilyDisabledExceptionTest.php      | 79 +++++++++++++++++++
 3 files changed, 161 insertions(+)
 create mode 100644 src/Lunr/Corona/Exceptions/TemporarilyDisabledException.php
 create mode 100644 src/Lunr/Corona/Exceptions/Tests/TemporarilyDisabledExceptionBaseTest.php
 create mode 100644 src/Lunr/Corona/Exceptions/Tests/TemporarilyDisabledExceptionTest.php

diff --git a/src/Lunr/Corona/Exceptions/TemporarilyDisabledException.php b/src/Lunr/Corona/Exceptions/TemporarilyDisabledException.php
new file mode 100644
index 00000000..46c8443c
--- /dev/null
+++ b/src/Lunr/Corona/Exceptions/TemporarilyDisabledException.php
@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * This file contains the TemporarilyDisabledException class.
+ *
+ * SPDX-FileCopyrightText: Copyright 2024 Move Agency Group B.V., Zwolle, The Netherlands
+ * SPDX-License-Identifier: MIT
+ */
+
+namespace Lunr\Corona\Exceptions;
+
+use Exception;
+
+/**
+ * Exception for the Temporarily Disabled HTTP error (540).
+ */
+class TemporarilyDisabledException extends HttpException
+{
+
+    /**
+     * Constructor.
+     *
+     * @param string         $message  Error message
+     * @param int            $app_code Application error code
+     * @param Exception|null $previous The previously thrown exception
+     */
+    public function __construct(string $message = 'The requested API is temporarily disabled', int $app_code = 0, Exception $previous = NULL)
+    {
+        parent::__construct($message, 540, $app_code, $previous);
+    }
+
+}
+
+?>
diff --git a/src/Lunr/Corona/Exceptions/Tests/TemporarilyDisabledExceptionBaseTest.php b/src/Lunr/Corona/Exceptions/Tests/TemporarilyDisabledExceptionBaseTest.php
new file mode 100644
index 00000000..fe7a2efd
--- /dev/null
+++ b/src/Lunr/Corona/Exceptions/Tests/TemporarilyDisabledExceptionBaseTest.php
@@ -0,0 +1,48 @@
+<?php
+
+/**
+ * This file contains the TemporarilyDisabledExceptionBaseTest class.
+ *
+ * SPDX-FileCopyrightText: Copyright 2024 Move Agency Group B.V., Zwolle, The Netherlands
+ * SPDX-License-Identifier: MIT
+ */
+
+namespace Lunr\Corona\Exceptions\Tests;
+
+/**
+ * This class contains tests for the TemporarilyDisabledException class.
+ *
+ * @covers Lunr\Corona\Exceptions\TemporarilyDisabledException
+ */
+class TemporarilyDisabledExceptionBaseTest extends TemporarilyDisabledExceptionTest
+{
+
+    /**
+     * Test that the error code was set correctly.
+     */
+    public function testErrorCodeSetCorrectly(): void
+    {
+        $this->assertPropertySame('code', 540);
+    }
+
+    /**
+     * Test that the error code was set correctly.
+     */
+    public function testApplicationErrorCodeSetCorrectly(): void
+    {
+        $this->assertPropertySame('app_code', $this->code);
+    }
+
+    /**
+     * Test that the error message was passed correctly.
+     */
+    public function testErrorMessagePassedCorrectly(): void
+    {
+        $this->expectExceptionMessage($this->message);
+
+        throw $this->class;
+    }
+
+}
+
+?>
diff --git a/src/Lunr/Corona/Exceptions/Tests/TemporarilyDisabledExceptionTest.php b/src/Lunr/Corona/Exceptions/Tests/TemporarilyDisabledExceptionTest.php
new file mode 100644
index 00000000..e4d9ff10
--- /dev/null
+++ b/src/Lunr/Corona/Exceptions/Tests/TemporarilyDisabledExceptionTest.php
@@ -0,0 +1,79 @@
+<?php
+
+/**
+ * This file contains the TemporarilyDisabledExceptionTest class.
+ *
+ * SPDX-FileCopyrightText: Copyright 2024 Move Agency Group B.V., Zwolle, The Netherlands
+ * SPDX-License-Identifier: MIT
+ */
+
+namespace Lunr\Corona\Exceptions\Tests;
+
+use Exception;
+use Lunr\Corona\Exceptions\TemporarilyDisabledException;
+use Lunr\Halo\LunrBaseTest;
+
+/**
+ * This class contains common setup routines, providers
+ * and shared attributes for testing the TemporarilyDisabledException class.
+ *
+ * @covers Lunr\Corona\Exceptions\TemporarilyDisabledException
+ */
+abstract class TemporarilyDisabledExceptionTest extends LunrBaseTest
+{
+
+    /**
+     * Previous exception.
+     * @var Exception
+     */
+    protected $previous;
+
+    /**
+     * Error message.
+     * @var string
+     */
+    protected $message;
+
+    /**
+     * Application error code.
+     * @var int
+     */
+    protected $code;
+
+    /**
+     * Instance of the tested class.
+     * @var TemporarilyDisabledException
+     */
+    protected TemporarilyDisabledException $class;
+
+    /**
+     * TestCase Constructor.
+     */
+    public function setUp(): void
+    {
+        $this->message = 'Http error!';
+        $this->code    = 9999;
+
+        $this->previous = new Exception();
+
+        $this->class = new TemporarilyDisabledException($this->message, $this->code, $this->previous);
+
+        parent::baseSetUp($this->class);
+    }
+
+    /**
+     * TestCase Destructor.
+     */
+    public function tearDown(): void
+    {
+        unset($this->code);
+        unset($this->message);
+        unset($this->previous);
+        unset($this->class);
+
+        parent::tearDown();
+    }
+
+}
+
+?>