keen-cli 0.2.1 → 0.2.2

data/README.md

@@ -1,6 +1,6 @@
 # keen-cli
 
-[![Build Status](https://travis-ci.org/keenlabs/keen-cli.svg?branch=master)](https://travis-ci.org/keenlabs/keen-cli)
+[![Build Status](https://travis-ci.org/keen/keen-cli.svg?branch=master)](https://travis-ci.org/keen/keen-cli)
 
 A command line interface for the Keen IO analytics API.
 
@@ -14,9 +14,10 @@ Install the gem:
 $ gem install keen-cli
 ```
 
-Verify the `keen` command is in your path by running it:
+Verify the `keen` command is in your path by running it. You should see information about available commands.
 
-``` shell
+```
+$ keen
 Commands:
   keen average               # Alias for queries:run -a average
   keen collections:delete    # Delete events from a collection
@@ -41,13 +42,11 @@ Commands:
   keen version               # Print the keen-cli version
 ```
 
-You should see information about available commands.
-
-If `keen` can't be found there might be an issue with your Ruby installation. If you're using [rbenv](https://github.com/sstephenson/rbenv) try running `rbenv rehash` after installation.
+If `keen` can't be found there might be an issue with your Ruby installation. In that case check out [rbenv](https://github.com/sstephenson/rbenv). If you're already using `rbenv` and `keen` still can't be found try running `rbenv rehash` after installation.
 
 ### Environment configuration
 
-Most keen-cli commands require the presence of a project and one or more API keys to do meaningful actions. By default, keen-cli attempts to find these in the process environment or a `.env` file in the current directory. This is the same heuristic that [keen-gem](https://github.com/keenlabs/keen-gem) uses and is based on [dotenv](https://github.com/bkeepers/dotenv).
+Most keen-cli commands require the presence of a project and one or more API keys to do meaningful actions. By default, keen-cli attempts to find these in the process environment or a `.env` file in the current directory. This is the same heuristic that [keen-gem](https://github.com/keen/keen-gem) uses and is based on [dotenv](https://github.com/bkeepers/dotenv).
 
 An example .env file looks like this:
 
@@ -190,54 +189,70 @@ Some examples:
 ``` shell
 # run a count
 $ keen queries:run --collection signups --analysis-type count
-1000
+{
+  "result": 1000
+}
 
 # run a count with collection name from .env
 # KEEN_COLLECTION_NAME=signups
 $ keen queries:run --analysis-type count
-1000
+{
+  "result": 1000
+}
 
 # run a count with a group by
 $ keen queries:run --collection signups --analysis-type count --group-by username
-[
-  {
-    "username": "dzello",
-    "result": 1000
-  }
-]
+{
+  "result": [
+    {
+      "username": "dzello",
+      "result": 1000
+    }
+  ]
+}
 
 # run a query with a timeframe, target property, group by, and interval
 $ keen queries:run --collection signups --analysis-type count_unique --target-property age --group-by source --timeframe last_24_hours --interval hourly
-
 {
-  "timeframe": {
-    "start": "2014-06-27T01:00:00.000Z",
-    "end": "2014-06-27T02:00:00.000Z"
-  },
-  "value": [
-  ...
-  ...
-  ...
+  "result": [
+    {
+      "timeframe": {
+        "start": "2014-06-27T01:00:00.000Z",
+        "end": "2014-06-27T02:00:00.000Z"
+      },
+      "value": [
+        ...
+      ]
+    }
+  }
+}
 
 # 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
+{
+  "result": 1000
+}
 
 # run an extraction with specific property names
 $ keen queries:run --collection minecraft-deaths --analysis-type extraction --property-names player,enemy
-[
-  {
-    "player": "dzello",
-    "enemy": "creeper"
-  },
-  {
-    "player": "dkador",
-    "enemy": "creeper"
-  }
-]
+{
+  "result": [
+    {
+      "player": "dzello",
+      "enemy": "creeper"
+    },
+    {
+      "player": "dkador",
+      "enemy": "creeper"
+    }
+  ]
+}
 
 # run a query using JSON to specify parameters
 $ echo "{ \"event_collection\" : \"minecraft-deaths\", \"target_property\": \"level\" }" | keen queries:run -a average
+{
+  "result": 2
+}
 ```
 
 **Query URL Generation**
@@ -272,6 +287,7 @@ Parameters that apply to most commands include:
 
 ### Changelog
 
++ 0.2.2 - Return full API JSON response for queries
 + 0.2.1 - Add `collections:delete` command
 + 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
@@ -289,7 +305,7 @@ Parameters that apply to most commands include:
 
 keen-cli is open source, and contributions are very welcome!
 
-Running the tests with:
+Run the tests with:
 
 ```
 $ bundle exec rake spec

data/keen-cli.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.description = "Record events and run queries from the comfort of your command line"
   s.license     = "MIT"
 
-  s.add_dependency "keen", ">= 0.8.6"
+  s.add_dependency "keen", ">= 0.8.8"
   s.add_dependency "thor"
   s.add_dependency "dotenv"
 

data/lib/keen-cli/queries.rb

@@ -40,11 +40,11 @@ module KeenCli
 
       query_options = to_query_options(options)
 
-      result = Keen.query(analysis_type, collection, query_options)
+      result = Keen.query(analysis_type, collection, query_options, :response => :all_keys)
 
       if (options[:spark])
         raise 'Spark only applies to series queries!' unless options[:interval]
-        numbers = result.map do |object|
+        numbers = result["result"].map do |object|
           object['value']
         end
         return numbers.join(' ').tap do |numbers_str|

data/lib/keen-cli/version.rb

@@ -1,3 +1,3 @@
 module KeenCli
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/keen-cli/queries_spec.rb

@@ -7,33 +7,35 @@ describe KeenCli::CLI do
   let(:read_key) { Keen.read_key }
   let(:write_key) { Keen.write_key }
 
+  let(:expected_response) { { "result" => 10 } }
+
   describe 'queries:run' do
     it 'runs the query using certain params' do
       url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths"
       stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
       _, options = start 'queries:run --analysis-type count --collection minecraft-deaths'
-      expect(_).to eq(10)
+      expect(_).to eq(expected_response)
     end
 
     it 'runs the query using aliased params' do
       url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths"
       stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
       _, options = start 'queries:run -a count -c minecraft-deaths'
-      expect(_).to eq(10)
+      expect(_).to eq(expected_response)
     end
 
     it 'converts dashes to underscores for certain properties' do
       url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths&group_by=%5B%22foo%22%5D&target_property=bar"
       stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
       _, options = start 'queries:run --analysis-type count --collection minecraft-deaths --group-by foo --target-property bar'
-      expect(_).to eq(10)
+      expect(_).to eq(expected_response)
     end
 
     it 'allows comma-delimited group by fields' do
       url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths&group_by=%5B%22%5C%22foo%22,%22bar%5C%22%22%5D&target_property=bar"
       stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
       _, options = start 'queries:run --analysis-type count --collection minecraft-deaths --group-by "foo,bar" --target-property bar'
-      expect(_).to eq(10)
+      expect(_).to eq(expected_response)
     end
 
     it 'parses filters as JSON' do
@@ -41,49 +43,49 @@ describe KeenCli::CLI do
       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)
+      expect(_).to eq(expected_response)
     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)
       _, options = start 'queries:run --analysis-type extraction --collection minecraft-deaths --property-names foo,bar --latest 1 --email bob@bob.io'
-      expect(_).to eq(10)
+      expect(_).to eq(expected_response)
     end
 
     it 'converts comma-delimited property names to an array' 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"
       stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
       _, options = start 'queries:run --analysis-type extraction --collection minecraft-deaths --property-names foo,bar'
-      expect(_).to eq(10)
+      expect(_).to eq(expected_response)
     end
 
     it 'uses a data option to take in query JSON' do
       url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths"
       stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
       _, options = start 'queries:run --analysis-type count --collection minecraft-deaths --data {"event_collection":"minecraft-deaths"}'
-      expect(_).to eq(10)
+      expect(_).to eq(expected_response)
     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)
+      expect(_).to eq(expected_response)
     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)
+      expect(_).to eq(expected_response)
     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)
+      expect(_).to eq(expected_response)
     end
 
   end
@@ -131,7 +133,7 @@ describe KeenCli::CLI do
           url = "https://api.keen.io/3.0/projects/#{project_id}/queries/#{underscored_analysis_type}?event_collection=minecraft-deaths"
           stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
           _, options = start "#{analysis_type} --collection minecraft-deaths"
-          expect(_).to eq(10)
+          expect(_).to eq(expected_response)
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2014-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keen
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.6
+        version: 0.8.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.8.6
+        version: 0.8.8
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement