PrintABrick/src/AppBundle/Api/Client/Brickset/BricksetClient.php

<?php

namespace AppBundle\Api\Client\Brickset;

use AppBundle\Api\Client\Brickset\Entity\AdditionalImage;
use AppBundle\Api\Client\Brickset\Entity\Instructions;
use AppBundle\Api\Client\Brickset\Entity\Review;
use AppBundle\Api\Client\Brickset\Entity\Set;
use AppBundle\Api\Client\Brickset\Entity\Subtheme;
use AppBundle\Api\Client\Brickset\Entity\Theme;
use AppBundle\Api\Client\Brickset\Entity\Year;
use AppBundle\Api\Exception\ApiException;
use AppBundle\Api\Exception\AuthenticationFailedException;
use AppBundle\Api\Exception\CallFailedException;

class BricksetClient
{
    const WSDL = 'https://brickset.com/api/v2.asmx?WSDL';

    private $apiKey = '';

    private $userHash = '';

    private $options;

    /** @var \SoapClient */
    private $soapClient;

    /**
     * @var array The defined classes
     */
    private static $classmap = [
        'sets' => Set::class,
        'additionalImages' => AdditionalImage::class,
        'instructions' => Instructions::class,
        'reviews' => Review::class,
        'themes' => Theme::class,
        'subthemes' => Subtheme::class,
        'years' => Year::class,
    ];

    /**
     * BricksetClient constructor.
     *
     * @param string $apiKey  Brickset API key
     * @param array  $options A array of config values
     *
     * @throws ApiException
     */
    public function __construct($apiKey, array $options = [])
    {
        $this->apiKey = $apiKey;

        $this->options['cache_wsdl'] = WSDL_CACHE_NONE;
        $this->options['exceptions'] = true;

        foreach (self::$classmap as $key => $value) {
            if (!isset($this->options['classmap'][$key])) {
                $this->options['classmap'][$key] = $value;
            }
        }
    }

    /**
     * Get or create new SoapClient.
     *
     * @throws ApiException
     *
     * @return \SoapClient
     */
    private function getSoapClient()
    {
        if (!$this->soapClient) {
            try {
                $this->soapClient = new \SoapClient(self::WSDL, $this->options);
            } catch (\SoapFault $exception) {
                // clear uncaught FatalErrorException
                error_clear_last();
                throw new ApiException(ApiException::BRICKSET);
            } catch (\Exception $exception) {
                // clear uncaught FatalErrorException
                error_clear_last();
                throw new ApiException(ApiException::BRICKSET);
            }
        }

        return $this->soapClient;
    }

    /**
     * @param mixed $apiKey
     */
    public function setApiKey($apiKey)
    {
        $this->apiKey = $apiKey;
    }

    private function call($method, $parameters)
    {
        $parameters['apiKey'] = $this->apiKey;

        try {
            $this->checkApiKey();

            $result = $this->getSoapClient()->__soapCall($method, [$parameters]);

            if (property_exists($result, $method.'Result')) {
                return $result->{$method.'Result'};
            }

            return null;
        } catch (\SoapFault $e) {
            throw new CallFailedException(ApiException::BRICKSET);
        } catch (AuthenticationFailedException $e) {
            throw $e;
        } catch (\Exception $e) {
            throw new ApiException(ApiException::BRICKSET);
        }
    }

    private function getArrayResult($response, $method)
    {
        if ($response && $result = $response->{$method}) {
            return is_array($result) ? $result : [$result];
        }

        return null;
    }

    /**
     * Retrieve a list of sets.
     *
     * @param array $parameters
     *
     * @return Set[]
     */
    public function getSets($parameters)
    {
        $parameters['userHash'] = $this->userHash;
        if (!array_key_exists('pageSize', $parameters)) {
            $parameters['pageSize'] = 1000;
        }

        // Add blank required parameters to api call in order to recieve response
        $required_keys = ['query', 'theme', 'subtheme', 'setNumber', 'year', 'owned', 'wanted', 'orderBy', 'pageSize', 'pageNumber', 'userName'];
        foreach ($required_keys as $key) {
            if (!array_key_exists($key, $parameters)) {
                $parameters[$key] = '';
            }
        }

        $response = $this->call('getSets', $parameters);

        return $this->getArrayResult($response, 'sets');
    }

