influxdb-client 1.2.0

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', '>= 12.3.3'
+  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,29 @@
+# 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/default_api'
+require 'influxdb2/client/version'
+require 'influxdb2/client/client'
+require 'influxdb2/client/influx_error'
+require 'influxdb2/client/write_api'
+require 'influxdb2/client/query_api'
+require 'influxdb2/client/delete_api'
+require 'influxdb2/client/point'
+require 'influxdb2/client/flux_table'

data/lib/influxdb2/client/client.rb

@@ -0,0 +1,89 @@
+# 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)
+      @auto_closeable = []
+      @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(write_options: InfluxDB2::SYNCHRONOUS)
+      write_api = WriteApi.new(options: @options, write_options: write_options)
+      @auto_closeable.push(write_api)
+      write_api
+    end
+
+    # Get the Query client.
+    #
+    # @return [QueryApi] New instance of QueryApi.
+    def create_query_api
+      QueryApi.new(options: @options)
+    end
+
+    # Get the Delete API to delete time series data from InfluxDB.
+    #
+    # @return [DeleteApi] New instance of DeleteApi.
+    def create_delete_api
+      DeleteApi.new(options: @options)
+    end
+
+    # Close all connections into InfluxDB 2.
+    #
+    # @return [ true ] Always true.
+    def close!
+      @closed = true
+      @auto_closeable.each(&:close!)
+      true
+    end
+  end
+end

data/lib/influxdb2/client/default_api.rb

@@ -0,0 +1,87 @@
+# 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 api
+  class DefaultApi
+    DEFAULT_TIMEOUT = 10
+    DEFAULT_REDIRECT_COUNT = 10
+
+    HEADER_CONTENT_TYPE = 'Content-Type'.freeze
+
+    # @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
+
+    private
+
+    def _post_json(payload, uri, headers: {})
+      _check_arg_type(:headers, headers, Hash)
+      _post(payload, uri, headers: headers.merge(HEADER_CONTENT_TYPE => 'application/json'))
+    end
+
+    def _post_text(payload, uri, headers: {})
+      _check_arg_type(:headers, headers, Hash)
+      _post(payload, uri, headers: headers.merge(HEADER_CONTENT_TYPE => 'text/plain'))
+    end
+
+    def _post(payload, uri, limit: @max_redirect_count, headers: {})
+      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['User-Agent'] = "influxdb-client-ruby/#{InfluxDB2::VERSION}"
+      headers.each { |k, v| request[k] = v }
+
+      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: limit - 1, headers: headers)
+        else
+          raise InfluxError.from_response(response)
+        end
+      ensure
+        http.finish if http.started?
+      end
+    end
+
+    def _check_arg_type(name, value, klass)
+      raise TypeError, "expected a #{klass.name} for #{name}; got #{value.class.name}" unless value.is_a?(klass)
+    end
+
+    def _check(key, value)
+      raise ArgumentError, "The '#{key}' should be defined as argument or default option: #{@options}" if value.nil?
+    end
+  end
+end

data/lib/influxdb2/client/delete_api.rb

@@ -0,0 +1,80 @@
+# 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_relative 'models/delete_predicate_request'
+
+module InfluxDB2
+  # Delete time series data from InfluxDB
+  #
+  class DeleteApi < DefaultApi
+    # @param [Hash] options The options to be used by the client.
+    def initialize(options:)
+      super(options: options)
+    end
+
+    # Delete time series data from InfluxDB.
+    #
+    # @example
+    # delete('2019-02-03T04:05:06+07:00', '2019-04-03T04:05:06+07:00',
+    #        predicate: 'key1="value1" AND key2="value"', bucket: 'my-bucket', org: 'my-org')
+    #
+    # @example
+    # delete(DateTime.rfc3339('2019-02-03T04:05:06+07:00'), DateTime.rfc3339('2019-03-03T04:05:06+07:00'),
+    #        predicate: 'key1="value1" AND key2="value"', bucket: 'my-bucket', org: 'my-org')
+    #
+    # @param [Object] start Start time of interval to delete data.
+    #   The start could be represent by [Time], [DateTime] or [String] formatted as RFC3339.
+    # @param [Object] stop Stop time of interval to delete data
+    #   The stop could be represent by [Time], [DateTime] or [String] formatted as RFC3339.
+    # @param [String] predicate InfluxQL-like predicate Stop time of interval to delete data
+    # @param [String] bucket specifies the bucket to remove data from
+    # @param [String] org specifies the organization to remove data from
+    def delete(start, stop, predicate: nil, bucket: nil, org: nil)
+      delete_request = InfluxDB2::DeletePredicateRequest.new(start: _to_rfc3339(start), stop: _to_rfc3339(stop),
+                                                             predicate: predicate)
+
+      _delete(delete_request, bucket: bucket, org: org)
+    end
+
+    private
+
+    def _delete(delete_request, bucket: nil, org: nil)
+      bucket_param = bucket || @options[:bucket]
+      org_param = org || @options[:org]
+      _check('bucket', bucket_param)
+      _check('org', org_param)
+
+      uri = URI.parse(File.join(@options[:url], '/api/v2/delete'))
+      uri.query = URI.encode_www_form(org: org_param, bucket: bucket_param)
+
+      _post_json(delete_request.to_body.to_json, uri)
+    end
+
+    def _to_rfc3339(time)
+      if time.is_a?(String)
+        time
+      elsif time.is_a?(Time)
+        _to_rfc3339(time.to_datetime)
+      elsif time.is_a?(DateTime)
+        _to_rfc3339(time.rfc3339)
+      end
+    end
+  end
+end

data/lib/influxdb2/client/flux_csv_parser.rb

