keen-cli 0.1.3 → 0.1.4

data/README.md

@@ -141,7 +141,9 @@ Parameters:
 + `--analysis-type` (alias -a)
 + `--group-by` (alias -g)
 + `--target-property` (alias -y)
-+ `--timeframe` (alias -t)
++ `--timeframe` (alias -t) - A relative timeframe, e.g. `last_60_minutes`
++ `--start` (alias -s) - The start time of an absolute timeframe
++ `--end` (alias -e) - The end time of an absolute timeframe
 + `--interval` (alias -i)
 + `--filters` (alias -f)
 + `--percentile`
@@ -184,6 +186,10 @@ $ keen queries:run --collection cli-tests --analysis-type median --target-proper
   ...
   ...
 
+# run a query with an absolute timeframe
+$ keen queries:run --analysis-type count --start 2014-07-01T00:00:00Z --end 2014-07-31T23:59:59Z
+1000
+
 # run an extraction with specific property names
 $ keen queries:run --collection minecraft-deaths --analysis-type extraction --property-names player,enemy
 [
@@ -218,6 +224,7 @@ Run `keen` with no arguments to see the full list of aliases.
 
 ### Changelog
 
++ 0.1.4 – Support absolute timeframes via `--start` and `--end` flags
 + 0.1.3 – Add querying via JSON. Add query aliases. Add support for extraction fields.
 + 0.1.2 – Change `project:show` to `project:describe`
 + 0.1.1 – Add `project:collections`

data/lib/keen-cli/cli.rb

@@ -35,6 +35,8 @@ module KeenCli
       option :"property-names"
       option :latest
       option :email
+      option :start, :aliases => ['s']
+      option :end, :aliases => ['e']
     end
 
     desc 'version', 'Print the keen-cli version'
@@ -142,6 +144,15 @@ module KeenCli
         q_options[:property_names] = property_names.split(",")
       end
 
+      if start_time = q_options.delete("start")
+        q_options[:timeframe] = { :start => start_time }
+      end
+
+      if end_time = q_options.delete("end")
+        q_options[:timeframe] = q_options[:timeframe] || {}
+        q_options[:timeframe][:end] = end_time
+      end
+
       raise "No analysis type given!" unless analysis_type
       raise "No collection given!" unless collection
 

data/lib/keen-cli/version.rb

@@ -1,3 +1,3 @@
 module KeenCli
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/keen-cli/cli_spec.rb

@@ -103,6 +103,28 @@ describe KeenCli::CLI do
       _, options = start 'queries:run --analysis-type count --data {"event_collection":"minecraft-deaths"}'
       expect(_).to eq(10)
     end
+
+    it 'converts a start parameter into an absolute timeframe' do
+      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths&timeframe=%7B%22start%22:%222014-07-06T12:00:00Z%22%7D"
+      stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
+      _, options = start 'queries:run --collection minecraft-deaths --analysis-type count --start 2014-07-06T12:00:00Z'
+      expect(_).to eq(10)
+    end
+
+    it 'converts an end parameter into an absolute timeframe' do
+      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths&timeframe=%7B%22end%22:%222014-07-06T12:00:00Z%22%7D"
+      stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
+      _, options = start 'queries:run --collection minecraft-deaths --analysis-type count --end 2014-07-06T12:00:00Z'
+      expect(_).to eq(10)
+    end
+
+    it 'converts start and end parameters into an absolute timeframe' do
+      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths&timeframe=%7B%22start%22:%222014-07-06T12:00:00Z%22,%22end%22:%222014-07-08T12:00:00Z%22%7D"
+      stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
+      _, options = start 'queries:run --collection minecraft-deaths --analysis-type count --start 2014-07-06T12:00:00Z --end 2014-07-08T12:00:00Z'
+      expect(_).to eq(10)
+    end
+
   end
 
   describe "queries:run aliases" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-06 00:00:00.000000000 Z
+date: 2014-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keen
@@ -172,3 +172,4 @@ summary: Command line interface to Keen IO
 test_files:
 - spec/keen-cli/cli_spec.rb
 - spec/spec_helper.rb
+has_rdoc: