BEditaClient::relationSchema() - Code Metrics - Inspection of "#133 feat: relationSchema() method now available" - bedita/php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#16)

by Valerio

created 2018-07-31 15:03 UTC

BEditaClient::relationSchema() A

↳ Parent: BEditaClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2018 ChannelWeb Srl, Chialab Srl
 *
 * Licensed under The MIT License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 */

namespace BEdita\SDK;

use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Uri;
use Http\Adapter\Guzzle6\Client;
use Psr\Http\Message\ResponseInterface;
use WoohooLabs\Yang\JsonApi\Client\JsonApiClient;

/**
 * BEdita4 API Client class
 */
class BEditaClient
{

    /**
     * Last response.
     *
     * @var \Psr\Http\Message\ResponseInterface
     */
    private $response = null;

    /**
     * BEdita4 API base URL
     *
     * @var string
     */
    private $apiBaseUrl = null;

    /**
     * BEdita4 API KEY
     *
     * @var string
     */
    private $apiKey = null;

    /**
     * Default headers in request
     *
     * @var array
     */
    private $defaultHeaders = [
        'Accept' => 'application/vnd.api+json',
    ];

    /**
     * Default headers in request
     *
     * @var array
     */
    private $defaultContentTypeHeader = [
        'Content-Type' => 'application/json',
    ];

    /**
     * JWT Auth tokens
     *
     * @var array
     */
    private $tokens = [];

    /**
     * JSON API BEdita4 client
     *
     * @var \WoohooLabs\Yang\JsonApi\Client\JsonApiClient
     */
    private $jsonApiClient = null;

    /**
     * Setup main client options:
     *  - API base URL
     *  - API KEY
     *  - Auth tokens 'jwt' and 'renew' (optional)
     *
     * @param string $apiUrl API base URL
     * @param string $apiKey API key
     * @param array $tokens JWT Autorization tokens as associative array ['jwt' => '###', 'renew' => '###']
     * @return void
     */
    public function __construct(string $apiUrl, ?string $apiKey = null, array $tokens = [])
    {
        $this->apiBaseUrl = $apiUrl;
        $this->apiKey = $apiKey;

        $this->defaultHeaders['X-Api-Key'] = $this->apiKey;
        $this->setupTokens($tokens);

        // setup an asynchronous JSON API client
        $guzzleClient = Client::createWithConfig([]);
        $this->jsonApiClient = new JsonApiClient($guzzleClient);
    }

    /**
     * Setup JWT access and refresh tokens.
     *
     * @param array $tokens JWT tokens as associative array ['jwt' => '###', 'renew' => '###']
     * @return void
     */
    public function setupTokens(array $tokens) : void
    {
        $this->tokens = $tokens;
        if (!empty($tokens['jwt'])) {
            $this->defaultHeaders['Authorization'] = sprintf('Bearer %s', $tokens['jwt']);
        } else {
            unset($this->defaultHeaders['Authorization']);
        }
    }

    /**
     * Get default headers in use on every request
     *
     * @return array Default headers
     * @codeCoverageIgnore
     */
    public function getDefaultHeaders() : array
    {
        return $this->defaultHeaders;
    }

    /**
     * Get API base URL used tokens
     *
     * @return string API base URL
     * @codeCoverageIgnore
     */
    public function getApiBaseUrl() : string
    {
        return $this->apiBaseUrl;
    }

    /**
     * Get current used tokens
     *
     * @return array Current tokens
     * @codeCoverageIgnore
     */
    public function getTokens() : array
    {
        return $this->tokens;
    }

    /**
     * Get last HTTP response
     *
     * @return ResponseInterface|null Response PSR interface
     * @codeCoverageIgnore
     */
    public function getResponse() : ?ResponseInterface
    {
        return $this->response;
    }

    /**
     * Get HTTP response status code
     * Return null if no response is available
     *
     * @return int|null Status code.
     */
    public function getStatusCode() : ?int
    {
        return $this->response ? $this->response->getStatusCode() : null;
    }

    /**
     * Get HTTP response status message
     * Return null if no response is available
     *
     * @return string|null Message related to status code.
     */
    public function getStatusMessage() : ?string
    {
        return $this->response ? $this->response->getReasonPhrase() : null;
    }

    /**
     * Get response body serialized into a PHP array
     *
     * @return array|null Response body as PHP array.
     */
    public function getResponseBody() : ?array
    {
        $response = $this->getResponse();
        if (empty($response)) {
            return null;
        }
        $responseBody = json_decode((string)$response->getBody(), true);
        if (!is_array($responseBody)) {
            return null;
        }

        return $responseBody;
    }

    /**
     * Classic authentication via POST /auth using username and password
     *
     * @param string $username username
     * @param string $password password
     * @return array|null Response in array format
     */
    public function authenticate(string $username, string $password) : ?array
    {
        $body = json_encode(compact('username', 'password'));

        return $this->post('/auth', $body, ['Content-Type' => 'application/json']);
    }

    /**
     * Send a GET request a list of resources or objects or a single resource or object
     *
     * @param string $path Endpoint URL path to invoke
     * @param array|null $query Optional query string
     * @param array|null $headers Headers
     * @return array|null Response in array format
     */
    public function get(string $path, ?array $query = null, ?array $headers = null) : ?array
    {
        $this->sendRequestRetry('GET', $path, $query, $headers);

        return $this->getResponseBody();
    }

    /**
     * GET a list of resources or objects of a given type
     *
     * @param string $type Object type name
     * @param array|null $query Optional query string
     * @param array|null $headers Custom request headers
     * @return array|null Response in array format
     */
    public function getObjects(string $type = 'objects', ?array $query = null, ?array $headers = null) : ?array
    {
        return $this->get(sprintf('/%s', $type), $query, $headers);
    }

    /**
     * GET a single object of a given type
     *
     * @param int|string $id Object id
     * @param string $type Object type name
     * @param array|null $query Optional query string
     * @param array|null $headers Custom request headers
     * @return array|null Response in array format
     */
    public function getObject($id, string $type = 'objects', ?array $query = null, ?array $headers = null) : ?array
    {
        return $this->get(sprintf('/%s/%s', $type, $id), $query, $headers);
    }

    /**
     * Get a list of related resources or objects
     *
     * @param int|string $id Resource id or object uname/id
     * @param string $type Type name
     * @param string $relation Relation name
     * @param array|null $query Optional query string
     * @param array|null $headers Custom request headers
     * @return array|null Response in array format
     */
    public function getRelated($id, string $type, string $relation, ?array $query = null, ?array $headers = null) : ?array
    {
        return $this->get(sprintf('/%s/%s/%s', $type, $id, $relation), $query, $headers);
    }

    /**
     * Add a list of related resources or objects
     *
     * @param int|string $id Resource id or object uname/id
     * @param string $type Type name
     * @param string $relation Relation name
     * @param string $data Related resources or objects to add, MUST contain id and type
     * @param array|null $headers Custom request headers
     * @return array|null Response in array format
     */
    public function addRelated($id, string $type, string $relation, array $data, ?array $headers = null) : ?array
    {
        $body = compact('data');

        return $this->post(sprintf('/%s/%s/relationships/%s', $type, $id, $relation), json_encode($body), $headers);
    }

    /**
     * Remove a list of related resources or objects
     *
     * @param int|string $id Resource id or object uname/id
     * @param string $type Type name
     * @param string $relation Relation name
     * @param string $data Related resources or objects to remove from relation
     * @param array|null $headers Custom request headers
     * @return array|null Response in array format
     */
    public function removeRelated($id, string $type, string $relation, array $data, ?array $headers = null) : ?array
    {
        $body = compact('data');

        return $this->delete(sprintf('/%s/%s/relationships/%s', $type, $id, $relation), json_encode($body), $headers);
    }

    /**
     * Replace a list of related resources or objects: previuosly related are removed and replaced with these.
     *
     * @param int|string $id Object id
     * @param string $type Object type name
     * @param string $relation Relation name
     * @param string $data Related resources or objects to insert
     * @param array|null $headers Custom request headers
     * @return array|null Response in array format
     */
    public function replaceRelated($id, string $type, string $relation, array $data, ?array $headers = null) : ?array
    {
        $body = compact('data');

        return $this->patch(sprintf('/%s/%s/relationships/%s', $type, $id, $relation), json_encode($body), $headers);
    }

    /**
     * Create a new object (POST) or modify an existing one (PATCH)
     *
     * @param string $type Object type name
     * @param array $data Object data to save
     * @param array|null $headers Custom request headers
     * @return array|null Response in array format
     */
    public function saveObject(string $type, array $data, ?array $headers = null) : ?array
    {
        $id = null;
        if (array_key_exists('id', $data)) {
            $id = $data['id'];
            unset($data['id']);
        }

        $body = [
            'data' => [
                'type' => $type,
                'attributes' => $data,
            ],
        ];
        if (!$id) {
            return $this->post(sprintf('/%s', $type), json_encode($body), $headers);
        }
        $body['data']['id'] = $id;

        return $this->patch(sprintf('/%s/%s', $type, $id), json_encode($body), $headers);
    }

    /**
     * Delete an object (DELETE) => move to trashcan.
     *
     * @param int|string $id Object id
     * @param string $type Object type name
     * @return array|null Response in array format
     */
    public function deleteObject($id, string $type) : ?array
    {
        return $this->delete(sprintf('/%s/%s', $type, $id));
    }

    /**
     * Remove an object => permanently remove object from trashcan.
     *
     * @param int|string $id Object id
     * @return array|null Response in array format
     */
    public function remove($id) : ?array
    {
        return $this->delete(sprintf('/trash/%s', $id));
    }

    /**
     * Upload file (POST)
     *
     * @param string $filename The file name
     * @param string $filepath File full path: could be on a local filesystem or a remote reachable URL
     * @param array|null $headers Custom request headers
     * @return array|null Response in array format
     * @throws BEditaClientException
     */
    public function upload(string $filename, string $filepath, ?array $headers = null) : ?array
    {
        if (!file_exists($filepath)) {
            throw new BEditaClientException('File not found', 500);
        }
        $file = file_get_contents($filepath);
        if (!$file) {
            throw new BEditaClientException('File get contents failed', 500);
        }
        if (empty($headers['Content-Type'])) {
            $headers['Content-Type'] = mime_content_type($filepath);
        }

        return $this->post(sprintf('/streams/upload/%s', $filename), $file, $headers);
    }

    /**
     * Create media by type and body data and link it to a stream:
     *  - `POST /:type` with `$body` as payload, create media object
     *  - `PATCH /streams/:stream_id/relationships/object` modify stream adding relation to media
     *  - `GET /:type/:id` get media data
     *
     * @param string $streamId The stream identifier
     * @param string $type The type
     * @param array $body The body data
     * @return array|null Response in array format
     * @throws BEditaClientException
     */
    public function createMediaFromStream($streamId, string $type, array $body) : ?array
    {
        $response = $this->post(sprintf('/%s', $type), json_encode($body));
        if (empty($response)) {
            throw new BEditaClientException('Invalid response from POST ' . sprintf('/%s', $type));
        }
        $id = $response['data']['id'];
        $data = compact('id', 'type');
        $body = compact('data');
        $response = $this->patch(sprintf('/streams/%s/relationships/object', $streamId), json_encode($body));
        if (empty($response)) {
            throw new BEditaClientException('Invalid response from PATCH ' . sprintf('/streams/%s/relationships/object', $id));
        }

        return $this->getObject($data['id'], $data['type']);
    }

    /**
     * Thumbnail request using `GET /media/thumbs` endpoint
     *
     *  Usage:
     *          thumbs(123) => `GET /media/thumbs/123`
     *          thumbs(123, ['preset' => 'glide']) => `GET /media/thumbs/123&preset=glide`
     *          thumbs(null, ['ids' => '123,124,125']) => `GET /media/thumbs?ids=123,124,125`
     *          thumbs(null, ['ids' => '123,124,125', 'preset' => 'async']) => `GET /media/thumbs?ids=123,124,125&preset=async`
     *          thumbs(123, ['options' => ['w' => 100, 'h' => 80, 'fm' => 'jpg']]) => `GET /media/thumbs/123/options[w]=100&options[h]=80&options[fm]=jpg` (these options could be not available... just set in preset(s))
     *
     * @param int|null $id the media Id.
     * @param array $query The query params for thumbs call.
     * @return array|null Response in array format
     */
    public function thumbs($id = null, $query = []) : ?array
    {
        if (empty($id) && empty($query['ids'])) {
            throw new BEditaClientException('Invalid empty id|ids for thumbs');
        }
        $endpoint = '/media/thumbs';
        if (!empty($id)) {
            $endpoint .= sprintf('/%d', $id);
        }

        return $this->get($endpoint, $query);
    }

    /**
     * Get JSON SCHEMA of a resource or object
     *
     * @param string $type Object or resource type name
     * @return array|null JSON SCHEMA in array format
     */
    public function schema(string $type) : ?array
    {
        $h = ['Accept' => 'application/schema+json'];

        return $this->get(sprintf('/model/schema/%s', $type), null, $h);
    }

    /**
     *
     * Get JSON SCHEMA of a relation
     *
     * @param string $type Object or resource type name
     * @return array|null JSON SCHEMA in array format
     */
    public function relationSchema(string $type) : ?array
    {
        $h = ['Accept' => 'application/json'];
	    return $this->get(sprintf('/model/relations/%s', $type), null, $h);
	}

    /**
     * Restore object from trash
     *
     * @param int|string $id Object id
     * @param string $type Object type name
     * @return array|null Response in array format
     */
    public function restoreObject($id, string $type) : ?array
    {
        $body = [
            'data' => [
                'id' => $id,
                'type' => $type,
            ],
        ];

        return $this->patch(sprintf('/%s/%s', 'trash', $id), json_encode($body));
    }

    /**
     * Send a PATCH request to modify a single resource or object
     *
     * @param string $path Endpoint URL path to invoke
     * @param mixed $body Request body
     * @param array|null $headers Custom request headers
     * @return array|null Response in array format
     */
    public function patch(string $path, $body, ?array $headers = null) : ?array
    {
        $this->sendRequestRetry('PATCH', $path, null, $headers, $body);

        return $this->getResponseBody();
    }

    /**
     * Send a POST request for creating resources or objects or other operations like /auth
     *
     * @param string $path Endpoint URL path to invoke
     * @param mixed $body Request body
     * @param array|null $headers Custom request headers
     * @return array|null Response in array format
     */
    public function post(string $path, $body, ?array $headers = null) : ?array
    {
        $this->sendRequestRetry('POST', $path, null, $headers, $body);

        return $this->getResponseBody();
    }

    /**
     * Send a DELETE request
     *
     * @param string $path Endpoint URL path to invoke.
     * @param mixed $body Request body
     * @param array|null $headers Custom request headers
     * @return array|null Response in array format.
     */
    public function delete(string $path, $body = null, ?array $headers = null) : ?array
    {
        $this->sendRequestRetry('DELETE', $path, null, $headers, $body);

        return $this->getResponseBody();
    }

