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
    def __init__(self, auth_handler=None,
            host='api.twitter.com', search_host='search.twitter.com',
19
             cache=None, secure=True, api_root='/1.1', search_root='',
20
            retry_count=0, retry_delay=0, retry_errors=None, timeout=60,
Mike's avatar
Mike committed
21
            parser=None, compression=False):
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
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.parser = parser or ModelParser()
Josh Roesslein's avatar
Josh Roesslein committed
35

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

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

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

Aaron Swartz's avatar
Aaron Swartz committed
60
61
62
63
64
65
    """/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
66
    )
67

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

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

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

92
    """ statuses/destroy """
Josh Roesslein's avatar
Josh Roesslein committed
93
    destroy_status = bind_api(
Joshua Roesslein's avatar
Joshua Roesslein committed
94
95
        path = '/statuses/destroy/{id}.json',
        method = 'POST',
96
        payload_type = 'status',
Josh Roesslein's avatar
Josh Roesslein committed
97
98
99
100
        allowed_param = ['id'],
        require_auth = True
    )

Ferenc Szalai's avatar
Ferenc Szalai committed
101
    """ statuses/retweet """
102
103
104
    retweet = bind_api(
        path = '/statuses/retweet/{id}.json',
        method = 'POST',
105
        payload_type = 'status',
106
107
108
        allowed_param = ['id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
109

Ferenc Szalai's avatar
Ferenc Szalai committed
110
    """ statuses/retweets """
111
112
    retweets = bind_api(
        path = '/statuses/retweets/{id}.json',
113
        payload_type = 'status', payload_list = True,
114
115
116
        allowed_param = ['id', 'count'],
        require_auth = True
    )
117

Joshua Roesslein's avatar
Joshua Roesslein committed
118
119
120
121
122
123
    retweeters = bind_api(
        path = '/statuses/retweeters/ids.json',
        payload_type = 'ids',
        allowed_param = ['id', 'cursor', 'stringify_ids']
    )

124
    """ users/show """
Josh Roesslein's avatar
Josh Roesslein committed
125
126
    get_user = bind_api(
        path = '/users/show.json',
127
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
128
129
130
        allowed_param = ['id', 'user_id', 'screen_name']
    )

Miriam Sexton's avatar
Miriam Sexton committed
131
132
    ''' statuses/oembed '''
    get_oembed = bind_api(
Miriam Sexton's avatar
Miriam Sexton committed
133
        path = '/statuses/oembed.json',
Miriam Sexton's avatar
Miriam Sexton committed
134
135
136
137
        payload_type = 'json',
        allowed_param = ['id', 'url', 'maxwidth', 'hide_media', 'omit_script', 'align', 'related', 'lang']
    )

138
139
140
141
142
143
144
145
146
147
    """ 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'],
    )

148
    """ Get the authenticated user """
Josh Roesslein's avatar
Josh Roesslein committed
149
    def me(self):
Josh Roesslein's avatar
Josh Roesslein committed
150
        return self.get_user(screen_name=self.auth.get_username())
Josh Roesslein's avatar
Josh Roesslein committed
151

152
153
154
    """ users/search """
    search_users = bind_api(
        path = '/users/search.json',
155
        payload_type = 'user', payload_list = True,
156
157
158
159
        require_auth = True,
        allowed_param = ['q', 'per_page', 'page']
    )

160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
    """ 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
    )

184
    """ direct_messages """
Josh Roesslein's avatar
Josh Roesslein committed
185
186
    direct_messages = bind_api(
        path = '/direct_messages.json',
187
        payload_type = 'direct_message', payload_list = True,
188
        allowed_param = ['since_id', 'max_id', 'count'],
Josh Roesslein's avatar
Josh Roesslein committed
189
190
191
        require_auth = True
    )

192
193
194
195
196
197
198
199
    """ direct_messages/show """
    get_direct_message = bind_api(
        path = '/direct_messages/show/{id}.json',
        payload_type = 'direct_message',
        allowed_param = ['id'],
        require_auth = True
    )

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

208
    """ direct_messages/new """
Josh Roesslein's avatar
Josh Roesslein committed
209
210
    send_direct_message = bind_api(
        path = '/direct_messages/new.json',
211
        method = 'POST',
212
        payload_type = 'direct_message',
213
        allowed_param = ['user', 'screen_name', 'user_id', 'text'],
214
        require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
215
    )
216

217
    """ direct_messages/destroy """
Josh Roesslein's avatar
Josh Roesslein committed
218
219
220
    destroy_direct_message = bind_api(
        path = '/direct_messages/destroy.json',
        method = 'DELETE',
221
        payload_type = 'direct_message',
Josh Roesslein's avatar
Josh Roesslein committed
222
223
224
225
        allowed_param = ['id'],
        require_auth = True
    )

226
    """ friendships/create """
Josh Roesslein's avatar
Josh Roesslein committed
227
228
    create_friendship = bind_api(
        path = '/friendships/create.json',
229
        method = 'POST',
230
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
231
        allowed_param = ['id', 'user_id', 'screen_name', 'follow'],
232
        require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
233
234
    )

235
    """ friendships/destroy """
Josh Roesslein's avatar
Josh Roesslein committed
236
237
238
    destroy_friendship = bind_api(
        path = '/friendships/destroy.json',
        method = 'DELETE',
239
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
240
241
242
243
        allowed_param = ['id', 'user_id', 'screen_name'],
        require_auth = True
    )

244
    """ friendships/show """
Josh Roesslein's avatar
Josh Roesslein committed
245
246
    show_friendship = bind_api(
        path = '/friendships/show.json',
247
        payload_type = 'friendship',
Josh Roesslein's avatar
Josh Roesslein committed
248
249
250
251
        allowed_param = ['source_id', 'source_screen_name',
                          'target_id', 'target_screen_name']
    )

252
253
    """ 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
254
        return self._lookup_friendships(list_to_csv(user_ids), list_to_csv(screen_names))
255
256
257
258
259
260
261
262
263

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


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

271
272
273
274
    """ friends/list """
    friends = bind_api(
        path = '/friends/list.json',
        payload_type = 'user', payload_list = True,
275
        allowed_param = ['id', 'user_id', 'screen_name', 'cursor']
276
277
    )

278
279
280
281
282
283
284
285
286
287
288
289
290
291
    """ 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']
    )

292
    """ followers/ids """
Josh Roesslein's avatar
Josh Roesslein committed
293
294
    followers_ids = bind_api(
        path = '/followers/ids.json',
295
        payload_type = 'ids',
296
        allowed_param = ['id', 'user_id', 'screen_name', 'cursor']
Josh Roesslein's avatar
Josh Roesslein committed
297
298
    )

299
300
301
302
    """ followers/list """
    followers = bind_api(
        path = '/followers/list.json',
        payload_type = 'user', payload_list = True,
303
        allowed_param = ['id', 'user_id', 'screen_name', 'cursor']
304
305
    )

306
    """ account/verify_credentials """
307
    def verify_credentials(self, **kargs):
Josh Roesslein's avatar
Josh Roesslein committed
308
309
310
        try:
            return bind_api(
                path = '/account/verify_credentials.json',
311
                payload_type = 'user',
312
313
314
                require_auth = True,
                allowed_param = ['include_entities', 'skip_status'],
            )(self, **kargs)
315
316
317
318
        except TweepError, e:
            if e.response and e.response.status == 401:
                return False
            raise
Josh Roesslein's avatar
Josh Roesslein committed
319

320
    """ account/rate_limit_status """
Josh Roesslein's avatar
Josh Roesslein committed
321
    rate_limit_status = bind_api(
322
        path = '/application/rate_limit_status.json',
323
        payload_type = 'json',
324
        allowed_param = ['resources'],
325
        use_cache = False
Josh Roesslein's avatar
Josh Roesslein committed
326
327
    )

328
    """ account/update_delivery_device """
Josh Roesslein's avatar
Josh Roesslein committed
329
330
331
332
    set_delivery_device = bind_api(
        path = '/account/update_delivery_device.json',
        method = 'POST',
        allowed_param = ['device'],
333
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
334
335
336
        require_auth = True
    )

337
    """ account/update_profile_colors """
Josh Roesslein's avatar
Josh Roesslein committed
338
339
340
    update_profile_colors = bind_api(
        path = '/account/update_profile_colors.json',
        method = 'POST',
341
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
342
343
344
345
346
347
        allowed_param = ['profile_background_color', 'profile_text_color',
                          'profile_link_color', 'profile_sidebar_fill_color',
                          'profile_sidebar_border_color'],
        require_auth = True
    )

348
    """ account/update_profile_image """
Josh Roesslein's avatar
Josh Roesslein committed
349
    def update_profile_image(self, filename):
Josh Roesslein's avatar
Josh Roesslein committed
350
        headers, post_data = API._pack_image(filename, 700)
Josh Roesslein's avatar
Josh Roesslein committed
351
        return bind_api(
Josh Roesslein's avatar
Josh Roesslein committed
352
353
            path = '/account/update_profile_image.json',
            method = 'POST',
354
            payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
355
356
357
            require_auth = True
        )(self, post_data=post_data, headers=headers)

358
    """ account/update_profile_background_image """
Josh Roesslein's avatar
Josh Roesslein committed
359
    def update_profile_background_image(self, filename, *args, **kargs):
Josh Roesslein's avatar
Josh Roesslein committed
360
        headers, post_data = API._pack_image(filename, 800)
Josh Roesslein's avatar
Josh Roesslein committed
361
362
363
        bind_api(
            path = '/account/update_profile_background_image.json',
            method = 'POST',
364
            payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
365
366
367
368
            allowed_param = ['tile'],
            require_auth = True
        )(self, post_data=post_data, headers=headers)

369
370
371
372
373
374
375
376
377
378
379
    """ account/update_profile_banner """
    def update_profile_banner(self, filename, *args, **kargs):
        headers, post_data = API._pack_image(filename, 700, form_field="banner")
        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)


380
    """ account/update_profile """
Josh Roesslein's avatar
Josh Roesslein committed
381
382
383
    update_profile = bind_api(
        path = '/account/update_profile.json',
        method = 'POST',
384
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
385
        allowed_param = ['name', 'url', 'location', 'description'],
386
        require_auth = True
Josh Roesslein's avatar
Josh Roesslein committed
387
388
    )

389
    """ favorites """
Josh Roesslein's avatar
Josh Roesslein committed
390
    favorites = bind_api(
391
        path = '/favorites/list.json',
392
        payload_type = 'status', payload_list = True,
393
        allowed_param = ['screen_name', 'user_id', 'max_id', 'count', 'since_id', 'max_id']
Josh Roesslein's avatar
Josh Roesslein committed
394
395
    )

396
    """ favorites/create """
397
    create_favorite = bind_api(
398
        path = '/favorites/create.json',
399
        method = 'POST',
400
        payload_type = 'status',
401
402
403
        allowed_param = ['id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
404

405
    """ favorites/destroy """
406
    destroy_favorite = bind_api(
407
408
        path = '/favorites/destroy.json',
        method = 'POST',
409
        payload_type = 'status',
410
411
412
        allowed_param = ['id'],
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
413

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

423
    """ blocks/destroy """
Josh Roesslein's avatar
Josh Roesslein committed
424
425
426
    destroy_block = bind_api(
        path = '/blocks/destroy.json',
        method = 'DELETE',
427
        payload_type = 'user',
Josh Roesslein's avatar
Josh Roesslein committed
428
        allowed_param = ['id', 'user_id', 'screen_name'],
Josh Roesslein's avatar
Josh Roesslein committed
429
430
431
        require_auth = True
    )

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

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

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

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

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

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

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

489
490
491
492
493
494
495
    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
496

497
498
499
500
501
502
503
    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
504

505
506
507
508
509
510
511
    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
512

513
514
    lists_all = bind_api(
        path = '/lists/list.json',
515
        payload_type = 'list', payload_list = True,
516
        allowed_param = ['screen_name', 'user_id'],
517
518
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
519

520
    lists_memberships = bind_api(
521
        path = '/lists/memberships.json',
522
        payload_type = 'list', payload_list = True,
523
        allowed_param = ['screen_name', 'user_id', 'filter_to_owned_lists', 'cursor'],
524
525
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
526

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

534
    list_timeline = bind_api(
535
        path = '/lists/statuses.json',
536
        payload_type = 'status', payload_list = True,
537
        allowed_param = ['owner_screen_name', 'slug', 'owner_id', 'list_id', 'since_id', 'max_id', 'count', 'include_rts']
538
    )
Josh Roesslein's avatar
Josh Roesslein committed
539

540
    get_list = bind_api(
541
        path = '/lists/show.json',
542
        payload_type = 'list',
543
        allowed_param = ['owner_screen_name', 'owner_id', 'slug', 'list_id']
544
    )
Josh Roesslein's avatar
Josh Roesslein committed
545

546
547
548
549
550
551
552
    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
553

554
555
556
557
558
559
560
    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
561

562
    list_members = bind_api(
563
        path = '/lists/members.json',
564
        payload_type = 'user', payload_list = True,
565
        allowed_param = ['owner_screen_name', 'slug', 'list_id', 'owner_id', 'cursor']
566
    )
Josh Roesslein's avatar
Josh Roesslein committed
567

568
569
570
571
572
    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
573

574
    subscribe_list = bind_api(
575
        path = '/lists/subscribers/create.json',
576
        method = 'POST',
577
        payload_type = 'list',
578
        allowed_param = ['owner_screen_name', 'slug', 'owner_id', 'list_id'],
579
580
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
581

582
    unsubscribe_list = bind_api(
583
584
        path = '/lists/subscribers/destroy.json',
        method = 'POST',
585
        payload_type = 'list',
586
        allowed_param = ['owner_screen_name', 'slug', 'owner_id', 'list_id'],
587
588
        require_auth = True
    )
Josh Roesslein's avatar
Josh Roesslein committed
589

590
    list_subscribers = bind_api(
591
        path = '/lists/subscribers.json',
592
        payload_type = 'user', payload_list = True,
593
        allowed_param = ['owner_screen_name', 'slug', 'owner_id', 'list_id', 'cursor']
594
    )
Josh Roesslein's avatar
Josh Roesslein committed
595

596
597
598
599
600
    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
601

602
    """ trends/available """
603
604
    trends_available = bind_api(
        path = '/trends/available.json',
605
606
607
608
609
        payload_type = 'json'
    )

    trends_place = bind_api(
        path = '/trends/place.json',
610
        payload_type = 'json',
611
        allowed_param = ['id', 'exclude']
612
613
    )

614
615
    trends_closest = bind_api(
        path = '/trends/closest.json',
616
        payload_type = 'json',
617
        allowed_param = ['lat', 'long']
618
    )
619

620
    """ search """
621
    search = bind_api(
622
623
        path = '/search/tweets.json',
        payload_type = 'search_results',
624
        allowed_param = ['q', 'lang', 'locale', 'since_id', 'geocode', 'show_user', 'max_id', 'since', 'until', 'result_type', 'count']
625
    )
Josh Roesslein's avatar
Josh Roesslein committed
626

627
    """ trends/daily """
628
629
    trends_daily = bind_api(
        path = '/trends/daily.json',
630
        payload_type = 'json',
631
632
        allowed_param = ['date', 'exclude']
    )
633

634
    """ trends/weekly """
635
636
    trends_weekly = bind_api(
        path = '/trends/weekly.json',
637
        payload_type = 'json',
638
639
        allowed_param = ['date', 'exclude']
    )
640

641
642
643
    """ geo/reverse_geocode """
    reverse_geocode = bind_api(
        path = '/geo/reverse_geocode.json',
644
        payload_type = 'place', payload_list = True,
645
646
647
648
649
650
        allowed_param = ['lat', 'long', 'accuracy', 'granularity', 'max_results']
    )

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

655
656
657
    """ geo/search """
    geo_search = bind_api(
        path = '/geo/search.json',
658
        payload_type = 'place', payload_list = True,
659
660
661
        allowed_param = ['lat', 'long', 'query', 'ip', 'granularity', 'accuracy', 'max_results', 'contained_within']
    )

662
663
664
665
666
667
668
    """ 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']
    )

669
670
671
672
673
674
675
    """ help/languages.json """
    supported_languages = bind_api(
        path = '/help/languages.json',
        payload_type = 'json',
        require_auth = True
    )

676
    """ Internal use only """
Josh Roesslein's avatar
Josh Roesslein committed
677
    @staticmethod
678
    def _pack_image(filename, max_size, form_field="image"):
Josh Roesslein's avatar
Josh Roesslein committed
679
680
681
682
683
        """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.')
684
        except os.error:
Josh Roesslein's avatar
Josh Roesslein committed
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
            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)
700
        body.append('Content-Disposition: form-data; name="%s"; filename="%s"' % (form_field, filename))
Josh Roesslein's avatar
Josh Roesslein committed
701
702
703
704
705
706
707
708
709
710
711
        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',
712
            'Content-Length': str(len(body))
Josh Roesslein's avatar
Josh Roesslein committed
713
714
715
        }

        return headers, body
716