influxdb 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 09adde8da537fe6ffd14bae482aa630646f5da5c
-  data.tar.gz: 856b57d58d9958bf159c1a1b8b324aae9289f4bb
-SHA512:
-  metadata.gz: e5756f9e16da70784f771e807c806fdf4ac4cf4e1e46d55132058b3c6149f8b83cfc7ad6744e0fe4df36a56ca8917d52e7c5033a8f2c46014170d3285fa107d3
-  data.tar.gz: 814e95e5e0c861a64613a2b65f9eac3229215adacee80e702587f8c010a857b5a7e66bd39448f8a782c458c40b11b375e6434cefa769e1ef656dc514fa5a5e49
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTM1OTVmZjljMTBkM2NjMjM3YTg2MTA5Yjk0MDRlZTdhNzNiODU4OQ==
+  data.tar.gz: !binary |-
+    ZDJlMGNhZDFhODg2NzEyZmFhODk5MTk4YjIxMzZjMjU3MTIwMzY0OA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YjlhYmZmMTk0MTEwYzc4MjVmNjJiN2E4MjE0OWI5YjU2ZGFlMDc0YTY3ZDBm
+    YjJkNWM3OGRiODU5NzMxMTdmYmJiMmZjZTdlOTIyNzA3OWZiZWJmMjNjZDU2
+    ZDVjYzNmOWUxOWMyNDcyZjZhMjIzMDVmZjY4MTFjNDkwZjIxM2M=
+  data.tar.gz: !binary |-
+    Njc1OTllNjhmYmQwYjM3ZGU0NjliZmRhZjJiMGZiZGExZmYzMzc0NWY0Zjcx
+    Yjc3Y2MyZjRjZDQxOGE5YmE0YmRjZWY3NzBlMmQ0NzJkMWFlZTY4M2I5NGZk
+    MDkzY2Y1OGRkYjBjNjkxYjljNmUyODUxNWMyNDhkODcxZTdhNjM=

data/README.md

@@ -76,6 +76,52 @@ loop do
 end
 ```
 
+Write data with time precision:
+
+Time precision can be set in 2 ways, either in the client initialization
+
+``` ruby
+require 'influxdb'
+
+username = 'foo'
+password = 'bar'
+database = 'site_development'
+name     = 'foobar'
+time_precision = 's'
+
+influxdb = InfluxDB::Client.new database, :username => username,
+                                          :password => password, 
+                                          :time_precision => time_precision
+
+data = {
+  :value => 0
+  :time => Time.now.to_i
+}
+
+influxdb.write_point(name, data)
+```
+or in the write call
+
+``` ruby
+require 'influxdb'
+
+username = 'foo'
+password = 'bar'
+database = 'site_development'
+name     = 'foobar'
+time_precision = 's'
+
+influxdb = InfluxDB::Client.new database, :username => username, :password => password
+
+data = {
+  :value => 0
+  :time => Time.now.to_i
+}
+
+influxdb.write_point(name, data, false, time_precision)
+```
+
+
 List cluster admins:
 
 ``` ruby

data/lib/influxdb.rb

@@ -5,3 +5,4 @@ require "influxdb/logger"
 require "influxdb/max_queue"
 require "influxdb/worker"
 require "influxdb/client"
+require "influxdb/point_value"

data/lib/influxdb/client.rb

@@ -5,7 +5,7 @@ require 'json'
 
 module InfluxDB
   class Client
-    attr_accessor :host, :port, :username, :password, :database
+    attr_accessor :host, :port, :username, :password, :database, :time_precision
     attr_accessor :queue, :worker
 
     include InfluxDB::Logger
@@ -26,7 +26,7 @@ module InfluxDB
     #
     # === Valid options in hash
     #
-    # +:hostname+:: the hostname to connect to
+    # +:host+:: the hostname to connect to
     # +:port+:: the port to connect to
     # +:username+:: the username to use when executing commands
     # +:password+:: the password associated with the username
@@ -40,11 +40,14 @@ module InfluxDB
       @password = opts[:password] || "root"
       @http = Net::HTTP.new(@host, @port)
       @http.use_ssl = opts[:use_ssl]
+      @time_precision = opts[:time_precision] || "m"
     end
 
