keen-cli 0.1.5 → 0.1.6

data/lib/keen-cli/projects.rb

@@ -0,0 +1,51 @@
+module KeenCli
+
+  class CLI < Thor
+
+    desc 'projects:describe', 'Print information about a project'
+    map 'projects:describe' => :projects_describe
+    shared_options
+
+    def projects_describe
+      Utils.process_options!(options)
+      Keen.project_info.tap do |info|
+        Utils.out_json(info, options)
+      end
+    end
+
+    desc 'projects:collections', 'Print information about a project\'s collections'
+    map 'projects:collections' => :projects_collections
+    shared_options
+
+    def projects_collections
+      Utils.process_options!(options)
+      Keen.event_collections.tap do |collections|
+        Utils.out_json(collections, options)
+      end
+    end
+
+    desc 'projects:open', 'Open a project\'s overview page in a browser'
+    map 'projects:open' => :projects_open
+    shared_options
+
+    def projects_open
+      Utils.process_options!(options)
+      "https://keen.io/project/#{Keen.project_id}".tap do |projects_url|
+        `open #{projects_url}`
+      end
+    end
+
+    desc 'projects:workbench', 'Open a project\'s workbench page in a browser'
+    map 'projects:workbench' => :projects_workbench
+    shared_options
+
+    def projects_workbench
+      Utils.process_options!(options)
+      "https://keen.io/project/#{Keen.project_id}/workbench".tap do |project_url|
+        `open #{project_url}`
+      end
+    end
+
+  end
+
+end

data/lib/keen-cli/queries.rb

@@ -0,0 +1,138 @@
+module KeenCli
+
+  class CLI < Thor
+
+    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
+      option :"property-names"
+      option :latest
+      option :email
+      option :start, :aliases => ['s']
+      option :end, :aliases => ['e']
+    end
+
+    desc 'queries:run', 'Run a query and print the result'
+    map 'queries:run' => :queries_run
+    shared_options
+    query_options
+    data_options
+    def queries_run(analysis_type=nil)
+
+      Utils.process_options!(options)
+
+      collection = Utils.get_collection_name(options)
+      raise "No collection given!" unless collection
+
+      analysis_type = analysis_type || options[:"analysis-type"]
+      raise "No analysis type given!" unless analysis_type
+
+      query_options = to_query_options(options)
+
+      Keen.query(analysis_type, collection, query_options).tap do |result|
+        if result.is_a?(Hash) || result.is_a?(Array)
+          Utils.out_json(result, options)
+        else
+          Utils.out(result, options)
+        end
+      end
+    end
+
+    desc 'queries:url', 'Print the URL for a query'
+    map 'queries:url' => :queries_url
+    shared_options
+    query_options
+    data_options
+    option :'exclude-api-key'
+
+    def queries_url
+
+      Utils.process_options!(options)
+
+      collection = Utils.get_collection_name(options)
+      raise "No collection given!" unless collection
+
+      analysis_type = options[:"analysis-type"]
+      raise "No analysis type given!" unless analysis_type
+
+      query_options = to_query_options(options)
+
+      Keen.query_url(analysis_type, collection, query_options,
+                     { :exclude_api_key => options[:'exclude-api-key']}).tap do |url|
+        Utils.out(url, options)
+      end
+    end
+
+    ANALYSIS_TYPES = %w(average count count-unique extraction median minimum maximum sum percentile select-unique)
+
+    ANALYSIS_TYPES.each do |analysis_type|
+      underscored_analysis_type = analysis_type.sub('-', '_')
+      desc analysis_type, "Alias for queries:run -a #{underscored_analysis_type}"
+      map analysis_type => method_name = "queries_run_#{underscored_analysis_type}"
+      shared_options
+      query_options
+      data_options
+      self.send(:define_method, method_name) { queries_run(underscored_analysis_type) }
+    end
+
+    private
+
+    def to_query_options(options)
+
+      data = nil
+
+      if $stdin.tty?
+        data = options[:data]
+      else
+        ARGV.clear
+        ARGF.each_line do |line|
+          data += line
+        end
+      end
+
+      # setup a holder for query options
+      q_options = {}
+
+      # if data is provided, parse it and merge it
+      unless data.nil?
+        data_options = JSON.parse(data)
+        q_options.merge!(data_options)
+      end
+
+      # copy query options in intelligently
+      q_options[:group_by] = options[:"group-by"]
+      q_options[:target_property] = options[:"target-property"]
+      q_options[:interval] = options[:interval]
+      q_options[:timeframe] = options[:timeframe]
+      q_options[:filters] = options[:filters]
+      q_options[:percentile] = options[:percentile]
+      q_options[:latest] = options[:latest]
+      q_options[:email] = options[:email]
+
+      if property_names = options[:"property-names"]
+        q_options[:property_names] = property_names.split(",")
+      end
+
+      if start_time = options[:start]
+        q_options[:timeframe] = { :start => start_time }
+      end
+
+      if end_time = options[:end]
+        q_options[:timeframe] = q_options[:timeframe] || {}
+        q_options[:timeframe][:end] = end_time
+      end
+
+      q_options.delete_if { |k, v| v.nil? }
+
+      q_options
+    end
+
+  end
+
+end

data/lib/keen-cli/shared.rb

@@ -0,0 +1,28 @@
+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']
+      option :pretty, :type => :boolean, :default => true
+      option :silent, :type => :boolean, :default => false
+    end
+
+    def self.collection_options
+      option :collection, :aliases => ['-c']
+    end
+
+    def self.data_options
+      option :data, :aliases => ['-d']
+    end
+
+    def self.file_options
+      option :file, :aliases => ['-f']
+    end
+
+  end
+
+end

data/lib/keen-cli/utils.rb

@@ -24,6 +24,24 @@ module KeenCli
 
       end
 
+      def out_json(hash, options)
+        if options[:silent]
+          # do nothing
+        elsif options[:pretty]
+          puts JSON.pretty_generate(hash)
+        else
+          puts JSON.generate(hash)
+        end
+      end
+
+      def out(str, options)
+        if options[:silent]
+          # do nothing
+        else
+          puts str
+        end
+      end
+
       def get_collection_name(options)
         options["collection"] || options["event_collection"] || ENV['KEEN_COLLECTION_NAME']
       end

data/lib/keen-cli/version.rb

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

data/lib/keen-cli.rb

@@ -8,3 +8,19 @@ Dotenv.load
 module KeenCli
 
 end
+
+class Hash
+
+  def deep_merge(hash)
+    target = dup
+    hash.keys.each do |key|
+      if hash[key].is_a? Hash and self[key].is_a? Hash
+        target[key] = target[key].deep_merge(hash[key])
+        next
+      end
+      target[key] = hash[key]
+    end
+    target
+  end
+
+end

data/spec/keen-cli/batch_processor_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+module KeenCli
+
+  describe BatchProcessor do
+
+    let(:batch_processor) { BatchProcessor.new('signups') }
+
+    describe 'new' do
+
+      it 'defaults batch size to 1000' do
+        expect(batch_processor.batch_size).to eq(1000)
+      end
+
+      it 'sets the collection' do
+        expect(batch_processor.collection).to eq('signups')
+      end
+
+      it 'sets the pretty output' do
+        batch_processor = BatchProcessor.new('signups', :pretty => true)
+        expect(batch_processor.pretty).to eq(true)
+      end
+
+      it 'sets the silent output' do
+        batch_processor = BatchProcessor.new('signups', :silent => true)
+        expect(batch_processor.silent).to eq(true)
+      end
+
+      it 'sets csv and merges csv options with defaults' do
+        csv_processor = BatchProcessor.new('signups', :csv => true, :csv_options => { :headers => ['foo'] })
+        expect(csv_processor.csv).to eq(true)
+        expect(csv_processor.csv_options).to eq(
+          :headers => ['foo'], :converters => :all)
+      end
+
+    end
+
+    describe 'conversion' do
+
+      let(:batch_processor) { BatchProcessor.new('signups') }
+
+      it 'converts a JSON string to a hash' 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')
+        expect(batch_processor.events.first).to eq({
+          "apple" => "sauce",
+          "banana" => "pancakes"
+        })
+      end
+
+      it 'converts a csv line to a hash' do
+        batch_processor.csv = true
+        batch_processor.csv_options[:headers] = ['apple', 'banana']
+        batch_processor.add('sauce,pancakes')
+        expect(batch_processor.events.first).to eq({
+          "apple" => "sauce",
+          "banana" => "pancakes"
+        })
+      end
+
+      it 'converts a csv line with dotted properties to nested hashes' do
+        batch_processor.csv = true
+        batch_processor.csv_options[:headers] = ['keen.timestamp', 'apple.date', 'apple.banana.cherry', 'apple.banana.walnut']
+        batch_processor.add('2012-08-09,pudding,smoothie,butter')
+        expect(batch_processor.events.first).to eq({
+          "apple" => {
+            "date" => "pudding",
+            "banana" => {
+              "cherry" => "smoothie",
+              "walnut" => "butter"
+            }
+          },
+          "keen" => {
+            "timestamp" => "2012-08-09"
+          }
+        })
+      end
+
+    end
+
+    describe 'add' do
+
+      let(:batch_processor) { BatchProcessor.new('signups', :silent => true) }
+
+      it 'starts empty' do
+        expect(batch_processor.size).to eq(0)
+        expect(batch_processor.events).to be_empty
+      end
+
+      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.events.first).to eq({
+          "apple" => "sauce",
+          "banana" => "pancakes"
+        })
+      end
+
+      it 'flushes at the batch size' do
+        stub_request(:post, "https://api.keen.io/3.0/projects/#{Keen.project_id}/events").
+          with(:body => "{\"signups\":[{\"apple\":\"sauce\",\"banana\":\"pancakes\"},{\"apple\":\"sauce\",\"banana\":\"pancakes\"}]}").
+          to_return(:status => 200, :body => { "signups" => [{ "created" => true }] }.to_json)
+        batch_processor.batch_size = 2
+        batch_processor.add('{ "apple": "sauce", "banana": "pancakes" }')
+        expect(batch_processor.size).to eq(1)
+        batch_processor.add('{ "apple": "sauce", "banana": "pancakes" }')
+        expect(batch_processor.size).to eq(0)
+        expect(batch_processor.events).to be_empty
+      end
+
+    end
+
+    describe 'flush' do
+
+      let(:batch_processor) { BatchProcessor.new('signups') }
+
+      it 'does not flush if there are no events' do
+        batch_processor.size = 0
+        batch_processor.flush
+      end
+
+    end
+
+  end
+
+end

data/spec/keen-cli/cli_spec.rb

@@ -2,171 +2,14 @@ require 'spec_helper'
 
 describe KeenCli::CLI do
 
-  let(:project_id) { 'AAAAAAA' }
-  let(:master_key) { 'DDDDDD' }
-  let(:read_key) { 'BBBBBB' }
-  let(:write_key) { 'CCCCCC' }
-
-  def start(str=nil)
-    KeenCli::CLI.start(str ? str.split(" ") : [])
-  end
-
-  before do
-    Keen.project_id = project_id
-    Keen.read_key = read_key
-    Keen.write_key = write_key
-    Keen.master_key = master_key
-  end
-
-  it 'prints help by default' do
-    _, options = start
-    expect(_).to be_empty
-  end
+  let(:project_id) { Keen.project_id }
+  let(:master_key) { Keen.master_key }
+  let(:read_key) { Keen.read_key }
+  let(:write_key) { Keen.write_key }
 
   it 'prints version info if -v is used' do
     _, options = start "-v"
     expect(_).to match /version/
   end
 
