keen-cli 0.1.9 → 0.2.0

data/README.md

@@ -162,7 +162,7 @@ Parameters:
 
 + `--collection`, `-c`: – The collection to query against. Can also be set on the environment via `KEEN_COLLECTION_NAME`.
 + `--analysis-type`, `-a`: The analysis type for the query. Only needed when not using a query command alias.
-+ `--group-by`, `-g`: A group by for the query.
++ `--group-by`, `-g`: A group by for the query. Multiple fields seperated by comma are supported.
 + `--target-property`, `-y`: A target property for the query.
 + `--timeframe`, `-t`: A relative timeframe, e.g. `last_60_minutes`.
 + `--start`, `-s`: The start time of an absolute timeframe.
@@ -173,6 +173,7 @@ Parameters:
 + `--property-names`: A comma-separated list of property names. Extractions only.
 + `--latest`: Number of latest events to retrieve. Extractions only.
 + `--email`: Send extraction results via email, asynchronously. Extractions only.
++ `--spark`: Format output for [spark](https://github.com/holman/spark) ▁▂▃▅▇ Interval and timeframe fields required.
 
 Input source parameters:
 + `--data`, `-d`: Specify query parameters as JSON instead of query params.
@@ -266,6 +267,7 @@ Parameters that apply to most commands include:
 
 ### Changelog
 
++ 0.2.0 - Add support for [spark](https://github.com/holman/spark) ▁▂▃▅▇
 + 0.1.9 - Supports JSON-encoded filters and comma-seperated multiple group by
 + 0.1.8 - Inputted lines can also be arrays of JSON objects. `--batch-size` param is now properly recognized.
 + 0.1.7 - Add docs command

data/lib/keen-cli/queries.rb

@@ -18,11 +18,16 @@ module KeenCli
       option :end, :aliases => ['e']
     end
 
+    def self.viz_options
+      option :"spark", :type => :boolean
+    end
+
     desc 'queries:run', 'Run a query and print the result'
     map 'queries:run' => :queries_run
     shared_options
     query_options
     data_options
+    viz_options
     def queries_run(analysis_type=nil)
 
       Utils.process_options!(options)
@@ -35,13 +40,25 @@ module KeenCli
 
       query_options = to_query_options(options)
 
-      Keen.query(analysis_type, collection, query_options).tap do |result|
-        if result.is_a?(Hash) || result.is_a?(Array)
-          Utils.out_json(result, options)
-        else
-          Utils.out(result, options)
+      result = Keen.query(analysis_type, collection, query_options)
+
+      if (options[:spark])
+        raise 'Spark only applies to series queries!' unless options[:interval]
+        numbers = result.map do |object|
+          object['value']
+        end
+        return numbers.join(' ').tap do |numbers_str|
+          Utils.out(numbers_str, options)
         end
       end
+
+      if result.is_a?(Hash) || result.is_a?(Array)
+        Utils.out_json(result, options)
+      else
+        Utils.out(result, options)
+      end
+
+      result
     end
 
     desc 'queries:url', 'Print the URL for a query'
@@ -78,6 +95,7 @@ module KeenCli
       shared_options
       query_options
       data_options
+      viz_options
       self.send(:define_method, method_name) { queries_run(underscored_analysis_type) }
     end
 

data/lib/keen-cli/version.rb

@@ -1,3 +1,3 @@
 module KeenCli
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

data/spec/keen-cli/queries_spec.rb

@@ -36,6 +36,14 @@ describe KeenCli::CLI do
       expect(_).to eq(10)
     end
 
+    it 'parses filters as JSON' do
+      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths&filters=%5B%7B%22property_name%22%3A%22enemy%22%2C%22operator%22%3A%22eq%22%2C%22property_value%22%3A%22creeper%22%7D%5D"
+      stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
+      filters = '[{"property_name":"enemy","operator":"eq","property_value":"creeper"}]'
+      _, options = start "queries:run --analysis-type count --collection minecraft-deaths --filters #{filters}"
+      expect(_).to eq(10)
+    end
+
     it 'accepts extraction-specific properties' do
       url = "https://api.keen.io/3.0/projects/#{project_id}/queries/extraction?event_collection=minecraft-deaths&property_names=%5B%22foo%22,%22bar%22%5D&latest=1&email=bob@bob.io"
       stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
@@ -96,6 +104,17 @@ describe KeenCli::CLI do
 
   end
 
+  describe 'spark format' do
+
+    it 'should emit interval results as numbers' do
+      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths&timeframe=last_2_minutes&interval=minutely"
+      stub_request(:get, url).to_return(:body => { :result => [{ value: 10 }, { value: 20 }] }.to_json)
+      _ = start 'queries:run --collection minecraft-deaths --analysis-type count --timeframe last_2_minutes --interval minutely --spark'
+      expect(_).to eq("10 20")
+    end
+
+  end
+
   describe "queries:run aliases" do
     KeenCli::CLI::ANALYSIS_TYPES.each do |analysis_type|
       describe analysis_type do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-17 00:00:00.000000000 Z
+date: 2014-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keen