Merge branch 'seajosh-master'

Author: Jon Heaton

README.md

@@ -2,7 +2,7 @@
 
 python-instagram
 ======
-A Python client for the Instagram REST and Search APIs
+A Python 2/3 client for the Instagram REST and Search APIs
 
 Installation
 -----
@@ -12,6 +12,7 @@ Requires
 -----
   * httplib2
   * simplejson
+  * six
 
 
 Instagram REST and Search APIs

get_access_token.py

@@ -14,10 +14,17 @@
     except Exception:
         pass
 
-client_id = raw_input("Client ID: ").strip()
-client_secret = raw_input("Client Secret: ").strip()
-redirect_uri = raw_input("Redirect URI: ").strip()
-raw_scope = raw_input("Requested scope (separated by spaces, blank for just basic read): ").strip()
+# Fix Python 2.x.
+try:
+    import __builtin__
+    input = getattr(__builtin__, 'raw_input')
+except (ImportError, AttributeError):
+    pass
+
+client_id = input("Client ID: ").strip()
+client_secret = input("Client Secret: ").strip()
+redirect_uri = input("Redirect URI: ").strip()
+raw_scope = input("Requested scope (separated by spaces, blank for just basic read): ").strip()
 scope = raw_scope.split(' ')
 # For basic, API seems to need to be set explicitly
 if not scope or scope == [""]:
@@ -26,10 +33,11 @@
 api = InstagramAPI(client_id=client_id, client_secret=client_secret, redirect_uri=redirect_uri)
 redirect_uri = api.get_authorize_login_url(scope = scope)
 
-print "Visit this page and authorize access in your browser:\n", redirect_uri
+print ("Visit this page and authorize access in your browser: "+ redirect_uri)
 
-code = raw_input("Paste in code in query string after redirect: ").strip()
+code = (str(input("Paste in code in query string after redirect: ").strip()))
 
 access_token = api.exchange_code_for_access_token(code)
-print "access token:\n", access_token
+print ("access token: " )
+print (access_token)
 

instagram/__init__.py

@@ -1,2 +1,2 @@
-from bind import InstagramAPIError, InstagramClientError
-from client import InstagramAPI
+from .bind import InstagramAPIError, InstagramClientError
+from .client import InstagramAPI

instagram/bind.py

@@ -1,16 +1,19 @@
 import urllib
-from oauth2 import OAuth2Request
+from .oauth2 import OAuth2Request
 import re
-from json_import import simplejson
+from .json_import import simplejson
 import hmac
 from hashlib import sha256
+import six
+from six.moves.urllib.parse import quote
+import sys
 
 re_path_template = re.compile('{\w+}')
 
 
 def encode_string(value):
     return value.encode('utf-8') \
-                        if isinstance(value, unicode) else str(value)
+        if isinstance(value, six.text_type) else str(value)
 
 
 class InstagramClientError(Exception):
@@ -76,7 +79,7 @@ def _build_parameters(self, args, kwargs):
                 except IndexError:
                     raise InstagramClientError("Too many arguments supplied")
 
-            for key, value in kwargs.iteritems():
+            for key, value in six.iteritems(kwargs):
                 if value is None:
                     continue
                 if key in self.parameters:
@@ -91,7 +94,7 @@ def _build_path(self):
                 name = variable.strip('{}')
 
                 try:
-                    value = urllib.quote(self.parameters[name])
+                    value = quote(self.parameters[name])
                 except KeyError:
                     raise Exception('No parameter value found for path variable: %s' % name)
                 del self.parameters[name]
@@ -119,23 +122,19 @@ def _do_api_request(self, url, method="GET", body=None, headers=None):
                 ips = self.api.client_ips
                 signature = hmac.new(secret, ips, sha256).hexdigest()
                 headers['X-Insta-Forwarded-For'] = '|'.join([ips, signature])
-
             response, content = OAuth2Request(self.api).make_request(url, method=method, body=body, headers=headers)
             if response['status'] == '503' or response['status'] == '429':
                 raise InstagramAPIError(response['status'], "Rate limited", "Your client is making too many request per second")
-
             try:
-                content_obj = simplejson.loads(content)
+                content_obj = simplejson.loads(content.decode())
             except ValueError:
                 raise InstagramClientError('Unable to parse response, not valid JSON.', status_code=response['status'])
