keen-cli 0.1.2 → 0.1.3

data/.travis.yml

@@ -1,11 +1,5 @@
 language: ruby
 rvm:
 - 2.1.0
-env:
-  global:
-    - secure: dyzAKPD91LvwtjcX0mo4ENPhpjCgtkrS1Z5mgodYHafMz+GBTrMLdwnA/jE2EnzUhVcTieuAvIsYP7sGsG43qxtYNIl7FMXdz1PywgQVZuPbmNV6Y2iBaU61TlQvR1rtLA+G4N8TOxdVQxThpYlNv1rNHGSqtgOOICMNZLTY224=
-    - secure: SAfN4kwEsqEBSSr8Fr2h2ySxFz7P+6rgysgEjF24fL6JW5N+YmKmwHh1en81d4R+BYcYIMQRwe1owpyqisvx0kASUVnWdPT0+loHm5rH22IEFsYjTEiuYOAZCj1/4yLcVmdX6EH34cNmoGbxUUziD9k9ctVGoehxaK9te+xphvc=
-    - secure: k2owfccj86F/b7X/WRsi8HGdJ9v+zuDek/Vu7XzNN+fqqja4rlXTtWSJyOTikklOMRN0AlUh1GjRWp+eT8YXKdiN4gk7WUGiryaTGATKWn1nLaIDtEjugMMmqXq7YwCih1GulPhMlRSwHU4b9q/MsciTFwzxREsxecjrQYL8HQY=
-    - secure: PXsUN/cmCwMbBjkJ6HLdWPmOEtk6+G1HMP5RhejImbUII7MJ1GRhHdehMCgc74wNfVt/MX/de2AgB17EQc5tDSKoQqV9dCZ4cRDPjlh82MK3gN1L2ZUgD+wJeY/29bZak6NMnVXVN18HGfIMjCVnS3t2rkQ94nwZVtIuhCkAWRk=
 script:
 - bundle exec rake spec

data/README.md

@@ -18,13 +18,23 @@ Verify the `keen` command is in your path by running it:
 
 ``` shell
 Commands:
+  keen average              # Alias for queries:run -c average
+  keen count                # Alias for queries:run -c count
+  keen count-unique         # Alias for queries:run -c count_unique
   keen events:add           # Add one or more events and print the result
+  keen extraction           # Alias for queries:run -c extraction
   keen help [COMMAND]       # Describe available commands or one specific command
+  keen maximum              # Alias for queries:run -c maximum
+  keen median               # Alias for queries:run -c median
+  keen minimum              # Alias for queries:run -c minimum
+  keen percentile           # Alias for queries:run -c percentile
   keen project:collections  # Print information about a project's collections
   keen project:describe     # Print information about a project
   keen project:open         # Open a project's overview page in a browser
   keen project:workbench    # Open a project's workbench page in a browser
   keen queries:run          # Run a query and print the result
+  keen select-unique        # Alias for queries:run -c select_unique
+  keen sum                  # Alias for queries:run -c sum
   keen version              # Print the keen-cli version
 ```
 
@@ -135,6 +145,10 @@ Parameters:
 + `--interval` (alias -i)
 + `--filters` (alias -f)
 + `--percentile`
++ `--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.
++ `--data` (alias -d) - Specify query parameters as JSON instead of query params. Data can also be piped in via STDIN.
 
 Some examples:
 
@@ -169,10 +183,42 @@ $ keen queries:run --collection cli-tests --analysis-type median --target-proper
   ...
   ...
   ...
+
+# 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"
+  }
+]
+
+# run a query using JSON to specify parameters
+$ echo "{ \"event_collection\" : \"minecraft-deaths\", \"target_property\": \"level\" }" | keen queries:run -a average
 ```
 
+**Query Aliases**
+
+For each type of analysis (e.g. count, average, extraction, etc.) there is an alias that can be used
+instead of `queries:run`. The command name is simply the type of analysis, using a dash to delimit words.
+Here are a few examples:
+
+``` shell
+$ keen count -c logins
+1000
+$ keen minimum -c cpu-checks -y iowait
+0.17
+```
+
+Run `keen` with no arguments to see the full list of aliases.
+
 ### Changelog
 
++ 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`
 + 0.1.0 - Initial version

data/keen-cli.gemspec

@@ -12,14 +12,14 @@ 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"
+  s.add_dependency "keen", ">= 0.8.4"
   s.add_dependency "thor"
   s.add_dependency "dotenv"
-  s.add_dependency "http"
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'debugger'
+  s.add_development_dependency 'webmock'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/keen-cli/cli.rb

@@ -1,4 +1,3 @@
-require 'http'
 require 'thor'
 require 'keen'
 require 'json'
@@ -33,6 +32,9 @@ module KeenCli
       option :timeframe, :aliases => ['-t']
       option :filters, :aliases => ['-f']
       option :percentile
+      option :"property-names"
+      option :latest
+      option :email
     end
 
     desc 'version', 'Print the keen-cli version'
@@ -50,9 +52,9 @@ module KeenCli
 
     def project_describe
       Utils.process_options!(options)
-      response = HTTP.get(
-        "https://api.keen.io/3.0/projects/#{Keen.project_id}?api_key=#{Keen.master_key}")
-      JSON.pretty_generate(JSON.parse(response.to_s)).tap do |s| puts s end
+      Keen.project_info.tap do |info|
+        puts JSON.pretty_generate(info)
+      end
     end
 
     desc 'project:collections', 'Print information about a project\'s collections'
@@ -92,23 +94,58 @@ module KeenCli
     map 'queries:run' => :queries_run
     shared_options
     query_options
-    def queries_run
+    data_options
+    def queries_run(analysis_type=nil)
 
       Utils.process_options!(options)
 
-      # convert dashes
-      q_options = options.inject({}) do |memo, element|
-        if ['analysis-type', 'group-by', 'target-property'].include?(element.first)
+      # work with a new set of options
+      q_options = {}
+
+      data = nil
+
+      if $stdin.tty?
+        data = options[:data]
+      else
+        ARGV.clear
+        ARGF.each_line do |line|
+          data = line
+        end
+      end
+
+      # if data is provided, parse it and merge it
+      unless data.nil?
+        data_options = JSON.parse(data)
+        q_options.merge!(data_options)
+      end
+
+      # convert dashes to underscores, and merge all into q_options
+      q_options.merge!(options.inject({}) do |memo, element|
+        if ['analysis-type', 'group-by', 'target-property', 'property-names'].include?(element.first)
           memo[element.first.sub('-', '_')] = element.last
         else
           memo[element.first] = element.last
         end
         memo
+      end)
+
+      collection = Utils.get_collection_name(q_options)
+      analysis_type = analysis_type || q_options["analysis_type"]
+
+      # delete fields that shouldn't be passed to keen-gem as options
+      q_options.delete("collection")
+      q_options.delete("event_collection")
+      q_options.delete("data")
+      q_options.delete("analysis_type")
+
+      if property_names = q_options.delete("property_names")
+        q_options[:property_names] = property_names.split(",")
       end
 
-      collection = Utils.get_collection_name(options)
+      raise "No analysis type given!" unless analysis_type
+      raise "No collection given!" unless collection
 
-      Keen.send(q_options["analysis_type"], collection, q_options).tap do |result|
+      Keen.send(analysis_type, collection, q_options).tap do |result|
         if result.is_a?(Hash) || result.is_a?(Array)
           puts JSON.pretty_generate(result)
         else
@@ -117,6 +154,18 @@ module KeenCli
       end
     end
 
+    ANALYSIS_TYPES = %w(average count count-unique extraction median minimum maximum sum percentile select-unique)
+
+    ANALYSIS_TYPES.each do |analysis_type|
+      underscored_analysis_type = analysis_type.sub('-', '_')
+      desc analysis_type, "Alias for queries:run -c #{underscored_analysis_type}"
+      map analysis_type => method_name = "queries_run_#{underscored_analysis_type}"
+      shared_options
+      query_options
+      data_options
+      self.send(:define_method, method_name) { queries_run(underscored_analysis_type) }
+    end
+
     desc 'events:add', 'Add one or more events and print the result'
     map 'events:add' => :events_add
 

data/lib/keen-cli/utils.rb

@@ -25,7 +25,7 @@ module KeenCli
       end
 
       def get_collection_name(options)
-        options["collection"] || ENV['KEEN_COLLECTION_NAME']
+        options["collection"] || options["event_collection"] || ENV['KEEN_COLLECTION_NAME']
       end
 
       def parse_data_as_querystring(query)

data/lib/keen-cli/version.rb

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

data/spec/keen-cli/cli_spec.rb

@@ -1,27 +1,121 @@
 require 'spec_helper'
 
 describe KeenCli::CLI do
+
+  let(:project_id) { 'AAAAAAA' }
+  let(:master_key) { 'DDDDDD' }
+  let(:read_key) { 'BBBBBB' }
+  let(:write_key) { 'CCCCCC' }
+
+  def start(str=nil)
+    KeenCli::CLI.start(str ? str.split(" ") : [])
+  end
+
+  before do
+    Keen.project_id = project_id
+    Keen.read_key = read_key
+    Keen.write_key = write_key
+    Keen.master_key = master_key
+  end
+
   it 'prints help by default' do
-    _, options = KeenCli::CLI.start
+    _, options = start
     expect(_).to be_empty
   end
 
   it 'prints version info if -v is used' do
-    _, options = KeenCli::CLI.start(%w[-v])
+    _, options = start "-v"
     expect(_).to match /version/
   end
 
   describe 'project:describe' do
     it 'gets the project' do
-      _, options = KeenCli::CLI.start(%w[project:describe])
-      expect(_).to match /\/3.0\/projects\/#{Keen.project_id}\/events/
+      url = "https://api.keen.io/3.0/projects/#{project_id}"
+      stub_request(:get, url).to_return(:body => { :fake => "response" }.to_json)
+      _, options = start 'project:describe'
+      expect(_).to eq("fake" => "response")
+    end
+
+    it 'uses the project id param if present' do
+      url = "https://api.keen.io/3.0/projects/GGGG"
+      stub_request(:get, url).to_return(:body => { :fake => "response" }.to_json)
+      _, options = start 'project:describe --project GGGG'
+      expect(_).to eq("fake" => "response")
     end
   end
 
   describe 'project:collections' do
     it 'prints the project\'s collections' do
-      _, options = KeenCli::CLI.start(%w[project:collections])
-      expect(_["properties"]["keen.timestamp"]).to eq 'datetime'
+      url = "https://api.keen.io/3.0/projects/#{project_id}/events"
+      stub_request(:get, url).to_return(:body => { :fake => "response" }.to_json)
+      _, options = start 'project:collections'
+      expect(_).to eq("fake" => "response")
+    end
+
+    it 'uses the project id param if present' do
+      url = "https://api.keen.io/3.0/projects/GGGG/events"
+      stub_request(:get, url).to_return(:body => { :fake => "response" }.to_json)
+      _, options = start 'project:collections --project GGGG'
+      expect(_).to eq("fake" => "response")
+    end
+  end
+
+  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)
+    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)
+    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=foo&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)
+    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)
+    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)
+    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 --data {"event_collection":"minecraft-deaths"}'
+      expect(_).to eq(10)
+    end
+  end
+
+  describe "queries:run aliases" do
+    KeenCli::CLI::ANALYSIS_TYPES.each do |analysis_type|
+      describe analysis_type do
+        it "aliases to queries run, passing along the #{analysis_type} analysis type" do
+          underscored_analysis_type = analysis_type.sub('-', '_')
+          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)
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'rspec'
+require 'webmock/rspec'
 
 require File.expand_path("../../lib/keen-cli", __FILE__)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2014-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keen
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.4
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -60,14 +60,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: http
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -76,7 +76,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -92,7 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: debugger
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -108,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements: