influxdb-client 1.0.0.beta

data/lib/influxdb2/client/version.rb

@@ -0,0 +1,23 @@
+# The MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module InfluxDB2
+  VERSION = '1.0.0.beta'.freeze
+end

data/lib/influxdb2/client/write_api.rb

@@ -0,0 +1,154 @@
+# The MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module InfluxDB2
+  # Precision constants.
+  #
+  class WritePrecision
+    SECOND = 's'.freeze
+    MILLISECOND = 'ms'.freeze
+    MICROSECOND = 'us'.freeze
+    NANOSECOND = 'ns'.freeze
+
+    def get_from_value(value)
+      constants = WritePrecision.constants.select { |c| WritePrecision.const_get(c) == value }
+      raise "The time precision #{value} is not supported." if constants.empty?
+
+      value
+    end
+  end
+
+  # Write time series data into InfluxDB.
+  #
+  class WriteApi
+    DEFAULT_TIMEOUT = 10
+    DEFAULT_REDIRECT_COUNT = 10
+
+    # @param [Hash] options The options to be used by the client.
+    def initialize(options:)
+      @options = options
+      @max_redirect_count = @options[:max_redirect_count] || DEFAULT_REDIRECT_COUNT
+    end
+
+    # Write data into specified Bucket.
+    #
+    # @example write(data:
+    #   [
+    #     {
+    #       name: 'cpu',
+    #       tags: { host: 'server_nl', region: 'us' },
+    #       fields: {internal: 5, external: 6},
+    #       time: 1422568543702900257
+    #     },
+    #     {name: 'gpu', fields: {value: 0.9999}}
+    #   ],
+    #   precision: InfluxDB::WritePrecision::NANOSECOND,
+    #   bucket: 'my-bucket',
+    #   org: 'my-org'
+    # )
+    #
+    # @example write(data: 'h2o,location=west value=33i 15')
+    #
+    # @example point = InfluxDB::Point.new(name: 'h2o')
+    #   .add_tag('location', 'europe')
+    #   .add_field('level', 2)
+    #
+    # hash = { name: 'h2o', tags: { host: 'aws', region: 'us' }, fields: { level: 5, saturation: '99%' }, time: 123 }
+    #
+    # write(data: ['h2o,location=west value=33i 15', point, hash])
+    #
+    # @param [Object] data DataPoints to write into InfluxDB. The data could be represent by [Hash], [Point], [String]
+    #   or by collection of these types
+    # @param [WritePrecision] precision The precision for the unix timestamps within the body line-protocol
+    # @param [String] bucket specifies the destination bucket for writes
+    # @param [String] org specifies the destination organization for writes
+    def write(data:, precision: nil, bucket: nil, org: nil)
+      precision_param = precision || @options[:precision]
+      bucket_param = bucket || @options[:bucket]
+      org_param = org || @options[:org]
+      _check('precision', precision_param)
+      _check('bucket', bucket_param)
+      _check('org', org_param)
+
+      payload = _generate_payload(data)
+      return nil if payload.nil?
+
+      uri = URI.parse(File.join(@options[:url], '/api/v2/write'))
+      uri.query = URI.encode_www_form(bucket: bucket_param, org: org_param, precision: precision_param.to_s)
+
+      _post(payload, uri)
+    end
+
+    private
+
+    def _post(payload, uri, limit = @max_redirect_count)
+      raise InfluxError.from_message("Too many HTTP redirects. Exceeded limit: #{@max_redirect_count}") if limit.zero?
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.open_timeout = @options[:open_timeout] || DEFAULT_TIMEOUT
+      http.write_timeout = @options[:write_timeout] || DEFAULT_TIMEOUT if Net::HTTP.method_defined? :write_timeout
+      http.read_timeout = @options[:read_timeout] || DEFAULT_TIMEOUT
+      http.use_ssl = @options[:use_ssl].nil? ? true : @options[:use_ssl]
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request['Authorization'] = "Token #{@options[:token]}"
+      request.body = payload
+
+      begin
+        response = http.request(request)
+        case response
+        when Net::HTTPSuccess then
+          response
+        when Net::HTTPRedirection then
+          location = response['location']
+          _post(payload, URI.parse(location), limit - 1)
+        else
+          raise InfluxError.from_response(response)
+        end
+      ensure
+        http.finish if http.started?
+      end
+    end
+
+    def _check(key, value)
+      raise ArgumentError, "The '#{key}' should be defined as argument or default option: #{@options}" if value.nil?
+    end
+
+    def _generate_payload(data)
+      if data.nil?
+        nil
+      elsif data.is_a?(Point)
+        data.to_line_protocol
+      elsif data.is_a?(String)
+        if data.empty?
+          nil
+        else
+          data
+        end
+      elsif data.is_a?(Hash)
+        _generate_payload(Point.from_hash(data))
+      elsif data.respond_to? :map
+        data.map do |item|
+          _generate_payload(item)
+        end.reject(&:nil?).join("\n".freeze)
+      end
+    end
+  end
+end

data/test/influxdb/client_test.rb

@@ -0,0 +1,70 @@
+# The MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'test_helper'
+
+class ClientTest < Minitest::Test
+  def test_defined_version_number
+    refute_nil ::InfluxDB2::VERSION
+  end
+
+  def test_client_new
+    refute_nil InfluxDB2::Client.new('http://localhost:9999', 'my-token')
+  end
+
+  def test_client_hash
+    client1 = InfluxDB2::Client.new('http://localhost:9999', 'my-token')
+    client2 = InfluxDB2::Client.new('http://localhost:9999', 'my-token-diff')
+
+    refute_equal client1.hash, client2.hash
+    assert_equal client1.hash, client1.hash
+  end
+
+  def test_client_eq
+    client1 = InfluxDB2::Client.new('http://localhost:9999', 'my-token')
+    client2 = InfluxDB2::Client.new('http://localhost:9999', 'my-token-diff')
+
+    refute_equal client1, client2
+    assert_equal client1, client1
+  end
+
+  def test_client_options
+    client = InfluxDB2::Client.new('http://localhost:9999', 'my-token')
+
+    assert_equal 'http://localhost:9999', client.options[:url]
+    assert_equal 'my-token', client.options[:token]
+  end
+
+  def test_close
+    client = InfluxDB2::Client.new('http://localhost:9999', 'my-token')
+
+    assert_equal true, client.close!
+    assert_equal true, client.close!
+  end
+
+  def test_get_write_api
+    client = InfluxDB2::Client.new('http://localhost:9999', 'my-token')
+
+    write_api = client.create_write_api
+
+    refute_nil write_api
+    assert_instance_of InfluxDB2::WriteApi, write_api
+  end
+end

data/test/influxdb/point_test.rb

@@ -0,0 +1,221 @@
+# The MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'test_helper'
+
+class PointTest < MiniTest::Test
+  def test_to_line_protocol
+    point_args = InfluxDB2::Point.new(name: 'h2o',
+                                      tags: { host: 'aws', region: 'us' },
+                                      fields: { level: 5, saturation: '99%' }, time: 123)
+    assert_equal 'h2o,host=aws,region=us level=5i,saturation="99%" 123', point_args.to_line_protocol
+
+    point_hash = InfluxDB2::Point.from_hash(name: 'h2o',
+                                            tags: { host: 'aws', region: 'us' },
+                                            fields: { level: 5, saturation: '99%' }, time: 123)
+    assert_equal 'h2o,host=aws,region=us level=5i,saturation="99%" 123', point_hash.to_line_protocol
+  end
+
+  def test_measurement_escape
+    point = InfluxDB2::Point.new(name: 'h2 o', tags: { location: 'europe' }, fields: { level: 2 })
+    assert_equal 'h2\\ o,location=europe level=2i', point.to_line_protocol
+
+    point = InfluxDB2::Point.new(name: 'h2,o', tags: { location: 'europe' }, fields: { level: 2 })
+    assert_equal 'h2\\,o,location=europe level=2i', point.to_line_protocol
+  end
+
+  def test_tag_empty_key
+    point = InfluxDB2::Point.new(name: 'h2o', fields: { level: 2 }).add_tag('location', 'europe').add_tag('', 'warn')
+
+    assert_equal 'h2o,location=europe level=2i', point.to_line_protocol
+  end
+
+  def test_tag_empty_value
+    point = InfluxDB2::Point.new(name: 'h2o', fields: { level: 2 }).add_tag('location', 'europe').add_tag('log', '')
+
+    assert_equal 'h2o,location=europe level=2i', point.to_line_protocol
+  end
+
+  def test_override_tag_and_field
+    point = InfluxDB2::Point.new(name: 'h2o', fields: { level: '1' })
+                            .add_tag('location', 'europe')
+                            .add_tag('location', 'europe2')
+                            .add_field(:level, 2)
+                            .add_field(:level, 3)
+
+    assert_equal 'h2o,location=europe2 level=3i', point.to_line_protocol
+  end
+
+  def test_field_types
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('tag_b', 'b')
+                            .add_tag('tag_a', 'a')
+                            .add_field('n1', -2)
+                            .add_field('n2', 10)
+                            .add_field('n3', 1_265_437_718_438_866_624_512)
+                            .add_field('n4', 5.5)
+                            .add_field('bool', true)
+                            .add_field('string', 'string value')
+
+    expected = 'h2o,tag_a=a,tag_b=b bool=true,n1=-2i,n2=10i,n3=1265437718438866624512i,n4=5.5,string="string value"'
+    assert_equal expected, point.to_line_protocol
+  end
+
+  def test_field_null_value
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .add_field('warning', nil)
+
+    assert_equal 'h2o,location=europe level=2i', point.to_line_protocol
+  end
+
+  def test_field_escape
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 'string esc\\ape value')
+
+    assert_equal 'h2o,location=europe level="string esc\\\\ape value"', point.to_line_protocol
+
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 'string esc"ape value')
+
+    assert_equal 'h2o,location=europe level="string esc\"ape value"', point.to_line_protocol
+  end
+
+  def test_time
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .time(123, InfluxDB2::WritePrecision::NANOSECOND)
+
+    assert_equal 'h2o,location=europe level=2i 123', point.to_line_protocol
+  end
+
+  def test_time_formatting
+    time = Time.utc(2015, 10, 15, 8, 20, 15)
+
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .time(time, InfluxDB2::WritePrecision::MILLISECOND)
+
+    assert_equal 'h2o,location=europe level=2i 1444897215000', point.to_line_protocol
+
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .time(time, InfluxDB2::WritePrecision::SECOND)
+
+    assert_equal 'h2o,location=europe level=2i 1444897215', point.to_line_protocol
+
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .time(time, InfluxDB2::WritePrecision::MICROSECOND)
+
+    assert_equal 'h2o,location=europe level=2i 1444897215000000', point.to_line_protocol
+
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .time(time, InfluxDB2::WritePrecision::NANOSECOND)
+
+    assert_equal 'h2o,location=europe level=2i 1444897215000000000', point.to_line_protocol
+  end
+
+  def test_time_formatting_default
+    time = Time.utc(2015, 10, 15, 8, 20, 15)
+
+    point = InfluxDB2::Point.new(name: 'h2o', time: time)
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+
+    assert_equal 'h2o,location=europe level=2i 1444897215000000000', point.to_line_protocol
+
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('level', 2)
+                            .time(time, nil)
+
+    assert_equal 'h2o,location=europe level=2i 1444897215000000000', point.to_line_protocol
+  end
+
+  def test_time_string
+    point_args = InfluxDB2::Point.new(name: 'h2o',
+                                      tags: { host: 'aws', region: 'us' },
+                                      fields: { level: 5 }, time: '123')
+
+    assert_equal 'h2o,host=aws,region=us level=5i 123', point_args.to_line_protocol
+  end
+
+  def test_time_float
+    point_args = InfluxDB2::Point.new(name: 'h2o',
+                                      tags: { host: 'aws', region: 'us' },
+                                      fields: { level: 5 }, time: 1.444897215e+18)
+
+    assert_equal 'h2o,host=aws,region=us level=5i 1444897215000000000', point_args.to_line_protocol
+
+    point_args = InfluxDB2::Point.new(name: 'h2o',
+                                      tags: { host: 'aws', region: 'us' },
+                                      fields: { level: 5 }, time: 102_030_405_060)
+
+    assert_equal 'h2o,host=aws,region=us level=5i 102030405060', point_args.to_line_protocol
+  end
+
+  def test_utf_8
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'Přerov')
+                            .add_field('level', 2)
+                            .time(123, InfluxDB2::WritePrecision::NANOSECOND)
+
+    assert_equal 'h2o,location=Přerov level=2i 123', point.to_line_protocol
+  end
+
+  def test_infinity_values
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('infinity_constant', Float::INFINITY)
+                            .add_field('infinity_positive', 1 / 0.0)
+                            .add_field('infinity_negative', -1 / 0.0)
+                            .add_field('level', 2)
+
+    assert_equal 'h2o,location=europe level=2i', point.to_line_protocol
+  end
+
+  def test_only_infinity_values
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_tag('location', 'europe')
+                            .add_field('infinity_constant', Float::INFINITY)
+                            .add_field('infinity_positive', 1 / 0.0)
+                            .add_field('infinity_negative', -1 / 0.0)
+
+    assert_nil point.to_line_protocol
+  end
+
+  def test_without_tags
+    point = InfluxDB2::Point.new(name: 'h2o')
+                            .add_field('level', 2)
+                            .time(123, InfluxDB2::WritePrecision::NANOSECOND)
+
+    assert_equal 'h2o level=2i 123', point.to_line_protocol
+  end
+end