@@ -0,0 +1,251 @@
+# 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 'csv'
+require 'base64'
+require 'time'
+
+module InfluxDB2
+  # This class represents Flux query error
+  #
+  class FluxQueryError < StandardError
+    def initialize(message, reference)
+      super(message)
+      @reference = reference
+    end
+
+    attr_reader :reference
+  end
+
+  # This class represents Flux query error
+  #
+  class FluxCsvParserError < StandardError
+    def initialize(message)
+      super(message)
+    end
+  end
+
+  # This class us used to construct FluxResult from CSV.
+  #
+  class FluxCsvParser
+    include Enumerable
+    def initialize(response, stream: false)
+      @response = response
+      @stream = stream
+      @tables = {}
+
+      @table_index = 0
+      @table_id = -1
+      @start_new_table = false
+      @table = nil
+      @parsing_state_error = false
+
+      @closed = false
+    end
+
+    attr_reader :tables, :closed
+
+    def parse
+      @csv_file = CSV.new(@response.instance_of?(Net::HTTPOK) ? @response.body : @response)
+
+      while (csv = @csv_file.shift)
+        # Response has HTTP status ok, but response is error.
+        next if csv.empty?
+
+        if csv[1] == 'error' && csv[2] == 'reference'
+          @parsing_state_error = true
+          next
+        end
+
+        # Throw  InfluxException with error response
+        if @parsing_state_error
+          error = csv[1]
+          reference_value = csv[2]
+          raise FluxQueryError.new(error, reference_value.nil? || reference_value.empty? ? 0 : reference_value.to_i)
+        end
+
+        result = _parse_line(csv)
+
+        yield result if @stream && result.instance_of?(InfluxDB2::FluxRecord)
+      end
+
+      self
+    end
+
+    def each
+      return enum_for(:each) unless block_given?
+
+      parse do |record|
+        yield record
+      end
+
+      self
+    ensure
+      _close_connection
+    end
+
+    private
+
+    def _parse_line(csv)
+      token = csv[0]
+
+      # start new table
+      if token == '#datatype'
+        # Return already parsed DataFrame
+        @start_new_table = true
+        @table = InfluxDB2::FluxTable.new
+
+        @tables[@table_index] = @table unless @stream
+
+        @table_index += 1
+        @table_id = -1
+      elsif @table.nil?
+        raise FluxCsvParserError, 'Unable to parse CSV response. FluxTable definition was not found.'
+      end
+
+      #  # datatype,string,long,dateTime:RFC3339,dateTime:RFC3339,dateTime:RFC3339,double,string,string,string
+      if token == '#datatype'
+        _add_data_types(@table, csv)
+
+      elsif token == '#group'
+        _add_groups(@table, csv)
+
+      elsif token == '#default'
+        _add_default_empty_values(@table, csv)
+      else
+        _parse_values(csv)
+      end
+    end
+
+    def _add_data_types(table, data_types)
+      (1..data_types.length - 1).each do |index|
+        column_def = InfluxDB2::FluxColumn.new(index: index - 1, data_type: data_types[index])
+        table.columns.push(column_def)
+      end
+    end
+
+    def _add_groups(table, csv)
+      i = 1
+
+      table.columns.each do |column|
+        column.group = csv[i] == 'true'
+        i += 1
+      end
+    end
+
+    def _add_default_empty_values(table, default_values)
+      i = 1
+
+      table.columns.each do |column|
+        column.default_value = default_values[i]
+        i += 1
+      end
+    end
+
+    def _add_column_names_and_tags(table, csv)
+      i = 1
+
+      table.columns.each do |column|
+        column.label = csv[i]
+        i += 1
+      end
+    end
+
+    def _parse_values(csv)
+      # parse column names
+      if @start_new_table
+        _add_column_names_and_tags(@table, csv)
+        @start_new_table = false
+        return
+      end
+
+      current_id = csv[2].to_i
+      @table_id = current_id if @table_id == -1
+
+      if @table_id != current_id
+        # create new table with previous column headers settings
+        @flux_columns = @table.columns
+        @table = InfluxDB2::FluxTable.new
+
+        @flux_columns.each do |column|
+          @table.columns.push(column)
+        end
+
+        @tables[@table_index] = @table unless @stream
+        @table_index += 1
+        @table_id = current_id
+      end
+
+      flux_record = _parse_record(@table_index - 1, @table, csv)
+
+      if @stream
+        flux_record
+      else
+        @tables[@table_index - 1].records.push(flux_record)
+      end
+    end
+
+    def _parse_record(table_index, table, csv)
+      record = InfluxDB2::FluxRecord.new(table_index)
+
+      table.columns.each do |flux_column|
+        column_name = flux_column.label
+        str_val = csv[flux_column.index + 1]
+        record.values[column_name] = _to_value(str_val, flux_column)
+      end
+
+      record
+    end
+
+    def _to_value(str_val, column)
+      if str_val.nil? || str_val.empty?
+        default_value = column.default_value
+
+        return nil if default_value.nil? || default_value.empty?
+
+        _to_value(default_value, column)
+      end
+
+      case column.data_type
+      when 'boolean'
+        if str_val.nil? || str_val.empty?
+          true
+        else
+          str_val.casecmp('true').zero?
+        end
+      when 'unsignedLong', 'long', 'duration'
+        str_val.to_i
+      when 'double'
+        str_val.to_f
+      when 'base64Binary'
+        Base64.decode64(str_val)
+      when 'dateTime:RFC3339', 'dateTime:RFC3339Nano'
+        Time.parse(str_val).to_datetime.rfc3339
+      else
+        str_val
+      end
+    end
+
+    def _close_connection
+      # Close CSV Parser
+      @csv_file.close
+      @closed = true
+    end
+  end
+end