added order_by to .all()

bendavis78 · bendavis78 · commit 0920ee83b055 · 2018-10-25T15:07:00.000-05:00
diff --git a/README.rst b/README.rst
@@ -198,6 +198,19 @@ Filtered list of objects:
 
     customers = Customer.filter(Active=True, FamilyName="Smith", qb=client)
 
+Filtered list of objects with ordering:
+
+.. code-block:: python
+
+    # Get customer invoices ordered by TxnDate
+    invoices = Invoice.filter(CustomerRef='100', order_by='TxnDate', qb=client)
+    
+    # Same, but in reverse order
+    invoices = Invoice.filter(CustomerRef='100', order_by='TxnDate DESC', qb=client)
+    
+    # Order customers by FamilyName then by GivenName
+    customers = Customer.all(order_by='FamilyName, GivenName', qb=client)
+
 Filtered list of objects with paging:
 
 .. code-block:: python
@@ -217,6 +230,12 @@ List with custom Where Clause (do not include the ``"WHERE"``):
 
     customers = Customer.where("Active = True AND CompanyName LIKE 'S%'", qb=client)
 
+List with custom Where and ordering:
+
+.. code-block:: python
+
+    customers = Customer.where("Active = True AND CompanyName LIKE 'S%'", order_by='DisplayName', qb=client)
+
 List with custom Where Clause and paging:
 
 .. code-block:: python
@@ -443,4 +462,4 @@ on Python 2.
 .. |Coverage Status| image:: https://coveralls.io/repos/sidecars/python-quickbooks/badge.svg?branch=master&service=github
    :target: https://coveralls.io/github/sidecars/python-quickbooks?branch=master
 
-.. _OAuth 1.0 vs. OAuth 2.0: https://developer.intuit.com/docs/0100_quickbooks_online/0100_essentials/000500_authentication_and_authorization/0010_oauth_1.0a_vs_oauth_2.0_apps
+.. _OAuth 1.0 vs. OAuth 2.0: https://developer.intuit.com/docs/0100_quickbooks_online/0100_essentials/000500_authentication_and_authorization/0010_oauth_1.0a_vs_oauth_2.0_apps
diff --git a/quickbooks/mixins.py b/quickbooks/mixins.py
@@ -153,14 +153,15 @@ class ListMixin(object):
     qbo_object_name = ""
 
     @classmethod
-    def all(cls, start_position="", max_results=100, qb=None):
+    def all(cls, order_by="", start_position="", max_results=100, qb=None):
         """
         :param start_position:
         :param max_results: The max number of entities that can be returned in a response is 1000.
         :param qb:
         :return: Returns list
         """
-        return cls.where("", start_position=start_position, max_results=max_results, qb=qb)
+        return cls.where("", order_by=order_by, start_position=start_position,
+                         max_results=max_results, qb=qb)
 
     @classmethod
     def filter(cls, order_by="", start_position="", max_results="", qb=None, **kwargs):
diff --git a/tests/unit/test_mixins.py b/tests/unit/test_mixins.py
@@ -148,7 +148,7 @@ def setUp(self):
     @patch('quickbooks.mixins.ListMixin.where')
     def test_all(self, where):
         Department.all()
-        where.assert_called_once_with('', max_results=100, start_position='', qb=None)
+        where.assert_called_once_with('', order_by='', max_results=100, start_position='', qb=None)
 
     def test_all_with_qb(self):
         with patch.object(self.qb_client, 'query') as query:
