influxdb-client 2.1.0.pre.3380 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 594977f22ac698a141e1123cbdb730dc87b16933f2f28d03098eec6480791ff1
-  data.tar.gz: 20ef07b3c2e19e50c8ba031d768c86747e3f3c13ca80b1bf416cdbe9e0f066d0
+  metadata.gz: be3ac6c581d2ec4f1bea7183b78bc8d189510a9815cd54483e09611ca65402bd
+  data.tar.gz: 5c18d34011098b03d9226188d5663a1c16b2b02348931409bf7fb5fb832dbb10
 SHA512:
-  metadata.gz: a0adda077801b92b62e22a735f4c0bcb3494716d0f0694191c4da50b51927fea24f37c3d67c57df12354b10baf652e41bca9baca1cd7c59aaafe138a5a786b51
-  data.tar.gz: 6c6c84ba4068dd6189244de3fe3921f6baa1642d75c5dadd4009e4e7cb7924e641b6ad194766d7486e375b84cccb2a780ba0fd5585c32eea6320b2c2cc3c4e2e
+  metadata.gz: 5e998c044335d66a56dcf9b25e53fbdbac305307458a456a451c517698e2e6f1295ea44bb11142fbbad6e42856e1a0e5fa1f0c6105cc3a9711a1efdc30ebfe8f
+  data.tar.gz: 58626af8588b716b4b4edba032c0a5d28b8a5645080ad0cd2ba39ded13d529025c6029aee5ac66e687a6143c6c4795d356730f74fbc78f78d551299745194217

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-## 2.1.0 [unreleased]
+## 2.1.0 [2021-10-22]
+
+### 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

@@ -64,13 +64,13 @@ The client can be installed manually or with bundler.
 To install the client gem manually:
 
 ```
-gem install influxdb-client -v 2.0.0
+gem install influxdb-client -v 2.1.0
 ```
 
 For management API:
 
 ```
-gem install influxdb-client-apis -v 2.0.0
+gem install influxdb-client-apis -v 2.1.0
 ```
 
 ## Usage
@@ -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.3380
+  version: 2.1.0
 platform: ruby
 authors:
 - Jakub Bednar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-13 00:00:00.000000000 Z
+date: 2021-10-22 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
@@ -184,9 +185,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: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3.1
 signing_key: