iter_all

surbas · surbas · commit afbbf2c3d643 · 2018-03-05T21:50:33.000-05:00
diff --git a/README.rst b/README.rst
@@ -42,7 +42,9 @@ provides CRUD operations, depending on capabilities of the resource:
 
 .. code:: python
 
-    api.Products.all()                         # GET /products
+    api.Products.all()                         # GET /products (returns only a single page of products as a list)
+    api.Products.iterall()                     # GET /products (autopaging generator that yields all
+                                               #                  products from all pages product by product.)
     api.Products.get(1)                        # GET /products/1
     api.Products.create(name='', type='', ...) # POST /products
     api.Products.get(1).update(price='199.90') # PUT /products/1
@@ -110,7 +112,7 @@ Full documentation of the API is available on the Bigcommerce
 To do
 -----
 
--  Automatic enumeration of multiple page responses
+-  Automatic enumeration of multiple page responses for subresources.
 
 .. |Build Status| image:: https://api.travis-ci.org/bigcommerce/bigcommerce-api-python.svg?branch=master
    :target: https://travis-ci.org/bigcommerce/bigcommerce-api-python
diff --git a/bigcommerce/resources/base.py b/bigcommerce/resources/base.py
@@ -99,7 +99,19 @@ def _get_all_path(cls):
         return cls.resource_name
 
     @classmethod
-    def all(cls, connection=None, **kwargs):
+    def all(cls, connection=None, **params):
+        """
+            Returns first page if no params passed in as a list.
+        """
+
+        request = cls._make_request('GET', cls._get_all_path(), connection, params=params)
+        return cls._create_object(request, connection=connection)
+
+    @classmethod
+    def iterall(cls, connection=None, **kwargs):
+        """
+            Returns a autopaging generator that yields each object returned one by one.
+        """
 
         try:
             limit = kwargs['limit']
