diff options
47 files changed, 3017 insertions, 1630 deletions
diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..b82c77b --- /dev/null +++ b/Makefile @@ -0,0 +1,19 @@ +SUBDIRS = common python python-twisted python-tornado + +.PHONY: all test +all test: $(SUBDIRS) + +all: TARG=all +test: TARG=test + +$(SUBDIRS): force + @ $(MAKE) -C $@ $(TARG) + +.PHONY: clean +clean: + for dir in $(SUBDIRS); do \ + $(MAKE) clean -C $$dir; \ + done + +.PHONY: force +force :; diff --git a/Makefile.inc b/Makefile.inc new file mode 100644 index 0000000..68a78c6 --- /dev/null +++ b/Makefile.inc @@ -0,0 +1,3 @@ +REPOS_DIR=.. +VERSION=$(shell cat $(REPOS_DIR)/VERSION) +ECHO=/bin/echo @@ -0,0 +1 @@ +3.3.4 diff --git a/change_version.sh b/change_version.sh new file mode 100644 index 0000000..5ea7a63 --- /dev/null +++ b/change_version.sh @@ -0,0 +1 @@ +find -name "Pubnub*py" | xargs sed -i "s/PubNub\ [0-9]\.[0-9]\.[0-9]/PubNub\ `cat VERSION`/g" diff --git a/common/LICENSE_HEADER b/common/LICENSE_HEADER new file mode 100644 index 0000000..a83793d --- /dev/null +++ b/common/LICENSE_HEADER @@ -0,0 +1,10 @@ +## www.pubnub.com - PubNub Real-time push service in the cloud. +# coding=utf8 + +## PubNub Real-time Push APIs and Notifications Framework +## Copyright (c) 2010 Stephen Blum +## http://www.pubnub.com/ + +## ----------------------------------- +## PubNub 3.3.4 Real-time Push Cloud API +## ----------------------------------- diff --git a/common/Makefile b/common/Makefile new file mode 100644 index 0000000..1be6f8c --- /dev/null +++ b/common/Makefile @@ -0,0 +1,16 @@ +include ../Makefile.inc + + +.PHONY: all +all: build + +.PHONY: build +build: + find -name "Pubnub*py" | xargs sed -i "s/PubNub\ [0-9]\.[0-9]\.[0-9]/PubNub\ $(VERSION)/g" + + +.PHONY: clean +clean: + +.PHONY: test +test: diff --git a/python/3.3/Pubnub.py b/common/PubnubBase.py index a3f4d6f..64d43ed 100644 --- a/python/3.3/Pubnub.py +++ b/common/PubnubBase.py @@ -1,31 +1,21 @@ -## www.pubnub.com - PubNub Real-time push service in the cloud. -# coding=utf8 - -## PubNub Real-time Push APIs and Notifications Framework -## Copyright (c) 2010 Stephen Blum -## http://www.pubnub.com/ - -## ----------------------------------- -## PubNub 3.0 Real-time Push Cloud API -## ----------------------------------- - try: import json except ImportError: import simplejson as json import time import hashlib import urllib2 -import uuid +import uuid -class Pubnub(): +class PubnubBase(object): def __init__( self, publish_key, subscribe_key, secret_key = False, + cipher_key = False, ssl_on = False, origin = 'pubsub.pubnub.com', - pres_uuid = None + UUID = None ) : """ #** @@ -50,6 +40,7 @@ class Pubnub(): self.publish_key = publish_key self.subscribe_key = subscribe_key self.secret_key = secret_key + self.cipher_key = cipher_key self.ssl = ssl_on if self.ssl : @@ -57,11 +48,69 @@ class Pubnub(): else : self.origin = 'http://' + self.origin - self.uuid = pres_uuid or str(uuid.uuid4()) + self.uuid = UUID or str(uuid.uuid4()) if not isinstance(self.uuid, basestring): raise AttributeError("pres_uuid must be a string") + def sign(self, channel, message): + ## Sign Message + if self.secret_key: + signature = hashlib.md5('/'.join([ + self.publish_key, + self.subscribe_key, + self.secret_key, + channel, + message + ])).hexdigest() + else: + signature = '0' + return signature + + def encrypt(self, message): + if self.cipher_key: + pc = PubnubCrypto() + out = [] + if type( message ) == type(list()): + for item in message: + encryptItem = pc.encrypt(self.cipher_key, item ).rstrip() + out.append(encryptItem) + message = json.dumps(out) + elif type( message ) == type(dict()): + outdict = {} + for k, item in message.iteritems(): + encryptItem = pc.encrypt(self.cipher_key, item ).rstrip() + outdict[k] = encryptItem + out.append(outdict) + message = json.dumps(out[0]) + else: + message = json.dumps(pc.encrypt(self.cipher_key, json.dumps(message)).replace('\n','')) + else : + message = json.dumps(message) + + return message; + + def decrypt(self, message): + if self.cipher_key: + pc = PubnubCrypto() + if type( message ) == type(list()): + for item in message: + encryptItem = pc.decrypt(self.cipher_key, item ) + out.append(encryptItem) + message = out + elif type( message ) == type(dict()): + outdict = {} + for k, item in message.iteritems(): + encryptItem = pc.decrypt(self.cipher_key, item ) + outdict[k] = encryptItem + out.append(outdict) + message = out[0] + else: + message = pc.decrypt(self.cipher_key, message) + + return message + + def publish( self, args ) : """ #** @@ -89,22 +138,20 @@ class Pubnub(): ## Capture User Input channel = str(args['channel']) - message = json.dumps(args['message'], separators=(',',':')) - ## Sign Message - if self.secret_key : - signature = hashlib.md5('/'.join([ - self.publish_key, - self.subscribe_key, - self.secret_key, - channel, - message - ])).hexdigest() + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] else : - signature = '0' + callback = None + + #message = json.dumps(args['message'], separators=(',',':')) + message = self.encrypt(args['message']) + + signature = self.sign(channel, message) ## Send Message - return self._request([ + return self._request({"urlcomponents": [ 'publish', self.publish_key, self.subscribe_key, @@ -112,78 +159,7 @@ class Pubnub(): channel, '0', message - ]) - - - def subscribe( self, args ) : - """ - #** - #* Subscribe - #* - #* This is BLOCKING. - #* Listen for a message on a channel. - #* - #* @param array args with channel and callback. - #* @return false on fail, array on success. - #** - - ## Subscribe Example - def receive(message) : - print(message) - return True - - pubnub.subscribe({ - 'channel' : 'hello_world', - 'callback' : receive - }) - - """ - - ## Fail if missing channel - if not 'channel' in args : - raise Exception('Missing Channel.') - return False - - ## Fail if missing callback - if not 'callback' in args : - raise Exception('Missing Callback.') - return False - - ## Capture User Input - channel = str(args['channel']) - callback = args['callback'] - subscribe_key = args.get('subscribe_key') or self.subscribe_key - - ## Begin Subscribe - while True : - - timetoken = 'timetoken' in args and args['timetoken'] or 0 - try : - ## Wait for Message - response = self._request(self._encode([ - 'subscribe', - subscribe_key, - channel, - '0', - str(timetoken) - ])+['?uuid='+self.uuid], encode=False) - - messages = response[0] - args['timetoken'] = response[1] - - ## If it was a timeout - if not len(messages) : - continue - - ## Run user Callback and Reconnect if user permits. - for message in messages : - if not callback(message) : - return - - except Exception: - time.sleep(1) - - return True + ]}, callback) def presence( self, args ) : """ @@ -246,6 +222,12 @@ class Pubnub(): """ channel = str(args['channel']) + + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] + else : + callback = None ## Fail if bad input. if not channel : @@ -253,11 +235,11 @@ class Pubnub(): return False ## Get Presence Here Now - return self._request([ + return self._request({"urlcomponents": [ 'v2','presence', 'sub_key', self.subscribe_key, 'channel', channel - ]); + ]}, callback); def history( self, args ) : @@ -288,14 +270,20 @@ class Pubnub(): raise Exception('Missing Channel') return False + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] + else : + callback = None + ## Get History - return self._request([ + return self._request({ "urlcomponents" : [ 'history', self.subscribe_key, channel, '0', str(limit) - ]); + ] }, callback); def detailedHistory(self, args) : """ @@ -319,39 +307,45 @@ class Pubnub(): ## Capture User Input channel = str(args['channel']) - params = [] + params = dict() count = 100 if args.has_key('count'): count = int(args['count']) - params.append('count' + '=' + str(count)) + params['count'] = str(count) if args.has_key('reverse'): - params.append('reverse' + '=' + str(args['reverse']).lower()) + params['reverse'] = str(args['reverse']).lower() if args.has_key('start'): - params.append('start' + '=' + str(args['start'])) + params['start'] = str(args['start']) if args.has_key('end'): - params.append('end' + '=' + str(args['end'])) + params['end'] = str(args['end']) ## Fail if bad input. if not channel : raise Exception('Missing Channel') return False + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] + else : + callback = None + ## Get History - return self._request([ + return self._request({ 'urlcomponents' : [ 'v2', 'history', 'sub-key', self.subscribe_key, 'channel', channel, - ],params=params); + ],'urlparams' : params }, callback=callback); - def time(self) : + def time(self, args = None) : """ #** #* Time @@ -366,10 +360,17 @@ class Pubnub(): print(timestamp) """ - return self._request([ + ## Capture Callback + if args and args.has_key('callback') : + callback = args['callback'] + else : + callback = None + time = self._request({'urlcomponents' : [ 'time', '0' - ])[0] + ]}, callback) + if time != None: + return time[0] def _encode( self, request ) : @@ -378,24 +379,14 @@ class Pubnub(): hex(ord(ch)).replace( '0x', '%' ).upper() or ch for ch in list(bit) ]) for bit in request] - - - def _request( self, request, origin = None, encode = True, params = None ) : + + def getUrl(self,request): ## Build URL - url = (origin or self.origin) + '/' + "/".join( - encode and self._encode(request) or request - ) - ## Add query params - if params is not None and len(params) > 0: - url = url + "?" + "&".join(params) - - ## Send Request Expecting JSONP Response - try: - try: usock = urllib2.urlopen( url, None, 200 ) - except TypeError: usock = urllib2.urlopen( url, None ) - response = usock.read() - usock.close() - return json.loads( response ) - except: - return None - + url = self.origin + '/' + "/".join([ + "".join([ ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.find(ch) > -1 and + hex(ord(ch)).replace( '0x', '%' ).upper() or + ch for ch in list(bit) + ]) for bit in request["urlcomponents"]]) + if (request.has_key("urlparams")): + url = url + '?' + "&".join([ x + "=" + y for x,y in request["urlparams"].iteritems()]) + return url diff --git a/common/PubnubCore.py b/common/PubnubCore.py new file mode 100644 index 0000000..9f79dc8 --- /dev/null +++ b/common/PubnubCore.py @@ -0,0 +1,115 @@ +class PubnubCore(PubnubBase): + def __init__( + self, + publish_key, + subscribe_key, + secret_key = False, + cipher_key = False, + ssl_on = False, + origin = 'pubsub.pubnub.com', + uuid = None + ) : + """ + #** + #* Pubnub + #* + #* Init the Pubnub Client API + #* + #* @param string publish_key required key to send messages. + #* @param string subscribe_key required key to receive messages. + #* @param string secret_key optional key to sign messages. + #* @param boolean ssl required for 2048 bit encrypted messages. + #* @param string origin PUBNUB Server Origin. + #* @param string pres_uuid optional identifier for presence (auto-generated if not supplied) + #** + + ## Initiat Class + pubnub = Pubnub( 'PUBLISH-KEY', 'SUBSCRIBE-KEY', 'SECRET-KEY', False ) + + """ + super(PubnubCore, self).__init__( + publish_key=publish_key, + subscribe_key=subscribe_key, + secret_key=secret_key, + cipher_key=cipher_key, + ssl_on=ssl_on, + origin=origin, + UUID=uuid + ) + + self.subscriptions = {} + self.timetoken = 0 + self.version = '3.4' + self.accept_encoding = 'gzip' + + + + def subscribe( self, args ) : + """ + #** + #* Subscribe + #* + #* This is BLOCKING. + #* Listen for a message on a channel. + #* + #* @param array args with channel and callback. + #* @return false on fail, array on success. + #** + + ## Subscribe Example + def receive(message) : + print(message) + return True + + pubnub.subscribe({ + 'channel' : 'hello_world', + 'callback' : receive + }) + + """ + + ## Fail if missing channel + if not 'channel' in args : + raise Exception('Missing Channel.') + return False + + ## Fail if missing callback + if not 'callback' in args : + raise Exception('Missing Callback.') + return False + + ## Capture User Input + channel = str(args['channel']) + callback = args['callback'] + subscribe_key = args.get('subscribe_key') or self.subscribe_key + + ## Begin Subscribe + while True : + + timetoken = 'timetoken' in args and args['timetoken'] or 0 + try : + ## Wait for Message + response = self._request(self._encode([ + 'subscribe', + subscribe_key, + channel, + '0', + str(timetoken) + ])+['?uuid='+self.uuid], encode=False) + + messages = response[0] + args['timetoken'] = response[1] + + ## If it was a timeout + if not len(messages) : + continue + + ## Run user Callback and Reconnect if user permits. + for message in messages : + if not callback(message) : + return + + except Exception: + time.sleep(1) + + return True diff --git a/common/PubnubCoreAsync.py b/common/PubnubCoreAsync.py new file mode 100644 index 0000000..a7fbb7d --- /dev/null +++ b/common/PubnubCoreAsync.py @@ -0,0 +1,180 @@ +try: + from hashlib import sha256 + digestmod = sha256 +except ImportError: + import Crypto.Hash.SHA256 as digestmod + sha256 = digestmod.new +import hmac + +class PubnubCoreAsync(PubnubBase): + + def start(self): pass + def stop(self): pass + def timeout( self, delay, callback ): + pass + + def __init__( + self, + publish_key, + subscribe_key, + secret_key = False, + cipher_key = False, + ssl_on = False, + origin = 'pubsub.pubnub.com', + uuid = None + ) : + """ + #** + #* Pubnub + #* + #* Init the Pubnub Client API + #* + #* @param string publish_key required key to send messages. + #* @param string subscribe_key required key to receive messages. + #* @param string secret_key required key to sign messages. + #* @param boolean ssl required for 2048 bit encrypted messages. + #* @param string origin PUBNUB Server Origin. + #** + + ## Initiat Class + pubnub = Pubnub( 'PUBLISH-KEY', 'SUBSCRIBE-KEY', 'SECRET-KEY', False ) + + """ + super(PubnubCoreAsync, self).__init__( + publish_key=publish_key, + subscribe_key=subscribe_key, + secret_key=secret_key, + cipher_key=cipher_key, + ssl_on=ssl_on, + origin=origin, + UUID=uuid + ) + + self.subscriptions = {} + self.timetoken = 0 + self.version = '3.3.4' + self.accept_encoding = 'gzip' + + def subscribe( self, args ) : + """ + #** + #* Subscribe + #* + #* This is NON-BLOCKING. + #* Listen for a message on a channel. + #* + #* @param array args with channel and message. + #* @return false on fail, array on success. + #** + + ## Subscribe Example + def receive(message) : + print(message) + return True + + ## On Connect Callback + def connected() : + pubnub.publish({ + 'channel' : 'hello_world', + 'message' : { 'some_var' : 'text' } + }) + + ## Subscribe + pubnub.subscribe({ + 'channel' : 'hello_world', + 'connect' : connected, + 'callback' : receive + }) + + """ + ## Fail if missing channel + if not 'channel' in args : + return 'Missing Channel.' + + ## Fail if missing callback + if not 'callback' in args : + return 'Missing Callback.' + + ## Capture User Input + channel = str(args['channel']) + callback = args['callback'] + connectcb = args['connect'] + + if 'errorback' in args: + errorback = args['errorback'] + else: + errorback = lambda x: x + + ## New Channel? + if not (channel in self.subscriptions) : + self.subscriptions[channel] = { + 'first' : False, + 'connected' : False, + } + + ## Ensure Single Connection + if self.subscriptions[channel]['connected'] : + return "Already Connected" + + self.subscriptions[channel]['connected'] = 1 + ## SUBSCRIPTION RECURSION + def _subscribe(): + ## STOP CONNECTION? + if not self.subscriptions[channel]['connected']: + return + + def sub_callback(response): + if not self.subscriptions[channel]['first'] : + self.subscriptions[channel]['first'] = True + connectcb() + + ## STOP CONNECTION? + if not self.subscriptions[channel]['connected']: + return + + + + ## PROBLEM? + if not response: + def time_callback(_time): + if not _time: + self.timeout( 1, _subscribe ) + return errorback("Lost Network Connection") + else: + self.timeout( 1, _subscribe) + + ## ENSURE CONNECTED (Call Time Function) + return self.time({ 'callback' : time_callback }) + + self.timetoken = response[1] + _subscribe() + + pc = PubnubCrypto() + out = [] + for message in response[0]: + callback(self.decrypt(message)) + + ## CONNECT TO PUBNUB SUBSCRIBE SERVERS + try: + self._request( { "urlcomponents" : [ + 'subscribe', + self.subscribe_key, + channel, + '0', + str(self.timetoken) + ], "urlparams" : {"uuid":self.uuid} }, sub_callback ) + except : + self.timeout( 1, _subscribe) + return + + ## BEGIN SUBSCRIPTION (LISTEN FOR MESSAGES) + _subscribe() + def unsubscribe( self, args ): + channel = str(args['channel']) + if not (channel in self.subscriptions): + return False + + ## DISCONNECT + self.subscriptions[channel]['connected'] = 0 + self.subscriptions[channel]['timetoken'] = 0 + self.subscriptions[channel]['first'] = False diff --git a/python-tornado/PubnubCrypto.py b/common/PubnubCrypto.py index 744f2d3..df7cb8d 100644 --- a/python-tornado/PubnubCrypto.py +++ b/common/PubnubCrypto.py @@ -1,14 +1,3 @@ -## www.pubnub.com - PubNub Real-time push service in the cloud. -# coding=utf8 - -## PubNub Real-time Push APIs and Notifications Framework -## Copyright (c) 2010 Stephen Blum -## http://www.pubnub.com/ - -## ----------------------------------- -## PubNub 3.1 Real-time Push Cloud API -## ----------------------------------- - from Crypto.Cipher import AES from Crypto.Hash import MD5 from base64 import encodestring, decodestring @@ -38,7 +27,8 @@ class PubnubCrypto() : #* @return msg with padding. #** """ - return msg + ((block_size - len(msg) % block_size) * chr(block_size - len(msg) % block_size)) + padding = block_size - (len(msg) % block_size) + return msg + chr(padding)*padding def depad( self, msg ): """ @@ -60,7 +50,7 @@ class PubnubCrypto() : #* @return key in MD5 format #** """ - return MD5.new(key).digest() + return hashlib.sha256(key).hexdigest() def encrypt( self, key, msg ): """ @@ -73,9 +63,9 @@ class PubnubCrypto() : """ secret = self.getSecret(key) Initial16bytes='0123456789012345' - cipher = AES.new(secret,AES.MODE_CBC,Initial16bytes) - return encodestring(cipher.encrypt(self.pad(msg))) - + cipher = AES.new(secret[0:32],AES.MODE_CBC,Initial16bytes) + enc = encodestring(cipher.encrypt(self.pad(msg))) + return enc def decrypt( self, key, msg ): """ #** @@ -87,6 +77,5 @@ class PubnubCrypto() : """ secret = self.getSecret(key) Initial16bytes='0123456789012345' - cipher = AES.new(secret,AES.MODE_CBC,Initial16bytes) + cipher = AES.new(secret[0:32],AES.MODE_CBC,Initial16bytes) return self.depad((cipher.decrypt(decodestring(msg)))) - diff --git a/common/PubnubUnitTest.py b/common/PubnubUnitTest.py new file mode 100644 index 0000000..2f9d28c --- /dev/null +++ b/common/PubnubUnitTest.py @@ -0,0 +1,36 @@ + +import time + +class Suite(): + def __init__(self, pubnub, expected): + self.pubnub = pubnub + self.total = expected + self.passed = 0 + self.failed = 0 + self.started = False + + def test(self, condition , name, message = None, response = None): + + if condition: + self.passed += 1 + msg = "PASS : " + name + if message: + msg += ", " + message + if response: + msg += ", " + response + print msg + else: + self.failed += 1 + msg = "FAIL : " + name + if message: + msg += ", " + message + if response: + msg += ", " + response + print msg + + if self.total == self.failed + self.passed: + print "\n======== RESULT ========" + print "Total\t:\t", self.total + print "Passed\t:\t", self.passed + print "Failed\t:\t", self.failed + self.pubnub.stop() diff --git a/common/unit-test-async.py b/common/unit-test-async.py new file mode 100644 index 0000000..f95c759 --- /dev/null +++ b/common/unit-test-async.py @@ -0,0 +1,146 @@ +## www.pubnub.com - PubNub Real-time push service in the cloud. +# coding=utf8 + +## PubNub Real-time Push APIs and Notifications Framework +## Copyright (c) 2010 Stephen Blum +## http://www.pubnub.com/ + +## ----------------------------------- +## PubNub 3.1 Real-time Push Cloud API +## ----------------------------------- + +import sys +import time +import random +sys.path.append('../') +sys.path.append('./') +sys.path.append('../common/') +from Pubnub import Pubnub + +publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' +subscribe_key = len(sys.argv) > 2 and sys.argv[2] or 'demo' +secret_key = len(sys.argv) > 3 and sys.argv[3] or None +cipher_key = len(sys.argv) > 4 and sys.argv[4] or None +ssl_on = len(sys.argv) > 5 and bool(sys.argv[5]) or False + +## ----------------------------------------------------------------------- +## Initiat Class +## ----------------------------------------------------------------------- +pubnub = Pubnub( publish_key, subscribe_key, secret_key, cipher_key, ssl_on ) +ch = 'python-async-test-channel-' +expect = 0 +done = 0 +failures = 0 +passes = 0 + +def stop(): + global done + global count + pubnub.stop() + print "============================" + print 'Total\t:\t' , failures + passes + print 'PASS\t:\t' , passes + print 'FAIL\t:\t', failures + print "============================" + +## --------------------------------------------------------------------------- +## Unit Test Function +## --------------------------------------------------------------------------- +def test( trial, name ) : + global failures + global passes + global done + done += 1 + #print trial + if trial == False: + print 'FAIL : ', name + failures += 1 + else: + print 'PASS : ', name + passes += 1 + if done == expect: + stop() + +def test_publish(): + channel = ch + str(random.random()) + def publish_cb(messages): + test(messages[0] == 1, "Publish Test") + + pubnub.publish({ + 'channel' : channel, + 'message' : {'one': 'Hello World! --> ɂ顶@#$%^&*()!', 'two': 'hello2'}, + 'callback' : publish_cb + }) + + +def test_history(): + channel = ch + str(random.random()) + def history_cb(messages): + test(len(messages) <= 1, "History Test") + pubnub.history({ + 'channel' : channel, + 'limit' : 1, + 'callback' : history_cb + }) + + + +def test_subscribe(): + message = "Testing Subscribe " + str(random.random()) + channel = ch + str(random.random()) + def subscribe_connect_cb(): + def publish_cb(response): + test(response[0] == 1, 'Publish Test in subscribe Connect Callback') + pubnub.publish({ + 'channel' : channel, + 'message' : message, + 'callback' : publish_cb + }) + def subscribe_cb(response): + test(response == message , 'Subscribe Receive Test in subscribe Callback') + pubnub.subscribe({ + 'channel' : channel, + 'connect' : subscribe_connect_cb, + 'callback': subscribe_cb + }) + + +def test_here_now(): + channel = ch + str(random.random()) + message = "Testing Subscribe" + def subscribe_connect_cb(): + def here_now_cb(response): + test(response["occupancy"] > 0, 'Here Now Test') + def publish_cb(response): + test(response[0] == 1, 'Here Now Test: Publish Test in subscribe Connect Callback') + pubnub.publish({ + 'channel' : channel, + 'message' : message, + 'callback' : publish_cb + }) + time.sleep(5) + pubnub.here_now({ + 'channel' : channel, + 'callback' : here_now_cb + }) + + + def subscribe_cb(response): + test(response == message , 'Here Now Test: Subscribe Receive Test in subscribe Callback') + pubnub.subscribe({ + 'channel' : channel, + 'connect' : subscribe_connect_cb, + 'callback': subscribe_cb + }) + +expect = 7 +test_publish() +test_history() +test_subscribe() +test_here_now() + + + +pubnub.start() +if failures > 0: + raise Exception('Fail', failures) diff --git a/python-tornado/Makefile b/python-tornado/Makefile new file mode 100644 index 0000000..bf23137 --- /dev/null +++ b/python-tornado/Makefile @@ -0,0 +1,28 @@ +include ../Makefile.inc + + +.PHONY: all +all: build + +.PHONY: build +build: + cat ../common/LICENSE_HEADER > ./Pubnub.py + echo "\n" >> ./Pubnub.py + cat ../common/PubnubCrypto.py >> ./Pubnub.py + echo "\n" >> ./Pubnub.py + cat ../common/PubnubBase.py >> ./Pubnub.py + echo "\n" >> ./Pubnub.py + cat ../common/PubnubCoreAsync.py >> ./Pubnub.py + echo "\n" >> ./Pubnub.py + cat ./unassembled/Platform.py >> ./Pubnub.py + find -name "Pubnub*py" | xargs sed -i "s/PubNub\ [0-9]\.[0-9]\.[0-9]/PubNub\ $(VERSION)/g" + + +.PHONY: clean +clean: + rm -f Pubnub.py* + +.PHONY: test +test: + python tests/unit-tests.py + diff --git a/python-tornado/Pubnub.py b/python-tornado/Pubnub.py index 12baf17..268cd6a 100644 --- a/python-tornado/Pubnub.py +++ b/python-tornado/Pubnub.py @@ -6,37 +6,102 @@ ## http://www.pubnub.com/ ## ----------------------------------- -## PubNub 3.1 Real-time Push Cloud API +## PubNub 3.3.4 Real-time Push Cloud API ## ----------------------------------- -import json -import time + +from Crypto.Cipher import AES +from Crypto.Hash import MD5 +from base64 import encodestring, decodestring import hashlib -import urllib2 -import tornado.httpclient -import sys -import uuid +import hmac -try: - from hashlib import sha256 - digestmod = sha256 -except ImportError: - import Crypto.Hash.SHA256 as digestmod - sha256 = digestmod.new +class PubnubCrypto() : + """ + #** + #* PubnubCrypto + #* + #** -import hmac -import tornado.ioloop -from PubnubCrypto import PubnubCrypto + ## Initiate Class + pc = PubnubCrypto -ioloop = tornado.ioloop.IOLoop.instance() + """ + + def pad( self, msg, block_size=16 ): + """ + #** + #* pad + #* + #* pad the text to be encrypted + #* appends a padding character to the end of the String + #* until the string has block_size length + #* @return msg with padding. + #** + """ + padding = block_size - (len(msg) % block_size) + return msg + chr(padding)*padding + + def depad( self, msg ): + """ + #** + #* depad + #* + #* depad the decryptet message" + #* @return msg without padding. + #** + """ + return msg[0:-ord(msg[-1])] -class Pubnub(): + def getSecret( self, key ): + """ + #** + #* getSecret + #* + #* hases the key to MD5 + #* @return key in MD5 format + #** + """ + return hashlib.sha256(key).hexdigest() - def stop(self): ioloop.stop() - def start(self): ioloop.start() - def timeout( self, callback, delay ): - ioloop.add_timeout( time.time()+float(delay), callback ) - + def encrypt( self, key, msg ): + """ + #** + #* encrypt + #* + #* encrypts the message + #* @return message in encrypted format + #** + """ + secret = self.getSecret(key) + Initial16bytes='0123456789012345' + cipher = AES.new(secret[0:32],AES.MODE_CBC,Initial16bytes) + enc = encodestring(cipher.encrypt(self.pad(msg))) + return enc + def decrypt( self, key, msg ): + """ + #** + #* decrypt + #* + #* decrypts the message + #* @return message in decryped format + #** + """ + secret = self.getSecret(key) + Initial16bytes='0123456789012345' + cipher = AES.new(secret[0:32],AES.MODE_CBC,Initial16bytes) + return self.depad((cipher.decrypt(decodestring(msg)))) + + +try: import json +except ImportError: import simplejson as json + +import time +import hashlib +import urllib2 +import uuid + +class PubnubBase(object): def __init__( self, publish_key, @@ -44,7 +109,8 @@ class Pubnub(): secret_key = False, cipher_key = False, ssl_on = False, - origin = 'pubsub.pubnub.com' + origin = 'pubsub.pubnub.com', + UUID = None ) : """ #** @@ -54,9 +120,10 @@ class Pubnub(): #* #* @param string publish_key required key to send messages. #* @param string subscribe_key required key to receive messages. - #* @param string secret_key required key to sign messages. + #* @param string secret_key optional key to sign messages. #* @param boolean ssl required for 2048 bit encrypted messages. #* @param string origin PUBNUB Server Origin. + #* @param string pres_uuid optional identifier for presence (auto-generated if not supplied) #** ## Initiat Class @@ -64,17 +131,79 @@ class Pubnub(): """ self.origin = origin + self.limit = 1800 self.publish_key = publish_key self.subscribe_key = subscribe_key self.secret_key = secret_key self.cipher_key = cipher_key self.ssl = ssl_on - self.subscriptions = {} if self.ssl : self.origin = 'https://' + self.origin else : self.origin = 'http://' + self.origin + + self.uuid = UUID or str(uuid.uuid4()) + + if not isinstance(self.uuid, basestring): + raise AttributeError("pres_uuid must be a string") + + def sign(self, channel, message): + ## Sign Message + if self.secret_key: + signature = hashlib.md5('/'.join([ + self.publish_key, + self.subscribe_key, + self.secret_key, + channel, + message + ])).hexdigest() + else: + signature = '0' + return signature + + def encrypt(self, message): + if self.cipher_key: + pc = PubnubCrypto() + out = [] + if type( message ) == type(list()): + for item in message: + encryptItem = pc.encrypt(self.cipher_key, item ).rstrip() + out.append(encryptItem) + message = json.dumps(out) + elif type( message ) == type(dict()): + outdict = {} + for k, item in message.iteritems(): + encryptItem = pc.encrypt(self.cipher_key, item ).rstrip() + outdict[k] = encryptItem + out.append(outdict) + message = json.dumps(out[0]) + else: + message = json.dumps(pc.encrypt(self.cipher_key, json.dumps(message)).replace('\n','')) + else : + message = json.dumps(message) + + return message; + + def decrypt(self, message): + if self.cipher_key: + pc = PubnubCrypto() + if type( message ) == type(list()): + for item in message: + encryptItem = pc.decrypt(self.cipher_key, item ) + out.append(encryptItem) + message = out + elif type( message ) == type(dict()): + outdict = {} + for k, item in message.iteritems(): + encryptItem = pc.decrypt(self.cipher_key, item ) + outdict[k] = encryptItem + out.append(outdict) + message = out[0] + else: + message = pc.decrypt(self.cipher_key, message) + + return message def publish( self, args ) : @@ -89,71 +218,35 @@ class Pubnub(): #** ## Publish Example - def publish_complete(info): - print(info) - - pubnub.publish({ + info = pubnub.publish({ 'channel' : 'hello_world', 'message' : { 'some_text' : 'Hello my World' - }, - 'callback' : publish_complete + } }) + print(info) """ ## Fail if bad input. if not (args['channel'] and args['message']) : - print('Missing Channel or Message') - return False + return [ 0, 'Missing Channel or Message' ] ## Capture User Input channel = str(args['channel']) - message = args['message'] - - if self.cipher_key : - pc = PubnubCrypto() - out = [] - if type( message ) == type(list()): - for item in message: - encryptItem = pc.encrypt(self.cipher_key, item ).rstrip() - out.append(encryptItem) - message = json.dumps(out) - elif type( message ) == type(dict()): - outdict = {} - for k, item in message.iteritems(): - encryptItem = pc.encrypt(self.cipher_key, item ).rstrip() - outdict[k] = encryptItem - out.append(outdict) - message = json.dumps(out[0]) - else: - message = json.dumps(pc.encrypt(self.cipher_key, message).replace('\n','')) - else : - message = json.dumps(args['message']) ## Capture Callback if args.has_key('callback') : callback = args['callback'] else : - callback = lambda x : x + callback = None + + #message = json.dumps(args['message'], separators=(',',':')) + message = self.encrypt(args['message']) + + signature = self.sign(channel, message) - ## Sign Message - if self.secret_key : - hashObject = sha256() - hashObject.update(self.secret_key) - hashedSecret = hashObject.hexdigest() - hash = hmac.HMAC(hashedSecret, '/'.join([ - self.publish_key, - self.subscribe_key, - self.secret_key, - channel, - message - ]), digestmod=digestmod) - signature = hash.hexdigest() - else : - signature = '0' - ## Send Message - return self._request([ + return self._request({"urlcomponents": [ 'publish', self.publish_key, self.subscribe_key, @@ -161,8 +254,295 @@ class Pubnub(): channel, '0', message - ], callback ); + ]}, callback) + + def presence( self, args ) : + """ + #** + #* presence + #* + #* This is BLOCKING. + #* Listen for presence events on a channel. + #* + #* @param array args with channel and callback. + #* @return false on fail, array on success. + #** + + ## Presence Example + def pres_event(message) : + print(message) + return True + + pubnub.presence({ + 'channel' : 'hello_world', + 'callback' : receive + }) + """ + + ## Fail if missing channel + if not 'channel' in args : + raise Exception('Missing Channel.') + return False + + ## Fail if missing callback + if not 'callback' in args : + raise Exception('Missing Callback.') + return False + + ## Capture User Input + channel = str(args['channel']) + callback = args['callback'] + subscribe_key = args.get('subscribe_key') or self.subscribe_key + + return self.subscribe({'channel': channel+'-pnpres', 'subscribe_key':subscribe_key, 'callback': callback}) + + + def here_now( self, args ) : + """ + #** + #* Here Now + #* + #* Load current occupancy from a channel. + #* + #* @param array args with 'channel'. + #* @return mixed false on fail, array on success. + #* + + ## Presence Example + here_now = pubnub.here_now({ + 'channel' : 'hello_world', + }) + print(here_now['occupancy']) + print(here_now['uuids']) + + """ + channel = str(args['channel']) + + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] + else : + callback = None + + ## Fail if bad input. + if not channel : + raise Exception('Missing Channel') + return False + + ## Get Presence Here Now + return self._request({"urlcomponents": [ + 'v2','presence', + 'sub_key', self.subscribe_key, + 'channel', channel + ]}, callback); + + + def history( self, args ) : + """ + #** + #* History + #* + #* Load history from a channel. + #* + #* @param array args with 'channel' and 'limit'. + #* @return mixed false on fail, array on success. + #* + + ## History Example + history = pubnub.history({ + 'channel' : 'hello_world', + 'limit' : 1 + }) + print(history) + + """ + ## Capture User Input + limit = args.has_key('limit') and int(args['limit']) or 10 + channel = str(args['channel']) + + ## Fail if bad input. + if not channel : + raise Exception('Missing Channel') + return False + + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] + else : + callback = None + + ## Get History + return self._request({ "urlcomponents" : [ + 'history', + self.subscribe_key, + channel, + '0', + str(limit) + ] }, callback); + + def detailedHistory(self, args) : + """ + #** + #* Detailed History + #* + #* Load Detailed history from a channel. + #* + #* @param array args with 'channel', optional: 'start', 'end', 'reverse', 'count' + #* @return mixed false on fail, array on success. + #* + + ## History Example + history = pubnub.detailedHistory({ + 'channel' : 'hello_world', + 'count' : 5 + }) + print(history) + + """ + ## Capture User Input + channel = str(args['channel']) + + params = dict() + count = 100 + + if args.has_key('count'): + count = int(args['count']) + + params['count'] = str(count) + + if args.has_key('reverse'): + params['reverse'] = str(args['reverse']).lower() + + if args.has_key('start'): + params['start'] = str(args['start']) + + if args.has_key('end'): + params['end'] = str(args['end']) + + ## Fail if bad input. + if not channel : + raise Exception('Missing Channel') + return False + + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] + else : + callback = None + + ## Get History + return self._request({ 'urlcomponents' : [ + 'v2', + 'history', + 'sub-key', + self.subscribe_key, + 'channel', + channel, + ],'urlparams' : params }, callback=callback); + + def time(self, args = None) : + """ + #** + #* Time + #* + #* Timestamp from PubNub Cloud. + #* + #* @return int timestamp. + #* + + ## PubNub Server Time Example + timestamp = pubnub.time() + print(timestamp) + + """ + ## Capture Callback + if args and args.has_key('callback') : + callback = args['callback'] + else : + callback = None + time = self._request({'urlcomponents' : [ + 'time', + '0' + ]}, callback) + if time != None: + return time[0] + + + def _encode( self, request ) : + return [ + "".join([ ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.find(ch) > -1 and + hex(ord(ch)).replace( '0x', '%' ).upper() or + ch for ch in list(bit) + ]) for bit in request] + + def getUrl(self,request): + ## Build URL + url = self.origin + '/' + "/".join([ + "".join([ ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.find(ch) > -1 and + hex(ord(ch)).replace( '0x', '%' ).upper() or + ch for ch in list(bit) + ]) for bit in request["urlcomponents"]]) + if (request.has_key("urlparams")): + url = url + '?' + "&".join([ x + "=" + y for x,y in request["urlparams"].iteritems()]) + return url + + +try: + from hashlib import sha256 + digestmod = sha256 +except ImportError: + import Crypto.Hash.SHA256 as digestmod + sha256 = digestmod.new +import hmac + +class PubnubCoreAsync(PubnubBase): + + def start(self): pass + def stop(self): pass + def timeout( self, delay, callback ): + pass + + def __init__( + self, + publish_key, + subscribe_key, + secret_key = False, + cipher_key = False, + ssl_on = False, + origin = 'pubsub.pubnub.com', + uuid = None + ) : + """ + #** + #* Pubnub + #* + #* Init the Pubnub Client API + #* + #* @param string publish_key required key to send messages. + #* @param string subscribe_key required key to receive messages. + #* @param string secret_key required key to sign messages. + #* @param boolean ssl required for 2048 bit encrypted messages. + #* @param string origin PUBNUB Server Origin. + #** + + ## Initiat Class + pubnub = Pubnub( 'PUBLISH-KEY', 'SUBSCRIBE-KEY', 'SECRET-KEY', False ) + + """ + super(PubnubCoreAsync, self).__init__( + publish_key=publish_key, + subscribe_key=subscribe_key, + secret_key=secret_key, + cipher_key=cipher_key, + ssl_on=ssl_on, + origin=origin, + UUID=uuid + ) + self.subscriptions = {} + self.timetoken = 0 + self.version = '3.3.4' + self.accept_encoding = 'gzip' def subscribe( self, args ) : """ @@ -198,13 +578,11 @@ class Pubnub(): """ ## Fail if missing channel if not 'channel' in args : - print('Missing Channel.') - return False + return 'Missing Channel.' ## Fail if missing callback if not 'callback' in args : - print('Missing Callback.') - return False + return 'Missing Callback.' ## Capture User Input channel = str(args['channel']) @@ -220,86 +598,66 @@ class Pubnub(): if not (channel in self.subscriptions) : self.subscriptions[channel] = { 'first' : False, - 'connected' : 0, - 'timetoken' : '0' + 'connected' : False, } ## Ensure Single Connection if self.subscriptions[channel]['connected'] : - print("Already Connected") - return False + return "Already Connected" self.subscriptions[channel]['connected'] = 1 - ## SUBSCRIPTION RECURSION - def substabizel(): + def _subscribe(): ## STOP CONNECTION? if not self.subscriptions[channel]['connected']: return - + def sub_callback(response): + if not self.subscriptions[channel]['first'] : + self.subscriptions[channel]['first'] = True + connectcb() + ## STOP CONNECTION? if not self.subscriptions[channel]['connected']: return - ## CONNECTED CALLBACK - if not self.subscriptions[channel]['first'] : - self.subscriptions[channel]['first'] = True - connectcb() + ## PROBLEM? if not response: def time_callback(_time): if not _time: - ioloop.add_timeout(time.time()+1, substabizel) + self.timeout( 1, _subscribe ) return errorback("Lost Network Connection") else: - ioloop.add_timeout(time.time()+1, substabizel) + self.timeout( 1, _subscribe) ## ENSURE CONNECTED (Call Time Function) return self.time({ 'callback' : time_callback }) - self.subscriptions[channel]['timetoken'] = response[1] - substabizel() + self.timetoken = response[1] + _subscribe() pc = PubnubCrypto() out = [] for message in response[0]: - if self.cipher_key : - if type( message ) == type(list()): - for item in message: - encryptItem = pc.decrypt(self.cipher_key, item ) - out.append(encryptItem) - message = out - elif type( message ) == type(dict()): - outdict = {} - for k, item in message.iteritems(): - encryptItem = pc.decrypt(self.cipher_key, item ) - outdict[k] = encryptItem - out.append(outdict) - message = out[0] - else: - message = pc.decrypt(self.cipher_key, message ) - - callback(message) + callback(self.decrypt(message)) ## CONNECT TO PUBNUB SUBSCRIBE SERVERS - try : - self._request( [ + try: + self._request( { "urlcomponents" : [ 'subscribe', self.subscribe_key, channel, '0', - str(self.subscriptions[channel]['timetoken']) - ], sub_callback ) + str(self.timetoken) + ], "urlparams" : {"uuid":self.uuid} }, sub_callback ) except : - ioloop.add_timeout(time.time()+1, substabizel) + self.timeout( 1, _subscribe) return ## BEGIN SUBSCRIPTION (LISTEN FOR MESSAGES) - substabizel() - - + _subscribe() def unsubscribe( self, args ): channel = str(args['channel']) if not (channel in self.subscriptions): @@ -311,140 +669,70 @@ class Pubnub(): self.subscriptions[channel]['first'] = False - def history( self, args ) : - """ - #** - #* History - #* - #* Load history from a channel. - #* - #* @param array args with 'channel' and 'limit'. - #* @return mixed false on fail, array on success. - #* - - ## History Example - history = pubnub.history({ - 'channel' : 'hello_world', - 'limit' : 1 - }) - print(history) - - """ - ## Capture User Input - limit = args.has_key('limit') and int(args['limit']) or 10 - channel = str(args['channel']) - - ## Fail if bad input. - if not channel : - print('Missing Channel') - return False - - ## Get History - return self._request( [ - 'history', - self.subscribe_key, - channel, - '0', - str(limit) - ], args['callback'] ); +import tornado.httpclient - def time( self, args ) : - """ - #** - #* Time - #* - #* Timestamp from PubNub Cloud. - #* - #* @return int timestamp. - #* +try: + from hashlib import sha256 + digestmod = sha256 +except ImportError: + import Crypto.Hash.SHA256 as digestmod + sha256 = digestmod.new - ## PubNub Server Time Example - def time_complete(timestamp): - print(timestamp) +import hmac +import tornado.ioloop +from tornado.stack_context import ExceptionStackContext +from PubnubCrypto import PubnubCrypto - pubnub.time(time_complete) +ioloop = tornado.ioloop.IOLoop.instance() - """ - def complete(response) : - args['callback'](response and response[0]) +class Pubnub(PubnubCoreAsync): - self._request( [ - 'time', - '0' - ], complete ) + def stop(self): ioloop.stop() + def start(self): ioloop.start() + def timeout( self, delay, callback): + ioloop.add_timeout( time.time()+float(delay), callback ) - def uuid(self) : - """ - #** - #* uuid - #* - #* Generate a UUID - #* - #* @return UUID. - #* - - ## PubNub UUID Example - uuid = pubnub.uuid() - print(uuid) - """ - return uuid.uuid1() + def __init__( + self, + publish_key, + subscribe_key, + secret_key = False, + cipher_key = False, + ssl_on = False, + origin = 'pubsub.pubnub.com' + ) : + super(Pubnub, self).__init__( + publish_key=publish_key, + subscribe_key=subscribe_key, + secret_key=secret_key, + cipher_key=cipher_key, + ssl_on=ssl_on, + origin=origin, + ) + self.headers = {} + self.headers['User-Agent'] = 'Python-Tornado' + self.headers['Accept-Encoding'] = self.accept_encoding + self.headers['V'] = self.version + self.http = tornado.httpclient.AsyncHTTPClient(max_clients=1000) def _request( self, request, callback ) : - ## Build URL - url = self.origin + '/' + "/".join([ - "".join([ ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.find(ch) > -1 and - hex(ord(ch)).replace( '0x', '%' ).upper() or - ch for ch in list(bit) - ]) for bit in request]) - - requestType = request[0] - - def complete(response) : - if response.error: - return callback(None) - obj = json.loads(response.buffer.getvalue()) - pc = PubnubCrypto() - out = [] - if self.cipher_key : - if requestType == "history" : - if type(obj) == type(list()): - for item in obj: - if type(item) == type(list()): - for subitem in item: - encryptItem = pc.decrypt(self.cipher_key, subitem ) - out.append(encryptItem) - elif type(item) == type(dict()): - outdict = {} - for k, subitem in item.iteritems(): - encryptItem = pc.decrypt(self.cipher_key, subitem ) - outdict[k] = encryptItem - out.append(outdict) - else : - encryptItem = pc.decrypt(self.cipher_key, item ) - out.append(encryptItem) - callback(out) - elif type( obj ) == type(dict()): - for k, item in obj.iteritems(): - encryptItem = pc.decrypt(self.cipher_key, item ) - out.append(encryptItem) - callback(out) - else : - callback(obj) - else : - callback(obj) - + url = self.getUrl(request) ## Send Request Expecting JSON Response - http = tornado.httpclient.AsyncHTTPClient(max_clients=1000) - request = tornado.httpclient.HTTPRequest( url, 'GET', dict({ - 'V' : '3.1', - 'User-Agent' : 'Python-Tornado', - 'Accept-Encoding' : 'gzip' - }) ) + #print self.headers + + request = tornado.httpclient.HTTPRequest( url, 'GET', self.headers, connect_timeout=10, request_timeout=310 ) + + def responseCallback(response): + def handle_exc(*args): + return True + if response.error is not None: + with ExceptionStackContext(handle_exc): + response.rethrow() + elif callback: + callback(eval(response._get_body())) - http.fetch( + self.http.fetch( request, - callback=complete, - connect_timeout=310, - request_timeout=310 + callback=responseCallback, ) diff --git a/python-tornado/examples/here-now-example.py b/python-tornado/examples/here-now-example.py new file mode 100644 index 0000000..85e3432 --- /dev/null +++ b/python-tornado/examples/here-now-example.py @@ -0,0 +1,45 @@ +## www.pubnub.com - PubNub Real-time push service in the cloud. +# coding=utf8 + +## PubNub Real-time Push APIs and Notifications Framework +## Copyright (c) 2010 Stephen Blum +## http://www.pubnub.com/ + +## ----------------------------------- +## PubNub 3.1 Real-time Push Cloud API +## ----------------------------------- + +import sys +import tornado +sys.path.append('..') +sys.path.append('../../common') +from Pubnub import Pubnub + +publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' +subscribe_key = len(sys.argv) > 2 and sys.argv[2] or 'demo' +secret_key = len(sys.argv) > 3 and sys.argv[3] or 'demo' +cipher_key = len(sys.argv) > 4 and sys.argv[4] or '' +ssl_on = len(sys.argv) > 5 and bool(sys.argv[5]) or False + +## ----------------------------------------------------------------------- +## Initiate Pubnub State +## ----------------------------------------------------------------------- +pubnub = Pubnub( publish_key, subscribe_key, secret_key, cipher_key, ssl_on ) +crazy = 'hello_world' + +## ----------------------------------------------------------------------- +## History Example +## ----------------------------------------------------------------------- +def here_now_complete(messages): + print(messages) + pubnub.stop() + +pubnub.here_now( { + 'channel' : crazy, + 'callback' : here_now_complete +}) + +## ----------------------------------------------------------------------- +## IO Event Loop +## ----------------------------------------------------------------------- +pubnub.start() diff --git a/python-tornado/examples/history-example.py b/python-tornado/examples/history-example.py index 5c6fb5b..c1619f4 100644 --- a/python-tornado/examples/history-example.py +++ b/python-tornado/examples/history-example.py @@ -11,7 +11,6 @@ import sys import tornado -sys.path.append('../') from Pubnub import Pubnub publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' @@ -31,6 +30,7 @@ crazy = 'hello_world' ## ----------------------------------------------------------------------- def history_complete(messages): print(messages) + tornado.ioloop.IOLoop.instance().stop() pubnub.history( { 'channel' : crazy, diff --git a/python-tornado/examples/publish-example.py b/python-tornado/examples/publish-example.py index cd66720..b9eaa15 100644 --- a/python-tornado/examples/publish-example.py +++ b/python-tornado/examples/publish-example.py @@ -6,38 +6,57 @@ ## http://www.pubnub.com/ ## ----------------------------------- -## PubNub 3.0 Real-time Push Cloud API +## PubNub 3.1 Real-time Push Cloud API ## ----------------------------------- import sys import tornado sys.path.append('../') +sys.path.append('../..') +sys.path.append('../../common') from Pubnub import Pubnub publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' subscribe_key = len(sys.argv) > 2 and sys.argv[2] or 'demo' secret_key = len(sys.argv) > 3 and sys.argv[3] or 'demo' -cipher_key = len(sys.argv) > 4 and sys.argv[4] or '' ##(Cipher key is Optional) +cipher_key = len(sys.argv) > 4 and sys.argv[4] or 'demo' ##(Cipher key is Optional) ssl_on = len(sys.argv) > 5 and bool(sys.argv[5]) or False ## ----------------------------------------------------------------------- ## Initiate Pubnub State ## ----------------------------------------------------------------------- -pubnub = Pubnub( publish_key, subscribe_key, secret_key,cipher_key, ssl_on ) +pubnub = Pubnub( publish_key=publish_key, subscribe_key=subscribe_key, secret_key=secret_key,cipher_key=cipher_key, ssl_on=ssl_on ) +#pubnub = Pubnub( publish_key, subscribe_key, secret_key, ssl_on ) crazy = 'hello_world' -## ----------------------------------------------------------------------- -## History Example -## ----------------------------------------------------------------------- -def history_complete(messages): - print(messages) +def publish_complete(info): + print(info) + +## Publish string +pubnub.publish({ + 'channel' : crazy, + 'message' : 'Hello World!', + 'callback' : publish_complete +}) -pubnub.history( { - 'channel' : crazy, - 'limit' : 10, - 'callback' : history_complete +## Publish list +li = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'] +pubnub.publish({ + 'channel' : crazy, + 'message' : li, + 'callback' : publish_complete }) +def done_cb(info): + publish_complete(info) + tornado.ioloop.IOLoop.instance().stop() + +## Publish Dictionary Object +pubnub.publish({ + 'channel' : crazy, + 'message' : { 'some_key' : 'some_val' }, + 'callback' : done_cb +}) ## ----------------------------------------------------------------------- ## IO Event Loop ## ----------------------------------------------------------------------- diff --git a/python-tornado/examples/subscribe-example.py b/python-tornado/examples/subscribe-example.py index c819f94..dfe8010 100644 --- a/python-tornado/examples/subscribe-example.py +++ b/python-tornado/examples/subscribe-example.py @@ -12,23 +12,37 @@ import sys import tornado sys.path.append('../') +sys.path.append('../..') from Pubnub import Pubnub publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' subscribe_key = len(sys.argv) > 2 and sys.argv[2] or 'demo' secret_key = len(sys.argv) > 3 and sys.argv[3] or 'demo' -cipher_key = len(sys.argv) > 4 and sys.argv[4] or '' ##(Cipher key is Optional) +cipher_key = len(sys.argv) > 4 and sys.argv[4] or 'demo' ##(Cipher key is Optional) ssl_on = len(sys.argv) > 5 and bool(sys.argv[5]) or False ## ----------------------------------------------------------------------- ## Initiate Pubnub State ## ----------------------------------------------------------------------- -pubnub = Pubnub( publish_key, subscribe_key, secret_key,cipher_key, ssl_on ) +pubnub = Pubnub( publish_key=publish_key, subscribe_key=subscribe_key, secret_key=secret_key,cipher_key=cipher_key, ssl_on=ssl_on ) +#pubnub = Pubnub( publish_key, subscribe_key, secret_key, ssl_on ) crazy = 'hello_world' +def connect_cb(): + print 'Connect' + +def subscribe_result(response): + print response + +pubnub.subscribe({ + 'channel' : crazy, + 'callback' : subscribe_result, + 'connect' : connect_cb +}) ## ----------------------------------------------------------------------- ## Publish Example ## ----------------------------------------------------------------------- +''' def publish_complete(info): print(info) @@ -53,7 +67,7 @@ pubnub.publish({ 'message' : { 'some_key' : 'some_val' }, 'callback' : publish_complete }) - +''' ## ----------------------------------------------------------------------- ## IO Event Loop ## ----------------------------------------------------------------------- diff --git a/python-tornado/tests/benchmark.py b/python-tornado/tests/benchmark.py index 5f9b5e3..9d1840e 100644 --- a/python-tornado/tests/benchmark.py +++ b/python-tornado/tests/benchmark.py @@ -12,7 +12,9 @@ import sys import datetime import tornado +sys.path.append('./') sys.path.append('../') +sys.path.append('../common') from Pubnub import Pubnub publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' diff --git a/python-tornado/tests/unit-test.py b/python-tornado/tests/unit-test.py deleted file mode 100644 index f593d11..0000000 --- a/python-tornado/tests/unit-test.py +++ /dev/null @@ -1,224 +0,0 @@ -## www.pubnub.com - PubNub Real-time push service in the cloud. -# coding=utf8 - -## PubNub Real-time Push APIs and Notifications Framework -## Copyright (c) 2010 Stephen Blum -## http://www.pubnub.com/ - -## TODO Tests -## -## - wait 20 minutes, send a message, receive and success. -## - -## - -## -## - -## ----------------------------------- -## PubNub 3.1 Real-time Push Cloud API -## ----------------------------------- - -import sys -sys.path.append('../') -from Pubnub import Pubnub - -publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' -subscribe_key = len(sys.argv) > 2 and sys.argv[2] or 'demo' -secret_key = len(sys.argv) > 3 and sys.argv[3] or None -cipher_key = len(sys.argv) > 4 and sys.argv[4] or None -ssl_on = len(sys.argv) > 5 and bool(sys.argv[5]) or False - -## ----------------------------------------------------------------------- -## Command Line Options Supplied PubNub -## ----------------------------------------------------------------------- -pubnub_user_supplied_options = Pubnub( - publish_key, ## OPTIONAL (supply None to disable) - subscribe_key, ## REQUIRED - secret_key, ## OPTIONAL (supply None to disable) - cipher_key, ## OPTIONAL (supply None to disable) - ssl_on ## OPTIONAL (supply None to disable) -) - -## ----------------------------------------------------------------------- -## High Security PubNub -## ----------------------------------------------------------------------- -pubnub_high_security = Pubnub( - ## Publish Key - 'pub-c-a30c030e-9f9c-408d-be89-d70b336ca7a0', - - ## Subscribe Key - 'sub-c-387c90f3-c018-11e1-98c9-a5220e0555fd', - - ## Secret Key - 'sec-c-MTliNDE0NTAtYjY4Ni00MDRkLTllYTItNDhiZGE0N2JlYzBl', - - ## Cipher Key - 'YWxzamRmbVjFaa05HVnGFqZHM3NXRBS73jxmhVMkjiwVVXV1d5UrXR1JLSkZFRr'+ - 'WVd4emFtUm1iR0TFpUZvbiBoYXMgYmVlbxWkhNaF3uUi8kM0YkJTEVlZYVFjBYi'+ - 'jFkWFIxSkxTa1pGUjd874hjklaTFpUwRVuIFNob3VsZCB5UwRkxUR1J6YVhlQWa'+ - 'V1ZkNGVH32mDkdho3pqtRnRVbTFpUjBaeGUgYXNrZWQtZFoKjda40ZWlyYWl1eX'+ - 'U4RkNtdmNub2l1dHE2TTA1jd84jkdJTbFJXYkZwWlZtRnKkWVrSRhhWbFpZVmFz'+ - 'c2RkZmTFpUpGa1dGSXhTa3hUYTFwR1Vpkm9yIGluZm9ybWFNfdsWQdSiiYXNWVX'+ - 'RSblJWYlRGcFVqQmFlRmRyYUU0MFpXbHlZV2wxZVhVNFJrTnR51YjJsMWRIRTJU'+ - 'W91ciBpbmZvcm1hdGliBzdWJtaXR0ZWQb3UZSBhIHJlc3BvbnNlLCB3ZWxsIHJl'+ - 'VEExWdHVybiB0am0aW9uIb24gYXMgd2UgcG9zc2libHkgY2FuLuhcFe24ldWVns'+ - 'dSaTFpU3hVUjFKNllWaFdhRmxZUWpCaQo34gcmVxdWlGFzIHNveqQl83snBfVl3', - - ## 2048bit SSL ON - ENABLED TRUE - True -) - -## ----------------------------------------------------------------------- -## Channel | Message Test Data (UTF-8) -## ----------------------------------------------------------------------- -crazy = ' ~`â¦â§!@#$%^&*(顶顅Ȓ)+=[]\\{}|;\':",./<>?abcd' -many_channels = [ str(x) + '-many_channel_test' for x in range(10) ] -runthroughs = 0 -planned_tests = 2 -delivery_retries = 0 -max_retries = 10 - -## ----------------------------------------------------------------------- -## Unit Test Function -## ----------------------------------------------------------------------- -def test( trial, name ) : - if trial : print( 'PASS: ' + name ) - else : print( '- FAIL - ' + name ) - -def test_pubnub(pubnub): - global runthroughs, planned_tests, delivery_retries, max_retries - - ## ----------------------------------------------------------------------- - ## Many Channels - ## ----------------------------------------------------------------------- - def phase2(): - status = { - 'sent' : 0, - 'received' : 0, - 'connections' : 0 - } - - def received( message, chan ): - global runthroughs - - test( status['received'] <= status['sent'], 'many sends' ) - status['received'] += 1 - pubnub.unsubscribe({ 'channel' : chan }) - if status['received'] == len(many_channels): - runthroughs += 1 - if runthroughs == planned_tests: pubnub.stop() - - def publish_complete( info, chan ): - global delivery_retries, max_retries - status['sent'] += 1 - test( info, 'publish complete' ) - test( info and len(info) > 2, 'publish response' ) - if not info[0]: - delivery_retries += 1 - if max_retries > delivery_retries: sendit(chan) - - def sendit(chan): - tchan = chan - pubnub.publish({ - 'channel' : chan, - 'message' : "Hello World", - 'callback' : (lambda msg:publish_complete( msg, tchan )) - }) - - def connected(chan): - status['connections'] += 1 - sendit(chan) - - def delivered(info): - if info and info[0]: status['sent'] += 1 - - def subscribe(chan): - pubnub.subscribe({ - 'channel' : chan, - 'connect' : (lambda:connected(chan+'')), - 'callback' : (lambda msg:received( msg, chan )) - }) - - ## Subscribe All Channels - for chan in many_channels: subscribe(chan) - - ## ----------------------------------------------------------------------- - ## Time Example - ## ----------------------------------------------------------------------- - def time_complete(timetoken): - test( timetoken, 'timetoken fetch' ) - test( isinstance( timetoken, int ), 'timetoken int type' ) - - pubnub.time({ 'callback' : time_complete }) - - ## ----------------------------------------------------------------------- - ## Publish Example - ## ----------------------------------------------------------------------- - def publish_complete(info): - test( info, 'publish complete' ) - test( info and len(info) > 2, 'publish response' ) - - pubnub.history( { - 'channel' : crazy, - 'limit' : 10, - 'callback' : history_complete - }) - - ## ----------------------------------------------------------------------- - ## History Example - ## ----------------------------------------------------------------------- - def history_complete(messages): - test( messages and len(messages) > 0, 'history' ) - test( messages, 'history' ) - - - pubnub.publish({ - 'channel' : crazy, - 'message' : "Hello World", - 'callback' : publish_complete - }) - - ## ----------------------------------------------------------------------- - ## Subscribe Example - ## ----------------------------------------------------------------------- - def message_received(message): - test( message, 'message received' ) - pubnub.unsubscribe({ 'channel' : crazy }) - - def done() : - pubnub.unsubscribe({ 'channel' : crazy }) - pubnub.publish({ - 'channel' : crazy, - 'message' : "Hello World", - 'callback' : (lambda x:x) - }) - - def dumpster(message) : - test( 0, 'never see this' ) - - pubnub.subscribe({ - 'channel' : crazy, - 'connect' : done, - 'callback' : dumpster - }) - - def connected() : - pubnub.publish({ - 'channel' : crazy, - 'message' : { 'Info' : 'Connected!' } - }) - - pubnub.subscribe({ - 'channel' : crazy, - 'connect' : connected, - 'callback' : message_received - }) - - phase2() - -## ----------------------------------------------------------------------- -## Run Tests -## ----------------------------------------------------------------------- -test_pubnub(pubnub_user_supplied_options) -test_pubnub(pubnub_high_security) -pubnub_high_security.start() - diff --git a/python-tornado/tests/unit-tests.py b/python-tornado/tests/unit-tests.py new file mode 100644 index 0000000..fdaa194 --- /dev/null +++ b/python-tornado/tests/unit-tests.py @@ -0,0 +1,73 @@ + +import sys + +sys.path.append('../../common') +sys.path.append('..') +sys.path.append('../common') +sys.path.append('.') + +from PubnubUnitTest import Suite +from Pubnub import Pubnub + +pubnub = Pubnub("demo","demo") + +tests_count = 1 + 2 +test_suite = Suite(pubnub,tests_count) + +tests = [] + + +def test_publish(): + name = "Publish Test" + def success(r): + test_suite.test(r[0] == 1, name) + + def fail(e): + test_suite.test(False, msg , e) + + + pubnub.publish({ + 'channel' : 'hello', + 'message' : 'hi', + 'callback' : success, + 'error' : fail + }) +tests.append(test_publish) + + +def test_subscribe_publish(): + channel = "hello" + name = "Subscribe Publish Test" + publish_msg = "This is Pubnub Python-Twisted" + def connect(): + def success(r): + test_suite.test(r[0] == 1, name, "publish success") + + def fail(e): + test_suite.test(False, name , "Publish Failed", e) + + pubnub.publish({ + 'channel' : channel, + 'message' : publish_msg, + 'callback' : success, + 'error' : fail + }) + + def callback(r): + test_suite.test(r == publish_msg, name, "message received") + + pubnub.subscribe({ + 'channel' : channel, + 'callback' : callback, + 'connect' : connect + }) +tests.append(test_subscribe_publish) + + + + + +for t in tests: + t() + +pubnub.start() diff --git a/python-tornado/unassembled/Platform.py b/python-tornado/unassembled/Platform.py new file mode 100644 index 0000000..7565fd2 --- /dev/null +++ b/python-tornado/unassembled/Platform.py @@ -0,0 +1,67 @@ +import tornado.httpclient + +try: + from hashlib import sha256 + digestmod = sha256 +except ImportError: + import Crypto.Hash.SHA256 as digestmod + sha256 = digestmod.new + +import hmac +import tornado.ioloop +from tornado.stack_context import ExceptionStackContext +from PubnubCrypto import PubnubCrypto + +ioloop = tornado.ioloop.IOLoop.instance() + +class Pubnub(PubnubCoreAsync): + + def stop(self): ioloop.stop() + def start(self): ioloop.start() + def timeout( self, delay, callback): + ioloop.add_timeout( time.time()+float(delay), callback ) + + def __init__( + self, + publish_key, + subscribe_key, + secret_key = False, + cipher_key = False, + ssl_on = False, + origin = 'pubsub.pubnub.com' + ) : + super(Pubnub, self).__init__( + publish_key=publish_key, + subscribe_key=subscribe_key, + secret_key=secret_key, + cipher_key=cipher_key, + ssl_on=ssl_on, + origin=origin, + ) + self.headers = {} + self.headers['User-Agent'] = 'Python-Tornado' + self.headers['Accept-Encoding'] = self.accept_encoding + self.headers['V'] = self.version + self.http = tornado.httpclient.AsyncHTTPClient(max_clients=1000) + + def _request( self, request, callback ) : + url = self.getUrl(request) + ## Send Request Expecting JSON Response + #print self.headers + + request = tornado.httpclient.HTTPRequest( url, 'GET', self.headers, connect_timeout=10, request_timeout=310 ) + + def responseCallback(response): + def handle_exc(*args): + return True + if response.error is not None: + with ExceptionStackContext(handle_exc): + response.rethrow() + elif callback: + callback(eval(response._get_body())) + + self.http.fetch( + request, + callback=responseCallback, + ) + diff --git a/python-twisted/Makefile b/python-twisted/Makefile new file mode 100644 index 0000000..bf23137 --- /dev/null +++ b/python-twisted/Makefile @@ -0,0 +1,28 @@ +include ../Makefile.inc + + +.PHONY: all +all: build + +.PHONY: build +build: + cat ../common/LICENSE_HEADER > ./Pubnub.py + echo "\n" >> ./Pubnub.py + cat ../common/PubnubCrypto.py >> ./Pubnub.py + echo "\n" >> ./Pubnub.py + cat ../common/PubnubBase.py >> ./Pubnub.py + echo "\n" >> ./Pubnub.py + cat ../common/PubnubCoreAsync.py >> ./Pubnub.py + echo "\n" >> ./Pubnub.py + cat ./unassembled/Platform.py >> ./Pubnub.py + find -name "Pubnub*py" | xargs sed -i "s/PubNub\ [0-9]\.[0-9]\.[0-9]/PubNub\ $(VERSION)/g" + + +.PHONY: clean +clean: + rm -f Pubnub.py* + +.PHONY: test +test: + python tests/unit-tests.py + diff --git a/python-twisted/Pubnub.py b/python-twisted/Pubnub.py index 3c3f4b1..283e121 100644 --- a/python-twisted/Pubnub.py +++ b/python-twisted/Pubnub.py @@ -6,42 +6,102 @@ ## http://www.pubnub.com/ ## ----------------------------------- -## PubNub 3.1 Real-time Push Cloud API +## PubNub 3.3.4 Real-time Push Cloud API ## ----------------------------------- -import sys -import json -import time + + +from Crypto.Cipher import AES +from Crypto.Hash import MD5 +from base64 import encodestring, decodestring import hashlib -import urllib2 -import uuid -try: - from hashlib import sha256 - digestmod = sha256 -except ImportError: - import Crypto.Hash.SHA256 as digestmod - sha256 = digestmod.new import hmac -from twisted.internet import reactor -from twisted.internet.defer import Deferred -from twisted.internet.protocol import Protocol -from twisted.web.client import Agent -from twisted.web.client import HTTPConnectionPool -from twisted.web.http_headers import Headers -from PubnubCrypto import PubnubCrypto -import gzip -import zlib -pnconn_pool = HTTPConnectionPool(reactor) -pnconn_pool.maxPersistentPerHost = 100 -pnconn_pool.cachedConnectionTimeout = 310 +class PubnubCrypto() : + """ + #** + #* PubnubCrypto + #* + #** -class Pubnub(): + ## Initiate Class + pc = PubnubCrypto - def start(self): reactor.run() - def stop(self): reactor.stop() - def timeout( self, callback, delay ): - reactor.callLater( delay, callback ) + """ + + def pad( self, msg, block_size=16 ): + """ + #** + #* pad + #* + #* pad the text to be encrypted + #* appends a padding character to the end of the String + #* until the string has block_size length + #* @return msg with padding. + #** + """ + padding = block_size - (len(msg) % block_size) + return msg + chr(padding)*padding + + def depad( self, msg ): + """ + #** + #* depad + #* + #* depad the decryptet message" + #* @return msg without padding. + #** + """ + return msg[0:-ord(msg[-1])] + + def getSecret( self, key ): + """ + #** + #* getSecret + #* + #* hases the key to MD5 + #* @return key in MD5 format + #** + """ + return hashlib.sha256(key).hexdigest() + + def encrypt( self, key, msg ): + """ + #** + #* encrypt + #* + #* encrypts the message + #* @return message in encrypted format + #** + """ + secret = self.getSecret(key) + Initial16bytes='0123456789012345' + cipher = AES.new(secret[0:32],AES.MODE_CBC,Initial16bytes) + enc = encodestring(cipher.encrypt(self.pad(msg))) + return enc + def decrypt( self, key, msg ): + """ + #** + #* decrypt + #* + #* decrypts the message + #* @return message in decryped format + #** + """ + secret = self.getSecret(key) + Initial16bytes='0123456789012345' + cipher = AES.new(secret[0:32],AES.MODE_CBC,Initial16bytes) + return self.depad((cipher.decrypt(decodestring(msg)))) + + +try: import json +except ImportError: import simplejson as json +import time +import hashlib +import urllib2 +import uuid + +class PubnubBase(object): def __init__( self, publish_key, @@ -49,7 +109,8 @@ class Pubnub(): secret_key = False, cipher_key = False, ssl_on = False, - origin = 'pubsub.pubnub.com' + origin = 'pubsub.pubnub.com', + UUID = None ) : """ #** @@ -59,9 +120,10 @@ class Pubnub(): #* #* @param string publish_key required key to send messages. #* @param string subscribe_key required key to receive messages. - #* @param string secret_key required key to sign messages. + #* @param string secret_key optional key to sign messages. #* @param boolean ssl required for 2048 bit encrypted messages. #* @param string origin PUBNUB Server Origin. + #* @param string pres_uuid optional identifier for presence (auto-generated if not supplied) #** ## Initiat Class @@ -69,17 +131,79 @@ class Pubnub(): """ self.origin = origin + self.limit = 1800 self.publish_key = publish_key self.subscribe_key = subscribe_key self.secret_key = secret_key self.cipher_key = cipher_key self.ssl = ssl_on - self.subscriptions = {} if self.ssl : self.origin = 'https://' + self.origin else : self.origin = 'http://' + self.origin + + self.uuid = UUID or str(uuid.uuid4()) + + if not isinstance(self.uuid, basestring): + raise AttributeError("pres_uuid must be a string") + + def sign(self, channel, message): + ## Sign Message + if self.secret_key: + signature = hashlib.md5('/'.join([ + self.publish_key, + self.subscribe_key, + self.secret_key, + channel, + message + ])).hexdigest() + else: + signature = '0' + return signature + + def encrypt(self, message): + if self.cipher_key: + pc = PubnubCrypto() + out = [] + if type( message ) == type(list()): + for item in message: + encryptItem = pc.encrypt(self.cipher_key, item ).rstrip() + out.append(encryptItem) + message = json.dumps(out) + elif type( message ) == type(dict()): + outdict = {} + for k, item in message.iteritems(): + encryptItem = pc.encrypt(self.cipher_key, item ).rstrip() + outdict[k] = encryptItem + out.append(outdict) + message = json.dumps(out[0]) + else: + message = json.dumps(pc.encrypt(self.cipher_key, json.dumps(message)).replace('\n','')) + else : + message = json.dumps(message) + + return message; + + def decrypt(self, message): + if self.cipher_key: + pc = PubnubCrypto() + if type( message ) == type(list()): + for item in message: + encryptItem = pc.decrypt(self.cipher_key, item ) + out.append(encryptItem) + message = out + elif type( message ) == type(dict()): + outdict = {} + for k, item in message.iteritems(): + encryptItem = pc.decrypt(self.cipher_key, item ) + outdict[k] = encryptItem + out.append(outdict) + message = out[0] + else: + message = pc.decrypt(self.cipher_key, message) + + return message def publish( self, args ) : @@ -94,72 +218,35 @@ class Pubnub(): #** ## Publish Example - def publish_complete(info): - print(info) - - pubnub.publish({ + info = pubnub.publish({ 'channel' : 'hello_world', 'message' : { 'some_text' : 'Hello my World' - }, - 'callback' : publish_complete + } }) + print(info) """ - ## Capture Callback - if args.has_key('callback'): callback = args['callback'] - else: callback = lambda x : x - ## Fail if bad input. - if not (args['channel'] and args['message']): - callback([ 0, 'Missing Channel or Message', 0 ]) - return False + if not (args['channel'] and args['message']) : + return [ 0, 'Missing Channel or Message' ] ## Capture User Input channel = str(args['channel']) - message = args['message'] - if self.cipher_key : - pc = PubnubCrypto() - out = [] - if type( message ) == type(list()): - for item in message: - encryptItem = pc.encrypt(self.cipher_key, item ).rstrip() - out.append(encryptItem) - message = json.dumps(out) - elif type( message ) == type(dict()): - outdict = {} - for k, item in message.iteritems(): - encryptItem = pc.encrypt(self.cipher_key, item ).rstrip() - outdict[k] = encryptItem - out.append(outdict) - message = json.dumps(out[0]) - else: - message = json.dumps(pc.encrypt(self.cipher_key, message).replace('\n','')) + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] else : - message = json.dumps(args['message']) + callback = None - def publish_response(info): - callback(info or [0, 'Disconnected', 0]); + #message = json.dumps(args['message'], separators=(',',':')) + message = self.encrypt(args['message']) - ## Sign Message - if self.secret_key : - hashObject = sha256() - hashObject.update(self.secret_key) - hashedSecret = hashObject.hexdigest() - hash = hmac.HMAC(hashedSecret, '/'.join([ - self.publish_key, - self.subscribe_key, - self.secret_key, - channel, - message - ]), digestmod=digestmod) - signature = hash.hexdigest() - else : - signature = '0' + signature = self.sign(channel, message) ## Send Message - return self._request([ + return self._request({"urlcomponents": [ 'publish', self.publish_key, self.subscribe_key, @@ -167,8 +254,295 @@ class Pubnub(): channel, '0', message - ], publish_response ) + ]}, callback) + + def presence( self, args ) : + """ + #** + #* presence + #* + #* This is BLOCKING. + #* Listen for presence events on a channel. + #* + #* @param array args with channel and callback. + #* @return false on fail, array on success. + #** + + ## Presence Example + def pres_event(message) : + print(message) + return True + + pubnub.presence({ + 'channel' : 'hello_world', + 'callback' : receive + }) + """ + + ## Fail if missing channel + if not 'channel' in args : + raise Exception('Missing Channel.') + return False + + ## Fail if missing callback + if not 'callback' in args : + raise Exception('Missing Callback.') + return False + + ## Capture User Input + channel = str(args['channel']) + callback = args['callback'] + subscribe_key = args.get('subscribe_key') or self.subscribe_key + + return self.subscribe({'channel': channel+'-pnpres', 'subscribe_key':subscribe_key, 'callback': callback}) + + + def here_now( self, args ) : + """ + #** + #* Here Now + #* + #* Load current occupancy from a channel. + #* + #* @param array args with 'channel'. + #* @return mixed false on fail, array on success. + #* + + ## Presence Example + here_now = pubnub.here_now({ + 'channel' : 'hello_world', + }) + print(here_now['occupancy']) + print(here_now['uuids']) + + """ + channel = str(args['channel']) + + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] + else : + callback = None + + ## Fail if bad input. + if not channel : + raise Exception('Missing Channel') + return False + + ## Get Presence Here Now + return self._request({"urlcomponents": [ + 'v2','presence', + 'sub_key', self.subscribe_key, + 'channel', channel + ]}, callback); + + + def history( self, args ) : + """ + #** + #* History + #* + #* Load history from a channel. + #* + #* @param array args with 'channel' and 'limit'. + #* @return mixed false on fail, array on success. + #* + + ## History Example + history = pubnub.history({ + 'channel' : 'hello_world', + 'limit' : 1 + }) + print(history) + + """ + ## Capture User Input + limit = args.has_key('limit') and int(args['limit']) or 10 + channel = str(args['channel']) + + ## Fail if bad input. + if not channel : + raise Exception('Missing Channel') + return False + + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] + else : + callback = None + + ## Get History + return self._request({ "urlcomponents" : [ + 'history', + self.subscribe_key, + channel, + '0', + str(limit) + ] }, callback); + def detailedHistory(self, args) : + """ + #** + #* Detailed History + #* + #* Load Detailed history from a channel. + #* + #* @param array args with 'channel', optional: 'start', 'end', 'reverse', 'count' + #* @return mixed false on fail, array on success. + #* + + ## History Example + history = pubnub.detailedHistory({ + 'channel' : 'hello_world', + 'count' : 5 + }) + print(history) + + """ + ## Capture User Input + channel = str(args['channel']) + + params = dict() + count = 100 + + if args.has_key('count'): + count = int(args['count']) + + params['count'] = str(count) + + if args.has_key('reverse'): + params['reverse'] = str(args['reverse']).lower() + + if args.has_key('start'): + params['start'] = str(args['start']) + + if args.has_key('end'): + params['end'] = str(args['end']) + + ## Fail if bad input. + if not channel : + raise Exception('Missing Channel') + return False + + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] + else : + callback = None + + ## Get History + return self._request({ 'urlcomponents' : [ + 'v2', + 'history', + 'sub-key', + self.subscribe_key, + 'channel', + channel, + ],'urlparams' : params }, callback=callback); + + def time(self, args = None) : + """ + #** + #* Time + #* + #* Timestamp from PubNub Cloud. + #* + #* @return int timestamp. + #* + + ## PubNub Server Time Example + timestamp = pubnub.time() + print(timestamp) + + """ + ## Capture Callback + if args and args.has_key('callback') : + callback = args['callback'] + else : + callback = None + time = self._request({'urlcomponents' : [ + 'time', + '0' + ]}, callback) + if time != None: + return time[0] + + + def _encode( self, request ) : + return [ + "".join([ ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.find(ch) > -1 and + hex(ord(ch)).replace( '0x', '%' ).upper() or + ch for ch in list(bit) + ]) for bit in request] + + def getUrl(self,request): + ## Build URL + url = self.origin + '/' + "/".join([ + "".join([ ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.find(ch) > -1 and + hex(ord(ch)).replace( '0x', '%' ).upper() or + ch for ch in list(bit) + ]) for bit in request["urlcomponents"]]) + if (request.has_key("urlparams")): + url = url + '?' + "&".join([ x + "=" + y for x,y in request["urlparams"].iteritems()]) + return url + + +try: + from hashlib import sha256 + digestmod = sha256 +except ImportError: + import Crypto.Hash.SHA256 as digestmod + sha256 = digestmod.new +import hmac + +class PubnubCoreAsync(PubnubBase): + + def start(self): pass + def stop(self): pass + def timeout( self, delay, callback ): + pass + + def __init__( + self, + publish_key, + subscribe_key, + secret_key = False, + cipher_key = False, + ssl_on = False, + origin = 'pubsub.pubnub.com', + uuid = None + ) : + """ + #** + #* Pubnub + #* + #* Init the Pubnub Client API + #* + #* @param string publish_key required key to send messages. + #* @param string subscribe_key required key to receive messages. + #* @param string secret_key required key to sign messages. + #* @param boolean ssl required for 2048 bit encrypted messages. + #* @param string origin PUBNUB Server Origin. + #** + + ## Initiat Class + pubnub = Pubnub( 'PUBLISH-KEY', 'SUBSCRIBE-KEY', 'SECRET-KEY', False ) + + """ + super(PubnubCoreAsync, self).__init__( + publish_key=publish_key, + subscribe_key=subscribe_key, + secret_key=secret_key, + cipher_key=cipher_key, + ssl_on=ssl_on, + origin=origin, + UUID=uuid + ) + + self.subscriptions = {} + self.timetoken = 0 + self.version = '3.3.4' + self.accept_encoding = 'gzip' def subscribe( self, args ) : """ @@ -224,8 +598,7 @@ class Pubnub(): if not (channel in self.subscriptions) : self.subscriptions[channel] = { 'first' : False, - 'connected' : 0, - 'timetoken' : '0' + 'connected' : False, } ## Ensure Single Connection @@ -233,78 +606,58 @@ class Pubnub(): return "Already Connected" self.subscriptions[channel]['connected'] = 1 - ## SUBSCRIPTION RECURSION - def substabizel(): + def _subscribe(): ## STOP CONNECTION? if not self.subscriptions[channel]['connected']: return - + def sub_callback(response): + if not self.subscriptions[channel]['first'] : + self.subscriptions[channel]['first'] = True + connectcb() + ## STOP CONNECTION? if not self.subscriptions[channel]['connected']: return - ## CONNECTED CALLBACK - if not self.subscriptions[channel]['first'] : - self.subscriptions[channel]['first'] = True - connectcb() + ## PROBLEM? if not response: def time_callback(_time): if not _time: - reactor.callLater( 1, substabizel ) + self.timeout( 1, _subscribe ) return errorback("Lost Network Connection") else: - reactor.callLater( 1, substabizel ) + self.timeout( 1, _subscribe) ## ENSURE CONNECTED (Call Time Function) return self.time({ 'callback' : time_callback }) - self.subscriptions[channel]['timetoken'] = response[1] - substabizel() + self.timetoken = response[1] + _subscribe() pc = PubnubCrypto() out = [] for message in response[0]: - if self.cipher_key : - if type( message ) == type(list()): - for item in message: - encryptItem = pc.decrypt(self.cipher_key, item ) - out.append(encryptItem) - message = out - elif type( message ) == type(dict()): - outdict = {} - for k, item in message.iteritems(): - encryptItem = pc.decrypt(self.cipher_key, item ) - outdict[k] = encryptItem - out.append(outdict) - message = out[0] - else: - message = pc.decrypt(self.cipher_key, message ) - else : - message - - callback(message) + callback(self.decrypt(message)) ## CONNECT TO PUBNUB SUBSCRIBE SERVERS - try : - self._request( [ + try: + self._request( { "urlcomponents" : [ 'subscribe', self.subscribe_key, channel, '0', - str(self.subscriptions[channel]['timetoken']) - ], sub_callback ) + str(self.timetoken) + ], "urlparams" : {"uuid":self.uuid} }, sub_callback ) except : - reactor.callLater( 1, substabizel ) + self.timeout( 1, _subscribe) return ## BEGIN SUBSCRIPTION (LISTEN FOR MESSAGES) - substabizel() - - + _subscribe() def unsubscribe( self, args ): channel = str(args['channel']) if not (channel in self.subscriptions): @@ -316,168 +669,82 @@ class Pubnub(): self.subscriptions[channel]['first'] = False - def history( self, args ) : - """ - #** - #* History - #* - #* Load history from a channel. - #* - #* @param array args with 'channel' and 'limit'. - #* @return mixed false on fail, array on success. - #* - - ## History Example - history = pubnub.history({ - 'channel' : 'hello_world', - 'limit' : 1 - }) - print(history) - - """ - ## Capture User Input - limit = args.has_key('limit') and int(args['limit']) or 10 - channel = str(args['channel']) - - ## Fail if bad input. - if not channel : - return 'Missing Channel' - - ## Get History - pc = PubnubCrypto() - return self._request( [ - 'history', - self.subscribe_key, - channel, - '0', - str(limit) - ], args['callback'] ) - - def time( self, args ) : - """ - #** - #* Time - #* - #* Timestamp from PubNub Cloud. - #* - #* @return int timestamp. - #* - - ## PubNub Server Time Example - def time_complete(timestamp): - print(timestamp) - - pubnub.time(time_complete) +from twisted.web.client import getPage +from twisted.internet import reactor +from twisted.internet.defer import Deferred +from twisted.internet.protocol import Protocol +from twisted.web.client import Agent, ContentDecoderAgent, RedirectAgent, GzipDecoder +from twisted.web.client import HTTPConnectionPool +from twisted.web.http_headers import Headers +from twisted.internet.ssl import ClientContextFactory +from twisted.internet.task import LoopingCall - """ - def complete(response) : - if not response: return 0 - args['callback'](response[0]) +pnconn_pool = HTTPConnectionPool(reactor, persistent=True) +pnconn_pool.maxPersistentPerHost = 100 +pnconn_pool.cachedConnectionTimeout = 310 - self._request( [ - 'time', - '0' - ], complete ) +class Pubnub(PubnubCoreAsync): - def uuid(self) : - """ - #** - #* uuid - #* - #* Generate a UUID - #* - #* @return UUID. - #* + def start(self): reactor.run() + def stop(self): reactor.stop() + def timeout( self, delay, callback ): + reactor.callLater( delay, callback ) - ## PubNub UUID Example - uuid = pubnub.uuid() - print(uuid) - """ - return uuid.uuid1() + def __init__( + self, + publish_key, + subscribe_key, + secret_key = False, + cipher_key = False, + ssl_on = False, + origin = 'pubsub.pubnub.com' + ) : + super(Pubnub, self).__init__( + publish_key=publish_key, + subscribe_key=subscribe_key, + secret_key=secret_key, + ssl_on=ssl_on, + origin=origin, + ) + self.headers = {} + self.headers['User-Agent'] = ['Python-Twisted'] + #self.headers['Accept-Encoding'] = [self.accept_encoding] + self.headers['V'] = [self.version] def _request( self, request, callback ) : global pnconn_pool ## Build URL + ''' url = self.origin + '/' + "/".join([ "".join([ ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.find(ch) > -1 and hex(ord(ch)).replace( '0x', '%' ).upper() or ch for ch in list(bit) ]) for bit in request]) - - requestType = request[0] - agent = Agent( + ''' + url = self.getUrl(request) + agent = ContentDecoderAgent(RedirectAgent(Agent( reactor, - self.ssl and None or pnconn_pool, - connectTimeout=30 - ) - request = agent.request( 'GET', url, Headers({ - 'V' : ['3.1'], - 'User-Agent' : ['Python-Twisted'], - 'Accept-Encoding' : ['gzip'] - }), None ) - - self.resulting_is = str() - def received(response): - headerlist = list(response.headers.getAllRawHeaders()) - for item in headerlist: - if( item[0] == "Content-Encoding"): - if type(item[1]) == type(list()): - for subitem in item[1]: - self.resulting_is = subitem - elif type(item[1]) == type(str()): - self.resulting_is = item[1] + contextFactory = WebClientContextFactory(), + pool = self.ssl and None or pnconn_pool + )), [('gzip', GzipDecoder)]) + request = agent.request( 'GET', url, Headers(self.headers), None ) + def received(response): finished = Deferred() response.deliverBody(PubNubResponse(finished)) return finished def complete(data): - if ( type(data) == type(str()) ): - if self.resulting_is: - d = zlib.decompressobj(16+zlib.MAX_WBITS) - - try : data = d.decompress(data) # try/catch here, pass through if except - except : data = data - - try : obj = json.loads(data) - except : obj = None - - pc = PubnubCrypto() - out = [] - if self.cipher_key : - if requestType == "history" : - if type(obj) == type(list()): - for item in obj: - if type(item) == type(list()): - for subitem in item: - encryptItem = pc.decrypt(self.cipher_key, subitem ) - out.append(encryptItem) - elif type(item) == type(dict()): - outdict = {} - for k, subitem in item.iteritems(): - encryptItem = pc.decrypt(self.cipher_key, subitem ) - outdict[k] = encryptItem - out.append(outdict) - else : - encryptItem = pc.decrypt(self.cipher_key, item ) - out.append(encryptItem) - callback(out) - elif type( obj ) == type(dict()): - for k, item in obj.iteritems(): - encryptItem = pc.decrypt(self.cipher_key, item ) - out.append(encryptItem) - callback(out) - else : - callback(obj) - else : - callback(obj) + callback(eval(data)) request.addCallback(received) request.addBoth(complete) - - +class WebClientContextFactory(ClientContextFactory): + def getContext(self, hostname, port): + return ClientContextFactory.getContext(self) + class PubNubResponse(Protocol): def __init__( self, finished ): self.finished = finished diff --git a/python-twisted/PubnubCrypto.py b/python-twisted/PubnubCrypto.py deleted file mode 100644 index 744f2d3..0000000 --- a/python-twisted/PubnubCrypto.py +++ /dev/null @@ -1,92 +0,0 @@ -## www.pubnub.com - PubNub Real-time push service in the cloud. -# coding=utf8 - -## PubNub Real-time Push APIs and Notifications Framework -## Copyright (c) 2010 Stephen Blum -## http://www.pubnub.com/ - -## ----------------------------------- -## PubNub 3.1 Real-time Push Cloud API -## ----------------------------------- - -from Crypto.Cipher import AES -from Crypto.Hash import MD5 -from base64 import encodestring, decodestring -import hashlib -import hmac - -class PubnubCrypto() : - """ - #** - #* PubnubCrypto - #* - #** - - ## Initiate Class - pc = PubnubCrypto - - """ - - def pad( self, msg, block_size=16 ): - """ - #** - #* pad - #* - #* pad the text to be encrypted - #* appends a padding character to the end of the String - #* until the string has block_size length - #* @return msg with padding. - #** - """ - return msg + ((block_size - len(msg) % block_size) * chr(block_size - len(msg) % block_size)) - - def depad( self, msg ): - """ - #** - #* depad - #* - #* depad the decryptet message" - #* @return msg without padding. - #** - """ - return msg[0:-ord(msg[-1])] - - def getSecret( self, key ): - """ - #** - #* getSecret - #* - #* hases the key to MD5 - #* @return key in MD5 format - #** - """ - return MD5.new(key).digest() - - def encrypt( self, key, msg ): - """ - #** - #* encrypt - #* - #* encrypts the message - #* @return message in encrypted format - #** - """ - secret = self.getSecret(key) - Initial16bytes='0123456789012345' - cipher = AES.new(secret,AES.MODE_CBC,Initial16bytes) - return encodestring(cipher.encrypt(self.pad(msg))) - - def decrypt( self, key, msg ): - """ - #** - #* decrypt - #* - #* decrypts the message - #* @return message in decryped format - #** - """ - secret = self.getSecret(key) - Initial16bytes='0123456789012345' - cipher = AES.new(secret,AES.MODE_CBC,Initial16bytes) - return self.depad((cipher.decrypt(decodestring(msg)))) - diff --git a/python-twisted/examples/here-now-example.py b/python-twisted/examples/here-now-example.py new file mode 100644 index 0000000..b3c9dc0 --- /dev/null +++ b/python-twisted/examples/here-now-example.py @@ -0,0 +1,43 @@ +## www.pubnub.com - PubNub Real-time push service in the cloud. +# coding=utf8 + +## PubNub Real-time Push APIs and Notifications Framework +## Copyright (c) 2010 Stephen Blum +## http://www.pubnub.com/ + +## ----------------------------------- +## PubNub 3.1 Real-time Push Cloud API +## ----------------------------------- + +import sys +from twisted.internet import reactor +from Pubnub import Pubnub + +publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' +subscribe_key = len(sys.argv) > 2 and sys.argv[2] or 'demo' +secret_key = len(sys.argv) > 3 and sys.argv[3] or 'demo' +cipher_key = len(sys.argv) > 4 and sys.argv[4] or '' +ssl_on = len(sys.argv) > 5 and bool(sys.argv[5]) or False + +## ----------------------------------------------------------------------- +## Initiate Pubnub State +## ----------------------------------------------------------------------- +pubnub = Pubnub( publish_key, subscribe_key, secret_key, cipher_key, ssl_on ) +crazy = 'hello_world' + +## ----------------------------------------------------------------------- +## History Example +## ----------------------------------------------------------------------- +def here_now_complete(messages): + print(messages) + reactor.stop() + +pubnub.here_now( { + 'channel' : crazy, + 'callback' : here_now_complete +}) + +## ----------------------------------------------------------------------- +## IO Event Loop +## ----------------------------------------------------------------------- +reactor.run() diff --git a/python-twisted/examples/history-example.py b/python-twisted/examples/history-example.py index 31b8edb..5f352ef 100644 --- a/python-twisted/examples/history-example.py +++ b/python-twisted/examples/history-example.py @@ -31,6 +31,7 @@ crazy = 'hello_world' ## ----------------------------------------------------------------------- def history_complete(messages): print(messages) + reactor.stop() pubnub.history( { 'channel' : crazy, diff --git a/python-twisted/examples/publish-example.py b/python-twisted/examples/publish-example.py index 4a5baf6..d09ad8d 100644 --- a/python-twisted/examples/publish-example.py +++ b/python-twisted/examples/publish-example.py @@ -12,6 +12,7 @@ import sys from twisted.internet import reactor sys.path.append('../') +sys.path.append('../../') from Pubnub import Pubnub publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' @@ -47,11 +48,14 @@ pubnub.publish({ 'callback' : publish_complete }) +def done_cb(info): + publish_complete(info) + reactor.stop() ## Publish Dictionary Object pubnub.publish({ 'channel' : crazy, 'message' : { 'some_key' : 'some_val' }, - 'callback' : publish_complete + 'callback' : done_cb }) ## ----------------------------------------------------------------------- diff --git a/python-twisted/examples/subscribe-example.py b/python-twisted/examples/subscribe-example.py index 994e7e3..cf4a919 100644 --- a/python-twisted/examples/subscribe-example.py +++ b/python-twisted/examples/subscribe-example.py @@ -23,7 +23,8 @@ ssl_on = len(sys.argv) > 5 and bool(sys.argv[5]) or False ## ----------------------------------------------------------------------- ## Initiate Pubnub State ## ----------------------------------------------------------------------- -pubnub = Pubnub( publish_key, subscribe_key, secret_key, cipher_key, ssl_on ) +#pubnub = Pubnub( publish_key, subscribe_key, secret_key, cipher_key, ssl_on ) +pubnub = Pubnub( publish_key, subscribe_key, secret_key, ssl_on ) crazy = 'hello_world' ## ----------------------------------------------------------------------- @@ -33,10 +34,7 @@ def message_received(message): print(message) def connected() : - pubnub.publish({ - 'channel' : crazy, - 'message' : { 'Info' : 'Connected!' } - }) + print 'Connected' pubnub.subscribe({ 'channel' : crazy, diff --git a/python-twisted/tests/unit-test-full.py b/python-twisted/tests/unit-test-full.py index f593d11..c5940af 100644 --- a/python-twisted/tests/unit-test-full.py +++ b/python-twisted/tests/unit-test-full.py @@ -19,6 +19,8 @@ import sys sys.path.append('../') +sys.path.append('./') +sys.path.append('../common/') from Pubnub import Pubnub publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' diff --git a/python-twisted/tests/unit-test.py b/python-twisted/tests/unit-test.py deleted file mode 100644 index 843f939..0000000 --- a/python-twisted/tests/unit-test.py +++ /dev/null @@ -1,107 +0,0 @@ -## www.pubnub.com - PubNub Real-time push service in the cloud. -# coding=utf8 - -## PubNub Real-time Push APIs and Notifications Framework -## Copyright (c) 2010 Stephen Blum -## http://www.pubnub.com/ - -## ----------------------------------- -## PubNub 3.1 Real-time Push Cloud API -## ----------------------------------- - -import sys -sys.path.append('../') -from Pubnub import Pubnub - -publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' -subscribe_key = len(sys.argv) > 2 and sys.argv[2] or 'demo' -secret_key = len(sys.argv) > 3 and sys.argv[3] or 'demo' -cipher_key = len(sys.argv) > 4 and sys.argv[4] or '' ##(Cipher key is Optional) -ssl_on = len(sys.argv) > 5 and bool(sys.argv[5]) or False - -## ----------------------------------------------------------------------- -## Initiat Class -## ----------------------------------------------------------------------- -pubnub = Pubnub( publish_key, subscribe_key, secret_key, cipher_key, ssl_on ) -crazy = ' ~`!@#$%^&*( 顶顅 Ȓ)+=[]\\{}|;\':",./<>?abcd' - -## --------------------------------------------------------------------------- -## Unit Test Function -## --------------------------------------------------------------------------- -def test( trial, name ) : - if trial : - print( 'PASS: ' + name ) - else : - print( 'FAIL: ' + name ) - -## ----------------------------------------------------------------------- -## Time Example -## ----------------------------------------------------------------------- -def time_complete(timestamp): - print(timestamp) - -pubnub.time({ 'callback' : time_complete }) - -## ----------------------------------------------------------------------- -## History Example -## ----------------------------------------------------------------------- -def history_complete(messages): - print(messages) - -pubnub.history( { - 'channel' : crazy, - 'limit' : 10, - 'callback' : history_complete -}) - -## ----------------------------------------------------------------------- -## Publish Example -## ----------------------------------------------------------------------- -def publish_complete(info): - print(info) - -pubnub.publish({ - 'channel' : crazy, - 'message' : {'one': 'Hello World! --> ɂ顶@#$%^&*()!', 'two': 'hello2'}, - 'callback' : publish_complete -}) - -## ----------------------------------------------------------------------- -## Subscribe Example -## ----------------------------------------------------------------------- -def message_received(message): - print(message) - print('Disconnecting...') - pubnub.unsubscribe({ 'channel' : crazy }) - - def done() : - print('final connection, done :)') - pubnub.unsubscribe({ 'channel' : crazy }) - pubnub.stop() - - def dumpster(message) : - print('never see this') - print(message) - - print('reconnecting...') - pubnub.subscribe({ - 'channel' : crazy, - 'connect' : done, - 'callback' : dumpster - }) - -def connected() : - pubnub.publish({ - 'channel' : crazy, - 'message' : { 'Info' : 'Connected!' } - }) - -pubnub.subscribe({ - 'channel' : crazy, - 'connect' : connected, - 'callback' : message_received -}) -## ----------------------------------------------------------------------- -## IO Event Loop -## ----------------------------------------------------------------------- -pubnub.start() diff --git a/python-twisted/tests/unit-tests.py b/python-twisted/tests/unit-tests.py new file mode 100644 index 0000000..f143a3a --- /dev/null +++ b/python-twisted/tests/unit-tests.py @@ -0,0 +1,107 @@ + +import sys +import time + +sys.path.append('../../common') +sys.path.append('../common') +sys.path.append('..') +sys.path.append('.') + +from PubnubUnitTest import Suite +from Pubnub import Pubnub + +pubnub = Pubnub("demo","demo") + +tests_count = 1 + 2 + 1 +test_suite = Suite(pubnub,tests_count) + +tests = [] + + + +def test_publish(): + channel = "hello" + str(time.time()) + name = "Publish Test" + def success(r): + test_suite.test(r[0] == 1, name) + + def fail(e): + test_suite.test(False, msg , e) + + + pubnub.publish({ + 'channel' : 'hello', + 'message' : 'hi', + 'callback' : success, + 'error' : fail + }) +tests.append(test_publish) + +#""" +def test_subscribe_publish(): + channel = "hello" + str(time.time()) + name = "Subscribe Publish Test" + publish_msg = "This is Pubnub Python-Twisted" + def connect(): + #print 'connect' + def success(r): + test_suite.test(r[0] == 1, name, "publish success") + + def fail(e): + test_suite.test(False, name , "Publish Failed", e) + + pubnub.publish({ + 'channel' : channel, + 'message' : publish_msg, + 'callback' : success, + 'error' : fail + }) + + def callback(r): + test_suite.test(r == publish_msg, name, "message received") + + pubnub.subscribe({ + 'channel' : channel, + 'callback' : callback, + 'connect' : connect + }) +tests.append(test_subscribe_publish) +#""" + +def test_here_now(): + channel = "hello12" #+ str(time.time()) + name = "Here Now Test" + + def connect(): + print 'connect' + def call_here_now(): + print 'call_here_now' + def success(r): + test_suite.test(r['occupancy'] == 1, name, "Here Now success") + + def fail(e): + test_suite.test(False, name , "Here Now Failed", e) + + pubnub.here_now({ + 'channel' : channel, + 'callback' : success, + 'error' : fail + }) + pubnub.timeout(5, call_here_now) + + def callback(r): + pass + print 'Subscribe' + pubnub.subscribe({ + 'channel' : channel, + 'callback' : callback, + 'connect' : connect + }) +tests.append(test_here_now) + + + + +for t in tests: t() + +pubnub.start() diff --git a/python-twisted/unassembled/Platform.py b/python-twisted/unassembled/Platform.py new file mode 100644 index 0000000..e4ae680 --- /dev/null +++ b/python-twisted/unassembled/Platform.py @@ -0,0 +1,83 @@ +from twisted.web.client import getPage +from twisted.internet import reactor +from twisted.internet.defer import Deferred +from twisted.internet.protocol import Protocol +from twisted.web.client import Agent, ContentDecoderAgent, RedirectAgent, GzipDecoder +from twisted.web.client import HTTPConnectionPool +from twisted.web.http_headers import Headers +from twisted.internet.ssl import ClientContextFactory +from twisted.internet.task import LoopingCall + +pnconn_pool = HTTPConnectionPool(reactor, persistent=True) +pnconn_pool.maxPersistentPerHost = 100 +pnconn_pool.cachedConnectionTimeout = 310 + +class Pubnub(PubnubCoreAsync): + + def start(self): reactor.run() + def stop(self): reactor.stop() + def timeout( self, delay, callback ): + reactor.callLater( delay, callback ) + + def __init__( + self, + publish_key, + subscribe_key, + secret_key = False, + cipher_key = False, + ssl_on = False, + origin = 'pubsub.pubnub.com' + ) : + super(Pubnub, self).__init__( + publish_key=publish_key, + subscribe_key=subscribe_key, + secret_key=secret_key, + ssl_on=ssl_on, + origin=origin, + ) + self.headers = {} + self.headers['User-Agent'] = ['Python-Twisted'] + #self.headers['Accept-Encoding'] = [self.accept_encoding] + self.headers['V'] = [self.version] + + def _request( self, request, callback ) : + global pnconn_pool + + ## Build URL + ''' + url = self.origin + '/' + "/".join([ + "".join([ ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.find(ch) > -1 and + hex(ord(ch)).replace( '0x', '%' ).upper() or + ch for ch in list(bit) + ]) for bit in request]) + ''' + url = self.getUrl(request) + agent = ContentDecoderAgent(RedirectAgent(Agent( + reactor, + contextFactory = WebClientContextFactory(), + pool = self.ssl and None or pnconn_pool + )), [('gzip', GzipDecoder)]) + request = agent.request( 'GET', url, Headers(self.headers), None ) + + def received(response): + finished = Deferred() + response.deliverBody(PubNubResponse(finished)) + return finished + + def complete(data): + callback(eval(data)) + + request.addCallback(received) + request.addBoth(complete) + +class WebClientContextFactory(ClientContextFactory): + def getContext(self, hostname, port): + return ClientContextFactory.getContext(self) + +class PubNubResponse(Protocol): + def __init__( self, finished ): + self.finished = finished + + def dataReceived( self, bytes ): + self.finished.callback(bytes) + diff --git a/python/3.2/Pubnub.py b/python/3.2/Pubnub.py deleted file mode 100644 index 79086cf..0000000 --- a/python/3.2/Pubnub.py +++ /dev/null @@ -1,345 +0,0 @@ -## www.pubnub.com - PubNub Real-time push service in the cloud. -# coding=utf8 - -## PubNub Real-time Push APIs and Notifications Framework -## Copyright (c) 2010 Stephen Blum -## http://www.pubnub.com/ - -## ----------------------------------- -## PubNub 3.0 Real-time Push Cloud API -## ----------------------------------- - -try: import json -except ImportError: import simplejson as json - -import time -import hashlib -import urllib2 -import uuid - -class Pubnub(): - def __init__( - self, - publish_key, - subscribe_key, - secret_key = False, - ssl_on = False, - origin = 'pubsub.pubnub.com', - pres_uuid = None - ) : - """ - #** - #* Pubnub - #* - #* Init the Pubnub Client API - #* - #* @param string publish_key required key to send messages. - #* @param string subscribe_key required key to receive messages. - #* @param string secret_key optional key to sign messages. - #* @param boolean ssl required for 2048 bit encrypted messages. - #* @param string origin PUBNUB Server Origin. - #* @param string pres_uuid optional identifier for presence (auto-generated if not supplied) - #** - - ## Initiat Class - pubnub = Pubnub( 'PUBLISH-KEY', 'SUBSCRIBE-KEY', 'SECRET-KEY', False ) - - """ - self.origin = origin - self.limit = 1800 - self.publish_key = publish_key - self.subscribe_key = subscribe_key - self.secret_key = secret_key - self.ssl = ssl_on - - if self.ssl : - self.origin = 'https://' + self.origin - else : - self.origin = 'http://' + self.origin - - self.uuid = pres_uuid or str(uuid.uuid4()) - - if not isinstance(self.uuid, basestring): - raise AttributeError("pres_uuid must be a string") - - def publish( self, args ) : - """ - #** - #* Publish - #* - #* Send a message to a channel. - #* - #* @param array args with channel and message. - #* @return array success information. - #** - - ## Publish Example - info = pubnub.publish({ - 'channel' : 'hello_world', - 'message' : { - 'some_text' : 'Hello my World' - } - }) - print(info) - - """ - ## Fail if bad input. - if not (args['channel'] and args['message']) : - return [ 0, 'Missing Channel or Message' ] - - ## Capture User Input - channel = str(args['channel']) - message = json.dumps(args['message'], separators=(',',':')) - - ## Sign Message - if self.secret_key : - signature = hashlib.md5('/'.join([ - self.publish_key, - self.subscribe_key, - self.secret_key, - channel, - message - ])).hexdigest() - else : - signature = '0' - - ## Send Message - return self._request([ - 'publish', - self.publish_key, - self.subscribe_key, - signature, - channel, - '0', - message - ]) - - - def subscribe( self, args ) : - """ - #** - #* Subscribe - #* - #* This is BLOCKING. - #* Listen for a message on a channel. - #* - #* @param array args with channel and callback. - #* @return false on fail, array on success. - #** - - ## Subscribe Example - def receive(message) : - print(message) - return True - - pubnub.subscribe({ - 'channel' : 'hello_world', - 'callback' : receive - }) - - """ - - ## Fail if missing channel - if not 'channel' in args : - raise Exception('Missing Channel.') - return False - - ## Fail if missing callback - if not 'callback' in args : - raise Exception('Missing Callback.') - return False - - ## Capture User Input - channel = str(args['channel']) - callback = args['callback'] - subscribe_key = args.get('subscribe_key') or self.subscribe_key - - ## Begin Subscribe - while True : - - timetoken = 'timetoken' in args and args['timetoken'] or 0 - try : - ## Wait for Message - response = self._request(self._encode([ - 'subscribe', - subscribe_key, - channel, - '0', - str(timetoken) - ])+['?uuid='+self.uuid], encode=False) - - messages = response[0] - args['timetoken'] = response[1] - - ## If it was a timeout - if not len(messages) : - continue - - ## Run user Callback and Reconnect if user permits. - for message in messages : - if not callback(message) : - return - - except Exception: - time.sleep(1) - - return True - - def presence( self, args ) : - """ - #** - #* presence - #* - #* This is BLOCKING. - #* Listen for presence events on a channel. - #* - #* @param array args with channel and callback. - #* @return false on fail, array on success. - #** - - ## Presence Example - def pres_event(message) : - print(message) - return True - - pubnub.presence({ - 'channel' : 'hello_world', - 'callback' : receive - }) - """ - - ## Fail if missing channel - if not 'channel' in args : - raise Exception('Missing Channel.') - return False - - ## Fail if missing callback - if not 'callback' in args : - raise Exception('Missing Callback.') - return False - - ## Capture User Input - channel = str(args['channel']) - callback = args['callback'] - subscribe_key = args.get('subscribe_key') or self.subscribe_key - - return self.subscribe({'channel': channel+'-pnpres', 'subscribe_key':subscribe_key, 'callback': callback}) - - - def here_now( self, args ) : - """ - #** - #* Here Now - #* - #* Load current occupancy from a channel. - #* - #* @param array args with 'channel'. - #* @return mixed false on fail, array on success. - #* - - ## Presence Example - here_now = pubnub.here_now({ - 'channel' : 'hello_world', - }) - print(here_now['occupancy']) - print(here_now['uuids']) - - """ - channel = str(args['channel']) - - ## Fail if bad input. - if not channel : - raise Exception('Missing Channel') - return False - - ## Get Presence Here Now - return self._request([ - 'v2','presence', - 'sub_key', self.subscribe_key, - 'channel', channel - ]); - - - def history( self, args ) : - """ - #** - #* History - #* - #* Load history from a channel. - #* - #* @param array args with 'channel' and 'limit'. - #* @return mixed false on fail, array on success. - #* - - ## History Example - history = pubnub.history({ - 'channel' : 'hello_world', - 'limit' : 1 - }) - print(history) - - """ - ## Capture User Input - limit = args.has_key('limit') and int(args['limit']) or 10 - channel = str(args['channel']) - - ## Fail if bad input. - if not channel : - raise Exception('Missing Channel') - return False - - ## Get History - return self._request([ - 'history', - self.subscribe_key, - channel, - '0', - str(limit) - ]); - - - def time(self) : - """ - #** - #* Time - #* - #* Timestamp from PubNub Cloud. - #* - #* @return int timestamp. - #* - - ## PubNub Server Time Example - timestamp = pubnub.time() - print(timestamp) - - """ - return self._request([ - 'time', - '0' - ])[0] - - - def _encode( self, request ) : - return [ - "".join([ ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.find(ch) > -1 and - hex(ord(ch)).replace( '0x', '%' ).upper() or - ch for ch in list(bit) - ]) for bit in request] - - - def _request( self, request, origin = None, encode = True ) : - ## Build URL - url = (origin or self.origin) + '/' + "/".join( - encode and self._encode(request) or request - ) - - ## Send Request Expecting JSONP Response - try: - try: usock = urllib2.urlopen( url, None, 200 ) - except TypeError: usock = urllib2.urlopen( url, None ) - response = usock.read() - usock.close() - return json.loads( response ) - except: - return None - diff --git a/python/3.2/unit-test.py b/python/3.2/unit-test.py deleted file mode 100755 index 88391a0..0000000 --- a/python/3.2/unit-test.py +++ /dev/null @@ -1,77 +0,0 @@ -## www.pubnub.com - PubNub Real-time push service in the cloud. -# coding=utf8 - -## PubNub Real-time Push APIs and Notifications Framework -## Copyright (c) 2010 Stephen Blum -## http://www.pubnub.com/ - -## ----------------------------------- -## PubNub 3.0 Real-time Push Cloud API -## ----------------------------------- - -from Pubnub import Pubnub -import sys - -publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' -subscribe_key = len(sys.argv) > 2 and sys.argv[2] or 'demo' -secret_key = len(sys.argv) > 3 and sys.argv[3] or None -ssl_on = len(sys.argv) > 4 and bool(sys.argv[4]) or False - - -## ----------------------------------------------------------------------- -## Initiat Class -## ----------------------------------------------------------------------- - -pubnub = Pubnub( publish_key, subscribe_key, secret_key, ssl_on ) -crazy = ' ~`!@#$%^&*(顶顅Ȓ)+=[]\\{}|;\':",./<>?abcd' - -## --------------------------------------------------------------------------- -## Unit Test Function -## --------------------------------------------------------------------------- -def test( trial, name ) : - if trial : - print( 'PASS: ' + name ) - else : - print( 'FAIL: ' + name ) - -## ----------------------------------------------------------------------- -## Publish Example -## ----------------------------------------------------------------------- -pubish_success = pubnub.publish({ - 'channel' : crazy, - 'message' : crazy -}) -test( pubish_success[0] == 1, 'Publish First Message Success' ) - -## ----------------------------------------------------------------------- -## History Example -## ----------------------------------------------------------------------- -history = pubnub.history({ - 'channel' : crazy, - 'limit' : 1 -}) -test( - history[0].encode('utf-8') == crazy, - 'History Message: ' + history[0] -) -test( len(history) == 1, 'History Message Count' ) - -## ----------------------------------------------------------------------- -## PubNub Server Time Example -## ----------------------------------------------------------------------- -timestamp = pubnub.time() -test( timestamp > 0, 'PubNub Server Time: ' + str(timestamp) ) - -## ----------------------------------------------------------------------- -## Subscribe Example -## ----------------------------------------------------------------------- -def receive(message) : - print(message) - return True - -pubnub.subscribe({ - 'channel' : crazy, - 'callback' : receive -}) - - diff --git a/python/3.3/history-example.py b/python/3.3/history-example.py deleted file mode 100755 index cedf69e..0000000 --- a/python/3.3/history-example.py +++ /dev/null @@ -1,12 +0,0 @@ -from Pubnub import Pubnub - -## Initiat Class -pubnub = Pubnub( 'demo', 'demo', None, False ) - -## History Example -history = pubnub.history({ - 'channel' : 'hello_world', - 'limit' : 1 -}) -print(history) - diff --git a/python/3.3/publish-example.py b/python/3.3/publish-example.py deleted file mode 100755 index 725df0b..0000000 --- a/python/3.3/publish-example.py +++ /dev/null @@ -1,14 +0,0 @@ -from Pubnub import Pubnub - -## Initiate Class -pubnub = Pubnub( 'demo', 'demo', None, False ) - -## Publish Example -info = pubnub.publish({ - 'channel' : 'hello_world', - 'message' : { - 'some_text' : 'Hello my World' - } -}) -print(info) - diff --git a/python/3.3/subscribe-example.py b/python/3.3/subscribe-example.py deleted file mode 100755 index e458e2b..0000000 --- a/python/3.3/subscribe-example.py +++ /dev/null @@ -1,64 +0,0 @@ -import sys -import threading -import time -import random -import string -from Pubnub import Pubnub - -## Initiate Class -pubnub = Pubnub( 'demo', 'demo', None, False ) - -print("My UUID is: "+pubnub.uuid) - -channel = ''.join(random.choice(string.ascii_letters + string.digits) for x in range(20)) - -## Subscribe Example -def receive(message) : - print(message) - return False - -def pres_event(message): - print(message) - return False - -def subscribe(): - print("Listening for messages on '%s' channel..." % channel) - pubnub.subscribe({ - 'channel' : channel, - 'callback' : receive - }) - -def presence(): - print("Listening for presence events on '%s' channel..." % channel) - pubnub.presence({ - 'channel' : channel, - 'callback' : pres_event - }) - -def publish(): - print("Publishing a test message on '%s' channel..." % channel) - pubnub.publish({ - 'channel' : channel, - 'message' : { 'text':'foo bar' } - }) - -pres_thread = threading.Thread(target=presence) -pres_thread.daemon=True -pres_thread.start() - -sub_thread = threading.Thread(target=subscribe) -sub_thread.daemon=True -sub_thread.start() - -time.sleep(3) - -publish() - - -print("waiting for subscribes and presence") -pres_thread.join() - -print pubnub.here_now({'channel':channel}) - -sub_thread.join() - diff --git a/python/Makefile b/python/Makefile new file mode 100644 index 0000000..5eb9e2f --- /dev/null +++ b/python/Makefile @@ -0,0 +1,29 @@ +include ../Makefile.inc + + +.PHONY: all +all: build + +.PHONY: build +build: + cat ../common/LICENSE_HEADER > ./Pubnub.py + echo "\n" >> ./Pubnub.py + cat ../common/PubnubCrypto.py >> ./Pubnub.py + echo "\n" >> ./Pubnub.py + cat ../common/PubnubBase.py >> ./Pubnub.py + echo "\n" >> ./Pubnub.py + cat ../common/PubnubCore.py >> ./Pubnub.py + echo "\n" >> ./Pubnub.py + cat ./unassembled/Platform.py >> ./Pubnub.py + find -name "Pubnub*py" | xargs sed -i "s/PubNub\ [0-9]\.[0-9]\.[0-9]/PubNub\ $(VERSION)/g" + + +.PHONY: clean +clean: + rm -f Pubnub.py* + +.PHONY: test +test: + python tests/detailed-history-unit-test.py + python tests/unit-test.py + diff --git a/python/Pubnub.py b/python/Pubnub.py new file mode 100644 index 0000000..b1d1777 --- /dev/null +++ b/python/Pubnub.py @@ -0,0 +1,646 @@ +## www.pubnub.com - PubNub Real-time push service in the cloud. +# coding=utf8 + +## PubNub Real-time Push APIs and Notifications Framework +## Copyright (c) 2010 Stephen Blum +## http://www.pubnub.com/ + +## ----------------------------------- +## PubNub 3.3.4 Real-time Push Cloud API +## ----------------------------------- + + +from Crypto.Cipher import AES +from Crypto.Hash import MD5 +from base64 import encodestring, decodestring +import hashlib +import hmac + +class PubnubCrypto() : + """ + #** + #* PubnubCrypto + #* + #** + + ## Initiate Class + pc = PubnubCrypto + + """ + + def pad( self, msg, block_size=16 ): + """ + #** + #* pad + #* + #* pad the text to be encrypted + #* appends a padding character to the end of the String + #* until the string has block_size length + #* @return msg with padding. + #** + """ + padding = block_size - (len(msg) % block_size) + return msg + chr(padding)*padding + + def depad( self, msg ): + """ + #** + #* depad + #* + #* depad the decryptet message" + #* @return msg without padding. + #** + """ + return msg[0:-ord(msg[-1])] + + def getSecret( self, key ): + """ + #** + #* getSecret + #* + #* hases the key to MD5 + #* @return key in MD5 format + #** + """ + return hashlib.sha256(key).hexdigest() + + def encrypt( self, key, msg ): + """ + #** + #* encrypt + #* + #* encrypts the message + #* @return message in encrypted format + #** + """ + secret = self.getSecret(key) + Initial16bytes='0123456789012345' + cipher = AES.new(secret[0:32],AES.MODE_CBC,Initial16bytes) + enc = encodestring(cipher.encrypt(self.pad(msg))) + return enc + def decrypt( self, key, msg ): + """ + #** + #* decrypt + #* + #* decrypts the message + #* @return message in decryped format + #** + """ + secret = self.getSecret(key) + Initial16bytes='0123456789012345' + cipher = AES.new(secret[0:32],AES.MODE_CBC,Initial16bytes) + return self.depad((cipher.decrypt(decodestring(msg)))) + + +try: import json +except ImportError: import simplejson as json + +import time +import hashlib +import urllib2 +import uuid + +class PubnubBase(object): + def __init__( + self, + publish_key, + subscribe_key, + secret_key = False, + cipher_key = False, + ssl_on = False, + origin = 'pubsub.pubnub.com', + UUID = None + ) : + """ + #** + #* Pubnub + #* + #* Init the Pubnub Client API + #* + #* @param string publish_key required key to send messages. + #* @param string subscribe_key required key to receive messages. + #* @param string secret_key optional key to sign messages. + #* @param boolean ssl required for 2048 bit encrypted messages. + #* @param string origin PUBNUB Server Origin. + #* @param string pres_uuid optional identifier for presence (auto-generated if not supplied) + #** + + ## Initiat Class + pubnub = Pubnub( 'PUBLISH-KEY', 'SUBSCRIBE-KEY', 'SECRET-KEY', False ) + + """ + self.origin = origin + self.limit = 1800 + self.publish_key = publish_key + self.subscribe_key = subscribe_key + self.secret_key = secret_key + self.cipher_key = cipher_key + self.ssl = ssl_on + + if self.ssl : + self.origin = 'https://' + self.origin + else : + self.origin = 'http://' + self.origin + + self.uuid = UUID or str(uuid.uuid4()) + + if not isinstance(self.uuid, basestring): + raise AttributeError("pres_uuid must be a string") + + def sign(self, channel, message): + ## Sign Message + if self.secret_key: + signature = hashlib.md5('/'.join([ + self.publish_key, + self.subscribe_key, + self.secret_key, + channel, + message + ])).hexdigest() + else: + signature = '0' + return signature + + def encrypt(self, message): + if self.cipher_key: + pc = PubnubCrypto() + out = [] + if type( message ) == type(list()): + for item in message: + encryptItem = pc.encrypt(self.cipher_key, item ).rstrip() + out.append(encryptItem) + message = json.dumps(out) + elif type( message ) == type(dict()): + outdict = {} + for k, item in message.iteritems(): + encryptItem = pc.encrypt(self.cipher_key, item ).rstrip() + outdict[k] = encryptItem + out.append(outdict) + message = json.dumps(out[0]) + else: + message = json.dumps(pc.encrypt(self.cipher_key, json.dumps(message)).replace('\n','')) + else : + message = json.dumps(message) + + return message; + + def decrypt(self, message): + if self.cipher_key: + pc = PubnubCrypto() + if type( message ) == type(list()): + for item in message: + encryptItem = pc.decrypt(self.cipher_key, item ) + out.append(encryptItem) + message = out + elif type( message ) == type(dict()): + outdict = {} + for k, item in message.iteritems(): + encryptItem = pc.decrypt(self.cipher_key, item ) + outdict[k] = encryptItem + out.append(outdict) + message = out[0] + else: + message = pc.decrypt(self.cipher_key, message) + + return message + + + def publish( self, args ) : + """ + #** + #* Publish + #* + #* Send a message to a channel. + #* + #* @param array args with channel and message. + #* @return array success information. + #** + + ## Publish Example + info = pubnub.publish({ + 'channel' : 'hello_world', + 'message' : { + 'some_text' : 'Hello my World' + } + }) + print(info) + + """ + ## Fail if bad input. + if not (args['channel'] and args['message']) : + return [ 0, 'Missing Channel or Message' ] + + ## Capture User Input + channel = str(args['channel']) + + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] + else : + callback = None + + #message = json.dumps(args['message'], separators=(',',':')) + message = self.encrypt(args['message']) + + signature = self.sign(channel, message) + + ## Send Message + return self._request({"urlcomponents": [ + 'publish', + self.publish_key, + self.subscribe_key, + signature, + channel, + '0', + message + ]}, callback) + + def presence( self, args ) : + """ + #** + #* presence + #* + #* This is BLOCKING. + #* Listen for presence events on a channel. + #* + #* @param array args with channel and callback. + #* @return false on fail, array on success. + #** + + ## Presence Example + def pres_event(message) : + print(message) + return True + + pubnub.presence({ + 'channel' : 'hello_world', + 'callback' : receive + }) + """ + + ## Fail if missing channel + if not 'channel' in args : + raise Exception('Missing Channel.') + return False + + ## Fail if missing callback + if not 'callback' in args : + raise Exception('Missing Callback.') + return False + + ## Capture User Input + channel = str(args['channel']) + callback = args['callback'] + subscribe_key = args.get('subscribe_key') or self.subscribe_key + + return self.subscribe({'channel': channel+'-pnpres', 'subscribe_key':subscribe_key, 'callback': callback}) + + + def here_now( self, args ) : + """ + #** + #* Here Now + #* + #* Load current occupancy from a channel. + #* + #* @param array args with 'channel'. + #* @return mixed false on fail, array on success. + #* + + ## Presence Example + here_now = pubnub.here_now({ + 'channel' : 'hello_world', + }) + print(here_now['occupancy']) + print(here_now['uuids']) + + """ + channel = str(args['channel']) + + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] + else : + callback = None + + ## Fail if bad input. + if not channel : + raise Exception('Missing Channel') + return False + + ## Get Presence Here Now + return self._request({"urlcomponents": [ + 'v2','presence', + 'sub_key', self.subscribe_key, + 'channel', channel + ]}, callback); + + + def history( self, args ) : + """ + #** + #* History + #* + #* Load history from a channel. + #* + #* @param array args with 'channel' and 'limit'. + #* @return mixed false on fail, array on success. + #* + + ## History Example + history = pubnub.history({ + 'channel' : 'hello_world', + 'limit' : 1 + }) + print(history) + + """ + ## Capture User Input + limit = args.has_key('limit') and int(args['limit']) or 10 + channel = str(args['channel']) + + ## Fail if bad input. + if not channel : + raise Exception('Missing Channel') + return False + + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] + else : + callback = None + + ## Get History + return self._request({ "urlcomponents" : [ + 'history', + self.subscribe_key, + channel, + '0', + str(limit) + ] }, callback); + + def detailedHistory(self, args) : + """ + #** + #* Detailed History + #* + #* Load Detailed history from a channel. + #* + #* @param array args with 'channel', optional: 'start', 'end', 'reverse', 'count' + #* @return mixed false on fail, array on success. + #* + + ## History Example + history = pubnub.detailedHistory({ + 'channel' : 'hello_world', + 'count' : 5 + }) + print(history) + + """ + ## Capture User Input + channel = str(args['channel']) + + params = dict() + count = 100 + + if args.has_key('count'): + count = int(args['count']) + + params['count'] = str(count) + + if args.has_key('reverse'): + params['reverse'] = str(args['reverse']).lower() + + if args.has_key('start'): + params['start'] = str(args['start']) + + if args.has_key('end'): + params['end'] = str(args['end']) + + ## Fail if bad input. + if not channel : + raise Exception('Missing Channel') + return False + + ## Capture Callback + if args.has_key('callback') : + callback = args['callback'] + else : + callback = None + + ## Get History + return self._request({ 'urlcomponents' : [ + 'v2', + 'history', + 'sub-key', + self.subscribe_key, + 'channel', + channel, + ],'urlparams' : params }, callback=callback); + + def time(self, args = None) : + """ + #** + #* Time + #* + #* Timestamp from PubNub Cloud. + #* + #* @return int timestamp. + #* + + ## PubNub Server Time Example + timestamp = pubnub.time() + print(timestamp) + + """ + ## Capture Callback + if args and args.has_key('callback') : + callback = args['callback'] + else : + callback = None + time = self._request({'urlcomponents' : [ + 'time', + '0' + ]}, callback) + if time != None: + return time[0] + + + def _encode( self, request ) : + return [ + "".join([ ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.find(ch) > -1 and + hex(ord(ch)).replace( '0x', '%' ).upper() or + ch for ch in list(bit) + ]) for bit in request] + + def getUrl(self,request): + ## Build URL + url = self.origin + '/' + "/".join([ + "".join([ ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.find(ch) > -1 and + hex(ord(ch)).replace( '0x', '%' ).upper() or + ch for ch in list(bit) + ]) for bit in request["urlcomponents"]]) + if (request.has_key("urlparams")): + url = url + '?' + "&".join([ x + "=" + y for x,y in request["urlparams"].iteritems()]) + return url + + +class PubnubCore(PubnubBase): + def __init__( + self, + publish_key, + subscribe_key, + secret_key = False, + cipher_key = False, + ssl_on = False, + origin = 'pubsub.pubnub.com', + uuid = None + ) : + """ + #** + #* Pubnub + #* + #* Init the Pubnub Client API + #* + #* @param string publish_key required key to send messages. + #* @param string subscribe_key required key to receive messages. + #* @param string secret_key optional key to sign messages. + #* @param boolean ssl required for 2048 bit encrypted messages. + #* @param string origin PUBNUB Server Origin. + #* @param string pres_uuid optional identifier for presence (auto-generated if not supplied) + #** + + ## Initiat Class + pubnub = Pubnub( 'PUBLISH-KEY', 'SUBSCRIBE-KEY', 'SECRET-KEY', False ) + + """ + super(PubnubCore, self).__init__( + publish_key=publish_key, + subscribe_key=subscribe_key, + secret_key=secret_key, + cipher_key=cipher_key, + ssl_on=ssl_on, + origin=origin, + UUID=uuid + ) + + self.subscriptions = {} + self.timetoken = 0 + self.version = '3.4' + self.accept_encoding = 'gzip' + + + + def subscribe( self, args ) : + """ + #** + #* Subscribe + #* + #* This is BLOCKING. + #* Listen for a message on a channel. + #* + #* @param array args with channel and callback. + #* @return false on fail, array on success. + #** + + ## Subscribe Example + def receive(message) : + print(message) + return True + + pubnub.subscribe({ + 'channel' : 'hello_world', + 'callback' : receive + }) + + """ + + ## Fail if missing channel + if not 'channel' in args : + raise Exception('Missing Channel.') + return False + + ## Fail if missing callback + if not 'callback' in args : + raise Exception('Missing Callback.') + return False + + ## Capture User Input + channel = str(args['channel']) + callback = args['callback'] + subscribe_key = args.get('subscribe_key') or self.subscribe_key + + ## Begin Subscribe + while True : + + timetoken = 'timetoken' in args and args['timetoken'] or 0 + try : + ## Wait for Message + response = self._request(self._encode([ + 'subscribe', + subscribe_key, + channel, + '0', + str(timetoken) + ])+['?uuid='+self.uuid], encode=False) + + messages = response[0] + args['timetoken'] = response[1] + + ## If it was a timeout + if not len(messages) : + continue + + ## Run user Callback and Reconnect if user permits. + for message in messages : + if not callback(message) : + return + + except Exception: + time.sleep(1) + + return True + + + +class Pubnub(PubnubCore): + def __init__( + self, + publish_key, + subscribe_key, + secret_key = False, + cipher_key = False, + ssl_on = False, + origin = 'pubsub.pubnub.com', + pres_uuid = None + ) : + super(Pubnub, self).__init__( + publish_key = publish_key, + subscribe_key = subscribe_key, + secret_key = secret_key, + cipher_key = cipher_key, + ssl_on = ssl_on, + origin = origin, + uuid = pres_uuid + ) + + def _request( self, request, callback = None ) : + ## Build URL + url = self.getUrl(request) + + ## Send Request Expecting JSONP Response + try: + try: usock = urllib2.urlopen( url, None, 310 ) + except TypeError: usock = urllib2.urlopen( url, None ) + response = usock.read() + usock.close() + resp_json = json.loads(response) + except: + return None + + if (callback): + callback(resp_json) + else: + return resp_json diff --git a/python/examples/here-now-example.py b/python/examples/here-now-example.py new file mode 100644 index 0000000..d2ca9bd --- /dev/null +++ b/python/examples/here-now-example.py @@ -0,0 +1,37 @@ +## www.pubnub.com - PubNub Real-time push service in the cloud. +# coding=utf8 + +## PubNub Real-time Push APIs and Notifications Framework +## Copyright (c) 2010 Stephen Blum +## http://www.pubnub.com/ + +## ----------------------------------- +## PubNub 3.1 Real-time Push Cloud API +## ----------------------------------- + +import sys +sys.path.append('../') +from twisted.internet import reactor +from Pubnub import Pubnub + +publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' +subscribe_key = len(sys.argv) > 2 and sys.argv[2] or 'demo' +secret_key = len(sys.argv) > 3 and sys.argv[3] or 'demo' +cipher_key = len(sys.argv) > 4 and sys.argv[4] or '' +ssl_on = len(sys.argv) > 5 and bool(sys.argv[5]) or False + +## ----------------------------------------------------------------------- +## Initiate Pubnub State +## ----------------------------------------------------------------------- +pubnub = Pubnub( publish_key=publish_key, subscribe_key=subscribe_key, + secret_key=secret_key, cipher_key=cipher_key, ssl_on=ssl_on) +crazy = 'hello_world' + +def print_cb(message): + print message + +pubnub.here_now( { + 'channel' : crazy, + 'callback' : print_cb +}) + diff --git a/python/3.2/history-example.py b/python/examples/history-example.py index cedf69e..c7c9547 100755 --- a/python/3.2/history-example.py +++ b/python/examples/history-example.py @@ -1,3 +1,5 @@ +import sys +sys.path.append('../') from Pubnub import Pubnub ## Initiat Class diff --git a/python/3.2/publish-example.py b/python/examples/publish-example.py index 725df0b..c97034b 100755 --- a/python/3.2/publish-example.py +++ b/python/examples/publish-example.py @@ -1,7 +1,7 @@ from Pubnub import Pubnub ## Initiate Class -pubnub = Pubnub( 'demo', 'demo', None, False ) +pubnub = Pubnub( publish_key='demo', subscribe_key='demo', ssl_on=False ) ## Publish Example info = pubnub.publish({ diff --git a/python/3.2/subscribe-example.py b/python/examples/subscribe-example.py index e458e2b..e458e2b 100755 --- a/python/3.2/subscribe-example.py +++ b/python/examples/subscribe-example.py diff --git a/python/3.3/detailed-history-unit-test.py b/python/tests/detailed-history-unit-test.py index 2169e52..31bdef8 100755 --- a/python/3.3/detailed-history-unit-test.py +++ b/python/tests/detailed-history-unit-test.py @@ -9,9 +9,12 @@ ## PubNub 3.0 Real-time Push Cloud API ## ----------------------------------- +import sys +sys.path.append('.') +sys.path.append('..') +sys.path.append('../common') from Pubnub import Pubnub import unittest2 as unittest -import sys publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' diff --git a/python/3.3/unit-test.py b/python/tests/unit-test.py index 88391a0..1737ace 100755 --- a/python/3.3/unit-test.py +++ b/python/tests/unit-test.py @@ -9,8 +9,11 @@ ## PubNub 3.0 Real-time Push Cloud API ## ----------------------------------- -from Pubnub import Pubnub import sys +sys.path.append('.') +sys.path.append('..') +sys.path.append('../common') +from Pubnub import Pubnub publish_key = len(sys.argv) > 1 and sys.argv[1] or 'demo' subscribe_key = len(sys.argv) > 2 and sys.argv[2] or 'demo' @@ -23,7 +26,7 @@ ssl_on = len(sys.argv) > 4 and bool(sys.argv[4]) or False ## ----------------------------------------------------------------------- pubnub = Pubnub( publish_key, subscribe_key, secret_key, ssl_on ) -crazy = ' ~`!@#$%^&*(顶顅Ȓ)+=[]\\{}|;\':",./<>?abcd' +crazy = 'demo' ## --------------------------------------------------------------------------- ## Unit Test Function @@ -37,11 +40,11 @@ def test( trial, name ) : ## ----------------------------------------------------------------------- ## Publish Example ## ----------------------------------------------------------------------- -pubish_success = pubnub.publish({ +publish_success = pubnub.publish({ 'channel' : crazy, 'message' : crazy }) -test( pubish_success[0] == 1, 'Publish First Message Success' ) +test( publish_success[0] == 1, 'Publish First Message Success' ) ## ----------------------------------------------------------------------- ## History Example @@ -61,17 +64,3 @@ test( len(history) == 1, 'History Message Count' ) ## ----------------------------------------------------------------------- timestamp = pubnub.time() test( timestamp > 0, 'PubNub Server Time: ' + str(timestamp) ) - -## ----------------------------------------------------------------------- -## Subscribe Example -## ----------------------------------------------------------------------- -def receive(message) : - print(message) - return True - -pubnub.subscribe({ - 'channel' : crazy, - 'callback' : receive -}) - - diff --git a/python/unassembled/Platform.py b/python/unassembled/Platform.py new file mode 100644 index 0000000..f598a98 --- /dev/null +++ b/python/unassembled/Platform.py @@ -0,0 +1,40 @@ + +class Pubnub(PubnubCore): + def __init__( + self, + publish_key, + subscribe_key, + secret_key = False, + cipher_key = False, + ssl_on = False, + origin = 'pubsub.pubnub.com', + pres_uuid = None + ) : + super(Pubnub, self).__init__( + publish_key = publish_key, + subscribe_key = subscribe_key, + secret_key = secret_key, + cipher_key = cipher_key, + ssl_on = ssl_on, + origin = origin, + uuid = pres_uuid + ) + + def _request( self, request, callback = None ) : + ## Build URL + url = self.getUrl(request) + + ## Send Request Expecting JSONP Response + try: + try: usock = urllib2.urlopen( url, None, 310 ) + except TypeError: usock = urllib2.urlopen( url, None ) + response = usock.read() + usock.close() + resp_json = json.loads(response) + except: + return None + + if (callback): + callback(resp_json) + else: + return resp_json |