Merge pull request #11 from SlicingDice/feature/many-corrections-client

Make some code corrections on client

Author: joaosimbiose

pyslicer/api.py

@@ -20,7 +20,7 @@ class SlicingDiceAPI(object):
 
     def __init__(
         self, master_key=None, write_key=None, read_key=None,
-            custom_key=None, use_ssl=False, timeout=60):
+            custom_key=None, use_ssl=True, timeout=60):
         """Instantiate a new SlicerDicer object.
 
         Keyword arguments:

pyslicer/client.py

@@ -82,7 +82,7 @@ class SlicingDice(SlicingDiceAPI):
     """
     def __init__(
         self, write_key=None, read_key=None, master_key=None,
-            custom_key=None, use_ssl=False, timeout=60):
+            custom_key=None, use_ssl=True, timeout=60, uses_test_endpoint=False):
         """Instantiate a new SlicingDice object.
 
         Keyword arguments:
@@ -91,9 +91,11 @@ def __init__(
             HTTPS requests. Defaults False.(Optional)
         timeout(int) -- Define timeout to request,
             defaults 30 secs(default 30).
+        test(bool) -- if true will use tests end-point (default False)
         """
         super(SlicingDice, self).__init__(
-            write_key, read_key, master_key, custom_key, use_ssl, timeout)
+            master_key, write_key, read_key, custom_key, use_ssl, timeout)
+        self.uses_test_endpoint = uses_test_endpoint
 
     def _count_query_wrapper(self, url, query):
         """Validate count query and make request.
@@ -125,10 +127,9 @@ def _data_extraction_wrapper(self, url, query):
                 req_type="post",
                 key_level=0)
 
-    @staticmethod
-    def _wrapper_test(test):
+    def _wrapper_test(self):
         base_url = SlicingDice.BASE_URL
-        if test:
+        if self.uses_test_endpoint:
             base_url += "/test"
         return base_url
 
@@ -159,15 +160,14 @@ def get_projects(self):
             key_level=2
         )
 
-    def create_field(self, data, test=False):
+    def create_field(self, data):
         """Create field in Slicing Dice
 
         Keyword arguments:
         data -- A dictionary in the Slicing Dice field
             format.
-        test(bool) -- if true will use tests end-point (default False)
         """
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         sd_data = validators.FieldValidator(data)
         if sd_data.validator():
             url = base_url + URLResources.FIELD
@@ -177,32 +177,27 @@ def create_field(self, data, test=False):
                 json_data=ujson.dumps(data),
                 key_level=1)
 
-    def get_fields(self, test=False):
-        """Get a list of fields
-
-        Keyword arguments:
-        test(bool) -- if true will use tests end-point (default False)
-        """
-        base_url = self._wrapper_test(test)
+    def get_fields(self):
+        """Get a list of fields"""
+        base_url = self._wrapper_test()
         url = base_url + URLResources.FIELD
         return self._make_request(
             url=url,
             req_type="get",
             key_level=2)
 
-    def index(self, data, auto_create_fields=False, test=False):
+    def index(self, data, auto_create_fields=False):
         """Make a index in Slicing Dice API
 
         Keyword arguments:
         data -- A dictionary in the Slicing Dice index
             format.
         auto_create_fields(bool) -- if true SlicingDice API will automatically
             create nonexistent fields (default False)
-        test(bool) -- if true will use tests end-point (default False)
         """
         if auto_create_fields:
             data["auto-create-fields"] = True
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         sd_data = validators.IndexValidator(data)
         if sd_data.validator():
             url = base_url + URLResources.INDEX
@@ -212,48 +207,42 @@ def index(self, data, auto_create_fields=False, test=False):
                 req_type="post",
                 key_level=1)
 
-    def count_entity(self, query, test=False):
+    def count_entity(self, query):
         """Make a count entity query
 
         Keyword arguments:
         query -- A dictionary in the Slicing Dice query
-        test(bool) -- if true will use tests end-point (default False)
         """
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         url = base_url + URLResources.QUERY_COUNT_ENTITY
         return self._count_query_wrapper(url, query)
 
-    def count_entity_total(self, test=False):
-        """Make a count entity total query
-
-        test(bool) -- if true will use tests end-point (default False)
-        """
-        base_url = self._wrapper_test(test)
+    def count_entity_total(self):
+        """Make a count entity total query"""
+        base_url = self._wrapper_test()
         url = base_url + URLResources.QUERY_COUNT_ENTITY_TOTAL
         return self._make_request(
             url=url,
             req_type="get",
             key_level=0)
 
-    def count_event(self, query, test=False):
+    def count_event(self, query):
         """Make a count event query
 
         Keyword arguments:
         data -- A dictionary query
