api.py 21.9 KB
Newer Older
1
# Tweepy
2
3
# Copyright 2009-2010 Joshua Roesslein
# See LICENSE for details.
4

5
6
7
import os
import mimetypes

Josh Roesslein's avatar
Josh Roesslein committed
8
9
from tweepy.binder import bind_api
from tweepy.error import TweepError
10
from tweepy.parsers import ModelParser
11
from tweepy.utils import list_to_csv
12

Josh Roesslein's avatar
Josh Roesslein committed
13

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

17
18
19
    def __init__(self, auth_handler=None,
            host='api.twitter.com', search_host='search.twitter.com',
             cache=None, secure=False, api_root='/1', search_root='',
20
            retry_count=0, retry_delay=0, retry_errors=None,
21
            parser=None):
Josh Roesslein's avatar
Josh Roesslein committed
22
        self.auth = auth_handler
Josh Roesslein's avatar
Josh Roesslein committed
23
        self.host = host
24
        self.search_host = search_host
Josh Roesslein's avatar
Josh Roesslein committed
25
        self.api_root = api_root
26
        self.search_root = search_root
Josh Roesslein's avatar
Josh Roesslein committed
27
28
        self.cache = cache
        self.secure = secure
29
30
        self.retry_count = retry_count
        self.retry_delay = retry_delay
31
        self.retry_errors = retry_errors
32
        self.parser = parser or ModelParser()
Josh Roesslein's avatar
Josh Roesslein committed
33

34
    """ statuses/public_timeline """
Josh Roesslein's avatar
Josh Roesslein committed
35
36
    public_timeline = bind_api(
        path = '/statuses/public_timeline.json',
37
        payload_type = 'status', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
38
39
40
        allowed_param = []
    )

Ferenc Szalai's avatar
Ferenc Szalai committed
41
    """ statuses/home_timeline """
