Merge branch '21st-century'

ssutch · ssutch · commit c757a83e86ef · 2012-02-14T16:59:06.000-08:00
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -0,0 +1,41 @@
+version 0.4.0 - 2012-02-14
+==========================
+
+New:
+
+  * Client interface methods have more explicit arguments and now take an 
+    error callback.
+
+    The `provision` `notify` and `feedback` methods in v0.3.2 would
+    implicitly assume they should perform asynchronously if the `callback`
+    argument was supplied. They would spin off a thread, later calling
+    the callback.
+
+    Now those methods take an `async` parameter, when True, will spin off
+    the XML-RPC request in another thread, calling `callback(result)` when
+    complete or `errback(exception)` if an error occurred.
+
+  * Clients will now automatically try to re-provision themselves if `INITIAL`
+    was provided during configuration. This helps, in case the server goes
+    down, to be able to retry provisioning at least once.
+
+Fixed bugs:
+
+  * Fixed #21 - logging of full contents of file PEM file when providing the 
+    whole thing in `provision()`
+
+  * Fixed #25 - provide a wrapper for api functions which will automaticaly 
+    try to reprovision should it encounter a `UknownAppID`.
+
+Other:
+
+  * Removed some of the redundant documentation from the setup.py file. 
+    Eventually I want to move to sphynx docs. That software didn't really 
+    exist in the same capacity in 2010 as it does now.
+
+version 0.3.2 - 2010-08-05
+==========================
+
+Started tracking changes. This is the version that everyone has been using for
+the past few years. 
+
diff --git a/example_tac.tac b/example_tac.tac
@@ -0,0 +1,12 @@
+import twisted.application, twisted.web, twisted.application.internet
+import pyapns.server
+
+application = twisted.application.service.Application("pyapns application")
+
+resource = twisted.web.resource.Resource()
+resource.putChild('', pyapns.server.APNSServer())
+site = twisted.web.server.Site(resource)
+
+server = twisted.application.internet.TCPServer(7077, site)
+server.setServiceParent(application)
+
diff --git a/pyapns/.gitignore b/pyapns/.gitignore
@@ -0,0 +1,4 @@
+*.pyc
+*.log
+*.pid
+
diff --git a/pyapns/__init__.py b/pyapns/__init__.py
@@ -1 +1 @@
-from .client import notify, provision, feedback, configure
+from .client import notify, provision, feedback, configure__version__ = "0.4.0"__author__ = "Samuel Sutch"__license__ = "MIT"__copyright__ = "Copyrighit 2012 Samuel Sutch"
diff --git a/pyapns/client.py b/pyapns/client.py
@@ -1,6 +1,7 @@
 import xmlrpclib
 import threading
 import httplib
+import functools
 from sys import hexversion
 
 OPTIONS = {'CONFIGURED': False, 'TIMEOUT': 20}
@@ -40,32 +41,76 @@ def configure(opts):
 class UnknownAppID(Exception): pass
 class APNSNotConfigured(Exception): pass
 
+def reprovision_and_retry(func):
+  """
+  Wraps the `errback` callback of the API functions, automatically trying to
+  re-provision if the app ID can not be found during the operation. If that's
+  unsuccessful, it will raise the UnknownAppID error.
+  """
+  @functools.wraps(func)
+  def wrapper(*a, **kw):
+    errback = kw.get('errback', None)
+    if errback is None:
+      def errback(e):
+        raise e
+    def errback_wrapper(e):
+      if isinstance(e, UnknownAppID) and 'INITIAL' in OPTIONS:
+        try:
+          for initial in OPTIONS['INITIAL']:
+            provision(*initial) # retry provisioning the initial setup
+          func(*a, **kw) # and try the function once more
+        except Exception, new_exc:
+          errback(new_exc) # throwing the new exception
+      else:
+        errback(e) # not an instance of UnknownAppID - nothing we can do here
+    kw['errback'] = errback_wrapper
+    return func(*a, **kw)
+  return wrapper
+
+def default_callback(func):
+  @functools.wraps(func)
+  def wrapper(*a, **kw):
+    if 'callback' not in kw:
+      kw['callback'] = lambda c: c
+    return func(*a, **kw)
+  return wrapper
 
-def provision(app_id, path_to_cert, environment, timeout=15, callback=None):
+@default_callback
+@reprovision_and_retry
+def provision(app_id, path_to_cert, environment, timeout=15, async=False, 
+              callback=None, errback=None):
   args = [app_id, path_to_cert, environment, timeout]