    /**
     * Send a generic JSON API request with a basic retry policy on expired token exception.
     *
     * @param string $method HTTP Method.
     * @param string $path Endpoint URL path.
     * @param array|null $query Query string parameters.
     * @param string[]|null $headers Custom request headers.
     * @param string|resource|\Psr\Http\Message\StreamInterface|null $body Request body.
     * @return \Psr\Http\Message\ResponseInterface
     */
    protected function sendRequestRetry(string $method, string $path, ?array $query = null, ?array $headers = null, $body = null) : ResponseInterface
    {
        try {
            return $this->sendRequest($method, $path, $query, $headers, $body);
        } catch (BEditaClientException $e) {
            // Handle error.
            $attributes = $e->getAttributes();
            if ($e->getCode() !== 401 || empty($attributes['code']) || $attributes['code'] !== 'be_token_expired') {
                // Not an expired token's fault.
                throw $e;
            }

            // Refresh and retry.
            $this->refreshTokens();
            unset($headers['Authorization']);

            return $this->sendRequest($method, $path, $query, $headers, $body);
        }
    }

    /**
     * Send a generic JSON API request and retrieve response $this->response
     *
     * @param string $method HTTP Method.
     * @param string $path Endpoint URL path (with or without starting `/`) or absolute API path
     * @param array|null $query Query string parameters.
     * @param string[]|null $headers Custom request headers.
     * @param string|resource|\Psr\Http\Message\StreamInterface|null $body Request body.
     * @return \Psr\Http\Message\ResponseInterface
     * @throws BEditaClientException Throws an exception if server response code is not 20x.
     */
    protected function sendRequest(string $method, string $path, ?array $query = null, ?array $headers = null, $body = null) : ResponseInterface
    {
        $uri = $this->requestUri($path, $query);
        $headers = array_merge($this->defaultHeaders, (array)$headers);

        // set default `Content-Type` if not set and $body not empty
        if (!empty($body)) {
            $headers = array_merge($this->defaultContentTypeHeader, $headers);
        }

        // Send the request synchronously to retrieve the response.
        $this->response = $this->jsonApiClient->sendRequest(new Request($method, $uri, $headers, $body));
        if ($this->getStatusCode() >= 400) {
            // Something bad just happened.
            $response = $this->getResponseBody();
            // Message will be 'error` array, if absent use status massage
            $message = empty($response['error']) ? $this->getStatusMessage() : $response['error'];
            throw new BEditaClientException($message, $this->getStatusCode());
        }

        return $this->response;
    }

    /**
     * Create request URI from path
     *
     * @param string $path Endpoint URL path (with or without starting `/`) or absolute API path
     * @param array|null $query Query string parameters.
     * @return Uri
     */
    protected function requestUri(string $path, ?array $query = null) : Uri
    {
        if (strpos($path, $this->apiBaseUrl) !== 0) {
            if (substr($path, 0, 1) !== '/') {
                $path = '/' . $path;
            }
            $path = $this->apiBaseUrl . $path;
        }
        $uri = new Uri($path);

        // if path contains query strings, remove them from path and add them to query filter
        parse_str($uri->getQuery(), $uriQuery);
        if ($query) {
            $query = array_merge((array)$uriQuery, (array)$query);
            $uri = $uri->withQuery(http_build_query($query));
        }

        return $uri;
    }

    /**
     * Refresh JWT access token.
     *
     * On success `$this->tokens` data will be updated with new access and renew tokens.
     *
     * @throws \BadMethodCallException Throws an exception if client has no renew token available.
     * @throws \Cake\Network\Exception\ServiceUnavailableException Throws an exception if server response doesn't
     *      include the expected data.
     * @return void
     * @throws BEditaClientException Throws an exception if server response code is not 20x.
     */
    public function refreshTokens() : void
    {
        if (empty($this->tokens['renew'])) {
            throw new \BadMethodCallException('You must be logged in to renew token');
        }

        $headers = [
            'Authorization' => sprintf('Bearer %s', $this->tokens['renew']),
        ];

        $this->sendRequest('POST', '/auth', [], $headers);
        $body = $this->getResponseBody();
        if (empty($body['meta']['jwt'])) {
            throw new BEditaClientException('Invalid response from server');
        }

        $this->setupTokens($body['meta']);
    }
}