-        test(bool) -- if true will use tests end-point (default False)
         """
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         url = base_url + URLResources.QUERY_COUNT_EVENT
         return self._count_query_wrapper(url, query)
 
-    def aggregation(self, query, test=False):
+    def aggregation(self, query):
         """Make a aggregation query
 
         Keyword arguments:
         query -- An aggregation query
-        test(bool) -- if true will use tests end-point (default False)
         """
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         url = base_url + URLResources.QUERY_AGGREGATION
         if "query" not in query:
             raise exceptions.InvalidQueryException(
@@ -268,14 +257,13 @@ def aggregation(self, query, test=False):
             req_type="post",
             key_level=0)
 
-    def top_values(self, query, test=False):
+    def top_values(self, query):
         """Make a top values query
 
         Keyword arguments:
         query -- A dictionary query
-        test(bool) -- if true will use tests end-point (default False)
         """
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         url = base_url + URLResources.QUERY_TOP_VALUES
         sd_query_top_values = validators.QueryValidator(query)
         if sd_query_top_values.validator():
@@ -285,14 +273,13 @@ def top_values(self, query, test=False):
                 req_type="post",
                 key_level=0)
 
-    def exists_entity(self, ids, test=False):
+    def exists_entity(self, ids):
         """Make a exists entity query
 
         Keyword arguments:
         ids -- A list with entity to check if exists
-        test(bool) -- if true will use tests end-point (default False)
         """
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         url = base_url + URLResources.QUERY_EXISTS_ENTITY
         if len(ids) > 100:
             raise exceptions.MaxLimitException(
@@ -306,90 +293,83 @@ def exists_entity(self, ids, test=False):
             req_type="post",
             key_level=0)
 
-    def get_saved_query(self, query_name, test=False):
+    def get_saved_query(self, query_name):
         """Get a saved query
 
         Keyword arguments:
         query_name(string) -- The name of the saved query
-        test(bool) -- if true will use tests end-point (default False)
         """
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         url = base_url + URLResources.QUERY_SAVED + query_name
         return self._make_request(
             url=url,
             req_type="get",
             key_level=0)
 
-    def get_saved_queries(self, test=False):
+    def get_saved_queries(self):
         """Get all saved queries
 
         Keyword arguments:
         query_name(string) -- The name of the saved query
-        test(bool) -- if true will use tests end-point (default False)
         """
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         url = base_url + URLResources.QUERY_SAVED
         return self._make_request(
             url=url,
             req_type="get",
             key_level=2)
 
-    def delete_saved_query(self, query_name, test=False):
+    def delete_saved_query(self, query_name):
         """Delete a saved query
 
         Keyword arguments:
         query_name(string) -- The name of the saved query
-        test(bool) -- if true will use tests end-point (default False)
         """
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         url = base_url + URLResources.QUERY_SAVED + query_name
         return self._make_request(
             url=url,
             req_type="delete",
             key_level=2
         )
 
-    def create_saved_query(self, query, test=False):
+    def create_saved_query(self, query):
         """Get a list of queries saved
 
         Keyword arguments:
         query -- A dictionary query
-        test(bool) -- if true will use tests end-point (default False)
         """
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         url = base_url + URLResources.QUERY_SAVED
         return self._saved_query_wrapper(url, query)
 
-    def update_saved_query(self, name, query, test=False):
+    def update_saved_query(self, name, query):
         """Get a list of queries saved
 
         Keyword arguments:
         name -- The name of the saved query to update
         query -- A dictionary query
-        test(bool) -- if true will use tests end-point (default False)
         """
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         url = base_url + URLResources.QUERY_SAVED + name
         return self._saved_query_wrapper(url, query, True)
 
-    def result(self, query, test=False):
+    def result(self, query):
         """Get a data extraction result
 
         Keyword arguments:
         query -- A dictionary query
-        test(bool) -- if true will use tests end-point (default False)
         """
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         url = base_url + URLResources.QUERY_DATA_EXTRACTION_RESULT
         return self._data_extraction_wrapper(url, query)
 
-    def score(self, query, test=False):
+    def score(self, query):
         """Get a data extraction score
 
         Keyword arguments:
         query -- A dictionary query
-        test(bool) -- if true will use tests end-point (default False)
         """
-        base_url = self._wrapper_test(test)
+        base_url = self._wrapper_test()
         url = base_url + URLResources.QUERY_DATA_EXTRACTION_SCORE
         return self._data_extraction_wrapper(url, query)