V0.2

New API:
api.photos_favorites
api.photos_votes
api.users_search
api.comments_post()

Bug Fix:
#3

Author: akirahrkw

README.md

@@ -10,53 +10,56 @@ this library was inspired by tweepy(https://github.com/tweepy/tweepy), python-in
     pip install python-500px
 
 ## Requires
-  * httplib2
   * simplejson
 
 ## Usage
-
 	from fivehundredpx.client import FiveHundredPXAPI
 	from fivehundredpx.auth   import *
-	
+
 	unauthorized_api = FiveHundredPXAPI(handler)
+	unauthorized_api.users_show(consumer_key=CONSUMER_KEY, id='727199')
 
-	handler = OAuthHandler(CONSUMER_KEY,CONSUMER_SECRET)
-	handler.set_access_token(OAUTH_TOKEN,OAUTH_TOKEN_SECRET)
+	handler = OAuthHandler(CONSUMER_KEY, CONSUMER_SECRET)
+	handler.set_access_token(OAUTH_TOKEN, OAUTH_TOKEN_SECRET)
 	api = FiveHundredPXAPI(handler)
 	api.users()
 
 ## Authentication
- 
-- ** initialize **
-    handler = OAuthHandler(CONSUMER_KEY,CONSUMER_SECRET)
-
-- **handler.get_authorization_url()** - get a url for authorization. **[authorize][]** 
-- **handler.get_access_token(verifier)** - get an access token. **[access_token][]**
-    token = handler.get_access_token(verifier)
-    print "this is your access token:\n%s" % token.key
-    print "this is your access token secret:\n%s" % token.secret
+    please check 500px's authentication document(https://github.com/500px/api-documentation/tree/master/authentication)
+    tests/oauth.py shows how to get request/access token.
 
-- **handler.get_xauth_access_token(username,password)** - get an access token by using xAuth.
+    verifier:
+    self.handler.get_authorization_url() # go to this url and get verifier
+    token = self.handler.get_access_token(verifier)
+    token.key, token.secret
 
+    xauth:
+    token = self.handler.get_request_token()
+    self.handler.set_request_token(token.key, token.secret)
+    token = self.handler.get_xauth_access_token(username, password)
+    token.key, token.secret
 
 ## Methods
 
   * api.photos()
   * api.photos_search()
   * api.photos_id()
   * api.photos_post()
+  * api.photos_update()
   * api.photos_delete()
   * api.photos_comments()
   * api.photos_comments_post()
+  * api.photos_favorites()
   * api.photos_favorite_post()
   * api.photos_favorite_delete()
   * api.photos_tags_post()
   * api.photos_tags_delete()
+  * api.photos_votes()
   * api.photos_vote_post()
   * api.upload_photo()
-  * api.photos_update()
   * api.users()
   * api.users_show()
+  * api.users_search()
   * api.users_friends()
   * api.users_followers()
   * api.users_friends_post()
@@ -68,15 +71,22 @@ this library was inspired by tweepy(https://github.com/tweepy/tweepy), python-in
   * api.blogs_post()
   * api.blogs_delete()
   * api.blogs_update()
+  * api.comments_post()
   * api.collections()
   * api.collections_id()
   * api.collections_post()
   * api.collections_update()
   * api.collections_delete()
 
-please check test.py
-
+## Test
+  python tests/oauth.py      [cunsumer_key] [consumer_secret]
+  python tests/blog.py       [cunsumer_key] [consumer_secret] [oauth_token] [oauth_token_secret]
+  python tests/collection.py [cunsumer_key] [consumer_secret] [oauth_token] [oauth_token_secret]
+  python tests/user.py       [cunsumer_key] [consumer_secret] [oauth_token] [oauth_token_secret]
+  python tests/photo.py      [cunsumer_key] [consumer_secret] [oauth_token] [oauth_token_secret]
+  python tests/upload.py     [cunsumer_key] [consumer_secret] [oauth_token] [oauth_token_secret]
 
+[authentication]: https://github.com/500px/api-documentation/tree/master/authentication
 [authorize]: https://github.com/500px/api-documentation/blob/master/authentication/POST_oauth_authorize.md
 [request_token]: https://github.com/500px/api-documentation/blob/master/authentication/POST_oauth_requesttoken.md
 [access_token]: https://github.com/500px/api-documentation/blob/master/authentication/POST_oauth_accesstoken.md

fivehundredpx/auth.py

@@ -45,6 +45,7 @@ def apply_auth(self,url,method,headers,parameters):
         )
         request.sign_request(self._sigmethod,self._consumer,self.access_token)
         headers.update(request.to_header())
+        return request
 
     def get_authorization_url(self):
         try:

fivehundredpx/bind.py

@@ -1,4 +1,4 @@
-from fivehundredpx.utils   import encode_string
+from fivehundredpx.utils   import Util
 from fivehundredpx.errors  import *
 import urllib, re, httplib, time, simplejson
 
@@ -14,59 +14,78 @@ class APIMethod(object):
         model_class    = config.get('model_class',None)
         response_type  = config.get('response_type','list')
         require_auth   = config.get('require_auth',False)
+        as_query       = config.get('as_query',False)
 
-        def __init__(self,api,*args,**kwargs):
+        def __init__(self, api, *args, **kwargs):
             '''parameters for every request'''
             if self.require_auth and not api.auth_handler: raise FiveHundredClientError('auth handler is required')
-			
+
             self.api 		  = api
             self.parameters   = {}
             self.as_generator = kwargs.pop("as_generator", False)
             self.max_pages 	  = kwargs.pop("max_pages", 3)
             self.headers      = kwargs.pop('headers', {})
-            self.body         = kwargs.pop('http_body', None)
+            self.body         = kwargs.pop('http_body', {})
             self.protocol     = 'https://' if self.api.secure else 'http://'
             if 'method'       in kwargs: self.method = kwargs.pop('method')
             if 'require_auth' in kwargs: self.require_auth = kwargs.pop('require_auth')
             self._build_parameters(args, kwargs)
             self._build_path()
 
-        def _build_parameters(self,args,kwargs):
+        def _build_parameters(self, args, kwargs):
             for index,value in enumerate(args):
                 if value is None: continue
                 try:
-                    self.parameters[self.allowed_params[index]] = encode_string(value)
+                    self.parameters[self.allowed_params[index]] = value
                 except IndexError:
                     raise FiveHundredsClientError("Too many arguments supplied")
 
             for key,value in kwargs.iteritems():
                 if value is None: continue
-                self.parameters[key] = encode_string(value)
-		
+                if type(value) in (list, tuple):
+                    self.parameters[key + "[]"] = value
+                else:
+                    self.parameters[key] = value
+
         def _build_path(self):
             for variable in re_path_template.findall(self.path):
                 name = variable.strip('{}')			
                 try:
-                    value = urllib.quote(self.parameters[name])
+                    value = urllib.quote(str(self.parameters[name]))
                     del self.parameters[name]
                     self.path = self.path.replace(variable,value)
                 except KeyError:
                     raise FiveHundredsClientError('No parameter value found for path variable: %s' % name)
 
         def _execute(self):
+            url = "%s%s%s%s" % (self.protocol,self.api.host,self.api.version,self.path)
+
+            if self.method == "GET" or self.as_query == True:
+                param_list = []
+                for key, value in self.parameters.iteritems():
+                    if type(value) in (list, tuple):
+                        for v in value:
+                            param_list.append("%s=%s" % (key, v))                   
+                    else:
+                        param_list.append("%s=%s" % (key, Util.replace_space(value)))
+
+                if len(param_list) != 0 : url = "%s?%s" % (url, "&".join(param_list))
+
+            elif self.method == "POST" or self.method == "PUT":
+                if self.headers.has_key('Content-Type') == False:
+                    self.headers['Content-Type'] = "application/x-www-form-urlencoded; charset=UTF-8"
 
-            url    = "%s%s%s%s" % (self.protocol,self.api.host,self.api.version,self.path)
-            params = urllib.urlencode(self.parameters) if len(self.parameters) != 0 else ''
+            postdata = None
+            if self.require_auth and self.api.auth_handler:
+                request = self.api.auth_handler.apply_auth(url, self.method, self.headers, self.parameters)
+                if not self.method == "GET": postdata = request.to_postdata()
 
-    	    if self.require_auth and self.api.auth_handler:
-                self.api.auth_handler.apply_auth(url, self.method, self.headers, self.parameters)
+            if self.path == "/upload": postdata = self.body
 
-            if not params == '': url = "%s?%s" % (url,params)
-            
             for count in xrange(self.api.retry_count):
                 conn = httplib.HTTPSConnection(self.api.host) if self.api.secure else httplib.HTTPConnection(self.api.host)
                 try:
-                    conn.request(self.method, url, body=self.body, headers=self.headers)
+                    conn.request(self.method, url, body=postdata, headers=self.headers)
                     response = conn.getresponse()
                 except Exception, e:
                     conn.close()

fivehundredpx/client.py

@@ -1,7 +1,7 @@
 from fivehundredpx       import settings
 from fivehundredpx.auth  import *
 from fivehundredpx.bind  import bind_api
-from fivehundredpx.utils import *
+from fivehundredpx.utils import FileUtil
 
 class FiveHundredPXAPI(object):
 
@@ -15,61 +15,60 @@ def __init__(self,auth_handler=None,host=None,secure=True,version=None,retry_cou
         self.retry_delay  = retry_delay or settings.RETRY_DELAY
         self.retry_errors = retry_errors
 
+    #### Photo API
+    # https://github.com/500px/api-documentation/tree/master/endpoints/photo
     photos 		           = bind_api(path='/photos')
-    photos_search          = bind_api(path='/photos/search')
+    photos_search          = bind_api(path='/photos/search', require_auth=True)
     photos_id 	           = bind_api(path='/photos/{id}', allowed_params=['id'])
     photos_post            = bind_api(path='/photos', method='POST', require_auth=True)
+    photos_update          = bind_api(path='/photos/{id}', method='PUT', require_auth=True, as_query=False)
     photos_delete          = bind_api(path='/photos/{id}', method='DELETE', allowed_params=['id'],require_auth=True)
     photos_comments        = bind_api(path='/photos/{id}/comments', allowed_params=['id'])
     photos_comments_post   = bind_api(path='/photos/{id}/comments', method='POST', allowed_params=['id'], require_auth=True)
+    photos_favorites       = bind_api(path='/photos/{id}/favorites', allowed_params=['id'], require_auth=True)
     photos_favorite_post   = bind_api(path='/photos/{id}/favorite', method='POST', allowed_params=['id'], require_auth=True)
     photos_favorite_delete = bind_api(path='/photos/{id}/favorite', method='DELETE', allowed_params=['id'], require_auth=True)
     photos_tags_post       = bind_api(path='/photos/{id}/tags', method='POST', allowed_params=['id'], require_auth=True)
-    photos_tags_delete     = bind_api(path='/photos/{id}/tags', method='DELETE', allowed_params=['id'], require_auth=True)
-    photos_vote_post       = bind_api(path='/photos/{id}/vote', method='POST', allowed_params=['id'], require_auth=True)
+    photos_tags_delete     = bind_api(path='/photos/{id}/tags', method='DELETE', allowed_params=['id'], require_auth=True, as_query=True)
+    photos_votes           = bind_api(path='/photos/{id}/votes', allowed_params=['id'], require_auth=True)
+    photos_vote_post       = bind_api(path='/photos/{id}/vote', method='POST', allowed_params=['id'], require_auth=True, as_query=True)
+    photos_report          = bind_api(path='/photos/{id}/report', method='POST', allowed_params=['id'], require_auth=True)
 
     def upload_photo(self, filename=None,fp=None,file_type=None, **kwargs):
-        headers,body = create_body_by_filepath(filename,'file',kwargs) if fp==None else create_body_by_fp(fp, 'file', file_type, kwargs) 
+        headers,body = FileUtil.create_body_by_filepath(filename,'file',kwargs) if fp==None else FileUtil.create_body_by_fp(fp, 'file', file_type, kwargs) 
         return bind_api(
             path = '/upload',
-            method = 'POST',
-            require_auth = True
+            method = 'POST'
         )(self,http_body=body, headers=headers)
 
-    def photos_update(self, id, **kwargs):
-        headers,body = create_body(kwargs)
-        return bind_api(
-            path='/photos/{id}',
-            method = 'PUT',
-            allowed_params=['id'],
-            require_auth = True
-        )(self,id=id, http_body=body, headers=headers)
-
+    #### User API
+    # https://github.com/500px/api-documentation/tree/master/endpoints/user
     users                = bind_api(path='/users', require_auth=True)
     users_show           = bind_api(path='/users/show')
+    users_search         = bind_api(path='/users/search')
     users_friends        = bind_api(path='/users/{id}/friends', allowed_params=['id'])
     users_followers      = bind_api(path='/users/{id}/followers', allowed_params=['id'])
     users_friends_post   = bind_api(path='/users/{id}/friends', method='POST', allowed_params=['id'])
     users_friends_delete = bind_api(path='/users/{id}/friends', method='DELETE', allowed_params=['id'])
 
+    #### Blog API
+    # https://github.com/500px/api-documentation/tree/master/endpoints/blog
     blogs               = bind_api(path='/blogs')
     blogs_id            = bind_api(path='/blogs/{id}', allowed_params=['id'])
     blogs_comments      = bind_api(path='/blogs/{id}/comments', allowed_params=['id'])
     blogs_comments_post = bind_api(path='/blogs/{id}/comments', require_auth=True, allowed_params=['id'], method='POST')
     blogs_post          = bind_api(path='/blogs', require_auth=True, method='POST')
+    blogs_update        = bind_api(path='/blogs/{id}', require_auth=True, allowed_params=['id'], method='PUT')
     blogs_delete        = bind_api(path='/blogs/{id}', require_auth=True, allowed_params=['id'], method='DELETE')
+    
+    #### Comment API
+    # https://github.com/500px/api-documentation/tree/master/endpoints/comments
+    comments_post = bind_api(path='/comments/{id}/comments', require_auth=True, allowed_params=['id'], method='POST')
 
-    def blogs_update(self, id, **kwargs):
-        headers,body = create_body(kwargs)
-        return bind_api(
-            path='/blogs/{id}',
-            method = 'PUT',
-            allowed_params=['id'],
-            require_auth = True
-        )(self,id=id, http_body=body, headers=headers)
-
-    collections        = bind_api(path='/collections')
-    collections_id     = bind_api(path='/collections/{id}', allowed_params=['id'])
-    collections_post   = bind_api(path='/collections', require_auth=True, method='POST')
-    collections_update = bind_api(path='/collections/{id}', require_auth=True, method='POST', allowed_params=['id'])
-    collections_delete = bind_api(path='/collections/{id}', require_auth=True, method='DELETE', allowed_params=['id'])
+    #### Collection API
+    # https://github.com/500px/api-documentation/tree/master/endpoints/collections
+    collections        = bind_api(path='/collections', require_auth=True)
+    collections_id     = bind_api(path='/collections/{id}', require_auth=True, allowed_params=['id'])
+    collections_post   = bind_api(path='/collections', require_auth=True, method='POST', as_query=True)
+    collections_update = bind_api(path='/collections/{id}', require_auth=True, method='PUT', allowed_params=['id'], as_query=True)
+    collections_delete = bind_api(path='/collections/{id}', require_auth=True, method='DELETE', allowed_params=['id'], as_query=True)

fivehundredpx/oauth.py

@@ -211,9 +211,11 @@ def to_header(self, realm=''):
 
     def to_postdata(self):
         """Serialize as post data for a POST request."""
-        return '&'.join(['%s=%s' % (escape(str(k)), escape(str(v))) \
+        # return '&'.join(['%s=%s' % (escape(str(k)), escape(str(v))) \
+        #     for k, v in self.parameters.iteritems()])
+        return '&'.join(['%s=%s' % (escape(str(k)), str(v).replace(" ", "+")) \
             for k, v in self.parameters.iteritems()])
-
+	
     def to_url(self):
         """Serialize as a URL for a GET request."""
         return '%s?%s' % (self.get_normalized_http_url(), self.to_postdata())
@@ -227,8 +229,17 @@ def get_normalized_parameters(self):
         except:
             pass
         # Escape key values before sorting.
-        key_values = [(escape(_utf8_str(k)), escape(_utf8_str(v))) \
-            for k,v in params.items()]
+        # key_values = [(escape(_utf8_str(k)), escape(_utf8_str(v))) \
+        #     for k,v in params.items()]
+        
+        # for this param: image_size[]=2&image_size[]=3
+        key_values = []
+        for k,v in params.items():
+            if type(v) in (list, tuple):
+                [ key_values.append( (escape(_utf8_str(k)), escape(_utf8_str(_v)) )) for _v in v ]
+            else:
+                key_values.append( (escape(_utf8_str(k)), escape(_utf8_str(v)) ) )
+    
         # Sort lexicographically, first after key, then after value.
         key_values.sort()
         # Combine key value pairs into a string.