silktide/brightlocal-api

<?php

namespace Silktide\BrightLocalApi;

use GuzzleHttp\Client as Guzzle;
use Exception;

/**
 * Class Api
 *
 * @package BrightLocal
 */
class Api
{
    /** API endpoint URL */
    const ENDPOINT = 'https://tools.brightlocal.com/seo-tools/api';

    /** expiry can't be more than 30 minutes (1800 seconds) */
    const MAX_EXPIRY = 1800;

    const HTTP_METHOD_POST = 'post';
    const HTTP_METHOD_GET = 'get';
    const HTTP_METHOD_PUT = 'put';
    const HTTP_METHOD_DELETE = 'delete';

    /**
     * @var string
     */
    protected $endpoint;

    /**
     * @var string
     */
    protected $apiKey;

    /**
     * @var string
     * */
    protected $apiSecret;

    /**
     * @var int
     * */
    protected $lastHttpCode;

    /**
     * @var string[]
     * */
    protected $allowedHttpMethods = [
        self::HTTP_METHOD_POST,
        self::HTTP_METHOD_GET,
        self::HTTP_METHOD_PUT,
        self::HTTP_METHOD_DELETE
    ];

    /**
     * @var Guzzle
     */
    protected $guzzle;

    /**
     * @param Guzzle $guzzle
     * @param string $apiKey
     * @param string $apiSecret
     * @param string $endpoint
     */
    public function __construct(Guzzle $guzzle, $apiKey, $apiSecret, $endpoint = null)
    {
        $this->guzzle = $guzzle;
        $this->endpoint = isset($endpoint) ? $endpoint : self::ENDPOINT;
        $this->setApiCredentials($apiKey, $apiSecret);
    }

    /**
     * Set API credentials
     *
     * @param string $apiKey
     * @param string $apiSecret
     */
    protected function setApiCredentials($apiKey, $apiSecret)
    {
        $this->apiKey = $apiKey;
        $this->apiSecret = $apiSecret;
    }

    /**
     * @return array
     */
    public function getSigAndExpires()
    {
        $expires = (int) gmdate('U') + self::MAX_EXPIRY;
        $sig = base64_encode(hash_hmac('sha1', $this->apiKey . $expires, $this->apiSecret, true));
        return [$sig, $expires];
    }

    /**
     * @param string $method
     * @param array $params
     * @param string $httpMethod
     * @throws \Exception
     * @return bool|mixed
     */
    public function call($method, $params = [], $httpMethod = self::HTTP_METHOD_POST)
    {
        if (!in_array($httpMethod, $this->allowedHttpMethods)) {
            throw new \Exception('Invalid HTTP method specified.');
        }
        $method = str_replace('/seo-tools/api', '', $method);
        // some methods only require api key but there's no harm in also sending
        // sig and expires to those methods
        list($sig, $expires) = $this->getSigAndExpires();
        $params = array_merge(array(
            'api-key' => $this->apiKey,
            'sig'     => $sig,
            'expires' => $expires
        ), $params);


        $guzzleProps = ['form_params' => $params];

        if ($httpMethod === self::HTTP_METHOD_GET) {
            $guzzleProps = ['query' => $params];
        }

        $result = $this->guzzle->$httpMethod($this->endpoint . $method, $guzzleProps);

        $this->lastHttpCode = $result->getStatusCode();
        return json_decode($result->getBody(), true);
    }

    /**
     * @param string $method
     * @param array $params
     * @return bool|mixed
     */
    public function get($method, $params = [])
    {
        return $this->call($method, $params, self::HTTP_METHOD_GET);
    }

    /**
     * @param string $method
     * @param array $params
     * @return bool|mixed
     */
    public function post($method, $params = [])
    {
        return $this->call($method, $params, self::HTTP_METHOD_POST);
    }

    /**
     * @param string $method
     * @param array $params
     * @return bool|mixed
     */
    public function put($method, $params = [])
    {
        return $this->call($method, $params, self::HTTP_METHOD_PUT);
    }

    /**
     * @param string $method
     * @param array $params
     * @return bool|mixed
     */
    public function delete($method, $params = [])
    {
        return $this->call($method, $params, self::HTTP_METHOD_DELETE);
    }

    /**
     * @return int
     */
    public function getLastHttpCode()
    {
        return $this->lastHttpCode;
    }
}