c2c.sqlalchemy.rest
Use it
In <project>/model.py:
from pyramid.security import Allow, Authenticated, ALL_PERMISSIONS
class Object(Base):
__tablename__ = 'object'
__table_args__ = {'autoload':True}
__acl__ = [
(Allow, 'admin', ALL_PERMISSIONS),
(Allow, 'editor', ('view', 'edit', 'new', 'delete')),
(Allow, Authenticated, ('view')),
]In <project>/views/rest.py:
from pyramid.view import view_config
from c2c.sqlalchemy.rest import REST
from <project>.models import DBSession, Object
obj = REST(DBSession, Object)
@view_config(route_name='obj_read_many', renderer='jsonp')
def obj_read_many(request):
return obj.read_many(request)
@view_config(route_name='obj_read_one', renderer='jsonp')
def obj_read_one(request):
return obj.read_one(request)
@view_config(route_name='obj_count', renderer='string')
def obj_count(request):
return obj.count(request)
@view_config(route_name='obj_create', renderer='jsonp')
def obj_create(request):
return obj.create(request)
@view_config(route_name='obj_update')
def obj_update(request):
return obj.update(request)
@view_config(route_name='obj_auto')
def obj_auto(request):
return obj.auto(request)
@view_config(route_name='obj_delete', renderer='jsonp')
def obj_delete(request):
return obj.delete(request)In <project>/__init__.py:
from pyramid.renderers import JSONP
from c2c.sqlalchemy.rest import add_rest_routes
config.add_renderer('jsonp', JSONP(param_name='callback'))
add_rest_routes(config, 'obj', '/object')Controlling what attributes to display
One may restrict the displayed attributes to a subset by passing an
attr_list argument to the constructor. By default all attributes are
displayed. For instance:
obj = REST(DBSession, Object, attr_list=['id', 'name'])Additional properties
It is possible to add some extra properties by defining in the model an
__additional_properties__ function with an attr_list argument.
For instance:
class Object(Base):
def __additional_properties__(self, attr_list=None):
properties = {}
if attr_list is None or 'l10n' in attr_list:
l10n = {}
for l in self.l10n:
l10n[l.lang.code] = l.value
properties.update({ "l10n": l10n })
return propertiesUsing Relationships
It is possible to retrieve related objects with read_many and read_one
actions provided that the relationships are defined in the models and that
they are passed to the REST constructor. For instance:
class Tag(GeoInterface, Base):
__tablename__ = 'tag'
__table_args__ = (
UniqueConstraint('name'),
{"schema": 'tagging'}
)
__acl__ = [
(Allow, 'admin', ALL_PERMISSIONS),
(Allow, 'editor', ('view', 'edit', 'new', 'delete')),
(Allow, Everyone, ('view')),
]
id = Column(types.Integer, primary_key=True)
name = Column(types.Unicode(200), nullable=False)
active = Column(types.Boolean, default=True)
l10n = relationship("TagL10n", backref="tag")
childrenTags = relationship("Tag",
secondary=tag_tag,
primaryjoin=id==tag_tag.c.tag_id1,
secondaryjoin=id==tag_tag.c.tag_id2,
order_by=name, backref="parentTags")tag_children = {
'childrenTags': { 'rest': REST(DBSession, Tag) }
}
tag = REST(DBSession, Tag, children=tag_children)The name of the property containing the related objects may be specified
using the propname parameter (default is the relationship name):
tag_children = {
'childrenTags': { 'rest': REST(DBSession, Tag), 'propname': 'tags' }
}
tag = REST(DBSession, Tag, children=tag_children)Example result:
{
"active": false,
"tags": [{
"active": true,
"name": "Artenschutz",
"id": 31
}, {
"active": false,
"name": "Pioniervegetation",
"id": 71
}],
"name": "Naturschutz",
"id": 58
}From source
Build:
python bootstrap.py --distribute -v 1.7.1 ./buildout/bin/buildout
Protocol
- Read many,
GETon.../obj:
{
"objects": [{
"id": id,
"property": "value",
...
},
...
]
}- Read one,
GETon.../obj/{id}:
{
"id": id,
"property": "value",
...
}- Count,
GETon.../obj/count:
23- Create,
POSTon.../objwith data:
{
"property": "value",
...
}and it will return the id.
- Update,
PUTon.../obj/{id}with data:
{
"property": "value",
...
}- Auto,
POSTon.../obj/autowith data:
{
"id": id,
"property": "value",
...
}If an object matches the given id, it will be updated, else a new object is automatically created with the given id value.
- Delete,
DELETEon.../obj/{id}.