Josh Roesslein's avatar
Josh Roesslein committed
42
43
    home_timeline = bind_api(
        path = '/statuses/home_timeline.json',
44
        payload_type = 'status', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
45
46
47
48
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

49
    """ statuses/friends_timeline """
Josh Roesslein's avatar
Josh Roesslein committed
50
51
    friends_timeline = bind_api(
        path = '/statuses/friends_timeline.json',
52
        payload_type = 'status', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
53
54
55
56
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

57
    """ statuses/user_timeline """
Josh Roesslein's avatar
Josh Roesslein committed
58
59
    user_timeline = bind_api(
        path = '/statuses/user_timeline.json',
60
        payload_type = 'status', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
61
62
63
64
        allowed_param = ['id', 'user_id', 'screen_name', 'since_id',
                          'max_id', 'count', 'page']
    )

65
    """ statuses/mentions """
Josh Roesslein's avatar
Josh Roesslein committed
66
67
    mentions = bind_api(
        path = '/statuses/mentions.json',
68
        payload_type = 'status', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
69
70
71
72
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
    """/statuses/:id/retweeted_by.format"""
    retweeted_by = bind_api(
        path = '/statuses/{id}/retweeted_by.json',
        payload_type = 'status', payload_list = True,
        allowed_param = ['id', 'count', 'page'],
        require_auth = True
    )

    """/statuses/:id/retweeted_by/ids.format"""
    retweeted_by_ids = bind_api(
        path = '/statuses/{id}/retweeted_by/ids.json',
        payload_type = 'ids',
        allowed_param = ['id', 'count', 'page'],
        require_auth = True
    )

Ferenc Szalai's avatar
Ferenc Szalai committed
89
    """ statuses/retweeted_by_me """
Josh Roesslein's avatar
Josh Roesslein committed
90
91
    retweeted_by_me = bind_api(
        path = '/statuses/retweeted_by_me.json',
92
        payload_type = 'status', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
93
94
95
96
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

97
    """ statuses/retweeted_to_me """
Josh Roesslein's avatar
Josh Roesslein committed
98
99
    retweeted_to_me = bind_api(
        path = '/statuses/retweeted_to_me.json',
100
        payload_type = 'status', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
101
102
103
104
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

105
    """ statuses/retweets_of_me """
Josh Roesslein's avatar
Josh Roesslein committed
106
107
    retweets_of_me = bind_api(
        path = '/statuses/retweets_of_me.json',
108
        payload_type = 'status', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
109
110
111
112
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

113
    """ statuses/show """
Josh Roesslein's avatar
Josh Roesslein committed
114
115
    get_status = bind_api(
        path = '/statuses/show.json',
116
        payload_type = 'status',
Josh Roesslein's avatar
Josh Roesslein committed
117
118
119
        allowed_param = ['id']
    )

Ferenc Szalai's avatar
Ferenc Szalai committed
120
    """ statuses/update """
Josh Roesslein's avatar
Josh Roesslein committed
121
122
123
    update_status = bind_api(
        path = '/statuses/update.json',
        method = 'POST',
124
        payload_type = 'status',
125
        allowed_param = ['status', 'in_reply_to_status_id', 'lat', 'long', 'source', 'place_id'],
Josh Roesslein's avatar
Josh Roesslein committed
126
127
128
        require_auth = True
    )

129
    """ statuses/destroy """
Josh Roesslein's avatar
Josh Roesslein committed
130
131
132
    destroy_status = bind_api(
        path = '/statuses/destroy.json',
        method = 'DELETE',
133
        payload_type = 'status',
Josh Roesslein's avatar
Josh Roesslein committed
134
135
136
137
        allowed_param = ['id'],
        require_auth = True
    )

Ferenc Szalai's avatar
Ferenc Szalai committed
138
    """ statuses/retweet """
139
140
141
    retweet = bind_api(
        path = '/statuses/retweet/{id}.json',
        method = 'POST',
142
        payload_type = 'status',
143
144
145
        allowed_param = ['id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
146

Ferenc Szalai's avatar
Ferenc Szalai committed
147
    """ statuses/retweets """
148
149
    retweets = bind_api(
        path = '/statuses/retweets/{id}.json',
150
        payload_type = 'status', payload_list = True,
151
152
153
        allowed_param = ['id', 'count'],
        require_auth = True
    )
154

155
    """ users/show """
Josh Roesslein's avatar
Josh Roesslein committed
156
157
    get_user = bind_api(
        path = '/users/show.json',
158
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
159
160
161
        allowed_param = ['id', 'user_id', 'screen_name']
    )

162
163
164
165
166
167
168
169
170
171
172
    """ Perform bulk look up of users from user ID or screenname """
    def lookup_users(self, user_ids=None, screen_names=None):
        return self._lookup_users(list_to_csv(user_ids), list_to_csv(screen_names))

    _lookup_users = bind_api(
        path = '/users/lookup.json',
        payload_type = 'user', payload_list = True,
        allowed_param = ['user_id', 'screen_name'],
        require_auth = True
    )

173
    """ Get the authenticated user """
Josh Roesslein's avatar
Josh Roesslein committed
174
    def me(self):
Josh Roesslein's avatar
Josh Roesslein committed
175
        return self.get_user(screen_name=self.auth.get_username())
Josh Roesslein's avatar
Josh Roesslein committed
176

177
178
179
    """ users/search """
    search_users = bind_api(
        path = '/users/search.json',
180
        payload_type = 'user', payload_list = True,
181
182
183
184
        require_auth = True,
        allowed_param = ['q', 'per_page', 'page']
    )

185
    """ statuses/friends """
Josh Roesslein's avatar
Josh Roesslein committed
186
187
    friends = bind_api(
        path = '/statuses/friends.json',
188
        payload_type = 'user', payload_list = True,
189
        allowed_param = ['id', 'user_id', 'screen_name', 'page', 'cursor']
Josh Roesslein's avatar
Josh Roesslein committed
190
191
    )

192
    """ statuses/followers """
Josh Roesslein's avatar
Josh Roesslein committed
193
194
    followers = bind_api(
        path = '/statuses/followers.json',
195
        payload_type = 'user', payload_list = True,
196
        allowed_param = ['id', 'user_id', 'screen_name', 'page', 'cursor']
Josh Roesslein's avatar
Josh Roesslein committed
197
198
    )

199
    """ direct_messages """
Josh Roesslein's avatar
Josh Roesslein committed
200
201
    direct_messages = bind_api(
        path = '/direct_messages.json',
202
        payload_type = 'direct_message', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
203
204
205
206
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )

207
    """ direct_messages/sent """
Josh Roesslein's avatar
Josh Roesslein committed
208
209
    sent_direct_messages = bind_api(
        path = '/direct_messages/sent.json',
210
        payload_type = 'direct_message', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
211
212
213
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )
214

215
    """ direct_messages/new """
Josh Roesslein's avatar
Josh Roesslein committed
216
217
    send_direct_message = bind_api(
        path = '/direct_messages/new.json',
218
        method = 'POST',
219
        payload_type = 'direct_message',
220
        allowed_param = ['user', 'screen_name', 'user_id', 'text'],
221
        require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
222
    )
223

224
    """ direct_messages/destroy """
Josh Roesslein's avatar
Josh Roesslein committed
225
226
227
    destroy_direct_message = bind_api(
        path = '/direct_messages/destroy.json',
        method = 'DELETE',
228
        payload_type = 'direct_message',
Josh Roesslein's avatar
Josh Roesslein committed
229
230
231
232
        allowed_param = ['id'],
        require_auth = True
    )

233
    """ friendships/create """
Josh Roesslein's avatar
Josh Roesslein committed
234
235
    create_friendship = bind_api(
        path = '/friendships/create.json',
236
        method = 'POST',
237
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
238
        allowed_param = ['id', 'user_id', 'screen_name', 'follow'],
239
        require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
240
241
    )

242
    """ friendships/destroy """
Josh Roesslein's avatar
Josh Roesslein committed
243
244
245
    destroy_friendship = bind_api(
        path = '/friendships/destroy.json',
        method = 'DELETE',
246
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
247
248
249
250
        allowed_param = ['id', 'user_id', 'screen_name'],
        require_auth = True
    )

251
    """ friendships/exists """
Josh Roesslein's avatar
Josh Roesslein committed
252
253
    exists_friendship = bind_api(
        path = '/friendships/exists.json',
254
        payload_type = 'json',
Josh Roesslein's avatar
Josh Roesslein committed
255
256
257
        allowed_param = ['user_a', 'user_b']
    )

258
    """ friendships/show """
Josh Roesslein's avatar
Josh Roesslein committed
259
260
    show_friendship = bind_api(
        path = '/friendships/show.json',
261
        payload_type = 'friendship',
Josh Roesslein's avatar
Josh Roesslein committed
262
263
264
265
        allowed_param = ['source_id', 'source_screen_name',
                          'target_id', 'target_screen_name']
    )

266
    """ friends/ids """
Josh Roesslein's avatar
Josh Roesslein committed
267
268
    friends_ids = bind_api(
        path = '/friends/ids.json',
269
        payload_type = 'ids',
270
        allowed_param = ['id', 'user_id', 'screen_name', 'cursor']
Josh Roesslein's avatar
Josh Roesslein committed
271
272
    )

273
274
275
276
277
278
279
280
281
282
283
284
285
286
    """ friendships/incoming """
    friendships_incoming = bind_api(
        path = '/friendships/incoming.json',
        payload_type = 'ids',
        allowed_param = ['cursor']
    )

    """ friendships/outgoing"""
    friendships_outgoing = bind_api(
        path = '/friendships/outgoing.json',
        payload_type = 'ids',
        allowed_param = ['cursor']
    )

287
    """ followers/ids """
Josh Roesslein's avatar
Josh Roesslein committed
288
289
    followers_ids = bind_api(
        path = '/followers/ids.json',
290
        payload_type = 'ids',
291
        allowed_param = ['id', 'user_id', 'screen_name', 'cursor']
Josh Roesslein's avatar
Josh Roesslein committed
292
293
    )

294
    """ account/verify_credentials """
Josh Roesslein's avatar
Josh Roesslein committed
295
296
297
298
    def verify_credentials(self):
        try:
            return bind_api(
                path = '/account/verify_credentials.json',
299
                payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
300
301
302
303
304
                require_auth = True
            )(self)
        except TweepError:
            return False

305
    """ account/rate_limit_status """
Josh Roesslein's avatar
Josh Roesslein committed
306
307
    rate_limit_status = bind_api(
        path = '/account/rate_limit_status.json',
308
        payload_type = 'json'
Josh Roesslein's avatar
Josh Roesslein committed
309
310
    )

311
    """ account/update_delivery_device """
Josh Roesslein's avatar
Josh Roesslein committed
312
313
314
315
    set_delivery_device = bind_api(
        path = '/account/update_delivery_device.json',
        method = 'POST',
        allowed_param = ['device'],
316
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
317
318
319
        require_auth = True
    )

320
    """ account/update_profile_colors """
Josh Roesslein's avatar
Josh Roesslein committed
321
322
323
    update_profile_colors = bind_api(
        path = '/account/update_profile_colors.json',
        method = 'POST',
324
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
325
326
327
328
329
330
        allowed_param = ['profile_background_color', 'profile_text_color',
                          'profile_link_color', 'profile_sidebar_fill_color',
                          'profile_sidebar_border_color'],
        require_auth = True
    )

331
    """ account/update_profile_image """
Josh Roesslein's avatar
Josh Roesslein committed
332
    def update_profile_image(self, filename):
Josh Roesslein's avatar
Josh Roesslein committed
333
        headers, post_data = API._pack_image(filename, 700)
Josh Roesslein's avatar
Josh Roesslein committed
334
        return bind_api(
Josh Roesslein's avatar
Josh Roesslein committed
335
336
            path = '/account/update_profile_image.json',
            method = 'POST',
337
            payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
338
339
340
            require_auth = True
        )(self, post_data=post_data, headers=headers)

341
    """ account/update_profile_background_image """
Josh Roesslein's avatar
Josh Roesslein committed
342
    def update_profile_background_image(self, filename, *args, **kargs):
Josh Roesslein's avatar
Josh Roesslein committed
343
        headers, post_data = API._pack_image(filename, 800)
Josh Roesslein's avatar
Josh Roesslein committed
344
345
346
        bind_api(
            path = '/account/update_profile_background_image.json',
            method = 'POST',
347
            payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
348
349
350
351
            allowed_param = ['tile'],
            require_auth = True
        )(self, post_data=post_data, headers=headers)

352
    """ account/update_profile """
Josh Roesslein's avatar
Josh Roesslein committed
353
354
355
    update_profile = bind_api(
        path = '/account/update_profile.json',
        method = 'POST',
356
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
357
        allowed_param = ['name', 'url', 'location', 'description'],
358
        require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
359
360
    )

361
    """ favorites """
Josh Roesslein's avatar
Josh Roesslein committed
362
363
    favorites = bind_api(
        path = '/favorites.json',
364
        payload_type = 'status', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
365
366
367
        allowed_param = ['id', 'page']
    )

368
    """ favorites/create """
369
370
371
    create_favorite = bind_api(
        path = '/favorites/create/{id}.json',
        method = 'POST',
372
        payload_type = 'status',
373
374
375
        allowed_param = ['id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
376

377
    """ favorites/destroy """
378
379
380
    destroy_favorite = bind_api(
        path = '/favorites/destroy/{id}.json',
        method = 'DELETE',
381
        payload_type = 'status',
382
383
384
        allowed_param = ['id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
385

386
    """ notifications/follow """
Josh Roesslein's avatar
Josh Roesslein committed
387
388
389
    enable_notifications = bind_api(
        path = '/notifications/follow.json',
        method = 'POST',
390
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
391
392
393
394
        allowed_param = ['id', 'user_id', 'screen_name'],
        require_auth = True
    )

395
    """ notifications/leave """
Josh Roesslein's avatar
Josh Roesslein committed
396
397
398
    disable_notifications = bind_api(
        path = '/notifications/leave.json',
        method = 'POST',
399
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
400
401
402
403
        allowed_param = ['id', 'user_id', 'screen_name'],
        require_auth = True
    )

404
    """ blocks/create """
Josh Roesslein's avatar
Josh Roesslein committed
405
406
407
    create_block = bind_api(
        path = '/blocks/create.json',
        method = 'POST',
408
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
409
        allowed_param = ['id', 'user_id', 'screen_name'],
Josh Roesslein's avatar
Josh Roesslein committed
410
411
412
        require_auth = True
    )

413
    """ blocks/destroy """
Josh Roesslein's avatar
Josh Roesslein committed
414
415
416
    destroy_block = bind_api(
        path = '/blocks/destroy.json',
        method = 'DELETE',
417
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
418
        allowed_param = ['id', 'user_id', 'screen_name'],
Josh Roesslein's avatar
Josh Roesslein committed
419
420
421
        require_auth = True
    )

422
    """ blocks/exists """
Josh Roesslein's avatar
Josh Roesslein committed
423
    def exists_block(self, *args, **kargs):
Josh Roesslein's avatar
Josh Roesslein committed
424
425
426
427
428
        try:
            bind_api(
                path = '/blocks/exists.json',
                allowed_param = ['id', 'user_id', 'screen_name'],
                require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
429
            )(self, *args, **kargs)
Josh Roesslein's avatar
Josh Roesslein committed
430
431
432
433
        except TweepError:
            return False
        return True

434
    """ blocks/blocking """
Josh Roesslein's avatar
Josh Roesslein committed
435
436
    blocks = bind_api(
        path = '/blocks/blocking.json',
437
        payload_type = 'user', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
438
439
440
441
        allowed_param = ['page'],
        require_auth = True
    )

442
    """ blocks/blocking/ids """
Josh Roesslein's avatar
Josh Roesslein committed
443
444
    blocks_ids = bind_api(
        path = '/blocks/blocking/ids.json',
445
        payload_type = 'json',
Josh Roesslein's avatar
Josh Roesslein committed
446
447
448
        require_auth = True
    )

449
    """ report_spam """
Josh Roesslein's avatar
Josh Roesslein committed
450
451
452
    report_spam = bind_api(
        path = '/report_spam.json',
        method = 'POST',
453
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
454
455
456
457
        allowed_param = ['id', 'user_id', 'screen_name'],
        require_auth = True
    )

458
    """ saved_searches """
Josh Roesslein's avatar
Josh Roesslein committed
459
460
    saved_searches = bind_api(
        path = '/saved_searches.json',
461
        payload_type = 'saved_search', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
462
463
464
        require_auth = True
    )

465
    """ saved_searches/show """
466
467
    get_saved_search = bind_api(
        path = '/saved_searches/show/{id}.json',
468
        payload_type = 'saved_search',
469
470
471
        allowed_param = ['id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
472

473
    """ saved_searches/create """
Josh Roesslein's avatar
Josh Roesslein committed
474
475
476
    create_saved_search = bind_api(
        path = '/saved_searches/create.json',
        method = 'POST',
477
        payload_type = 'saved_search',
Josh Roesslein's avatar
Josh Roesslein committed
478
479
480
481
        allowed_param = ['query'],
        require_auth = True
    )

482
    """ saved_searches/destroy """
483
484
485
    destroy_saved_search = bind_api(
        path = '/saved_searches/destroy/{id}.json',
        method = 'DELETE',
486
        payload_type = 'saved_search',
487
488
489
        allowed_param = ['id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
490

491
    """ help/test """
Josh Roesslein's avatar
Josh Roesslein committed
492
    def test(self):
493
        try:
494
            bind_api(
495
496
497
498
                path = '/help/test.json',
            )(self)
        except TweepError:
            return False
499
        return True
500

Josh Roesslein's avatar
Josh Roesslein committed
501
502
    def create_list(self, *args, **kargs):
        return bind_api(
Josh Roesslein's avatar
Josh Roesslein committed
503
            path = '/%s/lists.json' % self.auth.get_username(),
Josh Roesslein's avatar
Josh Roesslein committed
504
            method = 'POST',
505
            payload_type = 'list',
506
            allowed_param = ['name', 'mode', 'description'],
Josh Roesslein's avatar
Josh Roesslein committed
507
508
509
            require_auth = True
        )(self, *args, **kargs)

Josh Roesslein's avatar
Josh Roesslein committed
510
511
512
513
    def destroy_list(self, slug):
        return bind_api(
            path = '/%s/lists/%s.json' % (self.auth.get_username(), slug),
            method = 'DELETE',
514
            payload_type = 'list',
Josh Roesslein's avatar
Josh Roesslein committed
515
516
517
            require_auth = True
        )(self)

Josh Roesslein's avatar
Josh Roesslein committed
518
519
    def update_list(self, slug, *args, **kargs):
        return bind_api(
Josh Roesslein's avatar
Josh Roesslein committed
520
            path = '/%s/lists/%s.json' % (self.auth.get_username(), slug),
Josh Roesslein's avatar
Josh Roesslein committed
521
            method = 'POST',
522
            payload_type = 'list',
523
            allowed_param = ['name', 'mode', 'description'],
Josh Roesslein's avatar
Josh Roesslein committed
524
525
526
            require_auth = True
        )(self, *args, **kargs)

527
528
    lists = bind_api(
        path = '/{user}/lists.json',
529
        payload_type = 'list', payload_list = True,
530
531
532
        allowed_param = ['user', 'cursor'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
533

534
535
    lists_memberships = bind_api(
        path = '/{user}/lists/memberships.json',
536
        payload_type = 'list', payload_list = True,
537
538
539
        allowed_param = ['user', 'cursor'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
540

541
542
    lists_subscriptions = bind_api(
        path = '/{user}/lists/subscriptions.json',
543
        payload_type = 'list', payload_list = True,
544
545
546
        allowed_param = ['user', 'cursor'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
547

548
549
    list_timeline = bind_api(
        path = '/{owner}/lists/{slug}/statuses.json',
550
        payload_type = 'status', payload_list = True,
551
        allowed_param = ['owner', 'slug', 'since_id', 'max_id', 'per_page', 'page']
552
    )
Josh Roesslein's avatar
Josh Roesslein committed
553

554
555
    get_list = bind_api(
        path = '/{owner}/lists/{slug}.json',
556
        payload_type = 'list',
557
558
        allowed_param = ['owner', 'slug']
    )
Josh Roesslein's avatar
Josh Roesslein committed
559
560
561
562
563

    def add_list_member(self, slug, *args, **kargs):
        return bind_api(
            path = '/%s/%s/members.json' % (self.auth.get_username(), slug),
            method = 'POST',
564
            payload_type = 'list',
Josh Roesslein's avatar
Josh Roesslein committed
565
566
567
568
569
570
571
572
            allowed_param = ['id'],
            require_auth = True
        )(self, *args, **kargs)

    def remove_list_member(self, slug, *args, **kargs):
        return bind_api(
            path = '/%s/%s/members.json' % (self.auth.get_username(), slug),
            method = 'DELETE',
573
            payload_type = 'list',
Josh Roesslein's avatar
Josh Roesslein committed
574
575
576
577
            allowed_param = ['id'],
            require_auth = True
        )(self, *args, **kargs)

578
579
    list_members = bind_api(
        path = '/{owner}/{slug}/members.json',
580
        payload_type = 'user', payload_list = True,
581
582
        allowed_param = ['owner', 'slug', 'cursor']
    )
Josh Roesslein's avatar
Josh Roesslein committed
583
584
585
586
587

    def is_list_member(self, owner, slug, user_id):
        try:
            return bind_api(
                path = '/%s/%s/members/%s.json' % (owner, slug, user_id),
588
                payload_type = 'user'
Josh Roesslein's avatar
Josh Roesslein committed
589
590
591
592
            )(self)
        except TweepError:
            return False

593
594
595
    subscribe_list = bind_api(
        path = '/{owner}/{slug}/subscribers.json',
        method = 'POST',
596
        payload_type = 'list',
597
598
599
        allowed_param = ['owner', 'slug'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
600

601
602
603
    unsubscribe_list = bind_api(
        path = '/{owner}/{slug}/subscribers.json',
        method = 'DELETE',
604
        payload_type = 'list',
605
606
607
        allowed_param = ['owner', 'slug'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
608

609
610
    list_subscribers = bind_api(
        path = '/{owner}/{slug}/subscribers.json',
611
        payload_type = 'user', payload_list = True,
612
613
        allowed_param = ['owner', 'slug', 'cursor']
    )
Josh Roesslein's avatar
Josh Roesslein committed
614
615
616
617
618

    def is_subscribed_list(self, owner, slug, user_id):
        try:
            return bind_api(
                path = '/%s/%s/subscribers/%s.json' % (owner, slug, user_id),
619
                payload_type = 'user'
Josh Roesslein's avatar
Josh Roesslein committed
620
621
622
623
            )(self)
        except TweepError:
            return False

624
    """ trends/available """
625
626
    trends_available = bind_api(
        path = '/trends/available.json',
627
        payload_type = 'json',
628
629
630
        allowed_param = ['lat', 'long']
    )

631
    """ trends/location """
632
633
    trends_location = bind_api(
        path = '/trends/{woeid}.json',
634
        payload_type = 'json',
635
636
        allowed_param = ['woeid']
    )
637

638
    """ search """
639
640
641
    search = bind_api(
        search_api = True,
        path = '/search.json',
642
        payload_type = 'search_result', payload_list = True,
643
        allowed_param = ['q', 'lang', 'locale', 'rpp', 'page', 'since_id', 'geocode', 'show_user', 'max_id', 'since', 'until', 'result_type']
644
    )
645
    search.pagination_mode = 'page'
Josh Roesslein's avatar
Josh Roesslein committed
646

647
    """ trends """
648
649
    trends = bind_api(
        path = '/trends.json',
650
        payload_type = 'json'
651
    )
Josh Roesslein's avatar
Josh Roesslein committed
652

653
    """ trends/current """
654
655
    trends_current = bind_api(
        path = '/trends/current.json',
656
        payload_type = 'json',
657
658
        allowed_param = ['exclude']
    )
659

660
    """ trends/daily """
661
662
    trends_daily = bind_api(
        path = '/trends/daily.json',
663
        payload_type = 'json',
664
665
        allowed_param = ['date', 'exclude']
    )
666

667
    """ trends/weekly """
668
669
    trends_weekly = bind_api(
        path = '/trends/weekly.json',
670
        payload_type = 'json',
671
672
        allowed_param = ['date', 'exclude']
    )
673

674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
    """ geo/reverse_geocode """
    reverse_geocode = bind_api(
        path = '/geo/reverse_geocode.json',
        payload_type = 'json',
        allowed_param = ['lat', 'long', 'accuracy', 'granularity', 'max_results']
    )

    """ geo/nearby_places """
    nearby_places = bind_api(
        path = '/geo/nearby_places.json',
        payload_type = 'json',
        allowed_param = ['lat', 'long', 'ip', 'accuracy', 'granularity', 'max_results']
    )

    """ geo/id """
    geo_id = bind_api(
        path = '/geo/id/{id}.json',
        payload_type = 'json',
        allowed_param = ['id']
    )

695
    """ Internal use only """
Josh Roesslein's avatar
Josh Roesslein committed
696
    @staticmethod
Josh Roesslein's avatar
Josh Roesslein committed
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
    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
735