    /**
     * @param $SetID
     *
     * @return Set
     */
    public function getSet($SetID)
    {
        $parameters = ['userHash' => $this->userHash, 'SetID' => $SetID];

        return $this->call('getSet', $parameters)->sets;
    }

    /**
     * Get a list of sets that have changed in the last {minutesAgo} minutes.
     *
     * @param int $minutesAgo
     *
     * @return Set[]
     */
    public function getRecentlyUpdatedSets($minutesAgo)
    {
        $parameters = ['minutesAgo' => $minutesAgo];

        $response = $this->call('getRecentlyUpdatedSets', $parameters);

        return $this->getArrayResult($response, 'sets');
    }

    /**
     * Get a list of URLs of additional set images for the specified set.
     *
     * @param int $setID Brickset unique id of set
     *
     * @return AdditionalImage[]
     */
    public function getAdditionalImages($setID)
    {
        $parameters = ['setID' => $setID];
        $response = $this->call('getAdditionalImages', $parameters);

        return $this->getArrayResult($response, 'additionalImages');
    }

    /**
     * Get the reviews for the specified set.
     *
     * @param int $setID Brickset unique id of set
     *
     * @return Review[]
     */
    public function getReviews($setID)
    {
        $parameters = ['setID' => $setID];

        $response = $this->call('getReviews', $parameters);

        return $this->getArrayResult($response, 'reviews');
    }

    /**
     * Get a list of instructions for the specified set.
     *
     * @param int $setID Brickset unique id of set
     *
     * @return Instructions[]
     */
    public function getInstructions($setID)
    {
        $parameters = ['setID' => $setID];

        $response = $this->call('getInstructions', $parameters);

        return $this->getArrayResult($response, 'instructions');
    }

    /**
     * Get a list of themes, with the total number of sets in each.
     *
     * @return Theme[]
     */
    public function getThemes()
    {
        return $this->call('getThemes', [])->themes;
    }

    /**
     * Get a list of subthemes for a given theme, with the total number of sets in each.
     *
     * @param string $theme Name of theme
     *
     * @return Subtheme[]
     */
    public function getSubthemes($theme)
    {
        $parameters = ['theme' => $theme];

        $response = $this->call('getSubthemes', $parameters);

        return $this->getArrayResult($response, 'subthemes');
    }

    /**
     * Get a list of years for a given theme, with the total number of sets in each.
     *
     * @param string $theme Name of theme
     *
     * @return Year[]
     */
    public function getYears($theme)
    {
        $parameters = ['theme' => $theme];

        $response = $this->call('getYears', $parameters);

        return $this->getArrayResult($response, 'years');
    }

    /**
     * Log in as a user and retrieve a token that can be used in subsequent API calls.
     *
     * @param string $username
     * @param string $password
     *
     * @return bool True if successful
     */
    public function login($username, $password)
    {
        $parameters = ['username' => $username, 'password' => $password];

        $response = $this->call('login', $parameters);
        if ($response == 'INVALIDKEY') {
            return false;
        } elseif (strpos($response, 'ERROR:') === 0) {
            return false;
        }
        $this->userHash = $response;

        return true;
    }

    /**
     * Check if an API key is valid.
     *
     * @throws AuthenticationFailedException If api key is not valid
     */
    private function checkApiKey()
    {
        $parameters['apiKey'] = $this->apiKey;

        if ($this->getSoapClient()->__soapCall('checkKey', [$parameters])->checkKeyResult != 'OK') {
            throw new AuthenticationFailedException(ApiException::BRICKSET);
        }
    }
}