-
             # Handle OAuthRateLimitExceeded from Instagram's Nginx which uses different format to documented api responses
-            if not content_obj.has_key('meta'):
+            if 'meta' not in content_obj:
                 if content_obj.get('code') == 420 or content_obj.get('code') == 429:
                     error_message = content_obj.get('error_message') or "Your client is making too many request per second"
                     raise InstagramAPIError(content_obj.get('code'), "Rate limited", error_message)
                 raise InstagramAPIError(content_obj.get('code'), content_obj.get('error_type'), content_obj.get('error_message'))
-
             api_responses = []
             status_code = content_obj['meta']['code']
             self.api.x_ratelimit_remaining = response.get("x-ratelimit-remaining",None)
@@ -166,7 +165,7 @@ def _do_api_request(self, url, method="GET", body=None, headers=None):
         def _paginator_with_url(self, url, method="GET", body=None, headers=None):
             headers = headers or {}
             pages_read = 0
-            while url and (pages_read < self.max_pages or self.max_pages is None):
+            while url and (self.max_pages is None or pages_read < self.max_pages):
                 api_responses, url = self._do_api_request(url, method, body, headers)
                 pages_read += 1
                 yield api_responses, url

instagram/client.py

@@ -1,6 +1,6 @@
-import oauth2
-from bind import bind_method
-from models import MediaShortcode, Media, User, Location, Tag, Comment, Relationship
+from . import oauth2
+from .bind import bind_method
+from .models import MediaShortcode, Media, User, Location, Tag, Comment, Relationship
 
 MEDIA_ACCEPT_PARAMETERS = ["count", "max_id"]
 SEARCH_ACCEPT_PARAMETERS = ["q", "count"]

instagram/models.py

@@ -1,4 +1,5 @@
-from helper import timestamp_to_datetime
+from .helper import timestamp_to_datetime
+import six
 
 
 class ApiModel(object):
@@ -12,7 +13,17 @@ def object_from_dictionary(cls, entry):
         return cls(**entry_str_dict)
 
     def __repr__(self):
-        return unicode(self).encode('utf8')
+        return str(self)
+        # if six.PY2:
+        #     return six.text_type(self).encode('utf8')
+        # else:
+        #     return self.encode('utf8')
+
+    def __str__(self):
+        if six.PY3:
+            return self.__unicode__()
+        else:
+            return unicode(self).encode('utf-8')
 
 
 class Image(ApiModel):
@@ -36,7 +47,7 @@ class Media(ApiModel):
 
     def __init__(self, id=None, **kwargs):
         self.id = id
-        for key, value in kwargs.iteritems():
+        for key, value in six.iteritems(kwargs):
             setattr(self, key, value)
 
     def get_standard_resolution_url(self):
@@ -67,12 +78,12 @@ def object_from_dictionary(cls, entry):
         new_media.user = User.object_from_dictionary(entry['user'])
 
         new_media.images = {}
-        for version, version_info in entry['images'].iteritems():
+        for version, version_info in six.iteritems(entry['images']):
             new_media.images[version] = Image.object_from_dictionary(version_info)
 
         if new_media.type == 'video':
             new_media.videos = {}
-            for version, version_info in entry['videos'].iteritems():
+            for version, version_info in six.iteritems(entry['videos']):
                 new_media.videos[version] = Video.object_from_dictionary(version_info)
 
         if 'user_has_liked' in entry:
@@ -113,14 +124,14 @@ class MediaShortcode(Media):
 
     def __init__(self, shortcode=None, **kwargs):
         self.shortcode = shortcode
-        for key, value in kwargs.iteritems():
+        for key, value in six.iteritems(kwargs):
             setattr(self, key, value)
 
 
 class Tag(ApiModel):
     def __init__(self, name, **kwargs):
         self.name = name
-        for key, value in kwargs.iteritems():
+        for key, value in six.iteritems(kwargs):
             setattr(self, key, value)
 
     def __unicode__(self):
@@ -129,7 +140,7 @@ def __unicode__(self):
 
 class Comment(ApiModel):
     def __init__(self, *args, **kwargs):
