Attach files to Kinto records
Project description
proof-of-concept: Attach files to Kinto records.
Install
pip install kinto-attachment
Setup
In the Kinto project settings
kinto.includes = kinto_attachment kinto.attachment.base_url = http://cdn.service.org/files/
Store files locally:
kinto.attachment.base_path = /tmp
Store on Amazon S3:
kinto.attachment.aws.access_key = <AWS access key> kinto.attachment.aws.secret_key = <AWS secret key> kinto.attachment.aws.bucket = <bucket name> kinto.attachment.aws.acl = <AWS ACL permissions|public-read>
See Pyramid Storage.
Usage
Using HTTPie:
http --auth alice: -form POST http://localhost:8888/v1/buckets/website/collections/assets/records/c2ce1975-0e52-4b2f-a5db-80166aeca689/attachment data='{"type": "wallpaper", "theme": "orange"}' "attachment@~/Pictures/background.jpg"
HTTP/1.1 303 See Other
Content-Length: 313
Content-Type: text/html; charset=UTF-8
Date: Tue, 10 Nov 2015 17:15:58 GMT
Location: http://localhost:8888/v1/buckets/b3cd54a6-9e43-10eb-2833-f3ba194e0786/collections/tasks/records/c2ce1975-0e52-4b2f-a5db-80166aeca689
Server: waitress
The related record was given an attachment field:
http --auth alice: GET http://localhost:8888/v1/buckets/b3cd54a6-9e43-10eb-2833-f3ba194e0786/collections/tasks/records/c2ce1975-0e52-4b2f-a5db-80166aeca689
HTTP/1.1 200 OK
Access-Control-Expose-Headers: Content-Length, Expires, Alert, Retry-After, Last-Modified, ETag, Pragma, Cache-Control, Backoff
Cache-Control: no-cache
Content-Length: 295
Content-Type: application/json; charset=UTF-8
Date: Tue, 10 Nov 2015 17:17:00 GMT
Etag: "1447175758684"
Last-Modified: Tue, 10 Nov 2015 17:15:58 GMT
Server: waitress
{
"data": {
"attachment": {
"filename": "IMG_20150219_174559-22.jpg",
"filesize": 1481798,
"hash": "hPME6i9avCf/LFaznYr+sHtwQEX7mXYHSu+vgtygpM8=",
"location": "IMG_20150219_174559-22.jpg",
"mimetype": "text/plain"
},
"id": "c2ce1975-0e52-4b2f-a5db-80166aeca689",
"last_modified": 1447175758684,
"type": "wallpaper",
"theme": "orange"
},
"permissions": {}
}
TODO
Setup tests with real Kinto on TravisCI
Handle default bucket
Validate API
Check record permissions
Make sure record is created with appropriate permissions
Delete attachment on record delete
Notes
API design discussion about mixing up attachment and record fields.
Changelog
0.1.0 (unreleased)
Initial working proof-of-concept.
