influxdb 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91c31bce05c5e0a514a22cef9375f6f51e1f7e3d
-  data.tar.gz: 842b0127d866fb9ed3a3cf0e7d3b878c6d1c5d01
+  metadata.gz: a1cd5af0d4500c96303b8c3c336926772eefedde
+  data.tar.gz: f5b17bce835b6973d763a0b0faad0d1a4882beb1
 SHA512:
-  metadata.gz: c3f979934171092ad2c2b3c5ff6041cd40663e55d87eaedc8473951097bb1f28d2089acf3448a8dda86e25e521f7ed606314eeb0a9399492a9427c35f39aaebf
-  data.tar.gz: 71d9c02ef46b61c64b6357e2df5886f1cc68517cbdf76da11104223535cb76dc88b73ffa671ad5a83d5afb344c99621c7b46df9d4462461364808f1f7c39810a
+  metadata.gz: a9a1e9d0df4907d754ab2fe0b7898b5852a0f9541f2a36ac12d0c2d6e0701406b88ff7d58461ead70b4c6833dd3bffc0c6048c3003911b3788ab18e9878101a1
+  data.tar.gz: 6d6703b9f341b8d1bb791a4548172d588165d537896b122c8d4fc6f902ad88b97d872fb15c1e078ddb36a3ec1341e7c9d3113b54d082659a295f5f803887d5c9

data/.travis.yml

@@ -5,7 +5,7 @@ rvm:
   - 2.0.0
   - 2.1.0
   - 2.2.0
+  - 2.3.0
   - ruby-head
   - jruby-20mode
   - jruby-21mode
-  - jruby-head

data/README.md

@@ -1,9 +1,9 @@
 influxdb-ruby
 =============
 
