@barchart/portfolio-client-js 3.3.0 → 3.4.1

package/.releases/3.3.0.md

@@ -1,3 +1,3 @@
 **New Features**
 
-* Added ```product``` to the ```PortfolioGateway```.
+* Added optional ```product``` argument to the ```PortfolioGateway``` constructor.

package/.releases/3.4.0.md

@@ -0,0 +1,3 @@
+**New Features**
+
+* Added ```PortfolioGateway.readMarketValue``` function.

package/.releases/3.4.1.md

@@ -0,0 +1,3 @@
+**Bug Fix**
+
+* Fixed ```PortfolioGateway.readMarketValue``` function.

package/lib/gateway/PortfolioGateway.js

@@ -44,7 +44,7 @@ module.exports = (() => {
 	 * @param {String} host - The hostname of the Portfolio web service.
 	 * @param {Number} port - The TCP port number of the Portfolio web service.
 	 * @param {String} environment - A description of the environment we're connecting to.
-	 * @param {String=} product - A product code which uses the gateway.
+	 * @param {String=} product - A code for the product which is using the gateway.
 	 * @extends {Disposable}
 	 */
 	class PortfolioGateway extends Disposable {
@@ -424,6 +424,23 @@ module.exports = (() => {
 				.withErrorInterceptor(ErrorInterceptor.GENERAL)
 				.endpoint;
 
+			this._readMarketValueEndpoint = EndpointBuilder.for('read-market-value', 'read market value')
+				.withVerb(VerbType.GET)
+				.withProtocol(protocolType)
+				.withHost(host)
+				.withPort(port)
+				.withPathBuilder((pb) => {
+					pb.withLiteralParameter('version', 'v1')
+						.withLiteralParameter('values', 'values');
+				})
+				.withQueryBuilder((qb) => {
+					qb.withVariableParameter('symbol', 'symbol', 'symbol', false);
+				})
+				.withRequestInterceptor(requestInterceptor)
+				.withResponseInterceptor(ResponseInterceptor.DATA)
+				.withErrorInterceptor(ErrorInterceptor.GENERAL)
+				.endpoint;
+
 			this._brokerageReportUrlGenerator = (user, portfolio, frame, end) => {
 				return `https://${Configuration.getBrokerageHost(host)}/reports/portfolios/${portfolio}/frames/${frame.code}/date/${end.format()}/${user}`;
 			};
@@ -1129,6 +1146,25 @@ module.exports = (() => {
 				});
 		}
 
+		/**
+		 * Returns all market value for a symbol.
+		 *
+		 * @public
+		 * @param {String} symbol
+		 */
+		readMarketValue(symbol) {
+			return Promise.resolve()
+				.then(() => {
+					assert.argumentIsRequired(symbol, 'symbol', String);
+
+					const payload = { };
+
+					payload.symbol = symbol;
+
+					return Gateway.invoke(this._readMarketValueEndpoint, payload);
+				});
+		}
+
 		/**
 		 * Generates a URL suitable for downloading a brokerage report (as a PDF).
 		 *
@@ -1186,14 +1222,16 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {JwtProvider} jwtProvider
+		 * @param {String=} product
 		 * @returns {Promise<PortfolioGateway>}
 		 */
-		static forTest(jwtProvider) {
+		static forTest(jwtProvider, product) {
 			return Promise.resolve()
 				.then(() => {
 					assert.argumentIsRequired(jwtProvider, 'jwtProvider', JwtProvider, 'JwtProvider');
+					assert.argumentIsOptional(product, 'product', String);
 
-					return start(new PortfolioGateway(REST_API_SECURE_PROTOCOL, Configuration.testHost, REST_API_SECURE_PORT, 'test'), jwtProvider);
+					return start(new PortfolioGateway(REST_API_SECURE_PROTOCOL, Configuration.testHost, REST_API_SECURE_PORT, 'test', product), jwtProvider);
 				});
 		}
 
@@ -1203,14 +1241,16 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {JwtProvider} jwtProvider
+		 * @param {String=} product
 		 * @returns {Promise<PortfolioGateway>}
 		 */
-		static forDevelopment(jwtProvider) {
+		static forDevelopment(jwtProvider, product) {
 			return Promise.resolve()
 				.then(() => {
 					assert.argumentIsRequired(jwtProvider, 'jwtProvider', JwtProvider, 'JwtProvider');
+					assert.argumentIsOptional(product, 'product', String);
 
-					return start(new PortfolioGateway(REST_API_SECURE_PROTOCOL, Configuration.developmentHost, REST_API_SECURE_PORT, 'development'), jwtProvider);
+					return start(new PortfolioGateway(REST_API_SECURE_PROTOCOL, Configuration.developmentHost, REST_API_SECURE_PORT, 'development', product), jwtProvider);
 				});
 		}
 
@@ -1220,14 +1260,16 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {JwtProvider} jwtProvider
+		 * @param {String=} product
 		 * @returns {Promise<PortfolioGateway>}
 		 */
-		static forStaging(jwtProvider) {
+		static forStaging(jwtProvider, product) {
 			return Promise.resolve()
 				.then(() => {
 					assert.argumentIsRequired(jwtProvider, 'jwtProvider', JwtProvider, 'JwtProvider');
+					assert.argumentIsOptional(product, 'product', String);
 
-					return start(new PortfolioGateway(REST_API_SECURE_PROTOCOL, Configuration.stagingHost, REST_API_SECURE_PORT, 'staging'), jwtProvider);
+					return start(new PortfolioGateway(REST_API_SECURE_PROTOCOL, Configuration.stagingHost, REST_API_SECURE_PORT, 'staging', product), jwtProvider);
 				});
 		}
 
@@ -1237,14 +1279,16 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {JwtProvider} jwtProvider
+		 * @param {String=} product
 		 * @returns {Promise<PortfolioGateway>}
 		 */
-		static forDemo(jwtProvider) {
+		static forDemo(jwtProvider, product) {
 			return Promise.resolve()
 				.then(() => {
 					assert.argumentIsRequired(jwtProvider, 'jwtProvider', JwtProvider, 'JwtProvider');
+					assert.argumentIsOptional(product, 'product', String);
 
-					return start(new PortfolioGateway(REST_API_SECURE_PROTOCOL, Configuration.demoHost, REST_API_SECURE_PORT, 'demo'), jwtProvider);
+					return start(new PortfolioGateway(REST_API_SECURE_PROTOCOL, Configuration.demoHost, REST_API_SECURE_PORT, 'demo', product), jwtProvider);
 				});
 		}
 
@@ -1254,14 +1298,16 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {JwtProvider} jwtProvider
+		 * @param {String=} product
 		 * @returns {Promise<PortfolioGateway>}
 		 */
-		static forProduction(jwtProvider) {
+		static forProduction(jwtProvider, product) {
 			return Promise.resolve()
 				.then(() => {
 					assert.argumentIsRequired(jwtProvider, 'jwtProvider', JwtProvider, 'JwtProvider');
+					assert.argumentIsOptional(product, 'product', String);
 
-					return start(new PortfolioGateway(REST_API_SECURE_PROTOCOL, Configuration.productionHost, REST_API_SECURE_PORT, 'production'), jwtProvider);
+					return start(new PortfolioGateway(REST_API_SECURE_PROTOCOL, Configuration.productionHost, REST_API_SECURE_PORT, 'production', product), jwtProvider);
 				});
 		}
 
@@ -1271,14 +1317,16 @@ module.exports = (() => {
 		 * @public
 		 * @static
 		 * @param {JwtProvider} jwtProvider
+		 * @param {String=} product
 		 * @returns {Promise<PortfolioGateway>}
 		 */
-		static forAdmin(jwtProvider) {
+		static forAdmin(jwtProvider, product) {
 			return Promise.resolve()
 				.then(() => {
 					assert.argumentIsRequired(jwtProvider, 'jwtProvider', JwtProvider, 'JwtProvider');
+					assert.argumentIsOptional(product, 'product', String);
 
-					return start(new PortfolioGateway(REST_API_SECURE_PROTOCOL, Configuration.adminHost, REST_API_SECURE_PORT, 'admin'), jwtProvider);
+					return start(new PortfolioGateway(REST_API_SECURE_PROTOCOL, Configuration.adminHost, REST_API_SECURE_PORT, 'admin', product), jwtProvider);
 				});
 		}
 

package/lib/index.js

@@ -7,6 +7,6 @@ module.exports = (() => {
 	return {
 		JwtProvider: JwtProvider,
 		PortfolioGateway: PortfolioGateway,
-		version: '3.3.0'
+		version: '3.4.1'
 	};
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@barchart/portfolio-client-js",
-  "version": "3.3.0",
+  "version": "3.4.1",
   "description": "JavaScript library for interfacing with Barchart's Portfolio API",
   "author": {
     "name": "Bryan Ingle",