influxdb-client 1.0.0.beta

data/Rakefile

@@ -0,0 +1,37 @@
+# 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 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test
+
+# Rubocop
+desc 'Run Rubocop lint checks'
+task :rubocop do
+  RuboCop::RakeTask.new
+end

data/bin/influxdb-onboarding.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+#
+# 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.
+#
+
+set -e
+
+echo "Wait to start InfluxDB 2.0"
+wget -S --spider --tries=20 --retry-connrefused --waitretry=5 http://localhost:9999/metrics
+
+echo
+echo "Post onBoarding request, to setup initial user (my-user@my-password), org (my-org) and bucketSetup (my-bucket)"
+echo
+curl -i -X POST http://localhost:9999/api/v2/setup -H 'accept: application/json' \
+    -d '{
+            "username": "my-user",
+            "password": "my-password",
+            "org": "my-org",
+            "bucket": "my-bucket",
+            "token": "my-token"
+        }'

data/bin/influxdb-restart.sh

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+#
+# 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.
+#
+
+set -e
+
+DEFAULT_DOCKER_REGISTRY="quay.io/influxdb/"
+DOCKER_REGISTRY="${DOCKER_REGISTRY:-$DEFAULT_DOCKER_REGISTRY}"
+
+DEFAULT_INFLUXDB_V2_REPOSITORY="influxdb"
+DEFAULT_INFLUXDB_V2_VERSION="2.0.0-beta"
+INFLUXDB_V2_REPOSITORY="${INFLUXDB_V2_REPOSITORY:-$DEFAULT_INFLUXDB_V2_REPOSITORY}"
+INFLUXDB_V2_VERSION="${INFLUXDB_V2_VERSION:-$DEFAULT_INFLUXDB_V2_VERSION}"
+INFLUXDB_V2_IMAGE=${DOCKER_REGISTRY}${INFLUXDB_V2_REPOSITORY}:${INFLUXDB_V2_VERSION}
+
+SCRIPT_PATH="$( cd "$(dirname "$0")" ; pwd -P )"
+
+docker kill influxdb_v2 || true
+docker rm influxdb_v2 || true
+docker network rm influx_network || true
+docker network create -d bridge influx_network --subnet 192.168.0.0/24 --gateway 192.168.0.1
+
+#
+# InfluxDB 2.0
+#
+echo
+echo "Restarting InfluxDB 2.0 [${INFLUXDB_V2_IMAGE}] ... "
+echo
+
+docker pull "${INFLUXDB_V2_IMAGE}" || true
+docker run \
+       --detach \
+       --name influxdb_v2 \
+       --network influx_network \
+       --publish 9999:9999 \
+       "${INFLUXDB_V2_IMAGE}"
+
+#
+# Post onBoarding request to InfluxDB 2
+#
+"${SCRIPT_PATH}"/influxdb-onboarding.sh

data/influxdb-client.gemspec

@@ -0,0 +1,53 @@
+# 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.
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'influxdb2/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'influxdb-client'
+  spec.version       = ENV['CIRCLE_BUILD_NUM'] ? "#{InfluxDB2::VERSION}-#{ENV['CIRCLE_BUILD_NUM']}" : InfluxDB2::VERSION
+  spec.authors       = ['Jakub Bednar']
+  spec.email         = ['jakub.bednar@gmail.com']
+
+  spec.summary       = 'Ruby library for InfluxDB 2.'
+  spec.description   = 'This is the official Ruby library for InfluxDB 2.'
+  spec.homepage      = 'https://github.com/influxdata/influxdb-client-ruby'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/influxdata/influxdb-client-ruby'
+  spec.metadata['changelog_uri'] = 'https://raw.githubusercontent.com/influxdata/influxdb-client-ruby/master/CHANGELOG.md'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features|smoke)/})
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'codecov', '~> 0.1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-reporters', '~> 1.4'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.66.0'
+  spec.add_development_dependency 'simplecov', '~> 0.17.1'
+  spec.add_development_dependency 'webmock', '~> 3.7'
+end

data/lib/influxdb2/client.rb

@@ -0,0 +1,25 @@
+# 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 'influxdb2/client/version'
+require 'influxdb2/client/client'
+require 'influxdb2/client/influx_error'
+require 'influxdb2/client/write_api'
+require 'influxdb2/client/point'

data/lib/influxdb2/client/client.rb

@@ -0,0 +1,71 @@
+# 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 'net/http'
+
+module InfluxDB2
+  # The client is the entry point to HTTP API defined
+  # in https://github.com/influxdata/influxdb/blob/master/http/swagger.yml.
+  class Client
+    # @return [ Hash ] options The configuration options.
+    attr_reader :options
+
+    # Instantiate a new InfluxDB client.
+    #
+    # @example Instantiate a client.
+    #   InfluxDBClient::Client.new(url: 'https://localhost:9999', token: 'my-token')
+    #
+    # @param [Hash] options The options to be used by the client.
+    # @param [String] url InfluxDB URL to connect to (ex. https://localhost:9999).
+    # @param [String] token Access Token used for authenticating/authorizing the InfluxDB request sent by client.
+    #
+    # @option options [String] :bucket the default destination bucket for writes
+    # @option options [String] :org the default organization bucket for writes
+    # @option options [WritePrecision] :precision the default precision for the unix timestamps within
+    # @option options [Integer] :open_timeout Number of seconds to wait for the connection to open
+    # @option options [Integer] :write_timeout Number of seconds to wait for one block of data to be written
+    # @option options [Integer] :read_timeout Number of seconds to wait for one block of data to be read
+    # @option options [Integer] :max_redirect_count Maximal number of followed HTTP redirects
+    # @option options [bool] :use_ssl Turn on/off SSL for HTTP communication
+    #   the body line-protocol
+    def initialize(url, token, options = nil)
+      @options = options ? options.dup : {}
+      @options[:url] = url if url.is_a? String
+      @options[:token] = token if token.is_a? String
+      @closed = false
+
+      at_exit { close! }
+    end
+
+    # Write time series data into InfluxDB thought WriteApi.
+    #
+    # @return [WriteApi] New instance of WriteApi.
+    def create_write_api
+      WriteApi.new(options: @options)
+    end
+
+    # Close all connections into InfluxDB 2.
+    #
+    # @return [ true ] Always true.
+    def close!
+      @closed = true
+      true
+    end
+  end
+end

data/lib/influxdb2/client/influx_error.rb

@@ -0,0 +1,27 @@
+module InfluxDB2
+  # InfluxError that is raised during HTTP communication.
+  class InfluxError < StandardError
+    # HTTP status code
+    attr_reader :code
+    # Reference code unique to the error type
+    attr_reader :reference
+
+    def initialize(message:, code:, reference:)
+      super(message)
+
+      @code = code
+      @reference = reference
+    end
+
+    def self.from_response(response)
+      json = JSON.parse(response.body)
+      obj = new(message: json['message'] || '', code: response.code, reference: json['code'] || '')
+      obj
+    end
+
+    def self.from_message(message)
+      obj = new(message: message, code: '', reference: '')
+      obj
+    end
+  end
+end

data/lib/influxdb2/client/point.rb

