marchio-lambda-put

marchio-lambda-put
==
REST PUT to DynamoDB via Lambda
--

Installation

$ npm init
$ npm install marchio-lambda-put --save

*

Lambda Setup

$3

* __marchio-lambda-post__
* __marchio-lambda-get__
* __Create an API with Lambda Proxy Integration through a Proxy Resource__
* A Lambda Function in Node.js for Proxy Integration
* Build an API Gateway API Using Proxy Integration and a Proxy Resource
* Create and Test an API with HTTP Proxy Integration through a Proxy Resource

*

$3

#### Create Test Role

* Browse to: https://console.aws.amazon.com/iam/
* Click: __Roles__ (from the left column)
* Click: __Create new role__
* __Step 1: Select role type__
* Expand Section: __AWS Service Role__
* For __AWS Lambda__, click: __Select__
* __Step 2__ is automatically skipped
* __Step 3: Attach policy__
Select both __AmazonDynamoDB__ policies
* Click: __Next Step__
* Create a name for the role (like __lambda-db-put__)
* Click: __Create role__

#### Create Lambda Function

* Browse to: https://console.aws.amazon.com/lambda
* Click: __Create a Lambda Function__
* Select: __Blank Function__
* Click: __Next__
* Name: __marchio-put__
* Description: __Marchio service__
* Runtime: __Node.js 4.3__
* Set the Role
* Role: __Choose and existing role__
* Existing role: __service-role/__(name of role you created earlier)
* Click: __Next__
* Click: __Create Function__

#### Setup API Gateway

* Browse to: https://console.aws.amazon.com/apigateway
* Click: __Create API__
* Select: __New API__
* API name: __marchio-put__
* Description: __Marchio service__
* Click: __Create API__
* Click on the slash (__/__)
* Drop down: __Actions__
* Select: __Create Resource__
* Check: __Configure as proxy resource__
* (Optionally enabled __CORS__)
* Click: __Create Resource__
* For __Integration type__ select: __Lambda Function Proxy__
* Lambda Region: For example: __us-east-1__
* Lambda Function: __marchio-put__
* Click: __Save__
* Add Permission to Lambda Function: __OK__
* Drop down: __Actions__
* Select: __Deploy API__
* Define a new stage (call it "test")
* Click: __Deploy__
* Save the __Invoke URL__

#### Create DynamoDB Table

* Browse to: https://console.aws.amazon.com/dynamodb/
* Click: __Create Table__
* Table name: __mldb__
* Primary partition key: __eid__
* The type should be the default (string)
* Click: __Create__
* After some churning, click the __Capacity__ tab
* Set the __Read / Write capacity units__ to __1__ to save money while testing
* Click: __Save__

#### Example and Deploy

See the deployment example located in the repo under:

* examples/deploy

It contains a deployment script and an example lambda source file.

* Install the dependencies by running:
``
$ npm install
`

To run the script you must first make it runnable:
`
$ chmod +x deploy-lambda.sh
`

To test:

* Deploy the API via API Gateway
* Create an environment variable called __AWS\_HOST\_MARCHIO\_PUT__ which is set to the invocation url
* Test the deployment using __curl__:

`
$ curl -i -X PUT -H "Content-Type: application/json" -d '{"email":"test@beta.com"}' $AWS_HOST_MARCHIO_PUT/test/marchio-put/110ec58a-a0f2-4ac4-8393-c866d813b8d1
`
* The response should contain a 204 status code.
* Browse the DynamoDB table to see the updated record.

*

Modules

marchio-lambda-put

Module

marchio-lambda-put-factory

Factory module

marchio-lambda-put

Example (Usage example)
`js
// Lambda root file
"use strict";

var mlFactory = require('marcio-lambda-put');

var getRandomInt = function (min, max) {
return Math.floor(Math.random() * (max - min + 1) + min);
};

// Why not just demo hashing with bcrypt?
// Because bcrypt requires installing on AWS Linux before packaging
// That's beyond the scope of this example, so we fake it.

function fakeHash( record ) {
// Not a real hash function - do not use in production
return new Promise( (resolve, reject) => {
if(!record) {
return reject('record not defined');
}
if(record.password) {
// only update if value passed in
// fake hashing - do not use in production
record.password = '$' + getRandomInt(10000, 10000000);
}
resolve(record);
});
}

exports.handler = function(event, context, callback) {

var model = {
name: 'mldb', // must match DynamoDB table name
partition: 'eid', // primary partition key - cannot be reserved word (like uuid)
// sort: 'status', // primary sort key
// recordMustExist: false, // default is false
fields: {
email: { type: String, required: true },
status: { type: String, required: true, default: "NEW" },
// Password will be (fake) hashed by filter before being saved
password: { type: String, select: false }, // select: false, exclude from query results
}
};

mlFactory.create({
event: event,
context: context,
callback: callback,
model: model,
filter: fakeHash
})
.catch(function(err) {
callback(err);
});
};
``

*

Testing

To test, go to the root folder and type (sans __$__):

$ npm test

*

Repo(s)

* bitbucket.org/mitchallen/marchio-lambda-put.git
* github.com/mitchallen/marchio-lambda-put.git

*

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style.
Add unit tests for any new or changed functionality. Lint and test your code.

*

Version History

#### Version 0.3.1

* updated deploy example

#### Version 0.3.0

* removed model/table name from url
* updated deploy-build examples

#### Version 0.2.1

* updated example project

#### Version 0.2.0

* changed primary model property to partition
* added support for sort key
* added recordMustExist flag
* new sort key tests will fail until post and get have sort supported added

#### Version 0.1.0

* initial release

*