Changeset 9632 for main/waeup.kofa

Timestamp:

14 Nov 2012, 18:38:31 (12 years ago)

Author:

uli

Message:

Provide XMLRPC services. We start with a student_id service.

Location:

main/waeup.kofa/trunk

Files:

• src/waeup/kofa/tests/test_webservices.py (added)
• src/waeup/kofa/webservices.py (modified) (1 diff)
• versions.cfg (modified) (1 diff)

main/waeup.kofa/trunk/src/waeup/kofa/webservices.py

@@ -80 +80 @@
     def render(self):
         return self.output
+
+class XMLRPCPermission(grok.Permission):
+    """Permission for using XMLRPC functions.
+    """
+    grok.name('waeup.xmlrpc')
+
+class UniversityXMLRPC(grok.XMLRPC):
+    """XMLRPC webservices for KOFA portals.
+
+    Please note, that XMLRPC does not support real keyword arguments
+    but positional arguments only.
+    """
+    grok.context(IUniversity)
+
+    @grok.require('waeup.Public')
+    def xmlrpc_api_version(self):
+        """Return the current API version for XMLRPC clients.
+        """
+        return u'0.1'
+
+    @grok.require('waeup.xmlrpc')
+    def get_student_id(self, reg_number=None):
+        """Get the id of a student with registration number `reg_number`.
+
+        Returns the student id as string if successful, ``None`` else.
+        """
+        if reg_number is not None:
+            cat = getUtility(ICatalog, name='students_catalog')
+            result = list(
+                cat.searchResults(reg_number=(reg_number, reg_number),
+                                  _limit=1))
+            if not len(result):
+                return None
+            return result[0].student_id
+        return None

main/waeup.kofa/trunk/versions.cfg

@@ -34 +34 @@
 # for support of unicode encoded passwords
 zope.password = 3.6.1
+# include bugfix for hanging xmlrpcrequests under paster
+zope.publisher = 3.12.2