python-ddp

An event driven ddp client

Installation

$ pip install python-ddp

Table of Contents

History
Quick Start
Usage

History

Latest Version 0.1.0

Initial implementation, add ability to call, subscribe and unsubscribe

Quick Start

General Commands

Establish a connection and Close It

from DDPClient import DDPClient

client = DDPClient('ws://127.0.0.1:3000/websocket')
client.connect()
client.close()

Call A Remote Function

from DDPClient import DDPClient

def callback_function(data):
    print data

client = DDPClient('ws://127.0.0.1:3000/websocket')
client.connect()
client.call('someFunction', [1,2,3], callback_function)

Subscribe and Unsubscribe

from DDPClient import DDPClient

def subscription_callback(data):
    print data

client = DDPClient('ws://127.0.0.1:3000/websocket')
client.connect()
sub_id = client.subscribe('posts', subscription_callback)
client.unsubscribe(sub_id)

Connection State Events

Connected

from DDPClient import DDPClient

def connected(self):
    print '* CONNECTED'

client = DDPClient('ws://127.0.0.1:3000/websocket')
client.on('connected', connected)
client.connect()

Socket Closed

from DDPClient import DDPClient

def closed(self, code, reason):
    print '* CONNECTION CLOSED {} {}'.format(code, reason)

client = DDPClient('ws://127.0.0.1:3000/websocket')
client.on('socket_closed', closed)
client.connect()

Subscription Events

Added To Collection

from DDPClient import DDPClient

def added(collection, id, fields):
    print '* ADDED {} {}'.format(collection, id)
    for key, value in fields.items():
        print '  - FIELD {} {}'.format(key, value)

client = DDPClient('ws://127.0.0.1:3000/websocket')
client.on('added', added)
client.connect()
sub_id = client.subscribe('posts')

Collection Changed

from DDPClient import DDPClient

def changed(self, collection, id, fields, cleared):
    print '* CHANGED {} {}'.format(collection, id)
    for key, value in fields.items():
        print '  - FIELD {} {}'.format(key, value)
    for key, value in cleared.items():
        print '  - CLEARED {} {}'.format(key, value)

client = DDPClient('ws://127.0.0.1:3000/websocket')
client.on('changed', changed)
client.connect()
sub_id = client.subscribe('posts')

Removed From Collection

from DDPClient import DDPClient

def removed(collection, id):
    print '* REMOVED {} {}'.format(collection, id)

client = DDPClient('ws://127.0.0.1:3000/websocket')
client.on('removed', removed)
client.connect()
sub_id = client.subscribe('posts')

Other Events

Failed

from DDPClient import DDPClient

def failed(collection, code, reason):
    print '* FAILED - data: {}'.format(str(data))

client = DDPClient('ws://127.0.0.1:3000/websocket')
client.connect()
client.on('failed', failed)

Usage

Functions

####call(self, method, params, callback=None)

Call a method on the server

Arguments

method - the remote server method
params - an array of commands to send to the method

Keyword Arguments

callback - a callback function containing the return data

####subscribe(self, name, params, callback=None)

Subcribe to add/change/remove events for a collection

Arguments

name - the name of the publication to subscribe
params - params to subscribe (parsed as json)

Keyword Arguments

callback - a callback function that gets executed when the subscription has completed

####unsubscribe(self, sub_id)

Unsubscribe from a collection

Arguments

sub_id - the id of the subsciption (returned by subcribe)

Events and Callback Arguments

When creating an instance of DDPClient it is capable of emitting a few events with arguments. The documentation below assumes that you've instanciated a client with the following code:

from DDPClient import DDPClient
client = DDPClient('ws://127.0.0.1:3000/websocket')