Changeset 10477

Timestamp:

10 Aug 2013, 01:10:04 (11 years ago)

Author:

uli

Message:

Add a (protected) XMLRPC service that tells about a student in exchange for valid credentials.

Location:

main/waeup.kofa/trunk/src/waeup/kofa

Files:

• students/tests/test_webservices.py (modified) (1 diff)
• students/webservices.py (modified) (1 diff)
• webservices.py (modified) (1 diff)

main/waeup.kofa/trunk/src/waeup/kofa/students/tests/test_webservices.py

@@ -318 +318 @@
         self.assertEqual(xmlout, RESPONSE_XML)
         return
+
+    def test_check_credentials(self):
+        # make sure we can get student infos providing valid creds
+        server = ServerProxy('http://mgr:mgrpw@localhost/app')
+        self.setup_student(self.student)
+        stud_id = self.student.student_id
+        result = server.check_credentials('mykey', stud_id, 'spwd')
+        self.assertEqual(
+            result, {
+                'description': 'Anna Tester',
+                'email': 'aa@aa.ng',
+                'id': 'K1000000',
+                'type': 'student'}
+            )
+        return

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

@@ -188 +188 @@
             return None
         return payments_dict
+
+    @grok.require('waeup.xmlrpc')
+    def check_credentials(self, key, username, password):
+        """Returns student data if username and password are valid,
+        None else.
+
+        We only query the students authenticator plugin in order not
+        to mix up with other credentials (admins, staff, etc.).
+
+        All additional checks performed by usual student
+        authentication apply. For instance for suspended students we
+        won't get a successful response but `None`.
+
+        This method can be used by CAS to authentify students for
+        external systems like moodle.
+        """
+        from zope.pluggableauth.interfaces import IAuthenticatorPlugin
+        auth = getUtility(IAuthenticatorPlugin, name='students')
+        creds = dict(login=username, password=password)
+        principal = auth.authenticateCredentials(creds)
+        if principal is None:
+            return None
+        return dict(email=principal.email, id=principal.id,
+                    type=principal.user_type,
+                    description=principal.description)

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

@@ -34 +34 @@
     #ACCEPTED_IP = ('174.36.230.28', )
     ACCEPTED_IP = ('127.0.0.1', )
-    
+
     def update(self, P_ID=None):
         if P_ID == None: