keen-cli 0.2.3 → 0.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 494c97428e79141428c1ed3beb39b22be64868ed
+  data.tar.gz: 8d205f837afd7f7edfcfbf4f775e1b69b6f89b20
+SHA512:
+  metadata.gz: a1c4010491f5f9a88df9b8b2a5a5591afb13fc2fab504ebfaf6ef3ab6cfd3a6f5e135ab98594fa1496b8e53a4cf065f1611fee5e40afe59b5ed44389d44fa792
+  data.tar.gz: 6720ca7a9c805084ff98096eac81153425792a7886b886bb5bc7f626e04c6e8561c9797e8de9e3a9f7e6021c51ee32792eb7700c47540388c070a89e27686586

data/README.md

@@ -4,6 +4,9 @@
 
 A command line interface for the Keen IO analytics API.
 
+### Community-Supported SDK
+This is an _unofficial_ community supported SDK. If you find any issues or have a request please post an [issue](https://github.com/keen/keen-cli/issues).
+
 ### Installation
 
 keen-cli is built with Ruby, so you'll need a working Ruby 1.9+ environment to use it. You can find Ruby installation instructions [here](https://www.ruby-lang.org/en/installation/).
@@ -127,35 +130,37 @@ $ keen events:add --collection signups
 # use the shorter form of collection
 $ keen events:add -c signups
 
-# add a blank event to a collection specified in a .env file:
-# KEEN_COLLECTION_NAME=signups
-$ keen events:add
+# add a blank event to a collection specified by the environment:
+$ KEEN_COLLECTION_NAME=signups keen events:add
 
 # add an event from JSON using the --data parameter
 $ keen events:add -c signups --data "{ \"username\" : \"dzello\", \"city\": \"San Francisco\" }"
 
-# add an event from key value pairs
+# add an event from key value pairs using the --params parameter
 $ keen events:add -c signups -data "username=dzello&city=SF" --params
 
-# pipe in events as JSON
-$ echo "{ \"username\" : \"dzello\", \"city\": \"San Francisco\" }" | keen events:add -c signups
-
 # 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
+$ keen events:add -c signups --file events.json
 
 # add events from a file that contains an array of JSON objects
 # [{ "apple" : "sauce" }, { "banana" : "pudding" }, { "cherry" : "pie" }]
-$ keen events:add --file events.json
+$ keen events:add -c signups --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
+$ keen events:add -c signups --file events.csv --csv
+
+# pipe in an event as JSON
+$ echo "{ \"username\" : \"dzello\", \"city\": \"San Francisco\" }" | keen events:add -c signups
+
+# pipe in multiple events as newline-delimited JSON
+$ cat events.json | keen events:add -c signups
 ```
 
 Notes:
@@ -192,20 +197,20 @@ Some examples:
 
 ``` shell
 # run a count
-$ keen queries:run --collection signups --analysis-type count
+$ keen queries:run --collection signups --analysis-type count --timeframe this_14_days
 {
   "result": 1000
 }
 
 # run a count with collection name from .env
 # KEEN_COLLECTION_NAME=signups
-$ keen queries:run --analysis-type count
+$ keen queries:run --analysis-type count --timeframe this_14_days
 {
   "result": 1000
 }
 
 # run a count with a group by
-$ keen queries:run --collection signups --analysis-type count --group-by username
+$ keen queries:run --collection signups --analysis-type count --group-by username --timeframe this_14_days
 {
   "result": [
     {
@@ -216,7 +221,7 @@ $ keen queries:run --collection signups --analysis-type count --group-by usernam
 }
 
 # 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
+$ keen queries:run --collection signups --analysis-type count_unique --target-property age --group-by source --timeframe previous_24_hours --interval hourly
 {
   "result": [
     {
@@ -238,7 +243,7 @@ $ keen queries:run --analysis-type count --start 2014-07-01T00:00:00Z --end 2014
 }
 
 # run an extraction with specific property names
-$ keen queries:run --collection minecraft-deaths --analysis-type extraction --property-names player,enemy
+$ keen queries:run --collection minecraft-deaths --analysis-type extraction --property-names player,enemy --timeframe this_14_days
 {
   "result": [
     {
@@ -253,7 +258,7 @@ $ keen queries:run --collection minecraft-deaths --analysis-type extraction --pr
 }
 
 # run a query using JSON to specify parameters
-$ echo "{ \"event_collection\" : \"minecraft-deaths\", \"target_property\": \"level\" }" | keen queries:run -a average
+$ echo "{ \"event_collection\" : \"minecraft-deaths\", \"target_property\": \"level\" , \"timeframe\": \"this_14_days\" }" | keen queries:run -a average
 {
   "result": 2
 }
@@ -268,7 +273,7 @@ Run `keen` with no arguments to see the full list of aliases.
 The same parameters apply as `queries:run`, in addition to one extra.
 
 + `--exclude-api-key`: Prevent the API key query param from being included in the output
- 
+
 **Query Aliases**
 
 For each type of analysis (e.g. count, average, extraction, etc.) there is an alias that can be used

data/Rakefile

@@ -3,7 +3,7 @@ require 'rspec/core/rake_task'
 
 desc "Run Rspec unit tests"
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = "spec/aud/**/*_spec.rb"
+  t.pattern = "spec/keen-cli/**/*_spec.rb"
 end
 
 task :default => :spec

data/keen-cli.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'debugger'
+  s.add_development_dependency 'byebug'
   s.add_development_dependency 'webmock'
 
   s.files         = `git ls-files`.split("\n")

data/lib/keen-cli/batch_processor.rb

@@ -93,6 +93,17 @@ module KeenCli
         keen.delete("created_at")
       end
 
+      # Set the keen.location.coordinates to a true array
+      if event["keen"] and event["keen"]["location"] and event["keen"]["location"]["coordinates"]
+        coordinates = event["keen"]["location"]["coordinates"]
+
+        if coordinates and coordinates[0] == "[" and coordinates[coordinates.length-1] == "]"
+          event["keen"]["location"]["coordinates"] = coordinates[1..coordinates.length-2].split(',').map(&:to_f)
+        elsif coordinates.class != Array # This should never happen, but just in case..
+          event["keen"].delete("location")
+        end
+      end
+
       self.events.push(event)
       self.size += 1
       self.total_size += 1

data/lib/keen-cli/version.rb

@@ -1,3 +1,3 @@
 module KeenCli
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/spec/keen-cli/batch_processor_spec.rb

@@ -166,6 +166,11 @@ module KeenCli
         expect(batch_processor.events.first).to eq({ "keen" => {} })
       end
 
+      it 'reformats the keen.location.coordinates property' do
+        batch_processor.add('{ "keen": { "location": { "coordinates": "[12.12, 34.34]" } } }')
+        expect(batch_processor.events.first).to eq({"keen" => { "location" => { "coordinates" => [12.12, 34.34] } } })
+      end
+
     end
 
     describe 'flush' do

metadata

@@ -1,126 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: keen-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.3
-  prerelease: 
+  version: 0.2.4
 platform: ruby
 authors:
 - Josh Dzielak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-20 00:00:00.000000000 Z
+date: 2016-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keen
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.8
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Record events and run queries from the comfort of your command line
@@ -130,8 +115,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -161,27 +146,26 @@ files:
 homepage: https://github.com/keenlabs/keen-cli
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Command line interface to Keen IO
 test_files:
 - spec/fixtures/events-array.json
@@ -194,4 +178,3 @@ test_files:
 - spec/keen-cli/projects_spec.rb
 - spec/keen-cli/queries_spec.rb
 - spec/spec_helper.rb
-has_rdoc: