Completed helper code and tests (which succeed).

Christopher Rabotin · Christopher Rabotin · commit 50ac36a17736 · 2015-01-14T12:45:21.000Z
diff --git a/influxdb/__init__.py b/influxdb/__init__.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 from .client import InfluxDBClient
 from .dataframe_client import DataFrameClient
+from .helper import SeriesHelper
 
 
 __all__ = [
diff --git a/influxdb/helper.py b/influxdb/helper.py
@@ -3,52 +3,67 @@
 Helper class for InfluxDB
 """
 from collections import namedtuple, defaultdict
+import six
 
-
-class InfluxDBSeriesHelper(object):
+class SeriesHelper(object):
+    __initialized__ = False
 
     def __new__(cls, *args, **kwargs):
-        # Introspect series representation.
-        try:
-            _meta = getattr(cls, 'Meta')
-        except AttributeError:
-            raise AttributeError('SeriesHelper {} does not contain a Meta class.'.format(cls.__name__))
-
-        for attribute in ['series_name', 'fields', 'client']:
+        if not SeriesHelper.__initialized__:
+            SeriesHelper.__initialized__ = True
+            # Introspect series representation.
             try:
-                setattr(cls, '_' + attribute, getattr(_meta, attribute))
+                _meta = getattr(cls, 'Meta')
             except AttributeError:
-                raise AttributeError('SeriesHelper\' {0} Meta class does not define {1}.'.format(cls.__name__, attribute))
-
-        cls._bulk_size = getattr(_meta, 'bulk_size', 1)
+                raise AttributeError('SeriesHelper {} does not contain a Meta class.'.format(cls.__name__))
+    
+            for attribute in ['series_name', 'fields', 'client']:
+                try:
+                    setattr(cls, '_' + attribute, getattr(_meta, attribute))
+                except AttributeError:
+                    raise AttributeError('SeriesHelper\' {0} Meta class does not define {1}.'.format(cls.__name__, attribute))
+    
+            cls._bulk_size = getattr(_meta, 'bulk_size', 1)
+    
+            # Class attribute definitions
+            cls._datapoints = defaultdict(list) # keys are the series name for ease of commit.
+            cls._type = namedtuple(cls.__name__, cls._fields)
 
-        # Class attribute definitions
-        cls._datapoints = defaultdict(list) # keys are the series name for ease of commit.
-        cls._type = namedtuple(cls.__name__, cls._fields)
-
-        return super(InfluxDBSeriesHelper, cls).__new__(cls, *args, **kwargs)
+        return super(SeriesHelper, cls).__new__(cls, *args, **kwargs)
 
     def __init__(self, **kwargs): # Does not support positional arguments.
         cls = self.__class__
 
         if sorted(cls._fields) != sorted(kwargs.keys()):
-            raise KeyError('[Fields enforced] Expected fields {0} and got {1}.'.format(sorted(cls._fields), sorted(kwargs.keys())))
+            raise NameError('Expected fields {0} and got {1}.'.format(', '.join(sorted(cls._fields)), ', '.join(sorted(kwargs.keys()))))
 
-        cls._datapoints[cls._series_name.format(**kwargs)] = cls._type(**kwargs)
+        cls._datapoints[cls._series_name.format(**kwargs)].append(cls._type(**kwargs))
 
         if len(cls._datapoints) > cls._bulk_size:
             cls.commit()
 
-    @staticmethod
-    def _json_body():
+    @classmethod
+    def commit(cls):
         '''
-        :return: JSON body of these datapoints.
+        Commit everything from datapoints via the client.
         '''
-        pass
+        rtn = cls._client.write_points(cls._json_body_())
+        cls._reset_()
+        return rtn
 
-    @staticmethod
-    def commit():
+    @classmethod
+    def _json_body_(cls):
         '''
-        Commit everything from datapoints via the client.
+        :return: JSON body of these datapoints.
         '''
-        pass
+        json_datapoints = []
+        for series_name, data in six.iteritems(cls._datapoints):
+            json_datapoints.append({'name': series_name,
+                                    'columns': cls._fields,
+                                    'points': [[point.__dict__[k] for k in cls._fields] for point in data]
+                                    })
+        return json_datapoints
+
+    @classmethod
+    def _reset_(cls):
+        cls._datapoints = defaultdict(list)
diff --git a/requirements.txt b/requirements.txt
@@ -1 +1,2 @@
 requests>=1.0.3
+six==1.9.0
diff --git a/tests/influxdb/helper_test.py b/tests/influxdb/helper_test.py
@@ -2,26 +2,63 @@
 
 import unittest
 
-from influxdb.helper import InfluxDBSeriesHelper
+from influxdb import SeriesHelper, InfluxDBClient
 
 
 class TestSeriesHelper(unittest.TestCase):
     @classmethod
     def setUpClass(cls):
         super(TestSeriesHelper, cls).setUpClass()
-        
-        class MySeriesHelper(InfluxDBSeriesHelper):
+
+        TestSeriesHelper.client = InfluxDBClient('host', 8086, 'username', 'password', 'database')
+
+        class MySeriesHelper(SeriesHelper):
             class Meta:
+                client = TestSeriesHelper.client
                 series_name = 'events.stats.{server_name}'
                 fields = ['time', 'server_name']
                 bulk_size = 5
-        
+
         TestSeriesHelper.MySeriesHelper = MySeriesHelper
 
-    def testFeatures(self):
+    def testSingleSeriesName(self):
+        '''
+        Tests JSON conversion when there is only one series name.
+        '''
+        TestSeriesHelper.MySeriesHelper(server_name='us.east-1', time=159)
+        TestSeriesHelper.MySeriesHelper(server_name='us.east-1', time=158)
+        TestSeriesHelper.MySeriesHelper(server_name='us.east-1', time=157)
+        TestSeriesHelper.MySeriesHelper(server_name='us.east-1', time=156)
+        expectation = [{'points': [[159, 'us.east-1'],
+                                   [158, 'us.east-1'],
+                                   [157, 'us.east-1'],
+                                   [156, 'us.east-1']],
+                        'name': 'events.stats.us.east-1',
+                        'columns': ['time', 'server_name']}]
+        self.assertListEqual(TestSeriesHelper.MySeriesHelper._json_body_(), expectation, 'Invalid JSON body of time series returned from _json_body_ for one series name.')
+        TestSeriesHelper.MySeriesHelper._reset_()
+        self.assertEqual(TestSeriesHelper.MySeriesHelper._json_body_(), [], 'Resetting helper did not empty datapoints.')
+
+    def testSeveralSeriesNames(self):
         '''
-        + Create event
-        + JSON
-        + Commit ? May be tough to test.
+        Tests JSON conversion when there is only one series name.
         '''
-        TestSeriesHelper.MySeriesHelper(server_name='us.east-1', time=159)
+        TestSeriesHelper.MySeriesHelper(server_name='us.east-1', time=159)
+        TestSeriesHelper.MySeriesHelper(server_name='fr.paris-10', time=158)
+        TestSeriesHelper.MySeriesHelper(server_name='lu.lux', time=157)
+        TestSeriesHelper.MySeriesHelper(server_name='uk.london', time=156)
+        expectation = [{'points': [[157, 'lu.lux']],
+                        'name': 'events.stats.lu.lux',
+                        'columns': ['time', 'server_name']},
+                       {'points': [[156, 'uk.london']],
+                        'name': 'events.stats.uk.london',
+                        'columns': ['time', 'server_name']},
+                       {'points': [[158, 'fr.paris-10']],
+                        'name': 'events.stats.fr.paris-10',
+                        'columns': ['time', 'server_name']},
+                       {'points': [[159, 'us.east-1']],
+                        'name': 'events.stats.us.east-1',
+                        'columns': ['time', 'server_name']}]
+        self.assertListEqual(TestSeriesHelper.MySeriesHelper._json_body_(), expectation, 'Invalid JSON body of time series returned from _json_body_ for several series names.')
+        TestSeriesHelper.MySeriesHelper._reset_()
+        self.assertEqual(TestSeriesHelper.MySeriesHelper._json_body_(), [], 'Resetting helper did not empty datapoints.')
