marchio-lambda-get

marchio-lambda-get
==
REST GET from DynamoDB via Lambda
--

Installation

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

*

Lambda Setup

$3

* __marchio-lambda-post__

* __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 __AmazonDynamoDBReadOnlyAccess__ policiy
* Click: __Next Step__
* Create a name for the role (like __lambda-db-get-only__)
* 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-get__
* 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-get__
* 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-get__
* 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

If you've already setup a demo for __marchio-lambda-post__ then you may have this table already. If not, create it and load it with a few test records.

* Browse to: https://console.aws.amazon.com/dynamodb/
* Click: __Create Table__
* Table name: __mldb__
* Primary 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\_GET__ which is set to the invocation url
* Test the deployment using __curl__ (substitute a valid __eid__ value):

`
$ curl -i -X GET -H "Accept: applications/json" \
$AWS_HOST_MARCHIO_GET/test/marchio-get/110ec58a-a0f2-4ac4-8393-c866d813b8d1
`
* The response should contain a 200 status code and a copy of the record.

*

Modules

marchio-lambda-get

Module

marchio-lambda-get-factory

Factory module

marchio-lambda-get

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

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

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: 'gid',
fields: {
eid: { type: String }, // return eid / primary partition in GET results
// gid: { type: String }, // return gid / primary sort in GET results
email: { type: String, required: true },
status: { type: String, required: true, default: "NEW" },
password: { type: String, select: false }, // select: false, exclude from query results
}
};

mlFactory.create({
event: event,
context: context,
callback: callback,
model: model
})
.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-get.git
* github.com/mitchallen/marchio-lambda-get.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.2

* removed comment from demo

#### Version 0.2.1

* Added support for primary sort key

#### Version 0.2.0

* Change model.primary to model.partition

#### Version 0.1.5

* Updated doc and demo deploy to show how to return primary key if required

#### Version 0.1.4

* Integrated module documentation into readme

#### Version 0.1.3

* Updated role documentation

#### Version 0.1.2

* Updated service to only return record and not Item wrapper.

#### Version 0.1.1

* Fixed issue with object passed to DynamoDB.getItem

#### Version 0.1.0

* initial release

*