testing error checking

Author: Claudio

bitly.py

@@ -45,7 +45,7 @@ def __init__(self, login, apikey):
         self.apikey = apikey
         self._urllib = urllib2
 
-    def shorten(self,longURLs,params={}):
+    def shorten(self, longURLs, params={}):
         """ 
             Takes either:
             A long URL string and returns shortened URL string
@@ -55,39 +55,31 @@ def shorten(self,longURLs,params={}):
         if not isinstance(longURLs, list):
             longURLs = [longURLs]
             want_result_list = False
-        
-        for index,url in enumerate(longURLs):
-            if not '://' in url:
-                longURLs[index] = "http://" + url
 
-        request = self._getURL("shorten",longURLs,params)
+        request = self._getURL("shorten", longURLs, params)
         result = self._fetchUrl(request)
         json = simplejson.loads(result)
-        self._CheckForError(json)
+        Api._CheckForError(json)
 
         results = json['results']
-        res = [self._extract_short_url(results[url]) for url in longURLs]
 
+        res = [results[url].get('shortUrl', None) for url in longURLs]
+        
         if want_result_list:
             return res
         else:
             return res[0]
 
-    def _extract_short_url(self,item):
-        if item['shortKeywordUrl'] == "":
-            return item['shortUrl']
-        else:
-            return item['shortKeywordUrl']
 
-    def expand(self,shortURL,params={}):
+    def expand(self, shortURL, params={}):
         """ Given a bit.ly url or hash, return long source url """
         request = self._getURL("expand",shortURL,params)
         result = self._fetchUrl(request)
         json = simplejson.loads(result)
-        self._CheckForError(json)
+        Api._CheckForError(json)
         return json['results'][string.split(shortURL, '/')[-1]]['longUrl']
 
-    def info(self,shortURL,params={}):
+    def info(self, shortURL, params={}):
         """ 
         Given a bit.ly url or hash, 
         return information about that page, 
@@ -96,23 +88,23 @@ def info(self,shortURL,params={}):
         request = self._getURL("info",shortURL,params)
         result = self._fetchUrl(request)
         json = simplejson.loads(result)
-        self._CheckForError(json)
+        Api._CheckForError(json)
         return json['results'][string.split(shortURL, '/')[-1]]
 
-    def stats(self,shortURL,params={}):
+    def stats(self, shortURL, params={}):
         """ Given a bit.ly url or hash, return traffic and referrer data.  """
         request = self._getURL("stats",shortURL,params)
         result = self._fetchUrl(request)
         json = simplejson.loads(result)
-        self._CheckForError(json)
+        Api._CheckForError(json)
         return Stats.NewFromJsonDict(json['results'])
 
-    def errors(self,params={}):
+    def errors(self, params={}):
         """ Get a list of bit.ly API error codes. """
         request = self._getURL("errors","",params)
         result = self._fetchUrl(request)
         json = simplejson.loads(result)
-        self._CheckForError(json)
+        Api._CheckForError(json)
         return json['results']
 
     def setUrllib(self, urllib):
@@ -123,7 +115,7 @@ def setUrllib(self, urllib):
         '''
         self._urllib = urllib
 
-    def _getURL(self,verb,paramVal,more_params={}): 
+    def _getURL(self, verb, paramVal, more_params={}): 
         if not isinstance(paramVal, list):
             paramVal = [paramVal]
 
@@ -145,7 +137,7 @@ def _getURL(self,verb,paramVal,more_params={}):
         encoded_params = urllib.urlencode(params)
         return "%s%s?%s" % (BITLY_BASE_URL,verb,encoded_params)
 
-    def _fetchUrl(self,url):
+    def _fetchUrl(self, url):
         '''Fetch a URL
     
         Args:
@@ -159,7 +151,8 @@ def _fetchUrl(self,url):
         url_data = self._urllib.urlopen(url).read()
         return url_data    
 
-    def _CheckForError(self, data):
+    @classmethod
+    def _CheckForError(cls, data):
         """Raises a BitlyError if bitly returns an error message.
     
         Args:
@@ -171,7 +164,7 @@ def _CheckForError(self, data):
         # to check first, rather than try and catch the exception
         if 'ERROR' in data or data['statusCode'] == 'ERROR':
             raise BitlyError, data['errorMessage']
-        for key in data['results']:
+        for key in data['results']:            
             if type(data['results']) is dict and type(data['results'][key]) is dict:
                 if 'statusCode' in data['results'][key] and data['results'][key]['statusCode'] == 'ERROR':
                     raise BitlyError, data['results'][key]['errorMessage'] 
@@ -202,8 +195,8 @@ def NewFromJsonDict(data):
 
 
 if __name__ == '__main__':
-    testURL1="www.yahoo.com"
-    testURL2="www.cnn.com"
+    testURL1="http://www.yahoo.com"
+    testURL2="http://www.cnn.com"
     a=Api(login="pythonbitly",apikey="R_06871db6b7fd31a4242709acaf1b6648")
     short=a.shorten(testURL1)    
     print "Short URL = %s" % short
@@ -220,6 +213,6 @@ def NewFromJsonDict(data):
     print "User clicks %s, total clicks: %s" % (stats.user_clicks,stats.total_clicks)
     errors=a.errors()
     print "Errors: %s" % errors
-    testURL3=["www.google.com"]
+    testURL3=["http://www.google.com"]
     short=a.shorten(testURL3) 
     print "Short url in list = %s" % short

test/test_shortening_urls.py

@@ -2,16 +2,19 @@
 #-*- coding:utf-8 -*-
 
 from nose.tools import assert_raises
+from mox import Mox
 
 import bitly
 
-def test_urls_shortening_scenario():
 
+def test_urls_shortening_scenario_for_plain_urls():
     api = bitly.Api(login='jcfigueiredo', apikey='R_1cf5dc0fa14c2df34261fb620bd256aa')
+    
     yield should_raise_when_an_invalid_credential_is_provided
     yield should_have_an_API_authenticated_by_my_credentials, api
-    yield should_shorten_an_url_consistently_when_a_single_string_urls_is_provided, api
+    yield should_shorten_an_url_consistently_when_a_single_string_url_is_provided, api
     yield should_shorten_many_urls_consistently_when_a_list_of_urls_is_provided, api
+    yield should_shorten_an_urls_with_querystring, api
 
 def should_raise_when_an_invalid_credential_is_provided():
     api = bitly.Api(login='inexistent_login', apikey='or_invalid_key')
@@ -20,23 +23,76 @@ def should_raise_when_an_invalid_credential_is_provided():
 def should_have_an_API_authenticated_by_my_credentials(api):
     assert api, 'Should have a valid API'
 
-def should_shorten_an_url_consistently_when_a_single_string_urls_is_provided(api):
+def should_shorten_an_url_consistently_when_a_single_string_url_is_provided(api):
     url_to_be_shortened = 'http://globoesporte.globo.com/motor/formula-1/noticia/2010/10/apos-maus-resultados-ferrari-reforca-apoio-massa-no-fim-da-temporada.html'
     expected_url = 'http://bit.ly/9n93fw'
-
+    
     shortened_url = api.shorten(longURLs=url_to_be_shortened)
-
+    
     assert shortened_url == expected_url, 'The shortened version of %s url should\'ve been %s but was %s' % (url_to_be_shortened, expected_url, shortened_url)
 
 def should_shorten_many_urls_consistently_when_a_list_of_urls_is_provided(api):
     urls_to_be_shortened = [ 'http://globoesporte.globo.com/motor/formula-1/noticia/2010/10/apos-maus-resultados-ferrari-reforca-apoio-massa-no-fim-da-temporada.html'
     ,
  'http://globoesporte.globo.com/basquete/noticia/2010/10/leandrinho-faz-19-pontos-na-vitoria-do-toronto-sobre-o-philadelphia.html'
     ]
-
+    
     expected_urls = ['http://bit.ly/9n93fw','http://bit.ly/aprECg']
-
+    
     shortened_urls = api.shorten(longURLs=urls_to_be_shortened)
-
+    
     for expected_url in expected_urls:
         assert expected_url in shortened_urls, 'The list os shortened urls should contain %s but it wasn\'t found in %s' % (expected_url, shortened_urls)
+
+
+def test_urls_shortening_scenario_for_urls_with_query_string():
+    api = bitly.Api(login='jcfigueiredo', apikey='R_1cf5dc0fa14c2df34261fb620bd256aa')
+    
+    yield should_have_an_API_authenticated_by_my_credentials, api
+    yield should_shorten_an_urls_with_querystring, api
+
+def should_shorten_an_urls_with_querystring(api):
+    
+    url_to_be_shortened = 'http://www.google.com/search?q=globo.com'
+    expected_url = 'http://bit.ly/9Rc5qD'
+    
+    shortened_url = api.shorten(longURLs=url_to_be_shortened)
+    
+    assert shortened_url == expected_url, 'The shortened version of %s url should\'ve been %s but was %s' % (url_to_be_shortened, expected_url, shortened_url)
+
+
+def test_checking_for_errors():
+    yield verifying_invalid_error_key
+    yield verifying_invalid_status_code
+    yield verifying_invalid_status_code_and_invalid_error_key
+    yield verifying_invalid_status_code
+
+def verifying_invalid_error_key():
+    #invalid error key
+    invalid_data = {'ERROR': 'any', 'errorMessage': 'something went wrong'} 
+    assert_raises(bitly.BitlyError, bitly.Api._CheckForError, invalid_data)
+
+def verifying_invalid_status_code():
+    #invalid status code
+    invalid_data = {'statusCode': 'ERROR', 'errorMessage': 'something went wrong'} 
+    assert_raises(bitly.BitlyError, bitly.Api._CheckForError, invalid_data)
+
+def verifying_invalid_status_code_and_invalid_error_key():
+    #both above
+    invalid_data = {'ERROR': 'any', 'statusCode': 'ERROR', 'errorMessage': 'something went wrong'} 
+    assert_raises(bitly.BitlyError, bitly.Api._CheckForError, invalid_data)
+
+def verifying_invalid_item():
+    #invalid item
+    invalid_data = {'results': 
+                        {'http://shorturl.com': {
+                                    'statusCode': 'ERROR',
+                                    'errorMessage': 'something went really wrong'
+                                    }
+                        }
+        ,
+        'statusCode': 'ANY BUT ERROR'
+    }
+    assert_raises(bitly.BitlyError, bitly.Api._CheckForError, invalid_data)
+
+