binary content example

Author: gojko

README.md

@@ -34,6 +34,7 @@
 * [Using AWS Mobile Analytics for server-side events](aws-mobile-analytics) – log events into AWS Mobile Analytics for easy internal telemetry
 * [Custom Authorizers](custom-authorizers) – a simple example of how to set up custom authorizers in API Gateway
 * [Geo location](api-gw-geolocation) – shows how to retrieve the country where your users originated the request
+* [Binary Content](binary-content) – shows how to configure API Gateway to send or receive binary data
 
 ## Event processing
 

binary-content/README.md

@@ -0,0 +1,36 @@
+# Handling binary content with API Gateway
+
+This project demonstrates how to configure API Gateway using Claudia API Builder to support binary content handling. There are three endpoints:
+
+* `/img`: shows how to receive a text request and respond with binary content
+* `/info` endpoint shows how to receive binary content and respond with text
+* `/thumb`: endpoint shows how to receive and respond with binary content
+
+## Try it out
+
+* run `npm install` to download the dependencies
+* run `npm run create` to deploy the project to Lambda. Grab the API ID from the result and replace `<API-ID>` in the example commands below
+
+### retrieve a picture (text request, binary result)
+
+```
+curl https://<API-ID>.execute-api.us-east-1.amazonaws.com/latest/img -H "Accept: image/png" > 1.png
+```
+
+### get info about a pic (binary request, text result) 
+
+```
+curl --request POST -H "Content-Type: image/png" --data-binary "@img.png" https://<API-ID>.execute-api.us-east-1.amazonaws.com/latest/info
+```
+
+### make a thumbnail (binary post, binary result)
+
+
+```
+curl --request POST -H "Content-Type: image/png" -H "Accept: image/png" --data-binary "@img.png" https://<API-ID>.execute-api.us-east-1.amazonaws.com/latest/thumb > thumb.png
+```
+
+## More information
+
+Check out the [Handling Binary Content Tutorial](https://claudiajs.com/tutorials/binary-content.html) for more information on these features, and see the [Binary Data Type support for API Gateway](https://aws.amazon.com/about-aws/whats-new/2016/11/binary-data-now-supported-by-api-gateway/) for more information on how things are configured under the hood.
+

binary-content/child-process-promise.js

@@ -0,0 +1,39 @@
+/*global module, require, console, Promise */
+const childProcess = require('child_process'),
+	execPromise = function (command) {
+		'use strict';
+		return new Promise(function (resolve, reject) {
+			childProcess.exec(command, function (err) {
+				if (err) {
+					reject(err);
+				} else {
+					resolve();
+				}
+			});
+		});
+	},
+	spawnPromise = function (command, options) {
+		'use strict';
+		return new Promise(function (resolve, reject) {
+			const process = childProcess.spawn(command, options),
+				result = [];
+			process.stdout.on('data', function (buffer) {
+				console.log(buffer.toString());
+				result.push(buffer.toString());
+			});
+			process.stderr.on('data', function (buffer) {
+				console.error(buffer.toString());
+			});
+			process.on('close', function (code) {
+				if (code !== 0) {
+					reject(code);
+				} else {
+					resolve(result.join(''));
+				}
+			});
+		});
+	};
+module.exports = {
+	exec: execPromise,
+	spawn: spawnPromise
+};

binary-content/fs-promise.js

@@ -0,0 +1,25 @@
+const fs = require('fs'),
+	promisify = function (target, methodName) {
+		'use strict';
+		target[methodName + 'Promise'] = function () {
+			const originalArgs = Array.prototype.slice.call(arguments);
+			return new Promise((resolve, reject) => {
+				const cb = function (err, data) {
+					if (err) {
+						reject(err);
+					} else {
+						resolve(data);
+					}
+				};
+				originalArgs.push(cb);
+				target[methodName].apply(target, originalArgs);
+			});
+		};
+	};
+
+promisify(fs, 'writeFile');
+promisify(fs, 'readFile');
+promisify(fs, 'unlink');
+promisify(fs, 'rename');
+
+module.exports = fs;

binary-content/img.png

@@ -0,0 +1,42 @@
+/*global exports*/
+const path = require('path'),
+	os = require('os'),
+	ApiBuilder = require('claudia-api-builder'),
+	fs = require('./fs-promise'),
+	childProcess = require('./child-process-promise'),
+	api = new ApiBuilder();
+
+module.exports = api;
+
+//api.setBinaryMediaTypes(['image/*']);
+
+api.get('/img', () => {
+	'use strict';
+	return fs.readFilePromise(path.join(__dirname, 'img.png'));
+}, { success: { contentType: 'image/png', contentHandling: 'CONVERT_TO_BINARY'}});
+
+
+api.post('/info', (request) => {
+	'use strict';
+	const tempFileName = path.join(os.tmpdir(), request.lambdaContext.awsRequestId);
+	let result;
+	return fs.writeFilePromise(tempFileName, request.body)
+		.then(() => childProcess.spawn('/usr/bin/identify', [tempFileName]))
+		.then(picInfo => result = picInfo.replace(/[^\s]*\s/, ''))
+		.then(() => fs.unlinkPromise(tempFileName))
+		.then(() => result);
+}, { success: { contentType: 'text/plain' } });
+
+api.post('/thumb', (request) => {
+	'use strict';
+	const tempFileName = path.join(os.tmpdir(), request.lambdaContext.awsRequestId),
+		thumbFileName = tempFileName + '-thumb.png';
+	let result;
+	return fs.writeFilePromise(tempFileName, request.body)
+		.then(() => childProcess.spawn('/usr/bin/convert', ['-resize', '150x', tempFileName, thumbFileName]))
+		.then(() => fs.readFilePromise(thumbFileName))
+		.then(fileContents => result = fileContents)
+		.then(() => fs.unlinkPromise(tempFileName))
+		.then(() => fs.unlinkPromise(thumbFileName))
+		.then(() => result);
+}, { success: { contentType: 'image/png', contentHandling: 'CONVERT_TO_BINARY' } });

binary-content/main.js

@@ -0,0 +1,18 @@
+{
+  "name": "binary-content",
+  "version": "1.0.0",
+  "description": "",
+  "scripts": {
+    "create": "claudia create --region us-east-1 --api-module main",
+    "update": "claudia update"
+  },
+  "keywords": [],
+  "author": "Gojko Adzic <gojko@neuri.co.uk>",
+  "license": "MIT",
+  "devDependencies": {
+    "claudia": "^2.6.0"
+  },
+  "dependencies": {
+    "claudia-api-builder": "^2.4.0"
+  }
+}