-  if callback is None:
-    return _xmlrpc_thread('provision', args, lambda r: r)
-  t = threading.Thread(target=_xmlrpc_thread, args=['provision', args, callback])
+  f_args = ['provision', args, callback, errback]
+  if not async:
+    return _xmlrpc_thread(*f_args)
+  t = threading.Thread(target=_xmlrpc_thread, args=f_args)
   t.daemon = True
   t.start()
 
-def notify(app_id, tokens, notifications, callback=None):
+@default_callback
+@reprovision_and_retry
+def notify(app_id, tokens, notifications, async=False, callback=None, 
+           errback=None):
   args = [app_id, tokens, notifications]
-  if callback is None:
-    return _xmlrpc_thread('notify', args, lambda r: r)
-  t = threading.Thread(target=_xmlrpc_thread, args=['notify', args, callback])
+  f_args = ['notify', args, callback, errback]
+  if not async:
+    return _xmlrpc_thread(*f_args)
+  t = threading.Thread(target=_xmlrpc_thread, args=f_args)
   t.daemon = True
   t.start()
 
-def feedback(app_id, callback=None):
+@default_callback
+@reprovision_and_retry
+def feedback(app_id, async=False, callback=None, errback=None):
   args = [app_id]
-  if callback is None:
-    return _xmlrpc_thread('feedback', args, lambda r: r)
-  t = threading.Thread(target=_xmlrpc_thread, args=['feedback', args, callback])
+  f_args = ['feedback', args, callback, errback]
+  if not async:
+    return _xmlrpc_thread(*f_args)
+  t = threading.Thread(target=_xmlrpc_thread, args=f_args)
   t.daemon = True
   t.start()
 
-def _xmlrpc_thread(method, args, callback):
+def _xmlrpc_thread(method, args, callback, errback=None):
   if not configure({}):
     raise APNSNotConfigured('APNS Has not been configured.')
   proxy = ServerProxy(OPTIONS['HOST'], allow_none=True, use_datetime=True,
@@ -77,8 +122,11 @@ def _xmlrpc_thread(method, args, callback):
     return callback(proxy(*args))
   except xmlrpclib.Fault, e:
     if e.faultCode == 404:
-      raise UnknownAppID
-    raise
+      e = UnknownAppID()
+    if errback is not None:
+      errback(e)
+    else:
+      raise e
 
 
 ## --------------------------------------------------------------
diff --git a/pyapns/server.py b/pyapns/server.py
@@ -1,8 +1,6 @@
 from __future__ import with_statement
 import _json as json
-import base64
 import struct
-import logging
 import binascii
 import datetime
 from StringIO import StringIO as _StringIO
@@ -11,7 +9,7 @@
 from twisted.internet.protocol import (
   ReconnectingClientFactory, ClientFactory, Protocol, ServerFactory)
 from twisted.internet.ssl import ClientContextFactory
-from twisted.application import internet, service
+from twisted.application import service
 from twisted.protocols.basic import LineReceiver
 from twisted.python import log
 from zope.interface import Interface, implements
@@ -52,7 +50,10 @@ def read(self):
 
 class APNSClientContextFactory(ClientContextFactory):
   def __init__(self, ssl_cert_file):
-    log.msg('APNSClientContextFactory ssl_cert_file=%s' % ssl_cert_file)
+    if 'BEGIN CERTIFICATE' not in ssl_cert_file:
+      log.msg('APNSClientContextFactory ssl_cert_file=%s' % ssl_cert_file)
+    else:
+      log.msg('APNSClientContextFactory ssl_cert_file={FROM_STRING}')
     self.ctx = SSL.Context(SSL.SSLv3_METHOD)
     if 'BEGIN CERTIFICATE' in ssl_cert_file:
       cer = crypto.load_certificate(crypto.FILETYPE_PEM, ssl_cert_file)
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,2 @@
+Twisted>=8.2.0
+pyOpenSSL>=0.10
diff --git a/setup.py b/setup.py

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +*.pyc
 +*.log
 +*.pid
++
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-from .client import notify, provision, feedback, configure`
	`1`	`+from .client import notify, provision, feedback, configure__version__ = "0.4.0"__author__ = "Samuel Sutch"__license__ = "MIT"__copyright__ = "Copyrighit 2012 Samuel Sutch"`