@@ -0,0 +1,214 @@
+# 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
+  DEFAULT_WRITE_PRECISION = WritePrecision::NANOSECOND
+  ESCAPE_KEY_LIST = ['\\'.freeze, ','.freeze, ' '.freeze, '='.freeze].freeze
+  ESCAPE_VALUE_LIST = ['\\'.freeze, '"'.freeze].freeze
+
+  # Point defines the values that will be written to the database.
+  # Ref: http://bit.ly/influxdata-point
+  class Point
+    # Create DataPoint instance for specified measurement name.
+    #
+    # @example InfluxDB::Point.new(name: "h2o",
+    #   tags: {host: 'aws', region: 'us'},
+    #   fields: {level: 5, saturation: "99%"},
+    #   time: 123)
+    #
+    # @param [String] name the measurement name for the point.
+    # @param [Hash] tags the tag set for the point
+    # @param [Hash] fields the fields for the point
+    # @param [Integer] time the timestamp for the point
+    # @param [WritePrecision] precision the precision for the unix timestamps within the body line-protocol
+    def initialize(name:, tags: nil, fields: nil, time: nil, precision: DEFAULT_WRITE_PRECISION)
+      @name = name
+      @tags = tags || {}
+      @fields = fields || {}
+      @time = time
+      @precision = precision
+    end
+
+    # Create DataPoint instance from specified data.
+    #
+    # @example Point.fromHash({
+    #   name: 'cpu',
+    #   tags: { host: 'server_nl', regios: 'us' },
+    #   fields: {internal: 5, external: 6},
+    #   time: 1422568543702900257
+    # })
+    #
+    # @param [Hash] data
+    def self.from_hash(data)
+      obj = new(name: data[:name], tags: data[:tags], fields: data[:fields], time: data[:time])
+      obj
+    end
+
+    # Adds or replaces a tag value for a point.
+    #
+    # @example InfluxDB::Point.new(name: "h2o")
+    #   .add_tag("location", "europe")
+    #   .add_field("level", 2)
+    #
+    # @param [Object] key the tag name
+    # @param [Object] value the tag value
+    def add_tag(key, value)
+      @tags[key] = value
+      self
+    end
+
+    # Adds or replaces a field value for a point.
+    #
+    # @example InfluxDB::Point.new(name: "h2o")
+    #   .add_tag("location", "europe")
+    #   .add_field("level", 2)
+    #
+    # @param [Object] key the field name
+    # @param [Object] value the field value
+    def add_field(key, value)
+      @fields[key] = value
+      self
+    end
+
+    # Updates the timestamp for the point.
+    #
+    # @example InfluxDB::Point.new(name: "h2o")
+    #   .add_tag("location", "europe")
+    #   .add_field("level", 2)
+    #   .time(Time.new(2015, 10, 15, 8, 20, 15), InfluxDB::WritePrecision::MILLISECOND)
+    #
+    # @example InfluxDB::Point.new(name: "h2o")
+    #   .add_tag("location", "europe")
+    #   .add_field("level", 2)
+    #   .time(123, InfluxDB::WritePrecision::NANOSECOND)
+    #
+    # @param [Object] time the timestamp
+    # @param [WritePrecision] precision the timestamp precision
+    def time(time, precision)
+      @time = time
+      @precision = precision
+      self
+    end
+
+    # If there is no field then return nil.
+    #
+    # @return a string representation of the point
+    def to_line_protocol
+      line_protocol = ''
+      measurement = _escape_key(@name || '')
+
+      line_protocol << measurement
+
+      tags = _escape_tags
+      line_protocol << ",#{tags}" unless tags.empty?
+      line_protocol << ' '.freeze if line_protocol[-1] == '\\'
+
+      fields = _escape_fields
+      return nil if fields.empty?
+
+      line_protocol << " #{fields}" if fields
+      timestamp = _escape_time
+      line_protocol << " #{timestamp}" if timestamp
+
+      line_protocol
+    end
+
+    private
+
+    def _escape_tags
+      return if @tags.nil?
+
+      @tags.sort.to_h.map do |k, v|
+        key = _escape_key(k.to_s)
+        value = _escape_key(v.to_s)
+        if key.empty? || value.empty?
+          nil
+        else
+          "#{key}=#{value}"
+        end
+      end.reject(&:nil?).join(','.freeze)
+    end
+
+    def _escape_fields
+      return if @fields.nil?
+
+      @fields.sort.to_h.map do |k, v|
+        key = _escape_key(k.to_s)
+        value = _escape_value(v)
+        if key.empty? || value.empty?
+          nil
+        else
+          "#{key}=#{value}"
+        end
+      end.reject(&:nil?).join(','.freeze)
+    end
+
+    def _escape_key(value)
+      result = value.dup
+      ESCAPE_KEY_LIST.each do |ch|
+        result = result.gsub(ch) { "\\#{ch}" }
+      end
+      result
+    end
+
+    def _escape_value(value)
+      if value.nil?
+        ''
+      elsif value.is_a?(String)
+        result = value.dup
+        ESCAPE_VALUE_LIST.each do |ch|
+          result = result.gsub(ch) { "\\#{ch}" }
+        end
+        '"'.freeze + result + '"'.freeze
+      elsif value.is_a?(Integer)
+        "#{value}i"
+      elsif [Float::INFINITY, -Float::INFINITY].include?(value)
+        ''
+      else
+        value.to_s
+      end
+    end
+
+    def _escape_time
+      if @time.nil?
+        nil
+      elsif @time.is_a?(Integer)
+        @time.to_s
+      elsif @time.is_a?(Float)
+        @time.round.to_s
+      elsif @time.is_a?(Time)
+        nano_seconds = @time.to_i * 1e9
+        nano_seconds += @time.tv_nsec
+        case @precision || DEFAULT_WRITE_PRECISION
+        when InfluxDB2::WritePrecision::MILLISECOND then
+          (nano_seconds / 1e6).round
+        when InfluxDB2::WritePrecision::SECOND then
+          (nano_seconds / 1e9).round
+        when InfluxDB2::WritePrecision::MICROSECOND then
+          (nano_seconds / 1e3).round
+        when InfluxDB2::WritePrecision::NANOSECOND then
+          nano_seconds.round
+        end
+      else
+        @time.to_s
+      end
+    end
+  end
+end