stymiee / authnetjson

src/Authnetjson/AuthnetSim.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\AuthnetInvalidAmountException;
use Exception;

/**
 * Wrapper to simplify the creation of SIM data
 *
 * @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
 */
class AuthnetSim
{
    /**
     * @var string  Authorize.Net API login ID
     */
    private $login;

    /**
     * @var string  Authorize.Net API signature key
     */
    private $signature;

    /**
     * @var string  URL endpoint for processing a transaction
     */
    private $url;

    /**
     * @var int  Randomly generated number

Expected "integer" but found "int" for @var tag in member variable comment

     */
    private $sequence;

    /**
     * @var int  Unix timestamp the request was made

Expected "integer" but found "int" for @var tag in member variable comment

     */
    private $timestamp;

    /**
     * Creates a SIM wrapper by setting the Authorize.Net credentials and URL of the endpoint to be used
     * for the API call
     *
     * @param string $login Authorize.Net API login ID
     * @param string $signature Authorize.Net API Transaction Key
     * @param string $api_url URL endpoint for processing a transaction
     * @throws Exception
     */
    public function __construct(string $login, string $signature, string $api_url)
    {
        $this->login = $login;
        $this->signature = $signature;
        $this->url = $api_url;
        $this->resetParameters();
    }

    /**
     * Returns the hash for the SIM transaction
     *
     * @param float $amount The amount of the transaction
     * @return string           Hash of five different unique transaction parameters
     * @throws AuthnetInvalidAmountException
     */
    public function getFingerprint(float $amount): string
    {
        if (!filter_var($amount, FILTER_VALIDATE_FLOAT, FILTER_FLAG_ALLOW_THOUSAND)) {
            throw new AuthnetInvalidAmountException('You must enter a valid amount greater than zero.');
        }

        return strtoupper(
            hash_hmac(
                'sha512',
                sprintf(
                    '%s^%s^%s^%s^',
                    $this->login,
                    $this->sequence,
                    $this->timestamp,
                    $amount
                ),
                hex2bin($this->signature)
            )
        );
    }

    /**
     * Returns the sequence generated for a transaction
     *
     * @return int Current sequence
     */
    public function getSequence(): int
    {
        return $this->sequence;
    }

    /**
     * Returns the timestamp for a transaction
     *
     * @return int Current timestamp
     */
    public function getTimestamp(): int
    {
        return $this->timestamp;
    }

    /**
     * Returns the account login ID
     *
     * @return string           API login ID
     */
    public function getLogin(): string
    {
        return $this->login;
    }

    /**
     * Returns the url endpoint for the transaction
     *
     * @return string           url endpoint
     */
    public function getEndpoint(): string
    {
        return $this->url;
    }

    /**
     * Resets the sequence and timestamp
     *
     * @throws Exception
     */
    public function resetParameters(): void
    {
        $this->sequence = random_int(1, 1000);
        $this->timestamp = time();
    }
}