-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathTumblr.php
More file actions
968 lines (813 loc) · 27.9 KB
/
Copy pathTumblr.php
File metadata and controls
968 lines (813 loc) · 27.9 KB
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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
<?php
/**
* Tumblr API library for PHP
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
*
* @package Tumblr
* @copyright Copyright (c) 2011 aoiaoi
* @license New BSD License
*/
require_once 'Zend/Oauth/Consumer.php';
/**
* @package Tumblr
* @copyright Copyright (c) 2011 aoiaoi
* @license New BSD License
*/
class Tumblr {
/**
* Base URI for the REST client
*/
const BASE_URI = 'http://api.tumblr.com';
/**
* The path for the REST client
*/
const PATH_BLOG_INFO = '/v2/blog/%s/info';
const PATH_BLOG_AVATAR = '/v2/blog/%s/avatar';
const PATH_BLOG_POSTS = '/v2/blog/$s/posts';
/**
* The URI for OAuth
*/
const REQUEST_TOKEN_URI = 'http://www.tumblr.com/oauth/request_token';
const AUTHORIZE_URI = 'http://www.tumblr.com/oauth/authorize';
const ACCESS_TOKEN_URI = 'http://www.tumblr.com/oauth/access_token';
/**
* The URI for the OAuth client
*/
const OAUTH_BLOG_FOLLOWERS = 'http://api.tumblr.com/v2/blog/%s/followers';
const OAUTH_POSTS_QUEUE = 'http://api.tumblr.com/v2/blog/%s/posts/queue';
const OAUTH_POSTS_DRAFT = 'http://api.tumblr.com/v2/blog/%s/posts/draft';
const OAUTH_POSTS_SUBMISSION = 'http://api.tumblr.com/v2/blog/%s/posts/submission';
const OAUTH_POST = 'http://api.tumblr.com/v2/blog/%s/post';
const OAUTH_POST_EDIT = 'http://api.tumblr.com/v2/blog/%s/post/edit';
const OAUTH_POST_REBLOG = 'http://api.tumblr.com/v2/blog/%s/post/reblog';
const OAUTH_POST_DELETE = 'http://api.tumblr.com/v2/blog/%s/post/delete';
const OAUTH_USER_INFO = 'http://api.tumblr.com/v2/user/info';
const OAUTH_USER_DASHBOARD = 'http://api.tumblr.com/v2/user/dashboard';
const OAUTH_USER_LIKES = 'http://api.tumblr.com/v2/user/likes';
const OAUTH_USER_FOLLOWING = 'http://api.tumblr.com/v2/user/following';
const OAUTH_USER_FOLLOW = 'http://api.tumblr.com/v2/user/follow';
const OAUTH_USER_UNFOLLOW = 'http://api.tumblr.com/v2/user/unfollow';
const OAUTH_USER_LIKE = 'http://api.tumblr.com/v2/user/like';
const OAUTH_USER_UNLIKE = 'http://api.tumblr.com/v2/user/unlike';
/**
* An OAuth application's consumer key
*
* @var string
*/
protected $_consumerKey = null;
/**
* ...
*
* @var string
*/
protected $_consumerSecret = null;
/**
* Access token retrieved from OAuth provider
*
* @var string
*/
protected $_accessToken = null;
/**
* ...
*
* @var string
*/
protected $_accessTokenSecret = null;
/**
* Reference to instance of Zend_Oauth_Consmer
*
* @var Zend_Oauth_Consumer
*/
protected $_oauthConsumer = null;
/**
* Reference to instance of Zend_Oauth_Token_Access
*
* @var Zend_Oauth_Token_Access
*/
protected $_oauthTokenAccess = null;
/**
* Reference to instance of Zend_Oauth_Client
*
* @var Zend_Oauth_Client
*/
protected $_oauthClient = null;
/**
* Reference to instance of Zend_Rest_Client
*
* @var Zend_Rest_Client
*/
protected $_restClient = null;
/**
* Performs object initializations
*
* @param array $configs
* @return void
*/
public function __construct($configs = array()) {
if (isset($configs['consumerKey'])) {
$this->setConsumerKey($configs['consumerKey']);
}
if (isset($configs['consumerSecret'])) {
$this->setConsumerSecret($configs['consumerSecret']);
}
if (isset($configs['accessToken'])) {
$this->setAccessToken($configs['accessToken']);
}
if (isset($configs['accessTokenSecret'])) {
$this->setAccessTokenSecret($configs['accessTokenSecret']);
}
if (isset($configs['oauthTokenAccess']) && $configs['oauthTokenAccess'] instanceof Zend_Oauth_Token_Access) {
$this->setOauthTokenAccess($configs['oauthTokenAccess']);
}
if (isset($configs['oauthConsumer']) && $configs['oauthConsumer'] instanceof Zend_Oauth_Consumer) {
$this->setOauthConsumer($configs['oauthConsumer']);
}
}
/**
* Set your consumer key
*
* @param string $consumerKey
* @return Tumblr
*/
public function setConsumerKey($consumerKey) {
$this->_consumerKey = (string) $consumerKey;
return $this;
}
/**
* Returns your consumer key
*
* @return string
*/
public function getConsumerKey() {
return $this->_consumerKey;
}
/**
* Set your consumer secret
*
* @param string $consumerSecret
* @return Tumblr
*/
public function setConsumerSecret($consumerSecret) {
$this->_consumerSecret = (string) $consumerSecret;
return $this;
}
/**
* Returns your consumer secret
*
* @return string
*/
public function getConsumerSecret() {
return $this->_consumerSecret;
}
/**
* Set access token
*
* @param string $accessToken
* @return Tumblr
*/
public function setAccessToken($accessToken) {
$this->_accessToken = (string) $accessToken;
return $this;
}
/**
* Return access token
*
* @return string
*/
public function getAccessToken() {
return $this->_accessToken;
}
/**
* Set access token secret
*
* @param string $accessTokenSecret
* @return Tumblr
*/
public function setAccessTokenSecret($accessTokenSecret) {
$this->_accessTokenSecret = (string) $accessTokenSecret;
return $this;
}
/**
* Return access token secret
*
* @return string
*/
public function getAccessTokenSecret() {
return $this->_accessTokenSecret;
}
/**
* Set Zend_Oauth_Token_Access object
*
* @param Zend_Oauth_Token_Access $oauthTokenAccess
* @return Tumblr
*/
public function setOauthTokenAccess(Zend_Oauth_Token_Access $oauthTokenAccess) {
$this->_oauthTokenAccess = $oauthTokenAccess;
$this->setAccessToken($oauthTokenAccess->getToken());
$this->setAccessTokenSecret($oauthTokenAccess->getTokenSecret());
return $this;
}
/**
* Return Zend_Oauth_Token_Access object
*
* @return Zend_Oauth_Token_Access
*/
public function getOauthTokenAccess() {
return $this->_oauthTokenAccess;
}
/**
* Set Zend_OAuth_Consumer object
*
* @param Zend_Oauth_Consumer $oauthConsumer
* @return Tumblr
*/
public function setOauthConsumer(Zend_Oauth_Consumer $oauthConsumer) {
$this->_oauthConsumer = $oauthConsumer;
return $this;
}
/**
* Returns a reference to the OAuth consumer, instantiating it if necessary
*
* @return Zend_Oauth_Consumer
*/
public function getOauthConsumer() {
if (null === $this->_oauthConsumer) {
$config = array('requestTokenUrl' => self::REQUEST_TOKEN_URI,
'authorizeUrl' => self::AUTHORIZE_URI,
'accessTokenUrl' => self::ACCESS_TOKEN_URI,
'consumerKey' => $this->getConsumerKey(),
'consumerSecret' => $this->getConsumerSecret());
$this->_oauthConsumer = new Zend_Oauth_Consumer($config);
}
return $this->_oauthConsumer;
}
/**
* Returns a reference to the REST client, instantiating it if necessary
*
* @return Zend_Rest_Client
*/
public function getRestClient() {
if (null === $this->_restClient) {
require_once 'Zend/Rest/Client.php';
$this->_restClient = new Zend_Rest_Client(self::BASE_URI);
}
return $this->_restClient;
}
/**
* Returns a reference to the OAuth client, instantiating it if necessary
*
* @return Zend_Oauth_Client
*/
public function getOauthClient() {
if (null === $this->_oauthClient) {
$oauthTokenAccess = $this->getOauthTokenAccess();
if (! $oauthTokenAccess instanceof Zend_Oauth_Token_Access) {
$oauthTokenAccess = new Zend_Oauth_Token_Access();
$oauthTokenAccess->setToken($this->getAccessToken());
$oauthTokenAccess->setTokenSecret($this->getAccessTokenSecret());
}
$parameters = array('consumerKey' => $this->getConsumerKey(),
'consumerSecret' => $this->getConsumerSecret());
$this->_oauthClient = $oauthTokenAccess->getHttpClient($parameters);
}
return $this->_oauthClient;
}
/**
* Reset the Zend_Oauth_Client object
*
* @param Tumblr
*/
public function resetOauthClient() {
$this->_oauthClient = null;
return $this;
}
/**
* Retrieve Blog Info
*
* @param string $hostname The standard or custom blog hostname
* @return json $response
*/
public function retrieveBlogInfo($hostname) {
$hostname = $this->_prepareHostname($hostname);
$parameters = array('api_key' => $this->getConsumerKey());
$restClient = $this->getRestClient();
$restClient->getHttpClient()->resetParameters();
$response = $restClient->restGet(sprintf(self::PATH_BLOG_INFO, $hostname), $parameters);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Retrieve a Blog Avatar
*
* @param string $hostname The standard or custom blog hostname
* @param int $size The size of avatar. Must be one of the values: 16|24|30|40|48|64|96|128|512 (default 64)
* @return json
*/
public function retrieveBlogAvatar($hostname, $size = 64) {
$hostname = $this->_prepareHostname($hostname);
$parameters = array('size' => $size);
$this->_validateBlogAvatarMethod($parameters);
$restClient = $this->getRestClient();
$restClient->getHttpClient()->resetParameters();
$response = $restClient->restGet(sprintf(self::PATH_BLOG_AVATAR, $hostname), $parameters);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Retrieve a Blog's Followers
*
* Request parameters include:
*
* # limit => int How many results to return: 1-20 (default 20)
* # offset => int Post number to start at: (default 0)
*
* @param string $hostname The standard or custom blog hostname
* @param array $parameters (limit|offset)
* @return json
*/
public function retrieveBlogsFollowers($hostname, $parameters = array()) {
$hostname = $this->_prepareHostname($hostname);
$defaultParameters = array('limit' => 20,
'offset' => 0);
$parameters = $this->_prepareParameters($parameters, $defaultParameters);
$this->_validateBlogsFollowersMethod($parameters);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(sprintf(self::OAUTH_BLOG_FOLLOWERS, $hostname));
$oauthClient->setParameterGet($parameters);
$response = $oauthClient->request(Zend_Http_Client::GET);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Retrieve Published Posts
*
* Request parameters include:
*
* # type => string The type of post to return: text|quote|link|answer|video|audio|photo
* # id => int A specific post ID
* # tag => string Limits the response to posts with the specified tag
* # limit => int How many results to return: 1-20 (default 20)
* # offset => int Post number to start at: (default 0)
* # reblog_info => bool Return reblog information: true|false (default false)
* # notes_info => bool Return notes infomation: true|false (default false)
* # format => string The post format to return, other than HTML: text|raw
*
* @param string $hostname The standard or custom blog hostname
* @param array $parameters
* @return json
*/
public function retrievePublishedPosts($hostname, $parameters = array()) {
$hostname = $this->_prepareHostname($hostname);
$defaultParameters = array('limit' => 20,
'offset' => 0,
'reblog_info' => false,
'notes_info' => false);
$parameters['api_key'] = $this->getConsumerKey();
$parameters = $this->_prepareParameters($parameters, $defaultParameters);
$this->_validatePublishedPostsMethod($parameters);
$restClient = $this->getRestClient();
$restClient->getHttpClient()->resetParameters();
$response = $restClient->restGet(sprintf(self::PATH_BLOG_POSTS, $hostname), $parameters);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Retrieve Queued Posts
*
* @param string $hostname The standard or custom blog hostname
* @return json
*/
public function retrieveQueuedPosts($hostname) {
$hostname = $this->_prepareHostname($hostname);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(sprintf(self::OAUTH_POSTS_QUEUE, $hostname));
$response = $oauthClient->request(Zend_Http_Client::GET);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Retrieve Draft Posts
*
* @param string $hostname The standard or custom blog hostname
* @return json
*/
public function retrieveDraftPosts($hostname) {
$hostname = $this->_prepareHostname($hostname);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(sprintf(self::OAUTH_POSTS_DRAFT, $hostname));
$response = $oauthClient->request(Zend_Http_Client::GET);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Retrieve Submission Posts
*
* @param string $hostname The standard or custom blog hostname
* @return json
*/
public function retrieveSubmissionPosts($hostname) {
$hostname = $this->_prepareHostname($hostname);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(sprintf(self::OAUTH_POSTS_SUBMISSION, $hostname));
$response = $oauthClient->request(Zend_Http_Client::GET);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* ...
*/
public function createBlogPost($hostname, $parameters = array()) {
$hostname = $this->_prepareHostname($hostname);
$defaultParameters = array('state' => 'published',
'markdown' => false);
$parameters = $this->_prepareParameters($parameters, $defaultParameters);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(sprintf(self::OAUTH_POST, $hostname));
$oauthClient->setParameterPost($parameters);
$response = $oauthClient->request(Zend_Http_Client::POST);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Edit a Blog Post
*
* Request parameters include:
*
* # ...
*
* @param string $hostname The standard or custom blog hostname
* @param int $postId The ID of the post to edit
* @return json
*/
public function editBlogPost($hostname, $postId, $parameters = array()) {
$hostname = $this->_prepareHostname($hostname);
$defaultParameters = array('state' => 'published',
'markdown' => false);
$parameters['id'] = $postId;
$parameters = $this->_prepareParameters($parameters, $defaultParameters);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(sprintf(self::OAUTH_POST_EDIT, $hostname));
$oauthClient->setParameterPost($parameters);
$response = $oauthClient->request(Zend_Http_Client::POST);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Reblog a Post
*
* Request parameters include:
*
* # comment => string A comment added to the reblogged post
* # ...
*
* @param string $hostname The standard or custom blog hostname
* @param int $postId The ID of the post to edit
* @param int $reblogKey The reblog key for the reblogged post
* @return json
*/
public function reblogPost($hostname, $postId, $reblogKey, $parameters = array()) {
$hostname = $this->_prepareHostname($hostname);
$defaultParameters = array('state' => 'published',
'markdown' => false);
$parameters['id'] = $postId;
$parameters['reblog_key'] = $reblogKey;
$parameters = $this->_prepareParameters($parameters, $defaultParameters);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(sprintf(self::OAUTH_POST_REBLOG, $hostname));
$oauthClient->setParameterPost($parameters);
$response = $oauthClient->request(Zend_Http_Client::POST);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Delete a Post
*
* @param string $hostname The standard or custom blog hostname
* @param int $postId The ID of the post to delete
* @return json
*/
public function deletePost($hostname, $postId) {
$hostname = $this->_prepareHostname($hostname);
$parameters = array('id' => $postId);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(sprintf(self::OAUTH_POST_DELETE, $hostname));
$oauthClient->setParameterPost($parameters);
$response = $oauthClient->request(Zend_Http_Client::POST);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Get a User's Information
*
* @return json
*/
public function retrieveUsersInfo() {
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(self::OAUTH_USER_INFO);
$response = $oauthClient->request(Zend_Http_Client::POST);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Retrieve a User's Dashboard
*
* Request parameters include:
*
* # limit => int How many results to return: 1-20 (default 20)
* # offset => int Post number to start at: (default 0)
* # type => string The type of post to return: text|quote|link|answer|video|audio|photo
* # since_id => int Return posts that have appeared after this ID: (default 0)
* # reblog_info => bool Return reblog information: true|false (default false)
* # notes_info => bool Return notes infomation: true|false (default false)
*
* @param array $parameters
* @return json
*/
public function retrieveUsersDashboard($parameters = array()) {
$defaultParameters = array('limit' => 20,
'offset' => 0,
'since_id' => 0,
'reblog_info' => false,
'notes_info' => false);
$parameters = $this->_prepareParameters($parameters, $defaultParameters);
$this->_validateUsersDashboardMethod($parameters);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(self::OAUTH_USER_DASHBOARD);
$oauthClient->setParameterGet($parameters);
$response = $oauthClient->request(Zend_Http_Client::GET);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Retrieve a User's Likes
*
* Request parameters include:
*
* # limit => int How many results to return: 1-20 (default 20)
* # offset => int Post number to start at: (default 0)
*
* @param array $parameters
* @return json
*/
public function retrieveUsersLikes($parameters = array()) {
$defaultParameters = array('limit' => 20,
'offset' => 0);
$parameters = $this->_prepareParameters($parameters, $defaultParameters);
$this->_validateUsersLikesMethod($parameters);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(self::OAUTH_USER_LIKES);
$oauthClient->setParameterGet($parameters);
$response = $oauthClient->request(Zend_Http_Client::GET);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Retrieve the Blogs a User Is Following
*
* Request parameters include:
*
* # limit => int How many results to return: 1-20 (default 20)
* # offset => int Post number to start at: (default 0)
*
* @param array $parameters
* @return json
*/
public function retrieveUsersFollowing($parameters = array()) {
$defaultParameters = array('limit' => 20,
'offset' => 0);
$parameters = $this->_prepareParameters($parameters, $defaultParameters);
$this->_validateUsersFollowingMethod($parameters);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(self::OAUTH_USER_FOLLOWING);
$oauthClient->setParameterGet($parameters);
$response = $oauthClient->request(Zend_Http_Client::GET);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Follow a blog
*
* @param string $blogUrl The URL of the blog to follow
* @return json
*/
public function followBlog($blogUrl) {
$parameters = array('url' => $blogUrl);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(self::OAUTH_USER_FOLLOW);
$oauthClient->setParameterPost($parameters);
$response = $oauthClient->request(Zend_Http_Client::POST);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Unfollow a blog
*
* @param string $blogUrl The URL of the blog to unfollow
* @return json
*/
public function unfollowBlog($blogUrl) {
$parameters = array('url' => $blogUrl);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(self::OAUTH_USER_UNFOLLOW);
$oauthClient->setParameterPost($parameters);
$response = $oauthClient->request(Zend_Http_Client::POST);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Like a Post
*
* @param int $postId The ID of the post to like
* @param string $reblogKey The reblog key for the post id
* @return json
*/
public function likePost($postId, $reblogKey) {
$parameters = array('id' => $postId,
'reblog_key' => $reblogKey);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(self::OAUTH_USER_LIKE);
$oauthClient->setParameterPost($parameters);
$response = $oauthClient->request(Zend_Http_Client::POST);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Unlike a Post
*
* @param int $postId The ID of the post to unlike
* @param string $reblogKey The reblog key for the post id
* @return json
*/
public function unlikePost($postId, $reblogKey) {
$parameters = array('id' => $postId,
'reblog_key' => $reblogKey);
$oauthClient = $this->getOauthClient();
$oauthClient->setUri(self::OAUTH_USER_UNLIKE);
$oauthClient->setParameterPost($parameters);
$response = $oauthClient->request(Zend_Http_Client::POST);
if ($response->isError()) {
throw new Exception("An error occurred sending request. Status code: {$response->getStatus()}");
}
return $response;
}
/**
* Prepare hostname for the request
*
* @param string $hostname The hostname of blog
* @return string
*/
protected function _prepareHostname($hostname) {
$parsed_url = parse_url($hostname);
if (isset($parsed_url['scheme'])) {
$hostname = $parsed_url['host'];
}
return $hostname;
}
/**
* Prepare parameters for the request
*
* @param array $parameters User Parameters
* @param array $defaultParameters Default Parameters
* @return array Merged array of user and default/required parameters
*/
protected function _prepareParameters(array $parameters, array $defaultParameters = array()) {
return array_merge($defaultParameters, $parameters);
}
/**
* Validate Retrieve Blog Avatar Parameters
*
* @param array $parameters
* @return void
*/
protected function _validateBlogAvatarMethod(array $parameters) {
$validParameters = array('size');
$this->_compareParameters($parameters, $validParameters);
if (isset($parameters['size'])) {
$validSize = array(16, 24, 30, 40, 48, 64, 96, 128, 512);
$this->_validateInArray('size', $parameters['size'], $validSize);
}
}
/**
* Validate Retrieve Blogs Followers Parameters
*
* @param array $parameters
* @return void
*/
protected function _validateBlogsFollowersMethod(array $parameters) {
$validParameters = array('limit', 'offset');
$this->_compareParameters($parameters, $validParameters);
}
/**
* Validate Retrieve Published Posts Parameters
*
* @param array $parameters
* @return void
*/
protected function _validatePublishedPostsMethod(array $parameters) {
$validParameters = array('api_key', 'type', 'id', 'tag', 'limit',
'offset', 'reblog_info', 'notes_info', 'format');
$this->_compareParameters($parameters, $validParameters);
}
/**
* Validate Retrieve Users Dashboard Parameters
*
* @param array $parameters
* @return void
*/
protected function _validateUsersDashboardMethod(array $parameters) {
$validParameters = array('limit', 'offset', 'type', 'since_id', 'reblog_info', 'notes_info');
$this->_compareParameters($parameters, $validParameters);
if (isset($parameters['type'])) {
$validType = array('text', 'photo', 'quote', 'link', 'chat', 'audio', 'video', 'question');
$this->_validateInArray('type', $parameters['type'], $validType);
}
}
/**
* Validate Retrieve Users Likes Parameters
*
* @param array $parameters
* @return void
*/
protected function _validateUsersLikesMethod(array $parameters) {
$validParameters = array('limit', 'offset');
$this->_compareParameters($parameters, $validParameters);
}
/**
* Validate Retrieve Users Following Parameters
*
* @param array $parameters
* @return void
*/
protected function _validateUsersFollowingMethod(array $parameters) {
$validParameters = array('limit', 'offset');
$this->_compareParameters($parameters, $validParameters);
}
/**
* Utility function to check for a difference between two arrays
*
* @param array $parameters User parameters
* @param array $validParameters Valid parameters
* @return void
* @throws Exception
*/
protected function _compareParameters(array $parameters, array $validParameters) {
$difference = array_diff(array_keys($parameters), $validParameters);
if ($difference) {
throw new Exception('The following parameters are invalid: ' . implode(',', $difference));
}
}
/**
* Check that a named value is in the given array
*
* @param string $name Name associated with the value
* @param mixed $value Value
* @param array $array Array in which to check for the value
* @return void
* @throws Exception
*/
protected function _validateInArray($name, $value, array $array) {
if (! in_array($value, $array)) {
throw new Exception("Invalid value for parameter '$name': $value");
}
}
}