nanopay-s3 v1.4.0

Nanopay S3

This library handles services related to AWS S3.

It uses the following dependencies:

• Bluebird
• Formidable
• AWS SDK

Methods

Upload

• upload(bucket, bucketPath, acl, req, cb) (return: function) - Uploads File to S3 Using Http Multipart requests(Streams) using callback pattern
• uploadSync(bucket, bucketPath, acl, req) (return: Promise) - Uploads File to S3 Using Http Multipart requests(Streams) using Promises pattern.

Usage

If you want to use any method inside this library with the Promises pattern, put the suffix "Sync" when calling the method you want, this way it's going to return you a Promise.

Upload to S3 (Using Promises)

const nanopayS3 = require('nanopay-s3');

/**
 * Upload file to a local directory temporary(AWS S3 doesn't allow streams), then upload to AWS S3
 * and then finally remove the temp file
 *
 * @param {string} accessKey - AWS Access Key
 * @param {string} secretKey - AWS Secret Key
 * @private
 */
const s3 = new nanopayS3(process.env.AWS_ACCESS_KEY_ID, process.env.AWS_SECRET_ACCESS_KEY);

const bucket = 'bucket-name';
const bucketPath = 'path/inside/the/bucket';
const acl = 'public-read'; // this ACL allows everyone to see/read the file you're uploading

/**
 * Upload file to a local directory temporary(AWS S3 doesn't allow streams), then upload to AWS S3
 * and then finally remove the temp file
 * @param {string} bucket - the S3 bucket 
 * @param {string} bucketPath - the S3 Bucket Path 
 * @param {string} acl - the ACL the defines the permissions for the file, see more: http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
 * @param {object} req - the HTTP request containg the file(Stream)
 * @returns {function} cb - the callback
 * @private
 */
s3.uploadSync(bucket, bucketPath, acl, req)
then(fileUploaded => {
	// Do something with fileUploaded;
})

Upload to S3 (Using Callbacks)

const nanopayS3 = require('nanopay-s3');

/**
 * Upload file to a local directory temporary(AWS S3 doesn't allow streams), then upload to AWS S3
 * and then finally remove the temp file
 *
 * @param {string} accessKey - AWS Access Key
 * @param {string} secretKey - AWS Secret Key
 * @private
 */
const s3 = new nanopayS3(process.env.AWS_ACCESS_KEY_ID, process.env.AWS_SECRET_ACCESS_KEY);

const bucket = 'bucket-name';
const bucketPath = 'path/inside/the/bucket';
const acl = 'public-read'; // this ACL allows everyone to see/read the file you're uploading

/**
 * Upload file to a local directory temporary(AWS S3 doesn't allow streams), then upload to AWS S3
 * and then finally remove the temp file
 * @param {string} bucket - the S3 bucket 
 * @param {string} bucketPath - the S3 Bucket Path 
 * @param {string} acl - the ACL the defines the permissions for the file, see more: http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html
 * @param {object} req - the HTTP request containg the file(Stream)
 * @returns {function} cb - the callback
 * @private
 */
s3.upload(bucket, bucketPath, acl, req, function (error, response) {
  if (error) {
    cb(error);
  }
  
  cb(false, response);
});