Client::getBaseGraphUrl() - Code Metrics - Inspection of "Adding `postJson` to support endpoints that expect..." - facebook/php-graph-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#957)

unknown

created 2018-03-13 05:44 UTC

Client::getBaseGraphUrl() A

↳ Parent: Client

Complexity

Conditions	4
Paths	4

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
eloc	3
nc	4
nop	1
dl	0
loc	7
ccs	4
cts	4
cp	1
crap	4
rs	9.2
c	0
b	0
f	0

<?php
/**
 * Copyright 2017 Facebook, Inc.
 *
 * You are hereby granted a non-exclusive, worldwide, royalty-free license to
 * use, copy, modify, and distribute this software in source code or binary
 * form for use in connection with the web services and APIs provided by
 * Facebook.
 *
 * As with any software that integrates with the Facebook platform, your use
 * of this software is subject to the Facebook Developer Principles and
 * Policies [http://developers.facebook.com/policy/]. This copyright notice
 * shall be included in all copies or substantial portions of the software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */
namespace Facebook;

use Facebook\Exception\SDKException;
use Http\Client\HttpClient;
use Http\Discovery\HttpClientDiscovery;
use Http\Discovery\MessageFactoryDiscovery;

/**
 * @package Facebook
 */
class Client
{
    /**
     * @const string Production Graph API URL.
     */
    const BASE_GRAPH_URL = 'https://graph.facebook.com';

    /**
     * @const string Graph API URL for video uploads.
     */
    const BASE_GRAPH_VIDEO_URL = 'https://graph-video.facebook.com';

    /**
     * @const string Beta Graph API URL.
     */
    const BASE_GRAPH_URL_BETA = 'https://graph.beta.facebook.com';

    /**
     * @const string Beta Graph API URL for video uploads.
     */
    const BASE_GRAPH_VIDEO_URL_BETA = 'https://graph-video.beta.facebook.com';

    /**
     * @const int The timeout in seconds for a normal request.
     */
    const DEFAULT_REQUEST_TIMEOUT = 60;

    /**
     * @const int The timeout in seconds for a request that contains file uploads.
     */
    const DEFAULT_FILE_UPLOAD_REQUEST_TIMEOUT = 3600;

    /**
     * @const int The timeout in seconds for a request that contains video uploads.
     */
    const DEFAULT_VIDEO_UPLOAD_REQUEST_TIMEOUT = 7200;

    /**
     * @var bool toggle to use Graph beta url
     */
    protected $enableBetaMode = false;

    /**
     * @var httpClient HTTP client handler
     */
    protected $httpClient;

    /**
     * @var int the number of calls that have been made to Graph
     */
    public static $requestCount = 0;

    /**
     * Instantiates a new Client object.
     *
     * @param null|HttpClient $httpClient
     * @param bool            $enableBeta
     */
    public function __construct(HttpClient $httpClient = null, $enableBeta = false)
    {
        $this->httpClient = $httpClient ?: HttpClientDiscovery::find();
        $this->enableBetaMode = $enableBeta;
    }

    /**
     * Sets the HTTP client handler.
     *
     * @param HttpClient $httpClient
     */
    public function setHttpClient(HttpClient $httpClient)
    {
        $this->httpClient = $httpClient;
    }

    /**
     * Returns the HTTP client handler.
     *
     * @return HttpClient
     */
    public function getHttpClient()
    {
        return $this->httpClient;
    }

    /**
     * Toggle beta mode.
     *
     * @param bool $betaMode
     */
    public function enableBetaMode($betaMode = true)
    {
        $this->enableBetaMode = $betaMode;
    }

    /**
     * Returns the base Graph URL.
     *
     * @param bool $postToVideoUrl post to the video API if videos are being uploaded
     *
     * @return string
     */
    public function getBaseGraphUrl($postToVideoUrl = false)
    {
        if ($postToVideoUrl) {
            return $this->enableBetaMode ? static::BASE_GRAPH_VIDEO_URL_BETA : static::BASE_GRAPH_VIDEO_URL;
        }

        return $this->enableBetaMode ? static::BASE_GRAPH_URL_BETA : static::BASE_GRAPH_URL;
    }

