keen-cli 0.2.0 → 0.2.1

data/README.md

@@ -19,6 +19,7 @@ Verify the `keen` command is in your path by running it:
 ``` shell
 Commands:
   keen average               # Alias for queries:run -a average
+  keen collections:delete    # Delete events from a collection
   keen count                 # Alias for queries:run -a count
   keen count-unique          # Alias for queries:run -a count_unique
   keen docs                  # Open the full Keen IO documentation in a browser
@@ -93,6 +94,10 @@ keen-cli has a variety of commands, and most are namespaced for clarity.
 * `projects:describe` - Get data about the project. Uses the [project row resource](https://keen.io/docs/api/reference/#project-row-resource).
 * `projects:collections` - Get schema information about the project's collections. Uses the [event resource](https://keen.io/docs/api/reference/#event-resource).
 
+##### Collections
+
+* `collections:delete` - Delete a collection. Takes filters and timeframe as options. Requires confirmation. Pass `--force` to skip, but BE CAREFUL :)
+
 ##### Events
 
 `events:add` - Add an event.
@@ -173,7 +178,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.
++ `--spark`: Format output for [spark](https://github.com/holman/spark) ▁▂▃▅▇. Interval and timeframe fields required. Set this flag and pipe output to `spark` to visualize output.
 
 Input source parameters:
 + `--data`, `-d`: Specify query parameters as JSON instead of query params.
@@ -267,6 +272,7 @@ Parameters that apply to most commands include:
 
 ### Changelog
 
++ 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
 + 0.1.8 - Inputted lines can also be arrays of JSON objects. `--batch-size` param is now properly recognized.

data/lib/keen-cli/cli.rb

@@ -8,6 +8,7 @@ require 'keen-cli/utils'
 require 'keen-cli/shared'
 
 require 'keen-cli/projects'
+require 'keen-cli/collections'
 require 'keen-cli/events'
 require 'keen-cli/queries'
 

data/lib/keen-cli/collections.rb

@@ -0,0 +1,61 @@
+module KeenCli
+
+  class CLI < Thor
+
+    def self.delete_options
+      self.collection_options
+      option :timeframe, :aliases => ['-t']
+      option :filters, :aliases => ['-f']
+      option :start, :aliases => ['s']
+      option :end, :aliases => ['e']
+      option :force, :type => :boolean, :default => false
+    end
+
+    desc 'collections:delete', 'Delete events from a collection'
+    map 'collections:delete' => :collections_delete
+
+    shared_options
+    delete_options
+
+    def collections_delete
+
+      Utils.process_options!(options)
+
+      collection = Utils.get_collection_name(options)
+
+      unless options[:force]
+        puts "WARNING! This is a delete request. Please re-enter the collection name to confirm."
+        confirmation = $stdin.gets.chomp!
+        unless confirmation == collection
+          Utils.out "Confirmation failed!", options
+          return false
+        end
+      end
+
+      q_options = {}
+      q_options[:timeframe] = options[:timeframe]
+
+      if start_time = options[:start]
+        q_options[:timeframe] = { :start => start_time }
+      end
+
+      if filters = options[:filters]
+        q_options[:filters] = JSON.parse(filters)
+      end
+
+      if end_time = options[:end]
+        q_options[:timeframe] = q_options[:timeframe] || {}
+        q_options[:timeframe][:end] = end_time
+      end
+
+      q_options.delete_if { |k, v| v.nil? }
+
+      Keen.delete(collection, q_options).tap do |result|
+        Utils.out(result, options)
+      end
+
+    end
+
+  end
+
+end

data/lib/keen-cli/version.rb

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

data/spec/keen-cli/collections_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe KeenCli::CLI do
+
+  describe 'collections:delete' do
+
+    it 'deletes the collection' do
+      stub_request(:delete, "https://api.keen.io/3.0/projects/#{Keen.project_id}/events/minecraft-deaths").
+        to_return(:status => 204, :body => "")
+      _, options = start 'collections:delete --collection minecraft-deaths --force'
+      expect(_).to eq(true)
+    end
+
+    it 'deletes the collection with filters' do
+      filters = '[{"property_name":"enemy","operator":"eq","property_value":"creeper"}]'
+      stub_request(:delete, "https://api.keen.io/3.0/projects/#{Keen.project_id}/events/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").
+        to_return(:status => 204, :body => "")
+      _, options = start "collections:delete --collection minecraft-deaths --filters #{filters} --force"
+      expect(_).to eq(true)
+    end
+
+  end
+
+end

data/spec/keen-cli/queries_spec.rb

@@ -106,13 +106,21 @@ describe KeenCli::CLI do
 
   describe 'spark format' do
 
-    it 'should emit interval results as numbers' do
+    it 'emits 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
 
+    it 'raises an exception if the query does not have an interval' do
+      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths&timeframe=last_2_minutes"
+      stub_request(:get, url).to_return(:body => { :result => [{ value: 10 }, { value: 20 }] }.to_json)
+      expect {
+        _ = start 'queries:run --collection minecraft-deaths --analysis-type count --timeframe last_2_minutes --spark'
+      }.to raise_error /Spark only applies to series/
+    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.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2014-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keen
@@ -141,6 +141,7 @@ files:
 - lib/keen-cli.rb
 - lib/keen-cli/batch_processor.rb
 - lib/keen-cli/cli.rb
+- lib/keen-cli/collections.rb
 - lib/keen-cli/events.rb
 - lib/keen-cli/projects.rb
 - lib/keen-cli/queries.rb
@@ -152,6 +153,7 @@ files:
 - spec/fixtures/events.json
 - spec/keen-cli/batch_processor_spec.rb
 - spec/keen-cli/cli_spec.rb
+- spec/keen-cli/collections_spec.rb
 - spec/keen-cli/events_spec.rb
 - spec/keen-cli/projects_spec.rb
 - spec/keen-cli/queries_spec.rb
@@ -187,6 +189,7 @@ test_files:
 - spec/fixtures/events.json
 - spec/keen-cli/batch_processor_spec.rb
 - spec/keen-cli/cli_spec.rb
+- spec/keen-cli/collections_spec.rb
 - spec/keen-cli/events_spec.rb
 - spec/keen-cli/projects_spec.rb
 - spec/keen-cli/queries_spec.rb