nosql-rest-preprocessor 0.3

A middleware module which solves common problems when building rest-apis with nosql databases.

NoSQL Rest Preprocessor
=======================
[](https://travis-ci.org/felixbr/nosql-rest-preprocessor)
[](https://coveralls.io/r/felixbr/nosql-rest-preprocessor)

A middleware module which solves common problems when building rest-apis with nosql databases.

### Installation

```
pip install nosql-rest-preprocessor
```

### Examples

```python
from nosql-rest-preprocessor.models import BaseModel

class AddressModel(BaseModel):
required_attributes = {'street', 'city', 'plz'}

# if you specify optional attributes explicitely, it will
# not allow anything but these and the required ones
optional_attributes = {'location'}

class UserModel(BaseModel):
required_attributes = {'firstName', 'lastName', 'email'}
immutable_attributes = {'id'}
private_attributes = {'password', 'salt'}

# will use AddressModel to validate, merge and prepare the content of the 'address' attribute
sub_models: {
'address': AddressModel
}
```

```python
new_user_from_request = {
"firstName": "Sepp",
"lastName": "Huber",
"email": "[e-mail]",
"address": {
"street": "Bakerstreet 1",
"city": "London",
"plz": "12345"
}
}

# checks required_attributes and raises ValidationError if something's amiss
UserModel.validate(new_user_from_request)

```

```python
user_obj_from_db = db.fetch_user_by_email("[e-mail]")

# strips out any non-public attributes
response_obj = UserModel.prepare_response(user_obj_from_db)

return Response(response_obj)
```

```python
from nosql-rest-preprocessor.models import BaseModel
from nosql-rest-preprocessor.resolvers import resolve, ResolveWith

class AddressModel(BaseModel):
...

class UserModel(BaseModel):
...

resolved_attributes = {
'address' = ResolveWith(lookup_func=SomeDB.find_address_by_key, model=AddressModel)
}

...

user = {
"name": "cookie_m0nster",
"address": "foreign_key_for_address"
}

resolved_obj = resolve(UserModel, user)
# resolved_obj['address'] is now replaced by the dict fetched by SomeDB.find_address_by_key('foreign_key_for_address')
```

### Running tests
```
pip install detox

detox
```