aboutsummaryrefslogtreecommitdiffstats
path: root/python/3.3/Pubnub.py
diff options
context:
space:
mode:
Diffstat (limited to 'python/3.3/Pubnub.py')
-rw-r--r--python/3.3/Pubnub.py376
1 files changed, 18 insertions, 358 deletions
diff --git a/python/3.3/Pubnub.py b/python/3.3/Pubnub.py
index a3f4d6f..e2b573f 100644
--- a/python/3.3/Pubnub.py
+++ b/python/3.3/Pubnub.py
@@ -11,13 +11,15 @@
try: import json
except ImportError: import simplejson as json
-
+import sys
+sys.path.append('../..')
import time
import hashlib
import urllib2
import uuid
+from PubnubCore import PubnubCore
-class Pubnub():
+class Pubnub(PubnubCore):
def __init__(
self,
publish_key,
@@ -27,360 +29,16 @@ class Pubnub():
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 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 = []
- count = 100
-
- if args.has_key('count'):
- count = int(args['count'])
-
- params.append('count' + '=' + str(count))
-
- if args.has_key('reverse'):
- params.append('reverse' + '=' + str(args['reverse']).lower())
-
- if args.has_key('start'):
- params.append('start' + '=' + str(args['start']))
-
- if args.has_key('end'):
- params.append('end' + '=' + str(args['end']))
-
- ## Fail if bad input.
- if not channel :
- raise Exception('Missing Channel')
- return False
-
- ## Get History
- return self._request([
- 'v2',
- 'history',
- 'sub-key',
- self.subscribe_key,
- 'channel',
- channel,
- ],params=params);
-
- 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, params = None ) :
+ super(Pubnub, self).__init__(
+ publish_key,
+ subscribe_key,
+ secret_key,
+ ssl_on,
+ origin,
+ pres_uuid
+ )
+
+ def _request( self, request, origin = None, encode = True, params = None, callback = None ) :
## Build URL
url = (origin or self.origin) + '/' + "/".join(
encode and self._encode(request) or request
@@ -395,7 +53,9 @@ class Pubnub():
except TypeError: usock = urllib2.urlopen( url, None )
response = usock.read()
usock.close()
- return json.loads( response )
+ if (callback):
+ callback(json.loads(response))
+ else:
+ return json.loads( response )
except:
return None
-
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-04 13:44:33 +0000