Merge pull request #33 from Clever/follow-links

Follow links

Author: aashay

README.md

@@ -56,6 +56,14 @@ If you'd like more control over pagination, or to limit the number of resources
         print students.next()
 ```
 
+You may also use the `starting_after` or `ending_before` parameters with the `iter` method:
+
+```python
+    students = clever.Student.iter(starting_after="530e5960049e75a9262cff1d")
+    for s in students:
+        print students.next()
+```
+
 The `retrieve` class method takes in a Clever ID and returns a specific resource. The object (or list of objects in the case of `all`) supports accessing properties using either dot notation or dictionary notation:
 
 ```python

clever/__init__.py

@@ -710,20 +710,21 @@ def all(cls, auth=None, **params):
 
   @classmethod
   def iter(cls, auth=None, **params):
-    for unsupported_param in ['limit', 'page', 'starting_after', 'ending_before']:
+    for unsupported_param in ['limit', 'page']:
       if unsupported_param in params:
         raise CleverError("ListableAPIResource does not support '%s' parameter" %
                           (unsupported_param,))
 
     requestor = APIRequestor(auth)
     url = cls.class_url()
-    params['limit'] = cls.ITER_LIMIT
+    params['limit'] = cls.ITER_LIMIT    
 
     while url:
       response, auth = requestor.request('get', url, params)
       for datum in convert_to_clever_object(cls, response, auth):
         yield datum
-      url = get_link(response, 'next')
+      
+      url = get_link(response, 'prev' if 'ending_before' in params else 'next')
       # params already included in url from get_link
       params = {}
 

test/test_clever.py

@@ -3,6 +3,7 @@
 import sys
 import unittest
 import httmock
+import itertools
 
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..'))
 import clever
@@ -36,9 +37,23 @@ def test_list_accessors(self):
       district = clever.District.all()[0]
       self.assertEqual(district['name'], district.name)
 
+    def test_starting_after(self):
+      allevents = clever.Event.all()
+      second_to_last_id = allevents[len(allevents)-2]['id']
+      events = clever.Event.iter(starting_after=second_to_last_id)
+      count = len(list(events))    
+      self.assertTrue(count==1)
+
+    def test_ending_before(self):
+      allevents = clever.Event.all()
+      second_id = allevents[1]['id']
+      events = clever.Event.iter(ending_before=second_id)
+      count = len(list(events))    
+      self.assertTrue(count==1)
+
     def test_unicode(self):
       # Make sure unicode requests can be sent
-      self.assertRaises(clever.InvalidRequestError, clever.District.retrieve, id=u'☃')
+      self.assertRaises(clever.APIError, clever.District.retrieve, id=u'☃')
 
     def test_none_values(self):
       district = clever.District.all(sort=None)[0]
@@ -76,6 +91,20 @@ def test_iter(self):
     for district in clever.District.iter():
       self.assertTrue(district.id)
 
+  def test_starting_after(self):
+    allevents = clever.Event.all()
+    second_to_last_id = allevents[len(allevents)-2]['id']
+    events = clever.Event.iter(starting_after=second_to_last_id)
+    count = len(list(events))    
+    self.assertTrue(count==1)
+
+  def test_ending_before(self):
+    allevents = clever.Event.all()
+    second_id = allevents[1]['id']
+    events = clever.Event.iter(ending_before=second_id)
+    count = len(list(events))    
+    self.assertTrue(count==1)
+
   def test_iter_count(self):
       r = requests.get('https://api.clever.com/v1.1/students?count=true',
           headers={'Authorization': 'Bearer DEMO_TOKEN'})
@@ -89,10 +118,6 @@ def test_iter_count(self):
   def test_unsupported_params(self):
     self.assertRaises(clever.CleverError, lambda: clever.District.all(page=2))
     self.assertRaises(clever.CleverError, lambda: clever.District.all(limit=10))
-    self.assertRaises(clever.CleverError, lambda: clever.District.all(
-        starting_after='4fd43cc56d11340000000005'))
-    self.assertRaises(clever.CleverError, lambda: clever.District.all(
-        ending_before='4fd43cc56d11340000000005'))
     self.assertRaises(clever.CleverError, lambda: clever.District.all(page=2, limit=10))
 
   def test_unicode(self):
@@ -160,7 +185,7 @@ def test_rate_limiter(self):
   suite = unittest.TestSuite()
   for TestClass in [
           functional_test({"api_key": "DEMO_KEY"}),
-          functional_test({"token": "7f76343d50b9e956138169e8cbb4630bb887b18"}),
+          functional_test({"token": "DEMO_TOKEN"}),
           AuthenticationErrorTest,
           InvalidRequestErrorTest,
           TooManyRequestsErrorTest]: