]> jfr.im git - z_archive/twitter.git/blobdiff - twitter/api.py
Cleanup argument parsing to support default format in config file
[z_archive/twitter.git] / twitter / api.py
index bc7f3c3feb8166935aea5d7af96be92cde42b762..c913dc2850a2656c47e48b57a505a659014b1885 100644 (file)
@@ -2,7 +2,7 @@
 from base64 import b64encode
 from urllib import urlencode
 
-import httplib
+import urllib2
 
 from exceptions import Exception
 
@@ -22,64 +22,76 @@ class TwitterError(Exception):
     """
     pass
 
+# These actions require POST http requests instead of GET
+_POST_ACTIONS = [
+    "create", "update", "destroy", "new", "follow", "leave",
+    ]
+
 class TwitterCall(object):
-    def __init__(self, username, password, format, domain, uri=""):
+    def __init__(
+        self, username, password, format, domain, uri="", agent=None):
         self.username = username
         self.password = password
         self.format = format
-        self.uri = uri
         self.domain = domain
+        self.uri = uri
+        self.agent = agent
     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.uri + "/" + k, self.agent)
     def __call__(self, **kwargs):
+        uri = self.uri
         method = "GET"
-        if (self.uri.endswith('new') 
-            or self.uri.endswith('update')
-            or self.uri.endswith('create')
-            or self.uri.endswith('destroy')):
-            method = "POST"
+        for action in _POST_ACTIONS:
+            if self.uri.endswith(action):
+                method = "POST"
+                if (self.agent):
+                    kwargs["source"] = self.agent
+                break
         
+        id = kwargs.pop('id', None)
+        if id:
+            uri += "/%s" %(id)
+            
         encoded_kwargs = urlencode(kwargs.items())
         argStr = ""
-        if kwargs and (method == "GET"):
-            argStr = "?" + encoded_kwargs
+        argData = None
+        encoded_kwargs = urlencode(kwargs.items())
+        if kwargs:
+            if (method == "GET"):
+                argStr = "?%s" %(encoded_kwargs)
+            else:
+                argData = encoded_kwargs
 
         headers = {}
+        if (self.agent):
+            headers["X-Twitter-Client"] = self.agent
         if (self.username):
             headers["Authorization"] = "Basic " + b64encode("%s:%s" %(
                 self.username, self.password))
-        if method == "POST":
-            headers["Content-type"] = "application/x-www-form-urlencoded"
-            headers["Content-length"] = len(encoded_kwargs)
         
-        c = httplib.HTTPConnection(self.domain)
+        req = urllib2.Request(
+                "http://%s/%s.%s%s" %(self.domain, self.uri, self.format, argStr),
+                argData, headers
+            )
         try:
-            c.putrequest(method, "%s.%s%s" %(
-                self.uri, self.format, argStr))
-            for item in headers.iteritems():
-                c.putheader(*item)
-            c.endheaders()
-            if method == "POST":
-                c.send(encoded_kwargs)
-            r = c.getresponse()
-
-            if (r.status == 304):
-                return []
-            elif (r.status != 200):
-                raise TwitterError("Twitter sent status %i: %s" %(
-                    r.status, r.read()))
+            handle = urllib2.urlopen(req) 
             if "json" == self.format:
-                return json.loads(r.read())
+                return json.loads(handle.read())
             else:
-                return r.read()
-        finally:
-            c.close()
-
+                return handle.read()
+        except urllib2.HTTPError, e:
+            if (e.code == 304):
+                return []
+            else:
+                raise TwitterError(
+                    "Twitter sent status %i for URL: %s.%s using parameters: (%s)\ndetails: %s" %(
+                        e.code, uri, self.format, encoded_kwargs, e.fp.read()))
+            
 class Twitter(TwitterCall):
     """
     The minimalist yet fully featured Twitter API class.
@@ -89,8 +101,8 @@ class Twitter(TwitterCall):
 
     The Twitter API is documented here:
 
-        http://apiwiki.twitter.com/
-        http://groups.google.com/group/twitter-development-talk/web/api-documentation
+      http://apiwiki.twitter.com/
+      http://groups.google.com/group/twitter-development-talk/web/api-documentation
     
     Examples::
     
@@ -112,13 +124,13 @@ class Twitter(TwitterCall):
 
     Searching Twitter::
         
-        twitter_search = Twitter(domain="search.twitter.com")
+      twitter_search = Twitter(domain="search.twitter.com")
 
-        # Find the latest search trends
-        twitter_search.trends()
+      # Find the latest search trends
+      twitter_search.trends()
 
-        # Search for the latest News on #gaza
-        twitter_search(q="#gaza")
+      # Search for the latest News on #gaza
+      twitter_search.search(q="#gaza")
 
     Using the data returned::
 
@@ -143,7 +155,9 @@ class Twitter(TwitterCall):
       The output will not be parsed in any way. It will be a raw string
       of XML.
     """
-    def __init__(self, email=None, password=None, format="json", domain="twitter.com"):
+    def __init__(
+        self, email=None, password=None, format="json", domain="twitter.com",
+        agent=None):
         """
         Create a new twitter API connector using the specified
         credentials (email and password). Format specifies the output
@@ -151,6 +165,6 @@ class Twitter(TwitterCall):
         """
         if (format not in ("json", "xml")):
             raise TwitterError("Unknown data format '%s'" %(format))
-        TwitterCall.__init__(self, email, password, format, domain)
+        TwitterCall.__init__(self, email, password, format, domain, "", agent)
 
 __all__ = ["Twitter", "TwitterError"]