api.py 32.8 KB
Newer Older
1
2
3
4
# Tweepy
# Copyright 2009 Joshua Roesslein
# See LICENSE

5
6
7
import os
import mimetypes

Josh Roesslein's avatar
Josh Roesslein committed
8
9
from . binder import bind_api
from . error import TweepError
10
from . auth import BasicAuthHandler, OAuthHandler
Josh Roesslein's avatar
Josh Roesslein committed
11
from tweepy.parsers import *
12

Josh Roesslein's avatar
Josh Roesslein committed
13

14
class API(object):
Josh Roesslein's avatar
Josh Roesslein committed
15
16
17
    """Twitter API"""

    def __init__(self, auth_handler=None, host='twitter.com', cache=None,
18
19
            secure=False, api_root='', validate=True,
            retry_count=0, retry_delay=0):
Josh Roesslein's avatar
Josh Roesslein committed
20
21
22
23
24
25
26
        # you may access these freely
        self.auth_handler = auth_handler
        self.host = host
        self.api_root = api_root
        self.cache = cache
        self.secure = secure
        self.validate = validate
27
28
        self.retry_count = retry_count
        self.retry_delay = retry_delay
Josh Roesslein's avatar
Josh Roesslein committed
29
30
31
32
33
34
35
36
37
38
39
40
41

        # not a good idea to touch these
        self._username = None

    @staticmethod
    def new(auth='basic', *args, **kargs):
        if auth == 'basic':
            return API(BasicAuthHandler(*args, **kargs))
        elif auth == 'oauth':
            return API(OAuthHandler(*args, **kargs))
        else:
            raise TweepError('Invalid auth type')

42
43
44
45
46
47
48
49
50
51
52
    """ statuses/public_timeline

        Returns the 20 most recent statuses from non-protected users who
        have set a custom user icon. The public timeline is cached for 60 
        seconds so requesting it more often than that is a waste of resources.

        Parameters: None
        Returns: list[Status]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-public_timeline
	"""
Josh Roesslein's avatar
Josh Roesslein committed
53
54
55
56
57
58
    public_timeline = bind_api(
        path = '/statuses/public_timeline.json',
        parser = parse_statuses,
        allowed_param = []
    )

59
60
61
62
63
64
65
66
67
68
69
    """ statuses/home_timeline [Coming soon]

        Returns the 20 most recent statuses, including retweets, posted
        by the authenticating user and that user's friends. This is the
        equivalent of /timeline/home on the Web.

        Parameters: since_id, max_id, count, page
        Returns: list[Status]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-home_timeline
    """
