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

5
import httplib
Josh Roesslein's avatar
Josh Roesslein committed
6
import urllib
7

Josh Roesslein's avatar
Josh Roesslein committed
8
9
from . parsers import parse_error
from . error import TweepError
10

Josh Roesslein's avatar
Josh Roesslein committed
11

12
13
def bind_api(path, parser, allowed_param=None, method='GET', require_auth=False,
              timeout=None, host=None):
14

Josh Roesslein's avatar
Josh Roesslein committed
15
16
17
18
19
    def _call(api, *args, **kargs):
        # If require auth, throw exception if credentials not provided
        if require_auth and not api.auth_handler:
            raise TweepError('Authentication required!')

20
21
22
23
24
        # Log some useful infomation
        api.logger.debug('Starting request...')
        api.logger.debug('  path: %s' % path)
        api.logger.debug('  method: %s' % method)

Josh Roesslein's avatar
Josh Roesslein committed
25
26
27
28
        # check for post_data parameter
        if 'post_data' in kargs:
            post_data = kargs['post_data']
            del kargs['post_data']
29
            api.logger.debug('  post data: %s' % post_data)
Josh Roesslein's avatar
Josh Roesslein committed
30
31
32
33
34
35
36
37
38
        else:
            post_data = None

        # check for headers
        if 'headers' in kargs:
            headers = dict(kargs['headers'])
            del kargs['headers']
        else:
            headers = {}
39
        api.logger.debug('  headers: %s' % headers)
Josh Roesslein's avatar
Josh Roesslein committed
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

        # build parameter dict
        if allowed_param:
            parameters = {}
            for idx, arg in enumerate(args):
                try:
                    parameters[allowed_param[idx]] = arg
                except IndexError:
                    raise TweepError('Too many parameters supplied!')
            for k, arg in kargs.items():
                if arg is None:
                    continue
                if k in parameters:
                    raise TweepError('Multiple values for parameter %s supplied!' % k)
                if k not in allowed_param:
                    raise TweepError('Invalid parameter %s supplied!' % k)
                parameters[k] = arg
57
        else:
Josh Roesslein's avatar
Josh Roesslein committed
58
59
60
            if len(args) > 0 or len(kargs) > 0:
                raise TweepError('This method takes no parameters!')
            parameters = None
61
        api.logger.debug('  parameters: %s' % parameters)
Josh Roesslein's avatar
Josh Roesslein committed
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

        # Build url with parameters
        if parameters:
            url = '%s?%s' % (api.api_root + path, urllib.urlencode(parameters))
        else:
            url = api.api_root + path

        # get scheme and host
        if api.secure:
            scheme = 'https://'
        else:
            scheme = 'http://'
        _host = host or api.host

        # Apply authentication
        if api.auth_handler:
78
79
80
81
            api.auth_handler.apply_auth(
                    scheme + _host + url,
                    method, headers, parameters
            )
Josh Roesslein's avatar
Josh Roesslein committed
82
83
84
85
86
87
88
89
90
91
92
93

        # Check cache if caching enabled and method is GET
        if api.cache and method == 'GET':
            cache_result = api.cache.get(url, timeout)
            # if cache result found and not expired, return it
            if cache_result:
                # must restore api reference
                if isinstance(cache_result, list):
                    for result in cache_result:
                        result._api = api
                else:
                    cache_result._api = api
94
                api.logger.debug("Cache hit!")
Josh Roesslein's avatar
Josh Roesslein committed
95
96
97
98
99
100
101
102
103
104
105
106
107
108
                return cache_result

        # Open connection
        # FIXME: add timeout
        if api.secure:
            conn = httplib.HTTPSConnection(_host)
        else:
            conn = httplib.HTTPConnection(_host)

        # Build request
        conn.request(method, url, headers=headers, body=post_data)

        # Get response
        resp = conn.getresponse()
109
        api.last_response = resp
110
111
112
        api.logger.debug('Received response...')
        api.logger.debug('  headers: %s' % resp.getheaders())
        api.logger.debug('  status code: %s' % resp.status)
Josh Roesslein's avatar
Josh Roesslein committed
113
114
115
116
117
118
119

        # If an error was returned, throw an exception
        if resp.status != 200:
            try:
                error_msg = parse_error(resp.read())
            except Exception:
                error_msg = "Twitter error response: status code = %s" % resp.status
120
            api.logger.error('  Error: %s' % error_msg)
Josh Roesslein's avatar
Josh Roesslein committed
121
122
123
            raise TweepError(error_msg)

        # Pass returned body into parser and return parser output
124
125
126
        try:
            out = parser(resp.read(), api)
        except Exception:
127
            api.logger.error("  parse error!")
128
129
            raise TweepError("Failed to parse returned data")

Josh Roesslein's avatar
Josh Roesslein committed
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
        conn.close()

        # validate result
        if api.validate:
            # list of results
            if isinstance(out, list) and len(out) > 0:
                if hasattr(out[0], 'validate'):
                    for result in out:
                        result.validate()
            # single result
            else:
                if hasattr(out, 'validate'):
                    out.validate()

        # store result in cache
        if api.cache and method == 'GET':
            api.cache.store(url, out)
147
148
149
            api.logger.debug("  caching result")

        api.logger.debug('request done.')
Josh Roesslein's avatar
Josh Roesslein committed
150
151
152

        return out

153
154
155
    # Expose extra data in callable object
    _call.allowed_param = allowed_param

Josh Roesslein's avatar
Josh Roesslein committed
156
157
    return _call