wlbot 1.1.3 → 1.1.5

package/LICENSE.txt

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

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,25 @@ 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.**
+
+If you are introducing new functionality, please add unit tests (UTs) to ensure the functionality of your contribution and its backwards compatibility. All UTs should be able to run locally. You will need to install the `devDependencies` to run the UTs.
 
 ## License
 Distributed under the MIT License. See `LICENSE.txt` for more information.
@@ -105,4 +123,4 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.
 Below are several references that were used to help find inspiration for this project, get a starting point for the CLI, and serve as a resource for the WeatherLink API.
 - [WeatherLink Developer Portal](https://weatherlink.github.io)
 - [WeatherLink Portal](https://www.weatherlink.com)
-- [How to Build a Command Line Interface (CLI) Using Node.js](https://cheatcode.co/tutorials/how-to-build-a-command-line-interface-cli-using-node-js)
+- [How to Build a Command Line Interface (CLI) Using Node.js](https://cheatcode.co/tutorials/how-to-build-a-command-line-interface-cli-using-node-js)

package/commands/config.js

@@ -2,7 +2,7 @@ import chalk from 'chalk';
 import ora from 'ora';
 
 export default (options) => {
-  const spinner = !options.raw ? ora('Reading Environment Variables').start() : undefined;
+  const spinner = ora('Reading Environment Variables').start();
 
   let evValues = {
     "WEATHER_LINK_API_KEY": process.env.WEATHER_LINK_API_KEY || "",
@@ -17,5 +17,6 @@ export default (options) => {
   }
 
   spinner.succeed(chalk.green.bold(`Environment Variables Retrieved`));
-  return console.log(JSON.stringify(evValues, undefined, 2))
-};
+  console.log(JSON.stringify(evValues, undefined, 2));
+  return;
+};

package/commands/metadata/catalog.js

@@ -4,41 +4,52 @@ import ora from 'ora';
 
 import { buildWeatherLinkApiUrl, checkForRequired } from '../../lib/utils.js';
 
-export default (options) => {
-  const spinner = !options.raw ? ora('Retrieving Sensor Catalog').start() : undefined;
+export default async (options) => {
+  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) {
-    if (spinner) { 
-      spinner.fail('Failed to Retrieve Catalog') 
+    if (spinner) {
+      spinner.fail('Failed to Retrieve Catalog');
     }
-    
-    return console.log(`${chalk.red.bold(`Missing Environment Variable(s):`)} ${envVars.missing.join(", ")}`);
+
+    console.log(`${chalk.red.bold(`Missing Environment Variable(s):`)} ${envVars.missing.join(", ")}`);
+    return;
   }
 
   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)) }
-    )
-  )
-    .then((response) => {
-      if (options.raw) {
-        return console.log(JSON.stringify(response.data));
-      }
-
-      spinner.succeed(chalk.green.bold(`Catalog Retrieved`));
-      return console.dir(response.data, { depth: null })
-    })
-    .catch((error) => {
-      if (options.raw) {
-        return console.log(JSON.stringify(error.response.data));
-      }
+  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)) }
+  );
 
-      spinner.fail('Failed to Retrieve Catalog');
-      return console.log(`${chalk.red.bold(`Error ${error.response.status}:`)} ${error.response.data.message}`);
-    })
-};
+  if (options.dryRun) {
+    console.log(urlToQuery);
+    return;
+  }
+
+  try {
+    const response = await axios.get(urlToQuery);
+
+    if (options.raw) {
+      console.log(JSON.stringify(response.data));
+      return response;
+    }
+
+    spinner.succeed(chalk.green.bold(`Catalog Retrieved`));
+    console.dir(response.data, { depth: null });
+    return response;
+
+  } catch (error) {
+    if (options.raw) {
+      console.log(JSON.stringify(error.response.data));
+      throw (error);
+    }
+
+    spinner.fail('Failed to Retrieve Catalog');
+    console.log(`${chalk.red.bold(`Error ${error.response.status}:`)} ${error.response.data.message}`);
+    throw (error);
+  }
+};

package/commands/metadata/mine.js

@@ -4,47 +4,58 @@ import ora from 'ora';
 
 import { buildWeatherLinkApiUrl, checkForRequired } from '../../lib/utils.js';
 
-export default (options) => {
-  const spinner = !options.raw ? ora('Searching for Stations').start() : undefined;
+export default async (options) => {
+  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) {
-    if (spinner) { 
-      spinner.fail('Failed to Retrieve Stations') 
+    if (spinner) {
+      spinner.fail('Failed to Retrieve Stations');
     }
-    
-    return console.log(`${chalk.red.bold(`Missing Environment Variable(s):`)} ${envVars.missing.join(", ")}`);
+
+    console.log(`${chalk.red.bold(`Missing Environment Variable(s):`)} ${envVars.missing.join(", ")}`);
+    return;
   }
 
   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)) }
-    )
-  )
-    .then((response) => {
-
-      if (options.raw) {
-        return console.log(JSON.stringify(response.data));
-      }
-
-      let stationIdList = [];
-      response.data.stations.forEach(station => {
-        stationIdList.push(station.station_id);
-      });
-
-      spinner.succeed(chalk.green.bold(`${stationIdList.length} Station(s) Found`));
-      return console.log(stationIdList);
-    })
-    .catch((error) => {
-      if (options.raw) {
-        return console.log(JSON.stringify(error.response.data));
-      }
-
-      spinner.fail('Unable to Find Stations');
-      return console.log(`${chalk.red.bold(`Error ${error.response.status}:`)} ${error.response.data.message}`);
-    })
-};
+  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) {
+    console.log(urlToQuery);
+    return;
+  }
+
+  try {
+    const response = await axios.get(urlToQuery);
+
+    if (options.raw) {
+      console.log(JSON.stringify(response.data));
+      return;
+    }
+
+    let stationIdList = [];
+    response.data.stations.forEach(station => {
+      stationIdList.push(station.station_id);
+    });
+
+    spinner.succeed(chalk.green.bold(`${stationIdList.length} Station(s) Found`));
+    console.dir(stationIdList, { depth: null });
+    return stationIdList;
+
+  } catch (error) {
+
+    if (options.raw) {
+      console.log(JSON.stringify(error.response.data));
+      throw (error);
+    }
+
+    spinner.fail('Unable to Find Stations');
+    console.log(`${chalk.red.bold(`Error ${error.response.status}:`)} ${error.response.data.message}`);
+    throw (error);
+  }
+};

package/commands/metadata/stations.js

@@ -4,41 +4,53 @@ 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;
+export default async (stationIds, options) => {
+  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) {
-    if (spinner) { 
-      spinner.fail('Failed to Retrieve Stations') 
+    if (spinner) {
+      spinner.fail('Failed to Retrieve Stations');
     }
 
-    return console.log(`${chalk.red.bold(`Missing Environment Variable(s):`)} ${envVars.missing.join(", ")}`);
+    console.log(`${chalk.red.bold(`Missing Environment Variable(s):`)} ${envVars.missing.join(", ")}`);
+    return;
   }
 
   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)) }
-    )
-  )
-    .then((response) => {
-      if (options.raw) {
-        return console.log(JSON.stringify(response.data));
-      }
-
-      spinner.succeed(chalk.green.bold(`${response.data.stations.length} Station(s) Found`));
-      return console.log(response.data);
-    })
-    .catch((error) => {
-      if (options.raw) {
-        return console.log(JSON.stringify(error.response.data));
-      }
-
-      spinner.fail('Unable to Find Stations');
-      return console.log(`${chalk.red.bold(`Error ${error.response.status}:`)} ${error.response.data.message}`);
-    })
-};
+  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) {
+    console.log(urlToQuery);
+    return;
+  }
+
+  try {
+    const response = await axios.get(urlToQuery);
+
+    if (options.raw) {
+      console.log(JSON.stringify(response.data));
+      return response;
+    }
+
+    spinner.succeed(chalk.green.bold(`${response.data.stations.length} Station(s) Found`));
+    console.dir(response.data, { depth: null });
+    return response;
+
+  } catch (error) {
+
+    if (options.raw) {
+      console.log(JSON.stringify(error.response.data));
+      throw (error);
+    }
+
+    spinner.fail('Unable to Find Stations');
+    console.log(`${chalk.red.bold(`Error ${error.response.status}:`)} ${error.response.data.message}`);
+    throw (error);
+  }
+};

package/commands/status.js

@@ -1,39 +1,44 @@
 import axios from 'axios';
 
-export default function(service, options) {
+export default async function (service, _) {
 
   // Mapping of wlbot's shorthand for service names to Davis Instrument's official names.
   const fullServiceName = {
-    'api'          : 'APIs and Data Feeds',
-    'dataingest'   : 'Data Ingestion',
-    'mobile'       : 'Mobile Applications',
-    'syscomms'     : 'System Communication',
-    'website'      : 'WeatherLink Website'
+    'api': 'APIs and Data Feeds',
+    'dataingest': 'Data Ingestion',
+    'mobile': 'Mobile Applications',
+    'syscomms': 'System Communication',
+    'website': 'WeatherLink Website'
   };
 
-  return (
-   axios.get(
-      'https://0886445102835570.hostedstatus.com/1.0/status/600712dea9c1290530967bc6'
-    )
-    .then((response) => {
-
-      var requestedDavisServices = service === 'all' ? 
-        response.data.result.status
-        :
-        response.data.result.status.filter(davisService => {
-          return davisService.name === fullServiceName[service];
-        });
-
-      return requestedDavisServices;
-
-    })
-    .catch((error) => {
-      return ({
-        'error': {
-          'msg': `${error.response.data.message}`,
-          'status': `${error.response.status}`
-        }
+  try {
+    const response = await axios.get('https://0886445102835570.hostedstatus.com/1.0/status/600712dea9c1290530967bc6');
+
+    if (!Array.isArray(response.data.result.status)) {
+      throw ({ response: { data: { message: 'Hosted Status returned in an unexpected format.' }, status: 999 } })
+    }
+
+    var requestedDavisServices = service === 'all' ?
+      response.data.result.status
+      :
+      response.data.result.status.filter(davisService => {
+        return davisService.name === fullServiceName[service];
       });
-    })
-  );
-};
+
+    requestedDavisServices.forEach((requestedService) => {
+      console.log(requestedService.name + ' is ' + requestedService.status + ' (Status Code: ' + requestedService.status_code + ')');
+    });
+
+    return requestedDavisServices;
+
+  } catch (error) {
+    console.log('Error: ' + error);
+
+    return ({
+      'error': {
+        'msg': `${error.response.data.message}`,
+        'status': `${error.response.status}`
+      }
+    });
+  }
+};

package/commands/weather/current.js

@@ -4,41 +4,51 @@ 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;
+export default async (stationId, options) => {
+  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) {
-    if (spinner) { 
-      spinner.fail('Failed to Retrieve Current Weather Data') 
+    if (spinner) {
+      spinner.fail('Failed to Retrieve Current Weather Data');
     }
 
-    return console.log(`${chalk.red.bold(`Missing Environment Variable(s):`)} ${envVars.missing.join(", ")}`);
+    console.log(`${chalk.red.bold(`Missing Environment Variable(s):`)} ${envVars.missing.join(", ")}`);
+    return;
   }
 
   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)) }
-    )
-  )
-    .then((response) => {
-      if (options.raw) {
-        return console.log(JSON.stringify(response.data));
-      }
-
-      spinner.succeed(chalk.green.bold(`Current Weather Data Retrieved`));
-      return console.dir(response.data, { depth: null })
-    })
-    .catch((error) => {
-      if (options.raw) {
-        return console.log(JSON.stringify(error.response.data));
-      }
+  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)) }
+  );
 
-      spinner.fail('Failed to Retrieve Current Weather Data');
-      return console.log(`${chalk.red.bold(`Error ${error.response.status}:`)} ${error.response.data.message}`);
-    })
-};
+  if (options.dryRun) {
+    console.log(urlToQuery);
+    return;
+  }
+
+  try {
+    const response = await axios.get(urlToQuery);
+    if (options.raw) {
+      console.log(JSON.stringify(response.data));
+      return response;
+    }
+
+    spinner.succeed(chalk.green.bold(`Current Weather Data Retrieved`));
+    console.dir(response.data, { depth: null });
+    return response;
+
+  } catch (error) {
+    if (options.raw) {
+      console.log(JSON.stringify(error.response.data));
+      throw error;
+    }
+
+    spinner.fail('Failed to Retrieve Current Weather Data');
+    console.log(`${chalk.red.bold(`Error ${error.response.status}:`)} ${error.response.data.message}`);
+    throw error;
+  }
+};

package/commands/weather/historic.js

@@ -4,47 +4,63 @@ 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;
+export default async (stationId, startTimestamp, endTimestamp, options) => {
+  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) {
-    if (spinner) { 
-      spinner.fail('Failed to Retrieve Historic Weather Data') 
+    if (spinner) {
+      spinner.fail('Failed to Retrieve Historic Weather Data');
     }
 
-    return console.log(`${chalk.red.bold(`Missing Environment Variable(s):`)} ${envVars.missing.join(", ")}`);
+    console.log(`${chalk.red.bold(`Missing Environment Variable(s):`)} ${envVars.missing.join(", ")}`);
+    return;
   }
 
   const resultsOfDateRangeCheck = dateRangeIsValid(startTimestamp, endTimestamp);
 
   if (!resultsOfDateRangeCheck.isValid) {
-    return console.log(`${chalk.red.bold(`Error:`)} ${resultsOfDateRangeCheck.msg}`);
+    if (spinner) {
+      spinner.fail(`${resultsOfDateRangeCheck.msg}`);
+    }
+
+    console.log(`${chalk.red.bold(`Error:`)} ${resultsOfDateRangeCheck.msg}`);
+    return;
   }
 
   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)) }
-    )
-  )
-    .then((response) => {
-      if (options.raw) {
-        return console.log(JSON.stringify(response.data));
-      }
-
-      spinner.succeed(chalk.green.bold(`Historical Weather Data Retrieved`));
-      return console.dir(response.data, { depth: null })
-    })
-    .catch((error) => {
-      if (options.raw) {
-        return console.log(JSON.stringify(error.response.data));
-      }
-
-      spinner.fail('Failed to Retrieve Historical Weather Data');
-      return console.log(`${chalk.red.bold(`Error ${error.response.status}:`)} ${error.response.data.message}`);
-    })
-};
+  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) {
+    console.log(urlToQuery);
+    return
+  }
+
+  try {
+    const response = await axios.get(urlToQuery);
+
+    if (options.raw) {
+      console.log(JSON.stringify(response.data));
+      return response;
+    }
+
+    spinner.succeed(chalk.green.bold(`Historical Weather Data Retrieved`));
+    console.dir(response.data, { depth: null });
+    return response;
+
+  } catch (error) {
+    if (options.raw) {
+      console.log(JSON.stringify(error.response.data));
+      throw error;
+    }
+
+    spinner.fail('Failed to Retrieve Historical Weather Data');
+    console.log(`${chalk.red.bold(`Error ${error.response.status}:`)} ${error.response.data.message}`);
+    throw error;
+  }
+};

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.3')
+  .version('1.1.5')
   .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);
 
@@ -65,17 +70,7 @@ program.command("config")
 program.command("status")
   .description("Retrieves the operational status(es) of Davis Instrument's services.")
   .addArgument(new Argument('[service]', 'The Davis Instrument service that you want to obtain the operational status of.').choices(['all', 'api', 'dataingest', 'mobile', 'syscomms', 'website']).default('all'))
