Convert WeatherProvider from interface to class

routes/weather.ts

@@ -5,8 +5,9 @@ import * as SunCalc from "suncalc";
 import * as moment from "moment-timezone";
 import * as geoTZ from "geo-tz";
 
-import { AdjustmentOptions, GeoCoordinates, TimeData, WateringData, WeatherData, WeatherProvider } from "../types";
+import { AdjustmentOptions, GeoCoordinates, TimeData, WateringData, WeatherData } from "../types";
-const weatherProvider: WeatherProvider = require("./weatherProviders/" + ( process.env.WEATHER_PROVIDER || "OWM" ) ).default;
+import { WeatherProvider } from "./weatherProviders/WeatherProvider";
+const weatherProvider: WeatherProvider = new ( require("./weatherProviders/" + ( process.env.WEATHER_PROVIDER || "OWM" ) ).default )();
 
 // Define regex filters to match against location
 const filters = {

routes/weatherProviders/DarkSky.ts

@@ -1,9 +1,12 @@
 import * as moment from "moment-timezone";
 
-import { GeoCoordinates, WateringData, WeatherData, WeatherProvider } from "../../types";
+import { GeoCoordinates, WateringData, WeatherData } from "../../types";
 import { httpJSONRequest } from "../weather";
+import { WeatherProvider } from "./WeatherProvider";
 
-async function getDarkSkyWateringData( coordinates: GeoCoordinates ): Promise< WateringData > {
+export default class DarkSkyWeatherProvider extends WeatherProvider {
+
+	public async getWateringData( coordinates: GeoCoordinates ): Promise< WateringData > {
 		// The Unix timestamp of 24 hours ago.
 		const yesterdayTimestamp: number = moment().subtract( 1, "day" ).unix();
 		const todayTimestamp: number = moment().unix();
@@ -58,7 +61,7 @@ async function getDarkSkyWateringData( coordinates: GeoCoordinates ): Promise< W
 		};
 	}
 
-async function getDarkSkyWeatherData( coordinates: GeoCoordinates ): Promise< WeatherData > {
+	public async getWeatherData( coordinates: GeoCoordinates ): Promise< WeatherData > {
 		const DARKSKY_API_KEY = process.env.DARKSKY_API_KEY,
 			forecastUrl = `https://api.darksky.net/forecast/${ DARKSKY_API_KEY }/${ coordinates[ 0 ] },${ coordinates[ 1 ] }?exclude=minutely,alerts,flags`;
 
@@ -104,10 +107,4 @@ async function getDarkSkyWeatherData( coordinates: GeoCoordinates ): Promise< We
 
 		return weather;
 	}
-
+}
-
-const DarkSkyWeatherProvider: WeatherProvider = {
-	getWateringData: getDarkSkyWateringData,
-	getWeatherData: getDarkSkyWeatherData
-};
-export default DarkSkyWeatherProvider;

routes/weatherProviders/OWM.ts

@@ -1,7 +1,10 @@
-import { GeoCoordinates, WateringData, WeatherData, WeatherProvider } from "../../types";
+import { GeoCoordinates, WateringData, WeatherData } from "../../types";
 import { httpJSONRequest } from "../weather";
+import { WeatherProvider } from "./WeatherProvider";
 
-async function getOWMWateringData( coordinates: GeoCoordinates ): Promise< WateringData > {
+export default class OWMWeatherProvider extends WeatherProvider {
+
+	public async getWateringData( coordinates: GeoCoordinates ): Promise< WateringData > {
 		const OWM_API_KEY = process.env.OWM_API_KEY,
 			forecastUrl = "http://api.openweathermap.org/data/2.5/forecast?appid=" + OWM_API_KEY + "&units=imperial&lat=" + coordinates[ 0 ] + "&lon=" + coordinates[ 1 ];
 
@@ -39,7 +42,7 @@ async function getOWMWateringData( coordinates: GeoCoordinates ): Promise< Water
 		};
 	}
 
-async function getOWMWeatherData( coordinates: GeoCoordinates ): Promise< WeatherData > {
+	public async getWeatherData( coordinates: GeoCoordinates ): Promise< WeatherData > {
 		const OWM_API_KEY = process.env.OWM_API_KEY,
 			currentUrl = "http://api.openweathermap.org/data/2.5/weather?appid=" + OWM_API_KEY + "&units=imperial&lat=" + coordinates[ 0 ] + "&lon=" + coordinates[ 1 ],
 			forecastDailyUrl = "http://api.openweathermap.org/data/2.5/forecast/daily?appid=" + OWM_API_KEY + "&units=imperial&lat=" + coordinates[ 0 ] + "&lon=" + coordinates[ 1 ];
@@ -86,9 +89,4 @@ async function getOWMWeatherData( coordinates: GeoCoordinates ): Promise< Weathe
 
 		return weather;
 	}
-
+}
-const OWMWeatherProvider: WeatherProvider = {
-	getWateringData: getOWMWateringData,
-	getWeatherData: getOWMWeatherData
-};
-export default OWMWeatherProvider;

routes/weatherProviders/WeatherProvider.ts

@@ -0,0 +1,19 @@
+import { GeoCoordinates, WateringData, WeatherData } from "../../types";
+
+export class WeatherProvider {
+	/**
+	 * Retrieves weather data necessary for watering level calculations.
+	 * @param coordinates The coordinates to retrieve the watering data for.
+	 * @return A Promise that will be resolved with the WateringData if it is successfully retrieved,
+	 * or rejected with an error message if an error occurs while retrieving the WateringData.
+	 */
+	getWateringData?( coordinates : GeoCoordinates ): Promise< WateringData >;
+
+	/**
+	 * Retrieves the current weather data for usage in the mobile app.
+	 * @param coordinates The coordinates to retrieve the weather for
+	 * @return A Promise that will be resolved with the WeatherData if it is successfully retrieved,
+	 * or rejected with an error message if an error occurs while retrieving the WeatherData.
+	 */
+	getWeatherData?( coordinates : GeoCoordinates ): Promise< WeatherData >;
+}

routes/weatherProviders/local.ts

@@ -1,6 +1,7 @@
 import * as express	from "express";
 import { CronJob } from "cron";
-import { GeoCoordinates, WateringData, WeatherProvider } from "../../types";
+import { GeoCoordinates, WateringData } from "../../types";
+import { WeatherProvider } from "./WeatherProvider";
 
 const count = { temp: 0, humidity: 0 };
 
@@ -43,7 +44,9 @@ export const captureWUStream = function( req: express.Request, res: express.Resp
 	res.send( "success\n" );
 };
 
-export const getLocalWateringData = function(): WateringData {
+export default class LocalWeatherProvider extends WeatherProvider {
+
+	public async getWateringData( coordinates: GeoCoordinates ): Promise< WateringData > {
 		const result: WateringData = {
 			...yesterday as WateringData,
 			// Use today's weather if we dont have information for yesterday yet (i.e. on startup)
@@ -59,6 +62,7 @@ export const getLocalWateringData = function(): WateringData {
 
 		return result;
 	};
+}
 
 new CronJob( "0 0 0 * * *", function() {
 
@@ -74,10 +78,3 @@ interface PWSStatus {
 	humidity?: number;
 	precip?: number;
 }
-
-const LocalWeatherProvider: WeatherProvider = {
-	getWateringData: async function ( coordinates: GeoCoordinates ) {
-		return getLocalWateringData();
-	}
-};
-export default LocalWeatherProvider;

types.ts

@@ -85,22 +85,4 @@ export interface AdjustmentOptions {
     d?: number;
 }
 
-export interface WeatherProvider {
-    /**
-     * Retrieves weather data necessary for watering level calculations.
-     * @param coordinates The coordinates to retrieve the watering data for.
-     * @return A Promise that will be resolved with the WateringData if it is successfully retrieved,
-     * or rejected with an error message if an error occurs while retrieving the WateringData.
-     */
-    getWateringData?( coordinates : GeoCoordinates ): Promise< WateringData >;
-
-    /**
-     * Retrieves the current weather data for usage in the mobile app.
-     * @param coordinates The coordinates to retrieve the weather for
-     * @return A Promise that will be resolved with the WeatherData if it is successfully retrieved,
-     * or rejected with an error message if an error occurs while retrieving the WeatherData.
-     */
-    getWeatherData?( coordinates : GeoCoordinates ): Promise< WeatherData >;
-}
-
 export type WeatherProviderId = "OWM" | "DarkSky" | "local";