Scriptotek\Alma\Client

Complexity

Total Complexity

23

Size/Duplication

Total Lines	259
Duplicated Lines	6.95 %

Coupling/Cohesion

Components	2
Dependencies	9

Importance

Changes	1
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	4
A	setSruClient()	0	4	1
A	assertHasSruClient()	0	6	2
A	setKey()	0	6	1
A	setRegion()	0	9	2
A	getFullUrl()	0	4	1
A	getHttpOptions()	0	11	2
A	request()	0	8	2
A	handleError()	0	5	1
A	getJSON()	9	9	1
A	getXML()	9	9	1
A	put()	0	15	1
A	putXML()	0	4	1
A	getRedirectLocation()	0	20	3

<?php

namespace Scriptotek\Alma;

use Danmichaelo\QuiteSimpleXMLElement\QuiteSimpleXMLElement;
use GuzzleHttp\Client as HttpClient;
use GuzzleHttp\Exception\RequestException;
use Scriptotek\Alma\Analytics\Analytics;
use Scriptotek\Alma\Bibs\Bibs;
use Scriptotek\Alma\Exception\ClientException;
use Scriptotek\Alma\Exception\SruClientNotSetException;
use Scriptotek\Alma\Users\Users;
use Scriptotek\Sru\Client as SruClient;

/**
 * Alma client.
 */
class Client
{
    public $baseUrl;

    /** @var string Alma zone (institution or network) */
    public $zone;

    /** @var string Alma Developers Network API key for this zone */
    public $key;

    /** @var string Network zone instance */
    public $nz;

    /** @var HttpClient */
    protected $httpClient;

    /** @var SruClient */
    public $sru;

    /** @var Bibs */
    public $bibs;

    /** @var Analytics */
    public $analytics;

    /** @var Users */
    public $users;

    /**
     * Create a new client to connect to a given Alma instance.
     *
     * @param string     $key        API key
     * @param string     $region     Hosted region code, used to build base URL
     * @param string     $zone       Alma zone (Either Zones::INSTITUTION or Zones::NETWORK)
     * @param HttpClient $httpClient
     *
     * @throws \ErrorException
     */
    public function __construct($key = null, $region = 'eu', $zone = Zones::INSTITUTION, HttpClient $httpClient = null)
    {
        $this->key = $key;
        $this->setRegion($region);
        $this->httpClient = $httpClient ?: new HttpClient();
        $this->zone = $zone;
        $this->bibs = new Bibs($this);  // Or do some magic instead?
        $this->analytics = new Analytics($this);  // Or do some magic instead?
        $this->users = new Users($this);  // Or do some magic instead?
        if ($zone == Zones::INSTITUTION) {
            $this->nz = new self(null, $region, Zones::NETWORK, $this->httpClient);

It seems like new self(null, $region, \Scriptotek\Alma\Zones::NETWORK, $this->httpClient) of type object<Scriptotek\Alma\Client> is incompatible with the declared type string of property $nz.

        } elseif ($zone != Zones::NETWORK) {
            throw new ClientException('Invalid zone name.');
        }
    }

    /**
     * Attach an SRU client (so you can search for Bib records).
     *
     * @param SruClient $sru
     */
    public function setSruClient(SruClient $sru)
    {
        $this->sru = $sru;
    }

    /**
     * Assert that an SRU client is connected. Throws SruClientNotSetException if not.
     *
     * @throws SruClientNotSetException
     */
    public function assertHasSruClient()
    {
        if (!isset($this->sru)) {
            throw new SruClientNotSetException();
        }
    }

    /**
     * Set the API key for this Alma instance.
     *
     * @param string $key The API key
     * @return $this
     */
    public function setKey($key)
    {
        $this->key = $key;

        return $this;
    }

    /**
     * Set the Alma region code ('na' for North America, 'eu' for Europe, 'ap' for Asia Pacific).
     *
     * @param $regionCode
     * @return $this
     * @throws \ErrorException
     */
    public function setRegion($regionCode)
    {
        if (!in_array($regionCode, ['na', 'eu', 'ap'])) {
            throw new ClientException('Invalid region code');
        }
        $this->baseUrl = 'https://api-' . $regionCode . '.hosted.exlibrisgroup.com/almaws/v1';

        return $this;
    }

    /**
     * @param $url
     *
     * @return string
     */
    protected function getFullUrl($url)
    {
        return $this->baseUrl . $url;
    }

    /**
     * @param array $options
     *
     * @return array
     */
    protected function getHttpOptions($options = [])
    {
        if (!$this->key) {
            throw new ClientException('No API key defined for ' . $this->zone);
        }
        $defaultOptions = [
            'headers' => ['Authorization' => 'apikey ' . $this->key],
        ];

        return array_merge_recursive($defaultOptions, $options);
    }

    /**
     * Make a HTTP request.
     *
     * @param string $method
     * @param string $url
     * @param array  $options
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function request($method, $url, $options = [])
    {
        try {
            return $this->httpClient->request($method, $this->getFullUrl($url), $this->getHttpOptions($options));
        } catch (\GuzzleHttp\Exception\ClientException $e) {
            $this->handleError($e->getResponse());
        }
    }

    public function handleError($response)
    {
        $msg = $response->getBody();
        throw new ClientException('Client error ' . $response->getStatusCode() . ': ' . $msg);
    }

    /**
     * Make a GET request, accepting JSON.
     *
     * @param string $url
     * @param array  $query
     *
     * @return mixed
     */
    public function getJSON($url, $query = [])

This method seems to be duplicated in your project.

    {
        $response = $this->request('GET', $url, [
            'query'   => $query,
            'headers' => ['Accept' => 'application/json'],
        ]);

        return json_decode($response->getBody());
    }

    /**
     * Make a GET request, accepting XML.
     *
     * @param string $url
     * @param array  $query
     *
     * @return mixed
     */
    public function getXML($url, $query = [])

This method seems to be duplicated in your project.

    {
        $response = $this->request('GET', $url, [
            'query'   => $query,
            'headers' => ['Accept' => 'application/xml'],
        ]);

        return new QuiteSimpleXMLElement(strval($response->getBody()));
    }

    /**
     * Make a PUT request.
     *
     * @param string $url
     * @param $data
     * @param string $contentType
     * @return bool
     */
    public function put($url, $data, $contentType = 'application/json')
    {
        $data = json_encode($data);

        $response = $this->request('PUT', $url, [
            'body'    => $data,
            'headers' => [
                'Content-Type' => $contentType,
                'Accept'       => $contentType,
            ],
        ]);

        return $response->getStatusCode() == '200';
        // TODO: Check if there are other success codes that can be returned
    }

    /**
     * Make a PUT request.
     *
     * @param string $url
     * @param $data
     *
     * @return bool
     */
    public function putXML($url, $data)
    {
        return $this->put($url, $data, 'application/xml');
    }

    /**
     * Get the redirect target location of an URL, or null if not a redirect.
     *
     * @param string $url
     * @param array  $query
     *
     * @return string|null
     */
    public function getRedirectLocation($url, $query = [])
    {
        try {
            $response = $this->httpClient->request('GET', $this->getFullUrl($url), $this->getHttpOptions([
                'query'           => $query,
                'headers'         => ['Accept' => 'application/json'],
                'allow_redirects' => false,
            ]));
        } catch (RequestException $e) {
            // We receive a 400 if the barcode is invalid
            // if ($e->hasResponse()) {

67% of this comment could be valid code. Did you maybe forget this after debugging?

            //     echo $e->getResponse()->getStatusCode() . "\n";

59% of this comment could be valid code. Did you maybe forget this after debugging?

            //     echo $e->getResponse()->getBody() . "\n";

59% of this comment could be valid code. Did you maybe forget this after debugging?

            // }
            return;
        }
        $locations = $response->getHeader('Location');

        return count($locations) ? $locations[0] : null;
    }
}