influxdb-cli 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ce4b04c848405e7568e3917616625f6ebdb3b44
-  data.tar.gz: 6119394e1cc3fbb8aa623ef9c771bb91c8dde217
+  metadata.gz: 5e41aad56b30e0f0407d98abd82cd260613f5d94
+  data.tar.gz: 912c971b11e4d00436a4f4f87234eacc6f205477
 SHA512:
-  metadata.gz: 7b305986de06fff53402acb46f62e2f6d12ce7f0cd1344c7de3d90cdaa9417e86017f23649968eb1ad7787424dcf3378070b57785d25beb90d2e3136e2baae64
-  data.tar.gz: 7739e71d2dfb2ad8da8a08b210f3de4ee7c97c44a2a745c64d867ec94d3bbadb63d209dff69dfd5793637ffd0003dd4b6020c3cb62019ced4840e50085cec930
+  metadata.gz: 703c39b21030ad02cc0636fe6dfe1dfa39e22c5f7586c544fa73ad7ae3c038de6d69ff236f9b49484f3fe26874e634f6624288fe74fa36dcd1195c8bc1f776be
+  data.tar.gz: c186a91062e03966dd02ffc141b8b5650bcf613f9d6cd934acd0ce0850914c334681ce672194b198aa6cb448f8a31e12b83d4cd7622bf5f3d8cfe016b68a793b

data/.rspec

@@ -1,2 +1 @@
 --color
---format d

data/README.md

@@ -13,21 +13,26 @@ gem install influxdb-cli
 ### Options
 
 ```shell
+$ influxdb-cli help db
+
 Usage:
-  influxdb-cli
+  influxdb-cli db
 
 Options:
-      [--host=HOST]          # Hostname
-                             # Default: localhost
-      [--port=PORT]          # Port
-                             # Default: 8086
-  -u, [--username=USERNAME]  # Username
-                             # Default: root
-  -p, [--password=PASSWORD]  # Password
-                             # Default: root
-  -d, [--database=DATABASE]  # Database
-                             # Default: db
-      [--pretty=PRETTY]      # Human readable times
+      [--host=HOST]                      # Hostname
+                                         # Default: localhost
+      [--port=PORT]                      # Port
+                                         # Default: 8086
+  -u, [--username=USERNAME]              # Username
+                                         # Default: root
+  -p, [--password=PASSWORD]              # Password
+                                         # Default: root
+  -d, [--database=DATABASE]              # Database
+                                         # Default: db
+      [--pretty=PRETTY]                  # Human readable times (UTC)
+      [--ssl], [--no-ssl]                # Connect using TLS/SSL
+      [--time-precision=TIME_PRECISION]  # Time precision can be set to either "s" for seconds, "ms" for milliseconds, or "u" for microseconds
+                                         # Default: s
 ```
 
 ### Usage

data/bin/influxdb-cli

@@ -16,13 +16,14 @@ class InfluxDBClientTasks < Thor
   @@db = nil
 
   desc 'db', 'Connect to InfluxDB (default command)'
-  method_option :host,      :default => 'localhost',  :desc => 'Hostname'
-  method_option :port,      :default => 8086,         :desc => 'Port'
-  method_option :username,  :default => 'root',       :desc => 'Username', :aliases => '-u'
-  method_option :password,  :default => 'root',       :desc => 'Password', :aliases => '-p'
-  method_option :database,  :default => 'db',         :desc => 'Database', :aliases => '-d'
-  method_option :pretty,    :default => nil,          :desc => 'Human readable times (UTC)'
-  method_option :ssl,       :default => false,        :desc => 'Connect using TLS/SSL', :type => :boolean
+  method_option :host,           default: 'localhost', desc: 'Hostname'
+  method_option :port,           default: 8086,        desc: 'Port'
+  method_option :username,       default: 'root',      desc: 'Username', aliases: '-u'
+  method_option :password,       default: 'root',      desc: 'Password', aliases: '-p'
+  method_option :database,       default: 'db',        desc: 'Database', aliases: '-d'
+  method_option :pretty,         default: nil,         desc: 'Human readable times (UTC)'
+  method_option :ssl,            default: false,       desc: 'Connect using TLS/SSL', type: :boolean
+  method_option :time_precision, default: 's',         desc: 'Time precision can be set to either "s" for seconds, "ms" for milliseconds, or "u" for microseconds'
 
   def db
     puts "Connecting to #{options.inspect}"
@@ -32,7 +33,8 @@ class InfluxDBClientTasks < Thor
         password: options[:password],
         host: options[:host],
         port: options[:port],
-        use_ssl: options[:ssl]
+        use_ssl: options[:ssl],
+        time_precision: options[:time_precision]
       }
     InfluxDBClient::Client.pretty = options[:pretty]
     puts '✔ ready'
@@ -58,6 +60,7 @@ 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 |query|
@@ -65,7 +68,7 @@ Pry::Commands.block_command InfluxDBClient::Client::QUERY_LANGUAGE_MATCHER, 'Exe
   result    = db.query(query)
   duration  = Time.now - start
 
-  InfluxDBClient::Client.print_tabularize(result)
+  InfluxDBClient::Client.print_tabularize(result, db.time_precision)
 
   # print query duration in seconds
   puts "Query duration: #{duration.round(2)}s"
@@ -81,4 +84,3 @@ Pry.config.print = proc { |output, value| Pry::Helpers::BaseHelpers.stagger_outp
 
 # TODO start `pry` only in case of `db` command, `help` and `version` should not start `pry`
 pry
-

data/lib/influxdb_client/client.rb

@@ -10,7 +10,7 @@ module InfluxDBClient
     # @param result [Hash] the {InfluDB::Client#query result}
     # @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)
+    def self.print_tabularize(result, time_precision, output=$stdout)
       result ||= {}
 
       if result.keys.empty?
@@ -21,8 +21,10 @@ module InfluxDBClient
       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}"
+          output.puts generate_table(series, result_series, time_precision)
+          output.puts "#{result_series.size} " \
+                      "#{pluralize(result_series.size, 'result')} " \
+                      "found for #{series}"
         else
           output.puts "No results found for #{series}"
         end
@@ -45,12 +47,18 @@ module InfluxDBClient
       end
     end
 
-    def self.generate_table(series, result_series)
+    def self.generate_table(series, result_series, time_precision)
       headings = result_series.first.keys
+      precision_factor, str_format = case time_precision.to_s
+      when 's'  then [1.0, '%F %T']
+      when 'ms' then [1_000.0, '%F %T.%3N']
+      when 'u'  then [1_000_000.0, '%F %T.%6N']
+      else raise "unknown time_precision #{time_precision}"
+      end
       rows = result_series.map do |row|
         if @pretty
-          microseconds_with_frac = "#{row['time'] / 1000}.#{row['time'] % 100}".to_f
-          row['time'] = Time.at(microseconds_with_frac).utc.strftime('%Y-%m-%d %H:%M:%S.%L')
+          seconds_with_frac = row['time'].to_f / precision_factor
+          row['time'] = Time.at(seconds_with_frac).utc.strftime(str_format)
         end
         row.values
       end
@@ -59,4 +67,3 @@ module InfluxDBClient
     end
   end
 end
-

data/lib/influxdb_client/version.rb

@@ -1,3 +1,3 @@
 module InfluxDBClient
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/spec/influxdb_client/client_spec.rb

@@ -48,27 +48,51 @@ module InfluxDBClient
         expect(Terminal::Table).to receive(:new).
           with(title: :series2, headings: %w[time value3 value4 value5 value6], rows: [[1394552447955, 3, 4, nil, nil], [1394664358980, nil, 4, 5, 6]])
 
-        described_class.print_tabularize(result)
+        described_class.print_tabularize(result, :ms)
       end
 
       context 'when pretty' do
         before(:all) { described_class.pretty = true }
         after(:all)  { described_class.pretty = false }
-        it 'generates tables' do
-          expect(Terminal::Table).to receive(:new).
-            with(title: :series1, headings: %w[time value1 value2], rows: [['2013-12-17 13:42:03.160', 1, 2]])
 
-          expect(Terminal::Table).to receive(:new).
-            with(title: :series2, headings: %w[time value3 value4 value5 value6], rows: [['2014-03-11 15:40:47.549', 3, 4, nil, nil], ['2014-03-12 22:45:58.799', nil, 4, 5, 6]])
+        context 'and time precision is seconds' do
+          let(:result)  { { series1: [{ 'time' => 1387287723, 'value1' => 1, 'value2' => 2 }] } }
+          it 'generates tables' do
+            expect(Terminal::Table).to receive(:new).
+              with(title: :series1, headings: %w[time value1 value2], rows: [['2013-12-17 13:42:03', 1, 2]])
+            
+            described_class.print_tabularize(result, :s)
+          end
+        end
+
+        context 'and time precision is milliseconds' do
+          it 'generates tables' do
+            expect(Terminal::Table).to receive(:new).
+              with(title: :series1, headings: %w[time value1 value2], rows: [['2013-12-17 13:42:03.815', 1, 2]])
+
+            expect(Terminal::Table).to receive(:new).
+              with(title: :series2, headings: %w[time value3 value4 value5 value6], rows: [['2014-03-11 15:40:47.954', 3, 4, nil, nil], ['2014-03-12 22:45:58.980', nil, 4, 5, 6]])
 
-          described_class.print_tabularize(result)
+            described_class.print_tabularize(result, :ms)
+          end
         end
+
+        context 'and time precision is microseconds' do
+          let(:result)  { { series1: [{ 'time' => 1387287723816232, 'value1' => 1, 'value2' => 2 }] } }
+          it 'generates tables' do
+            expect(Terminal::Table).to receive(:new).
+              with(title: :series1, headings: %w[time value1 value2], rows: [['2013-12-17 13:42:03.816231', 1, 2]])
+            
+            described_class.print_tabularize(result, :u)
+          end
+        end
+        
       end
 
       it 'prints results' do
         output = double 'Output'
         table  = double 'Table'
-        Terminal::Table.stub(new: table)
+        allow(Terminal::Table).to receive(:new).and_return(table)
 
         # should print series1 and series2
         expect(output).to receive(:puts).twice.with(table)
@@ -78,7 +102,7 @@ module InfluxDBClient
         # line break for series
         expect(output).to receive(:puts).twice.with(no_args)
 
-        described_class.print_tabularize(result, output)
+        described_class.print_tabularize(result, :ms, output)
       end
 
       context 'when no results' do
@@ -89,13 +113,13 @@ module InfluxDBClient
           output = double 'Output'
           result = {}
           expect(output).to receive(:puts).once.with('No results found')
-          described_class.print_tabularize(result, output)
+          described_class.print_tabularize(result, :ms, output)
         end
 
         it 'prints specific no results found per series' do
           output = double 'Output'
           table  = double 'Table'
-          Terminal::Table.stub(new: table)
+          allow(Terminal::Table).to receive(:new).and_return(table)
 
           # should print series1
           expect(output).to receive(:puts).once.with(table)
@@ -106,7 +130,7 @@ module InfluxDBClient
           # line break for series
           expect(output).to receive(:puts).twice.with(no_args)
 
-          described_class.print_tabularize(result, output)
+          described_class.print_tabularize(result, :ms, output)
         end
       end
 
@@ -115,10 +139,9 @@ module InfluxDBClient
           output = double 'Output'
           result = nil
           expect(output).to receive(:puts).once.with('No results found')
-          described_class.print_tabularize(result, output)
+          described_class.print_tabularize(result, :ms, output)
         end
       end
     end
   end
 end
-

data/spec/spec_helper.rb

@@ -7,7 +7,18 @@ Dir['../lib/**/*.rb'].each &method(:require)
 require './lib/influxdb_client'
 
 RSpec.configure do |config|
-  config.color_enabled = true
-  config.formatter = 'progress'
+  original_stderr = $stderr
+  original_stdout = $stdout
+
+  config.before(:all) do
+    # Redirect stderr and stdout
+    $stderr = File.new('/dev/null', 'w')
+    $stdout = File.new('/dev/null', 'w')
+  end
+
+  config.after(:all) do
+    $stderr = original_stderr
+    $stdout = original_stdout
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Pablo Cantero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-29 00:00:00.000000000 Z
+date: 2014-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: influxdb