keen-cli 0.1.7 → 0.1.8

data/README.md

@@ -118,34 +118,39 @@ Various examples:
 
 ``` shell
 # add an empty event
-$ keen events:add --collection cli-tests
+$ keen events:add --collection signups
 
 # use the shorter form of collection
-$ keen events:add -c cli-tests
+$ keen events:add -c signups
 
 # add a blank event to a collection specified in a .env file:
-# KEEN_COLLECTION_NAME=cli-tests
+# KEEN_COLLECTION_NAME=signups
 $ keen events:add
 
 # add an event from JSON using the --data parameter
-$ keen events:add -c cli-tests --data "{ \"username\" : \"dzello\", \"zsh\": 1 }"
+$ keen events:add -c signups --data "{ \"username\" : \"dzello\", \"city\": \"San Francisco\" }"
 
 # add an event from key value pairs
-$ keen events:add -c cli-tests -data "username=dzello&zsh=1" --params
+$ keen events:add -c signups -data "username=dzello&city=SF" --params
 
 # pipe in events as JSON
-$ echo "{ \"username\" : \"dzello\", \"zsh\": 1 }" | keen events:add -c cli-tests
+$ echo "{ \"username\" : \"dzello\", \"city\": \"San Francisco\" }" | keen events:add -c signups
 
-# add events from a file that contains newline delimited json
-# { "apple" : "sauce" }
-# { "banana" : "pudding" }
-# { "cherry" : "pie" }
+# add events from a file that contains newline delimited json:
+# { "username" : "dzello", "city" : "San Francisco" }
+# { "username" : "KarlTheFog", "city" : "San Francisco" }
+# { "username" : "polarvortex", "city" : "Chicago" }
 $ keen events:add --file events.json
 
-# add events from a file in CSV format; the first row should be columns
-# fruit,dish
-# apple,sauce
-# banana,pudding
+# add events from a file that contains an array of JSON objects
+# [{ "apple" : "sauce" }, { "banana" : "pudding" }, { "cherry" : "pie" }]
+$ keen events:add --file events.json
+
+# add events from a file in CSV format. the first row must be column names:
+# username, city
+# dzello, San Francisco
+# KarlTheFog, San Francisco
+# polarvortex, Chicago
 $ keen events:add --file events.csv --csv
 ```
 
@@ -178,16 +183,16 @@ Some examples:
 
 ``` shell
 # run a count
-$ keen queries:run --collection cli-tests --analysis-type count
+$ keen queries:run --collection signups --analysis-type count
 1000
 
 # run a count with collection name from .env
-# KEEN_COLLECTION_NAME=cli-tests
+# KEEN_COLLECTION_NAME=signups
 $ keen queries:run --analysis-type count
 1000
 
 # run a count with a group by
-$ keen queries:run --collection cli-tests --analysis-type count --group-by username
+$ keen queries:run --collection signups --analysis-type count --group-by username
 [
   {
     "username": "dzello",
@@ -196,7 +201,7 @@ $ keen queries:run --collection cli-tests --analysis-type count --group-by usern
 ]
 
 # run a query with a timeframe, target property, group by, and interval
-$ keen queries:run --collection cli-tests --analysis-type median --target-property value --group-by cohort --timeframe last_24_hours --interval hourly
+$ keen queries:run --collection signups --analysis-type count_unique --target-property age --group-by source --timeframe last_24_hours --interval hourly
 
 {
   "timeframe": {
@@ -261,6 +266,7 @@ Parameters that apply to most commands include:
 
 ### Changelog
 
++ 0.1.8 - Inputted lines can also be arrays of JSON objects. `--batch-size` param is now properly recognized.
 + 0.1.7 - Add docs command
 + 0.1.6 - Big refactoring to make importing events much cleaner and batching happen automatically. Also adds `queries:url`.
 + 0.1.5 – Support adding events from files with `--file`. Optionally add from CSV with `--csv`.

data/lib/keen-cli/batch_processor.rb

@@ -18,16 +18,18 @@ module KeenCli
     # internal state tracking
     attr_accessor :size
     attr_accessor :events
+    attr_accessor :total_size
 
     def initialize(collection, options={})
       self.collection = collection
-      self.batch_size = options[:batch_size] || DEFAULT_BATCH_SIZE
+      self.batch_size = options[:'batch-size'] || DEFAULT_BATCH_SIZE
       self.csv = options[:csv]
       self.params = options[:params]
       self.csv_options = DEFAULT_CSV_OPTIONS.merge(options[:csv_options] || {})
       self.events = []
       self.pretty = options[:pretty]
       self.silent = options[:silent]
+      self.total_size = 0
       self.reset
     end
 
@@ -46,22 +48,28 @@ module KeenCli
         csv_row = CSV.parse_line(line, self.csv_options)
         raise "Could not parse! #{line}" unless csv_row
 
-        hash = row_to_hash(csv_row)
+        csv_event = row_to_hash(csv_row)
+        add_event_and_flush_if_necessary(csv_event)
 
       elsif self.params
 
-        hash = Utils.parse_data_as_querystring(line)
+        querystring_event = Utils.parse_data_as_querystring(line)
+        add_event_and_flush_if_necessary(querystring_event)
 
       else
 
-        hash = JSON.parse(line)
+        json_object = JSON.parse(line)
 
-      end
-
-      self.events.push(hash)
-      self.size += 1
+        # if it's an array, lets iterate over and flush as necessary
+        if json_object.is_a?(Array)
+          json_object.each do |json_event|
+            add_event_and_flush_if_necessary(json_event)
+          end
+        else
+          add_event_and_flush_if_necessary(json_object)
+        end
 
-      self.flush if self.size >= self.batch_size
+      end
 
     end
 
@@ -77,6 +85,13 @@ module KeenCli
 
     private
 
+    def add_event_and_flush_if_necessary(event)
+      self.events.push(event)
+      self.size += 1
+      self.total_size += 1
+      self.flush if self.size >= self.batch_size
+    end
+
     def set_headers(line)
       csv_row = CSV.parse_line(line, self.csv_options)
       self.csv_options[:headers] = csv_row.to_a

data/lib/keen-cli/events.rb

@@ -7,7 +7,7 @@ module KeenCli
     def self.events_options
       option :csv
       option :params
-      option :'batch-size'
+      option :'batch-size', type: :numeric
     end
 
     desc 'events:add', 'Add one or more events and print the result'
@@ -30,19 +30,15 @@ module KeenCli
         :params => options[:params],
         :pretty => options[:pretty],
         :silent => options[:silent],
-        :batch_size => options[:'batch-size'])
-
-      total_events = 0
+        :'batch-size' => options[:'batch-size'])
 
       if data = options[:data]
         batch_processor.add(data)
-        total_events += 1
       end
 
       if file = options[:file]
         File.readlines(file).each do |line|
           batch_processor.add(line)
-          total_events += 1
         end
       end
 
@@ -50,18 +46,16 @@ module KeenCli
         ARGV.clear
         ARGF.each_line do |line|
           batch_processor.add(line)
-          total_events += 1
         end
       end
 
       if $stdin.tty? && data.nil? && file.nil?
         batch_processor.add("{}")
-        total_events += 1
       end
 
       batch_processor.flush
 
-      total_events
+      batch_processor.total_size
 
     end
 

data/lib/keen-cli/version.rb

@@ -1,3 +1,3 @@
 module KeenCli
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/spec/fixtures/events-array.json

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

data/spec/keen-cli/batch_processor_spec.rb

@@ -12,6 +12,10 @@ module KeenCli
         expect(batch_processor.batch_size).to eq(1000)
       end
 
+      it 'sets total size to 0' do
+        expect(batch_processor.total_size).to eq(0)
+      end
+
       it 'sets the collection' do
         expect(batch_processor.collection).to eq('signups')
       end
@@ -47,6 +51,14 @@ module KeenCli
         })
       end
 
+      it 'converts a JSON array to a series of hashes' do
+        batch_processor.add('[{ "apple": "sauce", "banana": "pancakes" }]')
+        expect(batch_processor.events.first).to eq({
+          "apple" => "sauce",
+          "banana" => "pancakes"
+        })
+      end
+
       it 'converts a param string to a hash' do
         batch_processor.params = true
         batch_processor.add('apple=sauce&banana=pancakes')
@@ -98,6 +110,7 @@ module KeenCli
       it 'adds events to an array up to batch size and increments count' do
         batch_processor.add('{ "apple": "sauce", "banana": "pancakes" }')
         expect(batch_processor.size).to eq(1)
+        expect(batch_processor.total_size).to eq(1)
         expect(batch_processor.events.first).to eq({
           "apple" => "sauce",
           "banana" => "pancakes"
@@ -111,8 +124,10 @@ module KeenCli
         batch_processor.batch_size = 2
         batch_processor.add('{ "apple": "sauce", "banana": "pancakes" }')
         expect(batch_processor.size).to eq(1)
+        expect(batch_processor.total_size).to eq(1)
         batch_processor.add('{ "apple": "sauce", "banana": "pancakes" }')
         expect(batch_processor.size).to eq(0)
+        expect(batch_processor.total_size).to eq(2)
         expect(batch_processor.events).to be_empty
       end
 

data/spec/keen-cli/events_spec.rb

@@ -28,12 +28,20 @@ describe KeenCli::CLI do
       expect(_).to eq(3)
     end
 
+    it 'accepts JSON events from a file param in array format' do
+      stub_request(:post, "https://api.keen.io/3.0/projects/#{Keen.project_id}/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-array.json', __FILE__)}"
+      expect(_).to eq(3)
+    end
+
     it 'accepts JSON events from a file param in CSV format' do
       stub_request(:post, "https://api.keen.io/3.0/projects/#{Keen.project_id}/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(4)
+      expect(_).to eq(3)
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-10 00:00:00.000000000 Z
+date: 2014-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keen
@@ -147,6 +147,7 @@ files:
 - lib/keen-cli/shared.rb
 - lib/keen-cli/utils.rb
 - lib/keen-cli/version.rb
+- spec/fixtures/events-array.json
 - spec/fixtures/events.csv
 - spec/fixtures/events.json
 - spec/keen-cli/batch_processor_spec.rb
@@ -181,6 +182,7 @@ signing_key:
 specification_version: 3
 summary: Command line interface to Keen IO
 test_files:
+- spec/fixtures/events-array.json
 - spec/fixtures/events.csv
 - spec/fixtures/events.json
 - spec/keen-cli/batch_processor_spec.rb