influxdb-client 2.1.0.pre.3441 → 2.1.0.pre.3812

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bd4863b65a77e9132d6e1592907cc2ed74cdc66de156ac474d7ff12955814e6
-  data.tar.gz: c3fece1432f2d88abd392a52b3ff7315e5054c21c0f765e18799e5937c183bde
+  metadata.gz: 7a3fcf08b154394bbe7a5c20a3025e258d78696436ecef75c769e22ccfb3512e
+  data.tar.gz: 49360f4aaf8995b26a460e5170d8c23959c1bc3610fe834a76f3e03479595820
 SHA512:
-  metadata.gz: 49e160aaa1e8fbb689f83bb7d2f8f495b51adea1a90f8de05da2d3243ed68c4097ed3a3c61f53520f208e61e1eccab78cb42593834fd31dc5d43ed65b4756119
-  data.tar.gz: de77bfe938248e8a7963c6d5fc5b48f31c1833baf50f291f5c30128919852692c635a74b7785245eae375320d192f1188efb9135813b2a7bd9b429990bc0bcb3
+  metadata.gz: 960131b0ab69dfbcb7a907795b118500a299295211feec800727390fae8eabaafb5733bf031fb56b7388f8aea8385e24c57b651e08e70ac126604925b2248a47
+  data.tar.gz: a15a699c569bf89689273217f7efe2ec9b53a354344b6714003e3ff9eb89aa210f1a3c6c875451a77c07be4bc6d97d799e8f7fea9e53d1a5e23a61eaf4b7fc4e

data/CHANGELOG.md

@@ -1,7 +1,11 @@
 ## 2.1.0 [unreleased]
 
+### Features
+1. [#93](https://github.com/influxdata/influxdb-client-ruby/pull/93): Add `PingApi` to check status of OSS and Cloud instance
+
 ### CI
 1. [#91](https://github.com/influxdata/influxdb-client-ruby/pull/91): Switch to next-gen CircleCI's convenience images
+1. [#95](https://github.com/influxdata/influxdb-client-ruby/pull/95): Update `jruby` to `9.3.1.0-jdk11`
 
 ## 2.0.0 [2021-09-13]
 

data/README.md

@@ -400,7 +400,7 @@ client.close!
 
 ### 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/).
+Server availability can be checked using the `client.ping` method. That is equivalent of the [influx ping](https://v2.docs.influxdata.com/v2.0/reference/cli/influx/ping/).
 
 ### Proxy configuration
 

data/lib/influxdb-client.rb

@@ -26,6 +26,7 @@ require 'influxdb2/client/write_api'
 require 'influxdb2/client/query_api'
 require 'influxdb2/client/delete_api'
 require 'influxdb2/client/health_api'
+require 'influxdb2/client/ping_api'
 require 'influxdb2/client/point'
 require 'influxdb2/client/flux_table'
 require 'influxdb2/client/write_retry'

data/lib/influxdb2/client/client.rb

@@ -87,11 +87,20 @@ module InfluxDB2
 
     # Get the health of an instance.
     #
+    # @deprecated Use `ping` instead
     # @return [HealthCheck]
     def health
       HealthApi.new(options: @options).health
     end
 
+    # Checks the status of InfluxDB instance and version of InfluxDB.
+    #
+    # @deprecated Use `ping` instead
+    # @return [Ping]
+    def ping
+      PingApi.new(options: @options).ping
+    end
+
     # Close all connections into InfluxDB 2.
     #
     # @return [ true ] Always true.

data/lib/influxdb2/client/health_api.rb

@@ -22,6 +22,7 @@ require_relative 'models/health_check'
 module InfluxDB2
   # The client of the InfluxDB 2.0 that implement Health HTTP API endpoint.
   #
+  # @deprecated Use `PingApi` instead
   class HealthApi < DefaultApi
     # @param [Hash] options The options to be used by the client.
     def initialize(options:)

data/lib/influxdb2/client/ping_api.rb

@@ -0,0 +1,65 @@
+# 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 Ping HTTP API endpoint.
+  #
+  class PingApi < DefaultApi
+    # @param [Hash] options The options to be used by the client.
+    def initialize(options:)
+      super(options: options)
+    end
+
+    # Checks the status of InfluxDB instance and version of InfluxDB.
+    #
+    # @return [Ping]
+    def ping
+      uri = _parse_uri('/ping')
+      headers = _get(uri)
+      Ping.new.tap do |model|
+        model.status = 'ok'
+        model.build = headers['X-Influxdb-Build']
+        model.version = headers['X-Influxdb-Version']
+        model.message = 'ready for queries and writes'
+      end
+    rescue StandardError => e
+      Ping.new.tap do |model|
+        model.status = 'fail'
+        model.message = e.message
+      end
+    end
+  end
+
+  # The status of InfluxDB instance and version of InfluxDB.
+  class Ping
+    # The type of InfluxDB build.
+    attr_accessor :build
+
+    # The version of InfluxDB.
+    attr_accessor :version
+
+    # The status of InfluxDB.
+    attr_accessor :status
+
+    # The error message.
+    attr_accessor :message
+  end
+end

data/test/influxdb/client_test.rb

@@ -90,6 +90,26 @@ class ClientTest < Minitest::Test
     assert_equal 'fail', health.status
   end
 
+  def test_ping
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token', use_ssl: false)
+
+    ping = client.ping
+    assert_equal 'ready for queries and writes', ping.message
+    assert_equal 'OSS, oss2', ping.build
+    assert_equal 'ok', ping.status
+    refute_empty ping.version
+  end
+
+  def test_ping_not_running
+    client_not_running = InfluxDB2::Client.new('http://localhost:8099', 'my-token', use_ssl: false)
+    ping = client_not_running.ping
+
+    assert_match 'Failed to open TCP connection to localhost:8099', ping.message
+    assert_equal 'fail', ping.status
+    assert_nil ping.build
+    assert_nil ping.version
+  end
+
   def test_trailing_slash_in_url
     uri = URI.parse(File.join('http://localhost:8099', '/api/v2/write'))
     assert_equal 'http://localhost:8099/api/v2/write', uri.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-client
 version: !ruby/object:Gem::Version
-  version: 2.1.0.pre.3441
+  version: 2.1.0.pre.3812
 platform: ruby
 authors:
 - Jakub Bednar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -146,6 +146,7 @@ files:
 - lib/influxdb2/client/models/dialect.rb
 - lib/influxdb2/client/models/health_check.rb
 - lib/influxdb2/client/models/query.rb
+- lib/influxdb2/client/ping_api.rb
 - lib/influxdb2/client/point.rb
 - lib/influxdb2/client/query_api.rb
 - lib/influxdb2/client/version.rb