grepdata_client 0.0.3 → 0.0.4

data/README.md

@@ -1,7 +1,7 @@
 GrepdataClient
 
 Official Ruby client for Grepdata API.  More info on GrepData APIs can be found 
-in the [GrepData docs](www.grepdata.com/docs).
+in the [GrepData docs](https://www.grepdata.com/docs).
 
 ## Installation
 
@@ -18,11 +18,11 @@ or if you use a Gemfile:
 The track call allows you to send data into the system, usually from client devices. 
 Setup the client with your public token (token) and the endpoint (default_endpoint), 
 generally either 'prod' or 'qa', to send data. These can be found in 
-[settings](www.grepdata.com/#/settings/account) and 
-[endpoints](www.grepdata.com/#/settings/endpoints) respectively. Each track call 
+[settings](https://www.grepdata.com/#/settings/account) and 
+[endpoints](https://www.grepdata.com/#/settings/endpoints) respectively. Each track call 
 requires a first parameter of event name and a second JSON object with any related 
 dimensions you would like to track along with this event. For more info see 
-[docs for sending data](www.grepdata.com/docs#sending).
+[docs for sending data](https://www.grepdata.com/docs#sending).
 
 ###Example
 
@@ -36,28 +36,39 @@ dimensions you would like to track along with this event. For more info see
 
 Querying data using the GrepData API is almost as simple as sending it. This time
 the client is configured using the private key (api_key) for your account which can 
-be found in [settings](www.grepdata.com/#/settings/account). 
+be found in [settings](https://www.grepdata.com/#/settings/account). 
 
 
 ### Data Query
 
 Each data request requires a params object including the following fields:
-+ **datamart** (string): the name of the datamart to query (endpoint name for timeseries data)
-+ **dimensions** (array): all dimensions to query, be sure to include any dimensions being filtered
-+ **filters** (JSON): an object containing any filters to apply to the selected dimensions, key is dimension name, value is array of valid options
-+ **metrics** (array): all metrics columns you want aggregated and returned
-+ **time_interval** (string): the time granularity to breakout, options are h => hour, d => day, m => month
-+ **start_date** (string): the inclusive start of the query in format yyyymmddhh00
-+ **end_date** (string): the inclusive end of the query in format yyyymmddhh00
++ **datamart** (string - Required): Name of the datamart to query (endpoint name for timeseries data).
++ **dimensions** (array - Required): All dimensions to query, be sure to include any dimensions being filtered.
++ **computed_dimensions** (JSON array): List of any dimensions which have transformation applied on-the-fly at query time.
++ **filters** (JSON): Object containing any filters to apply to the selected dimensions, key is dimension name, value is array of valid options.
++ **metrics** (array - Required): All metrics columns you want aggregated and returned.
++ **time_interval** (string - Required): Time granularity to breakout, options are h => hour, d => day, m => month.
++ **start_date** (string - Required): Inclusive start of the query in format yyyymmddhh00.
++ **end_date** (string - Required): Inclusive end of the query in format yyyymmddhh00.
++ **type** (string): Formatting type for the output, 'full' for one entry per row or 'ui' for a compressed, mapped version.
++ **order_by** (array): Ordered list of dimensions, metrics and/or 'date' indicating the order to return data.
++ **max_rows** (int): Max amount of rows to return back. If the result-set is larger than this max row size, the API will return an error message.
++ **limit** (int): Return the top-n dimension-sets matching the query where n is defined by this parameter. The sorting will be conducted over the total timeperiod, regardless of the time interval (hourly, daily, monthly) chosen. By default, the sorting will occur on the first selected metric, use {limit_by_metric} to change the sort ordering.
++ **limit_after_max** (int): Similar to limit, this value will cause the API to return the top-n rows matching the query if and only if the total rows without limiting would exceed the {max_rows} value (provided or default). Just like {limit}, the sorting will be conducted over the total timeperiod, regardless of the time interval (hourly, daily, monthly) chosen. By default, the sorting will occur on the first selected metric, use {limit_by_metric} to change the sort ordering.
++ **limit_by_metric** (string): Used in conjunction with {limit} to specify the metric to use in sorting the result set. If unset, the sorting will occur on the first selected metric.
++ **offset** (int): Used in conjunction with {limit} and {limit_by_metric} to specify the offset into the results. If unset, the offset is 0, returning the top {limit} results. The offset is 0-indexed, meaning an offset of 5 will ignore the first 5 results and return starting with the 6th. Useful for paging results.
++ **include_remainder** (bool): Used in conjunction with {limit}, {limit_by_metric} and {offset} to determine whether to compute and include a remainder or "Other" entry. If unset or 0, only the top {limit} results will be returned. If set to 1, an extra row will be appended with all the data past top {limit} results aggregated together. If an offset is specified, both the data before {offset} and after {offset} + {limit} will be included.
++ **include_dimension_lists** (bool): If set to true and type=full, the returned json will include a section entitled 'dimensionLists,' a map of dimension name to a list of all values for that dimension in the result set.
++ **include_zero_values** (bool): If set to true and type=full, every returned dimension-set will have a comlete array of values, including entries with metrics of 0 for timeperiods that do not include any data. If false, only the timeperiods and dimensions with data will be returned.
 
 The `client.query` call will return a query object which can be executed with the method `get_result` or printed as 
 a the complete API url that will be executed with `get_url`.
 
 ###Example
-From the user_info datamart
-Select the hour, country and the total count of events 
-Where the country is either US, UK or CA and the event was between 2013/06/11 08:00 and 2013/06/11 09:00
-Grouped by hour and country
+From the user_info datamart  
+Select the hour, country and the total count of events  
+Where the country is either US, UK or CA and the event was between 2013/06/11 08:00 and 2013/06/11 09:00  
+Grouped by hour and country  
 
     require 'rubygems'
     require 'grepdata_client'
@@ -77,6 +88,8 @@ Grouped by hour and country
     req = client.query params
     puts req.get_result
 
+### Funneling Query
+
 Funneling queries can also be issued from this client. Similar to querying above, the 
 client is configured with the api_key and fired with a set of query parameters:
 + **datamart** (string): the name of the datamart to query (endpoint name for timeseries data)
@@ -91,10 +104,10 @@ client is configured with the api_key and fired with a set of query parameters:
 + **only_totals** (boolean): a flag to indicate whether to collapse all data from the given timerange into a single total (true) or leave it broken out by time_interval (false)
 
 ###Example
-From the demonstration datamart
-Select the daily counts of play, pause, seek and stop events 
-Where the country is US and the events occurred between 2013/06/12 and 2013/06/19
-Broken out by day and country
+From the demonstration datamart  
+Select the daily counts of play, pause, seek and stop events  
+Where the country is US and the events occurred between 2013/06/12 and 2013/06/19  
+Broken out by day and country  
 
     require 'rubygems'
     require 'grepdata_client'
@@ -109,7 +122,7 @@ Broken out by day and country
       :dimensions => %w(event country),
       :metrics => %w(Count),
       :start_date => "201306120000",
-      :end_date => "201306190000",  
+      :end_date => "201306190000",
       :steps => [
         { :name => "step1: play", :value => "play" },
         { :name => "step2: pause", :value => "pause" },

data/lib/grepdata_client/utils.rb

@@ -49,9 +49,25 @@ module GrepdataClient
       result[:datamart] = params[:datamart] if params[:datamart]
       result[:metrics] = params[:metrics].join(',') if params[:metrics]
       result[:dimensions] = params[:dimensions].join(',') if params[:dimensions]
+      result[:computed_dimensions] = params[:computed_dimensions] if params[:computed_dimensions]
       result[:filters] = params[:filters].to_json if params[:filters]
       result[:time_interval] = params[:time_interval] if params[:time_interval]
-    
+      result[:type] = params[:type] if params[:type]
+      result[:order_by] = params[:order_by].join(',') if params[:order_by]
+      result[:max_rows] = params[:max_rows] if params[:max_rows]
+      result[:limit] = params[:limit] if params[:limit]
+      result[:limit_after_max] = params[:limit_after_max] if params[:limit_after_max]
+      result[:offset] = params[:offset] if params[:offset]    
+      if params[:sortMetric]
+        limit_by_metric = params[:sortMetric]
+      elsif params[:limit_by_metric]
+        limit_by_metric = params[:limit_by_metric]
+      end
+      result[:limit_by_metric] = limit_by_metric if limit_by_metric
+      result[:include_remainder] = params[:include_remainder] if params[:include_remainder]    
+      result[:include_dimension_lists] = params[:include_dimension_lists] if params[:include_dimension_lists]    
+      result[:include_zero_values] = params[:include_zero_values] if params[:include_zero_values]    
+
       if action == "funneling"
         steps = []
         params[:steps].each do |step|
@@ -72,7 +88,8 @@ module GrepdataClient
       result[:signature] = params[:signature] if params[:signature]
       result[:restricted] = params[:restricted] if params[:restricted]
       result[:expiration] = params[:expiration] if params[:expiration]
+      
       result
     end
   end
-end
+end

data/lib/grepdata_client/version.rb

@@ -1,3 +1,3 @@
 module GrepdataClient
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grepdata_client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-25 00:00:00.000000000 Z
+date: 2013-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus