influxdb-cli 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7a4f8e0419999de09aa047254204462f8150b6d
-  data.tar.gz: f468e14d522630cc1e4b6de1970e3484ba2b8051
+  metadata.gz: 281b2fa707050411c4122d9d0baec8bb71eb7df9
+  data.tar.gz: 7c8db30a7593ce61d5568b736db0e14d5a89deea
 SHA512:
-  metadata.gz: 83f22cfbe7d9c64fb8189cf2b37f0dbbf66db33aef45d658e251c77179fca54c18a0b6ffa79d57d439c7a65eea83e1be17d9034e6432c19e5992e1615162a723
-  data.tar.gz: 714a92645856fecd8e2cc3f8b85ef0ab3e6bdce44c7183c4ce274e214834ed235235a7c18a1969f8b0e8951fbdeae4e5d77a528652f90ec5df9ef35e683ee7d8
+  metadata.gz: 0755bf563ec3a8bcf1d3253b833f76668ac72e67f474cdaa6304e2247cc0cb17b292f601830bf6676eee4deba3e356185182d6b328e2d4fa7ba64f076050f2a6
+  data.tar.gz: ebb47210f603cad89deee719c23681db14695a999c39a8218922972b0ca75d38f57f42dbc74aed8a81ac80a89edee192e618130a91fd847f3321da149dd3b095

data/README.md

@@ -31,10 +31,10 @@ Options:
 
 ### Usage
 
-Connect to a database:
+#### Connect to a database
 
 ```shell
-influxdb-cli
+$ influxdb-cli
 Connecting to {"host"=>"localhost", "port"=>8086, "username"=>"root", "password"=>"root", "database"=>"db"}
 ✔ ready
 ```
@@ -42,16 +42,63 @@ Connecting to {"host"=>"localhost", "port"=>8086, "username"=>"root", "password"
 or
 
 ```shell
-influxdb-cli -u user -p password -d database -h sandbox.influxdb.org --port 9061
+$ influxdb-cli -u user -p password -d database -h sandbox.influxdb.org --port 9061
 Connecting to {"host"=>"sandbox.influxdb.org", "port"=>"9061", "username"=>"username", "password"=>"password", "database"=>"database"}
 ✔ ready
 ```
 
 [InfluxDB Playground](http://play.influxdb.org) :metal:
 
-Query with a [tabularized](https://github.com/visionmedia/terminal-table) output:
+#### Create a database and user
 
-```shell
+```ruby
+2.0.0 (main)> db.create_database 'db'
+2.0.0 (main)> db.create_database_user 'db', 'root', 'root'
+```
+
+#### List databases
+
+```ruby
+2.0.0 (main)> db.get_database_list
+```
+
+#### Switch databases
+
+```ruby
+2.0.0 (main)> use other_database
+2.0.0 (main)> db.database
+=> "other_database"
+```
+
+#### Write a point
+
+```ruby
+2.0.0 (main)> db.write_point('test', { message: 'Hello Pablo' })
+
+2.0.0 (main)> SELECT * FROM test
+
++---------------+-----------------+-------------+
+|                     test                      |
++---------------+-----------------+-------------+
+| time          | sequence_number | message     |
++---------------+-----------------+-------------+
+| 1387287723816 | 1               | Hello Pablo |
++---------------+-----------------+-------------+
+1 result found for test
+
+Query duration: 0.0s
+```
+
+#### Return the last point from every time series in the database
+
+```ruby
+2.0.0 (main)> SELECT * FROM /.*/
+```
+
+
+#### Query with a [tabularized output](https://github.com/visionmedia/terminal-table)
+
+```ruby
 2.0.0 (main)> SELECT * FROM deploys
 +---------------+-----------------+-----------------+--------+-----------------+-------------------+----------+
 |                                                    deploys                                                  |
@@ -61,15 +108,14 @@ Query with a [tabularized](https://github.com/visionmedia/terminal-table) output
 | ...           | ...             | ...             | ...    | ...             | ...               | ...      |
 +---------------+-----------------+-----------------+--------+-----------------+-------------------+----------+
 
-=> {
-    "deploys.count" => 1
-}
-```
+1 result found for deploys
 
+Query duration: 0.49s
+```
 
-Query with a Ruby Hash output ([awesome_print](https://github.com/michaeldv/awesome_print)):
+#### Query with a [Ruby Hash output](https://github.com/michaeldv/awesome_print)
 
-```shell
+```ruby
 2.0.0 (main)> db.query('SELECT * FROM deploys')
 => {
      "deploys" => [
@@ -84,9 +130,9 @@ Query with a Ruby Hash output ([awesome_print](https://github.com/michaeldv/awes
         },
 ```
 
-Other methods:
+#### Other methods
 
-```shell
+```ruby
 2.0.0 (main)> db.write_point(name, data)
 2.0.0 (main)> db.get_database_list
 2.0.0 (main)> ls -q db
@@ -101,7 +147,9 @@ instance variables: @database  @host  @http  @password  @port  @queue  @username
 
 As influxdb-cli is empowered with Pry, all Pry awesome commands are avaiable in the console.
 
-```shell
+#### show-source
+
+```ruby
 2.0.0 (main)> show-source InfluxDB::Client#query
 
 From: /Users/pablo/.gem/ruby/2.0.0/gems/influxdb-0.0.11/lib/influxdb/client.rb @ line 152:
@@ -128,7 +176,9 @@ def query(query)
 end
 ```
 
-```shel
+#### show-doc
+
+```ruby
 
 2.0.0 (main)> show-doc InfluxDB::Client#initialize
 

data/bin/influxdb-cli

@@ -12,7 +12,9 @@ require 'influxdb_client/version'
 require 'influxdb_client/client'
 
 class InfluxDBClientTasks < Thor
-  desc 'db', 'Connect to InfluxDB'
+  @@db = nil
+
+  desc 'db', 'Connect to InfluxDB (default command)'
   method_option :host,      :default => 'localhost',  :aliases => '-h',  :desc => 'Hostname'
   method_option :port,      :default => 8086,         :desc => 'Port'
   method_option :username,  :default => 'root',       :aliases => '-u',  :desc => 'Username'
@@ -28,13 +30,11 @@ class InfluxDBClientTasks < Thor
   desc 'version', 'Show influxdb-cli version'
   def version
     puts "influxdb-cli #{InfluxDBClient::VERSION}"
-    # skip `pry` console
-    exit 0
   end
 
   def self.db; @@db; end
 
-  default_task :db
+  default_command :db
 end
 
 # Returns {InfluxDB::Client} instance using given parameters.
@@ -44,11 +44,14 @@ def db; InfluxDBClientTasks.db; end
 
 InfluxDBClientTasks.start
 
+# exit if the db command wasn't called
+exit 0 unless db
+
 # allow typing queries directly from console i.e.`select * from deploys` instead of `query('select * from deploys')`.
 # matches `delete from ...` and `select ... from ...`
-Pry::Commands.block_command InfluxDBClient::Client::QUERY_LANGUAGE_MATCHER, 'Execute a query' do |cmd|
+Pry::Commands.block_command InfluxDBClient::Client::QUERY_LANGUAGE_MATCHER, 'Execute a query' do |query|
   start     = Time.now
-  result    = db.query(cmd)
+  result    = db.query(query)
   duration  = Time.now - start
 
   InfluxDBClient::Client.print_tabularize(result)
@@ -57,6 +60,11 @@ Pry::Commands.block_command InfluxDBClient::Client::QUERY_LANGUAGE_MATCHER, 'Exe
   puts "Query duration: #{duration.round(2)}s"
 end
 
+# switch databases `use db_name`
+Pry::Commands.block_command InfluxDBClient::Client::SWITCH_DATABASE_MATCHER, 'Switch databases' do |db_name|
+  db.database = db_name
+end
+
 # awesome_print
 Pry.config.print = proc { |output, value| Pry::Helpers::BaseHelpers.stagger_output("=> #{value.ai}", output) }
 

data/lib/influxdb_client/client.rb

@@ -2,7 +2,8 @@ require 'terminal-table'
 
 module InfluxDBClient
   class Client
-    QUERY_LANGUAGE_MATCHER = /\A\s*((delete\s+from|select\s+.+\s+from)\s.+)\z/i
+    QUERY_LANGUAGE_MATCHER  = /\A\s*((delete\s+from|select\s+.+\s+from)\s.+)\z/i
+    SWITCH_DATABASE_MATCHER = /\A\s*use\s+(\S+)\s*\z/i
 
     # Prints a tabularized output from a query result.
     #
@@ -10,9 +11,15 @@ module InfluxDBClient
     # @param output [STDOUT] the output to `puts` the results
     # @return [Hash] the number of points per time series i.e. { 'response_times.count' => 10 }
     def self.print_tabularize(result, output=$stdout)
-      (result || {}).keys.each do |series|
-        result_series = result[series]
+      result ||= {}
+
+      if result.keys.empty?
+        output.puts 'No results found'
+        return
+      end
 
+      result.keys.each do |series|
+        result_series = result[series]
         if result_series.any?
           output.puts generate_table(series, result_series)
           output.puts "#{result_series.size} #{pluralize(result_series.size, 'result')} found for #{series}"

data/lib/influxdb_client/version.rb

@@ -1,3 +1,3 @@
 module InfluxDBClient
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/influxdb_client/client_spec.rb

@@ -25,6 +25,17 @@ module InfluxDBClient
       end
     end
 
+    describe '.SWITCH_DATABASE_MATCHER' do
+      subject { Client::SWITCH_DATABASE_MATCHER }
+      it { should match('use response_times') }
+      it { should match('  use   response_times  ') }
+
+      it { should_not match('use') }
+      it { should_not match(' use ') }
+      it { should_not match('use response_times tests') }
+      it { should_not match('useresponse_times') }
+    end
+
     describe '.print_tabularize' do
       let(:result)  { { series1: [{ value1: 1, value2: 2 }],
                         series2: [{ value3: 3,   value4: 4, value5: nil, value6: nil },
@@ -56,11 +67,18 @@ module InfluxDBClient
         described_class.print_tabularize(result, output)
       end
 
-      context 'when empty results' do
+      context 'when no results' do
         let(:result)  { { series1: [{ value1: 1, value2: 2 }],
                           series2: [] } }
 
-        it 'prints no results found' do
+        it 'prints generic no results found' do
+          output = double 'Output'
+          result = {}
+          expect(output).to receive(:puts).once.with('No results found')
+          described_class.print_tabularize(result, output)
+        end
+
+        it 'prints specific no results found per series' do
           output = double 'Output'
           table  = double 'Table'
           Terminal::Table.stub(new: table)
@@ -77,6 +95,15 @@ module InfluxDBClient
           described_class.print_tabularize(result, output)
         end
       end
+
+      context 'when result is null' do
+        it 'prints generic no results found' do
+          output = double 'Output'
+          result = nil
+          expect(output).to receive(:puts).once.with('No results found')
+          described_class.print_tabularize(result, output)
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Pablo Cantero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-15 00:00:00.000000000 Z
+date: 2013-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: influxdb