keen-cli 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+.env

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+- 2.1.0
+env:
+  global:
+    - secure: dyzAKPD91LvwtjcX0mo4ENPhpjCgtkrS1Z5mgodYHafMz+GBTrMLdwnA/jE2EnzUhVcTieuAvIsYP7sGsG43qxtYNIl7FMXdz1PywgQVZuPbmNV6Y2iBaU61TlQvR1rtLA+G4N8TOxdVQxThpYlNv1rNHGSqtgOOICMNZLTY224=
+    - secure: SAfN4kwEsqEBSSr8Fr2h2ySxFz7P+6rgysgEjF24fL6JW5N+YmKmwHh1en81d4R+BYcYIMQRwe1owpyqisvx0kASUVnWdPT0+loHm5rH22IEFsYjTEiuYOAZCj1/4yLcVmdX6EH34cNmoGbxUUziD9k9ctVGoehxaK9te+xphvc=
+    - secure: k2owfccj86F/b7X/WRsi8HGdJ9v+zuDek/Vu7XzNN+fqqja4rlXTtWSJyOTikklOMRN0AlUh1GjRWp+eT8YXKdiN4gk7WUGiryaTGATKWn1nLaIDtEjugMMmqXq7YwCih1GulPhMlRSwHU4b9q/MsciTFwzxREsxecjrQYL8HQY=
+    - secure: PXsUN/cmCwMbBjkJ6HLdWPmOEtk6+G1HMP5RhejImbUII7MJ1GRhHdehMCgc74wNfVt/MX/de2AgB17EQc5tDSKoQqV9dCZ4cRDPjlh82MK3gN1L2ZUgD+wJeY/29bZak6NMnVXVN18HGfIMjCVnS3t2rkQ94nwZVtIuhCkAWRk=
+script:
+- bundle exec rake spec

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+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.2)
+      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

data/LICENSE

@@ -0,0 +1,21 @@
+Author Josh Dzielak
+Copyright (c) 2012-2014 Keen Labs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,176 @@
+# keen-cli
+
+[![Build Status](https://travis-ci.org/keenlabs/keen-cli.svg?branch=master)](https://travis-ci.org/keenlabs/keen-cli)
+
+A command line interface for the Keen IO analytics API.
+
+### 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/).
+
+Install the gem:
+
+``` shell
+$ gem install keen-cli
+```
+
+Verify the `keen` command is in your path by running it:
+
+``` shell
+$ keen
+Commands:
+  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 version         # Print the keen-cli version
+```
+
+You should see information about available commands.
+
+If `keen` can't be found there might be an issue with your Ruby installation. If you're using [rbenv](https://github.com/sstephenson/rbenv) try running `rbenv rehash` after installation.
+
+### 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.
+
+An example .env file looks like this:
+
+```
+KEEN_PROJECT_ID=aaaaaaaaaaaaaaa
+KEEN_MASTER_KEY=xxxxxxxxxxxxxxx
+KEEN_WRITE_KEY=yyyyyyyyyyyyyyy
+KEEN_READ_KEY=zzzzzzzzzzzzzzz
+```
+
+If you run `keen` from a directory with this .env file, it will assume the project in context is the one specified by `KEEN_PROJECT_ID`.
+
+To override the project context use the `--project` option:
+
+``` shell
+$ keen project:show --project XXXXXXXXXXXXXXX
+```
+
+Similar overrides are available for specifiying API keys: `--master-key`, `--read-key` and `--write-key`.
+
+For example:
+
+``` shell
+$ keen project:show --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
+```
+
+### Usage
+
+keen-cli has a variety of commands, and most are namespaced for clarity.
+
+* `version` - Print version information
+
+##### Projects
+
+* `project:open` - Open the Project Overview page in a browser
+* `project:show` - Get data about the project, uses the [project row resource](https://keen.io/docs/api/reference/#project-row-resource).
+
+##### Events
+
+`events:add` - Add an event.
+
+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.
+
+Various examples:
+
+``` shell
+# create an empty event
+$ keen events:add --collection cli-tests
+
+# use the shorter form of collection
+$ keen events:add -c cli-tests
+
+# add a blank event to a collection specified in the .env file:
+# KEEN_COLLECTION_NAME=cli-tests
+$ keen events:add
+
+# create an event from JSON
+$ keen events:add -c cli-tests -d "{ \"username\" : \"dzello\", \"zsh\": 1 }"
+
+# create an event from key value pairs
+$ keen events:add -c cli-tests -d "username=dzello&zsh=1"
+
+# pipe in events as JSON
+$ echo "{ \"username\" : \"dzello\", \"zsh\": 1 }" | keen events:add -c cli-tests
+
+# pipe in events in querystring format
+$ echo "username=dzello&zsh=1" | keen events:add -c cli-test
+
+# pipe in events from a file of newline delimited json
+# { "username" : "dzello", "zsh" : 1 }
+# { "username" : "dkador", "zsh" : 1 }
+# { "username" : "gphat", "zsh" : 1 }
+$ cat events.json | keen events:add -c cli-test
+```
+
+##### Queries
+
+`queries:run` - Runs a query and prints the result in pretty JSON.
+
+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)
++ `--interval` (alias -i)
++ `--filters` (alias -f)
++ `--percentile`
+
+Some examples:
+
+``` shell
+# run a count
+$ keen queries:run -a count -c cli-tests
+
+# run a count with collection name from .env
+# KEEN_COLLECTION_NAME=cli-tests
+$ keen queries:run -a count
+1000
+
+# run a count with a group by
+$ keen queries:run -a count -g a
+[
+  {
+    "a": 1,
+    "result": 1000
+  }
+]
+
+# run a query with a timeframe, target property, group by, and interval
+$ keen queries:run -c cli-tests --analysis-type median --target-property value --group-by cohort --timeframe last_24_hours --interval hourly
+
+{
+  "timeframe": {
+    "start": "2014-06-27T01:00:00.000Z",
+    "end": "2014-06-27T02:00:00.000Z"
+  },
+  "value": [
+  ...
+  ...
+  ...
+```
+
+### Contributing
+
+keen-cli is open source, and contributions are very welcome!
+
+Running the tests with:
+
+```
+$ bundle exec rake spec
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+desc "Run Rspec unit tests"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = "spec/aud/**/*_spec.rb"
+end
+
+task :default => :spec
+task :test => [:spec]

data/bin/keen

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'keen-cli'
+require 'keen-cli/cli'
+
+KeenCli::CLI.start

data/keen-cli.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "keen-cli/version"
+
+Gem::Specification.new do |s|
+  s.name        = "keen-cli"
+  s.version     = KeenCli::VERSION
+  s.authors     = ["Josh Dzielak"]
+  s.email       = "josh@keen.io"
+  s.homepage    = "https://github.com/keenlabs/keen-cli"
+  s.summary     = "Command line interface to Keen IO"
+  s.description = "Record events and run queries from the comfort of your command line"
+  s.license     = "MIT"
+
+  s.add_dependency "keen"
+  s.add_dependency "thor"
+  s.add_dependency "dotenv"
+  s.add_dependency "http"
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'debugger'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/keen-cli/cli.rb

@@ -0,0 +1,150 @@
+require 'http'
+require 'thor'
+require 'keen'
+require 'json'
+
+require 'keen-cli/utils'
+
+module KeenCli
+
+  class CLI < Thor
+
+    def self.shared_options
+      option :project, :aliases => ['-p']
+      option :"master-key", :aliases => ['-k']
+      option :"read-key", :aliases => ['-r']
+      option :"write-key", :aliases => ['-w']
+    end
+
+    def self.data_options
+      option :data, :aliases => ['-d']
+    end
+
+    def self.collection_options
+      option :collection, :aliases => ['-c']
+    end
+
+    def self.query_options
+      self.collection_options
+      option :"analysis-type", :aliases => ['-a']
+      option :"group-by", :aliases => ['-g']
+      option :"target-property", :aliases => ['-y']
+      option :interval, :aliases => ['-i']
+      option :timeframe, :aliases => ['-t']
+      option :filters, :aliases => ['-f']
+      option :percentile
+    end
+
+    desc 'version', 'Print the keen-cli version'
+    map %w(-v --version) => :version
+
+    def version
+      "keen-cli version #{KeenCli::VERSION}".tap do |s|
+        puts s
+      end
+    end
+
+    desc 'project:show', 'Show the current project'
+    map 'project:show' => :project_show
+    shared_options
+
+    def project_show
+      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:open', 'Open the current project'
+    map 'project:open' => :project_open
+    shared_options
+
+    def project_open
+      Utils.process_options!(options)
+      "https://keen.io/project/#{Keen.project_id}".tap do |project_url|
+        `open #{project_url}`
+      end
+    end
+
+    desc 'queries:run', 'Run a query'
+    map 'queries:run' => :queries_run
+    shared_options
+    query_options
+    def queries_run
+
+      Utils.process_options!(options)
+
+      # convert dashes
+      q_options = options.inject({}) do |memo, element|
+        if ['analysis-type', 'group-by', 'target-property'].include?(element.first)
+          memo[element.first.sub('-', '_')] = element.last
+        else
+          memo[element.first] = element.last
+        end
+        memo
+      end
+
+      collection = Utils.get_collection_name(options)
+
+      Keen.send(q_options["analysis_type"], collection, q_options).tap do |result|
+        if result.is_a?(Hash) || result.is_a?(Array)
+          puts JSON.pretty_generate(result)
+        else
+          puts result
+        end
+      end
+    end
+
+    desc 'events:add', 'Add an event'
+    map 'events:add' => :events_add
+
+    shared_options
+    data_options
+    collection_options
+
+    def events_add
+
+      events = []
+
+      if $stdin.tty?
+        events.push(options[:data] || {})
+      else
+        ARGV.clear
+        ARGF.each_line do |line|
+          events.push(line)
+        end
+      end
+
+      events = events.map do |event|
+        begin
+          JSON.parse(event)
+        rescue
+          begin
+            Utils.parse_data_as_querystring(event)
+          rescue
+            event
+          end
+        end
+      end
+
+      collection = Utils.get_collection_name(options)
+
+      if events.length > 1
+
+        Keen.publish_batch(collection => events).tap do |result|
+          puts JSON.pretty_generate(result)
+        end
+
+      else
+
+        Keen.publish(collection, events.first).tap do |result|
+          puts JSON.pretty_generate(result)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/keen-cli/utils.rb

@@ -0,0 +1,49 @@
+module KeenCli
+
+  class Utils
+
+    class << self
+
+      def process_options!(options)
+
+        if project_id = options[:project]
+          Keen.project_id = project_id
+        end
+
+        if master_key = options[:"master-key"]
+          Keen.master_key = master_key
+        end
+
+        if read_key = options[:"read-key"]
+          Keen.read_key = read_key
+        end
+
+        if write_key = options[:"write-key"]
+          Keen.write_key = write_key
+        end
+
+      end
+
+      def get_collection_name(options)
+        options["collection"] || ENV['KEEN_COLLECTION_NAME']
+      end
+
+      def parse_data_as_querystring(query)
+        keyvals = query.split('&').inject({}) do |result, q| 
+          k,v = q.split('=')
+          if !v.nil?
+             result.merge({k => v})
+          elsif !result.key?(k)
+            result.merge({k => true})
+          else
+            result
+          end
+        end
+        keyvals
+      end
+
+    end
+
+  end
+
+end

data/lib/keen-cli/version.rb

@@ -0,0 +1,3 @@
+module KeenCli
+  VERSION = "0.1.0"
+end

data/lib/keen-cli.rb

@@ -0,0 +1,10 @@
+require 'keen-cli/version'
+require 'keen-cli/cli'
+
+require 'dotenv'
+
+Dotenv.load
+
+module KeenCli
+
+end

data/spec/keen-cli/cli_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe KeenCli::CLI do
+  it 'prints help by default' do
+    _, options = KeenCli::CLI.start
+    expect(_).to be_empty
+  end
+
+  it 'prints version info if -v is used' do
+    _, options = KeenCli::CLI.start(%w[-v])
+    expect(_).to match /version/
+  end
+
+  describe 'project:show' do
+    it 'gets the project' do
+      _, options = KeenCli::CLI.start(%w[project:show])
+      expect(_).to match /\/3.0\/projects\/#{Keen.project_id}\/events/
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+
+require File.expand_path("../../lib/keen-cli", __FILE__)
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: keen-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Josh Dzielak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-28 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: http
+  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
+  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
+email: josh@keen.io
+executables:
+- keen
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/keen
+- keen-cli.gemspec
+- lib/keen-cli.rb
+- lib/keen-cli/cli.rb
+- lib/keen-cli/utils.rb
+- lib/keen-cli/version.rb
+- spec/keen-cli/cli_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/keenlabs/keen-cli
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 3
+summary: Command line interface to Keen IO
+test_files:
+- spec/keen-cli/cli_spec.rb
+- spec/spec_helper.rb