Merge pull request #3 from shweshi/dev

close #2 export data in json and csv

Author: shweshi

.gitignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -49,6 +49,8 @@ terminal-stocks -t [ticker] --historical [domain] // to see the historical price
 terminal-stocks --tickers ITC.NS,INFY.NS // to get the current prices of the multiple stocks
 terminal-stocks -m // to see the market summary
 terminal-stocks --market // to see the market summary
+terminal-stokcs --market --json // to export the data as json file
+terminal-stokcs --market --csv // to expor the data as csv file
 ```
 
 ### Example

app/services/csvService.js

@@ -0,0 +1,13 @@
+const fs = require('fs')
+const jsonexport = require('jsonexport');
+
+module.exports = {
+    csvExport: csvExport,
+};
+
+function csvExport(data) {
+    jsonexport(data, function (err, csv) {
+        if (err) return console.error(err);
+        fs.writeFileSync('terminal-stocks_' + Date.now() + '_.csv', csv);
+    })
+}

app/services/jsonService.js

@@ -0,0 +1,9 @@
+const fs = require('fs')
+
+module.exports = {
+    jsonExport: jsonExport,
+};
+
+function jsonExport(data) {
+    fs.writeFileSync('terminal-stocks_' + Date.now() + '_.json', JSON.stringify(data));
+}

app/transformer/responseTransformer.js

@@ -10,7 +10,9 @@ module.exports = {
   transformHistoricalPrices: transformHistoricalPrices,
   transformMarketSummary: transformMarketSummary,
   transformError: transformError,
-  transformChart: transformChart
+  transformChart: transformChart,
+  transformExportJsonSuccess: transformExportJsonSuccess,
+  transformExportCsvSuccess: transformExportCsvSuccess,
 };
 
 function transformChart(data) {
@@ -32,7 +34,7 @@ function transformChart(data) {
       x: time,
       y: data.indicators.quote[0].volume
     }
-    
+
   screen.append(line)
   line.setData([linedata])
   screen.key(['escape', 'q', 'C-c'], function (ch, key) {
@@ -149,5 +151,13 @@ function transformHistoricalPrices(data) {
 }
 
 function transformError(error) {
-  return `\nSorry, we couldn't find. Please check the stock ticker and provide correct one.\n\n`;
+  return `\nSorry, we couldn't find. Please check the stock ticker and provide correct one.\n\n ${error.message}`;
+}
+
+function transformExportJsonSuccess() {
+  return `\nExported to json successfully.\nStored in: ${process.cwd()}\n`;
+}
+
+function transformExportCsvSuccess() {
+  return `\nExported to csv successfully.\nStored in: ${process.cwd()}\n`;
 }

bin/index.js

@@ -16,24 +16,34 @@ var argv = require('yargs/yargs')(process.argv.slice(2))
     .alias('c', 'chart')
     .describe('c', 'Fetch chart for given ticker')
     .describe('historical', 'To get historical price information of the stock')
+    .describe('json', 'To export the data as json')
+    .describe('csv', 'To export the data csv')
     .help('h')
     .alias('h', 'help')
     .alias('v', 'version')
     .argv;
 
+const options = {};
+
+if (argv.json) {
+    options.export = 'json';
+} else if (argv.csv) {
+    options.export = 'csv';
+}
+
 if (argv.tickers) {
     const tickers = argv.tickers.split(',');
-    stocksCli.fetchCurrentPrice(tickers);
+    stocksCli.fetchCurrentPrice(tickers, options);
 }
 if (argv.market) {
-    stocksCli.fetchMarketSummary();
+    stocksCli.fetchMarketSummary(options, options);
 } else if (argv.t || argv.ticker) {
     const ticker = argv.t || argv.ticker;
     if (argv.historical) {
-        stocksCli.fetchHistoricalPrices(ticker, { page: 1, limit: 10 });
+        stocksCli.fetchHistoricalPrices(ticker, { page: 1, limit: 10, export: options.export });
     } else if (argv.chart) {
         stocksCli.fetchChart(ticker);
     } else {
-        stocksCli.fetchCurrentPrice([ticker]);
+        stocksCli.fetchCurrentPrice([ticker], options);
     }
 }

cli/stocksCli.js

@@ -1,4 +1,6 @@
 var yahooService = require('../app/services/yahooService');
+var jsonService = require('../app/services/jsonService');
+var csvService = require('../app/services/csvService');
 var responseTransformer = require('../app/transformer/responseTransformer');
 
 module.exports = {
@@ -8,10 +10,18 @@ module.exports = {
     fetchChart: fetchChart
 };
 
-function fetchCurrentPrice(tickers) {
+function fetchCurrentPrice(tickers, options = {}) {
     yahooService.getCurrentPrice(tickers)
         .then((data) => {
-            console.log(responseTransformer.transformCurrentPrice(data));
+            if (options.export === 'json') {
+                jsonService.jsonExport(data);
+                console.log(responseTransformer.transformExportJsonSuccess())
+            } else if (options.export === 'csv') {
+                csvService.csvExport(data);
+                console.log(responseTransformer.transformExportCsvSuccess())
+            } else {
+                console.log(responseTransformer.transformCurrentPrice(data));
+            }
         }).catch((error) => {
             console.log(responseTransformer.transformError(error));
         });
@@ -20,16 +30,32 @@ function fetchCurrentPrice(tickers) {
 function fetchHistoricalPrices(ticker, options) {
     yahooService.getHistoricalPrices(ticker, options)
         .then((data) => {
-            console.log(responseTransformer.transformHistoricalPrices(data));
+            if (options.export === 'json') {
+                jsonService.jsonExport(data);
+                console.log(responseTransformer.transformExportJsonSuccess())
+            } else if (options.export === 'csv') {
+                csvService.csvExport(data);
+                console.log(responseTransformer.transformExportCsvSuccess())
+            } else {
+                console.log(responseTransformer.transformHistoricalPrices(data));
+            }
         }).catch((error) => {
             console.log(responseTransformer.transformError(error));
         });
 }
 
-function fetchMarketSummary() {
-    yahooService.getMarketSummary()
+function fetchMarketSummary(options) {
+    yahooService.getMarketSummary(options)
         .then((data) => {
-            console.log(responseTransformer.transformMarketSummary(data));
+            if (options.export === 'json') {
+                jsonService.jsonExport(data);
+                console.log(responseTransformer.transformExportJsonSuccess())
+            } else if (options.export === 'csv') {
+                csvService.csvExport(data);
+                console.log(responseTransformer.transformExportCsvSuccess())
+            } else {
+                console.log(responseTransformer.transformMarketSummary(data));
+            }
         }).catch((error) => {
             console.log(responseTransformer.transformError(error));
         });

docs/cli.md

@@ -82,6 +82,20 @@ Example:
 terminal-stocks --ticker ^BSENS
 ```
 
+## Export the data
+You can export the data as json and csv file.
+- To export as json
+ ```sh
+terminal-stocks --ticker <TICKER> --json
+```
+
+- To export as csv
+ ```sh
+terminal-stocks --ticker <TICKER> --csv
+```
+
+This works with other data also like --historical, --market or --tickers
+
 ---
 
 ?> DISCLAIMER: Use data provided by termnal-stocks for information purpose. Do not use for trading.

package-lock.json

@@ -1,10 +1,10 @@
 {
   "name": "terminal-stocks",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Fetch stock price information on terminal",
   "main": "index.js",
   "bin": {
-    "terminal-stocks": "./bin/index.js"
+    "terminal-stocks": "bin/index.js"
   },
   "dependencies": {
     "ansi_up": "^4.0.4",
@@ -14,13 +14,15 @@
     "cli-table3": "^0.6.0",
     "colors": "^1.4.0",
     "express": "^4.15.4",
+    "jsonexport": "^3.2.0",
     "request": "^2.88.0",
     "yargs": "^16.1.1"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "serve": "node server.js",
-    "watch": "nodemon server.js"
+    "watch": "nodemon server.js",
+    "start": "node server.js"
   },
   "author": "Shashi Prakash Gautam <contactmespg@gmail.com>",
   "license": "ISC",
@@ -34,5 +36,8 @@
   "bugs": {
     "url": "https://github.com/shweshi/terminal-stocks/issues"
   },
-  "homepage": "https://github.com/shweshi/terminal-stocks#readme"
+  "homepage": "https://github.com/shweshi/terminal-stocks#readme",
+  "directories": {
+    "doc": "docs"
+  }
 }