Prepared for release

Author: alexanderdean

.gitignore

@@ -3,5 +3,19 @@
 # Vagrant
 .vagrant/
 
-# build directory
-tmp
+# node.js
+lib-cov
+*.seed
+*.log
+*.csv
+*.dat
+*.out
+*.pid
+*.gz
+
+pids
+logs
+results
+
+npm-debug.log
+node_modules

CHANGELOG

@@ -1,3 +1,3 @@
-Version 0.1.0 (2015-0X-XX)
+Version 0.1.0 (2015-07-10)
 --------------------------
 Initial release

Gruntfile.js

@@ -45,7 +45,7 @@ grunt.initConfig({
 });
 
 grunt.loadTasks('tasks');
-grunt.registerTask('default', ['dynamo','createRole','kinesis']);
+grunt.registerTask('init', ['dynamo','createRole','kinesis']);
 grunt.registerTask('role', ['attachRole','packaging']);
 grunt.registerTask('deploy', ['deployLambda']);
 grunt.registerTask('connect', ['associateStream']);

README.md

@@ -5,19 +5,17 @@
 
 ## Introduction
 
-This is an example [AWS Lambda] [aws-lambda] application for processing a [Kinesis] [aws-kinesis] stream of events ([introductory blog post] [blog-post]). It reads the stream of simple JSON events generated by our event generator. Our lambda function aggregates and buckets events and stores them in DynamoDB.
+This is an example [AWS Lambda] [aws-lambda] application for processing a [Kinesis] [aws-kinesis] stream of events ([introductory blog post] [blog-post]). It reads the stream of simple JSON events generated by our event generator. Our AWS Lambda function aggregates and buckets events and stores them in [DynamoDB] [aws-dynamodb].
 
+This was built by the Data Science team at [Snowplow Analytics] [snowplow], who use AWS Lambda in their projects.
 
-This was built by the Data Science team at [Snowplow Analytics] [snowplow].
-
-**Running this requires an Amazon AWS account, and it will incur charges.**
-
-_See also:_ [Spark Example Project] [spark-example-project] | [Spark Streaming Example Project][spark-streaming-example-project]
+**Running this requires an Amazon AWS account, and will incur charges.**
 
+_See also:_ [Spark Streaming Example Project][spark-streaming-example-project] | [Spark Example Project] [spark-example-project]
 
 ## Overview
 
-We have implemented a super-simple analytics-on-write stream processing job using AWS Lambda. Our AWS Lambda Node.js job reads a Kinesis stream containing events in a JSON format:
+We have implemented a super-simple analytics-on-write stream processing job using AWS Lambda. Our AWS Lambda function, written in JavaScript, reads a Kinesis stream containing events in a JSON format:
 
 ```json
 {
@@ -42,14 +40,14 @@ Assuming git, [Vagrant] [vagrant-install] and [VirtualBox] [virtualbox-install]
 guest$ cd /vagrant
 guest# npm install grunt
 guest$ npm install
-guest$ grunt
+guest$ grunt --help
 ```
 
 ## Tutorial
 
 You can follow along in [the release blog post] [blog-post] to get the project up and running yourself.
 
-The below steps assume that you are running inside Vagrant, as per the Developer Quickstart above.
+The following steps assume that you are running inside Vagrant, as per the Developer Quickstart above.
 
 ### 1. Setting up AWS
 
@@ -63,10 +61,10 @@ Default region name [None]: us-east-1
 Default output format [None]: json
 ```
 
-Now we can create our DynamoDB table, Kinesis Stream, and IAM/CloudFormation/Lambda Roles. We will be using [Cloudformation] [http://aws.amazon.com/cloudformation] to make our new role. Using grunt, we will test your credentials by:
+Now we can create our DynamoDB table, Kinesis stream, and IAM role. We will be using [CloudFormation] [http://aws.amazon.com/cloudformation] to make our new role. Using Grunt, we can create all like so:
 
 ```bash
