Readme copied from AWS event mocks. Newlines

Author: astuyve

README.md

@@ -0,0 +1,82 @@
+# Event Mocks
+A small library that includes details mocks of AWS Lambda event sources. Useful for use when unit testing your Lambda functions. Supported Event Sources are: SNS, API Gateway, S3, & Scheduled.
+
+The library simply uses default event source mock templates and merge it with any overwrite you provide. [Check out the JSON template files](./lib/events) to learn more about the data structure of each event source.
+
+## Usage
+
+### SNS
+
+```js
+const createEvent = require('aws-event-mocks');
+const mocked = createEvent({
+  template: 'aws:sns',
+  merge: {
+    Records: [{
+      Sns: {
+        Message: 'trigger-email'
+      }
+    }]
+  }
+});
+```
+
+### API Gateway
+
+```js
+const createEvent = require('aws-event-mocks');
+const event = createEvent({
+  template: 'aws:apiGateway',
+  merge: {
+    body: {
+      first_name: 'Sam',
+      last_name: 'Smith'
+    }
+  }
+});
+```
+
+### S3
+
+```js
+const createEvent = require('aws-event-mocks');
+const event = createEvent({
+  template: 'aws:s3',
+  merge: {
+    Records: [{
+      eventName: 'ObjectCreated:Put',
+      s3: {
+        bucket: {
+          name: 'my-bucket-name'
+        },
+        object: {
+          key: 'object-key'
+        }
+      }
+    }]
+  }
+});
+```
+
+### Scheduled
+
+```js
+const createEvent = require('aws-event-mocks');
+const event = createEvent({
+  template: 'aws:scheduled',
+  merge: {
+    region: 'us-west-2'
+  }
+});
+```
+
+### Kinesis
+
+```js
+const createEvent = require('aws-event-mocks');
+const event = createEvent({
+  template: 'aws:kinesis',
+  merge: {
+    data: new Buffer('this is test data').toString('base64')
+  }
+});

globals.d.ts

@@ -1,4 +1,4 @@
 declare module '*.json' {
   const value: any;
   export default value;
-  }
+  }

lib/events/aws/api-gateway-event-template.json

@@ -38,4 +38,4 @@
     "user": ""
   },
   "stageVariables": {}
-}
+}

lib/events/aws/dynamo-stream-event-template.json

@@ -27,4 +27,4 @@
       "eventSource": "aws:dynamodb"
     }
   ]
-}
+}

lib/events/aws/kinesis-template.json

@@ -17,4 +17,4 @@
       }
     }
   ]
-}
+}

lib/events/aws/s3-template.json

@@ -35,4 +35,4 @@
       }
     }
   ]
-}
+}

lib/events/aws/scheduled-template.json

@@ -10,4 +10,4 @@
     "arn:aws:events:us-east-1:123456789:rule/test-service-rule"
   ],
   "detail": {}
-}
+}

lib/events/aws/sns-template.json

@@ -19,4 +19,4 @@
       }
     }
   ]
-}
+}

lib/events/aws/sqs-template.json

@@ -17,4 +17,4 @@
           "awsRegion": "us-east-2"
       }
   ]
-}
+}

lib/index.spec.ts

@@ -145,4 +145,4 @@ describe('createKinesisEvent()', function () {
 
     expect(new Buffer(event.Records[0].kinesis.data, 'base64').toString('ascii')).to.equal('kinesis test')
   })
-})
+})