stymiee / authnetjson

src/Authnetjson/AuthnetWebhooksRequest.php

<?php

declare(strict_types=1);

/**
 * This file is part of the AuthnetJSON package.
 *
 * (c) John Conde <stymiee@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Authnetjson;

use Authnetjson\Exception\AuthnetCurlException;
use Authnetjson\Exception\AuthnetInvalidJsonException;
use Curl\Curl;

/**
 * Creates a request to the Authorize.Net Webhooks endpoints
 *
 * @package   AuthnetJSON
 * @author    John Conde <stymiee@gmail.com>
 * @copyright 2015 - 2023 John Conde <stymiee@gmail.com>
 * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
 * @link      https://github.com/stymiee/authnetjson
 * @see       https://developer.authorize.net/api/reference/features/webhooks.html
 */
class AuthnetWebhooksRequest
{
    /**
     * @var string  Base URL for processing a webhook
     */
    private $url;

    /**
     * @var string  Endpoint for processing a webhook
     */
    private $endpoint;

    /**
     * @var string  JSON formatted API request
     */
    private $requestJson;

    /**
     * @var object  Wrapper object representing an endpoint
     */
    private $processor;

    /**
     * Creates the request object by setting the Authorize.Net credentials and URL of the endpoint to be used
     * for the API call
     *
     * @param string $api_url URL endpoint for processing a transaction
     */
    public function __construct(string $api_url)
    {
        $this->url = $api_url;
    }

    /**
     * Outputs the account credentials, endpoint URL, and request JSON in a human-readable format
     *
     * @return string  HTML table containing debugging information
     */
    public function __toString(): string
    {
        $output = '<table id="authnet-request">' . "\n";
        $output .= '<caption>Authorize.Net Request</caption>' . "\n";
        $output .= '<tr><th colspan="2"><b>Class Parameters</b></th></tr>' . "\n";
        $output .= '<tr><td><b>Authnet Server URL</b></td><td>' . $this->url . '</td></tr>' . "\n";
        $output .= '<tr><th colspan="2"><b>Request JSON</b></th></tr>' . "\n";
        if (!empty($this->requestJson)) {
            $output .= '<tr><td colspan="2"><pre>' . "\n";
            $output .= $this->requestJson . "\n";
            $output .= '</pre></td></tr>' . "\n";
        } else {
            $output .= '<tr><td colspan="2" style="text-align: center;"><pre>N/A</pre></td></tr>' . "\n";
        }
        $output .= '</table>';

        return $output;
    }

    /**
     * Creates a new webhook
     *
     * @param array $webhooks Array of webhooks to be created or modified
     * @param string $webhookUrl URL of where webhook notifications will be sent
     * @param string $status Status of webhooks to be created or modified [active/inactive]
     * @return AuthnetWebhooksResponse
     * @throws AuthnetInvalidJsonException
     * @throws AuthnetCurlException
     */
    public function createWebhooks(array $webhooks, string $webhookUrl, string $status = 'active'): object
    {
        $this->endpoint = 'webhooks';
        $this->url = sprintf('%s%s', $this->url, $this->endpoint);
        $request = [
            'url'        => $webhookUrl,
            'eventTypes' => $webhooks,
            'status'     => $status
        ];
        $this->requestJson = json_encode($request);
        $response = $this->post($this->url, $this->requestJson);
        return new AuthnetWebhooksResponse($response);
    }

    /**
     * Sends a test ping to a URL for (a) designated webhook(s)
     *
     * @param string $webhookId Webhook ID to be tested
     * @throws AuthnetCurlException
     */
    public function testWebhook(string $webhookId): void
    {
        $this->endpoint = 'webhooks';
        $this->url = sprintf('%s%s/%s/pings', $this->url, $this->endpoint, $webhookId);
        $this->requestJson = json_encode([]);
        $this->post($this->url, $this->requestJson);
    }

    /**
     * Gets all available event types
     *
     * @return AuthnetWebhooksResponse
     * @throws AuthnetCurlException
     * @throws AuthnetInvalidJsonException
     */
    public function getEventTypes(): object
    {
        $this->endpoint = 'eventtypes';
        $this->url = sprintf('%s%s', $this->url, $this->endpoint);
        return $this->getByUrl($this->url);
    }

    /**
     * List all of your webhooks
     *
     * @return AuthnetWebhooksResponse
     * @throws AuthnetCurlException
     * @throws AuthnetInvalidJsonException
     */
    public function getWebhooks(): object
    {
        $this->endpoint = 'webhooks';
        $this->url = sprintf('%s%s', $this->url, $this->endpoint);
        return $this->getByUrl($this->url);
    }

    /**
     * Get a webhook
     *
     * @param string $webhookId Webhook ID to be retrieved
     * @return AuthnetWebhooksResponse
     * @throws AuthnetCurlException
     * @throws AuthnetInvalidJsonException
     */
    public function getWebhook(string $webhookId): object
    {
        $this->endpoint = 'webhooks';
        $this->url = sprintf('%s%s/%s', $this->url, $this->endpoint, $webhookId);
        return $this->getByUrl($this->url);
    }

    /**
     * GET API request
     *
     * @param string $url API endpoint to hit
     * @return object
     * @throws AuthnetCurlException
     * @throws AuthnetInvalidJsonException
     */
    private function getByUrl(string $url): object

Private method name "AuthnetWebhooksRequest::getByUrl" must be prefixed with an underscore

    {
        $response = $this->get($url);
        return new AuthnetWebhooksResponse($response);
    }

    /**
     * Updates webhook event types
     *
     * @param string $webhookId Webhook ID to be modified
     * @param string $webhookUrl URL of where webhook notifications will be sent
     * @param array $eventTypes Array of event types to be added/removed
     * @param string $status Status of webhooks to be modified [active/inactive]
     * @return AuthnetWebhooksResponse
     * @throws AuthnetInvalidJsonException
     * @throws AuthnetCurlException
     */
    public function updateWebhook(
        string $webhookId,
        string $webhookUrl,
        array $eventTypes,
        string $status = 'active'
    ): object {
        $this->endpoint = 'webhooks';
        $this->url = sprintf('%s%s/%s', $this->url, $this->endpoint, $webhookId);
        $request = [
            'url'        => $webhookUrl,
            'eventTypes' => $eventTypes,
            'status'     => $status
        ];
        $this->requestJson = json_encode($request);
        $response = $this->put($this->url, $this->requestJson);
        return new AuthnetWebhooksResponse($response);
    }

    /**
     * Delete a webhook
     *
     * @param string $webhookId Webhook ID to be deleted
     * @throws AuthnetCurlException
     */
    public function deleteWebhook(string $webhookId): void
    {
        $this->endpoint = 'webhooks';
        $this->url = sprintf('%s%s/%s', $this->url, $this->endpoint, $webhookId);
        $this->delete($this->url);
    }

    /**
     * Retrieve Notification History
     *
     * @param int $limit Default: 1000
     * @param int $offset Default: 0
     * @return AuthnetWebhooksResponse
     * @throws AuthnetInvalidJsonException
     * @throws AuthnetCurlException
     */
    public function getNotificationHistory(int $limit = 1000, int $offset = 0): object
    {
        $this->endpoint = 'notifications';
        $this->url = sprintf('%s%s', $this->url, $this->endpoint);
        $response = $this->get(
            $this->url,
            [
                'offset' => $offset,
                'limit'  => $limit
            ]
        );
        return new AuthnetWebhooksResponse($response);
    }

    /**
     * Tells the handler to make the API call to Authorize.Net
     *
     * @return string
     * @throws AuthnetCurlException
     */
    private function handleResponse(): string

Private method name "AuthnetWebhooksRequest::handleResponse" must be prefixed with an underscore

    {
        if (!$this->processor->error) {
            return $this->processor->response;
        }
        $response = json_decode($this->processor->response, false);
        $error_message = sprintf('(%u) %s: %s', $response->status, $response->reason, $response->message);

        throw new AuthnetCurlException(sprintf('Connection error: %s', $error_message));
    }

    /**
     * Make GET request via Curl
     *
     * @param string $url
     * @param array $params
     * @return string
     * @throws AuthnetCurlException
     *
     * @codeCoverageIgnore
     */
    private function get(string $url, array $params = []): string

Private method name "AuthnetWebhooksRequest::get" must be prefixed with an underscore

    {
        $this->processor->get($url, $params);
        return $this->handleResponse();
    }

    /**
     * Make POST request via Curl
     *
     * @param string $url API endpoint
     * @param string $request JSON request payload
     * @return string
     * @throws AuthnetCurlException
     *
     * @codeCoverageIgnore
     */
    private function post(string $url, string $request): string

Private method name "AuthnetWebhooksRequest::post" must be prefixed with an underscore

    {
        $this->processor->post($url, $request);
        return $this->handleResponse();
    }

    /**
     * Make PUT request via Curl
     *
     * @param string $url API endpoint
     * @param string $request JSON request payload
     * @return string
     * @throws AuthnetCurlException
     *
     * @codeCoverageIgnore
     */
    private function put(string $url, string $request): string

Private method name "AuthnetWebhooksRequest::put" must be prefixed with an underscore

    {
        $this->processor->put($url, $request, true);
        return $this->handleResponse();
    }

    /**
     * Make DELETE request via Curl
     *
     * @param string $url API endpoint
     * @return string
     * @throws AuthnetCurlException
     *
     * @codeCoverageIgnore
     */
    private function delete(string $url): string

Private method name "AuthnetWebhooksRequest::delete" must be prefixed with an underscore

    {
        $this->processor->delete($url, [], true);
        return $this->handleResponse();
    }

    /**
     * Sets the handler to be used to handle our API call. Mainly used for unit testing as Curl is used by default.
     *
     * @param Curl $processor
     */
    public function setProcessHandler(Curl $processor): void
    {
        $this->processor = $processor;
    }

    /**
     * Gets the request sent to Authorize.Net in JSON format for logging purposes
     *
     * @return string transaction request sent to Authorize.Net in JSON format
     */
    public function getRawRequest(): string
    {
        return $this->requestJson;
    }
}