Skip to content
This repository was archived by the owner on Apr 9, 2021. It is now read-only.

Python 2 and 3 compatibility #28

Merged
davemarchevsky merged 1 commit into from
Dec 18, 2013
Merged

Python 2 and 3 compatibility #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
build
dist
bitly_api.egg-info
*.pyc
*.pyc
*.swp
9 changes: 4 additions & 5 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
language: python
python:
- 2.6
- 2.7
- "2.6"
- "2.7"
- "3.3"
env:
global:
secure: mpFkhLxiDEpGeAMfcSx601ZFykkrKilpWch6qsx62qNhZTVrf33bru9hFooi/NpGGx+2A+epRj705BibAG8OUvjJBJCAZnrNbrn/j9XsBwA4bmsoDzLg+7eaElneX3J+MWlT4419nVhnH+k3W1yRX+0HrsmE+5mGmxuIE4DdIpI=
install: pip install flake8
script:
- ./run_tests.sh
- flake8 bitly_api
script: ./run_tests.sh
3 changes: 2 additions & 1 deletion bitly_api/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from bitly_api import Connection, BitlyError, Error
from __future__ import absolute_import
from bitly_api.bitly_api import Connection, BitlyError, Error
__version__ = '0.3'
__author__ = "Jehiah Czebotar <[email protected]>"

@davemarchevsky davemarchevsky Dec 18, 2013

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this need to be updated to @jsocol? Not sure what the convention is

@jsocol jsocol Dec 18, 2013

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typically this stays as the original author or maintainer and something like a CONTRIBUTORS file would have people who come later. I'm not too worried about it, unless Jehiah would rather have his bitly email there.

__all__ = ["Connection", "BitlyError", "Error"]
Expand Down
111 changes: 69 additions & 42 deletions bitly_api/bitly_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,34 @@
import bitly_http
import hashlib
try:
import json
except ImportError:
import simplejson as json
import json
import sys
import time
import types
import urllib
import warnings

try:
from urllib.request import build_opener, HTTPRedirectHandler
from urllib.parse import urlencode
from urllib.error import URLError, HTTPError
string_types = str,
integer_types = int,
numeric_types = (int, float)
text_type = str
binary_type = bytes
except ImportError as e:
from urllib2 import build_opener, HTTPRedirectHandler, URLError, HTTPError
from urllib import urlencode
string_types = basestring,
integer_types = (int, long)
numeric_types = (int, long, float)
text_type = unicode
binary_type = str


class DontRedirect(HTTPRedirectHandler):
def redirect_response(self, req, fp, code, msg, headers, newurl):
if code in (301, 302, 303, 307):
raise HTTPError(req.get_full_url(), code, msg, headers, fp)


class Error(Exception):
pass
Expand All @@ -22,9 +41,9 @@ def __init__(self, code, message):


def _utf8(s):
if isinstance(s, unicode):
if isinstance(s, text_type):
s = s.encode('utf-8')
assert isinstance(s, str)
assert isinstance(s, binary_type)
return s


Expand All @@ -35,7 +54,7 @@ def _utf8_params(params):
for k, v in params.items():
if v is None:
continue
if isinstance(v, (int, long, float)):
if isinstance(v, numeric_types):
v = str(v)
if isinstance(v, (list, tuple)):
v = [_utf8(x) for x in v]
Expand Down Expand Up @@ -314,26 +333,26 @@ def user_link_history(self, created_before=None, created_after=None,
private=None):
params = dict()
if created_before is not None:
assert isinstance(limit, int)
assert isinstance(limit, integer_types)
params["created_before"] = created_before
if created_after is not None:
assert isinstance(limit, int)
assert isinstance(limit, integer_types)
params["created_after"] = created_after
if archived is not None:
assert isinstance(archived, str)
assert isinstance(archived, string_types)
archived = archived.lower()
assert archived is "on" or "off" or "both"
params["archived"] = archived
if private is not None:
assert isinstance(private, str)
assert isinstance(private, string_types)
private = private.lower()
assert private is "on" or "off" or "both"
params["private"] = private
if limit is not None:
assert isinstance(limit, int)
assert isinstance(limit, integer_types)
params["limit"] = str(limit)
if offset is not None:
assert isinstance(offset, int)
assert isinstance(offset, integer_types)
params["offset"] = str(offset)
data = self._call_oauth2("v3/user/link_history", params)
return data["link_history"]
Expand All @@ -346,10 +365,10 @@ def user_network_history(self, offset=None, expand_client_id=False,
if expand_user is True:
params["expand_user"] = "true"
if offset is not None:
assert isinstance(offset, int)
assert isinstance(offset, integer_types)
params["offset"] = str(offset)
if limit is not None:
assert isinstance(limit, int)
assert isinstance(limit, integer_types)
params["limit"] = str(limit)
data = self._call_oauth2("v3/user/network_history", params)
return data
Expand Down Expand Up @@ -508,10 +527,10 @@ def bundle_create(self, private=False, title=None, description=None):
if private:
params["private"] = "true"
if title is not None:
assert isinstance(title, str)
assert isinstance(title, string_types)
params["title"] = title
if description is not None:
assert isinstance(description, str)
assert isinstance(description, string_types)
params["description"] = description
data = self._call_oauth2_metrics("v3/bundle/create", params)
return data
Expand All @@ -521,13 +540,13 @@ def bundle_edit(self, bundle_link, edit=None, title=None, description=None,
"""edit a bundle for the authenticated user"""
params = dict(bundle_link=bundle_link)
if edit:
assert isinstance(edit, str)
assert isinstance(edit, string_types)
params["edit"] = edit
if title:
assert isinstance(title, str)
assert isinstance(title, string_types)
params["title"] = title
if description:
assert isinstance(description, str)
assert isinstance(description, string_types)
params["description"] = description
if private is not None:
if private:
Expand All @@ -540,7 +559,7 @@ def bundle_edit(self, bundle_link, edit=None, title=None, description=None,
else:
params["preview"] = "false"
if og_image:
assert isinstance(og_image, str)
assert isinstance(og_image, string_types)
params["og_image"] = og_image
data = self._call_oauth2_metrics("v3/bundle/edit", params)
return data
Expand All @@ -549,7 +568,7 @@ def bundle_link_add(self, bundle_link, link, title=None):
"""add a link to a bundle"""
params = dict(bundle_link=bundle_link, link=link)
if title:
assert isinstance(title, str)
assert isinstance(title, string_types)
params["title"] = title
data = self._call_oauth2_metrics("v3/bundle/link_add", params)
return data
Expand Down Expand Up @@ -581,7 +600,7 @@ def bundle_link_edit(self, bundle_link, link, edit, title=None,
params = dict(bundle_link=bundle_link, link=link)
if edit == "title":
params["edit"] = edit
assert isinstance(title, str)
assert isinstance(title, string_types)
params["title"] = title
elif edit == "preview":
params["edit"] = edit
Expand Down Expand Up @@ -681,16 +700,16 @@ def search(self, query, offset=None, cities=None, domain=None, fields=None,
limit=10, lang='en'):
params = dict(query=query, lang=lang)
if offset:
assert isinstance(offset, int)
assert isinstance(offset, integer_types)
params["offset"] = str(offset)
if cities: # TODO: check format
assert isinstance(cities, str)
assert isinstance(cities, string_types)
params["cities"] = cities
if domain:
assert isinstance(domain, str)
assert isinstance(domain, string_types)
params["domain"] = domain
if fields:
assert isinstance(fields, str)
assert isinstance(fields, string_types)
params["fields"] = fields
data = self._call_oauth2_metrics("v3/search", params, limit=limit)
return data['results']
Expand Down Expand Up @@ -723,26 +742,27 @@ def _call_oauth2_metrics(self, endpoint, params, unit=None, units=None,
assert unit in ("minute", "hour", "day", "week", "mweek", "month")
params["unit"] = unit
if units is not None:
assert isinstance(units, int), "Unit (%r) must be integer" % units
assert isinstance(units, integer_types), \
"Unit (%r) must be integer" % units
params["units"] = units
if tz_offset is not None:
# tz_offset can either be a hour offset, or a timezone like
# North_America/New_York
if isinstance(tz_offset, int):
if isinstance(tz_offset, integer_types):
msg = "integer tz_offset must be between -12 and 12"
assert -12 <= tz_offset <= 12, msg
else:
assert isinstance(tz_offset, (str, unicode))
assert isinstance(tz_offset, string_types)
params["tz_offset"] = tz_offset
if rollup is not None:
assert isinstance(rollup, bool)
params["rollup"] = "true" if rollup else "false"
if limit is not None:
assert isinstance(limit, int)
assert isinstance(limit, integer_types)
params["limit"] = limit
if unit_reference_ts is not None:
assert (unit_reference_ts == 'now' or
isinstance(unit_reference_ts, (int, long)))
isinstance(unit_reference_ts, integer_types))
params["unit_reference_ts"] = unit_reference_ts

return self._call_oauth2(endpoint, params)
Expand Down Expand Up @@ -773,21 +793,28 @@ def _call(self, host, method, params, secret=None, timeout=5000):
'scheme': scheme,
'host': host,
'method': method,
'params': urllib.urlencode(params, doseq=1)
'params': urlencode(params, doseq=1)
}

try:
http_response = bitly_http.get(request, timeout,
user_agent=self.user_agent)
if http_response['http_status_code'] != 200:
raise BitlyError(500, http_response['result'])
if not http_response['result'].startswith('{'):
raise BitlyError(500, http_response['result'])
data = json.loads(http_response['result'])
opener = build_opener(DontRedirect())
opener.addheaders = [('User-agent', self.user_agent + ' urllib')]
response = opener.open(request)
code = response.code
result = response.read().decode('utf-8')
if code != 200:
raise BitlyError(500, result)
if not result.startswith('{'):

@davemarchevsky davemarchevsky Dec 18, 2013

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We talked about this in person and decided it was OK for now, but recording here for posterity.

>>> json.loads(' {"a":"b"} ')
{u'a': u'b'}
>>> ' {"a":"b"} '.startswith('{')
False

So although our API won't return json with whitespace padding, we shouldn't be doing a startswith check here.

raise BitlyError(500, result)
data = json.loads(result)
if data.get('status_code', 500) != 200:
raise BitlyError(data.get('status_code', 500),
data.get('status_txt', 'UNKNOWN_ERROR'))
return data
except URLError as e:
raise BitlyError(500, str(e))
except HTTPError as e:
raise BitlyError(e.code, e.read())
except BitlyError:
raise
except Exception:
Expand Down
77 changes: 0 additions & 77 deletions bitly_api/bitly_http.py
View file
Open in desktop

This file was deleted.

9 changes: 8 additions & 1 deletion test/test_bitly_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,12 @@ def testProDomain():
try:
result = bitly.pro_domain(domain)
assert result == test_data[domain], domain
except bitly_api.BitlyError, e:
except bitly_api.BitlyError as e:
assert str(e) == test_data[domain]


def testUserInfo():
bitly = get_connection()
data = bitly.user_info()
assert data is not None
assert 'login' in data