keen-cli 0.1.1 → 0.1.2

data/.gitignore

@@ -1 +1,2 @@
 .env
+Gemfile.lock

data/README.md

@@ -18,13 +18,14 @@ Verify the `keen` command is in your path by running it:
 
 ``` shell
 Commands:
-  keen events:add         # Add an event
-  keen help [COMMAND]     # Describe available commands or one specific command
-  keen project:open       # Open the current project
-  keen project:show       # Show the current project
-  keen project:workbench  # Open the current project's workbench
-  keen queries:run        # Run a query
-  keen version            # Print the keen-cli version
+  keen events:add           # Add one or more events and print the result
+  keen help [COMMAND]       # Describe available commands or one specific command
+  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 version              # Print the keen-cli version
 ```
 
 You should see information about available commands.
@@ -33,7 +34,7 @@ If `keen` can't be found there might be an issue with your Ruby installation. If
 
 ### Environment configuration
 
-Most keen-cli functions require the presence of a project and one or more API keys to do meaningful actions. By default, keen-cli attempts to find these in the process environment or a `.env` file in the current directory. This is the same heuristic that [keen-gem](https://github.com/keenlabs/keen-gem) uses.
+Most keen-cli commands require the presence of a project and one or more API keys to do meaningful actions. By default, keen-cli attempts to find these in the process environment or a `.env` file in the current directory. This is the same heuristic that [keen-gem](https://github.com/keenlabs/keen-gem) uses and is based on [dotenv](https://github.com/bkeepers/dotenv).
 
 An example .env file looks like this:
 
@@ -49,7 +50,7 @@ If you run `keen` from a directory with this .env file, it will assume the proje
 To override the project context use the `--project` option:
 
 ``` shell
-$ keen project:show --project XXXXXXXXXXXXXXX
+$ keen project:describe --project XXXXXXXXXXXXXXX
 ```
 
 Similar overrides are available for specifiying API keys: `--master-key`, `--read-key` and `--write-key`.
@@ -57,13 +58,13 @@ Similar overrides are available for specifiying API keys: `--master-key`, `--rea
 For example:
 
 ``` shell
-$ keen project:show --project XXXXXXXXXXXXXXX --master-key AAAAAAAAAAAAAA
+$ keen project:describe --project XXXXXXXXXXXXXXX --master-key AAAAAAAAAAAAAA
 ```
 
 Shorter aliases exist as well: `-p` for project, `-k` for master key, `-r` for read key, and `-w` for write key.
 
 ``` shell
-$ keen project:show -p XXXXXXXXXXXXXXX -k AAAAAAAAAAAAAA
+$ keen project:describe -p XXXXXXXXXXXXXXX -k AAAAAAAAAAAAAA
 ```
 
 ### Usage
@@ -75,8 +76,9 @@ keen-cli has a variety of commands, and most are namespaced for clarity.
 ##### Projects
 
 * `project:open` - Open the Project Overview page in a browser
-* `project:workbench` - Open the Project Workbench in a browser
-* `project:show` - Get data about the project, uses the [project row resource](https://keen.io/docs/api/reference/#project-row-resource).
+* `project:workbench` - Open the Project Workbench page in a browser
+* `project:describe` - Get data about the project. Uses the [project row resource](https://keen.io/docs/api/reference/#project-row-resource).
+* `project:collections` - Get schema information about the project's collections. Uses the [event resource](https://keen.io/docs/api/reference/#event-resource).
 
 ##### Events
 
@@ -169,6 +171,12 @@ $ keen queries:run --collection cli-tests --analysis-type median --target-proper
   ...
 ```
 
+### Changelog
+
++ 0.1.2 – Change `project:show` to `project:describe`
++ 0.1.1 – Add `project:collections`
++ 0.1.0 - Initial version
+
 ### Contributing
 
 keen-cli is open source, and contributions are very welcome!

data/lib/keen-cli/cli.rb

@@ -44,18 +44,18 @@ module KeenCli
       end
     end
 
-    desc 'project:show', 'Show the current project'
-    map 'project:show' => :project_show
+    desc 'project:describe', 'Print information about a project'
+    map 'project:describe' => :project_describe
     shared_options
 
-    def project_show
+    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
     end
 
-    desc 'project:collections', 'Show the current project\'s collections'
+    desc 'project:collections', 'Print information about a project\'s collections'
     map 'project:collections' => :project_collections
     shared_options
 
@@ -66,7 +66,7 @@ module KeenCli
       end
     end
 
-    desc 'project:open', 'Open the current project'
+    desc 'project:open', 'Open a project\'s overview page in a browser'
     map 'project:open' => :project_open
     shared_options
 
@@ -77,7 +77,7 @@ module KeenCli
       end
     end
 
-    desc 'project:workbench', 'Open the current project\'s workbench'
+    desc 'project:workbench', 'Open a project\'s workbench page in a browser'
     map 'project:workbench' => :project_workbench
     shared_options
 
@@ -88,7 +88,7 @@ module KeenCli
       end
     end
 
-    desc 'queries:run', 'Run a query'
+    desc 'queries:run', 'Run a query and print the result'
     map 'queries:run' => :queries_run
     shared_options
     query_options
@@ -117,7 +117,7 @@ module KeenCli
       end
     end
 
-    desc 'events:add', 'Add an event'
+    desc 'events:add', 'Add one or more events and print the result'
     map 'events:add' => :events_add
 
     shared_options

data/lib/keen-cli/version.rb

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

data/spec/keen-cli/cli_spec.rb

@@ -11,10 +11,17 @@ describe KeenCli::CLI do
     expect(_).to match /version/
   end
 
-  describe 'project:show' do
+  describe 'project:describe' do
     it 'gets the project' do
-      _, options = KeenCli::CLI.start(%w[project:show])
+      _, options = KeenCli::CLI.start(%w[project:describe])
       expect(_).to match /\/3.0\/projects\/#{Keen.project_id}\/events/
     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'
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-28 00:00:00.000000000 Z
+date: 2014-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keen
@@ -133,7 +133,6 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,54 +0,0 @@
-PATH
-  remote: .
-  specs:
-    keen-cli (0.1.0)
-      dotenv
-      http
-      keen
-      thor
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.6)
-    columnize (0.8.9)
-    debugger (1.6.8)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.3.5)
-    debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.3.5)
-    diff-lcs (1.2.5)
-    dotenv (0.11.1)
-      dotenv-deployment (~> 0.0.2)
-    dotenv-deployment (0.0.2)
-    http (0.6.1)
-      http_parser.rb (~> 0.6.0)
-    http_parser.rb (0.6.0)
-    keen (0.8.3)
-      addressable (~> 2.3.5)
-      multi_json (~> 1.3)
-    multi_json (1.10.1)
-    rake (10.3.2)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.2)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.2)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.2)
-    thor (0.19.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  debugger
-  keen-cli!
-  rake
-  rspec