Merge pull request #12 from proger/multibackend

Multibackend

Author: proger

README.md

@@ -67,13 +67,24 @@ modules:
         type: apns
         # make sure this pem file contains only one(!) certificate + key pair
         certfile: "/etc/ssl/private/apns_example_app.pem"
-        # sandbox is for testing
         gateway: "gateway.push.apple.com"
-        #gateway: "gateway.sandbox.push.apple.com"
+      -
+        type: apns
+        # you can add more backends of each type by specifying backend_ref with unique names
+        backend_ref: "sandbox"
+        # make sure this pem file contains only one(!) certificate + key pair
+        certfile: "/etc/ssl/private/apns_example_app_sandbox.pem"
+        gateway: "gateway.sandbox.push.apple.com"
       -
         type: fcm
         gateway: "https://fcm.googleapis.com/fcm/send"
         api_key: "API_KEY"
+      -
+        type: fcm
+        # you can add more backends of each type by specifying backend_ref with unique names
+        backend_ref: "fcm2"
+        gateway: "https://fcm.googleapis.com/fcm/send"
+        api_key: "API_KEY_2"
 ```
 
 ## Client Applications
@@ -94,15 +105,34 @@ Example (note, `to='localhost'` contain the your user's server name):
            node='register-push-apns'
            action='execute'>
     <x xmlns='jabber:x:data' type='submit'>
-      <field
-      var='token'>
+      <field var='token'>
         <value>urq6urq6urq6urq6urq6urq6urq6urq6urq6urq6uro=</value>
       </field>
     </x>
   </command>
 </iq>
 ```
 
+You need to specify a `backend_ref` field to route your subscription to a particular backend:
+
+```xml
+<iq type='set' to='localhost' id='randomrandomrequestid2'>
+  <command xmlns='http://jabber.org/protocol/commands'
+           node='register-push-apns'
+           action='execute'>
+    <x xmlns='jabber:x:data' type='submit'>
+      <field var='backend_ref'>
+        <value>sandbox</value>
+      </field>
+      <field var='token'>
+        <value>urq6urq6urq6urq6urq6urq6urq6urq6urq6urq6uro=</value>
+      </field>
+    </x>
+  </command>
+</iq>
+```
+
+
 See [client.py](client.py) for a reference client.
 
 You can use `babababababababababababababababababababababababababababababababa` (`urq6urq6urq6urq6urq6urq6urq6urq6urq6urq6uro=` in base64) token to test APNS.

client.py

@@ -35,7 +35,11 @@ def text(self, to, msg):
         self.send_message(mto=to, mbody=msg)
         self.disconnect(wait=True)
 
-    def register_push_apns(self, token):
+    def register_push_apns(self, token, ref=None):
+        if ref:
+            ref_payload = "<field var='backend_ref'><value>%s</value></field>" % ref
+        else:
+            ref_payload = ""
         self['xep_0050'].start_command(jid=self.__server,
                                        node='register-push-apns',
                                        session={
@@ -44,11 +48,16 @@ def register_push_apns(self, token):
                                            'id': 'execute',
                                            'payload': [ET.fromstring("""
                                            <x xmlns='jabber:x:data' type='submit'>
-                                           <field var='token'> <value>%s</value> </field>
-                                           </x>""" % hextobase64(token))]
+                                           %s<field var='token'><value>%s</value></field>
+                                           </x>""" % (ref_payload, hextobase64(token)))]
                                        })
 
-    def register_push_fcm(self, token):
+
+    def register_push_fcm(self, token, ref=None):
+        if ref:
+            ref_payload = "<field var='backend_ref'><value>%s</value></field>" % ref
+        else:
+            ref_payload = ""
         self['xep_0050'].start_command(jid=self.__server,
                                        node='register-push-fcm',
                                        session={
@@ -57,8 +66,8 @@ def register_push_fcm(self, token):
                                            'id': 'execute',
                                            'payload': [ET.fromstring("""
                                            <x xmlns='jabber:x:data' type='submit'>
-                                           <field var='token'> <value>%s</value> </field>
-                                           </x>""" % token)]
+                                           %s<field var='token'><value>%s</value></field>
+                                           </x>""" % (ref_payload, token))]
                                        })
 
     def list_push_registrations(self):
@@ -91,8 +100,8 @@ def _command_error(self, iq, session):
 
 def usage():
     print >>sys.stderr, 'usage: client.py jid password text jid msg'
-    print >>sys.stderr, 'usage: client.py jid password register-push-apns token'
-    print >>sys.stderr, 'usage: client.py jid password register-push-fcm token'
+    print >>sys.stderr, 'usage: client.py jid password register-push-apns token [backend_ref]'
+    print >>sys.stderr, 'usage: client.py jid password register-push-fcm token [backend_ref]'
     print >>sys.stderr, 'usage: client.py jid password list-push-registrations'
     print >>sys.stderr, 'usage: client.py jid password unregister-push'
     sys.exit(1)