Introduction
s3asy ('S-Three-Zee') is a simple library for issuing GET, PUT, and DELETE requests against Amazon S3. It allows caching of files in a local redis instance using the If-Modified-Since and ```Date```` headers as cache-control.
It achieves this simplicity by utilizing knox and cacheit under the hood.
Warning: Don't use this for large objects, as it obviously buffers them in memory. Also Redis cannot cash strings larger than 512 MB.
Example
var S3 = require('s3asy');
var s3 = new S3({
key: '<api-key-here>',
secret: '<secret-here>',
bucket: 'bucket-name',
cache: true
});
s3.get('/some/path', {'x-amz-acl': 'private'}, function(err, body) {
console.log(body);
});API
s3.get(path, [headers], callback)
s3.put(path, headers, data, callback)
Requires Content-Type and Content-Length headers
s3.delete(path, [headers], callback)
s3.copy(dst_path, src_path, src_bucket, headers, callback)
- dst_path - the destination filename
- src_path - the source filename
- src_bucket - the source bucket. The dst_bucket is the bucket passed to the constructor.
Requires Content-Type and Content-Length headers
s3.ls(path, callback)
List files with a given prefix (path). Do NOT use a leading slash.
Run Tests
Ensure you have mocha installed.
npm install mocha
Add a config file for s3asy to use in ~/.s3asy_test_config.js.
module.exports = {
key: '<api-key-here>',
secret: '<secret-here>',
bucket: 'bucket-name',
cache: true
};
Run tests
cd test
mocha test.js --reporter spec