-        for key, value in kwargs.iteritems():
+        for key, value in six.iteritems(kwargs):
             setattr(self, key, value)
 
     @classmethod
@@ -156,7 +167,7 @@ def __unicode__(self):
 class Location(ApiModel):
     def __init__(self, id, *args, **kwargs):
         self.id = str(id)
-        for key, value in kwargs.iteritems():
+        for key, value in six.iteritems(kwargs):
             setattr(self, key, value)
 
     @classmethod
@@ -178,7 +189,7 @@ class User(ApiModel):
 
     def __init__(self, id, *args, **kwargs):
         self.id = id
-        for key, value in kwargs.iteritems():
+        for key, value in six.iteritems(kwargs):
             setattr(self, key, value)
 
     def __unicode__(self):

instagram/oauth2.py

@@ -1,7 +1,8 @@
-from json_import import simplejson
-import urllib
+from .json_import import simplejson
+from six.moves.urllib.parse import urlencode
 from httplib2 import Http
 import mimetypes
+import six
 
 
 class OAuth2AuthExchangeError(Exception):
@@ -67,7 +68,7 @@ def _url_for_authorize(self, scope=None):
         }
         if scope:
             client_params.update(scope=' '.join(scope))
-        url_params = urllib.urlencode(client_params)
+        url_params = urlencode(client_params)
         return "%s?%s" % (self.api.authorize_url, url_params)
 
     def _data_for_exchange(self, code=None, username=None, password=None, scope=None, user_id=None):
@@ -87,7 +88,7 @@ def _data_for_exchange(self, code=None, username=None, password=None, scope=None
                 client_params.update(scope=' '.join(scope))
         elif user_id:
             client_params.update(user_id=user_id)
-        return urllib.urlencode(client_params)
+        return urlencode(client_params)
 
     def get_authorize_url(self, scope=None):
         return self._url_for_authorize(scope=scope)
@@ -107,7 +108,7 @@ def exchange_for_access_token(self, code=None, username=None, password=None, sco
         http_object = Http(disable_ssl_certificate_validation=True)
         url = self.api.access_token_url
         response, content = http_object.request(url, method="POST", body=data)
-        parsed_content = simplejson.loads(content)
+        parsed_content = simplejson.loads(content.decode())
         if int(response['status']) != 200:
             raise OAuth2AuthExchangeError(parsed_content.get("error_message", ""))
         return parsed_content['access_token'], parsed_content['user']
@@ -137,7 +138,7 @@ def _full_url_with_params(self, path, params, include_secret=False):
         return (self._full_url(path, include_secret) + self._full_query_with_params(params))
 
     def _full_query_with_params(self, params):
-        params = ("&" + urllib.urlencode(params)) if params else ""
+        params = ("&" + urlencode(params)) if params else ""
         return params
 
     def _auth_query(self, include_secret=False):
@@ -150,7 +151,7 @@ def _auth_query(self, include_secret=False):
             return base
 
     def _post_body(self, params):
-        return urllib.urlencode(params)
+        return urlencode(params)
 
     def _encode_multipart(params, files):
         boundary = "MuL7Ip4rt80uND4rYF0o"
@@ -208,5 +209,7 @@ def make_request(self, url, method="GET", body=None, headers=None):
         headers = headers or {}
         if not 'User-Agent' in headers:
             headers.update({"User-Agent": "%s Python Client" % self.api.api_name})
-        http_obj = Http(disable_ssl_certificate_validation=True)
+        # https://github.com/jcgregorio/httplib2/issues/173
+        # bug in httplib2 w/ Python 3 and disable_ssl_certificate_validation=True
+        http_obj = Http() if six.PY3 else Http(disable_ssl_certificate_validation=True)        
         return http_obj.request(url, method, body=body, headers=headers)

instagram/subscriptions.py

@@ -1,6 +1,6 @@
 import hmac
 import hashlib
-from json_import import simplejson
+from .json_import import simplejson
 
 class SubscriptionType:
     TAG = 'tag'

requirements.txt

@@ -1,7 +1,7 @@
 bottle==0.12.7
-bottle-session==0.3
 httplib2==0.9
 python-instagram==1.1.3
 redis==2.10.3
 simplejson==3.6.3
 wsgiref==0.1.2
+beaker==1.6.4