bb`s module

Main BB classic app module

• / - Main Page Handler
• /login - Login Page Handler
• /logout - Logout Page Handler
• /api/.* - Cross Domain Handler

class bb.BaseRequestHandler(request=None, response=None)

Base Request Handler

auth_check()

Check session

dev

Check develompent environment

class bb.CacheInfo(parent=None, key_name=None, _app=None, _from_entity=False, **kwds)

Model for the cached response.

Attributes:

• url - Fetch URL
• status_code - Response status
• headers - Response headers
• content - Response content
• date - Date when response was added to the cache

class bb.CrossDomain(request=None, response=None)

Cross Domain Handler

• PUT /api/.* - CrossDomain PUT
• POST /api/.* - CrossDomain POST
• DELETE /api/.* - CrossDomain DELETE
• GET /api/.* - CrossDomain GET

apiurl

get api url

delete()

wrapper for the function

fetch_request(method, data=None)

Fetch request

Parameters:

• url (string) – [required] request url
• headers (dict) – [required] request headers

Returns:

request response

Raises:

Exception

Return type:

Response

fullurl

get full url

get()

wrapper for the function

jsondata

get json data from request body

post()

wrapper for the function

put()

wrapper for the function

xmldata

get xml data from request body

exception bb.GetSubjectException

Exception on get subject_id

class bb.LoginPage(request=None, response=None)

Login Page Handler

• GET /login - LoginPage GET
• POST /login - LoginPage POST

get()

GET request

post()

POST request

class bb.LogoutPage(request=None, response=None)

Logout Page Handler

• GET /logout - LogoutPage GET

get()

GET request

class bb.MainPage(request=None, response=None)

Main Page Handler

• GET / - MainPage GET

get()

wrapper for the function

bb.absolute_url(subdomain, relative_url='', params='', query='', fragment='')

Prepare absolute url for request

Parameters:

• subdomain (string) – [required] basecamphq subdomain
• relative_url (string) – relative url
• params (string) – url parameters
• query (string) – url query
• fragment (string) – url fragment

Returns:

absolute url for request

Return type:

string

bb.authenticated(func)

decorator for check authentication

bb.convert(node)

convert xml to dict

Parameters:node (string) – [required] xml node to convert Returns:converted node Raises:Exception Return type:tuple(string, valuetype)

bb.convertchilds(childs)

convert childs

Parameters:childs (list) – [required] list of nodes Returns:converted childs Raises:Exception Return type:list

bb.convertsubnodes(childs)

convert subnodes

Parameters:childs (list) – [required] list of nodes Returns:converted nodes Raises:Exception Return type:dict|string

bb.dict2xml(data, tags)

convert dict to xml

Parameters:

• data (dict) – [required] dict with data to convert
• tags (tuple) – [required] tuple of base tags

Returns:

pretty xml

Return type:

string

bb.get_headers(username, password)

Prepare request headers

Parameters:

• username (string) – [required] username
• password (string) – [required] password

Returns:

headers dict

Return type:

dict

bb.get_subject_id(username, password, subdomain)

Get ‘subject_id’ for report query - it is id of logged in user.

Parameters:

• username (string) – [required] username
• password (string) – [required] password
• subdomain (string) – [required] subdomain

Returns:

id of logged in user

Raises:

GetSubjectException

Return type:

string

bb.get_xml_for_request(url)

Get xml base tags for request

Parameters:url (string) – [required] url Returns:tuple of base tags or None Return type:tuple or None

bb.save_request(url, result)

Save request

Parameters:

• url (string) – [required] request url
• result (Response) – [required] request response