Completed
Push — master ( 7113c4...8875d3 )
by Yassine
14s
created

ClientTest   A

Complexity

Total Complexity 17

Size/Duplication

Total Lines 237
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
dl 0
loc 237
rs 10
c 0
b 0
f 0
wmc 17

14 Methods

Rating   Name   Duplication   Size   Complexity  
A testBetaModeCanBeDisabledOrEnabledViaConstructor() 0 9 1
A initializeTestApp() 0 21 4
A testARequestEntityCanBeUsedToSendARequestToGraph() 0 8 1
A testABatchRequestEntityCanBeUsedToSendABatchRequestToGraph() 0 14 1
A testTheHttpClientWillFallbackToDefault() 0 6 1
A testARequestWithFilesWillBeMultipart() 0 9 1
B testABatchRequestWillProperlyBatchFiles() 0 25 1
A testBetaModeCanBeDisabledOrEnabledViaMethod() 0 10 1
A testARequestOfParamsWillBeUrlEncoded() 0 8 1
A setUp() 0 4 1
A testARequestValidatesTheAccessTokenWhenOneIsNotProvided() 0 4 1
A testGraphVideoUrlCanBeSet() 0 10 1
A testACustomHttpClientCanBeInjected() 0 7 1
A testCanCreateATestUserAndGetTheProfileAndThenDeleteTheTestUser() 0 48 1
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\Tests;
24
25
use Facebook\Exception\SDKException;
26
use Facebook\Application;
27
use Facebook\Request;
28
use Facebook\BatchRequest;
29
use Facebook\Client;
30
use Facebook\FileUpload\File;
31
use Facebook\FileUpload\Video;
32
// These are needed when you uncomment the HTTP clients below.
33
use Facebook\Tests\Fixtures\MyFooBatchHttpClient;
34
use Facebook\Tests\Fixtures\MyFooHttpClient;
35
use Facebook\Response;
36
use Facebook\BatchResponse;
37
use Facebook\GraphNode\GraphNode;
38
use Http\Client\HttpClient;
39
use PHPUnit\Framework\TestCase;
40
41
class ClientTest extends TestCase
42
{
43
    /**
44
     * @var Application
45
     */
46
    public $fbApp;
47
48
    /**
49
     * @var Client
50
     */
51
    public $fbClient;
52
53
    /**
54
     * @var Application
55
     */
56
    public static $testApp;
57
58
    /**
59
     * @var Client
60
     */
61
    public static $testClient;
62
63
    protected function setUp()
64
    {
65
        $this->fbApp = new Application('id', 'shhhh!');
66
        $this->fbClient = new Client(new MyFooHttpClient());
67
    }
68
69
    public function testACustomHttpClientCanBeInjected()
70
    {
71
        $handler = new MyFooHttpClient();
72
        $client = new Client($handler);
73
        $httpClient = $client->getHttpClient();
74
75
        $this->assertInstanceOf(MyFooHttpClient::class, $httpClient);
76
    }
77
78
    public function testTheHttpClientWillFallbackToDefault()
79
    {
80
        $client = new Client();
81
        $httpClient = $client->getHttpClient();
82
83
        $this->assertInstanceOf(HttpClient::class, $httpClient);
84
    }
85
86
    public function testBetaModeCanBeDisabledOrEnabledViaConstructor()
87
    {
88
        $client = new Client(null, false);
89
        $url = $client->getBaseGraphUrl();
90
        $this->assertEquals(Client::BASE_GRAPH_URL, $url);
91
92
        $client = new Client(null, true);
93
        $url = $client->getBaseGraphUrl();
94
        $this->assertEquals(Client::BASE_GRAPH_URL_BETA, $url);
95
    }
96
97
    public function testBetaModeCanBeDisabledOrEnabledViaMethod()
98
    {
99
        $client = new Client();
100
        $client->enableBetaMode(false);
101
        $url = $client->getBaseGraphUrl();
102
        $this->assertEquals(Client::BASE_GRAPH_URL, $url);
103
104
        $client->enableBetaMode(true);
105
        $url = $client->getBaseGraphUrl();
106
        $this->assertEquals(Client::BASE_GRAPH_URL_BETA, $url);
107
    }
108
109
    public function testGraphVideoUrlCanBeSet()
110
    {
111
        $client = new Client();
112
        $client->enableBetaMode(false);
113
        $url = $client->getBaseGraphUrl($postToVideoUrl = true);
114
        $this->assertEquals(Client::BASE_GRAPH_VIDEO_URL, $url);
115
116
        $client->enableBetaMode(true);
117
        $url = $client->getBaseGraphUrl($postToVideoUrl = true);
118
        $this->assertEquals(Client::BASE_GRAPH_VIDEO_URL_BETA, $url);
119
    }
120
121
    public function testARequestEntityCanBeUsedToSendARequestToGraph()
122
    {
123
        $fbRequest = new Request($this->fbApp, 'token', 'GET', '/foo');
124
        $response = $this->fbClient->sendRequest($fbRequest);
125
126
        $this->assertInstanceOf(Response::class, $response);
127
        $this->assertEquals(200, $response->getHttpStatusCode());
128
        $this->assertEquals('{"data":[{"id":"123","name":"Foo"},{"id":"1337","name":"Bar"}]}', $response->getBody());
129
    }
130
131
    public function testABatchRequestEntityCanBeUsedToSendABatchRequestToGraph()
132
    {
133
        $fbRequests = [
134
            new Request($this->fbApp, 'token', 'GET', '/foo'),
135
            new Request($this->fbApp, 'token', 'POST', '/bar'),
136
        ];
137
        $fbBatchRequest = new BatchRequest($this->fbApp, $fbRequests);
138
139
        $fbBatchClient = new Client(new MyFooBatchHttpClient());
140
        $response = $fbBatchClient->sendBatchRequest($fbBatchRequest);
141
142
        $this->assertInstanceOf(BatchResponse::class, $response);
143
        $this->assertEquals('GET', $response[0]->getRequest()->getMethod());
0 ignored issues
show
Bug introduced by
The method getRequest() does not exist on null. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

143
        $this->assertEquals('GET', $response[0]->/** @scrutinizer ignore-call */ getRequest()->getMethod());

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
144
        $this->assertEquals('POST', $response[1]->getRequest()->getMethod());
0 ignored issues
show
Bug introduced by
The method getRequest() does not exist on null. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

144
        $this->assertEquals('POST', $response[1]->/** @scrutinizer ignore-call */ getRequest()->getMethod());

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
145
    }
146
147
    public function testABatchRequestWillProperlyBatchFiles()
148
    {
149
        $fbRequests = [
150
            new Request($this->fbApp, 'token', 'POST', '/photo', [
151
                'message' => 'foobar',
152
                'source' => new File(__DIR__ . '/foo.txt'),
153
            ]),
154
            new Request($this->fbApp, 'token', 'POST', '/video', [
155
                'message' => 'foobar',
156
                'source' => new Video(__DIR__ . '/foo.txt'),
157
            ]),
158
        ];
159
        $fbBatchRequest = new BatchRequest($this->fbApp, $fbRequests);
160
        $fbBatchRequest->prepareRequestsForBatch();
161
162
        list($url, $method, $headers, $body) = $this->fbClient->prepareRequestMessage($fbBatchRequest);
163
164
        $this->assertEquals(Client::BASE_GRAPH_VIDEO_URL, $url);
165
        $this->assertEquals('POST', $method);
166
        $this->assertContains('multipart/form-data; boundary=', $headers['Content-Type']);
167
        $this->assertContains('Content-Disposition: form-data; name="batch"', $body);
168
        $this->assertContains('Content-Disposition: form-data; name="include_headers"', $body);
169
        $this->assertContains('"name":0,"attached_files":', $body);
170
        $this->assertContains('"name":1,"attached_files":', $body);
171
        $this->assertContains('"; filename="foo.txt"', $body);
172
    }
173
174
    public function testARequestOfParamsWillBeUrlEncoded()
175
    {
176
        $fbRequest = new Request($this->fbApp, 'token', 'POST', '/foo', ['foo' => 'bar']);
177
        $response = $this->fbClient->sendRequest($fbRequest);
178
179
        $headersSent = $response->getRequest()->getHeaders();
180
181
        $this->assertEquals('application/x-www-form-urlencoded', $headersSent['Content-Type']);
182
    }
183
184
    public function testARequestWithFilesWillBeMultipart()
185
    {
186
        $myFile = new File(__DIR__ . '/foo.txt');
187
        $fbRequest = new Request($this->fbApp, 'token', 'POST', '/foo', ['file' => $myFile]);
188
        $response = $this->fbClient->sendRequest($fbRequest);
189
190
        $headersSent = $response->getRequest()->getHeaders();
191
192
        $this->assertContains('multipart/form-data; boundary=', $headersSent['Content-Type']);
193
    }
194
195
    /**
196
     * @expectedException \Facebook\Exception\SDKException
197
     */
198
    public function testARequestValidatesTheAccessTokenWhenOneIsNotProvided()
199
    {
200
        $fbRequest = new Request($this->fbApp, null, 'GET', '/foo');
201
        $this->fbClient->sendRequest($fbRequest);
202
    }
203
204
    /**
205
     * @group integration
206
     */
207
    public function testCanCreateATestUserAndGetTheProfileAndThenDeleteTheTestUser()
208
    {
209
        $this->initializeTestApp();
210
211
        // Create a test user
212
        $testUserPath = '/' . TestCredentials::$appId . '/accounts/test-users';
0 ignored issues
show
Bug introduced by
The type Facebook\Tests\TestCredentials was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
213
        $params = [
214
            'installed' => true,
215
            'name' => 'Foo Phpunit User',
216
            'locale' => 'en_US',
217
            'permissions' => implode(',', ['read_stream', 'user_photos']),
218
        ];
219
220
        $request = new Request(
221
            static::$testApp,
222
            static::$testApp->getAccessToken(),
223
            'POST',
224
            $testUserPath,
225
            $params
226
        );
227
        $response = static::$testClient->sendRequest($request)->getGraphNode();
228
229
        $testUserId = $response->getField('id');
230
        $testUserAccessToken = $response->getField('access_token');
231
232
        // Get the test user's profile
233
        $request = new Request(
234
            static::$testApp,
235
            $testUserAccessToken,
236
            'GET',
237
            '/me'
238
        );
239
        $graphNode = static::$testClient->sendRequest($request)->getGraphNode();
240
241
        $this->assertInstanceOf(GraphNode::class, $graphNode);
242
        $this->assertNotNull($graphNode->getField('id'));
243
        $this->assertEquals('Foo Phpunit User', $graphNode->getField('name'));
244
245
        // Delete test user
246
        $request = new Request(
247
            static::$testApp,
248
            static::$testApp->getAccessToken(),
249
            'DELETE',
250
            '/' . $testUserId
251
        );
252
        $graphNode = static::$testClient->sendRequest($request)->getGraphNode();
253
254
        $this->assertTrue($graphNode->getField('success'));
255
    }
256
257
    public function initializeTestApp()
258
    {
259
        if (!file_exists(__DIR__ . '/TestCredentials.php')) {
260
            throw new SDKException(
261
                'You must create a TestCredentials.php file from TestCredentials.php.dist'
262
            );
263
        }
264
265
        if (!strlen(TestCredentials::$appId) ||
266
            !strlen(TestCredentials::$appSecret)
267
        ) {
268
            throw new SDKException(
269
                'You must fill out TestCredentials.php'
270
            );
271
        }
272
        static::$testApp = new Application(
273
            TestCredentials::$appId,
274
            TestCredentials::$appSecret
275
        );
276
277
        static::$testClient = new Client();
278
    }
279
}
280