rest service, disconnect log and enhanced notifications

.gitignore

@@ -10,3 +10,5 @@ build/**
 dist/**
 .idea
 atlassian-ide-plugin.xml
+twistd.log
+twistd.pid

CHANGES.txt

@@ -1,3 +1,47 @@
+version 0.5.0 - 2013-01-25
+==========================
+
+There is lots of new stuff here but this release is backwards compatible. The
+REST interface operates on a different default port and runs completey in 
+paralell with the XML-RPC one. That said, REST is the way forward and all new
+features will be added to that server.
+
+New:
+
+  * An all-new REST interface that simplifies access to pyapns's functionality.
+
+    The XML-RPC server will be depreciated over the coming years. Next year it
+    will be "depreciated" as in it will start giving off warnings and the year
+    after it will likely be entirely removed.
+
+  * REST interface uses Apple's new "enhanced" notification format which has 
+    the ability to send back errors in the event Apple severs the connection 
+    to pyapns (which can happen for a number of reasons).
+
+  * A disconnection log which will pair disconnection events with the 
+    notifications at fault. This will allow you to remove offending tokens
+    and notifications.
+
+  * The new Python client uses the very fine requests library which provides
+    several advantages over the old XML-RPC library principally: connection
+    keep-alive and reuse and connection pooling.
+
+Fixed Bugs:
+
+  * Fixed #31/#26 - Token blacklisting - we will not blacklist tokens as it's 
+    not the job of this daemon to persist that kind of state. We however now 
+    give you the tools to blacklist tokens should you wish to do so.
+
+  * Fixed #14 - Apple Dropping Connection - this can happen for any number
+    of reasons, by using the new REST service you can get an idea of why.
+
+  * Fixed #10 - reprovisioning - while this issue isn't specifically to allow
+    reprovisioning, the reason @mikeytrw wanted the feature was to replace
+    certs, which is now possible.
+
+  * Fixed #28 - sending multiple notifications after a disconnect fails - 
+    simply fixed the way the deferred was handeled
+
 version 0.4.0 - 2012-02-14
 ==========================
 

COPYING

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2012 Samuel Sutch
+Copyright (c) 2013 Samuel Sutch
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

example_conf.json

@@ -1,41 +1,17 @@
 {
+    "host": "localhost",
+    "log_file_name": "pyapns.log",
+    "log_file_dir": ".",
+    "log_file_rotate_length": 1000000000,
+    "log_file_max_rotate": 10,
 	"port": 7077,
+	"rest_port": 8088,
 	"autoprovision": [
 		{
-			"app_id": "sandbox:com.ficture.ficturebeta",
-			"cert": "/Users/sam/dev/ficture/push_certs/development-com.ficture.ficturebeta.pem",
+			"app_id": "com.example.myapp",
+			"cert": "/path/to/cert.pem",
 			"environment": "sandbox",
 			"timeout": 15
-		},
-		{
-			"app_id": "production:com.ficture.ficturebeta",
-			"cert": "/Users/sam/dev/ficture/push_certs/production-com.ficture.ficturebeta.pem",
-			"environment": "production",
-			"timeout": 15
-		},
-		{
-			"app_id": "sandbox:com.ficture.ficturebeta2",
-			"cert": "/Users/sam/dev/ficture/push_certs/development-com.ficture.ficturebeta2.pem",
-			"environment": "sandbox",
-			"timeout": 15
-		},
-		{
-			"app_id": "production:com.ficture.ficturebeta2",
-			"cert": "/Users/sam/dev/ficture/push_certs/production-com.ficture.ficturebeta2.pem",
-			"environment": "production",
-			"timeout": 15
-		},
-		{
-			"app_id": "sandbox:com.ficture.ficturebeta3",
-			"cert": "/Users/sam/dev/ficture/push_certs/development-com.ficture.ficturebeta3.pem",
-			"environment": "sandbox",
-			"timeout": 15
-		},
-		{
-			"app_id": "production:com.ficture.ficturebeta3",
-			"cert": "/Users/sam/dev/ficture/push_certs/production-com.ficture.ficturebeta3.pem",
-			"environment": "production",
-			"timeout": 15
 		}
 	]
 }

pyapns.tac

@@ -0,0 +1,96 @@
+# CONFIG FILE LOCATION
+# relative to this file or absolute path
+
+config_file = '/path/to/config/pyapns_conf.json'
+
+# you don't need to change anything below this line really
+
+import twisted.application, twisted.web, twisted.application.internet
+from twisted.python.logfile import LogFile
+from twisted.python.log import ILogObserver, FileLogObserver
+import pyapns.server, pyapns._json
+import pyapns.rest_service, pyapns.model
+import os
+
+config = {}
+
+if os.path.exists(os.path.abspath(config_file)):
+    with open(os.path.abspath(config_file)) as f:
+        config.update(pyapns._json.loads(f.read()))
+else:
+    print 'No config file loaded. Alter the `config_file` variable at', \
+          'the top of this file to set one.'
+
+xml_service = pyapns.server.APNSServer()
+
+# get automatic provisioning
+if 'autoprovision' in config:
+    for app in config['autoprovision']:
+        # for XML-RPC
+        xml_service.xmlrpc_provision(app['app_id'], app['cert'], 
+                                     app['environment'], app['timeout'])
+        # for REST
+        pyapns.model.AppRegistry.put(
+            app['app_id'], app['environment'], app['cert'], 
+            timeout=app['timeout']
+        )
+
+if 'log_file_name' in config:
+    log_file_name = config['log_file_name']
+else:
+    log_file_name = 'twistd.log'
+
+if 'log_file_dir' in config:
+    log_file_dir = config['log_file_dir']
+else:
+    log_file_dir = '.'
+
+if 'log_file_rotate_length' in config:
+    log_file_rotate_length = config['log_file_rotate_length']
+else:
+    log_file_rotate_length = 1000000
+
+if 'log_file_mode' in config:
+    log_file_mode = config['log_file_mode']
+else:
+    log_file_mode = None
+
+if 'log_file_max_rotate' in config:
+    log_file_max_rotate = config['log_file_max_rotate']
+else:
+    log_file_max_rotate = None
+
+application = twisted.application.service.Application("pyapns application")
+logfile = LogFile(log_file_name, log_file_dir, log_file_rotate_length, log_file_mode, log_file_max_rotate)
+application.setComponent(ILogObserver, FileLogObserver(logfile).emit)
+
+if 'host' in config:
+    host = config['host']
+else:
+    host = ''
+
+# XML-RPC server support ------------------------------------------------------
+
+if 'port' in config:
+    port = config['port']
+else:
+    port = 7077
+
+resource = twisted.web.resource.Resource()
+resource.putChild('', xml_service)
+
+site = twisted.web.server.Site(resource)
+
+server = twisted.application.internet.TCPServer(port, site, interface=host)
+server.setServiceParent(application)
+
+# rest service support --------------------------------------------------------
+if 'rest_port' in config:
+    rest_port = config['rest_port']
+else:
+    rest_port = 8088
+
+site = twisted.web.server.Site(pyapns.rest_service.default_resource)
+
+server = twisted.application.internet.TCPServer(rest_port, site, interface=host)
+server.setServiceParent(application)

pyapns/__init__.py

@@ -1 +1 @@
-from .client import notify, provision, feedback, configure__version__ = "0.4.0"__author__ = "Samuel Sutch"__license__ = "MIT"__copyright__ = "Copyrighit 2012 Samuel Sutch"
+from .client import notify, provision, feedback, configure__version__ = "0.5.0"__author__ = "Samuel Sutch"__license__ = "MIT"__copyright__ = "Copyrighit 2013 Samuel Sutch"

pyapns/_json.py

@@ -1,21 +1,34 @@
 try:
-  import json
+    try:
+        import ujson # try for ujson first because it rocks and is fast as hell
+        class ujsonWrapper(object):
+            def dumps(self, obj, *args, **kwargs):
+                # ujson dumps method doesn't have separators keyword argument
+                if 'separators' in kwargs:
+                    del kwargs['separators']
+                return ujson.dumps(obj, *args, **kwargs)
+
+            def loads(self, str, *args, **kwargs):
+                return ujson.loads(str, *args, **kwargs)
+        json = ujsonWrapper()
+    except ImportError:
+        import json
 except (ImportError, NameError):
-  try:
-    from django.utils import simplejson as json
-  except (ImportError, NameError):
-    import simplejson as json
+    try:
+        from django.utils import simplejson as json
+    except (ImportError, NameError):
+        import simplejson as json
 try:
-  json.dumps
-  json.loads
+    json.dumps
+    json.loads
 except AttributeError:
-  try: # monkey patching for python-json package
-    json.dumps = lambda obj, *args, **kwargs: json.write(obj)
-    json.loads = lambda str, *args, **kwargs: json.read(str)
-  except AttributeError:
-    raise ImportError('Could not load an apropriate JSON library '
-                      'currently supported are simplejson, '
-                      'python2.6+ json and python-json')
+    try:  # monkey patching for python-json package
+        json.dumps = lambda obj, *args, **kwargs: json.write(obj)
+        json.loads = lambda str, *args, **kwargs: json.read(str)
+    except AttributeError:
+        raise ImportError('Could not load an apropriate JSON library '
+                          'currently supported are simplejson, '
+                          'python2.6+ json and python-json')
 
 loads = json.loads
 dumps = json.dumps