influxdb-client 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c567a9747fbb62687569311a2a23d75115eab950713766a8a7e8ac0a65d8a7b
-  data.tar.gz: 1fdb87086e8f18ff65d2da79a51d34c397887bc6ad0ae87dd3904b3cbb1787e0
+  metadata.gz: 0bef54ca002cca11fb29d73a4de5efaa081a800ebc6a284a7eca088bf7d257ea
+  data.tar.gz: 1ca91c0b690ee38c10e89cc41a178f071e244b7b85126a0fadb52315c9eb5a45
 SHA512:
-  metadata.gz: bbc770f809525bd1799e1698d4c8214893a4364f9563fcb972e47f5446720cbbfda6e07acdb0c253b2cad0c6d86decda03fbdcb8ac5639f3428a4362f2f59819
-  data.tar.gz: 3469d334c5fe3bade7cca71291db812f617a56231a8a6a5abe309b2ecb97a381a6f547df81699da7ba0a8c67b20742a620cba020b2bed366802a259463881df0
+  metadata.gz: 849abb961288944fb762ec38a8bb7fdc4b51be0941a03547e8e23360aee98aedf78018e98f75bb879497784bf75a6df3f5c80f164c2a9a453a466f5b8e890d7d
+  data.tar.gz: 2f9a75a9913f0f719d4dce37b1dfa33527159c0435672473979562aba705f8bf1ce34e1be5bd27bfd5dd713af41e39cf194460859a3631d6b28ededb9d188588

data/.github/PULL_REQUEST_TEMPLATE

@@ -2,7 +2,7 @@ Closes #
 
 _Briefly describe your proposed changes:_
 
-  - [ ] CHANGELOG.md updated
-  - [ ] Rebased/mergeable
-  - [ ] Tests pass
-  - [ ] Sign [CLA](https://influxdata.com/community/cla/) (if not already signed)
+- [ ] CHANGELOG.md updated
+- [ ] Rebased/mergeable
+- [ ] Tests pass
+- [ ] Sign [CLA](https://influxdata.com/community/cla/) (if not already signed)

data/.rubocop.yml

@@ -27,11 +27,11 @@ AllCops:
 Metrics/LineLength:
   Max: 120
 Metrics/MethodLength:
-  Max: 30
+  Max: 50
 Metrics/ClassLength:
   Max: 200
 Metrics/AbcSize:
-  Max: 30
+  Max: 40
 Metrics/CyclomaticComplexity:
   Max: 15
 Metrics/PerceivedComplexity:

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 1.2.0 [2020-03-13]
+
+### Features
+1. [#23](https://github.com/influxdata/influxdb-client-ruby/issues/23): Added DeleteApi to delete time series data from InfluxDB.
+1. [#24](https://github.com/influxdata/influxdb-client-ruby/issues/24): Added jitter_interval and retry_interval to WriteApi
+1. [#26](https://github.com/influxdata/influxdb-client-ruby/issues/26): Set User-Agent to influxdb-client-ruby/VERSION for all requests
+
+### Security
+1. [#29](https://github.com/influxdata/influxdb-client-ruby/pull/29): Upgrade rake to version 12.3.3 - [CVE-2020-8130](https://github.com/advisories/GHSA-jppv-gw3r-w3q8)
+
+### Bugs
+1. [#22](https://github.com/influxdata/influxdb-client-ruby/pull/22): Fixed batch write
+1. [#28](https://github.com/influxdata/influxdb-client-ruby/pull/28): Correctly parse CSV where multiple results include multiple tables
+1. [#30](https://github.com/influxdata/influxdb-client-ruby/pull/30): Send Content-Type headers
+
 ## 1.1.0 [2020-02-14]
 
 ### Features

data/README.md

@@ -11,7 +11,6 @@
 This repository contains the reference Ruby client for the InfluxDB 2.0.
 
 #### Note: This library is for use with InfluxDB 2.x. For connecting to InfluxDB 1.x instances, please use the [influxdb-ruby](https://github.com/influxdata/influxdb-ruby) client.
-#### Disclaimer: This library is a work in progress and should not be considered production ready yet.
 
 ## Installation
 
@@ -24,7 +23,7 @@ The client can be installed manually or with bundler.
 To install the client gem manually:
 
 ```
-gem install influxdb-client -v 1.1.0
+gem install influxdb-client -v 1.2.0
 ```
 
 ## Usage
@@ -122,8 +121,10 @@ The writes are processed in batches which are configurable by `WriteOptions`:
 
 | Property | Description | Default Value |
 | --- | --- | --- |
-| **batchSize** | the number of data point to collect in batch | 1000 |
-| **flushInterval** | the number of milliseconds before the batch is written | 1000 |
+| batchSize | the number of data point to collect in batch | 1000 |
+| flushInterval | the number of milliseconds before the batch is written | 1000 |
+| retry_interval | the number of milliseconds to retry unsuccessful write. The retry interval is used when the InfluxDB server does not specify "Retry-After" header. | 1000 |
+| jitter_interval | the number of milliseconds to increase the batch flush interval by a random amount | 0 |
 
 ```ruby
 write_options = InfluxDB2::WriteOptions.new(write_type: InfluxDB2::WriteType::BATCHING,
@@ -209,6 +210,27 @@ write_api = client.create_write_api
 write_api.write(data: ['h2o,location=west value=33i 15', point, hash])
 ```
 
+### Delete data
+
+The [DeleteApi](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/delete_api.rb) supports deletes [points](https://v2.docs.influxdata.com/v2.0/reference/glossary/#point) from an InfluxDB bucket.
+
+```ruby
+client = InfluxDB2::Client.new('http://localhost:9999', 'my-token',
+                               bucket: 'my-bucket',
+                               org: 'my-org',
+                               precision: InfluxDB2::WritePrecision::NANOSECOND)
+
+client.create_delete_api.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"')
+```
+
+The time range could be specified as:
+
+1. String - `"2019-02-03T04:05:06+07:00"`
+1. DateTime - `DateTime.rfc3339('2019-03-03T04:05:06+07:00')`
+1. Time - `Time.utc(2015, 10, 16, 8, 20, 15)`
+
 ## Local tests
 
 ```

data/bin/generate-sources.sh

@@ -4,12 +4,7 @@
 
 SCRIPT_PATH="$( cd "$(dirname "$0")" || exit ; pwd -P )"
 
-# Generate OpenAPI generator
-#cd "${SCRIPT_PATH}"/../openapi-generator/ || exit
-#mvn clean install -DskipTests
-
 # delete old sources
-#rm "${SCRIPT_PATH}"/../influxdb_client/domain/*.py
 rm "${SCRIPT_PATH}"/../lib/influxdb2/client/models/*
 
 # Generate client
@@ -21,10 +16,8 @@ mkdir -p "${SCRIPT_PATH}"/../lib/influxdb2/client/models
 mv "${SCRIPT_PATH}"/../lib/influx_db2/models/* "${SCRIPT_PATH}"/../lib/influxdb2/client/models
 
 cd "${SCRIPT_PATH}"/../lib/influxdb2/client/models || exit
-rm -r $(ls | grep -v "\<query.rb\>\|\<dialect.rb\>")
+rm -r $(ls | grep -v "\<dialect.rb\>\|\<query.rb\>\|\<delete_predicate_request.rb\>")
 
 # Clean
 rmdir "${SCRIPT_PATH}"/../lib/influx_db2/models
 rmdir "${SCRIPT_PATH}"/../lib/influx_db2/
-
-#rm -r $(ls | grep -v "\<query.rb\>\|\<dialect.rb\>")

data/influxdb-client.gemspec

@@ -46,7 +46,7 @@ Gem::Specification.new do |spec|
   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 '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'

data/lib/influxdb2/client.rb

@@ -24,5 +24,6 @@ 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

@@ -70,6 +70,13 @@ module InfluxDB2
       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.

data/lib/influxdb2/client/default_api.rb

@@ -24,6 +24,8 @@ module InfluxDB2
     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
@@ -32,7 +34,17 @@ module InfluxDB2
 
     private
 
-    def _post(payload, uri, limit = @max_redirect_count)
+    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)
@@ -43,6 +55,9 @@ module InfluxDB2
 
       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
@@ -52,7 +67,7 @@ module InfluxDB2
           response
         when Net::HTTPRedirection then
           location = response['location']
-          _post(payload, URI.parse(location), limit - 1)
+          _post(payload, URI.parse(location), limit: limit - 1, headers: headers)
         else
           raise InfluxError.from_response(response)
         end
@@ -61,6 +76,10 @@ module InfluxDB2
       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

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

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 require 'csv'
 require 'base64'
+require 'time'
 
 module InfluxDB2
   # This class represents Flux query error
@@ -50,6 +51,7 @@ module InfluxDB2
       @tables = {}
 
       @table_index = 0
+      @table_id = -1
       @start_new_table = false
       @table = nil
       @parsing_state_error = false
@@ -112,6 +114,7 @@ module InfluxDB2
         @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
@@ -172,9 +175,10 @@ module InfluxDB2
         return
       end
 
-      @current_index = csv[2].to_i
+      current_id = csv[2].to_i
+      @table_id = current_id if @table_id == -1
 
-      if @current_index > (@table_index - 1)
+      if @table_id != current_id
         # create new table with previous column headers settings
         @flux_columns = @table.columns
         @table = InfluxDB2::FluxTable.new
@@ -185,6 +189,7 @@ module InfluxDB2
 
         @tables[@table_index] = @table unless @stream
         @table_index += 1
+        @table_id = current_id
       end
 
       flux_record = _parse_record(@table_index - 1, @table, csv)

data/lib/influxdb2/client/influx_error.rb

@@ -5,22 +5,26 @@ module InfluxDB2
     attr_reader :code
     # Reference code unique to the error type
     attr_reader :reference
+    # The Retry-After header describes when to try the request again.
+    attr_reader :retry_after
 
-    def initialize(message:, code:, reference:)
+    def initialize(message:, code:, reference:, retry_after:)
       super(message)
 
       @code = code
       @reference = reference
+      @retry_after = retry_after
     end
 
     def self.from_response(response)
       json = JSON.parse(response.body)
-      obj = new(message: json['message'] || '', code: response.code, reference: json['code'] || '')
+      obj = new(message: json['message'] || '', code: response.code, reference: json['code'] || '',
+                retry_after: response['Retry-After'] || '')
       obj
     end
 
     def self.from_message(message)
-      obj = new(message: message, code: '', reference: '')
+      obj = new(message: message, code: '', reference: '', retry_after: '')
       obj
     end
   end

data/lib/influxdb2/client/models/delete_predicate_request.rb

@@ -0,0 +1,215 @@
+=begin
+#Influx API Service
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+OpenAPI spec version: 0.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.4
+
+=end
+
+require 'date'
+
+module InfluxDB2
+  # The delete predicate request.
+  class DeletePredicateRequest
+    # RFC3339Nano
+    attr_accessor :start
+
+    # RFC3339Nano
+    attr_accessor :stop
+
+    # InfluxQL-like delete statement
+    attr_accessor :predicate
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'start' => :'start',
+        :'stop' => :'stop',
+        :'predicate' => :'predicate'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'start' => :'DateTime',
+        :'stop' => :'DateTime',
+        :'predicate' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'start')
+        self.start = attributes[:'start']
+      end
+
+      if attributes.has_key?(:'stop')
+        self.stop = attributes[:'stop']
+      end
+
+      if attributes.has_key?(:'predicate')
+        self.predicate = attributes[:'predicate']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @start.nil?
+        invalid_properties.push('invalid value for "start", start cannot be nil.')
+      end
+
+      if @stop.nil?
+        invalid_properties.push('invalid value for "stop", stop cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @start.nil?
+      return false if @stop.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          start == o.start &&
+          stop == o.stop &&
+          predicate == o.predicate
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [start, stop, predicate].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = InfluxDB2.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end