Josh Roesslein's avatar
Josh Roesslein committed
70
71
72
73
74
75
76
    home_timeline = bind_api(
        path = '/statuses/home_timeline.json',
        parser = parse_statuses,
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

77
78
79
80
81
82
83
84
85
86
    """ statuses/friends_timeline

        Returns the 20 most recent statuses posted by the
        authenticating user and that user's friends.

        Parameters: since_id, max_id, count, page
        Returns: list[Status]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-friends_timeline
    """
Josh Roesslein's avatar
Josh Roesslein committed
87
88
89
90
91
92
93
    friends_timeline = bind_api(
        path = '/statuses/friends_timeline.json',
        parser = parse_statuses,
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

94
95
96
97
98
99
100
101
102
103
104
    """ statuses/user_timeline

        Returns the 20 most recent statuses posted from the
        authenticating user. It's also possible to request another
        user's timeline via the id parameter.

        Parameters: (id or user_id or screen_name), since_id, max_id, count, page
        Returns: list[Status]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-user_timeline
    """
Josh Roesslein's avatar
Josh Roesslein committed
105
106
107
108
109
110
111
    user_timeline = bind_api(
        path = '/statuses/user_timeline.json',
        parser = parse_statuses,
        allowed_param = ['id', 'user_id', 'screen_name', 'since_id',
                          'max_id', 'count', 'page']
    )

112
113
114
115
116
117
118
119
120
121
    """ statuses/mentions

        Returns the 20 most recent mentions (status containing @username)
        for the authenticating user.

        Parameters: since_id, max_id, count, page
        Returns: list[Status]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-mentions
    """
Josh Roesslein's avatar
Josh Roesslein committed
122
123
124
125
126
127
128
    mentions = bind_api(
        path = '/statuses/mentions.json',
        parser = parse_statuses,
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

129
130
131
132
133
134
135
136
137
    """ statuses/retweeted_by_me [Coming soon]

        Returns the 20 most recent retweets posted by the authenticating user.

        Parameters: since_id, max_id, count, page
        Returns: list[Status]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-retweeted_by_me
    """
Josh Roesslein's avatar
Josh Roesslein committed
138
139
140
141
142
143
144
    retweeted_by_me = bind_api(
        path = '/statuses/retweeted_by_me.json',
        parser = parse_statuses,
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

145
146
147
148
149
150
151
152
153
154
    """ statuses/retweeted_to_me

        Returns the 20 most recent retweets posted by the
        authenticating user's friends.

        Parameters: since_id, max_id, count, page
        Returns: list[Status]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-retweeted_to_me
    """
Josh Roesslein's avatar
Josh Roesslein committed
155
156
157
158
159
160
161
    retweeted_to_me = bind_api(
        path = '/statuses/retweeted_to_me.json',
        parser = parse_statuses,
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

162
163
164
165
166
167
168
169
170
171
    """ statuses/retweets_of_me

        Returns the 20 most recent tweets of the authenticated
        user that have been retweeted by others.

        Parameters: since_id, max_id, count, page
        Returns: list[Status]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-retweets_of_me
    """
Josh Roesslein's avatar
Josh Roesslein committed
172
173
174
175
176
177
178
    retweets_of_me = bind_api(
        path = '/statuses/retweets_of_me.json',
        parser = parse_statuses,
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

179
180
181
182
183
184
185
186
187
188
    """ statuses/show

        Returns a single status, specified by the id parameter below.
        The status's author will be returned inline.

        Parameters: id (Required)
        Returns: Status

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses%C2%A0show
    """
Josh Roesslein's avatar
Josh Roesslein committed
189
190
191
192
193
194
    get_status = bind_api(
        path = '/statuses/show.json',
        parser = parse_status,
        allowed_param = ['id']
    )

195
196
197
198
199
200
201
202
203
204
205
    """ statuses/update [Geolocation parameters coming soon]

        Updates the authenticating user's status.
        A status update with text identical to the authenticating user's
        current status will be ignored to prevent duplicates.

        Parameters: status (Required), in_reply_to_status_id, lat, long
        Returns: Status

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses%C2%A0update
    """
Josh Roesslein's avatar
Josh Roesslein committed
206
207
208
209
    update_status = bind_api(
        path = '/statuses/update.json',
        method = 'POST',
        parser = parse_status,
210
        allowed_param = ['status', 'in_reply_to_status_id', 'lat', 'long'],
Josh Roesslein's avatar
Josh Roesslein committed
211
212
213
        require_auth = True
    )

214
215
216
217
218
219
220
221
    """ statuses/destroy

        Destroys the status specified by the required ID parameter.
        The authenticating user must be the author of the specified status.

        Parameters: id (Required)
        Returns: Status
    """
Josh Roesslein's avatar
Josh Roesslein committed
222
223
224
225
226
227
228
229
    destroy_status = bind_api(
        path = '/statuses/destroy.json',
        method = 'DELETE',
        parser = parse_status,
        allowed_param = ['id'],
        require_auth = True
    )

230
231
232
233
234
235
236
237
238
239
    """ statuses/retweet [Coming soon]

        Retweets a tweet. Requires the id parameter of the tweet you are
        retweeting. Returns the original tweet with retweet details.

        Parameters: id (Required)
        Returns: Status

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-retweet
    """
Josh Roesslein's avatar
Josh Roesslein committed
240
241
242
243
244
245
246
247
    retweet = bind_api(
        path = '/statuses/retweet/id.json',
        method = 'POST',
        parser = parse_status,
        allowed_param = ['id'],
        require_auth = True
    )

248
249
250
251
252
253
254
255
256
    """ statuses/retweets [Coming soon]

        Returns up to 100 of the first retweets of a given tweet.

        Parameters: id (Required), count
        Returns: Retweet

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-retweets
    """
257
258
259
260
261
262
263
264
    def retweets(self, id, *args, **kargs):
        return bind_api(
            path = '/statuses/retweets/%s.json' % id,
            parser = parse_retweets,
            allowed_param = ['count'],
            require_auth = True
        )(self, *args, **kargs)

265
266
267
268
269
270
271
272
273
274
    """ users/show

        Returns extended information of a given user, specified by ID or
        screen name as per the required id parameter.

        Parameters: id or user_id or screen_name (One of these is required)
        Returns: User

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-users%C2%A0show
    """
Josh Roesslein's avatar
Josh Roesslein committed
275
276
277
278
279
280
    get_user = bind_api(
        path = '/users/show.json',
        parser = parse_user,
        allowed_param = ['id', 'user_id', 'screen_name']
    )

281
282
283
284
285
286
287
288
289
    """ Get the authenticated user

        Equivalent of calling API.get_user(authenticated_user_name)

        Parameters: None
        Returns: User

        See: API.get_user()
    """
Josh Roesslein's avatar
Josh Roesslein committed
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
    def me(self):
        # if username not fetched, go get it...
        if self._username is None:
            if self.auth_handler is None:
                raise TweepError('Authentication required')

            try:
                user = bind_api(
                    path = '/account/verify_credentials.json',
                    parser = parse_user
                )(self)
            except TweepError, e:
                raise TweepError('Failed to fetch username: %s' % e)

            self._username = user.screen_name

        return self.get_user(screen_name=self._username)

308
309
310
311
312
313
314
315
316
317
318
    """ statuses/friends

        Returns a user's friends. They are ordered by the order in
        which they were added as friends, 100 at a time.
        (Please note that the result set isn't guaranteed to be 100
        every time as suspended users will be filtered out.)
        Use the page option to access older friends. With no user specified,
        request defaults to the authenticated user's friends. It's also
        possible to request another user's friends list via the id,
        screen_name or user_id parameter.

319
        Parameters: (id or user_id or screen_name), page (deprecated), cursor
320
321
322
323
        Returns: list[Users]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses%C2%A0friends
    """
Josh Roesslein's avatar
Josh Roesslein committed
324
325
326
    friends = bind_api(
        path = '/statuses/friends.json',
        parser = parse_users,
327
        allowed_param = ['id', 'user_id', 'screen_name', 'page', 'cursor']
Josh Roesslein's avatar
Josh Roesslein committed
328
329
    )

330
331
332
333
334
335
336
337
    """ statuses/followers

        Returns the authenticating user's followers.They are ordered by
        the order in which they joined Twitter, 100 at a time.
        (Please note that the result set isn't guaranteed to be 100 every
        time as suspended users will be filtered out.)
        Use the page option to access earlier followers.

338
        Parameters: (id or user_id or screen_name), page (deprecated), cursor
339
340
341
342
        Returns: list[User]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses%C2%A0followers
    """
Josh Roesslein's avatar
Josh Roesslein committed
343
344
345
    followers = bind_api(
        path = '/statuses/followers.json',
        parser = parse_users,
346
        allowed_param = ['id', 'user_id', 'screen_name', 'page', 'cursor'],
Josh Roesslein's avatar
Josh Roesslein committed
347
348
349
        require_auth = True
    )

350
351
352
353
354
355
356
357
358
359
    """ direct_messages

        Returns a list of the 20 most recent direct messages sent
        to the authenticating user.

        Parameters: since_id, max_id, count, page
        Returns: list[DirectMessage]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-direct_messages
    """
Josh Roesslein's avatar
Josh Roesslein committed
360
361
362
363
364
365
366
    direct_messages = bind_api(
        path = '/direct_messages.json',
        parser = parse_directmessages,
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

367
368
369
370
371
372
373
374
375
376
    """ direct_messages/sent

        Returns a list of the 20 most recent direct messages sent
        by the authenticating user.

        Parameters: since_id, max_id, count, page
        Returns: list[DirectMessage]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-direct_messages%C2%A0sent
    """
Josh Roesslein's avatar
Josh Roesslein committed
377
378
379
380
381
382
    sent_direct_messages = bind_api(
        path = '/direct_messages/sent.json',
        parser = parse_directmessages,
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )
383

384
385
386
387
388
389
390
391
392
393
    """ direct_messages/new

        Sends a new direct message to the specified user from
        the authenticating user.

        Parameters: user (Required), text (Required)
        Returns: DirectMessage

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-direct_messages%C2%A0new
    """
Josh Roesslein's avatar
Josh Roesslein committed
394
395
    send_direct_message = bind_api(
        path = '/direct_messages/new.json',
396
        method = 'POST',
Josh Roesslein's avatar
Josh Roesslein committed
397
398
        parser = parse_dm,
        allowed_param = ['user', 'text'],
399
        require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
400
    )
401

402
403
404
405
406
407
408
409
410
411
412
    """ direct_messages/destroy

        Destroys the direct message specified in the required ID parameter.
        The authenticating user must be the recipient of the
        specified direct message.

        Parameters: id (Required)
        Returns: DirectMessage

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-direct_messages%C2%A0destroy
    """
Josh Roesslein's avatar
Josh Roesslein committed
413
414
415
416
417
418
419
420
    destroy_direct_message = bind_api(
        path = '/direct_messages/destroy.json',
        method = 'DELETE',
        parser = parse_dm,
        allowed_param = ['id'],
        require_auth = True
    )

421
422
423
424
425
426
427
428
429
430
431
432
    """ friendships/create

        Allows the authenticating users to follow the user specified in
        the ID parameter.  Returns the befriended user when successful.

        Parameters:
            id or user_id or screen_name (One of these is required)
            follow
        Returns: User

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships%C2%A0create
    """
Josh Roesslein's avatar
Josh Roesslein committed
433
434
    create_friendship = bind_api(
        path = '/friendships/create.json',
435
        method = 'POST',
Josh Roesslein's avatar
Josh Roesslein committed
436
437
        parser = parse_user,
        allowed_param = ['id', 'user_id', 'screen_name', 'follow'],
438
        require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
439
440
    )

441
442
443
444
445
446
447
448
449
450
    """ friendships/destroy

        Allows the authenticating users to unfollow the user specified
        in the ID parameter.  Returns the unfollowed user when successful.

        Parameters: id or user_id or screen_name (One of these is required)
        Returns: User

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships%C2%A0destroy
    """
Josh Roesslein's avatar
Josh Roesslein committed
451
452
453
454
455
456
457
458
    destroy_friendship = bind_api(
        path = '/friendships/destroy.json',
        method = 'DELETE',
        parser = parse_user,
        allowed_param = ['id', 'user_id', 'screen_name'],
        require_auth = True
    )

459
460
461
462
463
464
465
466
467
    """ friendships/exists

        Tests for the existence of friendship between two users.

        Parameters: user_a (Required), user_b (Required)
        Returns: Boolean (True if user_a follows user_b, otherwise False)

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships-exists
    """
Josh Roesslein's avatar
Josh Roesslein committed
468
469
470
471
472
473
    exists_friendship = bind_api(
        path = '/friendships/exists.json',
        parser = parse_json,
        allowed_param = ['user_a', 'user_b']
    )

474
475
476
477
478
479
480
481
482
483
484
    """ friendships/show

        Returns detailed information about the relationship between two users.

        Parameters:
            source_id or source_screen_name (One of these is required)
            target_id or target_screen_name (One of these is required)
        Returns: tuple(Friendship - source, Friendship - target)

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friendships-show
    """
Josh Roesslein's avatar
Josh Roesslein committed
485
486
487
488
489
490
491
    show_friendship = bind_api(
        path = '/friendships/show.json',
        parser = parse_friendship,
        allowed_param = ['source_id', 'source_screen_name',
                          'target_id', 'target_screen_name']
    )

492
493
494
495
496
497
498
499
    """ friends/ids

        Returns an array of numeric IDs for every user the
        specified user is following.

        Parameters:
            id or user_id or screen_name (One of these is required)
            cursor
500
        Returns: list<int>
501
502
503

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-friends%C2%A0ids
    """
Josh Roesslein's avatar
Josh Roesslein committed
504
505
    friends_ids = bind_api(
        path = '/friends/ids.json',
506
        parser = parse_ids,
507
        allowed_param = ['id', 'user_id', 'screen_name', 'cursor']
Josh Roesslein's avatar
Josh Roesslein committed
508
509
    )

510
511
512
513
514
515
516
517
    """ followers/ids

        Returns an array of numeric IDs for every user following
        the specified user.

        Parameters:
            id or user_id or screen_name (One of these is required)
            cursor
518
        Returns: list<int>
519
520
521

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-followers%C2%A0ids
    """
Josh Roesslein's avatar
Josh Roesslein committed
522
523
    followers_ids = bind_api(
        path = '/followers/ids.json',
524
        parser = parse_ids,
525
        allowed_param = ['id', 'user_id', 'screen_name', 'cursor']
Josh Roesslein's avatar
Josh Roesslein committed
526
527
    )

528
529
530
531
532
533
534
535
536
537
538
539
    """ account/verify_credentials

        Use this method to test if supplied user credentials are valid.
        Because this method can be a vector for a brute force dictionary
        attack to determine a user's password, it is limited to 15 requests
        per 60 minute period (starting from your first request).

        Parameters: None
        Returns: True if credentials are valid, otherwise False

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0verify_credentials
    """
Josh Roesslein's avatar
Josh Roesslein committed
540
541
542
543
544
545
546
547
548
549
    def verify_credentials(self):
        try:
            return bind_api(
                path = '/account/verify_credentials.json',
                parser = parse_return_true,
                require_auth = True
            )(self)
        except TweepError:
            return False

550
551
552
553
554
555
556
557
558
559
560
561
562
563
    """ account/rate_limit_status

        Returns the remaining number of API requests available to the
        requesting user before the API limit is reached for the current hour.
        Calls to rate_limit_status do not count against the rate limit.
        If authentication credentials are provided, the rate limit status for
        the authenticating user is returned.  Otherwise, the rate limit status
        for the requester's IP address is returned.

        Parameters: None
        Returns: json object

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0rate_limit_status
    """
Josh Roesslein's avatar
Josh Roesslein committed
564
565
566
567
568
    rate_limit_status = bind_api(
        path = '/account/rate_limit_status.json',
        parser = parse_json
    )

569
570
571
572
573
574
575
576
577
578
579
    """ account/update_delivery_device

        Sets which device Twitter delivers updates to for the authenticating
        user.  Sending "none" as the device parameter will disable IM or SMS
        updates.

        Parameters: device (Required)
        Returns: User

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0update_delivery_device
    """
Josh Roesslein's avatar
Josh Roesslein committed
580
581
582
583
584
585
586
587
    set_delivery_device = bind_api(
        path = '/account/update_delivery_device.json',
        method = 'POST',
        allowed_param = ['device'],
        parser = parse_user,
        require_auth = True
    )

588
589
590
591
592
593
594
595
596
597
598
599
    """ account/update_profile_colors

        Sets one or more hex values that control the color scheme of the
        authenticating user's profile page on twitter.com.

        Parameters: profile_background_color, profile_text_color,
            profile_link_color, profile_sidebar_fill_color,
            profile_sidebar_border_color
        Returns: User

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0update_profile_colors
    """
Josh Roesslein's avatar
Josh Roesslein committed
600
601
602
603
604
605
606
607
608
609
    update_profile_colors = bind_api(
        path = '/account/update_profile_colors.json',
        method = 'POST',
        parser = parse_user,
        allowed_param = ['profile_background_color', 'profile_text_color',
                          'profile_link_color', 'profile_sidebar_fill_color',
                          'profile_sidebar_border_color'],
        require_auth = True
    )

610
611
612
613
614
615
616
617
618
619
    """ account/update_profile_image

        Updates the authenticating user's profile image.

        Parameters:
            filename - local file path to image (Required)
        Returns: User

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0update_profile_image
    """
Josh Roesslein's avatar
Josh Roesslein committed
620
621
622
623
624
625
626
627
628
    def update_profile_image(self, filename):
        headers, post_data = _pack_image(filename, 700)
        bind_api(
            path = '/account/update_profile_image.json',
            method = 'POST',
            parser = parse_none,
            require_auth = True
        )(self, post_data=post_data, headers=headers)

629
630
631
632
633
634
635
636
637
638
639
    """ account/update_profile_background_image

        Updates the authenticating user's profile background image.

        Parameters:
            filename - local file path to image (Required)
            tile
        Returns: User

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0update_profile_background_image
    """
Josh Roesslein's avatar
Josh Roesslein committed
640
641
642
643
644
645
646
647
648
649
    def update_profile_background_image(self, filename, *args, **kargs):
        headers, post_data = _pack_image(filename, 800)
        bind_api(
            path = '/account/update_profile_background_image.json',
            method = 'POST',
            parser = parse_none,
            allowed_param = ['tile'],
            require_auth = True
        )(self, post_data=post_data, headers=headers)

650
651
652
653
654
655
656
657
658
659
    """ account/update_profile

        Sets values that users are able to set under the "Account" tab of
        their settings page. Only the parameters specified will be updated.

        Parameters: name, email, url, location, description
        Returns: User

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-account%C2%A0update_profile
    """
Josh Roesslein's avatar
Josh Roesslein committed
660
661
662
663
664
    update_profile = bind_api(
        path = '/account/update_profile.json',
        method = 'POST',
        parser = parse_user,
        allowed_param = ['name', 'email', 'url', 'location', 'description'],
665
        require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
666
667
    )

668
669
670
671
672
673
674
675
676
677
    """ favorites

        Returns the 20 most recent favorite statuses for the authenticating
        user or user specified by the ID parameter.

        Parameters: id, page
        Returns: list[Status]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-favorites
    """
Josh Roesslein's avatar
Josh Roesslein committed
678
679
680
681
682
683
    favorites = bind_api(
        path = '/favorites.json',
        parser = parse_statuses,
        allowed_param = ['id', 'page']
    )

684
685
686
687
688
689
690
691
692
693
    """ favorites/create

        Favorites the status specified in the ID parameter as the
        authenticating user. Returns the favorite status when successful.

        Parameters: id (Required)
        Returns: Status

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-favorites%C2%A0create
    """
Josh Roesslein's avatar
Josh Roesslein committed
694
695
696
697
698
699
700
701
    create_favorite = bind_api(
        path = '/favorites/create.json',
        method = 'POST',
        parser = parse_status,
        allowed_param = ['id'],
        require_auth = True
    )

702
703
704
705
706
707
708
709
710
711
    """ favorites/destroy

        Un-favorites the status specified in the ID parameter as the
        authenticating user. Returns the un-favorited status.

        Parameters: id (Required)
        Returns: Status

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-favorites%C2%A0destroy
    """
Josh Roesslein's avatar
Josh Roesslein committed
712
713
    destroy_favorite = bind_api(
        path = '/favorites/destroy.json',
714
        method = 'DELETE',
Josh Roesslein's avatar
Josh Roesslein committed
715
        parser = parse_status,
716
717
        allowed_param = ['id'],
        require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
718
719
    )

720
721
722
723
724
725
726
727
728
729
    """ notifications/follow

        Enables device notifications for updates from the specified user.
        Returns the specified user when successful.

        Parameters: id or user_id or screen_name (One of these is required)
        Returns: User

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-notifications%C2%A0follow
    """
Josh Roesslein's avatar
Josh Roesslein committed
730
731
732
733
734
735
736
737
    enable_notifications = bind_api(
        path = '/notifications/follow.json',
        method = 'POST',
        parser = parse_user,
        allowed_param = ['id', 'user_id', 'screen_name'],
        require_auth = True
    )

738
739
740
741
742
743
744
745
746
747
    """ notifications/leave

        Disables notifications for updates from the specified user to the
        authenticating user.  Returns the specified user when successful.

        Parameters: id or user_id or screen_name (One of these is required)
        Returns: User

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-notifications%C2%A0leave
    """
Josh Roesslein's avatar
Josh Roesslein committed
748
749
750
751
752
753
754
755
    disable_notifications = bind_api(
        path = '/notifications/leave.json',
        method = 'POST',
        parser = parse_user,
        allowed_param = ['id', 'user_id', 'screen_name'],
        require_auth = True
    )

756
757
758
759
760
761
762
763
764
765
766
    """ blocks/create

        Blocks the user specified in the ID parameter as the authenticating
        user. Destroys a friendship to the blocked user if it exists.
        Returns the blocked user when successful.

        Parameters: id (Required)
        Returns: User

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks%C2%A0create
    """
Josh Roesslein's avatar
Josh Roesslein committed
767
768
769
770
771
772
773
774
    create_block = bind_api(
        path = '/blocks/create.json',
        method = 'POST',
        parser = parse_user,
        allowed_param = ['id'],
        require_auth = True
    )

775
776
777
778
779
780
781
782
783
784
    """ blocks/destroy

        Un-blocks the user specified in the ID parameter for the
        authenticating user. Returns the un-blocked user when successful.

        Parameters: id (Required)
        Returns: User

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks%C2%A0destroy
    """
Josh Roesslein's avatar
Josh Roesslein committed
785
786
787
788
789
790
791
792
    destroy_block = bind_api(
        path = '/blocks/destroy.json',
        method = 'DELETE',
        parser = parse_user,
        allowed_param = ['id'],
        require_auth = True
    )

793
794
795
796
797
798
799
800
801
    """ blocks/exists

        Checks if the authenticating user is blocking a target user.

        Parameters: id or user_id or screen_name (One of these is required)
        Returns: Boolean (True if blocked, otherwise False)

        http://apiwiki.twitter.com/Twitter+REST+API+Method%3A-blocks-exists
    """
Josh Roesslein's avatar
Josh Roesslein committed
802
803
804
805
806
807
808
809
810
811
812
813
814
    def exists_block(self, **kargs):
        try:
            bind_api(
                path = '/blocks/exists.json',
                parser = parse_none,
                allowed_param = ['id', 'user_id', 'screen_name'],
                require_auth = True
            )(self, **kargs)
        except TweepError:
            return False

        return True

815
816
817
818
819
820
821
822
823
824
    """ blocks/blocking

        Returns an array of user objects that the authenticating
        user is blocking.

        Parameters: page
        Returns: list[User]

        http://apiwiki.twitter.com/Twitter+REST+API+Method%3A-blocks-blocking
    """
Josh Roesslein's avatar
Josh Roesslein committed
825
826
827
828
829
830
831
    blocks = bind_api(
        path = '/blocks/blocking.json',
        parser = parse_users,
        allowed_param = ['page'],
        require_auth = True
    )

832
833
834
835
836
837
838
839
840
841
    """ blocks/blocking/ids

        Returns an array of numeric user ids the authenticating
        user is blocking.

        Parameters: None
        Returns: json object

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-blocks-blocking-ids
    """
Josh Roesslein's avatar
Josh Roesslein committed
842
843
844
845
846
847
    blocks_ids = bind_api(
        path = '/blocks/blocking/ids.json',
        parser = parse_json,
        require_auth = True
    )

848
849
850
851
852
853
854
855
856
    """ saved_searches

        Returns the authenticated user's saved search queries.

        Parameters: None
        Returns: list[SavedSearch]

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-saved_searches
    """
Josh Roesslein's avatar
Josh Roesslein committed
857
858
859
860
861
862
    saved_searches = bind_api(
        path = '/saved_searches.json',
        parser = parse_saved_searches,
        require_auth = True
    )

863
864
865
866
867
868
869
870
871
872
    """ saved_searches/show

        Retrieve the data for a saved search owned by the
        authenticating user specified by the given id.

        Parameters: id (Required)
        Returns: SavedSearch

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-saved_searches-show
    """
Josh Roesslein's avatar
Josh Roesslein committed
873
874
875
876
877
878
879
    def get_saved_search(self, id):
        return bind_api(
            path = '/saved_searches/show/%s.json' % id,
            parser = parse_saved_search,
            require_auth = True
        )(self)

880
881
882
883
884
885
886
887
888
    """ saved_searches/create

        Creates a saved search for the authenticated user.

        Parameters: query (Required)
        Returns: SavedSearch

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-saved_searches-create
    """
Josh Roesslein's avatar
Josh Roesslein committed
889
890
891
892
893
894
895
896
    create_saved_search = bind_api(
        path = '/saved_searches/create.json',
        method = 'POST',
        parser = parse_saved_search,
        allowed_param = ['query'],
        require_auth = True
    )

897
898
899
900
901
902
903
904
905
906
    """ saved_searches/destroy

        Destroys a saved search for the authenticated user.
        The search specified by id must be owned by the authenticating user.

        Parameters: id (Required)
        Returns: SavedSearch

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-saved_searches-destroy
    """
Josh Roesslein's avatar
Josh Roesslein committed
907
908
909
910
911
912
913
914
915
    def destroy_saved_search(self, id):
        return bind_api(
            path = '/saved_searches/destroy/%s.json' % id,
            method = 'DELETE',
            parser = parse_saved_search,
            allowed_param = ['id'],
            require_auth = True
        )(self)

916
917
918
919
920
921
922
923
924
    """ help/test

        Invokes the test method in the Twitter API.

        Parameters: None
        Returns: Boolean (True if 200 status code returned, otherwise False)

        http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-help%C2%A0test
    """
Josh Roesslein's avatar
Josh Roesslein committed
925
    def test(self):
926
927
928
929
930
931
932
933
934
        try:
            return bind_api(
                path = '/help/test.json',
                parser = parse_return_true
            )(self)
        except TweepError:
            return False

    """ search
Josh Roesslein's avatar
Josh Roesslein committed
935

936
937
938
939
940
941
942
943
        Returns tweets that match a specified query.

        Parameters: q (Required), lang, locale, rpp, page, since_id
            geocode, show_user
        Returns: list[SearchResult]

        http://apiwiki.twitter.com/Twitter-Search-API-Method%3A-search
    """
Josh Roesslein's avatar
Josh Roesslein committed
944
945
946
947
948
949

    def search(self, *args, **kargs):
        return bind_api(
            host = 'search.' + self.host,
            path = '/search.json',
            parser = parse_search_results,
950
            allowed_param = ['q', 'lang', 'locale', 'rpp', 'page', 'since_id', 'geocode', 'show_user'],
Josh Roesslein's avatar
Josh Roesslein committed
951
        )(self, *args, **kargs)
952
    search.pagination_mode = 'page'
Josh Roesslein's avatar
Josh Roesslein committed
953

954
955
956
957
958
959
960
961
962
963
964
    """ trends

        Returns the top ten topics that are currently trending on Twitter.
        The response includes the time of the request, the name of each trend,
        and the url to the Twitter Search results page for that topic.

        Parameters: None
        Returns: json object

        http://apiwiki.twitter.com/Twitter-Search-API-Method%3A-trends
    """
Josh Roesslein's avatar
Josh Roesslein committed
965
966
967
968
    def trends(self):
        return bind_api(
            host = 'search.' + self.host,
            path = '/trends.json',
969
            parser = parse_json
Josh Roesslein's avatar
Josh Roesslein committed
970
971
        )(self)

972
973
974
975
976
977
978
979
980
981
982
983
    """ trends/current

        Returns the current top 10 trending topics on Twitter.
        The response includes the time of the request, the name of each
        trending topic, and query used on Twitter Search results
        page for that topic.

        Parameters: exclude
        Returns: json object

        http://apiwiki.twitter.com/Twitter-Search-API-Method%3A-trends-current
    """
984
985
986
987
988
989
990
991
    def trends_current(self, *args, **kargs):
        return bind_api(
            host = 'search.' + self.host,
            path = '/trends/current.json',
            parser = parse_json,
            allowed_param = ['exclude']
        )(self, *args, **kargs)

992
993
994
995
996
997
998
999
1000
    """ trends/daily

        Returns the top 20 trending topics for each hour in a given day.

        Parameters: date, exclude
        Returns: json object

        http://apiwiki.twitter.com/Twitter-Search-API-Method%3A-trends-daily
    """
1001
1002
1003
1004
1005
1006
1007
1008
    def trends_daily(self, *args, **kargs):
        return bind_api(
            host = "search." + self.host,
            path = '/trends/daily.json',
            parser = parse_json,
            allowed_param = ['date', 'exclude']
        )(self, *args, **kargs)

1009
1010
1011
1012
1013
1014
1015
1016
1017
    """ trends/weekly

        Returns the top 30 trending topics for each day in a given week.

        Parameters: date, exclude
        Returns: json object

        http://apiwiki.twitter.com/Twitter-Search-API-Method%3A-trends-weekly
    """
1018
1019
1020
1021
1022
1023
1024
1025
    def trends_weekly(self, *args, **kargs):
        return bind_api(
            host = "search." + self.host,
            path = '/trends/weekly.json',
            parser = parse_json,
            allowed_param = ['date', 'exclude']
        )(self, *args, **kargs)

1026
1027
    """ Internal use only """

Josh Roesslein's avatar
Josh Roesslein committed
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
    def _pack_image(filename, max_size):
        """Pack image from file into multipart-formdata post body"""
        # image must be less than 700kb in size
        try:
            if os.path.getsize(filename) > (max_size * 1024):
                raise TweepError('File is too big, must be less than 700kb.')
        except os.error, e:
            raise TweepError('Unable to access file')

        # image must be gif, jpeg, or png
        file_type = mimetypes.guess_type(filename)
        if file_type is None:
            raise TweepError('Could not determine file type')
        file_type = file_type[0]
        if file_type not in ['image/gif', 'image/jpeg', 'image/png']:
            raise TweepError('Invalid file type for image: %s' % file_type)

        # build the mulitpart-formdata body
        fp = open(filename, 'rb')
        BOUNDARY = 'Tw3ePy'
        body = []
        body.append('--' + BOUNDARY)
        body.append('Content-Disposition: form-data; name="image"; filename="%s"' % filename)
        body.append('Content-Type: %s' % file_type)
        body.append('')
        body.append(fp.read())
        body.append('--' + BOUNDARY + '--')
        body.append('')
        fp.close()
        body = '\r\n'.join(body)

        # build headers
        headers = {
            'Content-Type': 'multipart/form-data; boundary=Tw3ePy',
            'Content-Length': len(body)
        }

        return headers, body
1066