Adding changed_fields support. (intercom#40)

jkeyes · jkeyes · commit 6f278d1143e0 · 2014-09-24T00:29:56.000+01:00
* adding identity_vars to User and Company
* adding submittable_attribute method to Resource
* changing to_dict support
diff --git a/intercom/__init__.py b/intercom/__init__.py
@@ -187,7 +187,7 @@ def endpoint(cls, value):
 
 class ResourceEncoder(JSONEncoder):
     def default(self, o):
-        if hasattr(o, 'from_api'):
+        if hasattr(o, 'attributes'):
             # handle API resources
             return o.attributes
         return super(ResourceEncoder, self).default(o)
diff --git a/intercom/api_operations/save.py b/intercom/api_operations/save.py
@@ -17,7 +17,9 @@ def from_dict(self, pdict):
     @property
     def to_dict(self):
         a_dict = {}
-        for name in self.attributes.keys():
+        for name in self.__dict__.keys():
+            if name == "changed_attributes":
+                continue
             a_dict[name] = self.__dict__[name]  # direct access
         return a_dict
 
@@ -33,12 +35,13 @@ def from_response(self, response):
 
     def save(self):
         collection = utils.resource_class_to_collection_name(self.__class__)
-        params = self.__dict__
+        params = self.attributes
         if self.id_present and not self.posted_updates:
             # update
             response = Intercom.put('/%s/%s' % (collection, self.id), **params)
         else:
             # create
+            params.update(self.identity_hash)
             response = Intercom.post('/%s' % (collection), **params)
         if response:
             return self.from_response(response)
@@ -53,6 +56,8 @@ def posted_updates(self):
 
     @property
     def identity_hash(self):
-        identity_vars = getattr(self, 'identity_vars', None)
-        if identity_vars:
-            return {}
+        identity_vars = getattr(self, 'identity_vars', [])
+        parts = {}
+        for var in identity_vars:
+            parts[var] = getattr(self, var, None)
+        return parts
diff --git a/intercom/company.py b/intercom/company.py
@@ -6,3 +6,4 @@
 
 class Company(Resource, Count, Find, Load):
     update_verb = 'post'
+    identity_vars = ['id', 'company_id']
diff --git a/intercom/traits/api_resource.py b/intercom/traits/api_resource.py
@@ -33,13 +33,15 @@ def to_datetime_value(value):
 class Resource(object):
 
     def __init__(_self, **params):
+        _self.changed_attributes = []
         _self.from_dict(params)
         self = _self
 
         if hasattr(_self, 'flat_store_attributes'):
             for attr in self.flat_store_attributes:
                 if not hasattr(self, attr):
                     setattr(self, attr, FlatStore())
+        _self.changed_attributes = []
 
     def _flat_store_attribute(self, attribute):
         if hasattr(self, 'flat_store_attributes'):
@@ -54,6 +56,7 @@ def from_api(cls, response):
 
     def from_response(self, response):
         self.from_dict(response)
+        self.changed_attributes = []
         return self
 
     def from_dict(self, dict):
@@ -64,7 +67,14 @@ def from_dict(self, dict):
 
     @property
     def attributes(self):
-        return self.__dict__
+        res = {}
+        for name, value in self.__dict__.items():
+            if self.submittable_attribute(name, value):
+                res[name] = value
+        return res
+
+    def submittable_attribute(self, name, value):
+        return name in self.changed_attributes or isinstance(value, FlatStore)
 
     def __getattribute__(self, attribute):
         value = super(Resource, self).__getattribute__(attribute)
@@ -82,4 +92,6 @@ def __setattr__(self, attribute, value):
             value_to_set = time.mktime(value.timetuple())
         else:
             value_to_set = value
+        if attribute != 'changed_attributes':
+            self.__dict__['changed_attributes'].append(attribute)
         super(Resource, self).__setattr__(attribute, value_to_set)
diff --git a/intercom/user.py b/intercom/user.py
@@ -13,6 +13,7 @@ class User(Resource, Find, FindAll, All, Count, Load, Save, Delete,
            IncrementableAttributes):
 
     update_verb = 'post'
+    identity_vars = ['email', 'user_id']
 
     @property
     def flat_store_attributes(self):

Original file line number	Diff line number	Diff line change
`@@ -6,3 +6,4 @@`
`6`	`6`
`7`	`7`	`class Company(Resource, Count, Find, Load):`
`8`	`8`	`update_verb = 'post'`
	`9`	`+ identity_vars = ['id', 'company_id']`