Merge pull request #11 from uriweb/release-2.0

Release 2.0

README.md

@@ -1,17 +1,17 @@
 # URI Tides Widget
 
-Add the `[uri-tides]` shortcode to a page and a tides widget appears.
+Add the `[uri-tides]` shortcode to a page and a tides widget appears.  Requires the [URI Tides Updater](https://github.com/uriweb/uri-tides-updater) plugin to be installed and activated on at least one site in a multisite network.
 
-The widget pulls in live water temp and tide prediction data from NOAA and graphically displays the current position of the tide.  By default, data is pulled from the station at Quonset Point, RI, but a different station or buoy can be set if desired.
+## How do I get set up?
+
+1. Install [URI Tides Updater](https://github.com/uriweb/uri-tides-updater). For multisite networks, activate it only on one site (e.g. the homepage) to avoid cron job duplication.
+2. Install [URI Tides](https://github.com/uriweb/uri-tides/archive/refs/heads/master.zip) and activate it where you intend to use it.  Network-activation may be appropriate.
+3. Configure the shortcode to taste.
 
 ## Attributes
 
 The tides widget is somewhat configurable by adding attributes to the shortcode:
 
-**`station`** (num)(optional)  
-The NOAA station ID from which to retrieve data. The default is Quonset Point, RI. (default: `8454049`)  
-Find a station on NOAA's [tides and currents website](https://tidesandcurrents.noaa.gov/stations.html).
-
 **`height`** (num)(optional)  
 Set a height in pixels for the tide chart (do not include units). The water temp will scale accordingly. (default: `30`)
 
@@ -26,5 +26,5 @@ Set custom CSS class(s) (default: none)
 Contributors: Brandon Fuller, John Pennypacker  
 Tags: widgets  
 Requires at least: 4.0  
-Tested up to: 4.9  
-Stable tag: 1.1.1  
+Tested up to: 6.0  
+Stable tag: 2.0  

js/tides.js

@@ -2,15 +2,6 @@
 
     'use strict';
 
-    /*
-     * See CO-OPS JSON API documentation at https://tidesandcurrents.noaa.gov/api/
-     */
-    var parameters = {
-        'timezone' : 'GMT',
-        'baseURL' : 'https://tidesandcurrents.noaa.gov/api/datagetter?'
-    };
-
-
     // Wait for the window to load...
     window.addEventListener('load', function(){
         uriTidesInit();
@@ -95,12 +86,11 @@
                 'padding' : h * (1/6)
             };
 
-            // Set the station id
-            var station = els[i].getAttribute('data-station');
-
-            helpers.status(els[i], 'Initiating tide data...');
-            buildChart(els[i], curve, station, );
-        };
+            if ( tides ) {
+                helpers.status(els[i], 'Initiating tide data...');
+                buildChart(els[i], curve );
+            }
+        }
 
     }
 
@@ -109,10 +99,9 @@
      * @param el el the tide widget element
      * @param curve obj the curve dimensions
      */
-		function buildChart(el, curve, station) {
+		function buildChart(el, curve) {
 
-			var tideHeight,
-					output,
+			var     output,
 					tide = tides.tide.predictions,
 					temp = tides.temperature.data,
 					display = {
@@ -178,9 +167,9 @@
         var x = (2 * Math.PI) / m.cycle * m.x;
         m.y = Math.sin(x) + 1;
 
-				// prepare the date of tide retrieval for display
+		// prepare the date of tide retrieval for display
         var retrieved = new Date(tides.date * 1000);
-				var options = { year: 'numeric', month: 'short', day: 'numeric', hour: "2-digit", minute: "2-digit" };
+		var options = { year: 'numeric', month: 'short', day: 'numeric', hour: "2-digit", minute: "2-digit" };
 
         var fillcolor = el.classList.contains('darkmode') ? '#fff' : '#555';
 
@@ -193,7 +182,7 @@
         output += '</svg>';
         output += '</div>';
 
-        output += '<div class="uri-tides-source">Source: <a href="https://tidesandcurrents.noaa.gov/stationhome.html?id=' + station + '" title="NOAA Center for Operational Oceanographic Producs and Services; tide data retrieved: ' + retrieved.toLocaleDateString("en-US", options) + '">NOAA/NOS/CO-OPS</a></div>';
+        output += '<div class="uri-tides-source">Source: <a href="https://tidesandcurrents.noaa.gov/stationhome.html?id=8454049" title="NOAA Center for Operational Oceanographic Producs and Services; tide data retrieved: ' + retrieved.toLocaleDateString("en-US", options) + '">NOAA/NOS/CO-OPS</a></div>';
 
 
         // Display