Merge pull request #57 from ostdotcom/develop

Merging develop to release 1.0

Author: Kedar Chandrayan

.jsdoc.json

@@ -5,7 +5,7 @@ branches:
   only:
   - master
   - develop
-  - review-changes-2805
+  - /^release-.*/
 notifications:
   email:
     recipients:
@@ -33,8 +33,10 @@ before_script:
   - mkdir -p dynamodb_instance_2
   - nohup java -Djava.library.path=./dynamodb/DynamoDBLocal_lib -jar DynamoDBLocal.jar -sharedDb &
   - nohup java -Djava.library.path=./dynamodb/DynamoDBLocal_lib -jar DynamoDBLocal.jar -sharedDb -dbPath ./dynamodb_instance_2 -port 8001 &
+  - sleep 30
 script:
   - node_modules/mocha/bin/mocha tests/mocha/services/dynamodb/* --timeout 10000 --exit
 after_script:
   - kill $(ps aux | grep 'DynamoDBLocal.jar' | awk '{print $2}')
-  - rm -rf dynamodb
+  - rm -rf dynamodb
+  - rm -rf dynamodb_instance_2

.travis.yml

@@ -1,18 +1,24 @@
-## OpenST-Storage v1.0.2
-- Common style guide followed across all openst repos using prettier ([openst-storage#21](https://github.com/OpenSTFoundation/openst-storage/issues/21))
-- Environment variables were a hard dependency. These lead to problems when multiple instances of OpenST-Storage are needed, 
+## Storage v1.0.3
+- Integrated with new Instance Composer.
+- Migrated to ES6.
+- Migrated repository from OpenST Foundation to OST organization and renamed it.
+- Removed TokenBalance Model and Cache.
+
+## Storage v1.0.2
+- Common style guide followed across all OST repos using prettier ([Storage#21](https://github.com/ostdotcom/storage/issues/21))
+- Environment variables were a hard dependency. These lead to problems when multiple instances of OST Storage are needed, 
     each having connection to different cache instances (for example). Thus making scaling not possible. Instead of reading 
-    the environment variables, we now depend on config object passed in the OpenST Storage constructor. Thus 2 objects of 
-    OpenST Storage can have totally different config strategies and thus will not interfere amongst each other.
-    ([openst-storage#20](https://github.com/OpenSTFoundation/openst-storage/issues/20))
-- Integrated use of Amazon DynamoDB Accelerator (DAX) to speed up certain actions ([openst-storage#18](https://github.com/OpenSTFoundation/openst-storage/issues/18))
+    the environment variables, we now depend on config object passed in the OST Storage constructor. Thus 2 objects of 
+    OST Storage can have totally different config strategies and thus will not interfere amongst each other.
+    ([Storage#20](https://github.com/ostdotcom/storage/issues/20))
+- Integrated use of Amazon DynamoDB Accelerator (DAX) to speed up certain actions ([Storage#18](https://github.com/ostdotcom/storage/issues/18))
 - Exposed models/dynamodb/base. It is the base class for all models which use sharded tables.
 - Restructured model directory.
 - Updated versions for dependencies to resolve package vulnerabilities.
 - Available shards and managed shards tables are deprecated.
 
-## OpenST-Storage v1.0.0
-- OpenST Storage contains storage and sharding related services.
+## Storage v1.0.0
+- OST Storage contains storage and sharding related services.
 - Wrapper services over Dynamo DB AWS SDK.
 - Auto Scale services to scale read/write capacity of DynamoDB tables.
 - Cache layer on top of Shard management services.

CHANGELOG.md

@@ -1,55 +1,60 @@
-# OpenST Storage
+Storage
+============
+[![Latest version](https://img.shields.io/npm/v/@ostdotcom/storage.svg?maxAge=3600)][npm]
+[![Build Status](https://travis-ci.org/ostdotcom/storage.svg?branch=develop)][travis]
+[![Downloads per month](https://img.shields.io/npm/dm/@ostdotcom/storage.svg?maxAge=3600)][npm]
 
-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.
+[npm]: https://www.npmjs.com/package/@ostdotcom/storage
+[travis]: https://travis-ci.org/ostdotcom/storage
+
+
+OST Storage contains DB storage libraries and respective services. It also contains data sharding libraries and services. 
 
 ##### Constructor parameters:
 There is 1 parameter required while creating the storage implementer.
 * First parameter is mandatory and it specifies the configuration strategy to be used. An example of the configStrategy is: 
 ```js
-configStrategy = {
-  OST_DEBUG_ENABLED:'1',
-  OS_DYNAMODB_API_VERSION: '2012-08-10',
-  OS_DYNAMODB_ACCESS_KEY_ID: 'x',
-  OS_DYNAMODB_SECRET_ACCESS_KEY: 'x',
-  OS_DYNAMODB_REGION: 'localhost',
-  OS_DYNAMODB_ENDPOINT: 'http://localhost:8000',
-  OS_DYNAMODB_SSL_ENABLED: '0',
-  OS_DYNAMODB_LOGGING_ENABLED: '1',
-  AUTO_SCALE_DYNAMO: '0',
-
-  OS_AUTOSCALING_API_VERSION: '2016-02-06' ,
-  OS_AUTOSCALING_ACCESS_KEY_ID: 'x' ,
-  OS_AUTOSCALING_SECRET_ACCESS_KEY: 'x' ,
-  OS_AUTOSCALING_REGION: 'localhost',
-  OS_AUTOSCALING_ENDPOINT: 'http://localhost:8000',
-  OS_AUTOSCALING_SSL_ENABLED: '0',
-  OS_AUTOSCALING_LOGGING_ENABLED: '1',
-
-  OS_DYNAMODB_TABLE_NAME_PREFIX: 'd_pk_',
-  OST_CACHING_ENGINE: 'memcached',
-  OST_CACHE_CONSISTENT_BEHAVIOR: 1,
-  OST_REDIS_HOST: '127.0.0.1',
-  OST_REDIS_PORT: 6379,  
-  OST_REDIS_PASS: 'st123',
-  OST_REDIS_TLS_ENABLED: 0,
-  OST_DEFAULT_TTL: '36000',
-  OST_CACHE_ENDPOINT: '127.0.0.1:6379',
-  OST_MEMCACHE_SERVERS: '127.0.0.1:11211'
-};
+configStrategy = 
+{
+  "cache": {
+    "engine": "memcached",
+    "servers": [
+      "127.0.0.1:11211"
+    ],
+    "defaultTtl": 36000
+  },
+  "storage": {
+    "endpoint": "http://localhost:8000",
+    "region": "localhost",
+    "apiVersion": "2012-08-10",
+    "apiKey": "X",
+    "apiSecret": "X",
+    "enableSsl": "0",
+    "enableLogging": "0",
+    "enableAutoscaling": "0",
+    "tablePrefix":"X",
+    "maxRetryCount":"1",
+    "autoScaling": {
+      "endpoint": "http://localhost:8000",
+      "region": "localhost",
+      "apiKey": "X",
+      "apiSecret": "X",
+      "apiVersion": "2012-08-10",
+      "enableSsl": "0"
+    }
+  }
+}
 ```
 
 ## DynamoDB Apis
 
 For all DynamoDB methods parameters description please refer [AWS DynamoDB Docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html)  
 
-Note: Response of all the apis is in [ResponseHelper](https://github.com/OpenSTFoundation/openst-base/blob/master/lib/formatter/response_helper.js) object wrapped in Promise.
-
 #### DynamoDB constructor 
   params [dynamodbConnectionParams](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#constructor-property)
 ```js
-  const OpenSTStorage = require('@openstfoundation/openst-storage');
-  let storage = OpenSTStorage.getInstance( configStrategy );
+  const OSTStorage = require('@ostdotcom/storage');
+  let storage = OSTStorage.getInstance( configStrategy );
   let ddbServiceObj = storage.dynamoDBService;
 ```
 
@@ -262,8 +267,8 @@ Note: Response of all the apis is in [ResponseHelper](https://github.com/OpenSTF
 &nbsp; AutoScaling params [autoScalingConnectionParams](#autoscaling-constructor)<br/>
 
 ```js
-  const OpenSTStorage = require('@openstfoundation/openst-storage');
-  let storage = OpenSTStorage.getInstance( configStrategy );
+  const OSTStorage = require('@ostdotcom/storage');
+  let storage = OSTStorage.getInstance( configStrategy );
   let ddbServiceObj = storage.dynamoDBService;
   let shardManagementObj = ddbServiceObj.shardManagement();
   let autoScalingObj = storage.autoScalingService;
@@ -354,8 +359,8 @@ For Parameters description please refer [AWS DynamoDB Docs](https://docs.aws.ama
 &nbsp; params [autoScalingConnectionParams](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/ApplicationAutoScaling.html#constructor-property)
 
 ```js
-  const OpenSTStorage = require('@openstfoundation/openst-storage');
-  let storage = OpenSTStorage.getInstance( configStrategy );
+  const OSTStorage = require('@ostdotcom/storage');
+  let storage = OSTStorage.getInstance( configStrategy );
   let autoScalingObj = storage.autoScalingService;
 ```
       

README.md

@@ -1 +1 @@
-1.0.2
+1.0.3

VERSION

@@ -0,0 +1,30 @@
+{
+  "ddbTablePrefix": "de_ma_",
+  "cache": {
+    "engine": "memcached",
+    "servers": [
+      "127.0.0.1:11211"
+    ],
+    "defaultTtl": 36000
+  },
+  "storage": {
+    "endpoint": "http://localhost:8000",
+    "region": "localhost",
+    "apiVersion": "2012-08-10",
+    "apiKey": "X",
+    "apiSecret": "X",
+    "enableSsl": "0",
+    "enableLogging": "0",
+    "enableAutoscaling": "0",
+    "enableDax": "0",
+    "maxRetryCount": 10,
+    "autoScaling": {
+      "endpoint": "http://localhost:8000",
+      "region": "localhost",
+      "apiKey": "X",
+      "apiSecret": "X",
+      "apiVersion": "2012-08-10",
+      "enableSsl": "0"
+    }
+  }
+}

config.json

@@ -0,0 +1,62 @@
+'use strict';
+
+/**
+ * Load all the core constants from the environment variables OR define them as literals here and export them.
+ *
+ * @module config/coreConstant
+ *
+ */
+
+const rootPrefix = '..',
+  paramErrorConfig = require(rootPrefix + '/config/error/param'),
+  apiErrorConfig = require(rootPrefix + '/config/error/general');
+
+/**
+ * Constructor for core constants
+ *
+ * @constructor
+ */
+const CoreConstant = function() {
+  const oThis = this;
+
+  // Generic env variable across NPM packages
+  oThis.DEBUG_ENABLED = process.env.OST_DEBUG_ENABLED;
+
+  oThis.DAX_API_VERSION = '';
+  oThis.DAX_ACCESS_KEY_ID = '';
+  oThis.DAX_SECRET_ACCESS_KEY = '';
+  oThis.DAX_REGION = '';
+  oThis.DAX_ENDPOINT = '';
+  oThis.DAX_SSL_ENABLED = '';
+};
+
+CoreConstant.prototype = {
+  // Generic env variable across NPM packages
+  DEBUG_ENABLED: null,
+
+  ERROR_CONFIG: {
+    param_error_config: paramErrorConfig,
+    api_error_config: apiErrorConfig
+  },
+
+  get icNameSpace() {
+    return 'OSTStorage';
+  },
+
+  // in ms fixed time after which we would retry
+  fixedRetryAfterTime: function() {
+    return 25;
+  },
+
+  // in ms variable time (which is incremented after every iteration) which we would retry
+  variableRetryAfterTime: function() {
+    return 25;
+  },
+
+  // default retry count
+  defaultRetryCount: function() {
+    return 50;
+  }
+};
+
+module.exports = new CoreConstant();