-  describe 'project:describe' do
-    it 'gets the project' do
-      url = "https://api.keen.io/3.0/projects/#{project_id}"
-      stub_request(:get, url).to_return(:body => { :fake => "response" }.to_json)
-      _, options = start 'project:describe'
-      expect(_).to eq("fake" => "response")
-    end
-
-    it 'uses the project id param if present' do
-      url = "https://api.keen.io/3.0/projects/GGGG"
-      stub_request(:get, url).to_return(:body => { :fake => "response" }.to_json)
-      _, options = start 'project:describe --project GGGG'
-      expect(_).to eq("fake" => "response")
-    end
-  end
-
-  describe 'project:collections' do
-    it 'prints the project\'s collections' do
-      url = "https://api.keen.io/3.0/projects/#{project_id}/events"
-      stub_request(:get, url).to_return(:body => { :fake => "response" }.to_json)
-      _, options = start 'project:collections'
-      expect(_).to eq("fake" => "response")
-    end
-
-    it 'uses the project id param if present' do
-      url = "https://api.keen.io/3.0/projects/GGGG/events"
-      stub_request(:get, url).to_return(:body => { :fake => "response" }.to_json)
-      _, options = start 'project:collections --project GGGG'
-      expect(_).to eq("fake" => "response")
-    end
-  end
-
-  describe 'queries:run' do
-    it 'runs the query using certain params' do
-      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths"
-      stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
-      _, options = start 'queries:run --analysis-type count --collection minecraft-deaths'
-      expect(_).to eq(10)
-    end
-
-    it 'runs the query using aliased params' do
-      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths"
-      stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
-      _, options = start 'queries:run -a count -c minecraft-deaths'
-      expect(_).to eq(10)
-    end
-
-    it 'converts dashes to underscores for certain properties' do
-      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths&group_by=foo&target_property=bar"
-      stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
-      _, options = start 'queries:run --analysis-type count --collection minecraft-deaths --group-by foo --target-property bar'
-      expect(_).to eq(10)
-    end
-
-    it 'accepts extraction-specific properties' do
-      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/extraction?event_collection=minecraft-deaths&property_names=%5B%22foo%22,%22bar%22%5D&latest=1&email=bob@bob.io"
-      stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
-      _, options = start 'queries:run --analysis-type extraction --collection minecraft-deaths --property-names foo,bar --latest 1 --email bob@bob.io'
-      expect(_).to eq(10)
-    end
-
-    it 'converts comma-delimited property names to an array' do
-      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/extraction?event_collection=minecraft-deaths&property_names=%5B%22foo%22,%22bar%22%5D"
-      stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
-      _, options = start 'queries:run --analysis-type extraction --collection minecraft-deaths --property-names foo,bar'
-      expect(_).to eq(10)
-    end
-
-
-    it 'uses a data option to take in query JSON' do
-      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths"
-      stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
-      _, options = start 'queries:run --analysis-type count --data {"event_collection":"minecraft-deaths"}'
-      expect(_).to eq(10)
-    end
-
-    it 'converts a start parameter into an absolute timeframe' do
-      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths&timeframe=%7B%22start%22:%222014-07-06T12:00:00Z%22%7D"
-      stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
-      _, options = start 'queries:run --collection minecraft-deaths --analysis-type count --start 2014-07-06T12:00:00Z'
-      expect(_).to eq(10)
-    end
-
-    it 'converts an end parameter into an absolute timeframe' do
-      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths&timeframe=%7B%22end%22:%222014-07-06T12:00:00Z%22%7D"
-      stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
-      _, options = start 'queries:run --collection minecraft-deaths --analysis-type count --end 2014-07-06T12:00:00Z'
-      expect(_).to eq(10)
-    end
-
-    it 'converts start and end parameters into an absolute timeframe' do
-      url = "https://api.keen.io/3.0/projects/#{project_id}/queries/count?event_collection=minecraft-deaths&timeframe=%7B%22start%22:%222014-07-06T12:00:00Z%22,%22end%22:%222014-07-08T12:00:00Z%22%7D"
-      stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
-      _, options = start 'queries:run --collection minecraft-deaths --analysis-type count --start 2014-07-06T12:00:00Z --end 2014-07-08T12:00:00Z'
-      expect(_).to eq(10)
-    end
-
-  end
-
-  describe "queries:run aliases" do
-    KeenCli::CLI::ANALYSIS_TYPES.each do |analysis_type|
-      describe analysis_type do
-        it "aliases to queries run, passing along the #{analysis_type} analysis type" do
-          underscored_analysis_type = analysis_type.sub('-', '_')
-          url = "https://api.keen.io/3.0/projects/#{project_id}/queries/#{underscored_analysis_type}?event_collection=minecraft-deaths"
-          stub_request(:get, url).to_return(:body => { :result => 10 }.to_json)
-          _, options = start "#{analysis_type} --collection minecraft-deaths"
-          expect(_).to eq(10)
-        end
-      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

data/spec/keen-cli/events_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe KeenCli::CLI do
+
+  describe 'events:add' do
+
+    it 'adds a blank event' do
+      stub_request(:post, "https://api.keen.io/3.0/projects/#{Keen.project_id}/events").
+        with(:body => "{\"minecraft-deaths\":[{}]}").
+        to_return(:body => { :created => true }.to_json)
+      _, options = start 'events:add --collection minecraft-deaths'
+      expect(_).to eq(1)
+    end
+
+    it 'accepts JSON events from a data param' do
+      stub_request(:post, "https://api.keen.io/3.0/projects/#{Keen.project_id}/events").
+        with(:body => "{\"minecraft-deaths\":[{\"foo\":1}]}").
+        to_return(:body => { :created => true }.to_json)
+      _, options = start 'events:add --collection minecraft-deaths --data {"foo":1}'
+      expect(_).to eq(1)
+    end
+
+    it 'accepts JSON events from a file param' 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.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)
+    end
+
+  end
+
+end

data/spec/keen-cli/projects_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe KeenCli::CLI do
+
+  let(:project_id) { Keen.project_id }
+  let(:master_key) { Keen.master_key }
+  let(:read_key) { Keen.read_key }
+  let(:write_key) { Keen.write_key }
+
+  describe 'projects:describe' do
+    it 'gets the project' do
+      url = "https://api.keen.io/3.0/projects/#{project_id}"
+      stub_request(:get, url).to_return(:body => { :fake => "response" }.to_json)
+      _, options = start 'projects:describe'
+      expect(_).to eq("fake" => "response")
+    end
+
+    it 'uses the project id param if present' do
+      url = "https://api.keen.io/3.0/projects/GGGG"
+      stub_request(:get, url).to_return(:body => { :fake => "response" }.to_json)
+      _, options = start 'projects:describe --project GGGG'
+      expect(_).to eq("fake" => "response")
+    end
+  end
+
+  describe 'projects:collections' do
+    it 'prints the project\'s collections' do
+      url = "https://api.keen.io/3.0/projects/#{project_id}/events"
+      stub_request(:get, url).to_return(:body => { :fake => "response" }.to_json)
+      _, options = start 'projects:collections'
+      expect(_).to eq("fake" => "response")
+    end
+
+    it 'uses the project id param if present' do
+      url = "https://api.keen.io/3.0/projects/GGGG/events"
+      stub_request(:get, url).to_return(:body => { :fake => "response" }.to_json)
+      _, options = start 'projects:collections --project GGGG'
+      expect(_).to eq("fake" => "response")
+    end
+  end
+
+end