Merge pull request #96 from brentru/new-time-endpoint

Add new IP-based time endpoint

Author: brentru

Adafruit_IO/_version.py

@@ -1 +1 @@
-__version__ = "2.3.1"
+__version__ = "2.3.2"

Adafruit_IO/client.py

@@ -18,6 +18,7 @@
 # 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.
+from time import struct_time
 import json
 import platform
 import pkg_resources
@@ -107,19 +108,15 @@ def _handle_error(response):
             raise RequestError(response)
         # Else do nothing if there was no error.
 
-    def _compose_url(self, path, is_time=None):
-        if is_time: # return a call to https://io.adafruit.com/api/v2/time/{unit}
-            return '{0}/api/{1}/{2}'.format(self.base_url, 'v2', path)
+    def _compose_url(self, path):
         return '{0}/api/{1}/{2}/{3}'.format(self.base_url, 'v2', self.username, path)
 
-    def _get(self, path, is_time=None):
-        response = requests.get(self._compose_url(path, is_time),
+    def _get(self, path):
+        response = requests.get(self._compose_url(path),
                                 headers=self._headers({'X-AIO-Key': self.key}),
                                 proxies=self.proxies)
         self._handle_error(response)
-        if not is_time:
-            return response.json()
-        return response.text
+        return response.json()
 
     def _post(self, path, data):
         response = requests.post(self._compose_url(path),
@@ -180,12 +177,14 @@ def append(self, feed, value):
         """
         return self.create_data(feed, Data(value=value))
 
-    def receive_time(self, time):
-        """Returns the time from the Adafruit IO server.
-        :param string time: Time to be returned: `millis`, `seconds`, `ISO-8601`.
+    def receive_time(self):
+        """Returns a struct_time from the Adafruit IO Server based on the device's IP address.
+        https://docs.python.org/3.7/library/time.html#time.struct_time
         """
-        timepath = "time/{0}".format(time)
-        return self._get(timepath, is_time=True)
+        path = 'integrations/time/struct.json'
+        time = self._get(path)
+        return struct_time((time['year'], time['mon'], time['mday'], time['hour'],
+                            time['min'], time['sec'], time['wday'], time['yday'], time['isdst']))
 
     def receive_weather(self, weather_id=None):
         """Adafruit IO Weather Service, Powered by Dark Sky

examples/basics/time-topics.py renamed to examples/basics/time.py

@@ -1,10 +1,11 @@
 """
-`time-topics.py`
-====================================
+`time.py`
+==========================================
 Don't have a RTC handy and need
 accurate time measurements?
 
-Let Adafruit IO serve real-time values!
+Let Adafruit IO serve up real-time values
+based off your device's IP-address!
 
 Author: Brent Rubell
 """
@@ -23,16 +24,8 @@
 # Create an instance of the REST client.
 aio = Client(ADAFRUIT_IO_USERNAME, ADAFRUIT_IO_KEY)
 
-print('---Adafruit IO REST API Time Helpers---')
-
-print('Seconds: aio.receive_time(seconds)')
-secs_val = aio.receive_time('seconds')
-print('\t' + secs_val)
-
-print('Milliseconds: aio.receive_time(millis)')
-ms_val = aio.receive_time('millis')
-print('\t' + ms_val)
-
-print('ISO-8601: aio.receive_time(ISO-8601)')
-iso_val = aio.receive_time('ISO-8601')
-print('\t' + iso_val)
+# Get the time from Adafruit IO
+time = aio.receive_time()
+# Time is returned as a `struct_time`
+# https://docs.python.org/3.7/library/time.html#time.struct_time
+print(time)

tests/test_client.py

@@ -80,6 +80,8 @@ def test_send_batch_data(self):
         self.assertEqual(int(data.value), 42)
 
     def test_receive_next(self):
+        """receive_next
+        """
         io = self.get_client()
         self.ensure_feed_deleted(io, 'testfeed')
         test_feed = io.create_feed(Feed(name="testfeed"))
@@ -88,6 +90,8 @@ def test_receive_next(self):
         self.assertEqual(int(data.value), 1)
 
     def test_receive_previous(self):
+        """receive_previous
+        """
         io = self.get_client()
         self.ensure_feed_deleted(io, 'testfeed')
         test_feed = io.create_feed(Feed(name="testfeed"))
@@ -101,6 +105,8 @@ def test_receive_previous(self):
         self.assertEqual(int(data.value), 2)
 
     def test_data_on_feed_returns_all_data(self):
+        """send_data
+        """
         io = self.get_client()
         self.ensure_feed_deleted(io, 'testfeed')
         test_feed = io.create_feed(Feed(name="testfeed"))
@@ -112,6 +118,8 @@ def test_data_on_feed_returns_all_data(self):
         self.assertEqual(int(result[1].value), 1)
 
     def test_data_on_feed_and_data_id_returns_data(self):
+        """send_data
+        """
         io = self.get_client()
         self.ensure_feed_deleted(io, 'testfeed')
         test_feed = io.create_feed(Feed(name="testfeed"))
@@ -121,6 +129,8 @@ def test_data_on_feed_and_data_id_returns_data(self):
         self.assertEqual(int(data.value), int(result.value))
 
     def test_create_data(self):
+        """create_data
+        """
         aio = self.get_client()
         self.ensure_feed_deleted(aio, 'testfeed')
         test_feed = aio.create_feed(Feed(name="testfeed"))
@@ -130,6 +140,8 @@ def test_create_data(self):
         self.assertEqual(int(result.value), 42)
 
     def test_location_data(self):
+        """receive_location
+        """
         aio = self.get_client()
         self.ensure_feed_deleted(aio, 'testlocfeed')
         test_feed = aio.create_feed(Feed(name='testlocfeed'))
@@ -144,6 +156,16 @@ def test_location_data(self):
         self.assertEqual(float(data.lon), -74.005334)
         self.assertEqual(float(data.ele), -6.0)
 
+    def test_time_data(self):
+        """receive_time
+        """
+        aio = self.get_client()
+        time = aio.receive_time()
+        # Check that each value is rx'd properly
+        # (should never be None type)
+        for time_data in time:
+            self.assertIsNotNone(time_data)
+
     # Test Feed Functionality
     def test_append_by_feed_name(self):
         io = self.get_client()