JohnConde\Authnet\AuthnetWebhook

Complexity

Total Complexity

15

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	15	5
A	__toString()	0	16	1
A	__get()	0	4	1
A	isValid()	0	5	2
A	getRequestId()	0	4	2
A	getAllHeaders()	0	15	4

<?php

/**
 * 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 JohnConde\Authnet;

/**
 * Handles a Webhook notification from the Authorize.Net Webhooks API
 *
 * @package     AuthnetJSON
 * @author      John Conde <stymiee@gmail.com>
 * @copyright   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/
 */
class AuthnetWebhook
{
    /**
     * @var     object  SimpleXML object representing the Webhook notification
     */
    private $webhook;

    /**
     * @var     string  JSON string that is the Webhook notification sent by Authorize.Net
     */
    private $webhookJson;

    /**
     * @var     array  HTTP headers sent with the notification
     */
    private $headers;

    /**
     * @var     string  Authorize.Net Signature Key
     */
    private $signature;

    /**
     * Creates the response object with the response json returned from the API call
     *
     * @param   string   $signature    Authorize.Net Signature Key
     * @param   string   $payload      Webhook Notification sent by Authorize.Net
     * @param   array    $headers      HTTP headers sent with the Webhook notification. Optional if PHP is run as an Apache module
     * @throws  \JohnConde\Authnet\AuthnetInvalidCredentialsException
     * @throws  \JohnConde\Authnet\AuthnetInvalidJsonException
     */
    public function __construct($signature, $payload, Array $headers = [])
    {
        $this->signature   = $signature;
        $this->webhookJson = $payload;
        $this->headers     = $headers;
        if (empty($this->headers) && function_exists('apache_request_headers')) {
            $this->headers = apache_request_headers();
        }
        if (empty($this->signature)) {
            throw new AuthnetInvalidCredentialsException('You have not configured your signature properly.');
        }
        if (($this->webhook = json_decode($this->webhookJson)) === null) {
            throw new AuthnetInvalidJsonException('Invalid JSON sent in the Webhook notification');
        }
    }

    /**
     * Outputs the response JSON in a human readable format
     *
     * @return  string  HTML table containing debugging information
     */
    public function __toString()
    {
        $output  = '';
        $output .= '<table summary="Authorize.Net Webhook" id="authnet-webhook">' . "\n";
        $output .= '<tr>' . "\n\t\t" . '<th colspan="2"><b>Response HTTP Headers</b></th>' . "\n" . '</tr>' . "\n";
        $output .= '<tr><td colspan="2"><pre>' . "\n";
        $output .= var_export($this->headers) . "\n";
        $output .= '</pre></td></tr>' . "\n";
        $output .= '<tr>' . "\n\t\t" . '<th colspan="2"><b>Response JSON</b></th>' . "\n" . '</tr>' . "\n";
        $output .= '<tr><td colspan="2"><pre>' . "\n";
        $output .= $this->webhookJson . "\n";
        $output .= '</pre></td></tr>' . "\n";
        $output .= '</table>';

        return $output;
    }

    /**
     * Gets a response variable from the Webhook notification
     *
     * @param   string  $var
     * @return  string          requested variable from the API call response
     */
    public function __get($var)
    {
        return $this->webhook->{$var};
    }

    /**
     * Validates a webhook signature to determine if the webhook is valid
     *
     * @return bool
     */
    public function isValid()
    {
        $hashedBody = strtoupper(hash_hmac('sha512', $this->webhookJson, $this->signature));
        return (isset($this->headers['X-ANET-Signature']) && strtoupper(explode('=', $this->headers['X-ANET-Signature'])[1]) === $hashedBody);
    }

    /**
     * Validates a webhook signature to determine if the webhook is valid
     *
     * @return string
     */
    public function getRequestId()
    {
        return (isset($this->headers['X-Request-Id'])) ? $this->headers['X-Request-Id'] : null;
    }

    /**
     * Retrieves all HTTP headers of a given request
     *
     * @return array
     */
    protected function getAllHeaders()

getAllHeaders uses the super-global variable $_SERVER which is generally not recommended.

    {
        $headers = [];
        if (function_exists('apache_request_headers')) {
            $headers = apache_request_headers();
        }
        else {
            foreach ($_SERVER as $name => $value) {
                if (substr($name, 0, 5) == 'HTTP_') {
                    $headers[str_replace(' ', '-', ucwords(strtolower(str_replace('_', ' ', substr($name, 5)))))] = $value;
                }
            }
        }
        return $headers;
    }
}