    /**
     * Prepares the request for sending to the client handler.
     *
     * @param Request $request
     *
     * @return array
     */
    public function prepareRequestMessage(Request $request)
    {
        $postToVideoUrl = $request->containsVideoUploads();
        $url = $this->getBaseGraphUrl($postToVideoUrl) . $request->getUrl();

        // If we're sending files they should be sent as multipart/form-data
        if ($request->containsFileUploads()) {
            $requestBody = $request->getMultipartBody();
            $request->setHeaders([
                'Content-Type' => 'multipart/form-data; boundary=' . $requestBody->getBoundary(),
            ]);
        } else {
            if($request->isJson()) {
                $requestBody = $request->getJsonEncodedBody();
                $request->setHeaders([
                    'Content-Type' => 'application/json',
                ]);
            }else{
                $requestBody = $request->getUrlEncodedBody();
                $request->setHeaders([
                    'Content-Type' => 'application/x-www-form-urlencoded',
                ]);
            }
        }

        return [
            $url,
            $request->getMethod(),
            $request->getHeaders(),
            $requestBody->getBody(),
        ];
    }

    /**
     * Makes the request to Graph and returns the result.
     *
     * @param Request $request
     *
     * @throws SDKException
     *
     * @return Response
     */
    public function sendRequest(Request $request)
    {
        if (get_class($request) === 'Facebook\Request') {
            $request->validateAccessToken();
        }

        list($url, $method, $headers, $body) = $this->prepareRequestMessage($request);

        $psr7Response = $this->httpClient->sendRequest(
            MessageFactoryDiscovery::find()->createRequest($method, $url, $headers, $body)
        );

        static::$requestCount++;

        // Prepare headers from associative array to a single string for each header.
        $responseHeaders = [];
        foreach ($psr7Response->getHeaders() as $name => $values) {
            $responseHeaders[] = sprintf('%s: %s', $name, implode(", ", $values));
        }

        $Response = new Response(
            $request,
            $psr7Response->getBody(),
            $psr7Response->getStatusCode(),
            $responseHeaders
        );

        if ($Response->isError()) {
            throw $Response->getThrownException();
        }

        return $Response;
    }

    /**
     * Makes a batched request to Graph and returns the result.
     *
     * @param BatchRequest $request
     *
     * @throws SDKException
     *
     * @return BatchResponse
     */
    public function sendBatchRequest(BatchRequest $request)
    {
        $request->prepareRequestsForBatch();
        $Response = $this->sendRequest($request);

        return new BatchResponse($request, $Response);
    }
}


1		<?php
2		/**
3		* Copyright 2017 Facebook, Inc.
4		*
5		* You are hereby granted a non-exclusive, worldwide, royalty-free license to
6		* use, copy, modify, and distribute this software in source code or binary
7		* form for use in connection with the web services and APIs provided by
8		* Facebook.
9		*
10		* As with any software that integrates with the Facebook platform, your use
11		* of this software is subject to the Facebook Developer Principles and
12		* Policies [http://developers.facebook.com/policy/]. This copyright notice
13		* shall be included in all copies or substantial portions of the software.
14		*
15		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17		* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18		* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20		* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21		* DEALINGS IN THE SOFTWARE.
22		*/
23		namespace Facebook;
24
25		use Facebook\Exception\SDKException;
26		use Http\Client\HttpClient;
27		use Http\Discovery\HttpClientDiscovery;
28		use Http\Discovery\MessageFactoryDiscovery;
29
30		/**
31		* @package Facebook
32		*/
33		class Client
34		{
35		/**
36		* @const string Production Graph API URL.
37		*/
38		const BASE_GRAPH_URL = 'https://graph.facebook.com';
39
40		/**
41		* @const string Graph API URL for video uploads.
42		*/
43		const BASE_GRAPH_VIDEO_URL = 'https://graph-video.facebook.com';
44
45		/**
46		* @const string Beta Graph API URL.
47		*/
48		const BASE_GRAPH_URL_BETA = 'https://graph.beta.facebook.com';
49
50		/**
51		* @const string Beta Graph API URL for video uploads.
52		*/
53		const BASE_GRAPH_VIDEO_URL_BETA = 'https://graph-video.beta.facebook.com';
54
55		/**
56		* @const int The timeout in seconds for a normal request.
57		*/
58		const DEFAULT_REQUEST_TIMEOUT = 60;
59
60		/**
61		* @const int The timeout in seconds for a request that contains file uploads.
62		*/
63		const DEFAULT_FILE_UPLOAD_REQUEST_TIMEOUT = 3600;
64
65		/**
66		* @const int The timeout in seconds for a request that contains video uploads.
67		*/
68		const DEFAULT_VIDEO_UPLOAD_REQUEST_TIMEOUT = 7200;
69
70		/**
71		* @var bool toggle to use Graph beta url
72		*/
73		protected $enableBetaMode = false;
74
75		/**
76		* @var httpClient HTTP client handler
77		*/
78		protected $httpClient;
79
80		/**
81		* @var int the number of calls that have been made to Graph
82		*/
83		public static $requestCount = 0;
84
85		/**
86		* Instantiates a new Client object.
87		*
88		* @param null\|HttpClient $httpClient
89		* @param bool $enableBeta
90		*/
91	44	public function __construct(HttpClient $httpClient = null, $enableBeta = false)
92		{
93	44	$this->httpClient = $httpClient ?: HttpClientDiscovery::find();
94	44	$this->enableBetaMode = $enableBeta;
95	44	}
96
97		/**
98		* Sets the HTTP client handler.
99		*
100		* @param HttpClient $httpClient
101		*/
102		public function setHttpClient(HttpClient $httpClient)
103		{
104		$this->httpClient = $httpClient;
105		}
106
107		/**
108		* Returns the HTTP client handler.
109		*
110		* @return HttpClient
111		*/
112	3	public function getHttpClient()
113		{
114	3	return $this->httpClient;
115		}
116
117		/**
118		* Toggle beta mode.
119		*
120		* @param bool $betaMode
121		*/
122	2	public function enableBetaMode($betaMode = true)
123		{
124	2	$this->enableBetaMode = $betaMode;
125	2	}
126
127		/**
128		* Returns the base Graph URL.
129		*
130		* @param bool $postToVideoUrl post to the video API if videos are being uploaded
131		*
132		* @return string
133		*/
134	17	public function getBaseGraphUrl($postToVideoUrl = false)
135		{
136	17	if ($postToVideoUrl) {
137	2	return $this->enableBetaMode ? static::BASE_GRAPH_VIDEO_URL_BETA : static::BASE_GRAPH_VIDEO_URL;
138		}
139
140	15	return $this->enableBetaMode ? static::BASE_GRAPH_URL_BETA : static::BASE_GRAPH_URL;
141		}
142
143		/**
144		* Prepares the request for sending to the client handler.
145		*
146		* @param Request $request
147		*
148		* @return array
149		*/
150	12	public function prepareRequestMessage(Request $request)
151		{
152	12	$postToVideoUrl = $request->containsVideoUploads();
153	12	$url = $this->getBaseGraphUrl($postToVideoUrl) . $request->getUrl();
154
155		// If we're sending files they should be sent as multipart/form-data
156	12	if ($request->containsFileUploads()) {
157	6	$requestBody = $request->getMultipartBody();
158	6	$request->setHeaders([
159	6	'Content-Type' => 'multipart/form-data; boundary=' . $requestBody->getBoundary(),
160		]);
161		} else {
162	9	if($request->isJson()) {
163	1	$requestBody = $request->getJsonEncodedBody();
164	1	$request->setHeaders([
165	1	'Content-Type' => 'application/json',
166		]);
167		}else{
168	8	$requestBody = $request->getUrlEncodedBody();
169	8	$request->setHeaders([
170	8	'Content-Type' => 'application/x-www-form-urlencoded',
171		]);
172		}
173		}
174
175		return [
176	12	$url,
177	12	$request->getMethod(),
178	12	$request->getHeaders(),
179	12	$requestBody->getBody(),
180		];
181		}
182
183		/**
184		* Makes the request to Graph and returns the result.
185		*
186		* @param Request $request
187		*
188		* @throws SDKException
189		*
190		* @return Response
191		*/
192	12	public function sendRequest(Request $request)
193		{
194	12	if (get_class($request) === 'Facebook\Request') {
195	11	$request->validateAccessToken();
196		}
197
198	11	list($url, $method, $headers, $body) = $this->prepareRequestMessage($request);
199
200	11	$psr7Response = $this->httpClient->sendRequest(
201	11	MessageFactoryDiscovery::find()->createRequest($method, $url, $headers, $body)
202		);
203
204	11	static::$requestCount++;
205
206		// Prepare headers from associative array to a single string for each header.
207	11	$responseHeaders = [];
208	11	foreach ($psr7Response->getHeaders() as $name => $values) {
209	11	$responseHeaders[] = sprintf('%s: %s', $name, implode(", ", $values));
210		}
211
212	11	$Response = new Response(
213	11	$request,
214	11	$psr7Response->getBody(),
215	11	$psr7Response->getStatusCode(),
216	11	$responseHeaders
217		);
218
219	11	if ($Response->isError()) {
220	3	throw $Response->getThrownException();
221		}
222
223	9	return $Response;
224		}
225
226		/**
227		* Makes a batched request to Graph and returns the result.
228		*
229		* @param BatchRequest $request
230		*
231		* @throws SDKException
232		*
233		* @return BatchResponse
234		*/
235	1	public function sendBatchRequest(BatchRequest $request)
236		{
237	1	$request->prepareRequestsForBatch();
238	1	$Response = $this->sendRequest($request);
239
240	1	return new BatchResponse($request, $Response);
241		}
242		}
243

facebook / php-graph-sdk

Pull Request — master (#957)

Client::getBaseGraphUrl() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like