v0.0.5: default profile helper, formatting

Author: benr-calam

README.md

@@ -61,7 +61,7 @@ client.profile(<profile_id>).loop(<loop_id>).participant(<participant_id>).patch
 ```
 
 ## Design Philosophy
-All items accessible in the dotloop API follow a hierarchical structure as represented like this:
+All items accessible in the dotloop API follow a hierarchical structure (i.e. profiles have loops which have folders which have documents) as represented like this:
 
 - Account
 - Contact
@@ -83,10 +83,22 @@ Accessing
 
     PATCH /profile/1/loop/1/folder/1
 
+with data
+
+    {
+      "name": "Disclosures (renamed)"
+    }
+
 translates seamlessly to
 
 ```python
-client.profile(1).loop(1).folder(1).patch(...)
+client.profile(1).loop(1).folder(1).patch(name='Disclosures (renamed)')
+```
+
+Note: if data keys ever have spaces then those keys can be included by unpacking a dictionary
+e.g.
+```python
+client.profile(1).loop(1).detail.patch(**{'Property Information': {...}})
 ```
 
 Inspiration was taken from [dotloop-ruby](https://github.com/sampatbadhe/dotloop-ruby) and [sendgrid-python](https://github.com/sendgrid/sendgrid-python).

dotloop/account.py

@@ -3,4 +3,4 @@
 
 class Account(DotloopObject):
     def get(self):
-        return self.fetch('get')
+        return self.fetch('get')

dotloop/activity.py

@@ -3,4 +3,4 @@
 
 class Activity(DotloopObject, id_field='activity_id'):
     def get(self, **kwargs):
-        return self.fetch('get', params=kwargs)
+        return self.fetch('get', params=kwargs)

dotloop/authenticate.py

@@ -1,5 +1,5 @@
 from base64 import b64encode
-from urllib.parse import urljoin, urlencode
+from urllib.parse import urlencode, urljoin
 
 import requests
 

dotloop/bases.py

@@ -1,3 +1,4 @@
+from json import JSONDecodeError
 from typing import Dict
 from urllib.parse import urljoin
 
@@ -62,7 +63,10 @@ def fetch(self, method, **kwargs) -> Dict:
             urljoin(self.base_url, endpoint),
             **kwargs
         )
-        return response.json()
+        try:
+            return response.json()
+        except JSONDecodeError as e:
+            return {'error': 'JSONDecodeError', 'message': f'{str(e)}: {response.content.decode()}', 'status': response.status_code}
 
 
 class NotNoneClass:
@@ -88,7 +92,7 @@ def first(iterable):
             raise KeyError(str(iterable))
 
     items = [
-        # [(object, method, id_value), (endpoint, params, body)]
+        # [(object, method, id_value), endpointToFormat]
         [('LoopIt', 'post', None), 'loop-it'],
         [('Account', 'get', None), 'account'],
         [('Profile', 'get', None), 'profile'],
@@ -131,4 +135,4 @@ def __getitem__(self, key):
         return self.first(endpoint for loc, endpoint in self.items if loc == key)
 
 
-EndpointDirectory = EndpointDirectoryClass()
+EndpointDirectory = EndpointDirectoryClass()

dotloop/client.py

@@ -1,3 +1,5 @@
+from functools import cached_property
+
 import requests
 
 from .account import Account
@@ -8,11 +10,14 @@
 
 class Client:
     endpoint_directory = EndpointDirectory
-    
+
     def __init__(self, access_token):
         self.session = requests.Session()
         self.access_token = access_token
 
+    def __str__(self):
+        return '<Client>'
+
     @property
     def access_token(self):
         return self._access_token
@@ -39,3 +44,17 @@ def profile(self):
     @property
     def contact(self):
         return Contact(parent=self)
+
+    @cached_property
+    def DEFAULT_PROFILE(self):
+        profiles = self.profile.get()
+        try:
+            return next(p['id'] for p in profiles['data'] if p.get('default'))
+        except (StopIteration, KeyError):
+            if 'error' in profiles:
+                raise ValueError(profiles.get('message', profiles.get('error')))
+            elif 'errors' in profiles:
+                raise ValueError(str(profiles['errors']))
+            else:
+                raise ValueError('Unable to fetch default profile id.')
+ 

dotloop/detail.py

@@ -6,4 +6,4 @@ def get(self):
         return self.fetch('get')
 
     def patch(self, **kwargs):
-        return self.fetch('patch', json=kwargs)
+        return self.fetch('patch', json=kwargs)

dotloop/loop_it.py

@@ -5,4 +5,4 @@ class LoopIt(DotloopObject):
     def post(self, **kwargs):
         return self.fetch('post', json=kwargs, params={
             'profile_id': self.profile_id
-        })
+        })

dotloop/loop_template.py

@@ -3,4 +3,4 @@
 
 class LoopTemplate(DotloopObject, id_field='loop_template_id'):
     def get(self):
-        return self.fetch('get')
+        return self.fetch('get')

setup.py

@@ -7,7 +7,7 @@
 
     setuptools.setup(
         name='dotloop-python',
-        version='0.0.4',
+        version='0.0.5',
         packages=setuptools.find_packages(),
         install_requires=['requests'],
         author='Ben Russell',