keen-cli 0.1.4 → 0.1.5

data/README.md

@@ -96,8 +96,10 @@ keen-cli has a variety of commands, and most are namespaced for clarity.
 
 Parameters:
 
-+ `--collection` (alias `-c`): The collection to add the event to. Alternately you can set `KEEN_COLLECTION_NAME` on the environment if you're working with the same collection frequently.
-+ `--data` (alias `-d`). The properties of the event. The value can be JSON or key=value pairs delimited by & (just like a query string). Data can also be piped in via STDIN.
++ `--collection`, `-c`: The collection to add the event to. Alternately you can set `KEEN_COLLECTION_NAME` on the environment if you're working with the same collection frequently.
++ `--data`, `-d`: The properties of the event. The value can be JSON or `key=value` pairs delimited by `&` (just like a query string). Data can also be piped in via STDIN.
++ `--file`, `-f`: The name of a file that contains newline delimited JSON
++ `--csv`: Specify that the file is in CSV format
 
 Various examples:
 
@@ -124,6 +126,12 @@ $ echo "{ \"username\" : \"dzello\", \"zsh\": 1 }" | keen events:add -c cli-test
 # pipe in events in querystring format
 $ echo "username=dzello&zsh=1" | keen events:add -c cli-test
 
+# specify a file that contains newline delimited json
+$ keen events:add --file events.json
+
+# specify a file in CSV format
+$ keen events:add --csv --file events.csv
+
 # pipe in events from a file of newline delimited json
 # { "username" : "dzello", "zsh" : 1 }
 # { "username" : "dkador", "zsh" : 1 }
@@ -137,20 +145,20 @@ $ cat events.json | keen events:add -c cli-test
 
 Parameters:
 
-+ `--collection` (alias -c) – The collection name to query against. Can also be set on the environment via `KEEN_COLLECTION_NAME`
-+ `--analysis-type` (alias -a)
-+ `--group-by` (alias -g)
-+ `--target-property` (alias -y)
-+ `--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`
-+ `--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.
++ `--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.
++ `--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.
++ `--end`, `-e`: The end time of an absolute timeframe.
++ `--interval`, `-i`: The interval for a series query.
++ `--filters`, `-f`: A set of filters for the query, passed as JSON.
++ `--percentile`: The percentile value (e.g. 99) for a percentile query.
++ `--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`, `-d`: Specify query parameters as JSON instead of query params. Data can also be piped in via STDIN.
 
 Some examples:
 
@@ -224,6 +232,7 @@ Run `keen` with no arguments to see the full list of aliases.
 
 ### Changelog
 
++ 0.1.5 – Support adding events from files with `--file`. Optionally add from CSV with `--csv`.
 + 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`

data/lib/keen-cli/cli.rb

@@ -1,6 +1,7 @@
 require 'thor'
 require 'keen'
 require 'json'
+require 'csv'
 
 require 'keen-cli/utils'
 
@@ -19,6 +20,11 @@ module KeenCli
       option :data, :aliases => ['-d']
     end
 
+    def self.file_options
+      option :file, :aliases => ['-f']
+      option :csv
+    end
+
     def self.collection_options
       option :collection, :aliases => ['-c']
     end
@@ -182,34 +188,52 @@ module KeenCli
 
     shared_options
     data_options
+    file_options
     collection_options
 
     def events_add
 
       events = []
+      collection = Utils.get_collection_name(options)
+
+      if options[:csv]
+
+        data = File.read(options[:file])
+        csv = CSV.new(data, :headers => true, :header_converters => :symbol, :converters => :all)
+        events = csv.to_a.map {|row| row.to_hash }
 
-      if $stdin.tty?
-        events.push(options[:data] || {})
       else
-        ARGV.clear
-        ARGF.each_line do |line|
-          events.push(line)
+
+        if $stdin.tty?
+          if data = options[:data]
+            events.push(data)
+          elsif file = options[:file]
+            File.readlines(file).each do |line|
+              events.push(line)
+            end
+          else
+            events.push({})
+          end
+        else
+          ARGV.clear
+          ARGF.each_line do |line|
+            events.push(line)
+          end
         end
-      end
 
-      events = events.map do |event|
-        begin
-          JSON.parse(event)
-        rescue
+        events = events.map do |event|
           begin
-            Utils.parse_data_as_querystring(event)
+            JSON.parse(event)
           rescue
-            event
+            begin
+              Utils.parse_data_as_querystring(event)
+            rescue
+              event
+            end
           end
         end
-      end
 
-      collection = Utils.get_collection_name(options)
+      end
 
       if events.length > 1
 

data/lib/keen-cli/version.rb

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

data/spec/fixtures/events.csv

@@ -0,0 +1,4 @@
+foo
+1
+2
+3

data/spec/fixtures/events.json

@@ -0,0 +1,3 @@
+{ "foo" : 1 }
+{ "foo" : 2 }
+{ "foo" : 3 }

data/spec/keen-cli/cli_spec.rb

@@ -140,4 +140,33 @@ describe KeenCli::CLI do
       end
     end
   end
+
+  describe 'events:add' do
+    it 'should accept JSON events from a data param' do
+      url = "https://api.keen.io/3.0/projects/#{project_id}/events/minecraft-deaths"
+      stub_request(:post, url).
+        with(:body => { "foo" => 1 }).
+        to_return(:body => { :created => true }.to_json)
+      _, options = start 'events:add --collection minecraft-deaths --data {"foo":1}'
+      expect(_).to eq("created" => true)
+    end
+
+    it 'should accept JSON events from a file param' do
+      url = "https://api.keen.io/3.0/projects/#{project_id}/events/minecraft-deaths"
+      stub_request(:post, "https://api.keen.io/3.0/projects/AAAAAAA/events").
+        with(:body => "{\"minecraft-deaths\":[{\"foo\":1},{\"foo\":2},{\"foo\":3}]}").
+        to_return(:body => { :created => true }.to_json)
+      _, options = start "events:add --collection minecraft-deaths --file #{File.expand_path('../../fixtures/events.json', __FILE__)}"
+      expect(_).to eq("created" => true)
+    end
+
+    it 'should accept JSON events from a file param in CSV format' do
+      url = "https://api.keen.io/3.0/projects/#{project_id}/events/minecraft-deaths"
+      stub_request(:post, "https://api.keen.io/3.0/projects/AAAAAAA/events").
+        with(:body => "{\"minecraft-deaths\":[{\"foo\":1},{\"foo\":2},{\"foo\":3}]}").
+        to_return(:body => { :created => true }.to_json)
+      _, options = start "events:add --collection minecraft-deaths --csv --file #{File.expand_path('../../fixtures/events.csv', __FILE__)}"
+      expect(_).to eq("created" => true)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-20 00:00:00.000000000 Z
+date: 2014-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keen
@@ -142,6 +142,8 @@ files:
 - lib/keen-cli/cli.rb
 - lib/keen-cli/utils.rb
 - lib/keen-cli/version.rb
+- spec/fixtures/events.csv
+- spec/fixtures/events.json
 - spec/keen-cli/cli_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/keenlabs/keen-cli
@@ -170,6 +172,8 @@ signing_key:
 specification_version: 3
 summary: Command line interface to Keen IO
 test_files:
+- spec/fixtures/events.csv
+- spec/fixtures/events.json
 - spec/keen-cli/cli_spec.rb
 - spec/spec_helper.rb
 has_rdoc: