DropboxClient::buildAuthHeader() - Code Metrics - Inspection of "Add some tests" - kunalvarma05/dropbox-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#97)

unknown

created 2017-12-11 18:20 UTC

DropboxClient::buildAuthHeader() A

↳ Parent: DropboxClient

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php
namespace Kunnu\Dropbox;

use Kunnu\Dropbox\Http\Clients\DropboxHttpClientInterface;

/**
 * DropboxClient
 */
class DropboxClient
{
    /**
     * Dropbox API Root URL.
     *
     * @const string
     */
    const BASE_PATH = 'https://api.dropboxapi.com/2';

    /**
     * Dropbox API Content Root URL.
     *
     * @const string
     */
    const CONTENT_PATH = 'https://content.dropboxapi.com/2';

    /**
     * DropboxHttpClientInterface Implementation
     *
     * @var \Kunnu\Dropbox\Http\Clients\DropboxHttpClientInterface
     */
    protected $httpClient;

    /**
     * Create a new DropboxClient instance
     *
     * @param DropboxHttpClientInterface $httpClient
     */
    public function __construct(DropboxHttpClientInterface $httpClient)
    {
        //Set the HTTP Client
        $this->setHttpClient($httpClient);
    }

    /**
     * Get the HTTP Client
     *
     * @return \Kunnu\Dropbox\Http\Clients\DropboxHttpClientInterface $httpClient
     */
    public function getHttpClient()
    {
        return $this->httpClient;
    }

    /**
     * Set the HTTP Client
     *
     * @param \Kunnu\Dropbox\Http\Clients\DropboxHttpClientInterface $httpClient
     *
     * @return \Kunnu\Dropbox\DropboxClient
     */
    public function setHttpClient(DropboxHttpClientInterface $httpClient)
    {
        $this->httpClient = $httpClient;

        return $this;
    }

    /**
     * Get the API Base Path.
     *
     * @return string API Base Path
     */
    public function getBasePath()
    {
        return static::BASE_PATH;
    }

    /**
     * Get the API Content Path.
     *
     * @return string API Content Path
     */
    public function getContentPath()
    {
        return static::CONTENT_PATH;
    }

    /**
     * Get the Authorization Header with the Access Token.
     *
     * @param string $accessToken Access Token
     *
     * @return array Authorization Header
     */
    protected function buildAuthHeader($accessToken = "")
    {
        return ['Authorization' => 'Bearer '. $accessToken];
    }

    /**
     * Get the Content Type Header.
     *
     * @param string $contentType Request Content Type
     *
     * @return array Content Type Header
     */
    protected function buildContentTypeHeader($contentType = "")
    {
        return ['Content-Type' => $contentType];
    }

    /**
     * Build URL for the Request
     *
     * @param string $endpoint Relative API endpoint
     * @param string $type Endpoint Type
     *
     * @link https://www.dropbox.com/developers/documentation/http/documentation#formats Request and response formats
     *
     * @return string The Full URL to the API Endpoints
     */
    protected function buildUrl($endpoint = '', $type = 'api')
    {
        //Get the base path
        $base = $this->getBasePath();

        //If the endpoint type is 'content'
        if ($type === 'content') {
            //Get the Content Path
            $base = $this->getContentPath();
        }

        //Join and return the base and api path/endpoint
        return $base . $endpoint;
    }

    /**
     * Send the Request to the Server and return the Response
     *
     * @param  DropboxRequest $request
     * @param  DropboxResponse $response
     *
     * @return \Kunnu\Dropbox\DropboxResponse
     *
     * @throws \Kunnu\Dropbox\Exceptions\DropboxClientException
     */
    public function sendRequest(DropboxRequest $request, DropboxResponse $response = null)
    {
        //Method
        $method = $request->getMethod();

        //Prepare Request
        list($url, $headers, $requestBody) = $this->prepareRequest($request);

        $options = [];
        if ($response instanceof DropboxResponseToFile) {
            $options['sink'] = $response->getFilePath();
        }

        //Send the Request to the Server through the HTTP Client
        //and fetch the raw response as DropboxRawResponse
        $rawResponse = $this->getHttpClient()->send($url, $method, $requestBody, $headers, $options);

        //Create DropboxResponse from DropboxRawResponse
        $response = $response ?: new DropboxResponse($request);
        $response->setHttpStatusCode($rawResponse->getHttpResponseCode());
        $response->setHeaders($rawResponse->getHeaders());
        if (!$response instanceof DropboxResponseToFile) {
            $response->setBody($rawResponse->getBody());
        }

        //Return the DropboxResponse
        return $response;
    }

    /**
     * Prepare a Request before being sent to the HTTP Client
     *
     * @param  \Kunnu\Dropbox\DropboxRequest $request
     *
     * @return array [Request URL, Request Headers, Request Body]
     */
    protected function prepareRequest(DropboxRequest $request)
    {
        //Build URL
        $url = $this->buildUrl($request->getEndpoint(), $request->getEndpointType());

        //The Endpoint is content
        if ($request->getEndpointType() === 'content') {
            //Dropbox requires the parameters to be passed
            //through the 'Dropbox-API-Arg' header
            $request->setHeaders(['Dropbox-API-Arg' => json_encode($request->getParams())]);

            //If a File is also being uploaded
            if ($request->hasFile()) {
                //Content Type
                $request->setContentType("application/octet-stream");

                //Request Body (File Contents)
                $requestBody = $request->getStreamBody()->getBody();
            } else {
                //Empty Body
                $requestBody = null;
            }
        } else {
            //The endpoint is 'api'
            //Request Body (Parameters)
            $requestBody = $request->getJsonBody()->getBody();
        }

        //Empty body
        if (is_null($requestBody)) {
            //Content Type needs to be kept empty
            $request->setContentType("");
        }

        //Build headers
        $headers = array_merge(
            $this->buildAuthHeader($request->getAccessToken()),
            $this->buildContentTypeHeader($request->getContentType()),
            $request->getHeaders()
            );

        //Return the URL, Headers and Request Body
        return [$url, $headers, $requestBody];
    }
}


1		<?php
2		namespace Kunnu\Dropbox;
3
4		use Kunnu\Dropbox\Http\Clients\DropboxHttpClientInterface;
5
6		/**
7		* DropboxClient
8		*/
9		class DropboxClient
10		{
11		/**
12		* Dropbox API Root URL.
13		*
14		* @const string
15		*/
16		const BASE_PATH = 'https://api.dropboxapi.com/2';
17
18		/**
19		* Dropbox API Content Root URL.
20		*
21		* @const string
22		*/
23		const CONTENT_PATH = 'https://content.dropboxapi.com/2';
24
25		/**
26		* DropboxHttpClientInterface Implementation
27		*
28		* @var \Kunnu\Dropbox\Http\Clients\DropboxHttpClientInterface
29		*/
30		protected $httpClient;
31
32		/**
33		* Create a new DropboxClient instance
34		*
35		* @param DropboxHttpClientInterface $httpClient
36		*/
37	58	public function __construct(DropboxHttpClientInterface $httpClient)
38		{
39		//Set the HTTP Client
40	58	$this->setHttpClient($httpClient);
41	58	}
42
43		/**
44		* Get the HTTP Client
45		*
46		* @return \Kunnu\Dropbox\Http\Clients\DropboxHttpClientInterface $httpClient
47		*/
48	49	public function getHttpClient()
49		{
50	49	return $this->httpClient;
51		}
52
53		/**
54		* Set the HTTP Client
55		*
56		* @param \Kunnu\Dropbox\Http\Clients\DropboxHttpClientInterface $httpClient
57		*
58		* @return \Kunnu\Dropbox\DropboxClient
59		*/
60	58	public function setHttpClient(DropboxHttpClientInterface $httpClient)
61		{
62	58	$this->httpClient = $httpClient;
63
64	58	return $this;
65		}
66
67		/**
68		* Get the API Base Path.
69		*
70		* @return string API Base Path
71		*/
72	49	public function getBasePath()
73		{
74	49	return static::BASE_PATH;
75		}
76
77		/**
78		* Get the API Content Path.
79		*
80		* @return string API Content Path
81		*/
82	10	public function getContentPath()
83		{
84	10	return static::CONTENT_PATH;
85		}
86
87		/**
88		* Get the Authorization Header with the Access Token.
89		*
90		* @param string $accessToken Access Token
91		*
92		* @return array Authorization Header
93		*/
94	49	protected function buildAuthHeader($accessToken = "")
95		{
96	49	return ['Authorization' => 'Bearer '. $accessToken];
97		}
98
99		/**
100		* Get the Content Type Header.
101		*
102		* @param string $contentType Request Content Type
103		*
104		* @return array Content Type Header
105		*/
106	49	protected function buildContentTypeHeader($contentType = "")
107		{
108	49	return ['Content-Type' => $contentType];
109		}
110
111		/**
112		* Build URL for the Request
113		*
114		* @param string $endpoint Relative API endpoint
115		* @param string $type Endpoint Type
116		*
117		* @link https://www.dropbox.com/developers/documentation/http/documentation#formats Request and response formats
118		*
119		* @return string The Full URL to the API Endpoints
120		*/
121	49	protected function buildUrl($endpoint = '', $type = 'api')
122		{
123		//Get the base path
124	49	$base = $this->getBasePath();
125
126		//If the endpoint type is 'content'
127	49	if ($type === 'content') {
128		//Get the Content Path
129	10	$base = $this->getContentPath();
130		}
131
132		//Join and return the base and api path/endpoint
133	49	return $base . $endpoint;
134		}
135
136		/**
137		* Send the Request to the Server and return the Response
138		*
139		* @param DropboxRequest $request
140		* @param DropboxResponse $response
141		*
142		* @return \Kunnu\Dropbox\DropboxResponse
143		*
144		* @throws \Kunnu\Dropbox\Exceptions\DropboxClientException
145		*/
146	49	public function sendRequest(DropboxRequest $request, DropboxResponse $response = null)
147		{
148		//Method
149	49	$method = $request->getMethod();
150
151		//Prepare Request
152	49	list($url, $headers, $requestBody) = $this->prepareRequest($request);
153
154	49	$options = [];
155	49	if ($response instanceof DropboxResponseToFile) {
156	1	$options['sink'] = $response->getFilePath();
157		}
158
159		//Send the Request to the Server through the HTTP Client
160		//and fetch the raw response as DropboxRawResponse
161	49	$rawResponse = $this->getHttpClient()->send($url, $method, $requestBody, $headers, $options);
162
163		//Create DropboxResponse from DropboxRawResponse
164	48	$response = $response ?: new DropboxResponse($request);
165	48	$response->setHttpStatusCode($rawResponse->getHttpResponseCode());
166	48	$response->setHeaders($rawResponse->getHeaders());
167	48	if (!$response instanceof DropboxResponseToFile) {
168	47	$response->setBody($rawResponse->getBody());
169		}
170
171		//Return the DropboxResponse
172	48	return $response;
173		}
174
175		/**
176		* Prepare a Request before being sent to the HTTP Client
177		*
178		* @param \Kunnu\Dropbox\DropboxRequest $request
179		*
180		* @return array [Request URL, Request Headers, Request Body]
181		*/
182	49	protected function prepareRequest(DropboxRequest $request)
183		{
184		//Build URL
185	49	$url = $this->buildUrl($request->getEndpoint(), $request->getEndpointType());
186
187		//The Endpoint is content
188	49	if ($request->getEndpointType() === 'content') {
189		//Dropbox requires the parameters to be passed
190		//through the 'Dropbox-API-Arg' header
191	10	$request->setHeaders(['Dropbox-API-Arg' => json_encode($request->getParams())]);
192
193		//If a File is also being uploaded
194	10	if ($request->hasFile()) {
195		//Content Type
196	7	$request->setContentType("application/octet-stream");
197
198		//Request Body (File Contents)
199	7	$requestBody = $request->getStreamBody()->getBody();
200		} else {
201		//Empty Body
202	10	$requestBody = null;
203		}
204		} else {
205		//The endpoint is 'api'
206		//Request Body (Parameters)
207	39	$requestBody = $request->getJsonBody()->getBody();
208		}
209
210		//Empty body
211	49	if (is_null($requestBody)) {
212		//Content Type needs to be kept empty
213	5	$request->setContentType("");
214		}
215
216		//Build headers
217	49	$headers = array_merge(
218	49	$this->buildAuthHeader($request->getAccessToken()),
219	49	$this->buildContentTypeHeader($request->getContentType()),
220	49	$request->getHeaders()
221		);
222
223		//Return the URL, Headers and Request Body
224	49	return [$url, $headers, $requestBody];
225		}
226		}
227

kunalvarma05 / dropbox-php-sdk

Pull Request — master (#97)

DropboxClient::buildAuthHeader() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like