Added support for order_by kwarg on .filter() and .where()

bendavis78 · bendavis78 · commit 34f94d7696c7 · 2018-10-25T14:22:21.000-05:00
diff --git a/quickbooks/mixins.py b/quickbooks/mixins.py
@@ -163,16 +163,18 @@ def all(cls, start_position="", max_results=100, qb=None):
         return cls.where("", start_position=start_position, max_results=max_results, qb=qb)
 
     @classmethod
-    def filter(cls, start_position="", max_results="", qb=None, **kwargs):
+    def filter(cls, order_by="", start_position="", max_results="", qb=None, **kwargs):
         """
+        :param order_by:
         :param start_position:
         :param max_results:
         :param qb:
         :param kwargs: field names and values to filter the query
         :return: Filtered list
         """
         return cls.where(build_where_clause(**kwargs),
-                         start_position=start_position, max_results=max_results, qb=qb)
+                         start_position=start_position, max_results=max_results, order_by=order_by,
+                         qb=qb)
 
     @classmethod
     def choose(cls, choices, field="Id", qb=None):
@@ -185,9 +187,10 @@ def choose(cls, choices, field="Id", qb=None):
         return cls.where(build_choose_clause(choices, field), qb=qb)
 
     @classmethod
-    def where(cls, where_clause="", start_position="", max_results="", qb=None):
+    def where(cls, where_clause="", order_by="", start_position="", max_results="", qb=None):
         """
         :param where_clause: QBO SQL where clause (DO NOT include 'WHERE')
+        :param order_by:
         :param start_position:
         :param max_results:
         :param qb:
@@ -196,14 +199,17 @@ def where(cls, where_clause="", start_position="", max_results="", qb=None):
         if where_clause:
             where_clause = "WHERE " + where_clause
 
+        if order_by:
+            order_by = " ORDERBY " + order_by
+
         if start_position:
             start_position = " STARTPOSITION " + str(start_position)
 
         if max_results:
             max_results = " MAXRESULTS " + str(max_results)
 
-        select = "SELECT * FROM {0} {1}{2}{3}".format(
-            cls.qbo_object_name, where_clause, start_position, max_results)
+        select = "SELECT * FROM {0} {1}{2}{3}{4}".format(
+            cls.qbo_object_name, where_clause, order_by, start_position, max_results)
 
         return cls.query(select, qb=qb)
 
diff --git a/tests/unit/test_mixins.py b/tests/unit/test_mixins.py
@@ -13,6 +13,7 @@
 
 from quickbooks.objects.base import PhoneNumber, QuickbooksBaseObject
 from quickbooks.objects.department import Department
+from quickbooks.objects.customer import Customer
 from quickbooks.objects.journalentry import JournalEntry, JournalEntryLine
 from quickbooks.objects.salesreceipt import SalesReceipt
 from quickbooks.mixins import ObjectListMixin
@@ -157,7 +158,8 @@ def test_all_with_qb(self):
     @patch('quickbooks.mixins.ListMixin.where')
     def test_filter(self, where):
         Department.filter(max_results=25, start_position='1', Active=True)
-        where.assert_called_once_with("Active = True", max_results=25, start_position='1', qb=None)
+        where.assert_called_once_with("Active = True", max_results=25, start_position='1',
+                                      order_by='', qb=None)
 
     def test_filter_with_qb(self):
         with patch.object(self.qb_client, 'query') as query:
@@ -166,13 +168,13 @@ def test_filter_with_qb(self):
 
     @patch('quickbooks.mixins.ListMixin.query')
     def test_where(self, query):
-        Department.where("Active=True", 1, 10)
+        Department.where("Active=True", start_position=1, max_results=10)
         query.assert_called_once_with("SELECT * FROM Department WHERE Active=True STARTPOSITION 1 MAXRESULTS 10",
                                       qb=None)
 
     def test_where_with_qb(self):
         with patch.object(self.qb_client, 'query') as query:
-            Department.where("Active=True", 1, 10, qb=self.qb_client)
+            Department.where("Active=True", start_position=1, max_results=10, qb=self.qb_client)
             self.assertTrue(query.called)
 
     @patch('quickbooks.mixins.QuickBooks.query')
@@ -202,6 +204,16 @@ def test_count(self, query):
         count = Department.count(where_clause="Active=True", qb=self.qb_client)
         query.assert_called_once_with("SELECT COUNT(*) FROM Department WHERE Active=True")
 
+    @patch('quickbooks.mixins.ListMixin.query')
+    def test_order_by(self, query):
+        Customer.filter(Active=True, order_by='DisplayName')
+        query.assert_called_once_with("SELECT * FROM Customer WHERE Active = True ORDERBY DisplayName", qb=None)
+
+    def test_order_by_with_qb(self):
+        with patch.object(self.qb_client, 'query') as query:
+            Customer.filter(Active=True, order_by='DisplayName', qb=self.qb_client)
+            self.assertTrue(query.called)
+
 
 class ReadMixinTest(unittest.TestCase):
     def setUp(self):
