Refactor model construction from results.

* move sub type & dependent type declarations to the model classes
* dependent_sub_types moves to the sub type classes themselves
* simplify construct/init_* methods

Author: rcoup

chargebee/model.py

@@ -4,16 +4,11 @@
 class Model(object):
     fields = []           # field list
     repr_field = None     # field to use for repr(), default is fields[0]
+    sub_types = {}        # mapping {attr: type}
+    dependant_types = {}  # mapping {attr: type}. If type is a 1-tuple, indicates it's a list.
 
-    def __init__(self, values, sub_types=None, dependant_types=None):
-        if sub_types is None:
-            sub_types = {}
-        if dependant_types is None:
-            dependant_types = {}
-
+    def __init__(self, values):
         self.values = values
-        self.sub_types = sub_types
-        self.dependant_types = dependant_types
         for field in self.fields:
             setattr(self, field, None)
 
@@ -49,21 +44,15 @@ def __getattr__(self, name):
         raise AttributeError("Attribute %s not found " % name)
 
     @classmethod
-    def construct(cls, values, sub_types=None, dependant_types=None):
-        obj = cls(values, sub_types, dependant_types)
+    def construct(cls, values):
+        obj = cls(values)
         obj.load(values)
+        for k, dependent_type in cls.dependant_types.items():
+            if values.get(k) is not None:
+                if isinstance(dependent_type, tuple):
+                    # dependent type being a 1-tuple indicates a list
+                    set_val = [dependent_type[0].construct(v) for v in values[k]]
+                else:
+                    set_val = dependent_type.construct(values[k])
+                setattr(obj, k, set_val)
         return obj
-
-    def init_dependant(self, obj, type, sub_types={}):
-        if obj.get(type) != None:
-            if isinstance(obj, dict) and type in self.dependant_types:
-                dependant_obj = self.dependant_types[type].construct(obj[type], sub_types)
-                setattr(self, type, dependant_obj)
-
-    def init_dependant_list(self, obj, type, sub_types={}):
-        if obj.get(type) != None:
-            if isinstance(obj[type],(list, tuple)) and type in self.dependant_types:
-                if(self.dependant_types != None):
-                    set_val = [self.dependant_types[type].construct(dt, sub_types) for dt in obj[type]]
-                    setattr(self, type, set_val)
-

chargebee/models/addon.py

@@ -15,6 +15,9 @@ class Tier(Model):
     "shipping_frequency_period_unit", "resource_version", "updated_at", "invoice_notes", "taxable", \
     "tax_profile_id", "meta_data", "tiers"]
 
+    sub_types = {
+        'tiers' : Tier,
+    }
 
     @staticmethod
     def create(params, env=None, headers=None):

chargebee/models/credit_note.py

@@ -36,6 +36,17 @@ class Allocation(Model):
     "round_off_amount", "fractional_correction", "line_items", "discounts", "line_item_discounts", \
     "line_item_tiers", "taxes", "line_item_taxes", "linked_refunds", "allocations", "deleted"]
 
+    sub_types = {
+      'line_items': LineItem,
+      'discounts': Discount,
+      'line_item_discounts': LineItemDiscount,
+      'line_item_tiers' : LineItemTier,
+      'taxes': Tax,
+      'line_item_taxes': LineItemTax,
+      'linked_refunds': LinkedRefund,
+      'allocations': Allocation,
+    }
+
 
     @staticmethod
     def create(params, env=None, headers=None):

chargebee/models/customer.py

@@ -35,6 +35,14 @@ class Relationship(Model):
     "registered_for_gst", "business_customer_without_vat_number", "customer_type", "client_profile_id", \
     "relationship"]
 
+    sub_types = {
+        'billing_address': BillingAddress,
+        'referral_urls': ReferralUrl,
+        'contacts': Contact,
+        'payment_method': PaymentMethod,
+        'balances': Balance,
+        'relationship': Relationship,
+    }
 
     @staticmethod
     def create(params=None, env=None, headers=None):

chargebee/models/estimate.py

@@ -3,11 +3,26 @@
 from chargebee import request
 from chargebee import APIError
 
+from chargebee.models.credit_note_estimate import CreditNoteEstimate
+from chargebee.models.invoice_estimate import InvoiceEstimate
+from chargebee.models.subscription_estimate import SubscriptionEstimate
+from chargebee.models.unbilled_charge import UnbilledCharge
+
+
 class Estimate(Model):
 
     fields = ["created_at", "subscription_estimate", "invoice_estimate", "invoice_estimates", \
     "next_invoice_estimate", "credit_note_estimates", "unbilled_charge_estimates"]
 
+    dependant_types = {
+        'subscription_estimate': SubscriptionEstimate,
+        'invoice_estimate': InvoiceEstimate,
+        'next_invoice_estimate': InvoiceEstimate,
+        'invoice_estimates': (InvoiceEstimate,),
+        'credit_note_estimates': (CreditNoteEstimate,),
+        'unbilled_charge_estimates': (UnbilledCharge,),
+    }
+
 
     @staticmethod
     def create_subscription(params, env=None, headers=None):

chargebee/models/event.py

@@ -12,6 +12,11 @@ class Webhook(Model):
     fields = ["id", "occurred_at", "source", "user", "webhook_status", "webhook_failure_reason", \
     "webhooks", "event_type", "api_version"]
 
+    sub_types = {
+        'webhooks': Webhook,
+    }
+
+
     @property
     def content(self):
         from chargebee import Content
@@ -23,12 +28,12 @@ def deserialize(json_data):
             webhook_data = json.loads(json_data)
         except (TypeError, ValueError) as ex:
             raise Exception("The passed json_data is not JSON formatted . " + ex.message)
-        
+
         api_version = webhook_data.get('api_version', None)
         env_version = Environment.API_VERSION
-        if api_version != None and api_version.upper() != env_version.upper(): 
+        if api_version != None and api_version.upper() != env_version.upper():
             raise Exception("API version [" + api_version.upper() + "] in response does not match "
-                    + "with client library API version [" + env_version.upper() + "]")  
+                    + "with client library API version [" + env_version.upper() + "]")
         return Event.construct(webhook_data)
 
     @staticmethod

chargebee/models/export.py

@@ -9,6 +9,11 @@ class Download(Model):
       pass
 
     fields = ["id", "operation_type", "mime_type", "status", "created_at", "download"]
+
+    sub_types = {
+        'download': Download,
+    }
+
     def wait_for_export_completion(self):
         return wait_for_export_completion()
 

chargebee/models/gift.py

@@ -17,6 +17,11 @@ class GiftTimeline(Model):
     fields = ["id", "status", "scheduled_at", "auto_claim", "no_expiry", "claim_expiry_date", \
     "resource_version", "updated_at", "gifter", "gift_receiver", "gift_timelines"]
 
+    sub_types = {
+        'gifter': Gifter,
+        'gift_receiver': GiftReceiver,
+        'gift_timelines': GiftTimeline,
+    }
 
     @staticmethod
     def create(params, env=None, headers=None):

chargebee/models/invoice.py

@@ -62,6 +62,24 @@ class BillingAddress(Model):
     "linked_payments", "dunning_attempts", "applied_credits", "adjustment_credit_notes", "issued_credit_notes", \
     "linked_orders", "notes", "shipping_address", "billing_address", "payment_owner", "deleted"]
 
+    sub_types = {
+      'line_items': LineItem,
+      'discounts': Discount,
+      'line_item_discounts': LineItemDiscount,
+      'taxes': Tax,
+      'line_item_taxes': LineItemTax,
+      'line_item_tiers': LineItemTier,
+      'linked_payments': LinkedPayment,
+      'dunning_attempts': DunningAttempt,
+      'applied_credits': AppliedCredit,
+      'adjustment_credit_notes': AdjustmentCreditNote,
+      'issued_credit_notes': IssuedCreditNote,
+      'linked_orders': LinkedOrder,
+      'notes': Note,
+      'shipping_address': ShippingAddress,
+      'billing_address': BillingAddress,
+    }
+
 
     @staticmethod
     def create(params, env=None, headers=None):

chargebee/models/invoice_estimate.py

@@ -27,3 +27,11 @@ class LineItemDiscount(Model):
     "amount_paid", "amount_due", "line_items", "discounts", "taxes", "line_item_taxes", "line_item_tiers", \
     "line_item_discounts", "round_off_amount", "customer_id"]
 
+    sub_types = {
+      'line_items': LineItem,
+      'discounts': Discount,
+      'taxes': Tax,
+      'line_item_taxes': LineItemTax,
+      'line_item_tiers' : LineItemTier,
+      'line_item_discounts': LineItemDiscount,
+    }