-[![Build Status](https://travis-ci.org/influxdb/influxdb-ruby.png?branch=master)](https://travis-ci.org/influxdb/influxdb-ruby)
+[![Build Status](https://travis-ci.org/influxdata/influxdb-ruby.svg?branch=master)](https://travis-ci.org/influxdata/influxdb-ruby)
 
-The official ruby client library for [InfluxDB](https://influxdb.com/).
+The official ruby client library for [InfluxDB](https://influxdata.com/time-series-platform/influxdb/). Maintained by [@toddboom](https://github.com/toddboom).
 
 > **Support for InfluxDB v0.8.x is now deprecated**. The final version of this library that will support the older InfluxDB interface is `v0.1.9`, which is available as a gem and tagged on this repository. If you're reading this message, then you should only expect support for InfluxDB v0.9.1 and higher.
 
@@ -292,7 +292,7 @@ Write multiple points in a batch (performance boost):
 data = [
   {
     series: 'cpu',
-    tags: { host: 'server_1', regios: 'us' },
+    tags: { host: 'server_1', region: 'us' },
     values: {internal: 5, external: 0.453345}
   },
   {
@@ -317,7 +317,7 @@ Write multiple points in a batch with a specific retention policy:
 data = [
   {
     series: 'cpu',
-    tags: { host: 'server_1', regios: 'us' },
+    tags: { host: 'server_1', region: 'us' },
     values: {internal: 5, external: 0.453345}
   },
   {
@@ -477,7 +477,7 @@ Testing
 -------
 
 ```
-git clone git@github.com:influxdb/influxdb-ruby.git
+git clone git@github.com:influxdata/influxdb-ruby.git
 cd influxdb-ruby
 bundle
 bundle exec rake

data/influxdb.gemspec

@@ -19,7 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "json"
-  spec.add_runtime_dependency "cause"
+
+  if RUBY_VERSION < '2.1'
+    spec.add_runtime_dependency "cause"
+  end
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/influxdb/client.rb

@@ -1,5 +1,6 @@
 require 'json'
-require 'cause'
+require 'cause' if RUBY_VERSION < '2.1'
+require 'thread'
 
 module InfluxDB
   # rubocop:disable Metrics/MethodLength

data/lib/influxdb/client/http.rb

@@ -37,12 +37,11 @@ module InfluxDB
     private
 
     def connect_with_retry(&block)
-      hosts = config.hosts.dup
+      host = config.next_host
       delay = config.initial_delay
       retry_count = 0
 
       begin
-        hosts.push(host = hosts.shift)
         http = Net::HTTP.new(host, config.port)
         http.open_timeout = config.open_timeout
         http.read_timeout = config.read_timeout

data/lib/influxdb/config.rb

@@ -1,10 +1,11 @@
+require 'thread'
+
 module InfluxDB
   # InfluxDB client configuration
   class Config
     AUTH_METHODS = %w(params basic_auth)
 
-    attr_accessor :hosts,
-                  :port,
+    attr_accessor :port,
                   :username,
                   :password,
                   :database,
@@ -27,7 +28,13 @@ module InfluxDB
     # rubocop:disable all
     def initialize(opts = {})
       @database = opts[:database]
-      @hosts = Array(opts[:hosts] || opts[:host] || ["localhost"])
+      @hosts_queue = Queue.new
+
+      # load the hosts into a Queue for thread safety
+      Array(opts[:hosts] || opts[:host] || ["localhost"]).each do |host|
+        @hosts_queue.push(host)
+      end
+
       @port = opts.fetch(:port, 8086)
       @prefix = opts.fetch(:prefix, '')
       @username = opts.fetch(:username, "root")
@@ -64,5 +71,19 @@ module InfluxDB
     def async?
       !!async
     end
+
+    def next_host
+      host = @hosts_queue.pop
+      @hosts_queue.push(host)
+      host
+    end
+
+    def hosts
+      Array.new(@hosts_queue.length) do
+        host = @hosts_queue.pop
+        @hosts_queue.push(host)
+        host
+      end
+    end
   end
 end

data/lib/influxdb/point_value.rb

@@ -4,9 +4,24 @@ module InfluxDB
     attr_reader :series, :values, :tags, :timestamp
 
     def initialize(data)
-      @series    = data[:series].gsub(/\s/, '\ ').gsub(',', '\,')
-      @values    = data_to_string(data[:values], true)
-      @tags      = data_to_string(data[:tags])
+      @series    = escape(data[:series], :measurement)
+
+      @values    = data[:values].map{|k, v|
+        key = escape(k.to_s, :field_key)
+        val = if v.is_a?(String)
+                '"' + escape(v, :field_value) + '"'
+              else
+                v.to_s
+              end
+        "#{key}=#{val}"
+      }.join(',') if data[:values]
+
+      @tags      = data[:tags].map{|k, v|
+        key = escape(k.to_s, :tag_key)
+        val = escape(v.to_s, :tag_value)
+        "#{key}=#{val}"
+      }.join(',') if data[:tags]
+
       @timestamp = data[:timestamp]
     end
 
@@ -20,31 +35,28 @@ module InfluxDB
 
     private
 
-    def data_to_string(data, quote_escape = false)
-      return nil unless data && !data.empty?
-      mappings = map(data, quote_escape)
-      mappings.join(',')
+    ESCAPES = {
+      measurement: [' ', ','],
+      tag_key:   ['=', ' ', ','],
+      tag_value: ['=', ' ', ','],
+      field_key: ['=', ' ', ',', '"'],
+      field_value: ['"'],
+    }
+
+    def escape(s, type)
+      ESCAPES[type].each do |ch|
+        s = s.gsub(ch){ "\\#{ch}" }
+      end
+      s
     end
 
     def map(data, quote_escape)
       data.map do |k, v|
         key = escape_key(k)
         val = v.is_a?(String) ? escape_value(v, quote_escape) : v
+        val = val.is_a?(Integer) ? "#{val}i" : v
         "#{key}=#{val}"
       end
     end
-
-    def escape_value(value, quote_escape)
-      val = value.
-        gsub(/\s/, '\ ').
-        gsub(',', '\,').
-        gsub('"', '\"')
-      val = %("#{val}") if quote_escape
-      val
-    end
-
-    def escape_key(key)
-      key.to_s.gsub(/\s/, '\ ').gsub(',', '\,')
-    end
   end
 end

data/lib/influxdb/query/core.rb

@@ -6,6 +6,11 @@ module InfluxDB
         get "/ping"
       end
 
+      def version
+        resp = get "/ping"
+        resp.header['x-influxdb-version']
+      end
+
       # rubocop:disable Metrics/MethodLength
       def query(query, opts = {})
         denormalize = opts.fetch(:denormalize, config.denormalize)
@@ -78,9 +83,9 @@ module InfluxDB
       end
 
       def fetch_series(response)
-        response.fetch('results', [])
-          .fetch(0, {})
-          .fetch('series', [])
+        response.fetch('results', []).flat_map{|result|
+          result.fetch('series', [])
+        }
       end
 
       def generate_payload(data)

data/lib/influxdb/version.rb

@@ -1,3 +1,3 @@
 module InfluxDB # :nodoc:
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/spec/influxdb/cases/querying_spec.rb

@@ -179,4 +179,105 @@ describe InfluxDB::Client do
       end
     end
   end
+
+  describe "multiple select queries" do
+    context "with single series with multiple points" do
+      let(:response) do
+        { "results" => [{ "series" => [{ "name" => "cpu", "tags" => { "region" => "us" },
+                                         "columns" => %w(time temp value),
+                                         "values" => [["2015-07-07T14:58:37Z", 92, 0.3445], ["2015-07-07T14:59:09Z", 68, 0.8787]] }] },
+                        { "series" => [{ "name" => "memory", "tags" => { "region" => "us" },
+                                         "columns" => %w(time free total),
+                                         "values" => [["2015-07-07T14:58:37Z", 96468992, 134217728], ["2015-07-07T14:59:09Z", 71303168, 134217728]] }] }] }
+      end
+      let(:expected_result) do
+        [{ "name" => "cpu", "tags" => { "region" => "us" },
+           "values" => [{ "time" => "2015-07-07T14:58:37Z", "temp" => 92, "value" => 0.3445 },
+                        { "time" => "2015-07-07T14:59:09Z", "temp" => 68, "value" => 0.8787 }] },
+         { "name" => "memory", "tags" => { "region" => "us" },
+           "values" => [{ "time" => "2015-07-07T14:58:37Z", "free" => 92*2**20, "total" => 128*2**20 },
+                        { "time" => "2015-07-07T14:59:09Z", "free" => 68*2**20, "total" => 128*2**20 }] }]
+      end
+      let(:query) { 'SELECT * FROM cpu; SELECT * FROM memory' }
+
+      before do
+        stub_request(:get, "http://influxdb.test:9999/query").with(
+          query: { q: query, u: "username", p: "password", precision: 's', db: database }
+        ).to_return(body: JSON.generate(response))
+      end
+
+      it "should return array with single hash containing multiple values" do
+        expect(subject.query(query)).to eq(expected_result)
+      end
+    end
+
+    context "with series with different tags" do
+      let(:response) do
+        { "results" =>           [{ "series" =>             [{ "name" => "cpu", "tags" => { "region" => "pl" }, "columns" => %w(time temp value), "values" => [["2015-07-07T15:13:04Z", 34, 0.343443]] },
+                                                             { "name" => "cpu", "tags" => { "region" => "us" }, "columns" => %w(time temp value), "values" => [["2015-07-07T14:58:37Z", 92, 0.3445], ["2015-07-07T14:59:09Z", 68, 0.8787]] }] },
+                                  { "series" =>             [{ "name" => "memory", "tags" => { "region" => "pl" }, "columns" => %w(time free total), "values" => [["2015-07-07T15:13:04Z", 35651584, 134217728]] },
+                                                             { "name" => "memory", "tags" => { "region" => "us" }, "columns" => %w(time free total), "values" => [["2015-07-07T14:58:37Z", 96468992, 134217728], ["2015-07-07T14:59:09Z", 71303168, 134217728]] }] }] }
+      end
+      let(:expected_result) do
+        [{ "name" => "cpu", "tags" => { "region" => "pl" },
+           "values" => [{ "time" => "2015-07-07T15:13:04Z", "temp" => 34, "value" => 0.343443 }] },
+         { "name" => "cpu", "tags" => { "region" => "us" },
+           "values" => [{ "time" => "2015-07-07T14:58:37Z", "temp" => 92, "value" => 0.3445 },
+                        { "time" => "2015-07-07T14:59:09Z", "temp" => 68, "value" => 0.8787 }] },
+         { "name" => "memory", "tags" => { "region" => "pl" },
+           "values" => [{ "time" => "2015-07-07T15:13:04Z", "free" => 34*2**20, "total" => 128*2**20 }] },
+         { "name" => "memory", "tags" => { "region" => "us" },
+           "values" => [{ "time" => "2015-07-07T14:58:37Z", "free" => 92*2**20, "total" => 128*2**20 },
+                        { "time" => "2015-07-07T14:59:09Z", "free" => 68*2**20, "total" => 128*2**20 }] }]
+      end
+      let(:query) { 'SELECT * FROM cpu; SELECT * FROM memory' }
+
+      before do
+        stub_request(:get, "http://influxdb.test:9999/query").with(
+          query: { q: query, u: "username", p: "password", precision: 's', db: database }
+        ).to_return(body: JSON.generate(response))
+      end
+
+      it "should return array with 2 elements grouped by tags" do
+        expect(subject.query(query)).to eq(expected_result)
+      end
+    end
+
+    context "with a block" do
+      let(:response) do
+        { "results" =>           [{ "series" =>             [{ "name" => "cpu", "tags" => { "region" => "pl" }, "columns" => %w(time temp value), "values" => [["2015-07-07T15:13:04Z", 34, 0.343443]] },
+                                                             { "name" => "cpu", "tags" => { "region" => "us" }, "columns" => %w(time temp value), "values" => [["2015-07-07T14:58:37Z", 92, 0.3445], ["2015-07-07T14:59:09Z", 68, 0.8787]] }] },
+                                  { "series" =>             [{ "name" => "memory", "tags" => { "region" => "pl" }, "columns" => %w(time free total), "values" => [["2015-07-07T15:13:04Z", 35651584, 134217728]] },
+                                                             { "name" => "memory", "tags" => { "region" => "us" }, "columns" => %w(time free total), "values" => [["2015-07-07T14:58:37Z", 96468992, 134217728], ["2015-07-07T14:59:09Z", 71303168, 134217728]] }] }] }
+      end
+
+      let(:expected_result) do
+        [{ "name" => "cpu", "tags" => { "region" => "pl" },
+           "values" => [{ "time" => "2015-07-07T15:13:04Z", "temp" => 34, "value" => 0.343443 }] },
+         { "name" => "cpu", "tags" => { "region" => "us" },
+           "values" => [{ "time" => "2015-07-07T14:58:37Z", "temp" => 92, "value" => 0.3445 },
+                        { "time" => "2015-07-07T14:59:09Z", "temp" => 68, "value" => 0.8787 }] },
+         { "name" => "memory", "tags" => { "region" => "pl" },
+           "values" => [{ "time" => "2015-07-07T15:13:04Z", "free" => 34*2**20, "total" => 128*2**20 }] },
+         { "name" => "memory", "tags" => { "region" => "us" },
+           "values" => [{ "time" => "2015-07-07T14:58:37Z", "free" => 92*2**20, "total" => 128*2**20 },
+                        { "time" => "2015-07-07T14:59:09Z", "free" => 68*2**20, "total" => 128*2**20 }] }]
+      end
+      let(:query) { 'SELECT * FROM cpu; SELECT * FROM memory' }
+
+      before do
+        stub_request(:get, "http://influxdb.test:9999/query").with(
+          query: { q: query, u: "username", p: "password", precision: 's', db: database }
+        ).to_return(body: JSON.generate(response))
+      end
+
+      it "should accept a block and yield name, tags and points" do
+        results = []
+        subject.query(query) do |name, tags, points|
+          results << { 'name' => name, 'tags' => tags, 'values' => points }
+        end
+        expect(results).to eq(expected_result)
+      end
+    end
+  end
 end

data/spec/influxdb/client_spec.rb

@@ -63,4 +63,33 @@ describe InfluxDB::Client do
       expect(subject.ping).to be_a(Net::HTTPNoContent)
     end
   end
+
+  describe "GET #version" do
+    it "returns 1.1.1" do
+      stub_request(:get, "http://influxdb.test:9999/ping").to_return(
+        { :status => 204, :headers => {'x-influxdb-version' => '1.1.1'} })
+
+      expect(subject.version).to eq('1.1.1')
+    end
+  end
+
+  describe "Load balancing" do
+    let(:args) { { hosts: hosts } }
+    let(:hosts) do
+      [
+        "influxdb.test0",
+        "influxdb.test1",
+        "influxdb.test2"
+      ]
+    end
+    let(:cycle) { 3 }
+    let!(:stubs) do
+      hosts.map { |host| stub_request(:get, "http://#{host}:9999/ping").to_return(status: 204) }
+    end
+
+    it "balance requests" do
+      (hosts.size * cycle).times { subject.ping }
+      stubs.cycle(cycle) { |stub| expect(stub).to have_been_requested.times(cycle) }
+    end
+  end
 end

data/spec/influxdb/point_value_spec.rb

@@ -1,43 +1,20 @@
 require "spec_helper"
 
 describe InfluxDB::PointValue do
-  describe "whitespace escaping" do
-    it 'should escape series name' do
-      point = InfluxDB::PointValue.new(series: "Some Long String", values: { value: 5 })
-      expect(point.series).to eq("Some\\ Long\\ String")
-    end
-
-    it 'should escape keys of passed value keys' do
-      point = InfluxDB::PointValue.new(series: "responses",
-                                       values: { 'some string key' => 5 })
-      expect(point.values.split("=").first).to eq("some\\ string\\ key")
-    end
-
-    it 'should escape passed values' do
-      point = InfluxDB::PointValue.new(series: "responses",
-                                       values: { response_time: 0.34343 },
-                                       tags: { city: "Twin Peaks" })
-      expect(point.tags.split("=").last).to eq("Twin\\ Peaks")
-    end
-  end
-
-  describe "comma escaping" do
-    it 'should escape series name' do
-      point = InfluxDB::PointValue.new(series: "Some Long String,", values: { value: 5 })
-      expect(point.series).to eq("Some\\ Long\\ String\\,")
-    end
-
-    it 'should escape keys of passed value keys' do
-      point = InfluxDB::PointValue.new(series: "responses",
-                                       values: { 'some string key,' => 5 })
-      expect(point.values.split("=").first).to eq("some\\ string\\ key\\,")
-    end
-
-    it 'should escape passed values' do
-      point = InfluxDB::PointValue.new(series: "responses",
-                                       values: { response_time: 0.34343 },
-                                       tags: { city: "Twin Peaks," })
-      expect(point.tags.split("=").last).to eq("Twin\\ Peaks\\,")
+  describe "escaping" do
+    let(:data) do
+      {
+        series: '1= ,"\\1',
+        tags: {'2= ,"\\2' => '3= ,"\\3'},
+        values: {'4= ,"\\4' => '5= ,"\\5'},
+      }
+    end
+
+    it 'should escape correctly' do
+      point = InfluxDB::PointValue.new(data)
+      expected = %(1=\\ \\,"\\1,2\\=\\ \\,"\\2=3\\=\\ \\,"\\3 )+
+                 %(4\\=\\ \\,\\"\\4="5= ,\\"\\5")
+      expect(point.dump).to eq(expected)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Todd Persen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: cause
-  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
   name: bundler
   requirement: !ruby/object:Gem::Requirement