Merge pull request #29 from SlicingDice/feature/new-api-formats

Change client to match new api formats

Author: joaosimbiose

CHANGELOG.md

@@ -4,6 +4,8 @@
 ### Updated
 - Make client compatible with python 3
 - Correct data extraction validator to accept columns: all
+- Add support  for SQL queries on client
+- Adapt test queries to the changes on SlicingDice API
 
 ## [2.0.0]
 ### Updated

README.md

@@ -36,7 +36,7 @@ If this is the first register ever entered into the system,
 from pyslicer import SlicingDice
 
 # Configure the client
-client = SlicingDice(master_key='API_KEY', uses_test_endpoint=False)
+client = SlicingDice(master_key='API_KEY')
 
 # Inserting data
 insert_data = {
@@ -90,7 +90,7 @@ Get information about current database(related to api keys informed on construct
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_API_KEY')
 print(client.get_database())
 ```
 
@@ -116,7 +116,7 @@ Get all created columns, both active and inactive ones. This method corresponds
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_API_KEY')
 print(client.get_columns())
 ```
 
@@ -155,7 +155,7 @@ Create a new column. This method corresponds to a [POST request at /column](http
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_API_KEY')
 column = {
     "name": "Year",
     "api-name": "year",
@@ -182,7 +182,7 @@ Insert data to existing entities or create new entities, if necessary. This meth
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_OR_WRITE_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_OR_WRITE_API_KEY')
 insert_data = {
     "user1@slicingdice.com": {
         "car-model": "Ford Ka",
@@ -239,7 +239,7 @@ Verify which entities exist in a table (uses `default` table if not provided) gi
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_OR_READ_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_OR_READ_API_KEY')
 ids = [
     "user1@slicingdice.com",
     "user2@slicingdice.com",
@@ -271,7 +271,7 @@ Count the number of inserted entities in the whole database. This method corresp
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_OR_READ_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_OR_READ_API_KEY')
 
 print(client.count_entity_total())
 ```
@@ -295,7 +295,7 @@ Count the total number of inserted entities in the given tables. This method cor
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_OR_READ_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_OR_READ_API_KEY')
 
 tables = ['default']
 
@@ -321,7 +321,7 @@ Count the number of entities matching the given query. This method corresponds t
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_OR_READ_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_OR_READ_API_KEY')
 query = [
     {
         "query-name": "corolla-or-fit",
@@ -375,7 +375,7 @@ Count the number of occurrences for time-series events matching the given query.
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_OR_READ_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_OR_READ_API_KEY')
 query = [
     {
         "query-name": "test-drives-in-ny",
@@ -431,7 +431,7 @@ Return the top values for entities matching the given query. This method corresp
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_OR_READ_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_OR_READ_API_KEY')
 query = {
     "car-year": {
         "year": 2
@@ -489,7 +489,7 @@ Return the aggregation of all columns in the given query. This method correspond
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_OR_READ_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_OR_READ_API_KEY')
 query = {
     "query": [
         {
@@ -538,7 +538,7 @@ Get all saved queries. This method corresponds to a [GET request at /query/saved
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_API_KEY')
 print(client.get_saved_queries())
 ```
 
@@ -589,7 +589,7 @@ Create a saved query at SlicingDice. This method corresponds to a [POST request
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_API_KEY')
 query = {
     "name": "my-saved-query",
     "type": "count/entity",
@@ -643,7 +643,7 @@ Update an existing saved query at SlicingDice. This method corresponds to a [PUT
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_API_KEY')
 new_query = {
     "type": "count/entity",
     "query": [
@@ -696,7 +696,7 @@ Executed a saved query at SlicingDice. This method corresponds to a [GET request
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_OR_READ_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_OR_READ_API_KEY')
 print(client.get_saved_query('my-saved-query'))
 ```
 
@@ -733,7 +733,7 @@ Delete a saved query at SlicingDice. This method corresponds to a [DELETE reques
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_API_KEY')
 print(client.delete_saved_query('my-saved-query'))
 ```
 
@@ -768,7 +768,7 @@ Retrieve inserted values for entities matching the given query. This method corr
 
 ```python
 from pyslicer import SlicingDice
-client = SlicingDice('MASTER_OR_READ_API_KEY', uses_test_endpoint=False)
+client = SlicingDice('MASTER_OR_READ_API_KEY')
 query = {
     "query": [
         {
@@ -855,7 +855,6 @@ print(client.score(query))
         }
     },
     "page": 1,
-    "page": 1,
     "next-page": null,
     "took": 0.063
 }

pyslicer/api.py

@@ -27,7 +27,7 @@ def __init__(
         use_ssl(bool) -- Define if the request uses verification SSL for
             HTTPS requests. Defaults False.(Optional)
         timeout(int) -- Define timeout to request,
-            defaults 30 secs(Optional).
+            defaults 60 secs(Optional).
         """
         self.keys = self._organize_keys(
             master_key, custom_key, read_key, write_key)
@@ -78,25 +78,31 @@ def _check_key(self, key_level):
                 "This key is not allowed to perform this operation.")
         return current_key_level[0]
 
-    def _make_request(self, url, req_type, key_level, json_data=None):
+    def _make_request(self, url, req_type, key_level, json_data=None,
+                      string_data=None, content_type='application/json'):
         """Returns a object request result
 
         Keyword arguments:
         url(string) -- the url to make a request
         req_type(string) -- the request type (POST, PUT, DELETE or GET)
         key_level(int) -- Define the key level needed
         json_data(json) -- The json to use on request (default None)
+        content_type(string) -- The content_type to use in the request (default
+         'application/json')
         """
         self._check_key(key_level)
-        headers = {'Content-Type': 'application/json',
+        headers = {'Content-Type': content_type,
                    'Authorization': self._api_key}
 
+        data = json_data
+        if string_data is not None and json_data is None:
+            data = string_data
         req = None
 
         if req_type == "post":
             req = self._requester.post(
                 url,
-                data=json_data,
+                data=data,
                 headers=headers)
         elif req_type == "get":
             req = self._requester.get(
@@ -111,7 +117,7 @@ def _make_request(self, url, req_type, key_level, json_data=None):
         elif req_type == "put":
             req = self._requester.put(
                 url,
-                data=json_data,
+                data=data,
                 headers=headers)
 
         return self._handler_request(req)
@@ -128,7 +134,8 @@ def _handler_request(self, req):
         try:
             result = ujson.loads(req.text)
         except ValueError as e:
-            raise exceptions.InternalException("Error while trying to load Json: %s" % e.message)
+            raise exceptions.InternalException("Error while trying to load"
+                                               " Json: %s" % e.message)
 
         sd_response = SDHandlerResponse(
             result=result,