Cleaned up and added tests for date utilities. Bumped version to 0.3

docs/api.rst

@@ -22,8 +22,8 @@ Credentials & Authentication
 
 .. autoclass:: AuthenticationException
 
-Utils
+Dates
 -----
 
-.. automodule:: mygeotab.utils
+.. automodule:: mygeotab.dates
    :members:

mygeotab/__init__.py

@@ -4,4 +4,4 @@
 
 __title__ = 'mygeotab'
 __author__ = 'Aaron Toth'
-__version__ = '0.2'
+__version__ = '0.3'

mygeotab/cli.py

@@ -12,7 +12,7 @@
 
 import mygeotab
 import mygeotab.api
-import mygeotab.utils
+import mygeotab.dates
 
 
 class Session(object):
@@ -202,7 +202,7 @@ def console(session, database=None, user=None, password=None, server=None):
         click.echo('Your session has expired. Please login again.')
         api = login(session, user, password, database, server)
 
-    methods = dict(my=api, mygeotab=mygeotab, utils=mygeotab.utils)
+    methods = dict(my=api, mygeotab=mygeotab, dates=mygeotab.dates)
     version = 'MyGeotab Console {0} [Python {1}]'.format(mygeotab.__version__,
                                                          sys.version.replace('\n', ''))
     auth_line = ('Logged in as: %s' % session.credentials) if session.credentials else 'Not logged in'

mygeotab/utils.py → mygeotab/dates.py

@@ -6,7 +6,7 @@
 from tzlocal import get_localzone
 
 
-def datetime_to_iso8601(dt):
+def format_iso_datetime(dt):
     """
     Formats the given datetime as a UTC-zoned ISO 8601 date string
 
@@ -17,16 +17,6 @@ def datetime_to_iso8601(dt):
     return dt.replace(tzinfo=None).isoformat() + 'Z'
 
 
-def parse_iso8601_datetime(iso_date):
-    """
-    Parses an ISO 8601 date string into a datetime object
-
-    :param iso_date: The date string
-    :return: The datetime object which represents the ISO 8601 string
-    """
-    return datetime.strptime(iso_date, "%Y-%m-%dT%H:%M:%S.%fZ")
-
-
 def localize_datetime(dt, tz=None):
     """
     Converts a naive or UTC-localized date into the provided timezone or current machine's timezone

mygeotab/serializers.py

@@ -5,13 +5,13 @@
 import six
 from dateutil import parser
 
-import mygeotab.utils
+import mygeotab.dates
 
 datetime_regex = re.compile(r'^\d{4}\-\d{2}\-\d{2}')
 
 
 def object_serializer(obj):
-    return mygeotab.utils.datetime_to_iso8601(obj) if hasattr(obj, 'isoformat') else obj
+    return mygeotab.dates.format_iso_datetime(obj) if hasattr(obj, 'isoformat') else obj
 
 
 def object_deserializer(obj):

tests/test_utils.py → tests/test_dates.py

@@ -5,7 +5,7 @@
 
 import pytz
 
-from mygeotab import utils
+from mygeotab import dates
 
 
 class TestGetUtcDate(unittest.TestCase):
@@ -14,7 +14,7 @@ def setUp(self):
 
     def test_naive_datetime_to_utc(self):
         date = datetime(2015, 3, 12, 2, 45, 34)
-        utc_date = utils.localize_datetime(date, pytz.utc)
+        utc_date = dates.localize_datetime(date, pytz.utc)
         self.assertIsNotNone(utc_date.tzinfo)
         self.assertIs(utc_date.tzinfo, pytz.utc)
         self.assertEqual(utc_date.year, date.year)
@@ -24,7 +24,7 @@ def test_naive_datetime_to_utc(self):
 
     def test_utc_datetime_to_utc(self):
         date = pytz.utc.localize(datetime(2015, 3, 12, 2, 45, 34))
-        utc_date = utils.localize_datetime(date, pytz.utc)
+        utc_date = dates.localize_datetime(date, pytz.utc)
         self.assertIsNotNone(utc_date.tzinfo)
         self.assertIs(utc_date.tzinfo, pytz.utc)
         self.assertEqual(utc_date.year, date.year)
@@ -35,7 +35,7 @@ def test_utc_datetime_to_utc(self):
     def test_zoned_datetime_to_utc(self):
         tz = pytz.timezone('US/Eastern')
         date = tz.localize(datetime(2015, 3, 12, 2, 45, 34))
-        utc_date = utils.localize_datetime(date, pytz.utc)
+        utc_date = dates.localize_datetime(date, pytz.utc)
         check_date = date.astimezone(pytz.utc)
         self.assertIsNotNone(utc_date.tzinfo)
         self.assertIs(utc_date.tzinfo, pytz.utc)
@@ -45,5 +45,28 @@ def test_zoned_datetime_to_utc(self):
         self.assertEqual(utc_date.hour, check_date.hour)
 
 
+class TestFormatIsoDate(unittest.TestCase):
+    def setUp(self):
+        pass
+
+    def test_format_naive_datetime(self):
+        date = datetime(2015, 3, 12, 2, 45, 34)
+        check_fmt = '2015-03-12T02:45:34Z'
+        fmt_date = dates.format_iso_datetime(date)
+        self.assertEqual(fmt_date, check_fmt)
+
+    def test_format_utc_datetime(self):
+        date = pytz.utc.localize(datetime(2015, 3, 12, 2, 45, 34))
+        check_fmt = '2015-03-12T02:45:34Z'
+        fmt_date = dates.format_iso_datetime(date)
+        self.assertEqual(fmt_date, check_fmt)
+
+    def test_format_local_datetime(self):
+        est = pytz.timezone('US/Eastern')
+        date = est.localize(datetime(2015, 3, 12, 2, 45, 34))
+        check_fmt = '2015-03-12T06:45:34Z'
+        fmt_date = dates.format_iso_datetime(date)
+        self.assertEqual(fmt_date, check_fmt)
+
 if __name__ == '__main__':
     unittest.main()