How to develop the PyBonita lib

Guideline

get_something methods return None if nothing found
Bonita Server does not properly return HTTP code. It only return 500 error with body containing real HTTP error. To get ride of this stupid feature, you should use the BonitaHTTPError exception calling it with the HTTP error code and a message. For example :

# Bonita Server response with 500 error code
try:
    xml = BonitaServer.get_instance().sendRESTRequest()
except BonitaHTTPError as err:
    print 'Bonita server raise an HTTP error code % with message %' % (err.code, err.message)

method header must include docstring with something like this :

def my_kick_ass_method(self,param1,param2,param3=default_value,**kwargs):
    """ Short description of the method in one line.

    Longer description. Could include some specific behaviors description.

    Description of usable extra paramaters if any (those given in kwargs).

    :param param1: description of param1, also set the default value if any
    :type param1: type of param1 (either standard as int, str or class as BonitaUser)
    :raise ExceptionClass: when the exception may be raised
    :return: Type return by the method, iwht a description if complex type (list, tuple, etc)

    """
    pass # my method code

Test case

With bonita Server

from pybonita.tests import TestWithBonitaServer

class TestBidonA(TestWithBonitaServer):

    def testA(self):
        BonitaServer.use('localhost', 9090, 'restuser', 'restbpm')

        user = BonitaUser('u1','p1')
        user.save()

Without bonita Server

from pybonita.tests import TestWithMockedServer

class TestBidonB(TestWithMockedServer):

    def testB(self):
        BonitaServer.use('localhost', 9090, 'restuser', 'restbpm')

        url = '/identityAPI/addUser'
        code = 204
        xml = ''
        BonitaServer.set_response_list([[url,code,xml]])

        user = BonitaUser('u2','p2')
        user.save()

Testing before developping

In order to test the calling requests, and the provided response, you could use the HTTPie tool and command like this one ::

http --form --auth restuser:restbpm POST http://serv-devbpm-integration.igbmc.u-strasbg.fr/bonita-server-rest/API/identityAPI/getAllUsers options="user:john" content-type:application/x-www-form-urlencoded

Adding –verbose –stream –traceback options at start could help you