Merge pull request #19 from SlicingDice/feature/change-tests-to-dimension

Change table to dimension on code

Author: joaosimbiose

README.md

@@ -37,14 +37,14 @@ into the system, the answer should be a list whose only element is
 require 'rbslicer'
 
 # Configure the client
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: true)
+client = SlicingDice.new(master_key: "API_KEY")
 
 # Inserting data
 insert_data = {
     "user50@slicingdice.com" => {
         "age" => 22
     },
-    "auto-create" => ["table", "column"]
+    "auto-create" => ["dimension", "column"]
 }
 client.insert(insert_data)
 
@@ -75,14 +75,13 @@ puts client.count_entity(query_data)
 
 ### Constructor
 
-`initialize(master_key: nil, custom_key: nil, read_key: nil, write_key: nil, timeout: 60, use_ssl: true, uses_test_endpoint: false)`
+`initialize(master_key: nil, custom_key: nil, read_key: nil, write_key: nil, timeout: 60, use_ssl: true)`
 * `master_key (String)` - [API key](https://docs.slicingdice.com/docs/api-keys) to authenticate requests with the SlicingDice API.
 * `custom_key (String)` - [API key](https://docs.slicingdice.com/docs/api-keys) to authenticate requests with the SlicingDice API.
 * `read_key (String)` - [API key](https://docs.slicingdice.com/docs/api-keys) to authenticate requests with the SlicingDice API.
 * `write_key (String)` - [API key](https://docs.slicingdice.com/docs/api-keys) to authenticate requests with the SlicingDice API.
 * `use_ssl (Bool)` - Define if the requests verify SSL for HTTPS requests.
 * `timeout (Fixnum)` - Amount of time, in seconds, to wait for results for each request.
-* `uses_test_endpoint (Bool)` - If false the client will send requests to production end-point, otherwise to tests end-point.
 
 ### `get_database()`
 Get information about current database. This method corresponds to a `GET` request at `/database`.
@@ -91,7 +90,7 @@ Get information about current database. This method corresponds to a `GET` reque
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 
 puts client.get_database()
 ```
@@ -102,7 +101,7 @@ puts client.get_database()
 {
     "name": "Database 1",
     "description": "My first database",
-    "tables": [
+    "dimensions": [
     	"default",
         "users"
     ],
@@ -118,7 +117,7 @@ Get all created columns, both active and inactive ones. This method corresponds
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 puts client.get_columns()
 ```
 
@@ -157,7 +156,7 @@ Create a new column. This method corresponds to a [POST request at /column](http
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 column = {
   "name" => "Year",
   "api-name" => "year",
@@ -184,7 +183,7 @@ Insert data to existing entities or create new entities, if necessary. This meth
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 insert_data = {
   "user1@slicingdice.com" => {
     "car-model" => "Ford Ka",
@@ -218,7 +217,7 @@ insert_data = {
       "date" => "2016-08-17T13:23:47+00:00"
     }
   },
-  "auto-create" => ["table", "column"]
+  "auto-create" => ["dimension", "column"]
 }
 puts client.insert(insert_data)
 ```
@@ -234,14 +233,14 @@ puts client.insert(insert_data)
 }
 ```
 
-### `exists_entity(ids, table)`
-Verify which entities exist in a table (uses `default` table if not provided) given a list of entity IDs. This method corresponds to a [POST request at /query/exists/entity](https://docs.slicingdice.com/docs/exists).
+### `exists_entity(ids, dimension)`
+Verify which entities exist in a dimension (uses `default` dimension if not provided) given a list of entity IDs. This method corresponds to a [POST request at /query/exists/entity](https://docs.slicingdice.com/docs/exists).
 
 #### Request example
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 ids = [
   "user1@slicingdice.com",
   "user2@slicingdice.com",
@@ -273,7 +272,7 @@ Count the number of inserted entities in the whole database. This method corresp
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 
 puts client.count_entity_total()
 ```
@@ -290,18 +289,18 @@ puts client.count_entity_total()
 }
 ```
 
-### `count_entity_total(tables)`
-Count the total number of inserted entities in the given tables. This method corresponds to a [POST request at /query/count/entity/total](https://docs.slicingdice.com/docs/total#section-counting-specific-tables).
+### `count_entity_total(dimensions)`
+Count the total number of inserted entities in the given dimensions. This method corresponds to a [POST request at /query/count/entity/total](https://docs.slicingdice.com/docs/total#section-counting-specific-tables).
 
 #### Request example
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 
-tables = ["default"]
+dimensions = ["default"]
 
-puts client.count_entity_total(tables)
+puts client.count_entity_total(dimensions)
 ```
 
 #### Output example
@@ -323,7 +322,7 @@ Count the number of entities matching the given query. This method corresponds t
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 query = [
     {
         'query-name' => 'corolla-or-fit',
@@ -377,7 +376,7 @@ Count the number of occurrences for time-series events matching the given query.
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 query = [
     {
         'query-name' => 'test-drives-in-ny',
@@ -433,7 +432,7 @@ Return the top values for entities matching the given query. This method corresp
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 query = {
   "car-year" => {
     "year" => 2
@@ -491,7 +490,7 @@ Return the aggregation of all columns in the given query. This method correspond
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 query = {
   "query" => [
     {
@@ -543,7 +542,7 @@ Get all saved queries. This method corresponds to a [GET request at /query/saved
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 puts client.get_saved_queries()
 ```
 
@@ -594,7 +593,7 @@ Create a saved query at SlicingDice. This method corresponds to a [POST request
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 query = {
   "name" => "my-saved-query",
   "type" => "count/entity",
@@ -648,7 +647,7 @@ Update an existing saved query at SlicingDice. This method corresponds to a [PUT
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 new_query = {
   "type" => "count/entity",
   "query" => [
@@ -700,7 +699,7 @@ Executed a saved query at SlicingDice. This method corresponds to a [GET request
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 puts client.get_saved_query("my-saved-query")
 ```
 
@@ -737,7 +736,7 @@ Delete a saved query at SlicingDice. This method corresponds to a [DELETE reques
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 puts client.delete_saved_query("my-saved-query")
 ```
 
@@ -774,7 +773,7 @@ Retrieve inserted values for entities matching the given query. This method corr
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 query = {
   "query" => [
     {
@@ -823,7 +822,7 @@ Retrieve inserted values as well as their relevance for entities matching the gi
 
 ```ruby
 require 'rbslicer'
-client = SlicingDice.new(master_key: "API_KEY", uses_test_endpoint: false)
+client = SlicingDice.new(master_key: "API_KEY")
 query = {
   "query" => [
     {
@@ -868,6 +867,32 @@ puts client.score(query)
 }
 ```
 
+### `sql(query)`
+Retrieve inserted values using a SQL syntax. This method corresponds to a POST request at /query/sql.
+
+#### Request example
+
+```go
+require 'rbslicer'
+client = SlicingDice.new(master_key: "API_KEY")
+query = "SELECT COUNT(*) FROM default WHERE age BETWEEN 0 AND 49"
+
+puts client.sql(query)
+```
+
+#### Output example
+
+```json
+{
+   "took":0.063,
+   "result":[
+       {"COUNT": 3}
+   ],
+   "count":1,
+   "status":"success"
+}
+```
+
 ## License
 
 [MIT](https://opensource.org/licenses/MIT)

lib/rbslicer.rb

@@ -197,15 +197,15 @@ def count_entity(query)
 
   # Public: Make a total query in SlicingDice API
   #
-  # tables(Hash) - A Hash to send in request containing the tables in which
+  # dimensions(Hash) - A Hash to send in request containing the dimensions in which
   #                the total query will be performed
   #
   # Returns a count entity total query result
-  def count_entity_total(tables=[])
+  def count_entity_total(dimensions=[])
     url = @base_url + METHODS[:query_count_entity_total]
 
     query = {
-      "tables" => tables
+      "dimensions" => dimensions
     }
 
     make_request(url, "post", 0, data=query)
@@ -256,10 +256,10 @@ def top_values(query)
   # Public: Check if a list of entities exists in SlicingDice API
   #
   # ids(Array) - A Array with ids to be checked
-  # table(String) - In which table entities check be checked
+  # dimension(String) - In which dimension entities check be checked
   #
   # Returns a Hash with ids that exists and that don't exits
-  def exists_entity(ids, table=nil)
+  def exists_entity(ids, dimension=nil)
     url = @base_url + METHODS[:query_exists_entity]
     if ids.length > 100
       raise Exceptions::MaxLimitExceptions, 'The query exists entity must '\
@@ -268,8 +268,8 @@ def exists_entity(ids, table=nil)
     query = {
       'ids' => ids
     }
-    if table.nil?
-      query['table'] = table
+    if dimension.nil?
+      query['dimension'] = dimension
     end
     make_request(url, "post", 0, data=query)
   end

lib/rbslicer/version.rb

@@ -1,3 +1,3 @@
 module Rbslicer
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.0.2'.freeze
 end

tests_and_examples/examples/count_entity.json

@@ -23283,7 +23283,7 @@
     "name": "Test for a \"COUNT ENTITY\" query using automatically created columns, operator \"AND\" and parameter \"EQUALS\".",
     "columns": [],
     "insert": {
-      "auto-create": ["table", "column"],
+      "auto-create": ["dimension", "column"],
       "24": {
         "string-test-column": "value:matched_value",
         "numeric-test-column": 1000001
@@ -23713,7 +23713,7 @@
     "name": "Test for a \"COUNT ENTITY\" query using automatically created columns, operators \"AND\" and \"OR\" and parameter \"EQUALS\".",
     "columns": [],
     "insert": {
-      "auto-create": ["table", "column"],
+      "auto-create": ["dimension", "column"],
       "24": {
         "string-test-column": "value:matched_value",
         "boolean-test-column": "true",
@@ -24251,7 +24251,7 @@
     "name": "Test for a \"COUNT ENTITY\" query using automatically created columns, operators \"AND\" and \"OR\" and parameters \"EQUALS\", \"BETWEEN\" and \"MINFREQ\".",
     "columns": [],
     "insert": {
-      "auto-create": ["table", "column"],
+      "auto-create": ["dimension", "column"],
       "24": {
         "string-test-column": "value:matched_value",
         "boolean-test-column": "true",