Merge pull request #4 from SlicingDice/renaming

Rename index() to insert()

Author: telles-simbiose

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## [Unreleased]
 ### Added
+- CLIENT: Rename method index() to insert()
 - CLIENT: Create requester and main method
 
 ## [0.3] - 2016-09-15

README.md

@@ -8,11 +8,11 @@ Official Arduino client for [SlicingDice](http://www.slicingdice.com/), Data War
 
 If you are new to SlicingDice, check our [quickstart guide](http://panel.slicingdice.com/docs/#quickstart-guide) and learn to use it in 15 minutes.
 
-Please refer to the [SlicingDice official documentation](http://panel.slicingdice.com/docs/) for more information on [analytics databases](http://panel.slicingdice.com/docs/#analytics-concepts), [data modeling](http://panel.slicingdice.com/docs/#data-modeling), [indexing](http://panel.slicingdice.com/docs/#data-indexing), [querying](http://panel.slicingdice.com/docs/#data-querying), [limitations](http://panel.slicingdice.com/docs/#current-slicingdice-limitations) and [API details](http://panel.slicingdice.com/docs/#api-details).
+Please refer to the [SlicingDice official documentation](http://panel.slicingdice.com/docs/) for more information on [analytics databases](http://panel.slicingdice.com/docs/#analytics-concepts), [data modeling](http://panel.slicingdice.com/docs/#data-modeling), [data insertion](http://panel.slicingdice.com/docs/#data-insertion), [querying](http://panel.slicingdice.com/docs/#data-querying), [limitations](http://panel.slicingdice.com/docs/#current-slicingdice-limitations) and [API details](http://panel.slicingdice.com/docs/#api-details).
 
 ### Note
 
-SlicingDice's Arduino client currently supports only indexing commands. Let us
+SlicingDice's Arduino client currently supports only data insert commands. Let us
 know if you application requires Arduino to query data from SlicingDice
 and we'll make sure to add this feature to our backlog.
 
@@ -47,17 +47,20 @@ void setup() {
     Ethernet.begin(mac, ip, dns, gateway, subnet);
 }
 
-// Send an indexation command to Slicing Dice API and print the result
+// Send an insert command to Slicing Dice API and print the result
 void loop() {
     StaticJsonBuffer<200> jsonBuffer;
-    JsonObject& queryIndex = jsonBuffer.createObject();
-    JsonObject& nestedQueryIndex = queryIndex.createNestedObject("[email protected]");
-    nestedQueryIndex["age"] = 22;
+    JsonObject& data = jsonBuffer.createObject();
+    JsonObject& nestedInsertion = data.createNestedObject("[email protected]");
+    nestedInsertion["age"] = 22;
+
     // Auto create non-existent fields
-    queryIndex["auto-create-fields"] = true;
+    JsonArray& autoCreate = data.createNestedArray("auto-create");
+    autoCreate.add("table");
+    autoCreate.add("column");
 
-    // Index object
-    sd.index(queryIndex);
+    // Insert object
+    sd.insert(data);
 
     // Print result for debugging
     Serial.print("Status code: ");
@@ -72,12 +75,12 @@ Whether you want to test the client installation or simply check more examples o
 
 ## Reference
 
-`SlicingDice` encapsulates logic for sending requests to the [index endpoint](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-index).
+`SlicingDice` encapsulates logic for sending requests to the [insert endpoint](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-insert).
 
 ### Attributes
 
-* `statusCode (int)` - HTTP status code after indexing to SlicingDice. Should be `200` in ordinary circumstances or one of the HTTP requests defined at the [API errors](http://panel.slicingdice.com/docs/#api-details-api-errors) section.
-* `response (String)` - Response after indexing data. Useful for debugging purposes.
+* `statusCode (int)` - HTTP status code after inserting to SlicingDice. Should be `200` in ordinary circumstances or one of the HTTP requests defined at the [API errors](http://panel.slicingdice.com/docs/#api-details-api-errors) section.
+* `response (String)` - Response after inserting data. Useful for debugging purposes.
 
 ### Constructors
 
@@ -87,8 +90,8 @@ Whether you want to test the client installation or simply check more examples o
 * `host (const char*)` - (Default: api.slicingdice.com) [Connection endpoint](http://panel.slicingdice.com/docs/#api-details-api-connection-connection-endpoints) to use when generating requests to SlicingDice.
 * `port (int)` - (Default: 80) Port to connect to when generating requests. Particularly useful when connect to `http://localhost`.
 
-### `void index(JsonObject& query)`
-Index data to existing entities or create new entities, if necessary. This method corresponds to a [POST request at /index](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-index).
+### `void insert(JsonObject& query)`
+Insert data to existing entities or create new entities, if necessary. This method corresponds to a [POST request at /insert](http://panel.slicingdice.com/docs/#api-details-api-endpoints-post-insert).
 
 #### Request example
 
@@ -117,17 +120,20 @@ void setup() {
     Ethernet.begin(mac, ip, dns, gateway, subnet);
 }
 
-// Send an indexation command to Slicing Dice API and print the result
+// Send an insertation command to Slicing Dice API and print the result
 void loop() {
     StaticJsonBuffer<200> jsonBuffer;
-    JsonObject& queryIndex = jsonBuffer.createObject();
-    JsonObject& nestedQueryIndex = queryIndex.createNestedObject("[email protected]");
-    nestedQueryIndex["age"] = 22;
+    JsonObject& data = jsonBuffer.createObject();
+    JsonObject& nestedInsertion = data.createNestedObject("[email protected]");
+    nestedInsertion["age"] = 22;
+    
     // Auto create non-existent fields
-    queryIndex["auto-create-fields"] = true;
+    JsonArray& autoCreate = data.createNestedArray("auto-create");
+    autoCreate.add("table");
+    autoCreate.add("column");
 
-    // Index object
-    sd.index(queryIndex);
+    // Insert object
+    sd.insert(data);
 
     // Print result for debugging
     Serial.print("Status code: ");
@@ -142,8 +148,8 @@ void loop() {
 Status code: 200
 {
     "status": "success",
-    "indexed-entities": 1,
-    "indexed-fields": 1,
+    "inserted-entities": 1,
+    "inserted-fields": 1,
     "took": 0.023
 }
 ```

SlicingDice.cpp

@@ -11,11 +11,11 @@ void SlicingDice::construct(String apiUserKey, const char* customHost, int custo
     useProduction = production;
 }
 
-/* Index data on Slicing Dice API
+/* Insert data on Slicing Dice API
  *
  * query - the query to send to Slicing Dice API
  */
-void SlicingDice::index(JsonObject& query) {
+void SlicingDice::insert(JsonObject& query) {
     char queryConverted[query.measureLength() +  1];
     query.printTo(queryConverted, sizeof(queryConverted));
     makeRequest(queryConverted);
@@ -37,7 +37,7 @@ void SlicingDice::makeRequest(const char* query){
         testEndPoint = String("test/");
     }
 
-    client.println("POST /v1/" + testEndPoint + "index HTTP/1.1");
+    client.println("POST /v1/" + testEndPoint + "insert HTTP/1.1");
     client.println(F("Content-Type: application/json"));
     String hostString = String(host);
     client.println("Host: " + hostString);

SlicingDice.h

@@ -9,7 +9,7 @@ class SlicingDice {
 public:
 	SlicingDice(String apiUserKey, boolean useProduction = false, const char* customHost = "api.slicingdice.com", int customPort=80);
 
-	void index(JsonObject& query);
+	void insert(JsonObject& data);
 	int statusCode;
 	String response;
 

tests_and_examples/Simple.ino

@@ -22,14 +22,19 @@ void setup() {
     Ethernet.begin(mac, ip, dns, gateway, subnet);
 }
 
-// Send an indexation command to Slicing Dice API and print the result
+// Send an insert command to Slicing Dice API and print the result
 void loop() {
     StaticJsonBuffer<200> jsonBuffer;
-    JsonObject& queryIndex = jsonBuffer.createObject();
-    JsonObject& nestedQueryIndex = queryIndex.createNestedObject("[email protected]");
-    nestedQueryIndex["age"] = 22;
-    queryIndex["auto-create-fields"] = true;
-    sd.index(queryIndex);
+    JsonObject& insertion = jsonBuffer.createObject();
+    JsonObject& nestedQueryInsertion = insertion.createNestedObject("[email protected]");
+    nestedQueryInsertion["age"] = 22;
+
+    // Auto create non-existent fields
+    JsonArray& autoCreate = insertion.createNestedArray("auto-create");
+    autoCreate.add("table");
+    autoCreate.add("column");
+    
+    sd.insert(insertion);
     Serial.print("Status code: ");
     Serial.println(sd.statusCode);
     Serial.println(sd.response);