Merge pull request #4 from OpenSTFoundation/develop

Merge of develop to master

Author: Abhay Kumar Singh

.jsdoc.json

@@ -0,0 +1,37 @@
+{
+  "tags": {
+    "allowUnknownTags": true
+  },
+  "source": {
+    "include": ["config/", "lib/", "services/"],
+    "exclude": [],
+    "includePattern": ".+\\.js(doc|x)?$",
+    "excludePattern": "(^|\\/|\\\\)_"
+  },
+  "plugins": [
+    "jsdoc-route-plugin"
+  ],
+  "recurseDepth": 5,
+  "templates": {
+    "systemName"            : "OpenST Storage",
+    "footer"                : "<style>.copyright, .jsdoc-message, footer { color: #555555;} footer { border-color:#eeeeee;} }</style>",
+    "copyright"             : "OpenST Foundation Ltd.",
+    "includeDate"           : false,
+    "theme"                 : "lumen",
+    "navType"               : "vertical",
+    "linenums"              : true,
+    "cleverLinks"           : true,
+    "monospaceLinks"        : true,
+    "default": {
+      "outputSourceFiles": true
+    }
+  },
+  "opts": {
+    "destination": "./docs/",
+    "encoding": "utf8",
+    "private": true,
+    "recurse": true,
+    "template": "./node_modules/ink-docstrap/template",
+    "readme": "./README.md"
+  }
+}

CHANGELOG.md

@@ -1,7 +1,5 @@
-## OpenST-Storage v1.0.0-beta.1 (23 May 2018)
+## OpenST-Storage v1.0.0 (24 May 2018)
 
-- OpenST Storage repository is created. Its main purpose is to provide storage related services.
-- Dynamodb services to create, put, get, update, delete and many other dynamodb related services is added.
-- Auto Scale services to scale tables in AWS is added.
-- Client side Shard Management services is added to manage scalable tables.
-- Cache multi management added for services performing data retrieval.
+- OpenST Storage contains storage and sharding related services.
+- Auto Scale services to scale read/write capacity of DynamoDB tables.
+- Cache layer on top of Shard management services.

README.md

@@ -1,138 +1,137 @@
 # OpenST Storage
 
-It has DB storage libraries and respective services. It also contains shard management libraries and services. 
+OpenST Storage contains DB storage libraries and respective services. It also contains data sharding libraries and services. 
 While OpenST Storage is available as-is for anyone to use, we caution that this is early stage software and under heavy ongoing development and improvement. Please report bugs and suggested improvements.
 
-# OpenST Dynamodb Services
+# DynamoDB Services
 
-```bash
+For Parameters description please refer [AWS DynamoDB Docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html)
 
-For Parametes description refer - https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html
+```bash
 
-const OSTBase = require('@openstfoundation/openst-base')
-    , DynamodbApiObject  = new OSTBase.Dynamodb(DynamodbConnectionParams)
+const OSTStorage = require('@openstfoundation/openst-storage')
+    , ddbServiceObj  = new OSTStorage.Dynamodb(dynamodbConnectionParams)
    ;
 
-    //Create Dynamodb Table
-    DynamodbApiObject.DynamodbApiObject(createTableParams);
+    //Create DynamoDB Table
+    ddbServiceObj.createTable(createTableParams);
 
     // Create Table Migration
     // 1. Creates table
-    // 2. Enables ContinuousBackup 
-    // 3. Enables read/write auto scaling
-    // 4. Returns describe table response 
-    DynamodbApiObject.createTableMigration(createTableMigrationParams);
+    // 2. Enables read/write auto scaling
+    // 3. Returns describe table response 
+    ddbServiceObj.createTableMigration(createTableMigrationParams);
 
-    // Update Dynamodb Table
-    DynamodbApiObject.updateTable(updateTableParams)
+    // Update DynamoDB Table
+    ddbServiceObj.updateTable(updateTableParams)
 
-    // Describe Dynamodb Table 
-    DynamodbApiObject.describeTable(describeTableParams)
+    // Describe DynamoDB Table 
+    ddbServiceObj.describeTable(describeTableParams)
 
-    // List Dynamodb Tables
-    DynamodbApiObject.describeTable(listTableParams)
+    // List DynamoDB Tables
+    ddbServiceObj.describeTable(listTableParams)
 
-    // Point in time recovery for Dynamodb Table
-    DynamodbApiObject.updateContinuousBackup(updateConitnousParams)
+    // Point in time recovery for DynamoDB Table
+    ddbServiceObj.updateContinuousBackup(updateConitnousParams)
 
-    // Delete Dynamodb table
-    DynamodbApiObject.deleteTable(deleteTableParams)
+    // Delete DynamoDB table
+    ddbServiceObj.deleteTable(deleteTableParams)
 
     // Batch Get Items
-    DynamodbApiObject.batchGet(batchGetParams)
+    ddbServiceObj.batchGet(batchGetParams)
 
     // Batch Write Items
-    DynamodbApiObject.batchWrite(batchWriteParams)
+    ddbServiceObj.batchWrite(batchWriteParams)
 
     // Query Items
-    DynamodbApiObject.query(queryParams)
+    ddbServiceObj.query(queryParams)
 
     // Scan Items
-    DynamodbApiObject.scan(queryParams)
+    ddbServiceObj.scan(queryParams)
 
     // Put Items
-    DynamodbApiObject.putItem(putItemParams)
+    ddbServiceObj.putItem(putItemParams)
 
     // Update an Item
-    DynamodbApiObject.updateItem(updateItemParams)
+    ddbServiceObj.updateItem(updateItemParams)
 
     // Delete Items
