Fixes and improvements of the XML-RPC interface

git-svn-id: svn://svn.cy55.de/Zope3/src/loops/trunk@1555 fd906abe-77d9-0310-91a1-e0d9ade77398

xmlrpc/README.txt

@@ -42,25 +42,34 @@ top-level type concept:
 
   >>> from loops.xmlrpc.common import LoopsMethods
   >>> xrf = LoopsMethods(loopsRoot, TestRequest())
-  >>> xrf.getStartObject()
+  >>> startObj = xrf.getStartObject()
-  {'title': u'Type', 'type': '0', 'id': '0', 'name': u'type'}
+  >>> sorted(startObj.keys())
+  ['children', 'id', 'name', 'parents', 'title', 'type']
+  >>> startObj['id'], startObj['name'], startObj['title'], startObj['type']
+  ('0', u'type', u'Type', '0')
 
 If we provide a concept named "domain" this will be used as starting point:
 
   >>> from loops.concept import Concept
   >>> domain = concepts[u'domain'] = Concept(u'Domain')
   >>> domain.conceptType = concepts.getTypeConcept()
-  >>> xrf.getStartObject()
+  >>> startObj = xrf.getStartObject()
-  {'title': u'Domain', 'type': '0', 'id': '7', 'name': u'domain'}
+  >>> sorted(startObj.keys())
+  ['children', 'id', 'name', 'parents', 'title', 'type']
+  >>> startObj['id'], startObj['name'], startObj['title'], startObj['type']
+  ('7', u'domain', u'Domain', '0')
 
 There are a few standard objects we can retrieve directly:
 
-  >>> xrf.getDefaultPredicate()
+  >>> defaultPred = xrf.getDefaultPredicate()
-  {'title': u'subobject', 'type': '4', 'id': '6', 'name': u'standard'}
+  >>> defaultPred['id'], defaultPred['name']
-  >>> xrf.getTypePredicate()
+  ('6', u'standard')
-  {'title': u'has Type', 'type': '4', 'id': '5', 'name': u'hasType'}
+  >>> typePred = xrf.getTypePredicate()
-  >>> xrf.getTypeConcept()
+  >>> typePred['id'], typePred['name']
-  {'title': u'Type', 'type': '0', 'id': '0', 'name': u'type'}
+  ('5', u'hasType')
+  >>> typeConcept = xrf.getTypeConcept()
+  >>> typeConcept['id'], typeConcept['name']
+  ('0', u'type')
 
 In addition we can get a list of all types and all predicates available:
 
@@ -71,12 +80,32 @@ In addition we can get a list of all types and all predicates available:
 
 We can also retrieve a certain object by its id or its name:
 
-  >>> xrf.getObjectById('2')
+  >>> obj2 = xrf.getObjectById('2')
-  {'title': u'Image', 'type': '0', 'id': '2', 'name': u'image'}
+  >>> obj2['id'], obj2['name']
-  >>> xrf.getObjectByName(u'textdocument')
+  ('2', u'image')
-  {'title': u'Text Document', 'type': '0', 'id': '3', 'name': u'textdocument'}
+  >>> textdoc = xrf.getObjectByName(u'textdocument')
+  >>> textdoc['id'], textdoc['name']
+  ('3', u'textdocument')
 
-Now we are ready to deal with children and parents...
+All methods that retrieve one object also returns its children and parents:
+
+  >>> ch = typeConcept['children']
+  >>> len(ch)
+  1
+  >>> ch[0]['name']
+  u'hasType'
+  >>> sorted(c['name'] for c in ch[0]['objects'])
+  [u'domain', u'file', u'image', u'predicate', u'textdocument', u'type']
+
+  >>> pa = defaultPred['parents']
+  >>> len(pa)
+  1
+  >>> pa[0]['name']
+  u'hasType'
+  >>> sorted(p['name'] for p in pa[0]['objects'])
+  [u'predicate']
+
+We can also retrieve children and parents explicitely:
 
   >>> ch = xrf.getChildren('0')
   >>> len(ch)

xmlrpc/common.py

@@ -45,22 +45,22 @@ class LoopsMethods(MethodPublisher):
 
     def getStartObject(self):
         so = self.concepts.get('domain', self.concepts.getTypeConcept())
-        return objectAsDict(so)
+        return self.getObjectWithChildren(so)
 
     def getObjectById(self, id):
-        return objectAsDict(getObjectForUid(id))
+        return self.getObjectWithChildren(getObjectForUid(id))
 
     def getObjectByName(self, name):
-        return objectAsDict(self.concepts[name])
+        return self.getObjectWithChildren(self.concepts[name])
 
     def getDefaultPredicate(self):
-        return objectAsDict(self.concepts.getDefaultPredicate())
+        return self.getObjectWithChildren(self.concepts.getDefaultPredicate())
 
     def getTypePredicate(self):
-        return objectAsDict(self.concepts.getTypePredicate())
+        return self.getObjectWithChildren(self.concepts.getTypePredicate())
 
     def getTypeConcept(self):
-        return objectAsDict(self.concepts.getTypeConcept())
+        return self.getObjectWithChildren(self.concepts.getTypeConcept())
 
     def getConceptTypes(self):
         tc = self.concepts.getTypeConcept()
@@ -76,16 +76,23 @@ class LoopsMethods(MethodPublisher):
         obj = getObjectForUid(id)
         preds = [getObjectForUid(p) for p in predicates]
         child = child and getObjectForUid(child) or None
-        rels = obj.getChildRelations(preds, child)
+        rels = obj.getChildRelations(preds or None, child)
         return formatRelations(rels)
 
     def getParents(self, id, predicates=[], parent=''):
         obj = getObjectForUid(id)
         preds = [getObjectForUid(p) for p in predicates]
         parent = parent and getObjectForUid(parent) or None
-        rels = obj.getParentRelations(preds, parent)
+        rels = obj.getParentRelations(preds or None, parent)
         return formatRelations(rels, useSecond=False)
 
+    def getObjectWithChildren(self, obj):
+        mapping = objectAsDict(obj)
+        mapping['children'] = formatRelations(obj.getChildRelations())
+        mapping['parents'] = formatRelations(
+                                obj.getParentRelations(), useSecond=False)
+        return mapping
+
 
 def objectAsDict(obj):
     mapping = {'id': getUidForObject(obj), 'name': getName(obj), 'title': obj.title,