Initial structure of dynamodb connector for LoopBack

Author: claylo

.eslintrc

@@ -0,0 +1,12 @@
+env:
+  node: true
+
+plugins:
+  - nodeca
+
+rules:
+  nodeca/indent: 2
+  quotes: 'single'
+
+ignore-path:
+  - .eslintignore

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+coverage

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2014 Clay Loveless <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the “Software”), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,13 @@
+## TESTS
+
+TESTER = ./node_modules/.bin/mocha
+OPTS = -G --timeout 10000
+TESTS = test/*.test.js
+
+test:
+	$(TESTER) $(OPTS) $(TESTS)
+test-verbose:
+	$(TESTER) $(OPTS) --reporter spec $(TESTS)
+testing:
+	$(TESTER) $(OPTS) --watch $(TESTS)
+.PHONY: test docs

README.md

@@ -0,0 +1,69 @@
+## loopback-connector-dynamodb
+
+DynamoDB connector for loopback-datasource-juggler. Because Dynamo doesn't get enough love.
+
+## DynamoDB connector
+
+ * Installation
+ * Creating a DynamoDB data source
+   * Properties
+ * Using the DynamoDB connector
+   * Local development with DynamoDB Local
+
+### Installation
+
+In your application root directory, enter:
+
+    $ npm install loopback-connector-dynamodb --save
+
+This will install the module from npm and add it as a depenency to the application's [package.json](http://docs.strongloop.com/display/LB/package.json) file.
+
+### Creating a DynamoDB data source
+
+Use the [Datasource generator](http://docs.strongloop.com/display/LB/Datasource+generator) to add a DynamoDB data source to your application. The entry in the application's `/server/datasources.json` will look like this:
+
+```json
+"mydb": {
+  "name": "mydb",
+  "connector": "dynamodb"
+}
+```
+
+Edit `datasources.json` to add other properties to enable you to connect the data source to a DynamoDB database.
+
+### Properties
+
+Property | Type | Description
+-------- | ---- | -----------
+connector | String | Connector name, either `loopback-connector-dynamodb` or `dynamodb`
+region | String | AWS Region to connect to. May also be set to `local` to use an instance of DynamoDB Local.
+debug | Boolean | If `true`, turn on verbose mode to debug requests and lifecycle.
+credentials | String | Method to locate credentials for the AWS SDK for Javascript. Valid values are: `env`, `shared`, `iamrole`, `file`. Default value: `shared`.
+credfile | String | If credentials method is `file`, specify the location of the JSON file to load.
+profile | String | Name the profile to use if using the `shared` credentials method.
+endpoint | Number | URL to use connecting to DynamoDB Local. Default is `8000`. Example: `http://localhost:8000/` Note: this property is ignored if `region` is not `local`.
+
+For example:
+
+*Example datasources.json file*
+```json
+{
+  "dynamo_dev": {
+    "name": "dynamo_dev",
+    "connector": "dynamodb",
+    "region": "local",
+    "credentials": "shared",
+    "profile": "localdev",
+    "port": 4567
+  },
+  "dynamo_qa": {
+    "name": "dynamo_qa",
+    "connector": "dynamodb",
+    "region": "us-west-2",
+    "credentials": "iamrole"
+  }
+}
+```
+
+:warning: You can't specify `aws_access_key_id` and `aws_secret_access_key` directly in your `datasources.json` file.
+This is intentional. Putting credentials like that into a file are A Very Bad Thing. Quit trying to do that.

docs.json

@@ -0,0 +1,8 @@
+{
+"content": [
+    {"title": "LoopBack DynamoDB Connector API", "depth": 2},
+    "lib/dynamodb.js"
+  ],
+  "codeSectionDepth": 3
+}
+

index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/dynamodb');