Merge pull request #3 from logicmonitor/validation-fix

Validation fix

Author: choprasan

docs/source/index.rst

@@ -27,7 +27,7 @@ The :mod:`logicmonitor_data_sdk` module provides
 Requirements.
 *************
 
-Python 2.7 and 3.4+
+Python 3.4+
 
 .. _RST Installation:
 
@@ -175,4 +175,4 @@ ResponseInterface
 
 Get in Touch
 ============
-If you have questions in general, reach out to our support@logicmonitor.com
+If you have questions in general, reach out to our support@logicmonitor.com

logicmonitor_data_sdk/configuration.py

@@ -7,15 +7,13 @@
 import multiprocessing
 import os
 import platform
-
 import six
 from six.moves import http_client as httplib
 
+from logicmonitor_data_sdk.utils.object_name_validator import ObjectNameValidator
 from logicmonitor_data_sdk.version import __version__
 
-
-# logging.basicConfig()
-
+objectNameValidator = ObjectNameValidator()
 
 class TypeWithDefault(type):
   def __init__(cls, name, bases, dct):
@@ -61,6 +59,10 @@ def __init__(self, company=None, authentication=None, id=None, key=None):
       raise ValueError(
           'Company must have your account name'
       )
+    if not objectNameValidator.is_valid_company_name(company):
+      raise ValueError(
+          'Invalid Company Name'
+      )
     if not authentication:
       id = os.environ.get('LM_ACCESS_ID', id)
       key = os.environ.get('LM_ACCESS_KEY', key)
@@ -72,6 +74,15 @@ def __init__(self, company=None, authentication=None, id=None, key=None):
       raise ValueError(
           'Authentication must provide the `id` and `key`'
       )
+    if not objectNameValidator.is_valid_auth_id(id):
+      raise ValueError(
+          'Invalid Access ID'
+      )
+    if key:
+      if not objectNameValidator.is_valid_auth_key(key):
+        raise ValueError(
+          'Invalid Access Key'
+        )
     self._company = company
     self._host = "https://" + self._company + ".logicmonitor.com/rest"
     self.check_authentication(authentication)

logicmonitor_data_sdk/models/datapoint.py

@@ -19,13 +19,14 @@ class DataPoint(object):
     name (:obj:`str`): Datapoint name. If no existing datapoint  matches for specified
       DataSource, a new datapoint is created with this name.
     aggregation_type (:obj:`str`, optional): The aggregation method, if any, that should be used
-      if data is pushed in sub-minute intervals. Only considered when creating
+      if data is pushed in sub-minute intervals. Allowed options are "sum", "average" and "none"(default) 
+      where "none" would take last value for that minute. Only considered when creating
       a new datapoint. See the About the Push Metrics REST API section of this
       guide for more information on datapoint value aggregation intervals.
     description (:obj:`str`, optional) : Datapoint description. Only considered when creating a
       new datapoint.
-    type (:obj:`str`, optional) : Metric type as a number in string format. Only considered when
-      creating a new datapoint.
+    type (:obj:`str`, optional) : Metric type as a number in string format. Allowed options are 
+      "guage" (default) and "counter". Only considered when creating a new datapoint.
 
   Examples:
       >>> from logicmonitor_data_sdk.models.datapoint import DataPoint
@@ -74,7 +75,7 @@ def __hash__(self):
   @property
   def aggregation_type(self):
     """The aggregation method, if any, that should be used if data is pushed in
-    sub-minute intervals. Only considered when creating a new datapoint.
+    sub-minute intervals. Aloowed values are 'sum', 'average' and 'none'(default). Only considered when creating a new datapoint.
 
     :return: The type of this DataPoint.
     :rtype: str
@@ -128,9 +129,9 @@ def name(self, name):
 
   @property
   def type(self):
-    """Metric type as a number in string format. Only considered when creating a new datapoint.
+    """Metric type (guage or counter) as a number in string format. Only considered when creating a new datapoint.
 
-    :return: The aggregation_type of this DataPoint.
+    :return: The type of this DataPoint.
     :rtype: str
     """
     return self._type

logicmonitor_data_sdk/utils/object_name_validator.py

@@ -30,6 +30,15 @@
 REGEX_DATA_SOURCE_GROUP_NAME = "[a-zA-Z0-9_\\- ]+$"
 PATTERN_DATA_SOURCE_GROUP_NAME = re.compile(REGEX_DATA_SOURCE_GROUP_NAME)
 
+REGEX_COMPANY_NAME = "^[a-zA-Z0-9_.\\-]+$"
+PATTERN_COMPANY_NAME = re.compile(REGEX_COMPANY_NAME)
+
+REGEX_AUTH_ID = "^[a-zA-Z0-9]+$"
+PATTERN_AUTH_ID = re.compile(REGEX_AUTH_ID)
+
+REGEX_AUTH_KEY = "[\s]"
+PATTERN_AUTH_KEY = re.compile(REGEX_AUTH_KEY)
+
 _INVALID_DATA_POINT_NAME_SET = {
   "SIN",
   "COS",
@@ -109,7 +118,7 @@ def is_valid_resource_name(self, resource_name):
     return bool(PATTERN_RESOURCE_NAME.match(resource_name))
 
   def is_valid_resource_id(self, resource_id):
-    return not bool(PATTERN_REGEX_INVALID_RESOURCE_NAME.match(resource_id))
+    return not bool(PATTERN_REGEX_INVALID_RESOURCE_NAME.search(resource_id))
 
   def is_valid_datasource_name(self, name):
     return len(self.validate_datasource_name(name)) == 0
@@ -150,6 +159,15 @@ def _validate(self, name, field_name, invalid_patten):
   def is_valid_instance_name(self, instance_name):
     return bool(PATTERN_INSTANCE_NAME.match(instance_name))
 
+  def is_valid_company_name(self, company_name):
+    return bool(PATTERN_COMPANY_NAME.match(company_name))
+
+  def is_valid_auth_id(self, auth_id):
+    return bool(PATTERN_AUTH_ID.match(auth_id))
+
+  def is_valid_auth_key(self, auth_key):
+    return not bool(PATTERN_AUTH_KEY.search(auth_key))
+
   def validate_device_display_name(self, name):
     return self._validate(name, "instance display name",
                           PATTERN_INVALID_DEVICE_DISPLAY_NAME)

logicmonitor_data_sdk/version.py

@@ -0,0 +1 @@
+__version__ = "0.0.1.beta1"