1			<?php
2			/**
3			* BEdita, API-first content management framework
4			* Copyright 2018 ChannelWeb Srl, Chialab Srl
5			*
6			* Licensed under The MIT License
7			* For full copyright and license information, please see the LICENSE.txt
8			* Redistributions of files must retain the above copyright notice.
9			*/
10
11			namespace BEdita\SDK;
12
13			use GuzzleHttp\Psr7\Request;
14			use GuzzleHttp\Psr7\Uri;
15			use Http\Adapter\Guzzle6\Client;
16			use Psr\Http\Message\ResponseInterface;
17			use WoohooLabs\Yang\JsonApi\Client\JsonApiClient;
18
19			/**
20			* BEdita4 API Client class
21			*/
22			class BEditaClient
23			{
24
25			/**
26			* Last response.
27			*
28			* @var \Psr\Http\Message\ResponseInterface
29			*/
30			private $response = null;
31
32			/**
33			* BEdita4 API base URL
34			*
35			* @var string
36			*/
37			private $apiBaseUrl = null;
38
39			/**
40			* BEdita4 API KEY
41			*
42			* @var string
43			*/
44			private $apiKey = null;
45
46			/**
47			* Default headers in request
48			*
49			* @var array
50			*/
51			private $defaultHeaders = [
52			'Accept' => 'application/vnd.api+json',
53			];
54
55			/**
56			* Default headers in request
57			*
58			* @var array
59			*/
60			private $defaultContentTypeHeader = [
61			'Content-Type' => 'application/json',
62			];
63
64			/**
65			* JWT Auth tokens
66			*
67			* @var array
68			*/
69			private $tokens = [];
70
71			/**
72			* JSON API BEdita4 client
73			*
74			* @var \WoohooLabs\Yang\JsonApi\Client\JsonApiClient
75			*/
76			private $jsonApiClient = null;
77
78			/**
79			* Setup main client options:
80			* - API base URL
81			* - API KEY
82			* - Auth tokens 'jwt' and 'renew' (optional)
83			*
84			* @param string $apiUrl API base URL
85			* @param string $apiKey API key
86			* @param array $tokens JWT Autorization tokens as associative array ['jwt' => '###', 'renew' => '###']
87			* @return void
88			*/
89			public function __construct(string $apiUrl, ?string $apiKey = null, array $tokens = [])
90			{
91			$this->apiBaseUrl = $apiUrl;
92			$this->apiKey = $apiKey;
93
94			$this->defaultHeaders['X-Api-Key'] = $this->apiKey;
95			$this->setupTokens($tokens);
96
97			// setup an asynchronous JSON API client
98			$guzzleClient = Client::createWithConfig([]);
99			$this->jsonApiClient = new JsonApiClient($guzzleClient);
100			}
101
102			/**
103			* Setup JWT access and refresh tokens.
104			*
105			* @param array $tokens JWT tokens as associative array ['jwt' => '###', 'renew' => '###']
106			* @return void
107			*/
108			public function setupTokens(array $tokens) : void
109			{
110			$this->tokens = $tokens;
111			if (!empty($tokens['jwt'])) {
112			$this->defaultHeaders['Authorization'] = sprintf('Bearer %s', $tokens['jwt']);
113			} else {
114			unset($this->defaultHeaders['Authorization']);
115			}
116			}
117
118			/**
119			* Get default headers in use on every request
120			*
121			* @return array Default headers
122			* @codeCoverageIgnore
123			*/
124			public function getDefaultHeaders() : array
125			{
126			return $this->defaultHeaders;
127			}
128
129			/**
130			* Get API base URL used tokens
131			*
132			* @return string API base URL
133			* @codeCoverageIgnore
134			*/
135			public function getApiBaseUrl() : string
136			{
137			return $this->apiBaseUrl;
138			}
139
140			/**
141			* Get current used tokens
142			*
143			* @return array Current tokens
144			* @codeCoverageIgnore
145			*/
146			public function getTokens() : array
147			{
148			return $this->tokens;
149			}
150
151			/**
152			* Get last HTTP response
153			*
154			* @return ResponseInterface\|null Response PSR interface
155			* @codeCoverageIgnore
156			*/
157			public function getResponse() : ?ResponseInterface
158			{
159			return $this->response;
160			}
161
162			/**
163			* Get HTTP response status code
164			* Return null if no response is available
165			*
166			* @return int\|null Status code.
167			*/
168			public function getStatusCode() : ?int
169			{
170			return $this->response ? $this->response->getStatusCode() : null;
171			}
172
173			/**
174			* Get HTTP response status message
175			* Return null if no response is available
176			*
177			* @return string\|null Message related to status code.
178			*/
179			public function getStatusMessage() : ?string
180			{
181			return $this->response ? $this->response->getReasonPhrase() : null;
182			}
183
184			/**
185			* Get response body serialized into a PHP array
186			*
187			* @return array\|null Response body as PHP array.
188			*/
189			public function getResponseBody() : ?array
190			{
191			$response = $this->getResponse();
192			if (empty($response)) {
193			return null;
194			}
195			$responseBody = json_decode((string)$response->getBody(), true);
196			if (!is_array($responseBody)) {
197			return null;
198			}
199
200			return $responseBody;
201			}
202
203			/**
204			* Classic authentication via POST /auth using username and password
205			*
206			* @param string $username username
207			* @param string $password password
208			* @return array\|null Response in array format
209			*/
210			public function authenticate(string $username, string $password) : ?array
211			{
212			$body = json_encode(compact('username', 'password'));
213
214			return $this->post('/auth', $body, ['Content-Type' => 'application/json']);
215			}
216
217			/**
218			* Send a GET request a list of resources or objects or a single resource or object
219			*
220			* @param string $path Endpoint URL path to invoke
221			* @param array\|null $query Optional query string
222			* @param array\|null $headers Headers
223			* @return array\|null Response in array format
224			*/
225			public function get(string $path, ?array $query = null, ?array $headers = null) : ?array
226			{
227			$this->sendRequestRetry('GET', $path, $query, $headers);
228
229			return $this->getResponseBody();
230			}
231
232			/**
233			* GET a list of resources or objects of a given type
234			*
235			* @param string $type Object type name
236			* @param array\|null $query Optional query string
237			* @param array\|null $headers Custom request headers
238			* @return array\|null Response in array format
239			*/
240			public function getObjects(string $type = 'objects', ?array $query = null, ?array $headers = null) : ?array
241			{
242			return $this->get(sprintf('/%s', $type), $query, $headers);
243			}
244
245			/**
246			* GET a single object of a given type
247			*
248			* @param int\|string $id Object id
249			* @param string $type Object type name
250			* @param array\|null $query Optional query string
251			* @param array\|null $headers Custom request headers
252			* @return array\|null Response in array format
253			*/
254			public function getObject($id, string $type = 'objects', ?array $query = null, ?array $headers = null) : ?array
255			{
256			return $this->get(sprintf('/%s/%s', $type, $id), $query, $headers);
257			}
258
259			/**
260			* Get a list of related resources or objects
261			*
262			* @param int\|string $id Resource id or object uname/id
263			* @param string $type Type name
264			* @param string $relation Relation name
265			* @param array\|null $query Optional query string
266			* @param array\|null $headers Custom request headers
267			* @return array\|null Response in array format
268			*/
269			public function getRelated($id, string $type, string $relation, ?array $query = null, ?array $headers = null) : ?array
270			{
271			return $this->get(sprintf('/%s/%s/%s', $type, $id, $relation), $query, $headers);
272			}
273
274			/**
275			* Add a list of related resources or objects
276			*
277			* @param int\|string $id Resource id or object uname/id
278			* @param string $type Type name
279			* @param string $relation Relation name
280			* @param string $data Related resources or objects to add, MUST contain id and type
281			* @param array\|null $headers Custom request headers
282			* @return array\|null Response in array format
283			*/
284			public function addRelated($id, string $type, string $relation, array $data, ?array $headers = null) : ?array
285			{
286			$body = compact('data');
287
288			return $this->post(sprintf('/%s/%s/relationships/%s', $type, $id, $relation), json_encode($body), $headers);
289			}
290
291			/**
292			* Remove a list of related resources or objects
293			*
294			* @param int\|string $id Resource id or object uname/id
295			* @param string $type Type name
296			* @param string $relation Relation name
297			* @param string $data Related resources or objects to remove from relation
298			* @param array\|null $headers Custom request headers
299			* @return array\|null Response in array format
300			*/
301			public function removeRelated($id, string $type, string $relation, array $data, ?array $headers = null) : ?array
302			{
303			$body = compact('data');
304
305			return $this->delete(sprintf('/%s/%s/relationships/%s', $type, $id, $relation), json_encode($body), $headers);
306			}
307
308			/**
309			* Replace a list of related resources or objects: previuosly related are removed and replaced with these.
310			*
311			* @param int\|string $id Object id
312			* @param string $type Object type name
313			* @param string $relation Relation name
314			* @param string $data Related resources or objects to insert
315			* @param array\|null $headers Custom request headers
316			* @return array\|null Response in array format
317			*/
318			public function replaceRelated($id, string $type, string $relation, array $data, ?array $headers = null) : ?array
319			{
320			$body = compact('data');
321
322			return $this->patch(sprintf('/%s/%s/relationships/%s', $type, $id, $relation), json_encode($body), $headers);
323			}
324
325			/**
326			* Create a new object (POST) or modify an existing one (PATCH)
327			*
328			* @param string $type Object type name
329			* @param array $data Object data to save
330			* @param array\|null $headers Custom request headers
331			* @return array\|null Response in array format
332			*/
333			public function saveObject(string $type, array $data, ?array $headers = null) : ?array
334			{
335			$id = null;
336			if (array_key_exists('id', $data)) {
337			$id = $data['id'];
338			unset($data['id']);
339			}
340
341			$body = [
342			'data' => [
343			'type' => $type,
344			'attributes' => $data,
345			],
346			];
347			if (!$id) {
348			return $this->post(sprintf('/%s', $type), json_encode($body), $headers);
349			}
350			$body['data']['id'] = $id;
351
352			return $this->patch(sprintf('/%s/%s', $type, $id), json_encode($body), $headers);
353			}
354
355			/**
356			* Delete an object (DELETE) => move to trashcan.
357			*
358			* @param int\|string $id Object id
359			* @param string $type Object type name
360			* @return array\|null Response in array format
361			*/
362			public function deleteObject($id, string $type) : ?array
363			{
364			return $this->delete(sprintf('/%s/%s', $type, $id));
365			}
366
367			/**
368			* Remove an object => permanently remove object from trashcan.
369			*
370			* @param int\|string $id Object id
371			* @return array\|null Response in array format
372			*/
373			public function remove($id) : ?array
374			{
375			return $this->delete(sprintf('/trash/%s', $id));
376			}
377
378			/**
379			* Upload file (POST)
380			*
381			* @param string $filename The file name
382			* @param string $filepath File full path: could be on a local filesystem or a remote reachable URL
383			* @param array\|null $headers Custom request headers
384			* @return array\|null Response in array format
385			* @throws BEditaClientException
386			*/
387			public function upload(string $filename, string $filepath, ?array $headers = null) : ?array
388			{
389			if (!file_exists($filepath)) {
390			throw new BEditaClientException('File not found', 500);
391			}
392			$file = file_get_contents($filepath);
393			if (!$file) {
394			throw new BEditaClientException('File get contents failed', 500);
395			}
396			if (empty($headers['Content-Type'])) {
397			$headers['Content-Type'] = mime_content_type($filepath);
398			}
399
400			return $this->post(sprintf('/streams/upload/%s', $filename), $file, $headers);
401			}
402
403			/**
404			* Create media by type and body data and link it to a stream:
405			* - `POST /:type` with `$body` as payload, create media object
406			* - `PATCH /streams/:stream_id/relationships/object` modify stream adding relation to media
407			* - `GET /:type/:id` get media data
408			*
409			* @param string $streamId The stream identifier
410			* @param string $type The type
411			* @param array $body The body data
412			* @return array\|null Response in array format
413			* @throws BEditaClientException
414			*/
415			public function createMediaFromStream($streamId, string $type, array $body) : ?array
416			{
417			$response = $this->post(sprintf('/%s', $type), json_encode($body));
418			if (empty($response)) {
419			throw new BEditaClientException('Invalid response from POST ' . sprintf('/%s', $type));
420			}
421			$id = $response['data']['id'];
422			$data = compact('id', 'type');
423			$body = compact('data');
424			$response = $this->patch(sprintf('/streams/%s/relationships/object', $streamId), json_encode($body));
425			if (empty($response)) {
426			throw new BEditaClientException('Invalid response from PATCH ' . sprintf('/streams/%s/relationships/object', $id));
427			}
428
429			return $this->getObject($data['id'], $data['type']);
430			}
431
432			/**
433			* Thumbnail request using `GET /media/thumbs` endpoint
434			*
435			* Usage:
436			* thumbs(123) => `GET /media/thumbs/123`
437			* thumbs(123, ['preset' => 'glide']) => `GET /media/thumbs/123&preset=glide`
438			* thumbs(null, ['ids' => '123,124,125']) => `GET /media/thumbs?ids=123,124,125`
439			* thumbs(null, ['ids' => '123,124,125', 'preset' => 'async']) => `GET /media/thumbs?ids=123,124,125&preset=async`
440			* thumbs(123, ['options' => ['w' => 100, 'h' => 80, 'fm' => 'jpg']]) => `GET /media/thumbs/123/options[w]=100&options[h]=80&options[fm]=jpg` (these options could be not available... just set in preset(s))
441			*
442			* @param int\|null $id the media Id.
443			* @param array $query The query params for thumbs call.
444			* @return array\|null Response in array format
445			*/
446			public function thumbs($id = null, $query = []) : ?array
447			{
448			if (empty($id) && empty($query['ids'])) {
449			throw new BEditaClientException('Invalid empty id\|ids for thumbs');
450			}
451			$endpoint = '/media/thumbs';
452			if (!empty($id)) {
453			$endpoint .= sprintf('/%d', $id);
454			}
455
456			return $this->get($endpoint, $query);
457			}
458
459			/**
460			* Get JSON SCHEMA of a resource or object
461			*
462			* @param string $type Object or resource type name
463			* @return array\|null JSON SCHEMA in array format
464			*/
465			public function schema(string $type) : ?array
466			{
467			$h = ['Accept' => 'application/schema+json'];
468
469			return $this->get(sprintf('/model/schema/%s', $type), null, $h);
470			}
471
472			/**
473			*
474			* Get JSON SCHEMA of a relation
475			*
476			* @param string $type Object or resource type name
477			* @return array\|null JSON SCHEMA in array format
478			*/
479			public function relationSchema(string $type) : ?array
480			{
481			$h = ['Accept' => 'application/json'];
482			return $this->get(sprintf('/model/relations/%s', $type), null, $h);
483			}
484
485			/**
486			* Restore object from trash
487			*
488			* @param int\|string $id Object id
489			* @param string $type Object type name
490			* @return array\|null Response in array format
491			*/
492			public function restoreObject($id, string $type) : ?array
493			{
494			$body = [
495			'data' => [
496			'id' => $id,
497			'type' => $type,
498			],
499			];
500
501			return $this->patch(sprintf('/%s/%s', 'trash', $id), json_encode($body));
502			}
503
504			/**
505			* Send a PATCH request to modify a single resource or object
506			*
507			* @param string $path Endpoint URL path to invoke
508			* @param mixed $body Request body
509			* @param array\|null $headers Custom request headers
510			* @return array\|null Response in array format
511			*/
512			public function patch(string $path, $body, ?array $headers = null) : ?array
513			{
514			$this->sendRequestRetry('PATCH', $path, null, $headers, $body);
515
516			return $this->getResponseBody();
517			}
518
519			/**
520			* Send a POST request for creating resources or objects or other operations like /auth
521			*
522			* @param string $path Endpoint URL path to invoke
523			* @param mixed $body Request body
524			* @param array\|null $headers Custom request headers
525			* @return array\|null Response in array format
526			*/
527			public function post(string $path, $body, ?array $headers = null) : ?array
528			{
529			$this->sendRequestRetry('POST', $path, null, $headers, $body);
530
531			return $this->getResponseBody();
532			}
533
534			/**
535			* Send a DELETE request
536			*
537			* @param string $path Endpoint URL path to invoke.
538			* @param mixed $body Request body
539			* @param array\|null $headers Custom request headers
540			* @return array\|null Response in array format.
541			*/
542			public function delete(string $path, $body = null, ?array $headers = null) : ?array
543			{
544			$this->sendRequestRetry('DELETE', $path, null, $headers, $body);
545
546			return $this->getResponseBody();
547			}
548
549			/**
550			* Send a generic JSON API request with a basic retry policy on expired token exception.
551			*
552			* @param string $method HTTP Method.
553			* @param string $path Endpoint URL path.
554			* @param array\|null $query Query string parameters.
555			* @param string[]\|null $headers Custom request headers.
556			* @param string\|resource\|\Psr\Http\Message\StreamInterface\|null $body Request body.
557			* @return \Psr\Http\Message\ResponseInterface
558			*/
559			protected function sendRequestRetry(string $method, string $path, ?array $query = null, ?array $headers = null, $body = null) : ResponseInterface
560			{
561			try {
562			return $this->sendRequest($method, $path, $query, $headers, $body);
563			} catch (BEditaClientException $e) {
564			// Handle error.
565			$attributes = $e->getAttributes();
566			if ($e->getCode() !== 401 \|\| empty($attributes['code']) \|\| $attributes['code'] !== 'be_token_expired') {
567			// Not an expired token's fault.
568			throw $e;
569			}
570
571			// Refresh and retry.
572			$this->refreshTokens();
573			unset($headers['Authorization']);
574
575			return $this->sendRequest($method, $path, $query, $headers, $body);
576			}
577			}
578
579			/**
580			* Send a generic JSON API request and retrieve response $this->response
581			*
582			* @param string $method HTTP Method.
583			* @param string $path Endpoint URL path (with or without starting `/`) or absolute API path
584			* @param array\|null $query Query string parameters.
585			* @param string[]\|null $headers Custom request headers.
586			* @param string\|resource\|\Psr\Http\Message\StreamInterface\|null $body Request body.
587			* @return \Psr\Http\Message\ResponseInterface
588			* @throws BEditaClientException Throws an exception if server response code is not 20x.
589			*/
590			protected function sendRequest(string $method, string $path, ?array $query = null, ?array $headers = null, $body = null) : ResponseInterface
591			{
592			$uri = $this->requestUri($path, $query);
593			$headers = array_merge($this->defaultHeaders, (array)$headers);
594
595			// set default `Content-Type` if not set and $body not empty
596			if (!empty($body)) {
597			$headers = array_merge($this->defaultContentTypeHeader, $headers);
598			}
599
600			// Send the request synchronously to retrieve the response.
601			$this->response = $this->jsonApiClient->sendRequest(new Request($method, $uri, $headers, $body));
602			if ($this->getStatusCode() >= 400) {
603			// Something bad just happened.
604			$response = $this->getResponseBody();
605			// Message will be 'error` array, if absent use status massage
606			$message = empty($response['error']) ? $this->getStatusMessage() : $response['error'];
607			throw new BEditaClientException($message, $this->getStatusCode());
608			}
609
610			return $this->response;
611			}
612
613			/**
614			* Create request URI from path
615			*
616			* @param string $path Endpoint URL path (with or without starting `/`) or absolute API path
617			* @param array\|null $query Query string parameters.
618			* @return Uri
619			*/
620			protected function requestUri(string $path, ?array $query = null) : Uri
621			{
622			if (strpos($path, $this->apiBaseUrl) !== 0) {
623			if (substr($path, 0, 1) !== '/') {
624			$path = '/' . $path;
625			}
626			$path = $this->apiBaseUrl . $path;
627			}
628			$uri = new Uri($path);
629
630			// if path contains query strings, remove them from path and add them to query filter
631			parse_str($uri->getQuery(), $uriQuery);
632			if ($query) {
633			$query = array_merge((array)$uriQuery, (array)$query);
634			$uri = $uri->withQuery(http_build_query($query));
635			}
636
637			return $uri;
638			}
639
640			/**
641			* Refresh JWT access token.
642			*
643			* On success `$this->tokens` data will be updated with new access and renew tokens.
644			*
645			* @throws \BadMethodCallException Throws an exception if client has no renew token available.
646			* @throws \Cake\Network\Exception\ServiceUnavailableException Throws an exception if server response doesn't
647			* include the expected data.
648			* @return void
649			* @throws BEditaClientException Throws an exception if server response code is not 20x.
650			*/
651			public function refreshTokens() : void
652			{
653			if (empty($this->tokens['renew'])) {
654			throw new \BadMethodCallException('You must be logged in to renew token');
655			}
656
657			$headers = [
658			'Authorization' => sprintf('Bearer %s', $this->tokens['renew']),
659			];
660
661			$this->sendRequest('POST', '/auth', [], $headers);
662			$body = $this->getResponseBody();
663			if (empty($body['meta']['jwt'])) {
664			throw new BEditaClientException('Invalid response from server');
665			}
666
667			$this->setupTokens($body['meta']);
668			}
669			}
670

bedita / php-sdk

Pull Request — master (#16)

BEditaClient::relationSchema() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like