-$ grunt
+$ grunt init
 Running "dynamo:default" (dynamo) task
 { TableDescription:
    { AttributeDefinitions: [ [Object], [Object], [Object] ],
@@ -89,11 +87,12 @@ Running "createRole:default" (createRole) task
 Running "kinesis:default" (kinesis) task
 {}
 
+Done, without errors.
 ```
 
 ### 2. Connect AWS Lambda service with the new role and building the project
 
-Wait a minute to ensure our roles gets created. In this step we connect the new service role to access Kinesis, Cloudwatch, Lambda, and DynamoDB. We will attach an admin policy to the lambda exec role to easily access the services. Using grunt, our javascript project gets assembled into a zip file for upload to the AWS Lambda service. Once its zipped, we attach a service role to it:
+Wait a minute to ensure our IAM service role gets created. Now we connect the new service role to access Kinesis, CloudWatch, Lambda, and DynamoDB. We will attach an admin policy to the lambda exec role to easily access the services. Using Grunt, our AWS Lambda function gets assembled into a zip file for upload to the AWS Lambda service. Once it's zipped, we attach a service role to it:
 
 ```bash
 $ grunt role
@@ -114,7 +113,6 @@ Created package at dist/aws-lambda-example-project_0-1-0_latest.zip
 ...
 ```
 
-
 ### 3. Deploy zip file to AWS Lambda service and connect Kinesis to Lambda
 
 In deploy this project to Lambda with the `grunt deploy` command:
@@ -128,7 +126,7 @@ Created AWS Lambda Function...
 
 ### 4. Connect Kinesis to Lambda
 
-The final step to getting this projected ready to start processing events is to connect Kinesis to the Lambda project with this command:
+The final step to getting this projected ready to start processing events is to associate our Kinesis stream to the Lambda function with this command:
 
 ```bash
 $ grunt connect
@@ -146,10 +144,9 @@ arn:aws:kinesis:us-east-1:844709429716:stream/my-stream
 Done, without errors.
 ```
 
-
 ### 5. Sending events to Kinesis
 
-We need to start sending events to our new Kinesis stream. We have created a helper method to do this - run the below and leave it running: 
+We need to start sending events to our new Kinesis stream. We have created a helper method to do this - run the below and leave it running in a tab: 
 
 ```bash
 $ grunt events
@@ -165,10 +162,9 @@ Writing Kineis Event: {"timestamp":"2015-06-29T20:12:22.708Z","type":"Green"}
 ...
 ```
 
-
 ### 6. Monitoring your job
 
-First head over to the AWS Lambda service console. Then review the logs in Cloudwatch.
+First head over to the AWS Lambda service console, then review the logs in CloudWatch.
 
 Finally, let's check the data in our DynamoDB table. Make sure you are in the correct AWS region, then click on `my-table` and hit the `Explore Table` button:
 
@@ -181,11 +177,10 @@ For each **BucketStart** and **EventType** pair, we see a **Count**, plus some *
 * Various improvements for the [0.2.0 release] [020-milestone]
 * Expanding our analytics-on-write thinking into our new [Icebucket] [icebucket] project
 
-
 ## Credits
 
-Tim Bell [@Tim-B] [tim-b] for his blog post [Writing Functions for AWS Lambda Using NPM and Grunt] [tim-b-post]. Thanks to Ian Meyers and his 
-[Amazon-Kinesis-Aggregators-Project][amazon-kinesis-aggregators].  A true inspiration for streaming analytics on write.
+* [Tim Bell] [tim-b] for his blog post [Writing Functions for AWS Lambda Using NPM and Grunt] [tim-b-post]
+* Ian Meyers and his [Amazon-Kinesis-Aggregators-Project][amazon-kinesis-aggregators], a true inspiration for streaming analytics-on-write
 
 ## Copyright and license
 
@@ -200,36 +195,32 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 
-[travis]: https://travis-ci.org/snowplow/spark-streaming-example-project
-[travis-image]: https://travis-ci.org/snowplow/spark-streaming-example-project.png?branch=master
+[travis]: https://travis-ci.org/snowplow/aws-lambda-nodejs-example-project
+[travis-image]: https://travis-ci.org/snowplow/aws-lambda-nodejs-example-project.png?branch=master
 [license-image]: http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat
 [license]: http://www.apache.org/licenses/LICENSE-2.0
 [release-image]: http://img.shields.io/badge/release-0.1.0-blue.svg?style=flat
-[releases]: https://github.com/snowplow/spark-streaming-example-project/releases
+[releases]: https://github.com/snowplow/aws-lambda-nodejs-example-project/releases
+[grunt-image]: https://cdn.gruntjs.com/builtwith.png
+
+[spark-example-project]: https://github.com/snowplow/spark-example-project
+[spark-streaming-example-project]: https://github.com/snowplow/spark-streaming-example-project
+
+[vagrant-install]: http://docs.vagrantup.com/v2/installation/index.html
+[virtualbox-install]: https://www.virtualbox.org/wiki/Downloads
+
+[blog-post]: http://snowplowanalytics.com/blog/2015/07/10/aws-lambda-nodejs-example-project-0.1.0-released/
+[020-milestone]: https://github.com/snowplow/aws-lambda-nodejs-example-project/milestones/Version%200.2.0
+[dynamodb-table-image]: /docs/dynamodb-table-image.png?raw=true
 
-[amazon-kinesis-aggregators]: https://github.com/awslabs/amazon-kinesis-aggregators
 [aws-lambda]: http://aws.amazon.com/lambda/
 [aws-kinesis]: http://aws.amazon.com/kinesis/
-[kinesis-example-producer]: https://github.com/snowplow/kinesis-example-scala-consumer
+[aws-dynamodb]: http://aws.amazon.com/dynamodb
 [vagrant-install]: http://docs.vagrantup.com/v2/installation/index.html
 [virtualbox-install]: https://www.virtualbox.org/wiki/Downloads
-[snowplow-kinesis]: https://github.com/snowplow/snowplow/wiki/Install-Scala-Kinesis-Enrich
 [tim-b]: https://github.com/Tim-B
 [tim-b-post]: http://hipsterdevblog.com/blog/2014/12/07/writing-functions-for-aws-lambda-using-npm-and-grunt/
-[grunt-aws-lambda]: https://github.com/Tim-B/grunt-aws-lambda
-[blog-post]: http://snowplowanalytics.com/blog/2015/06/10/spark-streaming-example-project-0.1.0-released/
-[dynamodb-table-image]: /docs/dynamodb-table-image.png?raw=true
-[spark-streaming]: https://spark.apache.org/streaming/
-[kinesis]: http://aws.amazon.com/kinesis
-[dynamodb]: http://aws.amazon.com/dynamodb
+[amazon-kinesis-aggregators]: https://github.com/awslabs/amazon-kinesis-aggregators
+
 [snowplow]: http://snowplowanalytics.com
 [icebucket]: https://github.com/snowplow/icebucket
-[aws-lambda]: http://aws.amazon.com/lambda
-[vagrant-install]: http://docs.vagrantup.com/v2/installation/index.html
-[virtualbox-install]: https://www.virtualbox.org/wiki/Downloads
-[spark-example-project]: https://github.com/snowplow/spark-example-project
-[spark-streaming-example-project]: https://github.com/snowplow/spark-streaming-example-project
-[grunt-image]: https://cdn.gruntjs.com/builtwith.png
-
-
-[license]: http://www.apache.org/licenses/LICENSE-2.

dist/.gitignore

@@ -0,0 +1,3 @@
+# Nothing in dist gets saved to version control
+*
+!.gitignore

vagrant/up.guidance

@@ -3,4 +3,4 @@ vagrant ssh
 cd /vagrant
 npm install grunt
 npm install
-grunt
+grunt --help

vagrant/up.playbooks

@@ -1,5 +1,3 @@
 oss-playbooks/nodejs.yml
-oss-playbooks/grunt.yml
 oss-playbooks/aws-cli-and-psql.yml
-oss-playbooks/invoke.yml
-oss-playbooks/jq.yml
+oss-playbooks/grunt.yml