-  .action((service, options) => {
-    status(service, options).then((result) => {
-      if (!Array.isArray(result)) {
-        console.log('Error: ' + result.error.msg);
-      } else {
-        result.forEach((requestedService) => {
-          console.log(requestedService.name + ' is ' + requestedService.status + ' (Status Code: ' + requestedService.status_code + ')');
-        });
-      }
-    });
-  });
+  .action(status);
 
 program.commands.sort((a, b) => a._name.localeCompare(b._name));
-program.parse(process.argv);
+program.parse(process.argv);

package/lib/utils.js

@@ -14,7 +14,7 @@ export function buildWeatherLinkApiUrl(endpoint, signature_parameters, uri_param
 
   var apiSignature = "";
   for (const key in signature_parameters) {
-    apiSignature = apiSignature + key + signature_parameters[key]
+    apiSignature = apiSignature + key + signature_parameters[key];
   }
 
   var hmac = crypto.createHmac('sha256', API_SECRET);
@@ -28,7 +28,7 @@ export function buildWeatherLinkApiUrl(endpoint, signature_parameters, uri_param
       apiRequestURL = apiRequestURL + "&" + key + "=" + uri_parameters[key];
     }
   });
-  
+
   apiRequestURL = apiRequestURL + "&api-signature=" + hashedData;
   return apiRequestURL;
 }
@@ -43,16 +43,16 @@ export function checkForRequired(envVars) {
   let missingEnvVars = []
 
   for (const envVar of envVars) {
-    if (!process.env[envVar]){
-      missingEnvVars.push(envVar)
+    if (!process.env[envVar]) {
+      missingEnvVars.push(envVar);
     }
   }
 
   if (missingEnvVars.length != 0) {
-    return {"exist": false, "missing": missingEnvVars};
+    return { "exist": false, "missing": missingEnvVars };
   }
 
-  return {"exist": true, "missing": missingEnvVars};
+  return { "exist": true, "missing": missingEnvVars };
 }
 
 /**
@@ -63,12 +63,12 @@ export function checkForRequired(envVars) {
  */
 export function dateRangeIsValid(startTimestamp, endTimestamp) {
   if (startTimestamp <= 0 || endTimestamp <= 0) {
-    return {isValid: false, msg:"start-timestamp and end-timestamp must be greater than 0."};
+    return { isValid: false, msg: "start-timestamp and end-timestamp must be greater than 0." };
   }
-  
+
   if (startTimestamp >= endTimestamp) {
-    return {isValid: false, msg:"start-timestamp must be less than end-timestamp."};
+    return { isValid: false, msg: "start-timestamp must be less than end-timestamp." };
   }
 
-  return {isValid: true, msg:""};
-}
+  return { isValid: true, msg: "" };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wlbot",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "A CLI for the WeatherLink Live API.",
   "keywords": [
     "Davis Instruments",
@@ -25,24 +25,26 @@
   "type": "module",
   "main": "./index.js",
   "bin": {
-    "wlbot": "./index.js"
+    "wlbot": "index.js"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/mike-weiner/wlbot.git"
+    "url": "git+https://github.com/mike-weiner/wlbot.git"
   },
   "scripts": {
-    "test": "mocha"
+    "pack:dry": "npm pack --dry-run",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage"
   },
   "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": "^12.0.0",
+    "ora": "^8.0.1"
   },
   "devDependencies": {
-    "chai": "^4.3.6",
-    "mocha": "^10.0.0"
+    "@babel/preset-env": "^7.23.7",
+    "@types/jest": "^29.5.11",
+    "jest": "^29.7.0"
   },
   "engines": {
     "node": ">=16"

package/test/utils.test.js

@@ -1,108 +0,0 @@
-import { buildWeatherLinkApiUrl, checkForRequired, dateRangeIsValid } from '../lib/utils.js';
-import chai from 'chai';
-
-describe('buildWeatherLinkApiUrl', () => {
-  beforeEach(() => {
-    // Set the environment variables
-    process.env.WEATHER_LINK_API_KEY = 'sampleKey';
-    process.env.WEATHER_LINK_API_SECRET = 'sampleSecret';
-    process.env.WEATHER_LINK_BASE_API_URL = 'https://api.weatherlink.com/v2/';
-  });
-
-  it('Endpoint: current/13', () => {
-    chai.expect(
-      buildWeatherLinkApiUrl(
-        `current/13`, 
-        {'api-key': process.env.WEATHER_LINK_API_KEY, 'station-id': String(13), 't': String(1660759469)}, 
-        {'api-key': process.env.WEATHER_LINK_API_KEY, 't': String(1660759469)}
-      )
-    ).to.equal('https://api.weatherlink.com/v2/current/13?api-key=sampleKey&t=1660759469&api-signature=dcf2f0eafc43ec8b6d6a1a7acfc6faa44f9bc1045124d7d6416f2f486ff72e95')
-  });
-
-  it('Endpoint: stations', () => {
-    chai.expect(
-      buildWeatherLinkApiUrl(
-        'stations', 
-        {'api-key': process.env.WEATHER_LINK_API_KEY, 't': String(1660757289)}, 
-        {'api-key': process.env.WEATHER_LINK_API_KEY, 't': String(1660757289)}
-      )
-    ).to.equal('https://api.weatherlink.com/v2/stations?api-key=sampleKey&t=1660757289&api-signature=1663a50336ae4b7d975e322ad010e297d4ec487c5d3d9d4dad1d8a4a9e53d606')
-  });
-
-  it('Endpoint: stations/13,14,15', () => {
-    chai.expect(
-      buildWeatherLinkApiUrl(
-        `stations/13,14,15`, 
-        {'api-key': process.env.WEATHER_LINK_API_KEY, 'station-ids': '13,14,15', 't': String(1660759608)}, 
-        {'api-key': process.env.WEATHER_LINK_API_KEY, 't': String(1660759608)}
-      )
-    ).to.equal('https://api.weatherlink.com/v2/stations/13,14,15?api-key=sampleKey&t=1660759608&api-signature=7accbcf70808449f944e5da9e3e06db0aae7362870e7ace8312d5d9e8103d274')
-  });
-});
-
-describe('checkForRequired', () => {
-  
-  beforeEach(() => {
-    // Set the environment variables
-    process.env.WEATHER_LINK_API_KEY = 'sampleKey';
-    process.env.WEATHER_LINK_API_SECRET = 'sampleSecret';
-    process.env.WEATHER_LINK_BASE_API_URL = 'https://api.weatherlink.com/v2/';
-  });
-
-  it('Missing All Env Vars', () => {
-    chai.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(
-      checkForRequired(["WEATHER_LINK_API_KEY", "WEATHER_LINK_API_SECRET", "WEATHER_LINK_BASE_API_URL"])
-    ).to.deep.equal({"exist": true, "missing": []})
-  });
-});
-
-describe('dateRangeIsValid', () => {
-
-  it('Start Timestamp is Before End Timestamp', () => {
-    chai.expect(
-      dateRangeIsValid(1673472399, 1673494000).isValid
-    ).to.equal(true)
-  });
-
-  it('Start Timestamp is the Same as End Timestamp', () => {
-    chai.expect(
-      dateRangeIsValid(1673494000, 1673494000).isValid
-    ).to.equal(false)
-  });
-
-  it('Start Timestamp is After End Timestamp', () => {
-    chai.expect(
-      dateRangeIsValid(1673494010, 1673494000).isValid
-    ).to.equal(false)
-  });
-
-  it('Start Timestamp is 0', () => {
-    chai.expect(
-      dateRangeIsValid(0, 1673494000).isValid
-    ).to.equal(false)
-  });
-
-  it('Start Timestamp is Negative', () => {
-    chai.expect(
-      dateRangeIsValid(-10, 1673494000).isValid
-    ).to.equal(false)
-  });
-
-  it('End Timestamp is 0', () => {
-    chai.expect(
-      dateRangeIsValid(1673494010, 0).isValid
-    ).to.equal(false)
-  });
-
-  it('End Timestamp is Negative', () => {
-    chai.expect(
-      dateRangeIsValid(1673494010, -10).isValid
-    ).to.equal(false)
-  });
-});