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

Change client to match new api formats

Author: joaosimbiose

.gitignore

@@ -8,4 +8,4 @@
 /spec/reports/
 /tmp/
 .idea/
-
+examples/*

CHANGELOG.md

@@ -3,6 +3,8 @@
 ## [2.0.2]
 ### Updated
 - 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.1]
 ### Updated

README.md

@@ -1,4 +1,4 @@
-# SlicingDice Official Ruby Client (v2.0.1)
+# SlicingDice Official Ruby Client (v2.0.2)
 ### Build Status: [![CircleCI](https://circleci.com/gh/SlicingDice/slicingdice-ruby.svg?style=svg)](https://circleci.com/gh/SlicingDice/slicingdice-ruby)
 
 Official Ruby client for [SlicingDice](http://www.slicingdice.com/), Data Warehouse and Analytics Database as a Service.  

lib/rbslicer.rb

@@ -37,7 +37,8 @@
   query_data_extraction_result: '/data_extraction/result/',
   query_data_extraction_score: '/data_extraction/score/',
   query_saved: '/query/saved/',
-  database: '/database/'
+  database: '/database/',
+  query_sql: '/query/sql/'
 }.freeze
 
 # Public: A ruby interface to SlicingDice API
@@ -63,27 +64,18 @@ def initialize(options = {})
       read_key = options.fetch(:read_key, nil)
       write_key = options.fetch(:write_key, nil)
       timeout = options.fetch(:timeout, 60)
-      uses_test_endpoint = options.fetch(:uses_test_endpoint, false)
       base_url= options.fetch(:base_url, BASE_URL)
     super(master_key, custom_key, read_key, write_key, timeout)
     @list_query_types = [
       "count/entity", "count/event", "count/entity/total",
-      "aggregation", "top_values"]
+      "aggregation", "top_values", "sql"]
     if base_url.nil?
       @base_url = BASE_URL
     else
       @base_url = base_url
     end
-    @uses_test_endpoint = uses_test_endpoint
   end
 
-  def wrapper_test()
-    base_url = @base_url
-    if @uses_test_endpoint
-      base_url += "/test"
-    end
-    return base_url
-  end
   # Public: Create column in SlicingDice API
   #
   # query - A Hash in the SlicingDice column format
@@ -104,7 +96,6 @@ def wrapper_test()
   #
   # Returns a hash with api result
   def create_column(query)
-    base_url = wrapper_test()
     if query.kind_of?(Array)
       query.each { |q| column_create(q) }
     else
@@ -113,18 +104,16 @@ def create_column(query)
   end
 
   def column_create(query)
-    base_url = wrapper_test()
     sd_validator = Utils::ColumnValidator.new(query)
     if sd_validator.validator
-      url = base_url + METHODS[:column]
+      url = @base_url + METHODS[:column]
       make_request(url, "post", 2, data= query)
     end
   end
 
   # Public: Get all columns created on SlicingDice API
   def get_columns()
-    base_url = wrapper_test()
-    url = base_url + METHODS[:column]
+    url = @base_url + METHODS[:column]
     make_request url, "get", 2
   end
 
@@ -144,18 +133,16 @@ def get_columns()
   #
   # Returns a hash with api result
   def insert(data)
-    base_url = wrapper_test()
     sd_validator = Utils::InsertValidator.new(data)
     if sd_validator.validator
-      url = base_url + METHODS[:insert]
+      url = @base_url + METHODS[:insert]
       make_request(url, "post", 1, data = data)
     end
   end
 
   # Public: Get information about current database
   def get_database()
-    base_url = wrapper_test()
-    url = base_url + METHODS[:database]
+    url = @base_url + METHODS[:database]
     make_request url, "get", 2
   end
 
@@ -204,8 +191,7 @@ def saved_query_wrapper(url, query, update = false)
   #
   # Returns a count entity query result
   def count_entity(query)
-    base_url = wrapper_test()
-    url = base_url + METHODS[:query_count_entity]
+    url = @base_url + METHODS[:query_count_entity]
     count_query_wrapper(url, query)
   end
 
@@ -216,8 +202,7 @@ def count_entity(query)
   #
   # Returns a count entity total query result
   def count_entity_total(tables=[])
-    base_url = wrapper_test()
-    url = base_url + METHODS[:query_count_entity_total]
+    url = @base_url + METHODS[:query_count_entity_total]
 
     query = {
       "tables" => tables
@@ -232,8 +217,7 @@ def count_entity_total(tables=[])
   #
   # Returns a count event query result
   def count_event(query)
-    base_url = wrapper_test()
-    url = base_url + METHODS[:query_count_event]
+    url = @base_url + METHODS[:query_count_event]
     count_query_wrapper(url, query)
   end
 
@@ -243,8 +227,7 @@ def count_event(query)
   #
   # Returns a aggregation query result
   def aggregation(query)
-    base_url = wrapper_test()
-    url = base_url + METHODS[:query_aggregation]
+    url = @base_url + METHODS[:query_aggregation]
     if !query.key?("query")
       raise Exceptions::InvalidQueryException, 'The aggregation query must '\
                                                'have \'query\' property.'
@@ -263,8 +246,7 @@ def aggregation(query)
   #
   # Returns a top values query result
   def top_values(query)
-    base_url = wrapper_test()
-    url = base_url + METHODS[:query_top_values]
+    url = @base_url + METHODS[:query_top_values]
     sd_validator = Utils::QueryTopValuesValidator.new(query)
     if sd_validator.validator
       make_request(url, "post", 0, data=query)
@@ -278,8 +260,7 @@ def top_values(query)
   #
   # Returns a Hash with ids that exists and that don't exits
   def exists_entity(ids, table=nil)
-    base_url = wrapper_test()
-    url = base_url + METHODS[:query_exists_entity]
+    url = @base_url + METHODS[:query_exists_entity]
     if ids.length > 100
       raise Exceptions::MaxLimitExceptions, 'The query exists entity must '\
                                             'have up to 100 ids.'
@@ -299,8 +280,7 @@ def exists_entity(ids, table=nil)
   #
   # Returns a hash with saved query
   def get_saved_queries()
-    base_url = wrapper_test()
-    url = base_url + METHODS[:query_saved]
+    url = @base_url + METHODS[:query_saved]
     make_request url, "get", 2
   end
 
@@ -310,8 +290,7 @@ def get_saved_queries()
   #
   # Returns a hash with saved query
   def get_saved_query(query_name)
-    base_url = wrapper_test()
-    url = base_url + METHODS[:query_saved] + query_name
+    url = @base_url + METHODS[:query_saved] + query_name
     make_request url, "get", 0
   end
 
@@ -321,8 +300,7 @@ def get_saved_query(query_name)
   #
   # Returns a hash with saved query
   def delete_saved_query(query_name)
-    base_url = wrapper_test()
-    url = base_url + METHODS[:query_saved] + query_name
+    url = @base_url + METHODS[:query_saved] + query_name
     make_request url, "delete", 2
   end
 
@@ -332,8 +310,7 @@ def delete_saved_query(query_name)
   #
   # Returns a hash with saved query created and SUCCESS status
   def create_saved_query(query)
-    base_url = wrapper_test()
-    url = base_url + METHODS[:query_saved]
+    url = @base_url + METHODS[:query_saved]
     saved_query_wrapper url, query
   end
 
@@ -344,28 +321,28 @@ def create_saved_query(query)
   #
   # Returns a hash with saved query updated and SUCCESS status
   def update_saved_query(name, query)
-    base_url = wrapper_test()
-    url = base_url + METHODS[:query_saved] + name
+    url = @base_url + METHODS[:query_saved] + name
     saved_query_wrapper(url, query, update=true)
   end
 
   # Public: Get a data extraction result query
   #
   # query(Hash) - A Hash to send in request
   def result(query)
-    base_url = wrapper_test()
-    url = base_url + METHODS[:query_data_extraction_result]
+    url = @base_url + METHODS[:query_data_extraction_result]
     data_extraction_wrapper(url, query)
   end
 
   # Public: Get a data extraction score query
   #
   # query(Hash) - A Hash to send in request
   def score(query)
-    base_url = wrapper_test()
-    url = base_url + METHODS[:query_data_extraction_score]
+    url = @base_url + METHODS[:query_data_extraction_score]
     data_extraction_wrapper(url, query)
   end
 
-  private :wrapper_test
+  def sql(query)
+    url = @base_url + METHODS[:query_sql]
+    make_request(url, "post", 0, data=query, sql=true)
+  end
 end

lib/rbslicer/api.rb

@@ -64,13 +64,18 @@ def check_key(endpoint_key_level)
     # data(Hash) - A Hash to send in request
     #
     # Returns a request result
-    def make_request(url, req_type, key_level,  data = nil)
+    def make_request(url, req_type, key_level, data = nil, sql = false)
       check_key key_level
+      content_type = 'application/json'
+
+      if sql
+        content_type = 'application/sql'
+      end
       headers = {
-        'Content-Type' => 'application/json',
+        'Content-Type' => content_type,
         'Authorization' => @api_key
       }
-      @req = @requester.run(url, headers, req_type, data=data)
+      @req = @requester.run(url, headers, req_type, data=data, sql = sql)
       handler_request!
     end
 

lib/rbslicer/core/requester.rb

@@ -19,7 +19,7 @@ def initialize(timeout)
     # data(Hash) - A Hash to send in request
     #
     # Returns a object with result request
-    def run(url, headers, req_type, data = nil)
+    def run(url, headers, req_type, data = nil, sql = false)
       begin
         uri = URI.parse(url)
         http = Net::HTTP.new(uri.host, uri.port)
@@ -29,12 +29,18 @@ def run(url, headers, req_type, data = nil)
         http.read_timeout = @timeout
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
         requester = nil
+        parsed_data = data
+
+        if !sql 
+          parsed_data = data.to_json
+        end
+
         if req_type == "post"
           requester = Net::HTTP::Post.new(uri.request_uri, initheader = headers)
-          requester.body = data.to_json
+          requester.body = parsed_data
         elsif req_type == "put"
           requester = Net::HTTP::Put.new(uri.request_uri, initheader = headers)
-          requester.body = data.to_json
+          requester.body = parsed_data
         elsif req_type == "get"
           requester = Net::HTTP::Get.new(uri.request_uri, initheader = headers)
         elsif req_type == "delete"

lib/rbslicer/utils/validators.rb

@@ -46,7 +46,7 @@ def initialize(hash_data)
       @valid_type_columns =
         ["unique-id", "boolean", "string", "integer", "decimal",
           "enumerated", "date", "integer-time-series",
-          "decimal-time-series", "string-time-series"]
+          "decimal-time-series", "string-time-series", "datetime"]
     end
 
     # Public: Validates key 'name' in column