Fix issue #43 TwitterHTTPError.__str__ messed up.

[z_archive/twitter.git] / twitter / api.py

diff --git a/twitter/api.py b/twitter/api.py
index 1bcf17bf06fbe1d01421fb32e833ae3fe37e594c..2c0279013fc1987cbd75bc041de8282e0e025c8b 100644 (file)
--- a/twitter/api.py
+++ b/twitter/api.py
@@ -1,22 +1,21 @@
-
-from base64 import encodestring
-from urllib import urlencode
-
-import urllib2
-
-from exceptions import Exception
+try:
+    import urllib.request as urllib_request
+    import urllib.error as urllib_error
+except ImportError:
+    import urllib2 as urllib_request
+    import urllib2 as urllib_error

 
 from twitter.twitter_globals import POST_ACTIONS
 
 from twitter.twitter_globals import POST_ACTIONS

+from twitter.auth import NoAuth

 
 

-def _py26OrGreater():
-    import sys
-    return sys.hexversion > 0x20600f0
-
-if _py26OrGreater():
+try:

     import json
     import json

-else:
+except ImportError:

     import simplejson as json
 
     import simplejson as json
 

+class _DEFAULT(object):
+    pass
+

 class TwitterError(Exception):
     """
     Base Exception thrown by the Twitter object when there is a
 class TwitterError(Exception):
     """
     Base Exception thrown by the Twitter object when there is a


@@ -29,88 +28,146 @@ class TwitterHTTPError(TwitterError):
     Exception thrown by the Twitter object when there is an
     HTTP error interacting with twitter.com.
     """
     Exception thrown by the Twitter object when there is an
     HTTP error interacting with twitter.com.
     """

-    def __init__(self, e, uri, format, encoded_args):
-      self.e = e
-      self.uri = uri
-      self.format = format
-      self.encoded_args = encoded_args
+    def __init__(self, e, uri, format, uriparts):
+        self.e = e
+        self.uri = uri
+        self.format = format
+        self.uriparts = uriparts
+        self.response_data = self.e.fp.read()

 
     def __str__(self):
 
     def __str__(self):

-        return "Twitter sent status %i for URL: %s.%s using parameters: (%s)\ndetails: %s" %(
-                    self.e.code, self.uri, self.format, self.encoded_args, self.e.fp.read())
+        return (
+            "Twitter sent status %i for URL: %s.%s using parameters: "
+            "(%s)\ndetails: %s" %(
+                self.e.code, self.uri, self.format, self.uriparts,
+                self.response_data))
+
+class TwitterResponse(object):
+    """
+    Response from a twitter request. Behaves like a list or a string
+    (depending on requested format) but it has a few other interesting
+    attributes.
+
+    `headers` gives you access to the response headers as an
+    httplib.HTTPHeaders instance. You can do
+    `response.headers.getheader('h')` to retrieve a header.
+    """
+    def __init__(self, headers):
+        self.headers = headers
+
+    @property
+    def rate_limit_remaining(self):
+        """
+        Remaining requests in the current rate-limit.
+        """
+        return int(self.headers.getheader('X-RateLimit-Remaining'))
+
+    @property
+    def rate_limit_reset(self):
+        """
+        Time in UTC epoch seconds when the rate limit will reset.
+        """
+        return int(self.headers.getheader('X-RateLimit-Reset'))
+
+
+def wrap_response(response, headers):
+    response_typ = type(response)
+    if response_typ is bool:
+        # HURF DURF MY NAME IS PYTHON AND I CAN'T SUBCLASS bool.
+        response_typ = int
+
+    class WrappedTwitterResponse(response_typ, TwitterResponse):
+        __doc__ = TwitterResponse.__doc__
+
+    return WrappedTwitterResponse(response)
+
+

 
 class TwitterCall(object):
 
 class TwitterCall(object):

+

     def __init__(
     def __init__(

-        self, username, password, format, domain, uri="", agent=None,
-        encoded_args=None, secure=True):
-        self.username = username
-        self.password = password
+        self, auth, format, domain, callable_cls, uri="",
+        uriparts=None, secure=True):
+        self.auth = auth

         self.format = format
         self.domain = domain
         self.format = format
         self.domain = domain

+        self.callable_cls = callable_cls

         self.uri = uri
         self.uri = uri

-        self.agent = agent
-        self.encoded_args = encoded_args
+        self.uriparts = uriparts

         self.secure = secure
 
     def __getattr__(self, k):
         try:
             return object.__getattr__(self, k)
         except AttributeError:
         self.secure = secure
 
     def __getattr__(self, k):
         try:
             return object.__getattr__(self, k)
         except AttributeError:

-            return TwitterCall(
-                self.username, self.password, self.format, self.domain,
-                self.uri + "/" + k, self.agent, self.encoded_args)
+            def extend_call(arg):
+                return self.callable_cls(
+                    auth=self.auth, format=self.format, domain=self.domain,
+                    callable_cls=self.callable_cls, uriparts=self.uriparts \
+                        + (arg,),
+                    secure=self.secure)
+            if k == "_":
+                return extend_call
+            else:
+                return extend_call(k)

 
     def __call__(self, **kwargs):
 
     def __call__(self, **kwargs):

-        uri = self.uri
+        # Build the uri.
+        uriparts = []
+        for uripart in self.uriparts:
+            # If this part matches a keyword argument, use the
+            # supplied value otherwise, just use the part.
+            uriparts.append(str(kwargs.pop(uripart, uripart)))
+        uri = '/'.join(uriparts)
+

         method = "GET"
         for action in POST_ACTIONS:
         method = "GET"
         for action in POST_ACTIONS:

-            if self.uri.endswith(action):
+            if uri.endswith(action):

                 method = "POST"
                 method = "POST"

-                if (self.agent):
-                    kwargs["source"] = self.agent

                 break
 
                 break
 

-        if (not self.encoded_args):
-            if kwargs.has_key('id'):
-                uri += "/%s" %(kwargs['id'])
-    
-            self.encoded_args = urlencode(kwargs.items())
-
-        argStr = ""
-        argData = None
-        if (method == "GET"):
-            if self.encoded_args:
-                argStr = "?%s" %(self.encoded_args)
-        else:
-            argData = self.encoded_args
-
-        headers = {}
-        if (self.agent):
-            headers["X-Twitter-Client"] = self.agent
-        if (self.username):
-            headers["Authorization"] = "Basic " + encodestring("%s:%s" %(
-                self.username, self.password)).strip('\n')
+        # If an id kwarg is present and there is no id to fill in in
+        # the list of uriparts, assume the id goes at the end.
+        id = kwargs.pop('id', None)
+        if id:
+            uri += "/%s" %(id)

 
         secure_str = ''
         if self.secure:
             secure_str = 's'
 
         secure_str = ''
         if self.secure:
             secure_str = 's'

+        dot = ""
+        if self.format:
+            dot = "."
+        uriBase = "http%s://%s/%s%s%s" %(
+                    secure_str, self.domain, uri, dot, self.format)
+
+        headers = {}
+        if self.auth:
+            headers.update(self.auth.generate_headers())
+            arg_data = self.auth.encode_params(uriBase, method, kwargs)
+            if method == 'GET':
+                uriBase += '?' + arg_data
+                body = None
+            else:
+                body = arg_data.encode('utf8')

 
 

-        req = urllib2.Request(
-                "http%s://%s/%s.%s%s" %(
-                    secure_str, self.domain, uri, self.format, argStr),
-                argData, headers)
-        
+        req = urllib_request.Request(uriBase, body, headers)
+        return self._handle_response(req, uri, arg_data)
+
+    def _handle_response(self, req, uri, arg_data):

         try:
         try:

-            handle = urllib2.urlopen(req)
+            handle = urllib_request.urlopen(req)

             if "json" == self.format:
             if "json" == self.format:

-                return json.loads(handle.read())
+                res = json.loads(handle.read().decode('utf8'))
+                return wrap_response(res, handle.headers)

             else:
             else:

-                return handle.read()
-        except urllib2.HTTPError, e:
+                return wrap_response(
+                    handle.read().decode('utf8'), handle.headers)
+        except urllib_error.HTTPError as e:

             if (e.code == 304):
                 return []
             else:
             if (e.code == 304):
                 return []
             else:

-                raise TwitterHTTPError(e, uri, self.format, self.encoded_args)
+                raise TwitterHTTPError(e, uri, self.format, arg_data)

 
 class Twitter(TwitterCall):
     """
 
 class Twitter(TwitterCall):
     """


@@ -121,12 +178,13 @@ class Twitter(TwitterCall):
 
     The Twitter API is documented here:
 
 
     The Twitter API is documented here:
 

-      http://apiwiki.twitter.com/
-      http://groups.google.com/group/twitter-development-talk/web/api-documentation
+      http://dev.twitter.com/doc
+

 
     Examples::
 
 
     Examples::
 

-      twitter = Twitter("hello@foo.com", "password123")
+      twitter = Twitter(
+          auth=OAuth(token, token_key, con_secret, con_secret_key)))

 
       # Get the public timeline
       twitter.statuses.public_timeline()
 
       # Get the public timeline
       twitter.statuses.public_timeline()


@@ -142,6 +200,10 @@ class Twitter(TwitterCall):
           user="billybob",
           text="I think yer swell!")
 
           user="billybob",
           text="I think yer swell!")
 

+      # Get the members of a particular list of a particular friend
+      twitter.user.listname.members(user="billybob", listname="billysbuds")
+
+

     Searching Twitter::
 
       twitter_search = Twitter(domain="search.twitter.com")
     Searching Twitter::
 
       twitter_search = Twitter(domain="search.twitter.com")


@@ -152,10 +214,12 @@ class Twitter(TwitterCall):
       # Search for the latest News on #gaza
       twitter_search.search(q="#gaza")
 
       # Search for the latest News on #gaza
       twitter_search.search(q="#gaza")
 

-    Using the data returned::

 
 

-      Twitter API calls return decoded JSON. This is converted into
-      a bunch of Python lists, dicts, ints, and strings. For example,
+    Using the data returned
+    -----------------------
+
+    Twitter API calls return decoded JSON. This is converted into
+    a bunch of Python lists, dicts, ints, and strings. For example::

 
       x = twitter.statuses.public_timeline()
 
 
       x = twitter.statuses.public_timeline()
 


@@ -165,28 +229,64 @@ class Twitter(TwitterCall):
       # The screen name of the user who wrote the first 'tweet'
       x[0]['user']['screen_name']
 
       # The screen name of the user who wrote the first 'tweet'
       x[0]['user']['screen_name']
 

-    Getting raw XML data::

 
 

-      If you prefer to get your Twitter data in XML format, pass
-      format="xml" to the Twitter object when you instantiate it:
+    Getting raw XML data
+    --------------------
+
+    If you prefer to get your Twitter data in XML format, pass
+    format="xml" to the Twitter object when you instantiate it::

 
       twitter = Twitter(format="xml")
 
       The output will not be parsed in any way. It will be a raw string
       of XML.
 
       twitter = Twitter(format="xml")
 
       The output will not be parsed in any way. It will be a raw string
       of XML.

+

     """
     def __init__(
     """
     def __init__(

-        self, email=None, password=None, format="json", domain="twitter.com",
-        agent=None, secure=True):
+        self, format="json",
+        domain="api.twitter.com", secure=True, auth=None,
+        api_version=_DEFAULT):

         """
         """

-        Create a new twitter API connector using the specified
-        credentials (email and password). Format specifies the output
-        format ("json" (default) or "xml").
+        Create a new twitter API connector.
+
+        Pass an `auth` parameter to use the credentials of a specific
+        user. Generally you'll want to pass an `OAuth`
+        instance::
+
+            twitter = Twitter(auth=OAuth(
+                    token, token_secret, consumer_key, consumer_secret))
+
+
+        `domain` lets you change the domain you are connecting. By
+        default it's `api.twitter.com` but `search.twitter.com` may be
+        useful too.
+
+        If `secure` is False you will connect with HTTP instead of
+        HTTPS.
+
+        `api_version` is used to set the base uri. By default it's
+        '1'. If you are using "search.twitter.com" set this to None.

         """
         """

-        if (format not in ("json", "xml")):
-            raise TwitterError("Unknown data format '%s'" %(format))
+        if not auth:
+            auth = NoAuth()
+
+        if (format not in ("json", "xml", "")):
+            raise ValueError("Unknown data format '%s'" %(format))
+
+        if api_version is _DEFAULT:
+            if domain == 'api.twitter.com':
+                api_version = '1'
+            else:
+                api_version = None
+
+        uriparts = ()
+        if api_version:
+            uriparts += (str(api_version),)
+

         TwitterCall.__init__(
         TwitterCall.__init__(

-            self, email, password, format, domain, "", agent, 
-            secure=secure)
+            self, auth=auth, format=format, domain=domain,
+            callable_cls=TwitterCall,
+            secure=secure, uriparts=uriparts)
+

 
 

-__all__ = ["Twitter", "TwitterError", "TwitterHTTPError"]
+__all__ = ["Twitter", "TwitterError", "TwitterHTTPError", "TwitterResponse"]