Merge pull request ej2#68 from Tesorio/to-dict

ej2 · web-flow · commit 62d2852cb40d · 2017-02-19T11:14:05.000-06:00
ToDictMixin
diff --git a/quickbooks/mixins.py b/quickbooks/mixins.py
@@ -1,4 +1,5 @@
 import simplejson as json
+import six
 from .utils import build_where_clause, build_choose_clause
 from .client import QuickBooks
 from .exceptions import QuickbooksException
@@ -50,6 +51,42 @@ def from_json(cls, json_data):
         return obj
 
 
+# Based on http://stackoverflow.com/a/1118038
+def to_dict(obj, classkey=None):
+    """
+    Recursively converts Python object into a dictionary
+    """
+    if isinstance(obj, dict):
+        data = {}
+        for (k, v) in obj.items():
+            data[k] = to_dict(v, classkey)
+        return data
+    elif hasattr(obj, "_ast"):
+        return to_dict(obj._ast())
+    elif hasattr(obj, "__iter__") and not isinstance(obj, str):
+        return [to_dict(v, classkey) for v in obj]
+    elif hasattr(obj, "__dict__"):
+        if six.PY2:
+            data = dict([(key, to_dict(value, classkey))
+                        for key, value in obj.__dict__.iteritems()
+                        if not callable(value) and not key.startswith('_')])
+        else:
+            data = dict([(key, to_dict(value, classkey))
+                        for key, value in obj.__dict__.items()
+                        if not callable(value) and not key.startswith('_')])
+
+        if classkey is not None and hasattr(obj, "__class__"):
+            data[classkey] = obj.__class__.__name__
+        return data
+    else:
+        return obj
+
+
+class ToDictMixin(object):
+    def to_dict(self):
+        return to_dict(self)
+
+
 class ReadMixin(object):
     qbo_object_name = ""
 
diff --git a/quickbooks/objects/base.py b/quickbooks/objects/base.py
@@ -1,8 +1,8 @@
 from six import python_2_unicode_compatible
-from ..mixins import ToJsonMixin, FromJsonMixin, ReadMixin, ListMixin, UpdateMixin
+from ..mixins import ToJsonMixin, FromJsonMixin, ReadMixin, ListMixin, UpdateMixin, ToDictMixin
 
 
-class QuickbooksBaseObject(ToJsonMixin, FromJsonMixin):
+class QuickbooksBaseObject(ToJsonMixin, FromJsonMixin, ToDictMixin):
     class_dict = {}
     list_dict = {}
     detail_dict = {}
@@ -66,7 +66,7 @@ def __str__(self):
 
 
 @python_2_unicode_compatible
-class PhoneNumber(ToJsonMixin, FromJsonMixin):
+class PhoneNumber(ToJsonMixin, FromJsonMixin, ToDictMixin):
     def __init__(self):
         self.FreeFormNumber = ""
 
diff --git a/tests/unit/test_mixins.py b/tests/unit/test_mixins.py
@@ -62,6 +62,63 @@ def test_from_json_missing_detail_object(self):
         self.assertEquals(new_obj.TotalAmt, 100)
 
 
+class ToDictMixinTest(unittest.TestCase):
+    def test_to_dict(self):
+        json_data = {
+            'DocNumber': '123',
+            'TotalAmt': 100,
+            'Line': [
+                {
+                    "Id": "0",
+                    "Description": "Test",
+                    "Amount": 25.54,
+                    "DetailType": "JournalEntryLineDetail",
+                    "JournalEntryLineDetail": {
+                        "PostingType": "Debit",
+                    }
+                },
+            ],
+        }
+
+        entry = JournalEntry.from_json(json_data)
+        expected = {
+            'DocNumber': '123',
+            'SyncToken': 0,
+            'domain': 'QBO',
+            'TxnDate': '',
+            'TotalAmt': 100,
+            'ExchangeRate': 1,
+            'CurrencyRef': None,
+            'PrivateNote': '',
+            'sparse': False,
+            'Line': [{
+                'LinkedTxn': [],
+                'Description': 'Test',
+                'JournalEntryLineDetail': {
+                    'TaxAmount': 0,
+                    'Entity': None,
+                    'DepartmentRef': None,
+                    'TaxCodeRef': None,
+                    'BillableStatus': '',
+                    'TaxApplicableOn': 'Sales',
+                    'PostingType': 'Debit',
+                    'AccountRef': None,
+                    'ClassRef': None,
+                },
+                'DetailType': 'JournalEntryLineDetail',
+                'LineNum': 0,
+                'Amount': 25.54,
+                'CustomField': [],
+                'Id': '0',
+            }],
+            'Adjustment': False,
+            'Id': None,
+            'TxnTaxDetail': None,
+        }
+
+        self.assertEquals(expected, entry.to_dict())
+
+
 class ListMixinTest(unittest.TestCase):
     def setUp(self):
         self.qb_client = client.QuickBooks(