-    DynamodbApiObject.deleteItem(deleteItemParams)
+    ddbServiceObj.deleteItem(deleteItemParams)
 
-    // Check if table exists using wait for method
-    DynamodbApiObject.tableExistsUsingWaitFor(tableExistsParams)
+    // Check if table exists and is in ACTIVE state using wait for method
+    ddbServiceObj.tableExistsUsingWaitFor(tableExistsParams)
 
     // Check if table doesn't exists using wait for method
-    DynamodbApiObject.tableNotExistsUsingWaitFor(tableNotExistsParams)
+    ddbServiceObj.tableNotExistsUsingWaitFor(tableNotExistsParams)
     
     // Check if table exist in ACTIVE state using describe table method
     // If table is being created, then response will be false
-    DynamodbApiObject.checkTableExist(tableExistParams)
+    ddbServiceObj.checkTableExist(tableExistParams)
     
 ```
 
-# OpenST Shard Management Services
+# Shard Management Services
 
 ```bash
-const OSTBase = require('@openstfoundation/openst-base')
-    , DynamodbApiObject  = new OSTBase.Dynamodb(DynamodbConnectionParams)
-    , ShardManagementObject = DynamodbApiObject.shardManagement()
+const OSTStorage = require('@openstfoundation/openst-storage')
+    , ddbServiceObj  = new OSTStorage.Dynamodb(dynamodbConnectionParams)
+    , shardMgmtObj = ddbServiceObj.shardManagement()
    ;
     
     // Run Shard Migration
     // Created available_shards and managed_shards table
-    ShardManagementObject.runShardMigration(dynamoDbObject, autoScaleObj);
+    shardMgmtObj.runShardMigration(dynamoDbObject, autoScaleObj);
     
     // Add Shard
     // Creates item in available_shards table
-    ShardManagementObject.addShard(addShardParams);
+    shardMgmtObj.addShard(addShardParams);
     
     // Configure Shard
     // Configure Enable/Disable allocation type
-    ShardManagementObject.configureShard(configureShardParams);
+    shardMgmtObj.configureShard(configureShardParams);
     
     // Get Shards By Different Types
     // Type Values : all/enabled/disabled
-    ShardManagementObject.getShardsByType(getShardsByTypeParams);
+    shardMgmtObj.getShardsByType(getShardsByTypeParams);
     
     // Does this shard exist in available_shards table
-    ShardManagementObject.hasShard(hasShardParams);
+    shardMgmtObj.hasShard(hasShardParams);
     
     // Assign Shard to an identifier
     // Creates entry in managed_shards table
-    ShardManagementObject.assignShard(assignShardParams);
+    shardMgmtObj.assignShard(assignShardParams);
     
     // Get Managed shards
-    ShardManagementObject.getManagedShard(managedShardParams);
+    shardMgmtObj.getManagedShard(managedShardParams);
     
 ```
 
-# OpenST Auto Scaling Services
+# Auto Scaling Services
 
-```bash
+For Parameters description please refer [AWS DynamoDB Docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ApplicationAutoScaling.html)
 
-For Parametes description refer - https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ApplicationAutoScaling.html
+```bash
 
-const OSTBase = require('@openstfoundation/openst-base')
-    , AutoScalingObject  = new OSTBase.AutoScaling(AutoScalingConnectionParams)
+const OSTStorage = require('@openstfoundation/openst-storage')
+    , autoScalingObj  = new OSTStorage.AutoScaling(autoScalingConnectionParams)
    ;
     
-    // Registers or updates a scalable target.  scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for its scalable dimension.
-    AutoScalingObject.registerScalableTarget(registerScalableTargetParams);
+    // Registers or updates a scalable target. Scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for its scalable dimension.
+    autoScalingObj.registerScalableTarget(registerScalableTargetParams);
     
     // Creates or updates a policy for an Application Auto Scaling scalable target
-    AutoScalingObject.putScalingPolicy(putScalingPolicyParams);
+    autoScalingObj.putScalingPolicy(putScalingPolicyParams);
     
     // Deletes the specified Application Auto Scaling scaling policy
-    AutoScalingObject.deleteScalingPolicy(deletecalingPolicyParams);
+    autoScalingObj.deleteScalingPolicy(deletecalingPolicyParams);
     
     // Deregistering a scalable target deletes the scaling policies that are associated with it.
-    AutoScalingObject.deregisterScalableTarget(deregisterScalableTargetParams);
+    autoScalingObj.deregisterScalableTarget(deregisterScalableTargetParams);
       
     // Gets information about the scalable targets in the specified namespace. 
-    AutoScalingObject.describeScalableTargets(describeScalableTargetsParams); 
+    autoScalingObj.describeScalableTargets(describeScalableTargetsParams); 
    
    // Describes the scaling policies for the specified service namespace.
-    AutoScalingObject.describeScalingPolicies(describeScalingPoliciesParams);   
+    autoScalingObj.describeScalingPolicies(describeScalingPoliciesParams);   
     
 ```

VERSION

@@ -0,0 +1 @@
+1.0.0

config/api_error_config.json

@@ -8,8 +8,8 @@
  */
 
 const rootPrefix = '..'
-  , paramErrorConfig = require(rootPrefix + '/config/param_error_config')
-  , apiErrorConfig = require(rootPrefix + '/config/api_error_config')
+  , paramErrorConfig = require(rootPrefix + '/config/error/param')
+  , apiErrorConfig = require(rootPrefix + '/config/error/general')
 ;
 
 /**