influxdb-client 1.2.0 → 1.3.0.pre.678

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bef54ca002cca11fb29d73a4de5efaa081a800ebc6a284a7eca088bf7d257ea
-  data.tar.gz: 1ca91c0b690ee38c10e89cc41a178f071e244b7b85126a0fadb52315c9eb5a45
+  metadata.gz: cfdd87f63df56ccaccfa5efa62a17363aa4f23ef5b5f4181fc818a8dd5b88878
+  data.tar.gz: '0139f72ececad7ec2a3dbd10686e769c92a626ca938ee091a967abfe91ac1452'
 SHA512:
-  metadata.gz: 849abb961288944fb762ec38a8bb7fdc4b51be0941a03547e8e23360aee98aedf78018e98f75bb879497784bf75a6df3f5c80f164c2a9a453a466f5b8e890d7d
-  data.tar.gz: 2f9a75a9913f0f719d4dce37b1dfa33527159c0435672473979562aba705f8bf1ce34e1be5bd27bfd5dd713af41e39cf194460859a3631d6b28ededb9d188588
+  metadata.gz: f0f1a96df880bd30f3ef945968ee7e0163e28507b2372f2e0c5daa2a7437570e49cd2fe183de9bd8eb0f002bf83272a814a562928d2a14c480a46456c4a46955
+  data.tar.gz: cbae27badcc80adc5b4bd4185ab02262ce941763da4727ae01366adc2579db4d697ea62131957a3abf088a56ac74bbc7a2b2c4349e48b942790101eabf6c4007

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.3.0 [unreleased]
+
+### Features
+1. [#32](https://github.com/influxdata/influxdb-client-ruby/pull/32): Checks the health of a running InfluxDB instance by querying the /health
+
 ## 1.2.0 [2020-03-13]
 
 ### Features

data/README.md

@@ -231,6 +231,12 @@ The time range could be specified as:
 1. DateTime - `DateTime.rfc3339('2019-03-03T04:05:06+07:00')`
 1. Time - `Time.utc(2015, 10, 16, 8, 20, 15)`
 
+## Advanced Usage
+
+### Check the server status 
+
+Server availability can be checked using the `client.health` method. That is equivalent of the [influx ping](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/ping/).
+
 ## Local tests
 
 ```

data/bin/generate-sources.sh

@@ -16,7 +16,7 @@ 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 "\<dialect.rb\>\|\<query.rb\>\|\<delete_predicate_request.rb\>")
+rm -r $(ls | grep -v "\<health_check.rb\>\|\<dialect.rb\>\|\<query.rb\>\|\<delete_predicate_request.rb\>")
 
 # Clean
 rmdir "${SCRIPT_PATH}"/../lib/influx_db2/models

data/lib/influxdb2/client.rb

@@ -25,5 +25,6 @@ require 'influxdb2/client/influx_error'
 require 'influxdb2/client/write_api'
 require 'influxdb2/client/query_api'
 require 'influxdb2/client/delete_api'
+require 'influxdb2/client/health_api'
 require 'influxdb2/client/point'
 require 'influxdb2/client/flux_table'

data/lib/influxdb2/client/client.rb

@@ -77,6 +77,13 @@ module InfluxDB2
       DeleteApi.new(options: @options)
     end
 
+    # Get the health of an instance.
+    #
+    # @return [HealthCheck]
+    def health
+      HealthApi.new(options: @options).health
+    end
+
     # Close all connections into InfluxDB 2.
     #
     # @return [ true ] Always true.

data/lib/influxdb2/client/default_api.rb

@@ -45,6 +45,14 @@ module InfluxDB2
     end
 
     def _post(payload, uri, limit: @max_redirect_count, headers: {})
+      _request(payload, uri, limit: limit, headers: headers, request: Net::HTTP::Post)
+    end
+
+    def _get(uri, limit: @max_redirect_count, headers: {})
+      _request(nil, uri, limit: limit, headers: headers.merge('Accept' => 'application/json'), request: Net::HTTP::Get)
+    end
+
+    def _request(payload, uri, limit: @max_redirect_count, headers: {}, request: Net::HTTP::Post)
       raise InfluxError.from_message("Too many HTTP redirects. Exceeded limit: #{@max_redirect_count}") if limit.zero?
 
       http = Net::HTTP.new(uri.host, uri.port)
@@ -53,7 +61,7 @@ module InfluxDB2
       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 = request.new(uri.request_uri)
       request['Authorization'] = "Token #{@options[:token]}"
       request['User-Agent'] = "influxdb-client-ruby/#{InfluxDB2::VERSION}"
       headers.each { |k, v| request[k] = v }

data/lib/influxdb2/client/health_api.rb

@@ -0,0 +1,49 @@
+# 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/health_check'
+
+module InfluxDB2
+  # The client of the InfluxDB 2.0 that implement Health HTTP API endpoint.
+  #
+  class HealthApi < DefaultApi
+    # @param [Hash] options The options to be used by the client.
+    def initialize(options:)
+      super(options: options)
+    end
+
+    # Get the health of an instance.
+    #
+    # @return [HealthCheck]
+    def health
+      uri = URI.parse(File.join(@options[:url], '/health'))
+      body = _get(uri).body
+      data = JSON.parse("[#{body}]", symbolize_names: true)[0]
+      HealthCheck.new.tap do |model|
+        model.build_from_hash data
+      end
+    rescue StandardError => e
+      HealthCheck.new.tap do |model|
+        model.name = 'influxdb'
+        model.status = 'fail'
+        model.message = e.message
+      end
+    end
+  end
+end

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

@@ -0,0 +1,256 @@
+=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
+  class HealthCheck
+    attr_accessor :name
+
+    attr_accessor :message
+
+    attr_accessor :checks
+
+    attr_accessor :status
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'message' => :'message',
+        :'checks' => :'checks',
+        :'status' => :'status'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'message' => :'String',
+        :'checks' => :'Array<HealthCheck>',
+        :'status' => :'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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.has_key?(:'checks')
+        if (value = attributes[:'checks']).is_a?(Array)
+          self.checks = value
+        end
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status 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 @name.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ['pass', 'fail'])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ['pass', 'fail'])
+      unless validator.valid?(status)
+        fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
+      end
+      @status = status
+    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 &&
+          name == o.name &&
+          message == o.message &&
+          checks == o.checks &&
+          status == o.status
+    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
+      [name, message, checks, status].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

data/lib/influxdb2/client/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module InfluxDB2
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/test/influxdb/client_test.rb

@@ -21,6 +21,10 @@
 require 'test_helper'
 
 class ClientTest < Minitest::Test
+  def setup
+    WebMock.allow_net_connect!
+  end
+
   def test_defined_version_number
     refute_nil ::InfluxDB2::VERSION
   end
@@ -67,4 +71,22 @@ class ClientTest < Minitest::Test
     refute_nil write_api
     assert_instance_of InfluxDB2::WriteApi, write_api
   end
+
+  def test_health
+    client = InfluxDB2::Client.new('http://localhost:9999', 'my-token', use_ssl: false)
+
+    health = client.health
+    assert_equal 'ready for queries and writes', health.message
+    assert_equal 'influxdb', health.name
+    assert_equal 'pass', health.status
+  end
+
+  def test_health_not_running
+    client_not_running = InfluxDB2::Client.new('http://localhost:8099', 'my-token', use_ssl: false)
+    health = client_not_running.health
+
+    assert_match 'Failed to open TCP connection to localhost:8099', health.message
+    assert_equal 'influxdb', health.name
+    assert_equal 'fail', health.status
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-client
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0.pre.678
 platform: ruby
 authors:
 - Jakub Bednar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-13 00:00:00.000000000 Z
+date: 2020-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,9 +152,11 @@ files:
 - lib/influxdb2/client/delete_api.rb
 - lib/influxdb2/client/flux_csv_parser.rb
 - lib/influxdb2/client/flux_table.rb
+- lib/influxdb2/client/health_api.rb
 - lib/influxdb2/client/influx_error.rb
 - lib/influxdb2/client/models/delete_predicate_request.rb
 - lib/influxdb2/client/models/dialect.rb
+- lib/influxdb2/client/models/health_check.rb
 - lib/influxdb2/client/models/query.rb
 - lib/influxdb2/client/point.rb
 - lib/influxdb2/client/query_api.rb
@@ -191,9 +193,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: