first commit

administrator/components/com_akeebabackup/webpush/WebPush/MessageSentReport.php

@@ -0,0 +1,174 @@
+<?php
+/**
+ * Akeeba WebPush
+ *
+ * An abstraction layer for easier implementation of WebPush in Joomla components.
+ *
+ * @copyright (c) 2022 Akeeba Ltd
+ * @license   GNU GPL v3 or later; see LICENSE.txt
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace Akeeba\WebPush\WebPush;
+
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * This class is a derivative work based on the WebPush library by Louis Lagrange. It has been modified to only use
+ * dependencies shipped with Joomla itself and must not be confused with the original work.
+ *
+ * You can find the original code at https://github.com/web-push-libs
+ *
+ * The original code came with the following copyright notice:
+ *
+ * =====================================================================================================================
+ *
+ * This file is part of the WebPush library.
+ *
+ * (c) Louis Lagrange <lagrange.louis@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE-LAGRANGE.txt
+ * file that was distributed with this source code.
+ *
+ * =====================================================================================================================
+ *
+ * @author Igor Timoshenkov [it@campoint.net]
+ * @started: 03.09.2018 9:21
+ *
+ * Standardized response from sending a message
+ */
+class MessageSentReport implements \JsonSerializable
+{
+	/**
+	 * @var string
+	 */
+	protected $reason;
+
+	/**
+	 * @var RequestInterface
+	 */
+	protected $request;
+
+	/**
+	 * @var ResponseInterface | null
+	 */
+	protected $response;
+
+	/**
+	 * @var boolean
+	 */
+	protected $success;
+
+	/**
+	 * @param   string  $reason
+	 */
+	public function __construct(RequestInterface $request, ?ResponseInterface $response = null, bool $success = true, $reason = 'OK')
+	{
+		$this->request  = $request;
+		$this->response = $response;
+		$this->success  = $success;
+		$this->reason   = $reason;
+	}
+
+	public function getEndpoint(): string
+	{
+		return $this->request->getUri()->__toString();
+	}
+
+	public function getReason(): string
+	{
+		return $this->reason;
+	}
+
+	public function setReason(string $reason): MessageSentReport
+	{
+		$this->reason = $reason;
+
+		return $this;
+	}
+
+	public function getRequest(): RequestInterface
+	{
+		return $this->request;
+	}
+
+	public function setRequest(RequestInterface $request): MessageSentReport
+	{
+		$this->request = $request;
+
+		return $this;
+	}
+
+	public function getRequestPayload(): string
+	{
+		return $this->request->getBody()->getContents();
+	}
+
+	public function getResponse(): ?ResponseInterface
+	{
+		return $this->response;
+	}
+
+	public function setResponse(ResponseInterface $response): MessageSentReport
+	{
+		$this->response = $response;
+
+		return $this;
+	}
+
+	public function getResponseContent(): ?string
+	{
+		if (!$this->response)
+		{
+			return null;
+		}
+
+		return $this->response->getBody()->getContents();
+	}
+
+	public function isSubscriptionExpired(): bool
+	{
+		if (!$this->response)
+		{
+			return false;
+		}
+
+		return \in_array($this->response->getStatusCode(), [404, 410], true);
+	}
+
+	public function isSuccess(): bool
+	{
+		return $this->success;
+	}
+
+	public function setSuccess(bool $success): MessageSentReport
+	{
+		$this->success = $success;
+
+		return $this;
+	}
+
+	public function jsonSerialize(): array
+	{
+		return [
+			'success'  => $this->isSuccess(),
+			'expired'  => $this->isSubscriptionExpired(),
+			'reason'   => $this->reason,
+			'endpoint' => $this->getEndpoint(),
+			'payload'  => $this->request->getBody()->getContents(),
+		];
+	}
+}