restfulgrok API

restfulgrok.view

exception restfulgrok.view.CouldNotDetermineContentType(querystring_error, acceptheader_error, acceptable_mimetypes)

Bases: exceptions.Exception

Raised when GrokRestViewMixin.get_content_type() fails to detect a supported content-type.

class restfulgrok.view.GrokRestViewMixin

Bases: object

Mix-in class for five.grok.View.

add_attachment_header()

Adds Content-Disposition header for filedownload if “downloadfile=yes” is in the querystring (request.get).

authorize()

Called by render() to authorize the user before calling handle().

The permissions required for each method is defined in permissions.

Raises:AccessControl.Unauthorized – If the current user do not have permission to perform the requested method.

content_types = <restfulgrok.contenttype.ContentTypesRegistry object>

A ContentTypesRegistry object containing all content-types supported by the API.

create_response(status, statusmsg, body)

Respond with the given status and statusmessage, with body as response body.

decode_input_data(rawdata)

Decode the given rawdata.

Raises:restfulgrok.contenttype.ContentTypeLoadError – If rawdata can not be decoded.

encode_output_data(pydata)

Encode the given python datastructure.

Raises:restfulgrok.contenttype.ContentTypeDumpError – If pydata can not be encoded.

get_content_type()

Detect input/output content type.

get_requestdata()

Decode the body of the request using decode_input_data(), and return the decoded data.

get_requestdata_dict()

Just like get_requestdata(), however, the ValueError is raised if the decoded data is not a dict.

get_requestmethod()

Get the request method as lowercase string.

handle()

Takes care of all the logic for render(), except that it does not encode_output_data() the response data, and it does not do authorization. This makes this method very suitable for use in tests or custom render() implementations.

handle_delete()

Override in subclasses. Defaults to response_405_method_not_allowed().

handle_get()

Override in subclasses. Defaults to response_405_method_not_allowed().

handle_head()

Override in subclasses. Defaults to response_405_method_not_allowed().

handle_options()

Override in subclasses. Defaults to response_405_method_not_allowed().

handle_post()

Override in subclasses. Defaults to response_405_method_not_allowed().

handle_put()

Override in subclasses. Defaults to response_405_method_not_allowed().

permissions = {'put': 'Modify portal content', 'default': 'Modify portal content', 'post': 'Add portal content', 'get': 'View'}

Map of request method to permission. You should have one (lowercase) key for each request method in supported_methods, or a “default” key defining a default permission.

render()

Called to render the view. Uses handle() to handle all the logic and encode_output_data() to encode the response from handle().

response_201_created(body)

Run self.response.setStatus(201, 'Created') and return body.

response_400_bad_request(body)

Respond with 400 Bad Request, and the body parameter as response body.

response_401_unauthorized(error='Unauthorized')

Respond with 401 Unauthorized, and {'error': 'Unauthorized'} as body.

response_405_method_not_allowed()

Respond with 405 Method Not Allowed.

set_contenttype_header(mimetype=None)

Set the content type header. Called by handle(), and may be overridden.

supported_methods = ['get', 'post', 'put', 'delete', 'options', 'head']

List of supported HTTP request methods in lowercase. Defaults to ['get', 'post', 'put', 'delete', 'options', 'head']. You do not have to override this to disallow any of those request methods since their default handle_<method>() implementations responds with 405 Method Not Allowed. However, if you implement other methods, such as TRACE, you need to add them to the list.

restfulgrok.fancyhtmlview

class restfulgrok.fancyhtmlview.GrokRestViewWithFancyHtmlMixin

Bases: restfulgrok.view.GrokRestViewMixin

Adds HtmlContentType to content_types.

class restfulgrok.fancyhtmlview.HtmlContentType

Bases: restfulgrok.contenttype.ContentType

XHTML content type. Provides a dumps-method that uses a jinja2-template to generate a bootrap-styled HTML-document which is suitable as a default view for a REST API.

error_template_name = 'restfulgrok/errorview.jinja.html'

jinja2 template name for the errorview().

classmethod get_previewdata(pydata)

Get the data that should be added to the data preview box.

Returns:A string containing the data.

classmethod get_template_data(pydata, view)

Get the template data.

Returns:Template data. Return type:dict

html_brandingtitle = 'REST API'

Variable forwarded to the template as brandingtitle.

html_heading = 'REST API'

Variable forwarded to the template as heading.

html_title = 'REST API'

Variable forwarded to the template as title.

template_environment = <jinja2.environment.Environment object>

The jinja2.Environment

template_name = 'restfulgrok/fancyhtmlview.jinja.html'

jinja2 template name for the normal html view (not for errors)

restfulgrok.contenttype

class restfulgrok.contenttype.ContentType

Bases: object

Superclass for all content-types for the ContentTypesRegistry.

description = ''

A short description for users of the content-type.

classmethod dumps(pydata, view)

Dump pydata to a string and return the string.

Parameters:

• pydata – The python data to encode.
• view – A GrokRestViewMixin instance.

extension = None

Extension for files of this type. Must be set in subclasses.

classmethod loads(rawdata, view)

Load the rawdata bytestring and return it as a decoded pyton object.

Parameters:

• rawdata – The bytestring to decode.
• view – A GrokRestViewMixin instance.

mimetype = None

The mimetype of this content type. Must be set in subclasses.

exception restfulgrok.contenttype.ContentTypeDumpError

Bases: restfulgrok.contenttype.ContentTypeError

Raised when ContentType.dumps() fails.

exception restfulgrok.contenttype.ContentTypeError

Bases: exceptions.Exception

Superclass for ContentType errors.

exception restfulgrok.contenttype.ContentTypeLoadError

Bases: restfulgrok.contenttype.ContentTypeError

Raised when ContentType.loads() fails.

class restfulgrok.contenttype.ContentTypesRegistry(*content_types)

Bases: object

Registry of ContentType objects.

add(content_type)

Add the given content_type to the registry. They are added indexed by their mimetype, so adding multiple content-types with the same mimetype will only add the last one.

addmany(*content_types)

Run add() for each item in content_types.

aslist()

Return list of :class:`ContentType`s in the registry.

negotiate_accept_header(acceptheader)

Parse the HTTP accept header and find any acceptable mimetypes from the registry.

Returns:An acceptable mimetype, or None if no acceptable mimetype is found. Return type:str

class restfulgrok.contenttype.JsonContentType

Bases: restfulgrok.contenttype.ContentType

JSON content type. Implements both loads and dumps.

class restfulgrok.contenttype.YamlContentType

Bases: restfulgrok.contenttype.ContentType

YAML content type. Implements both loads and dumps.

restfulgrok.mock

Mock classes to simplify testing. See the sourcecode (or the source links below).

class restfulgrok.mock.MockContext(parentnode=None, id=None)

Bases: object

getParentNode()

class restfulgrok.mock.MockRequest(method='GET', body='', getdata={}, headers={'Accept': 'application/json'})

Bases: object

get(key, default=None)

getHeader(header)

class restfulgrok.mock.MockResponse

Bases: object

getStatus()

setHeader(header, value)

setStatus(code, msg)

class restfulgrok.mock.MockRestView(request=None, response=<restfulgrok.mock.MockResponse object>, context=None)

Bases: restfulgrok.view.GrokRestViewMixin

class restfulgrok.mock.MockRestViewWithFancyHtml(request=None, response=<restfulgrok.mock.MockResponse object>, context=None)

Bases: restfulgrok.fancyhtmlview.GrokRestViewWithFancyHtmlMixin