api.py 24.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
    def __init__(self, auth_handler=None,
            host='api.twitter.com', search_host='search.twitter.com',
Joshua Roesslein's avatar
Joshua Roesslein committed
19
             cache=None, api_root='/1.1', search_root='',
20
            retry_count=0, retry_delay=0, retry_errors=None, timeout=60,
21
22
            parser=None, compression=False, wait_on_rate_limit=False,
            wait_on_rate_limit_notify=False):
Josh Roesslein's avatar
Josh Roesslein committed
23
        self.auth = auth_handler
Josh Roesslein's avatar
Josh Roesslein committed
24
        self.host = host
25
        self.search_host = search_host
Josh Roesslein's avatar
Josh Roesslein committed
26
        self.api_root = api_root
27
        self.search_root = search_root
Josh Roesslein's avatar
Josh Roesslein committed
28
        self.cache = cache
Mike's avatar
Mike committed
29
        self.compression = compression
30
31
        self.retry_count = retry_count
        self.retry_delay = retry_delay
32
        self.retry_errors = retry_errors
33
        self.timeout = timeout
34
        self.wait_on_rate_limit = wait_on_rate_limit
35
        self.wait_on_rate_limit_notify = wait_on_rate_limit_notify
36
        self.parser = parser or ModelParser()
Josh Roesslein's avatar
Josh Roesslein committed
37

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

46
    """ statuses/user_timeline """
Josh Roesslein's avatar
Josh Roesslein committed
47
48
    user_timeline = bind_api(
        path = '/statuses/user_timeline.json',
49
        payload_type = 'status', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
50
        allowed_param = ['id', 'user_id', 'screen_name', 'since_id',
51
                          'max_id', 'count', 'include_rts']
Josh Roesslein's avatar
Josh Roesslein committed
52
53
    )

54
    """ statuses/mentions """
55
56
    mentions_timeline = bind_api(
        path = '/statuses/mentions_timeline.json',
57
        payload_type = 'status', payload_list = True,
58
        allowed_param = ['since_id', 'max_id', 'count'],
Josh Roesslein's avatar
Josh Roesslein committed
59
60
61
        require_auth = True
    )

Aaron Swartz's avatar
Aaron Swartz committed
62
63
64
65
66
67
    """/related_results/show/:id.format"""
    related_results = bind_api(
        path = '/related_results/show/{id}.json',
        payload_type = 'relation', payload_list = True,
        allowed_param = ['id'],
        require_auth = False
68
    )
69

70
    """ statuses/retweets_of_me """
Josh Roesslein's avatar
Josh Roesslein committed
71
72
    retweets_of_me = bind_api(
        path = '/statuses/retweets_of_me.json',
73
        payload_type = 'status', payload_list = True,
74
        allowed_param = ['since_id', 'max_id', 'count'],
Josh Roesslein's avatar
Josh Roesslein committed
75
76
77
        require_auth = True
    )

78
    """ statuses/show """
Josh Roesslein's avatar
Josh Roesslein committed
79
80
    get_status = bind_api(
        path = '/statuses/show.json',
81
        payload_type = 'status',
Josh Roesslein's avatar
Josh Roesslein committed
82
83
84
        allowed_param = ['id']
    )

Ferenc Szalai's avatar
Ferenc Szalai committed
85
    """ statuses/update """
Josh Roesslein's avatar
Josh Roesslein committed
86
87
88
    update_status = bind_api(
        path = '/statuses/update.json',
        method = 'POST',
89
        payload_type = 'status',
90
        allowed_param = ['status', 'in_reply_to_status_id', 'lat', 'long', 'source', 'place_id'],
Josh Roesslein's avatar
Josh Roesslein committed
91
92
93
        require_auth = True
    )

94
95
    """ statuses/update_with_media """
    def update_with_media(self, filename, *args, **kwargs):
96
97
        f = kwargs.pop('file', None)
        headers, post_data = API._pack_image(filename, 3072, form_field='media[]', f=f)
98
99
100
101
102
103
104
105
106
107
108
109
110
        kwargs.update({'headers': headers, 'post_data': post_data})

        return bind_api(
            path='/statuses/update_with_media.json',
            method = 'POST',
            payload_type='status',
            allowed_param = [
                'status', 'possibly_sensitive', 'in_reply_to_status_id', 'lat', 'long',
                'place_id', 'display_coordinates'
            ],
            require_auth=True
        )(self, *args, **kwargs)

111
    """ statuses/destroy """
Josh Roesslein's avatar
Josh Roesslein committed
112
    destroy_status = bind_api(
Joshua Roesslein's avatar
Joshua Roesslein committed
113
114
        path = '/statuses/destroy/{id}.json',
        method = 'POST',
115
        payload_type = 'status',
Josh Roesslein's avatar
Josh Roesslein committed
116
117
118
119
        allowed_param = ['id'],
        require_auth = True
    )

Ferenc Szalai's avatar
Ferenc Szalai committed
120
    """ statuses/retweet """
121
122
123
    retweet = bind_api(
        path = '/statuses/retweet/{id}.json',
        method = 'POST',
124
        payload_type = 'status',
125
126
127
        allowed_param = ['id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
128

Ferenc Szalai's avatar
Ferenc Szalai committed
129
    """ statuses/retweets """
130
131
    retweets = bind_api(
        path = '/statuses/retweets/{id}.json',
132
        payload_type = 'status', payload_list = True,
133
134
135
        allowed_param = ['id', 'count'],
        require_auth = True
    )
136

Joshua Roesslein's avatar
Joshua Roesslein committed
137
138
139
140
141
142
    retweeters = bind_api(
        path = '/statuses/retweeters/ids.json',
        payload_type = 'ids',
        allowed_param = ['id', 'cursor', 'stringify_ids']
    )

143
    """ users/show """
Josh Roesslein's avatar
Josh Roesslein committed
144
145
    get_user = bind_api(
        path = '/users/show.json',
146
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
147
148
149
        allowed_param = ['id', 'user_id', 'screen_name']
    )

Miriam Sexton's avatar
Miriam Sexton committed
150
151
    ''' statuses/oembed '''
    get_oembed = bind_api(
Miriam Sexton's avatar
Miriam Sexton committed
152
        path = '/statuses/oembed.json',
Miriam Sexton's avatar
Miriam Sexton committed
153
154
155
156
        payload_type = 'json',
        allowed_param = ['id', 'url', 'maxwidth', 'hide_media', 'omit_script', 'align', 'related', 'lang']
    )

157
158
159
160
161
162
163
164
165
166
    """ 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'],
    )

167
    """ Get the authenticated user """
Josh Roesslein's avatar
Josh Roesslein committed
168
    def me(self):
Josh Roesslein's avatar
Josh Roesslein committed
169
        return self.get_user(screen_name=self.auth.get_username())
Josh Roesslein's avatar
Josh Roesslein committed
170

171
172
173
    """ users/search """
    search_users = bind_api(
        path = '/users/search.json',
174
        payload_type = 'user', payload_list = True,
175
        require_auth = True,
176
        allowed_param = ['q', 'count', 'page']
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
    """ users/suggestions/:slug """
    suggested_users = bind_api(
        path = '/users/suggestions/{slug}.json',
        payload_type = 'user', payload_list = True,
        require_auth = True,
        allowed_param = ['slug', 'lang']
    )

    """ users/suggestions """
    suggested_categories = bind_api(
        path = '/users/suggestions.json',
        payload_type = 'category', payload_list = True,
        allowed_param = ['lang'],
        require_auth = True
    )

    """ users/suggestions/:slug/members """
    suggested_users_tweets = bind_api(
        path = '/users/suggestions/{slug}/members.json',
        payload_type = 'status', payload_list = True,
        allowed_param = ['slug'],
        require_auth = True
    )

203
    """ direct_messages """
Josh Roesslein's avatar
Josh Roesslein committed
204
205
    direct_messages = bind_api(
        path = '/direct_messages.json',
206
        payload_type = 'direct_message', payload_list = True,
207
        allowed_param = ['since_id', 'max_id', 'count'],
Josh Roesslein's avatar
Josh Roesslein committed
208
209
210
        require_auth = True
    )

211
212
213
214
215
216
217
218
    """ direct_messages/show """
    get_direct_message = bind_api(
        path = '/direct_messages/show/{id}.json',
        payload_type = 'direct_message',
        allowed_param = ['id'],
        require_auth = True
    )

219
    """ direct_messages/sent """
Josh Roesslein's avatar
Josh Roesslein committed
220
221
    sent_direct_messages = bind_api(
        path = '/direct_messages/sent.json',
222
        payload_type = 'direct_message', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
223
224
225
        allowed_param = ['since_id', 'max_id', 'count', 'page'],
        require_auth = True
    )
226

227
    """ direct_messages/new """
Josh Roesslein's avatar
Josh Roesslein committed
228
229
    send_direct_message = bind_api(
        path = '/direct_messages/new.json',
230
        method = 'POST',
231
        payload_type = 'direct_message',
232
        allowed_param = ['user', 'screen_name', 'user_id', 'text'],
233
        require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
234
    )
235

236
    """ direct_messages/destroy """
Josh Roesslein's avatar
Josh Roesslein committed
237
238
239
    destroy_direct_message = bind_api(
        path = '/direct_messages/destroy.json',
        method = 'DELETE',
240
        payload_type = 'direct_message',
Josh Roesslein's avatar
Josh Roesslein committed
241
242
243
244
        allowed_param = ['id'],
        require_auth = True
    )

245
    """ friendships/create """
Josh Roesslein's avatar
Josh Roesslein committed
246
247
    create_friendship = bind_api(
        path = '/friendships/create.json',
248
        method = 'POST',
249
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
250
        allowed_param = ['id', 'user_id', 'screen_name', 'follow'],
251
        require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
252
253
    )

254
    """ friendships/destroy """
Josh Roesslein's avatar
Josh Roesslein committed
255
256
257
    destroy_friendship = bind_api(
        path = '/friendships/destroy.json',
        method = 'DELETE',
258
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
259
260
261
262
        allowed_param = ['id', 'user_id', 'screen_name'],
        require_auth = True
    )

263
    """ friendships/show """
Josh Roesslein's avatar
Josh Roesslein committed
264
265
    show_friendship = bind_api(
        path = '/friendships/show.json',
266
        payload_type = 'friendship',
Josh Roesslein's avatar
Josh Roesslein committed
267
268
269
270
        allowed_param = ['source_id', 'source_screen_name',
                          'target_id', 'target_screen_name']
    )

271
272
    """ Perform bulk look up of friendships from user ID or screenname """
    def lookup_friendships(self, user_ids=None, screen_names=None):
Santosh Kumar's avatar
Santosh Kumar committed
273
        return self._lookup_friendships(list_to_csv(user_ids), list_to_csv(screen_names))
274
275
276
277
278
279
280
281
282

    _lookup_friendships = bind_api(
        path = '/friendships/lookup.json',
        payload_type = 'relationship', payload_list = True,
        allowed_param = ['user_id', 'screen_name'],
        require_auth = True
    )


283
    """ friends/ids """
Josh Roesslein's avatar
Josh Roesslein committed
284
285
    friends_ids = bind_api(
        path = '/friends/ids.json',
286
        payload_type = 'ids',
287
        allowed_param = ['id', 'user_id', 'screen_name', 'cursor']
Josh Roesslein's avatar
Josh Roesslein committed
288
289
    )

290
291
292
293
    """ friends/list """
    friends = bind_api(
        path = '/friends/list.json',
        payload_type = 'user', payload_list = True,
294
        allowed_param = ['id', 'user_id', 'screen_name', 'cursor']
295
296
    )

297
298
299
300
301
302
303
304
305
306
307
308
309
310
    """ 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']
    )

311
    """ followers/ids """
Josh Roesslein's avatar
Josh Roesslein committed
312
313
    followers_ids = bind_api(
        path = '/followers/ids.json',
314
        payload_type = 'ids',
315
        allowed_param = ['id', 'user_id', 'screen_name', 'cursor']
Josh Roesslein's avatar
Josh Roesslein committed
316
317
    )

318
319
320
321
    """ followers/list """
    followers = bind_api(
        path = '/followers/list.json',
        payload_type = 'user', payload_list = True,
322
323
        allowed_param = ['id', 'user_id', 'screen_name', 'cursor', 'count',
            'skip_status', 'include_user_entities']
324
325
    )

326
    """ account/verify_credentials """
327
    def verify_credentials(self, **kargs):
Josh Roesslein's avatar
Josh Roesslein committed
328
329
330
        try:
            return bind_api(
                path = '/account/verify_credentials.json',
331
                payload_type = 'user',
332
333
334
                require_auth = True,
                allowed_param = ['include_entities', 'skip_status'],
            )(self, **kargs)
335
        except TweepError as e:
336
337
338
            if e.response and e.response.status == 401:
                return False
            raise
Josh Roesslein's avatar
Josh Roesslein committed
339

340
    """ account/rate_limit_status """
Josh Roesslein's avatar
Josh Roesslein committed
341
    rate_limit_status = bind_api(
342
        path = '/application/rate_limit_status.json',
343
        payload_type = 'json',
344
        allowed_param = ['resources'],
345
        use_cache = False
Josh Roesslein's avatar
Josh Roesslein committed
346
347
    )

348
    """ account/update_delivery_device """
Josh Roesslein's avatar
Josh Roesslein committed
349
350
351
352
    set_delivery_device = bind_api(
        path = '/account/update_delivery_device.json',
        method = 'POST',
        allowed_param = ['device'],
353
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
354
355
356
        require_auth = True
    )

357
    """ account/update_profile_colors """
Josh Roesslein's avatar
Josh Roesslein committed
358
359
360
    update_profile_colors = bind_api(
        path = '/account/update_profile_colors.json',
        method = 'POST',
361
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
362
363
364
365
366
367
        allowed_param = ['profile_background_color', 'profile_text_color',
                          'profile_link_color', 'profile_sidebar_fill_color',
                          'profile_sidebar_border_color'],
        require_auth = True
    )

368
    """ account/update_profile_image """
369
370
    def update_profile_image(self, filename, file=None):
        headers, post_data = API._pack_image(filename, 700, f=file)
Josh Roesslein's avatar
Josh Roesslein committed
371
        return bind_api(
Josh Roesslein's avatar
Josh Roesslein committed
372
373
            path = '/account/update_profile_image.json',
            method = 'POST',
374
            payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
375
376
377
            require_auth = True
        )(self, post_data=post_data, headers=headers)

378
    """ account/update_profile_background_image """
Josh Roesslein's avatar
Josh Roesslein committed
379
    def update_profile_background_image(self, filename, *args, **kargs):
380
381
        f = kargs.pop('file', None)
        headers, post_data = API._pack_image(filename, 800, f=f)
Josh Roesslein's avatar
Josh Roesslein committed
382
383
384
        bind_api(
            path = '/account/update_profile_background_image.json',
            method = 'POST',
385
            payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
386
387
388
389
            allowed_param = ['tile'],
            require_auth = True
        )(self, post_data=post_data, headers=headers)

390
391
    """ account/update_profile_banner """
    def update_profile_banner(self, filename, *args, **kargs):
392
393
        f = kargs.pop('file', None)
        headers, post_data = API._pack_image(filename, 700, form_field="banner", f=f)
394
395
396
397
398
399
400
401
        bind_api(
            path = '/account/update_profile_banner.json',
            method = 'POST',
            allowed_param = ['width', 'height', 'offset_left', 'offset_right'],
            require_auth = True
        )(self, post_data=post_data, headers=headers)


402
    """ account/update_profile """
Josh Roesslein's avatar
Josh Roesslein committed
403
404
405
    update_profile = bind_api(
        path = '/account/update_profile.json',
        method = 'POST',
406
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
407
        allowed_param = ['name', 'url', 'location', 'description'],
408
        require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
409
410
    )

411
    """ favorites """
Josh Roesslein's avatar
Josh Roesslein committed
412
    favorites = bind_api(
413
        path = '/favorites/list.json',
414
        payload_type = 'status', payload_list = True,
415
        allowed_param = ['screen_name', 'user_id', 'max_id', 'count', 'since_id', 'max_id']
Josh Roesslein's avatar
Josh Roesslein committed
416
417
    )

418
    """ favorites/create """
419
    create_favorite = bind_api(
420
        path = '/favorites/create.json',
421
        method = 'POST',
422
        payload_type = 'status',
423
424
425
        allowed_param = ['id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
426

427
    """ favorites/destroy """
428
    destroy_favorite = bind_api(
429
430
        path = '/favorites/destroy.json',
        method = 'POST',
431
        payload_type = 'status',
432
433
434
        allowed_param = ['id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
435

436
    """ blocks/create """
Josh Roesslein's avatar
Josh Roesslein committed
437
438
439
    create_block = bind_api(
        path = '/blocks/create.json',
        method = 'POST',
440
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
441
        allowed_param = ['id', 'user_id', 'screen_name'],
Josh Roesslein's avatar
Josh Roesslein committed
442
443
444
        require_auth = True
    )

445
    """ blocks/destroy """
Josh Roesslein's avatar
Josh Roesslein committed
446
447
448
    destroy_block = bind_api(
        path = '/blocks/destroy.json',
        method = 'DELETE',
449
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
450
        allowed_param = ['id', 'user_id', 'screen_name'],
Josh Roesslein's avatar
Josh Roesslein committed
451
452
453
        require_auth = True
    )

454
    """ blocks/blocking """
Josh Roesslein's avatar
Josh Roesslein committed
455
    blocks = bind_api(
Joshua Roesslein's avatar
Joshua Roesslein committed
456
        path = '/blocks/list.json',
457
        payload_type = 'user', payload_list = True,
458
        allowed_param = ['cursor'],
Josh Roesslein's avatar
Josh Roesslein committed
459
460
461
        require_auth = True
    )

462
    """ blocks/blocking/ids """
Josh Roesslein's avatar
Josh Roesslein committed
463
    blocks_ids = bind_api(
Joshua Roesslein's avatar
Joshua Roesslein committed
464
        path = '/blocks/ids.json',
465
        payload_type = 'json',
Josh Roesslein's avatar
Josh Roesslein committed
466
467
468
        require_auth = True
    )

469
    """ report_spam """
Josh Roesslein's avatar
Josh Roesslein committed
470
    report_spam = bind_api(
471
        path = '/users/report_spam.json',
Josh Roesslein's avatar
Josh Roesslein committed
472
        method = 'POST',
473
        payload_type = 'user',
474
        allowed_param = ['user_id', 'screen_name'],
Josh Roesslein's avatar
Josh Roesslein committed
475
476
477
        require_auth = True
    )

478
    """ saved_searches """
Josh Roesslein's avatar
Josh Roesslein committed
479
    saved_searches = bind_api(
480
        path = '/saved_searches/list.json',
481
        payload_type = 'saved_search', payload_list = True,
Josh Roesslein's avatar
Josh Roesslein committed
482
483
484
        require_auth = True
    )

485
    """ saved_searches/show """
486
487
    get_saved_search = bind_api(
        path = '/saved_searches/show/{id}.json',
488
        payload_type = 'saved_search',
489
490
491
        allowed_param = ['id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
492

493
    """ saved_searches/create """
Josh Roesslein's avatar
Josh Roesslein committed
494
495
496
    create_saved_search = bind_api(
        path = '/saved_searches/create.json',
        method = 'POST',
497
        payload_type = 'saved_search',
Josh Roesslein's avatar
Josh Roesslein committed
498
499
500
501
        allowed_param = ['query'],
        require_auth = True
    )

502
    """ saved_searches/destroy """
503
504
    destroy_saved_search = bind_api(
        path = '/saved_searches/destroy/{id}.json',
505
        method = 'POST',
506
        payload_type = 'saved_search',
507
508
509
        allowed_param = ['id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
510

511
512
513
514
515
516
517
    create_list = bind_api(
        path = '/lists/create.json',
        method = 'POST',
        payload_type = 'list',
        allowed_param = ['name', 'mode', 'description'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
518

519
520
521
522
523
524
525
    destroy_list = bind_api(
        path = '/lists/destroy.json',
        method = 'POST',
        payload_type = 'list',
        allowed_param = ['owner_screen_name', 'owner_id', 'list_id', 'slug'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
526

527
528
529
530
531
532
533
    update_list = bind_api(
        path = '/lists/update.json',
        method = 'POST',
        payload_type = 'list',
        allowed_param = ['list_id', 'slug', 'name', 'mode', 'description', 'owner_screen_name', 'owner_id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
534

535
536
    lists_all = bind_api(
        path = '/lists/list.json',
537
        payload_type = 'list', payload_list = True,
538
        allowed_param = ['screen_name', 'user_id'],
539
540
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
541

542
    lists_memberships = bind_api(
543
        path = '/lists/memberships.json',
544
        payload_type = 'list', payload_list = True,
545
        allowed_param = ['screen_name', 'user_id', 'filter_to_owned_lists', 'cursor'],
546
547
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
548

549
    lists_subscriptions = bind_api(
550
        path = '/lists/subscriptions.json',
551
        payload_type = 'list', payload_list = True,
552
        allowed_param = ['screen_name', 'user_id', 'cursor'],
553
554
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
555

556
    list_timeline = bind_api(
557
        path = '/lists/statuses.json',
558
        payload_type = 'status', payload_list = True,
559
        allowed_param = ['owner_screen_name', 'slug', 'owner_id', 'list_id', 'since_id', 'max_id', 'count', 'include_rts']
560
    )
Josh Roesslein's avatar
Josh Roesslein committed
561

562
    get_list = bind_api(
563
        path = '/lists/show.json',
564
        payload_type = 'list',
565
        allowed_param = ['owner_screen_name', 'owner_id', 'slug', 'list_id']
566
    )
Josh Roesslein's avatar
Josh Roesslein committed
567

568
569
570
571
572
573
574
    add_list_member = bind_api(
        path = '/lists/members/create.json',
        method = 'POST',
        payload_type = 'list',
        allowed_param = ['screen_name', 'user_id', 'owner_screen_name', 'owner_id', 'slug', 'list_id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
575

576
577
578
579
580
581
582
    remove_list_member = bind_api(
        path = '/lists/members/destroy.json',
        method = 'POST',
        payload_type = 'list',
        allowed_param = ['screen_name', 'user_id', 'owner_screen_name', 'owner_id', 'slug', 'list_id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
583

584
    """ Perform bulk add of list members from user ID or screenname """
kk6's avatar
kk6 committed
585
    def add_list_members(self, screen_name=None, user_id=None, slug=None,
586
                         list_id=None, owner_id=None, owner_screen_name=None):
kk6's avatar
kk6 committed
587
588
        return self._add_list_members(list_to_csv(screen_name),
                                      list_to_csv(user_id),
589
590
591
592
                                      slug, list_id, owner_id,
                                      owner_screen_name)

    _add_list_members = bind_api(
593
594
595
        path = '/lists/members/create_all.json',
        method = 'POST',
        payload_type = 'list',
596
        allowed_param = ['screen_name', 'user_id', 'slug', 'lit_id', 'owner_id', 'owner_screen_name'],
597
598
599
        require_auth = True
    )

600
    """ Perform bulk remove of list members from user ID or screenname """
kk6's avatar
kk6 committed
601
    def remove_list_members(self, screen_name=None, user_id=None, slug=None,
602
                         list_id=None, owner_id=None, owner_screen_name=None):
kk6's avatar
kk6 committed
603
604
        return self._remove_list_members(list_to_csv(screen_name),
                                      list_to_csv(user_id),
605
606
607
608
                                      slug, list_id, owner_id,
                                      owner_screen_name)

    _remove_list_members = bind_api(
609
610
611
        path = '/lists/members/destroy_all.json',
        method = 'POST',
        payload_type = 'list',
612
        allowed_param = ['screen_name', 'user_id', 'slug', 'lit_id', 'owner_id', 'owner_screen_name'],
613
614
615
        require_auth = True
    )

616
    list_members = bind_api(
617
        path = '/lists/members.json',
618
        payload_type = 'user', payload_list = True,
619
        allowed_param = ['owner_screen_name', 'slug', 'list_id', 'owner_id', 'cursor']
620
    )
Josh Roesslein's avatar
Josh Roesslein committed
621

622
623
624
625
626
    show_list_member = bind_api(
        path = '/lists/members/show.json',
        payload_type = 'user',
        allowed_param = ['list_id', 'slug', 'user_id', 'screen_name', 'owner_screen_name', 'owner_id']
    )
Josh Roesslein's avatar
Josh Roesslein committed
627

628
    subscribe_list = bind_api(
629
        path = '/lists/subscribers/create.json',
630
        method = 'POST',
631
        payload_type = 'list',
632
        allowed_param = ['owner_screen_name', 'slug', 'owner_id', 'list_id'],
633
634
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
635

636
    unsubscribe_list = bind_api(
637
638
        path = '/lists/subscribers/destroy.json',
        method = 'POST',
639
        payload_type = 'list',
640
        allowed_param = ['owner_screen_name', 'slug', 'owner_id', 'list_id'],
641
642
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
643

644
    list_subscribers = bind_api(
645
        path = '/lists/subscribers.json',
646
        payload_type = 'user', payload_list = True,
647
        allowed_param = ['owner_screen_name', 'slug', 'owner_id', 'list_id', 'cursor']
648
    )
Josh Roesslein's avatar
Josh Roesslein committed
649

650
651
652
653
654
    show_list_subscriber = bind_api(
        path = '/lists/subscribers/show.json',
        payload_type = 'user',
        allowed_param = ['owner_screen_name', 'slug', 'screen_name', 'owner_id', 'list_id', 'user_id']
    )
Josh Roesslein's avatar
Josh Roesslein committed
655

656
    """ trends/available """
657
658
    trends_available = bind_api(
        path = '/trends/available.json',
659
660
661
662
663
        payload_type = 'json'
    )

    trends_place = bind_api(
        path = '/trends/place.json',
664
        payload_type = 'json',
665
        allowed_param = ['id', 'exclude']
666
667
    )

668
669
    trends_closest = bind_api(
        path = '/trends/closest.json',
670
        payload_type = 'json',
671
        allowed_param = ['lat', 'long']
672
    )
673

674
    """ search """
675
    search = bind_api(
676
677
        path = '/search/tweets.json',
        payload_type = 'search_results',
678
        allowed_param = ['q', 'lang', 'locale', 'since_id', 'geocode', 'max_id', 'since', 'until', 'result_type', 'count', 'include_entities', 'from', 'to', 'source']
679
    )
Josh Roesslein's avatar
Josh Roesslein committed
680

681
    """ trends/daily """
682
683
    trends_daily = bind_api(
        path = '/trends/daily.json',
684
        payload_type = 'json',
685
686
        allowed_param = ['date', 'exclude']
    )
687

688
    """ trends/weekly """
689
690
    trends_weekly = bind_api(
        path = '/trends/weekly.json',
691
        payload_type = 'json',
692
693
        allowed_param = ['date', 'exclude']
    )
694

695
696
697
    """ geo/reverse_geocode """
    reverse_geocode = bind_api(
        path = '/geo/reverse_geocode.json',
698
        payload_type = 'place', payload_list = True,
699
700
701
702
703
704
        allowed_param = ['lat', 'long', 'accuracy', 'granularity', 'max_results']
    )

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

709
710
711
    """ geo/search """
    geo_search = bind_api(
        path = '/geo/search.json',
712
        payload_type = 'place', payload_list = True,
713
714
715
        allowed_param = ['lat', 'long', 'query', 'ip', 'granularity', 'accuracy', 'max_results', 'contained_within']
    )

716
717
718
719
720
721
722
    """ geo/similar_places """
    geo_similar_places = bind_api(
        path = '/geo/similar_places.json',
        payload_type = 'place', payload_list = True,
        allowed_param = ['lat', 'long', 'name', 'contained_within']
    )

723
724
725
726
727
    """ help/languages.json """
    supported_languages = bind_api(
        path = '/help/languages.json',
        payload_type = 'json',
        require_auth = True
728
    )
Joshua Roesslein's avatar
Joshua Roesslein committed
729

730
    """ help/configuration """
731
732
733
    configuration = bind_api(
        path = '/help/configuration.json',
        payload_type = 'json',
734
        require_auth = True
735
736
    )

737
    """ Internal use only """
Josh Roesslein's avatar
Josh Roesslein committed
738
    @staticmethod
739
    def _pack_image(filename, max_size, form_field="image", f=None):
Josh Roesslein's avatar
Josh Roesslein committed
740
741
        """Pack image from file into multipart-formdata post body"""
        # image must be less than 700kb in size
742
743
744
745
746
747
748
749
750
751
752
753
        if f == None:
            try:
                if os.path.getsize(filename) > (max_size * 1024):
                    raise TweepError('File is too big, must be less than 700kb.')
            except os.error:
                raise TweepError('Unable to access file')

            # build the mulitpart-formdata body
            fp = open(filename, 'rb')
        else:
            f.seek(0, 2) # Seek to end of file
            if f.tell() > (max_size * 1024):
Josh Roesslein's avatar
Josh Roesslein committed
754
                raise TweepError('File is too big, must be less than 700kb.')
755
756
            f.seek(0) # Reset to beginning of file
            fp = f
Josh Roesslein's avatar
Josh Roesslein committed
757
758
759
760
761
762
763
764
765

        # 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)

766
767


Josh Roesslein's avatar
Josh Roesslein committed
768
769
770
        BOUNDARY = 'Tw3ePy'
        body = []
        body.append('--' + BOUNDARY)
771
        body.append('Content-Disposition: form-data; name="%s"; filename="%s"' % (form_field, filename))
Josh Roesslein's avatar
Josh Roesslein committed
772
773
774
775
776
777
778
779
780
781
782
        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',
783
            'Content-Length': str(len(body))
Josh Roesslein's avatar
Josh Roesslein committed
784
785
786
        }

        return headers, body