alphavantage - npm Package Compare versions

Comparing version 0.0.4 to 0.0.5

index.js

 'use strict';
 
+require('dotenv').config();
+const apiKey = 'AV_KEY';
+
 /**
@@ -7,7 +10,5 @@ * The Alpha Vantage core module.
 module.exports = config => {
-  // Check for any config errors.
-  if (!config) {
-    throw new Error(`Missing config for alphavantage module`);
-  }
+  config = Object.assign({}, { key: process.env[apiKey] }, config);
 
+  // Check for config errors.
   let errors = [];
@@ -28,2 +29,3 @@ ['key'].forEach(prop => {
   return {
+    util: require('./lib/util')(config),
     data: require('./lib/data')(config),
@@ -30,0 +32,0 @@ performance: require('./lib/performance')(config)

lib/util.js

 'use strict';
 
-module.exports = config => ({
+/**
+ * Time stamp regex that AlphaVantage uses.
+ */
+const timestamp = /[0-9]{4}-[0-9]{2}-[0-9]{2}( [0-9]{2}:[0-9]{2}:[0-9]{2})?/g;
+
+/**
+ * The data keys to replace from the AlphaVantage API.
+ */
+const keys = {
+  'Meta Data': 'meta',
+  '1. Information': 'information',
+  Information: 'information',
+  '2. Symbol': 'symbol',
+  '3. Last Refreshed': 'updated',
+  'Last Refreshed': 'updated',
+  '4. Interval': 'interval',
+  '4. Output Size': 'size',
+  '5. Output Size': 'size',
+  '4. Time Zone': 'zone',
+  '5. Time Zone': 'zone',
+  '6. Time Zone': 'zone',
+  'Time Series (1min)': 'data',
+  'Time Series (Daily)': 'data',
+  'Weekly Time Series': 'data',
+  'Monthly Time Series': 'data',
+  '1. open': 'open',
+  '2. high': 'high',
+  '3. low': 'low',
+  '4. close': 'close',
+  '5. volume': 'volume',
+  '6. volume': 'volume',
+  '5. adjusted close': 'adjusted',
+  '7. dividend amount': 'dividend',
+  '8. split coefficient': 'split',
+  'Rank A: Real-Time Performance': 'real',
+  'Rank B: 1 Day Performance': '1day',
+  'Rank C: 5 Day Performance': '5day',
+  'Rank D: 1 Month Performance': '1month',
+  'Rank E: 3 Month Performance': '3month',
+  'Rank F: Year-to-Date (YTD) Performance': 'ytd',
+  'Rank G: 1 Year Performance': '1year',
+  'Rank H: 3 Year Performance': '3year',
+  'Rank I: 5 Year Performance': '5year',
+  'Rank J: 10 Year Performance': '10year'
+};
+
+module.exports = config => {
   /**
+   * Recursively walk the data tree and replace weird keys with a normalized set.
+   * 
+   * @param {Object|String|Number} data
+   *   The data to normalize.
+   * 
+   * @returns {Object|String|Number}
+   *   Normalized data.
+   */
+  const polish = data => {
+    // If this is not an object, dont recurse.
+    if (typeof data !== 'object') {
+      return data;
+    }
+
+    // If the data is a complex object, walk all subtrees to normalize all branches.
+    let clean = {};
+    Object.keys(data).forEach(key => {
+      // If the key is a date time string, convert it to an iso timestamp.
+      if (timestamp.test(key.toString())) {
+        clean[new Date(key.toString()).toISOString()] = polish(data[key]);
+        return;
+      }
+
+      clean[keys[key] || key] = polish(data[key]);
+    });
+
+    return clean;
+  };
+
+  /**
    * Util function to build the proper API url.
@@ -21,3 +97,3 @@ *
    */
-  url: (fn, symbol, size, type, interval) => {
+  const url = (fn, symbol, size, type, interval) => {
     let params = [];
@@ -42,3 +118,8 @@
     return `${config.base}${params.join('&')}`;
-  }
-});
+  };
+
+  return {
+    url,
+    polish
+  };
+};

package.json

 {
   "name": "alphavantage",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "A simple interface to the Alpha Vantage API.",
@@ -37,2 +37,3 @@ "main": "index.js",
   "devDependencies": {
+    "dotenv": "^4.0.0",
     "jest": "^20.0.4",
@@ -39,0 +40,0 @@ "prettier": "^1.5.3"

README.md

@@ -22,3 +22,3 @@ # AlphaVantage
  - [ ] Add Technical indicators data
- - [ ] Add utils to clean up response data
+ - [x] Add utils to clean up response data
 
@@ -97,2 +97,10 @@ #### Installation
 });
+
+/**
+ * Data polishing
+ *
+ * Rewrite weird data keys to be consistent across all api calls. This is an optional
+ * utility you can use with the result of any api call.
+ */
+ const polished = alpha.util.polish(data);
 ```
@@ -99,0 +107,0 @@

test/data.js

 'use strict';
 
-const alpha = require('../')({
-  key: 'demo'
-});
+const alpha = require('../')();
 
@@ -14,1 +12,33 @@ test(`intraday data works`, () => {
 });
+
+test(`daily data works`, () => {
+  expect.assertions(2);
+  return alpha.data.daily(`msft`).then(data => {
+    expect(data['Meta Data']).toBeDefined();
+    expect(data['Time Series (Daily)']).toBeDefined();
+  });
+});
+
+test(`adjusted data works`, () => {
+  expect.assertions(2);
+  return alpha.data.adjusted(`msft`).then(data => {
+    expect(data['Meta Data']).toBeDefined();
+    expect(data['Time Series (Daily)']).toBeDefined();
+  });
+});
+
+test(`weekly data works`, () => {
+  expect.assertions(2);
+  return alpha.data.weekly(`msft`).then(data => {
+    expect(data['Meta Data']).toBeDefined();
+    expect(data['Weekly Time Series']).toBeDefined();
+  });
+});
+
+test(`monthly data works`, () => {
+  expect.assertions(2);
+  return alpha.data.monthly(`msft`).then(data => {
+    expect(data['Meta Data']).toBeDefined();
+    expect(data['Monthly Time Series']).toBeDefined();
+  });
+});

test/init.js

 'use strict';
 
+const env = process.env;
+const Alpha = require('../');
+
+// Clear the current environment variables for testing.
+process.env = {};
+
 test(`initialization without a config throws an error`, () => {
   expect.assertions(1);
   try {
-    const alpha = require('../')();
+    const alpha = Alpha();
   } catch (e) {
-    expect(e.message).toEqual(`Missing config for alphavantage module`);
+    expect(e.message).toEqual(`Missing Alpha Vantage config settings: key`);
   }
@@ -15,3 +21,3 @@ });
   try {
-    const alpha = require('../')({});
+    const alpha = Alpha({});
   } catch (e) {
@@ -21,1 +27,12 @@ expect(e.message).toEqual(`Missing Alpha Vantage config settings: key`);
 });
+
+test(`initialization without an api key, but with env key works`, () => {
+  expect.assertions(1);
+  try {
+    process.env = env;
+    const alpha = Alpha();
+    expect(alpha).toBeDefined();
+  } catch (e) {
+    expect(e).toBeUndefined();
+  }
+});

test/performance.js

 'use strict';
 
-const alpha = require('../')({
-  key: 'demo'
-});
+const alpha = require('../')();
 
@@ -7,0 +5,0 @@ test(`sector performance data works`, () => {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 2 instances in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

40405

increased by217.4%

Number of package files

20

increased by81.82%

Lines of code

792

increased by417.65%

Number of lines in readme file

110

increased by7.84%

Worsened metrics

Dev dependency count

3

increased by50%

Number of low supply chain risk alerts

5

increased by400%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes