wlbot 1.1.2 → 1.1.4

package/README.md

@@ -12,6 +12,7 @@
   - [Install npm Packages](#install-npm-packages)
   - [Installing CLI Globally](#installing-cli-globally)
 - [Calling the CLI](#calling-the-cli)
+- [Upgrading `wlbot` via `npm`](#upgrading-wlbot-via-npm)
 - [Contributing](#contributing)
 - [License](#license)
 - [References](#references)
@@ -95,8 +96,23 @@ There are several commands that you will probably call more frequently than othe
 - `wlbot metadata mine`: This command will return an array of `station-id` numbers for the weather station's that your WeatherLink account has permission to view data for. 
 - `wlbot weather current <station-id>`: This command will return the current weather record for the station whose station id matches `<station-id>`. 
 
+## Upgrading `wlbot` via `npm`
+If you installed `wlbot` via `npm`, you can quickly get an updated version via the command line. 
+
+To see what version of `wlbot` you currently have installed:
+1. Open a command line window and run `wlbot -V`. 
+
+To upgrade your installed version of `wlbot`:
+1. Open a command line window and run `npm update -g wlbot`.
+
+Downloading the upgrade may take a minute or two based on your internet connection.
+
 ## Contributing
-All contributions are welcome! First, search open issues to see if a ticket has already been created for the issue or feature request that you have. If a ticket does not already exist, open an issue to discuss what contributions you would like to make. All contributions should be developed in a `feature/` branch as a PR will be required before any changes are merged into the `main` branch.
+All contributions are welcome! 
+
+First, search open issues to see if a ticket has already been created for the issue or feature request that you have. If a ticket does not already exist, open an issue to discuss what contributions you would like to make. 
+
+**All contributions should be developed in a `feature/` branch off of the `development` branch as a PR will be required before any changes are merged back into the `development` branch.**
 
 ## License
 Distributed under the MIT License. See `LICENSE.txt` for more information.

package/commands/metadata/catalog.js

@@ -5,7 +5,7 @@ import ora from 'ora';
 import { buildWeatherLinkApiUrl, checkForRequired } from '../../lib/utils.js';
 
 export default (options) => {
-  const spinner = !options.raw ? ora('Retrieving Sensor Catalog').start() : undefined;
+  const spinner = !options.raw && !options.dryRun ? ora('Retrieving Sensor Catalog').start() : undefined;
 
   const envVars = checkForRequired(["WEATHER_LINK_API_KEY", "WEATHER_LINK_API_SECRET", "WEATHER_LINK_BASE_API_URL"])
   if (!envVars.exist) {
@@ -18,13 +18,17 @@ export default (options) => {
 
   const API_KEY = process.env.WEATHER_LINK_API_KEY;
 
-  axios.get(
-    buildWeatherLinkApiUrl(
-      `sensor-catalog`,
-      { "api-key": API_KEY, "t": String(Math.round(Date.now() / 1000)) },
-      { "api-key": API_KEY, "t": String(Math.round(Date.now() / 1000)) }
-    )
-  )
+  const urlToQuery = buildWeatherLinkApiUrl(
+    `sensor-catalog`,
+    { "api-key": API_KEY, "t": String(Math.round(Date.now() / 1000)) },
+    { "api-key": API_KEY, "t": String(Math.round(Date.now() / 1000)) }
+  );
+
+  if (options.dryRun) {
+    return console.log(urlToQuery);
+  }
+
+  axios.get(urlToQuery)
     .then((response) => {
       if (options.raw) {
         return console.log(JSON.stringify(response.data));

package/commands/metadata/mine.js

@@ -5,7 +5,7 @@ import ora from 'ora';
 import { buildWeatherLinkApiUrl, checkForRequired } from '../../lib/utils.js';
 
 export default (options) => {
-  const spinner = !options.raw ? ora('Searching for Stations').start() : undefined;
+  const spinner = !options.raw && !options.dryRun ? ora('Searching for Stations').start() : undefined;
 
   const envVars = checkForRequired(["WEATHER_LINK_API_KEY", "WEATHER_LINK_API_SECRET", "WEATHER_LINK_BASE_API_URL"])
   if (!envVars.exist) {
@@ -18,13 +18,17 @@ export default (options) => {
 
   const API_KEY = process.env.WEATHER_LINK_API_KEY;
 
-  axios.get(
-    buildWeatherLinkApiUrl(
-      'stations',
-      { "api-key": API_KEY, "t": String(Math.round(Date.now() / 1000)) },
-      { "api-key": API_KEY, "t": String(Math.round(Date.now() / 1000)) }
-    )
-  )
+  const urlToQuery = buildWeatherLinkApiUrl(
+    'stations',
+    { "api-key": API_KEY, "t": String(Math.round(Date.now() / 1000)) },
+    { "api-key": API_KEY, "t": String(Math.round(Date.now() / 1000)) }
+  );
+
+  if (options.dryRun) {
+    return console.log(urlToQuery);
+  }
+
+  axios.get(urlToQuery)
     .then((response) => {
 
       if (options.raw) {

package/commands/metadata/stations.js

@@ -5,7 +5,7 @@ import ora from 'ora';
 import { buildWeatherLinkApiUrl, checkForRequired } from '../../lib/utils.js';
 
 export default (stationIds, options) => {
-  const spinner = !options.raw ? ora('Searching for Stations').start() : undefined;
+  const spinner = !options.raw && !options.dryRun ? ora('Searching for Stations').start() : undefined;
 
   const envVars = checkForRequired(["WEATHER_LINK_API_KEY", "WEATHER_LINK_API_SECRET", "WEATHER_LINK_BASE_API_URL"])
   if (!envVars.exist) {
@@ -18,13 +18,17 @@ export default (stationIds, options) => {
 
   const API_KEY = process.env.WEATHER_LINK_API_KEY;
 
-  axios.get(
-    buildWeatherLinkApiUrl(
-      `stations/${stationIds}`,
-      { "api-key": API_KEY, "station-ids": String(stationIds), "t": String(Math.round(Date.now() / 1000)) },
-      { "api-key": API_KEY, "t": String(Math.round(Date.now() / 1000)) }
-    )
-  )
+  const urlToQuery = buildWeatherLinkApiUrl(
+    `stations/${stationIds}`,
+    { "api-key": API_KEY, "station-ids": String(stationIds), "t": String(Math.round(Date.now() / 1000)) },
+    { "api-key": API_KEY, "t": String(Math.round(Date.now() / 1000)) }
+  );
+
+  if (options.dryRun) {
+    return console.log(urlToQuery);
+  }
+
+  axios.get(urlToQuery)
     .then((response) => {
       if (options.raw) {
         return console.log(JSON.stringify(response.data));

package/commands/weather/current.js

@@ -5,7 +5,7 @@ import ora from 'ora';
 import { buildWeatherLinkApiUrl, checkForRequired } from '../../lib/utils.js';
 
 export default (stationId, options) => {
-  const spinner = !options.raw ? ora('Retrieving Current Weather Data').start() : undefined;
+  const spinner = !options.raw && !options.dryRun ? ora('Retrieving Current Weather Data').start() : undefined;
 
   const envVars = checkForRequired(["WEATHER_LINK_API_KEY", "WEATHER_LINK_API_SECRET", "WEATHER_LINK_BASE_API_URL"])
   if (!envVars.exist) {
@@ -18,13 +18,17 @@ export default (stationId, options) => {
 
   const API_KEY = process.env.WEATHER_LINK_API_KEY;
 
-  axios.get(
-    buildWeatherLinkApiUrl(
-      `current/${stationId}`,
-      { "api-key": API_KEY, "station-id": String(stationId), "t": String(Math.round(Date.now() / 1000)) },
-      { "api-key": API_KEY, "t": String(Math.round(Date.now() / 1000)) }
-    )
-  )
+  const urlToQuery = buildWeatherLinkApiUrl(
+    `current/${stationId}`,
+    { "api-key": API_KEY, "station-id": String(stationId), "t": String(Math.round(Date.now() / 1000)) },
+    { "api-key": API_KEY, "t": String(Math.round(Date.now() / 1000)) }
+  );
+
+  if (options.dryRun) {
+    return console.log(urlToQuery);
+  }
+
+  axios.get(urlToQuery)
     .then((response) => {
       if (options.raw) {
         return console.log(JSON.stringify(response.data));

package/commands/weather/historic.js

@@ -5,7 +5,7 @@ import ora from 'ora';
 import { buildWeatherLinkApiUrl, checkForRequired, dateRangeIsValid } from '../../lib/utils.js';
 
 export default (stationId, startTimestamp, endTimestamp, options) => {
-  const spinner = !options.raw ? ora('Retrieving Historical Weather Data').start() : undefined;
+  const spinner = !options.raw && !options.dryRun ? ora('Retrieving Historical Weather Data').start() : undefined;
 
   const envVars = checkForRequired(["WEATHER_LINK_API_KEY", "WEATHER_LINK_API_SECRET", "WEATHER_LINK_BASE_API_URL"])
   if (!envVars.exist) {
@@ -24,13 +24,17 @@ export default (stationId, startTimestamp, endTimestamp, options) => {
 
   const API_KEY = process.env.WEATHER_LINK_API_KEY;
 
-  axios.get(
-    buildWeatherLinkApiUrl(
-      `historic/${stationId}`,
-      { "api-key": API_KEY, "end-timestamp": endTimestamp, "start-timestamp": startTimestamp, "station-id": String(stationId), "t": String(Math.round(Date.now() / 1000)) },
-      { "api-key": API_KEY, "end-timestamp": endTimestamp, "start-timestamp": startTimestamp, "t": String(Math.round(Date.now() / 1000)) }
-    )
-  )
+  const urlToQuery = buildWeatherLinkApiUrl(
+    `historic/${stationId}`,
+    { "api-key": API_KEY, "end-timestamp": endTimestamp, "start-timestamp": startTimestamp, "station-id": String(stationId), "t": String(Math.round(Date.now() / 1000)) },
+    { "api-key": API_KEY, "end-timestamp": endTimestamp, "start-timestamp": startTimestamp, "t": String(Math.round(Date.now() / 1000)) }
+  );
+
+  if (options.dryRun) {
+    return console.log(urlToQuery);
+  }
+
+  axios.get(urlToQuery)
     .then((response) => {
       if (options.raw) {
         return console.log(JSON.stringify(response.data));

package/index.js

@@ -18,7 +18,7 @@ const program = new Command();
 program
   .description("A CLI for the WeatherLink Live API.")
   .name("wlbot")
-  .version('1.1.1')
+  .version('1.1.4')
   .usage('<command>');
 
 const metadata = program.command("metadata")
@@ -26,17 +26,20 @@ const metadata = program.command("metadata")
 
 metadata.command("catalog")
   .description("Get a catalog of all available sensor types and the data reported by each sensor.")
+  .option("-d, --dry-run", "Checks for the necessary environmental variables and outputs the URL that would be queried.")
   .option("-r, --raw", "Display the raw response from the WeatherLink API.")
   .action(catalog);
 
 metadata.command("mine")
   .description("Returns an array of Weather Station Id(s) that are associated with your WeatherLink API Key.")
+  .option("-d, --dry-run", "Checks for the necessary environmental variables and outputs the URL that would be queried.")
   .option("-r, --raw", "Display the raw response from the WeatherLink API.")
   .action(mine);
 
 metadata.command("stations")
   .description("Returns all available information about 1 or more weather stations associated with your WeatherLink API Key.")
   .argument('<station-ids>', 'A comma-separated list of Weather Station Id(s) that you want information about.')
+  .option("-d, --dry-run", "Checks for the necessary environmental variables and outputs the URL that would be queried.")
   .option("-r, --raw", "Display the raw response from the WeatherLink API.")
   .action(stations);
 
@@ -46,6 +49,7 @@ const weather = program.command("weather")
 weather.command("current")
   .description("Get the current weather data for 1 weather station associated with your WeatherLink API Key.")
   .argument('<station-id>', 'The Station ID of the weather station that you want current weather data for.')
+  .option("-d, --dry-run", "Checks for the necessary environmental variables and outputs the URL that would be queried.")
   .option("-r, --raw", "Display the raw response from the WeatherLink API.")
   .action(current);
 
@@ -54,6 +58,7 @@ weather.command("historic")
   .argument('<station-id>', 'The Station ID of the weather station that you want current weather data for.')
   .argument('<start-timestamp>', 'A Unix timestamp marking the beginning of the historical period (must be earlier than end-timestamp but not more than 24 hours earlier).')
   .argument('<end-timestamp>', 'A Unix timestamp marking the end of the historical period (must be later than start-timestamp but not more than 24 hours later).')
+  .option("-d, --dry-run", "Checks for the necessary environmental variables and outputs the URL that would be queried.")
   .option("-r, --raw", "Display the raw response from the WeatherLink API.")
   .action(historic);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wlbot",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "A CLI for the WeatherLink Live API.",
   "keywords": [
     "Davis Instruments",
@@ -35,14 +35,14 @@
     "test": "mocha"
   },
   "dependencies": {
-    "axios": "^0.27.2",
-    "chalk": "^5.0.1",
-    "commander": "^9.4.0",
-    "ora": "^6.1.2"
+    "axios": "^1.6.3",
+    "chalk": "^5.3.0",
+    "commander": "^11.1.0",
+    "ora": "^8.0.1"
   },
   "devDependencies": {
-    "chai": "^4.3.6",
-    "mocha": "^10.0.0"
+    "chai": "^5.0.0",
+    "mocha": "^10.2.0"
   },
   "engines": {
     "node": ">=16"

package/test/utils.test.js

@@ -1,5 +1,5 @@
 import { buildWeatherLinkApiUrl, checkForRequired, dateRangeIsValid } from '../lib/utils.js';
-import chai from 'chai';
+import { expect } from 'chai';
 
 describe('buildWeatherLinkApiUrl', () => {
   beforeEach(() => {
@@ -10,7 +10,7 @@ describe('buildWeatherLinkApiUrl', () => {
   });
 
   it('Endpoint: current/13', () => {
-    chai.expect(
+    expect(
       buildWeatherLinkApiUrl(
         `current/13`, 
         {'api-key': process.env.WEATHER_LINK_API_KEY, 'station-id': String(13), 't': String(1660759469)}, 
@@ -20,7 +20,7 @@ describe('buildWeatherLinkApiUrl', () => {
   });
 
   it('Endpoint: stations', () => {
-    chai.expect(
+    expect(
       buildWeatherLinkApiUrl(
         'stations', 
         {'api-key': process.env.WEATHER_LINK_API_KEY, 't': String(1660757289)}, 
@@ -30,7 +30,7 @@ describe('buildWeatherLinkApiUrl', () => {
   });
 
   it('Endpoint: stations/13,14,15', () => {
-    chai.expect(
+    expect(
       buildWeatherLinkApiUrl(
         `stations/13,14,15`, 
         {'api-key': process.env.WEATHER_LINK_API_KEY, 'station-ids': '13,14,15', 't': String(1660759608)}, 
@@ -50,13 +50,13 @@ describe('checkForRequired', () => {
   });
 
   it('Missing All Env Vars', () => {
-    chai.expect(
+    expect(
       checkForRequired(["WEATHER_LINK_VERY_FAKE_NONEXISTENT"])
     ).to.deep.equal({"exist": false, "missing": ["WEATHER_LINK_VERY_FAKE_NONEXISTENT"]})
   });
 
   it('All Env Vars Defined', () => {
-    chai.expect(
+    expect(
       checkForRequired(["WEATHER_LINK_API_KEY", "WEATHER_LINK_API_SECRET", "WEATHER_LINK_BASE_API_URL"])
     ).to.deep.equal({"exist": true, "missing": []})
   });
@@ -65,43 +65,43 @@ describe('checkForRequired', () => {
 describe('dateRangeIsValid', () => {
 
   it('Start Timestamp is Before End Timestamp', () => {
-    chai.expect(
+    expect(
       dateRangeIsValid(1673472399, 1673494000).isValid
     ).to.equal(true)
   });
 
   it('Start Timestamp is the Same as End Timestamp', () => {
-    chai.expect(
+    expect(
       dateRangeIsValid(1673494000, 1673494000).isValid
     ).to.equal(false)
   });
 
   it('Start Timestamp is After End Timestamp', () => {
-    chai.expect(
+    expect(
       dateRangeIsValid(1673494010, 1673494000).isValid
     ).to.equal(false)
   });
 
   it('Start Timestamp is 0', () => {
-    chai.expect(
+    expect(
       dateRangeIsValid(0, 1673494000).isValid
     ).to.equal(false)
   });
 
   it('Start Timestamp is Negative', () => {
-    chai.expect(
+    expect(
       dateRangeIsValid(-10, 1673494000).isValid
     ).to.equal(false)
   });
 
   it('End Timestamp is 0', () => {
-    chai.expect(
+    expect(
       dateRangeIsValid(1673494010, 0).isValid
     ).to.equal(false)
   });
 
   it('End Timestamp is Negative', () => {
-    chai.expect(
+    expect(
       dateRangeIsValid(1673494010, -10).isValid
     ).to.equal(false)
   });