/
Client.php
506 lines (446 loc) · 13.7 KB
/
Client.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
<?php
namespace Tumblr\API;
/**
* A client to access the Tumblr API
*/
class Client
{
/** @var string */
private $apiKey;
/** @var RequestHandler */
public $requestHandler;
/**
* Create a new Client
*
* @param string $consumerKey the consumer key
* @param string|null $consumerSecret the consumer secret
* @param string|null $token oauth token
* @param string|null $secret oauth token secret
*/
public function __construct($consumerKey, $consumerSecret = null, $token = null, $secret = null)
{
$this->requestHandler = new RequestHandler();
$this->setConsumer($consumerKey, $consumerSecret);
if ($token && $secret) {
$this->setToken($token, $secret);
}
}
/**
* Set the consumer for this client
*
* @param string $consumerKey the consumer key
* @param string|null $consumerSecret the consumer secret
* @return void
*/
public function setConsumer($consumerKey, $consumerSecret)
{
$this->apiKey = $consumerKey;
$this->requestHandler->setConsumer($consumerKey, $consumerSecret);
}
/**
* Set the token for this client
*
* @param string $token the oauth token
* @param string $secret the oauth secret
*/
public function setToken($token, $secret)
{
$this->requestHandler->setToken($token, $secret);
}
/**
* Retrieve RequestHandler instance
*
* @return RequestHandler
*/
public function getRequestHandler()
{
return $this->requestHandler;
}
/**
* Get info on the authenticating user
*
* @return array the response array
*/
public function getUserInfo()
{
return $this->getRequest('v2/user/info', null, false);
}
/**
* Get user dashboard for the authenticating user
*
* @param array $options the options for the call
* @return array the response array
*/
public function getDashboardPosts($options = null)
{
return $this->getRequest('v2/user/dashboard', $options, false);
}
/**
* Get followings for the authenticating user
*
* @param array $options the options for the call
* @return array the response array
*/
public function getFollowedBlogs($options = null)
{
return $this->getRequest('v2/user/following', $options, false);
}
/**
* Get likes for the authenticating user
*
* @param array $options the options for the call
* @return array the response array
*/
public function getLikedPosts($options = null)
{
return $this->getRequest('v2/user/likes', $options, false);
}
/**
* Follow a blog
*
* @param string $blogName the name of the blog to follow
* @return array the response array
*/
public function follow($blogName)
{
$options = array('url' => $this->blogUrl($blogName));
return $this->postRequest('v2/user/follow', $options, false);
}
/**
* Unfollow a blog
*
* @param string $blogName the name of the blog to follow
* @return array the response array
*/
public function unfollow($blogName)
{
$options = array('url' => $this->blogUrl($blogName));
return $this->postRequest('v2/user/unfollow', $options, false);
}
/**
* Like a post
*
* @param int $postId the id of the post
* @param string $reblogKey the reblog_key of the post
*
* @return array the response array
*/
public function like($postId, $reblogKey)
{
$options = array('id' => $postId, 'reblog_key' => $reblogKey);
return $this->postRequest('v2/user/like', $options, false);
}
/**
* Unlike a post
*
* @param int $postId the id of the post
* @param string $reblogKey the reblog_key of the post
*
* @return array the response array
*/
public function unlike($postId, $reblogKey)
{
$options = array('id' => $postId, 'reblog_key' => $reblogKey);
return $this->postRequest('v2/user/unlike', $options, false);
}
/**
* Delete a post
*
* @param string $blogName the name of the blog the post is on
* @param int $postId the id of the post
* @param string $reblogKey the reblog_key of the post
*
* @return array the response array
*/
public function deletePost($blogName, $postId, $reblogKey)
{
$options = array('id' => $postId, 'reblog_key' => $reblogKey);
$path = $this->blogPath($blogName, '/post/delete');
return $this->postRequest($path, $options, false);
}
/**
* Reblog a post
*
* @param string $blogName the name of the blog
* @param int $postId the id of the post
* @param string $reblogKey the reblog key of the post
* @param array $options the options for the call
*
* @return array the response array
*/
public function reblogPost($blogName, $postId, $reblogKey, $options = null)
{
$params = array('id' => $postId, 'reblog_key' => $reblogKey);
$params = array_merge($options ?: array(), $params);
$path = $this->blogPath($blogName, '/post/reblog');
return $this->postRequest($path, $params, false);
}
/**
* Edit a post
*
* @param string $blogName the name of the blog
* @param int $postId the id of the post to edit
* @param array $data the data to save
*
* @return array the response array
*/
public function editPost($blogName, $postId, $data)
{
$data['id'] = $postId;
$path = $this->blogPath($blogName, '/post/edit');
return $this->postRequest($path, $data, false);
}
/**
* Create a post
*
* @param string $blogName the name of the blog
* @param array $data the data to save
*
* @return array the response array
*/
public function createPost($blogName, $data)
{
$path = $this->blogPath($blogName, '/post');
return $this->postRequest($path, $data, false);
}
/**
* Get tagged posts
*
* @param string $tag the tag to look up
* @param array $options the options for the call
*
* @return array the response array
*/
public function getTaggedPosts($tag, $options = null)
{
if (!$options) {
$options = array();
}
$options['tag'] = $tag;
return $this->getRequest('v2/tagged', $options, true);
}
/**
* Get information about a given blog
*
* @param string $blogName the name of the blog to look up
* @return array the response array
*/
public function getBlogInfo($blogName)
{
$path = $this->blogPath($blogName, '/info');
return $this->getRequest($path, null, true);
}
/**
* Get blog avatar URL
*
* @param string $blogName the nae of the blog to look up
* @param int $size the size to retrieve
*
* @return string|null the avatar url
*/
public function getBlogAvatar($blogName, $size = null)
{
$path = $this->blogPath($blogName, '/avatar');
if ($size) {
$path .= "/$size";
}
return $this->getRedirect($path, null, true);
}
/**
* Get blog likes for a given blog
*
* @param string $blogName the name of the blog to look up
* @param array $options the options for the call
*
* @return array the response array
*/
public function getBlogLikes($blogName, $options = null)
{
$path = $this->blogPath($blogName, '/likes');
return $this->getRequest($path, $options, true);
}
/**
* Get blog followers for a given blog
*
* @param string $blogName the name of the blog to look up
* @param array $options the options for the call
*
* @return array the response array
*/
public function getBlogFollowers($blogName, $options = null)
{
$path = $this->blogPath($blogName, '/followers');
return $this->getRequest($path, $options, false);
}
/**
* Get posts for a given blog
*
* @param string $blogName the name of the blog
* @param array $options the options for the call
*
* @return array the response array
*/
public function getBlogPosts($blogName, $options = null)
{
$path = $this->blogPath($blogName, '/posts');
if ($options && isset($options['type'])) {
$path .= '/' . $options['type'];
unset($options['type']);
}
return $this->getRequest($path, $options, true);
}
/**
* Get queue posts for a given blog
*
* @param string $blogName the name of the blog
* @param array $options the options for the call
*
* @return array the response array
*/
public function getQueuedPosts($blogName, $options = null)
{
$path = $this->blogPath($blogName, '/posts/queue');
return $this->getRequest($path, $options, false);
}
/**
* Get draft posts for a given blog
*
* @param string $blogName the name of the blog
* @param array $options the options for the call
*
* @return array the response array
*/
public function getDraftPosts($blogName, $options = null)
{
$path = $this->blogPath($blogName, '/posts/draft');
return $this->getRequest($path, $options, false);
}
/**
* Get submission posts for a given blog
*
* @param string $blogName the name of the blog
* @param array $options the options for the call
*
* @return array the response array
*/
public function getSubmissionPosts($blogName, $options = null)
{
$path = $this->blogPath($blogName, '/posts/submission');
return $this->getRequest($path, $options, false);
}
/**
* Make a GET request to the given endpoint and return the response
*
* @param string $path the path to call on
* @param array|null $options the options to call with
* @param bool $addApiKey whether or not to add the api key
*
* @return array the response object (parsed)
*/
public function getRequest($path, $options, $addApiKey)
{
$response = $this->makeRequest('GET', $path, $options, $addApiKey);
return $this->parseResponse($response);
}
/**
* Make a POST request to the given endpoint and return the response
*
* @param string $path the path to call on
* @param array $options the options to call with
* @param bool $addApiKey whether or not to add the api key
*
* @return array the response object (parsed)
*/
public function postRequest($path, $options, $addApiKey)
{
if (isset($options['source']) && is_array($options['source'])) {
$sources = $options['source'];
unset($options['source']);
foreach ($sources as $i => $source) {
$options["source[$i]"] = $source;
}
}
$response = $this->makeRequest('POST', $path, $options, $addApiKey);
return $this->parseResponse($response);
}
/**
* Parse a response and return an appropriate result
*
* @param \stdClass $response the response from the server
*
* @throws RequestException
* @return array the response data
*/
private function parseResponse($response)
{
$response->json = json_decode($response->body);
if ($response->status < 400) {
return $response->json->response;
} else {
throw new RequestException($response);
}
}
/**
* Make a GET request to the given endpoint and return the response
*
* @param string $path the path to call on
* @param array|null $options the options to call with
* @param bool $addApiKey whether or not to add the api key
*
* @return string|null url redirected to (or null)
*/
private function getRedirect($path, $options, $addApiKey)
{
$response = $this->makeRequest('GET', $path, $options, $addApiKey);
if ($response->status === 301 || $response->status === 302) {
return $response->headers['Location'][0];
}
return null;
}
/**
* Make a request to the given endpoint and return the response
*
* @param string $method the method to call: GET, POST
* @param string $path the path to call on
* @param array|null $options the options to call with
* @param bool $addApiKey whether or not to add the api key
*
* @return \stdClass the response object (not parsed)
*/
private function makeRequest($method, $path, $options, $addApiKey)
{
if ($addApiKey) {
$options = array_merge(
array('api_key' => $this->apiKey),
$options ?: array()
);
}
return $this->requestHandler->request($method, $path, $options);
}
/**
* Expand the given blogName into a base path for the blog
*
* @param string $blogName the name of the blog
* @param string $ext the url extension
*
* @return string the blog base path
*/
private function blogPath($blogName, $ext)
{
$blogUrl = $this->blogUrl($blogName);
return "v2/blog/$blogUrl$ext";
}
/**
* Get the URL of a blog by name or URL
*
* @param string $blogName the name of the blog
* @return string the blog URL
*/
private function blogUrl($blogName)
{
if (strpos($blogName, '.') === false) {
return "$blogName.tumblr.com";
}
return $blogName;
}
}