-    def create_database(name)
+    ## allow options, e.g. influxdb.create_database('foo', replicationFactor: 3)
+    def create_database(name, options = {})
       url = full_url("db")
-      data = JSON.generate({:name => name})
+      options[:name] = name
+      data = JSON.generate(options)
       post(url, data)
     end
 
@@ -100,27 +103,27 @@ module InfluxDB
       update_database_user(database, username, :admin => admin)
     end
 
-    def write_point(name, data, async=false)
+    def write_point(name, data, async=false, time_precision=@time_precision)
       data = data.is_a?(Array) ? data : [data]
       columns = data.reduce(:merge).keys.sort {|a,b| a.to_s <=> b.to_s}
       payload = {:name => name, :points => [], :columns => columns}
 
-      data.each do |p|
-        point = []
-        columns.each { |c| point << p[c] }
-        payload[:points].push point
+      data.each do |point|
+        payload[:points] << columns.inject([]) do |array, column|
+          array << InfluxDB::PointValue.new(point[column]).dump
+        end
       end
 
       if async
         @worker = InfluxDB::Worker.new if @worker.nil?
         @worker.queue.push(payload)
       else
-        _write([payload])
+        _write([payload], time_precision)
       end
     end
 
-    def _write(payload)
-      url = full_url("db/#{@database}/series")
+    def _write(payload, time_precision=nil)
+      url = full_url("db/#{@database}/series", "time_precision=#{time_precision}")
       data = JSON.generate(payload)
 
       headers = {"Content-Type" => "application/json"}
@@ -189,7 +192,12 @@ module InfluxDB
 
     def denormalize_series series
       columns = series['columns']
-      series['points'].map { |point| Hash[columns.zip(point)]}
+      series['points'].map do |point|
+        decoded_point = point.map do |value|
+          InfluxDB::PointValue.new(value).load
+        end
+        Hash[columns.zip(decoded_point)]
+      end
     end
   end
 end

data/lib/influxdb/errors.rb

@@ -7,4 +7,7 @@ module InfluxDB
 
   class ConnectionError < Error
   end
+
+  class JSONParserError < Error
+  end
 end

data/lib/influxdb/point_value.rb

@@ -0,0 +1,49 @@
+require 'json'
+
+module InfluxDB
+
+  class PointValue
+    attr_accessor :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def dump
+      if value.is_a?(Array) || value.is_a?(Hash)
+        JSON.generate(value)
+      else
+        value
+      end
+    end
+
+    def load
+      if json?
+        begin
+          JSON.parse(value)
+        rescue JSON::ParserError => e
+          raise InfluxDB::JSONParserError, e.message
+        end
+      else
+        value
+      end
+    end
+
+    def json?
+      value =~ /(
+        # define subtypes and build up the json syntax, BNF-grammar-style
+        # The {0} is a hack to simply define them as named groups here but not match on them yet
+        # I added some atomic grouping to prevent catastrophic backtracking on invalid inputs
+        (?<number>  -?(?=[1-9]|0(?!\d))\d+(\.\d+)?([eE][+-]?\d+)?){0}
+        (?<boolean> true | false | null ){0}
+        (?<string>  " (?>[^"\\\\]* | \\\\ ["\\\\bfnrt\/] | \\\\ u [0-9a-f]{4} )* " ){0}
+        (?<array>   \[ (?> \g<json> (?: , \g<json> )* )? \s* \] ){0}
+        (?<pair>    \s* \g<string> \s* : \g<json> ){0}
+        (?<object>  \{ (?> \g<pair> (?: , \g<pair> )* )? \s* \} ){0}
+        (?<json>    \s* (?> \g<number> | \g<boolean> | \g<string> | \g<array> | \g<object> ) \s* ){0}
+        )
+      \A \g<json> \Z
+      /uix
+    end
+  end
+end

data/lib/influxdb/version.rb

@@ -1,3 +1,3 @@
 module InfluxDB
-  VERSION = "0.0.14"
+  VERSION = "0.0.15"
 end

data/spec/influxdb/client_spec.rb

@@ -4,7 +4,7 @@ require "json"
 describe InfluxDB::Client do
   before do
     @influxdb = InfluxDB::Client.new "database", :host => "influxdb.test",
-      :port => 9999, :username => "username", :password => "password"
+      :port => 9999, :username => "username", :password => "password", :time_precision => "s"
   end
 
   describe "#new" do
@@ -19,6 +19,7 @@ describe InfluxDB::Client do
         @influxdb.username.should == "root"
         @influxdb.password.should == "root"
         @influxdb.instance_variable_get(:@http).use_ssl?.should == false
+        @influxdb.time_precision.should == "m"
       end
     end
 
@@ -27,7 +28,8 @@ describe InfluxDB::Client do
         @influxdb = InfluxDB::Client.new :hostname => "host",
                                          :port => "port",
                                          :username => "username",
-                                         :password => "password"
+                                         :password => "password",
+                                         :time_precision => "s"
 
         @influxdb.should be_a InfluxDB::Client
         @influxdb.database.should be_nil
@@ -35,6 +37,7 @@ describe InfluxDB::Client do
         @influxdb.port.should == "port"
         @influxdb.username.should == "username"
         @influxdb.password.should == "password"
+        @influxdb.time_precision.should == "s"
       end
     end
 
@@ -48,6 +51,7 @@ describe InfluxDB::Client do
         @influxdb.port.should == 8086
         @influxdb.username.should == "root"
         @influxdb.password.should == "root"
+        @influxdb.time_precision.should == "m"        
       end
     end
 
@@ -56,7 +60,8 @@ describe InfluxDB::Client do
         @influxdb = InfluxDB::Client.new "database", :hostname => "host",
                                                      :port => "port",
                                                      :username => "username",
-                                                     :password => "password"
+                                                     :password => "password",
+                                                     :time_precision => "s"
 
         @influxdb.should be_a(InfluxDB::Client)
         @influxdb.database.should == "database"
@@ -64,6 +69,7 @@ describe InfluxDB::Client do
         @influxdb.port.should == "port"
         @influxdb.username.should == "username"
         @influxdb.password.should == "password"
+        @influxdb.time_precision.should == "s"
       end
     end
 
@@ -220,7 +226,7 @@ describe InfluxDB::Client do
       }]
 
       stub_request(:post, "http://influxdb.test:9999/db/database/series").with(
-        :query => {:u => "username", :p => "password"},
+        :query => {:u => "username", :p => "password", :time_precision => "s"},
         :body => body
       )
 
@@ -237,7 +243,7 @@ describe InfluxDB::Client do
       }]
 
       stub_request(:post, "http://influxdb.test:9999/db/database/series").with(
-        :query => {:u => "username", :p => "password"},
+        :query => {:u => "username", :p => "password", :time_precision => "s"},
         :body => body
       ).to_return(:status => 401)
 
@@ -254,7 +260,7 @@ describe InfluxDB::Client do
       }]
 
       stub_request(:post, "http://influxdb.test:9999/db/database/series").with(
-        :query => {:u => "username", :p => "password"},
+        :query => {:u => "username", :p => "password", :time_precision => "s"},
         :body => body
       ).to_return(:status => 200)
 
@@ -271,7 +277,7 @@ describe InfluxDB::Client do
       }]
 
       stub_request(:post, "http://influxdb.test:9999/db/database/series").with(
-        :query => {:u => "username", :p => "password"},
+        :query => {:u => "username", :p => "password", :time_precision => "s"},
         :body => body
       )
 
@@ -279,6 +285,78 @@ describe InfluxDB::Client do
 
       @influxdb.write_point("seriez", data).should be_a(Net::HTTPOK)
     end
+
+    it "should dump a hash point value to json" do
+      prefs = [{'favorite_food' => 'lasagna'}]
+      body = [{
+        "name" => "users",
+        "points" => [[1, prefs.to_json]],
+        "columns" => ["id", "prefs"]
+      }]
+
+      stub_request(:post, "http://influxdb.test:9999/db/database/series").with(
+        :query => {:u => "username", :p => "password", :time_precision => "s"},
+        :body => body
+      )
+
+      data = {:id => 1, :prefs => prefs}
+
+      @influxdb.write_point("users", data).should be_a(Net::HTTPOK)
+    end
+
+    it "should dump an array point value to json" do
+      line_items = [{'id' => 1, 'product_id' => 2, 'quantity' => 1, 'price' => "100.00"}]
+      body = [{
+        "name" => "seriez",
+        "points" => [[1, line_items.to_json]],
+        "columns" => ["id", "line_items"]
+      }]
+
+      stub_request(:post, "http://influxdb.test:9999/db/database/series").with(
+        :query => {:u => "username", :p => "password", :time_precision => "s"},
+        :body => body
+      )
+
+      data = {:id => 1, :line_items => line_items}
+
+      @influxdb.write_point("seriez", data).should be_a(Net::HTTPOK)
+    end
+
+    it "should POST to add points with time field with precision defined in client initialization" do
+      time_in_seconds = Time.now.to_i
+      body = [{
+        "name" => "seriez",
+        "points" => [[87, "juan", time_in_seconds]],
+        "columns" => ["age", "name", "time"]
+      }]
+
+      stub_request(:post, "http://influxdb.test:9999/db/database/series").with(
+        :query => {:u => "username", :p => "password", :time_precision => "s"},
+        :body => body
+      )
+
+      data = {:name => "juan", :age => 87, :time => time_in_seconds}
+
+      @influxdb.write_point("seriez", data).should be_a(Net::HTTPOK)
+    end    
+
+    it "should POST to add points with time field with precision defined in call of write function" do
+      time_in_milliseconds = (Time.now.to_f * 1000).to_i
+      body = [{
+        "name" => "seriez",
+        "points" => [[87, "juan", time_in_milliseconds]],
+        "columns" => ["age", "name", "time"]
+      }]
+
+      stub_request(:post, "http://influxdb.test:9999/db/database/series").with(
+        :query => {:u => "username", :p => "password", :time_precision => "m"},
+        :body => body
+      )
+
+      data = {:name => "juan", :age => 87, :time => time_in_milliseconds}
+
+      @influxdb.write_point("seriez", data, false, "m").should be_a(Net::HTTPOK)
+    end    
   end
 
   describe "#execute_queries" do
@@ -309,4 +387,21 @@ describe InfluxDB::Client do
       series.should ==(expected_series)
     end
   end
+
+  describe "#query" do
+
+    it 'should load JSON point value as an array of hashes' do
+      line_items = [{'id' => 1, 'product_id' => 2, 'quantity' => 1, 'price' => "100.00"}]
+
+      data = [{ :name => "orders", :columns => ["id", "line_items"], :points => [[1, line_items.to_json]]}]
+
+      stub_request(:get, "http://influxdb.test:9999/db/database/series").with(
+        :query => { :q => "select * from orders", :u => "username", :p => "password"}
+      ).to_return(
+        :body => JSON.generate(data)
+      )
+
+      @influxdb.query('select * from orders').should == {'orders' => [{'id' => 1, 'line_items' => line_items}]}
+    end
+  end
 end

data/spec/influxdb/point_value_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe InfluxDB::PointValue do
+
+  describe 'load' do
+
+    it 'should raise error if json parsing fails' do
+      val = InfluxDB::PointValue.new('{invalid_json')
+      val.should_receive(:json?).and_return(true)
+      expect { val.load }.to raise_error(InfluxDB::JSONParserError)
+    end
+  end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: influxdb
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Todd Persen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-03 00:00:00.000000000 Z
+date: 2014-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -42,42 +42,42 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: This is the official Ruby library for InfluxDB.
@@ -100,9 +100,11 @@ files:
 - lib/influxdb/errors.rb
 - lib/influxdb/logger.rb
 - lib/influxdb/max_queue.rb
+- lib/influxdb/point_value.rb
 - lib/influxdb/version.rb
 - lib/influxdb/worker.rb
 - spec/influxdb/client_spec.rb
+- spec/influxdb/point_value_spec.rb
 - spec/influxdb_spec.rb
 - spec/max_queue_spec.rb
 - spec/spec_helper.rb
@@ -116,22 +118,23 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: Ruby library for InfluxDB.
 test_files:
 - spec/influxdb/client_spec.rb
+- spec/influxdb/point_value_spec.rb
 - spec/influxdb_spec.rb
 - spec/max_queue_spec.rb
 - spec/spec_helper.rb