Changes between Version 1 and Version 2 of Events

Timestamp:

12/09/14 11:13:13 (11 years ago)

Author:

mschenk

Comment:

—

Events

@@ -17 +17 @@
 The body of a mail event consists of a JSON-encoded dictionary of the following form:
 
-{{{#!python
-
+{{{
+#!py
 {
   'from_email': 'sender@my.domain',
@@ -29 +29 @@
 
 The '''html_message''' field is optional.
+
+Example of an e-mail event:
+
+{{{
+#!py
+import pika
+import json
+
+credentials = pika.PlainCredentials(SETTINGS.queueuser, SETTINGS.queuepassword)
+connection = pika.BlockingConnection(pika.ConnectionParameters(
+    host=SETTINGS.queuehost,credentials=credentials))
+channel = connection.channel()
+message = {
+  'from_email': 'sender@my.domain',
+  'recipient_list': [ 'recipient1@gmail.com', 'recipient2@hotmail.com' ],
+  'subject': 'The subject line for this message',
+  'message': 'A multi-line string holding the text version of this message',
+  'html_message': 'A multi-line string holding the html-version of this message',
+}
+channel.basic_publish(
+  exchange='extensionschoolevents',
+  routing_key='mail.sending',
+  body=json.dumps(message),
+  properties=pika.BasicProperties(delivery_mode=2),
+)
+}}}
+
+### Learner events ###
+
+#### Add ####
+
+This event must be sent when a new learner has registered. At this moment the learner MUST also have provided a password for his registration.
+
+The routing key for this event is '''learner.add'''
+
+The body of a learner.add event consists of a JSON-encoded dictionary of the following object:
+{{{
+{
+  'learner': {
+    'id': 15,
+    'email': 'a.g.degroot@hotmail.com',
+    'userlevel': 1,
+    'newslettersubscription': false,
+    'surname': 'Groot',
+    'firstname': 'Anne',
+    'nameprefix': 'de',
+    'initials': 'A.G.',
+    'gender': 'Female',          
+  }
+  'password': 'plaintext password for this learner'
+}
+}}}
+
+The 'learner' key holds an encoding of the django-object from learners.models
+
+Example of a '''learner.add''' event:
+
+
+{{{
+#!py
+import pika
+import jsonpickle
+
+credentials = pika.PlainCredentials(SETTINGS.queueuser, SETTINGS.queuepassword)
+connection = pika.BlockingConnection(pika.ConnectionParameters(
+    host=SETTINGS.queuehost,credentials=credentials))
+channel = connection.channel()
+learner = learners.models.Learner.objects.get(id=learnerid)
+message = {
+  'learners': learner,
+  'password': learnerpassword,
+}
+channel.basic_publish(
+  exchange='extensionschoolevents',
+  routing_key='mail.sending',
+  body=jsonpickle.encode(message),
+  properties=pika.BasicProperties(delivery_mode=2),
+)
+}}}