Merge branch 'v1' into patch-1

Author: rehrumesh

.github/ISSUE_TEMPLATE

@@ -0,0 +1,23 @@
+**Actual Behaviour**
+
+Please state here what is currently happening.
+
+**Expected Behaviour**
+
+State here what the feature should enable the user to do.
+
+**Steps to reproduce it**
+
+Add steps to reproduce bugs or add information on the place where the feature should be implemented. Add links to a sample deployment or code.
+
+**LogCat for the issue**
+
+Provide logs for the crash here
+
+**Screenshots of the issue**
+
+Where-ever possible attach a screenshot of the issue.
+
+**Would you like to work on the issue?**
+
+Please let us know if you can work on it or the issue should be assigned to someone else.

.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,7 @@
+Fixes issue #[Add issue number here. If you do not solve the issue entirely, please change the message e.g. "First steps for issues #IssueNumber]
+
+Changes: [Add here what changes were made in this issue and if possible provide links.]
+
+Demo Link: [Add here the link where your changes can be seen]
+
+Screenshots for the change: 

.travis.yml

@@ -4,8 +4,44 @@ node_js:
 
 sudo: false
 
+before_install:
+  - cd test
+  - mkdir sample-template
+  - cd sample-template
+  - npm init --yes
+
 install:
+  - npm install --save-dev serverless-offline 
+  - npm install -g [email protected]
+  - npm install aws-sdk
+  - npm install --save dynamodb-doc-client-wrapper
+  - serverless create --template aws-nodejs
+  - cd ..
+  - cd ..
+  - npm link
+  - cd test/sample-template/node_modules
+  - npm link serverless-dynamodb-local
+  - cd ..
+  - sed -i '18 a plugins:' serverless.yml
+  - sed -i '19 a - serverless-offline' serverless.yml
+  - sed -i '20 a - serverless-dynamodb-local' serverless.yml
+  - cd ..
+  - cd ..
+  - npm install --save-dev mocha
+  - npm install --save-dev should
+  - npm install --save expect
+  - npm install --save request
+  - npm install --save chai
   - travis_retry npm install
+  - cd test/sample-template
 
+before_script:
+  - sls dynamodb install
+  - sls offline start & 
+  - sleep 15
+  - cd .. 
+  - cd ..
+  - npm run test
+  
 script:
-  - npm test
+  - npm test

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

README.md

@@ -3,7 +3,7 @@ serverless-dynamodb-local
 
 [![Join the chat at https://gitter.im/99xt/serverless-dynamodb-local](https://badges.gitter.im/99xt/serverless-dynamodb-local.svg)](https://gitter.im/99xt/serverless-dynamodb-local?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![npm version](https://badge.fury.io/js/serverless-dynamodb-local.svg)](https://badge.fury.io/js/serverless-dynamodb-local)
-[![license](https://img.shields.io/npm/l/serverless-dynamodb-local.svg)](https://www.npmjs.com/package/serverless-dynamodb-local)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## This Plugin Requires
 * [email protected]
@@ -51,20 +51,32 @@ All CLI options are optional:
 --sharedDb                -h  DynamoDB will use a single database file, instead of using separate files for each credential and region. If you specify -sharedDb, all DynamoDB clients will interact with the same set of tables regardless of their region and credential configuration.
 --delayTransientStatuses  -t  Causes DynamoDB to introduce delays for certain operations. DynamoDB can perform some tasks almost instantaneously, such as create/update/delete operations on tables and indexes; however, the actual DynamoDB service requires more time for these tasks. Setting this parameter helps DynamoDB simulate the behavior of the Amazon DynamoDB web service more closely. (Currently, this parameter introduces delays only for global secondary indexes that are in either CREATING or DELETING status.)
 --optimizeDbBeforeStartup -o  Optimizes the underlying database tables before starting up DynamoDB on your computer. You must also specify -dbPath when you use this parameter.
+--migration               -m  After starting dynamodb local, run dynamodb migrations.
+--heapInitial                 The initial heap size 
+--heapMax                     The maximum heap size
 --migrate                 -m  After starting DynamoDB local, create DynamoDB tables from the Serverless configuration.
 --seed                    -s  After starting and migrating dynamodb local, injects seed data into your tables. The --seed option determines which data categories to onload.
+--convertEmptyValues      -e  Set to true if you would like the document client to convert empty values (0-length strings, binary buffers, and sets) to be converted to NULL types when persisting to DynamoDB.
 ```
 
 All the above options can be added to serverless.yml to set default configuration: e.g.
 
 ```yml
 custom:
   dynamodb:
+  # If you only want to use DynamoDB Local in some stages, declare them here
+    stages:
+      - dev
     start:
       port: 8000
       inMemory: true
+      heapInitial: 200m
+      heapMax: 1g
       migrate: true
       seed: true
+      convertEmptyValues: true
+    # Uncomment only if you already have a DynamoDB running locally
+    # noStart: true
 ```
 
 ##  Migrations: sls dynamodb migrate
@@ -95,13 +107,18 @@ resources:
           WriteCapacityUnits: 1
 ```
 
+**Note:**
+DynamoDB local doesn't support TTL specification, therefore plugin will simply ignore ttl configuration from Cloudformation template.
+
 ## Seeding: sls dynamodb seed
 ### Configuration
 
 In `serverless.yml` seeding categories are defined under `dynamodb.seed`.
 
 If `dynamodb.start.seed` is true, then seeding is performed after table migrations.
 
+If you wish to use raw AWS AttributeValues to specify your seed data instead of Javascript types then simply change the variable of any such json files from `sources:` to `rawsources:`.
+
 ```yml
 dynamodb:
   start:
@@ -117,7 +134,7 @@ dynamodb:
     test:
       sources:
         - table: users
-          sources: [./fake-test-users.json]
+          rawsources: [./fake-test-users.json]
         - table: subscriptions
           sources: [./fake-test-subscriptions.json]
 ```
@@ -181,6 +198,17 @@ Make sure that `serverless-dynamodb-local` is above `serverless-offline` so it w
 
 Now your local DynamoDB database will be automatically started before running `serverless offline`.
 
+### Using with serverless-offline and serverless-webpack plugin
+Run `serverless offline start`. In comparison with `serverless offline`, the `start` command will fire an `init` and a `end` lifecycle hook which is needed for serverless-offline and serverless-dynamodb-local to switch off both ressources. 
+
+Add plugins to your `serverless.yml` file:
+```yaml
+plugins:
+  - serverless-webpack
+  - serverless-dynamodb-local
+  - serverless-offline #serverless-offline needs to be last in the list
+```
+
 ## Reference Project
 * [serverless-react-boilerplate](https://github.com/99xt/serverless-react-boilerplate)