influxdb-client 2.1.0.pre.3441 → 2.2.0.pre.4244

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bd4863b65a77e9132d6e1592907cc2ed74cdc66de156ac474d7ff12955814e6
-  data.tar.gz: c3fece1432f2d88abd392a52b3ff7315e5054c21c0f765e18799e5937c183bde
+  metadata.gz: a0dd61b35e7f884f78c34dc811322b5729752c29326b227cc490cefd51e74a8a
+  data.tar.gz: 67fa3056a29be235d4403f03af55fa2f13263935064886a88a9baaad5d513a51
 SHA512:
-  metadata.gz: 49e160aaa1e8fbb689f83bb7d2f8f495b51adea1a90f8de05da2d3243ed68c4097ed3a3c61f53520f208e61e1eccab78cb42593834fd31dc5d43ed65b4756119
-  data.tar.gz: de77bfe938248e8a7963c6d5fc5b48f31c1833baf50f291f5c30128919852692c635a74b7785245eae375320d192f1188efb9135813b2a7bd9b429990bc0bcb3
+  metadata.gz: a67ea2c94cb86793664c997de39552c63ab9f6b0591368ac574788e00efb11ce6ea837f71e2e8e7dc596c213a62124512848fdd0b076b9581e16ecfb08694c63
+  data.tar.gz: fa8e865d6838ea8498ac4b76bc936d5712173b48e7bb815652a62f94fa233582206cd2bffd77f1689a8bbd7d03f30f55b2c4efff2bb06cf18fadcc0c99b87df4

data/CHANGELOG.md

@@ -1,7 +1,19 @@
-## 2.1.0 [unreleased]
+## 2.2.0 [unreleased]
+
+### Features
+1. [#96](https://github.com/influxdata/influxdb-client-ruby/pull/96): Add support for Parameterized Queries
+
+### Documentation
+1. [#96](https://github.com/influxdata/influxdb-client-ruby/pull/96): Add Parameterized Queries example
+
+## 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
@@ -152,6 +152,33 @@ query_api.query_stream(query: query).each do |record|
 end
 ```
 
+#### Parameterized queries
+InfluxDB Cloud supports [Parameterized Queries](https://docs.influxdata.com/influxdb/cloud/query-data/parameterized-queries/)
+that let you dynamically change values in a query using the InfluxDB API. Parameterized queries make Flux queries more
+reusable and can also be used to help prevent injection attacks.
+
+InfluxDB Cloud inserts the params object into the Flux query as a Flux record named `params`. Use dot or bracket
+notation to access parameters in the `params` record in your Flux query. Parameterized Flux queries support only `int`
+, `float`, and `string` data types. To convert the supported data types into
+other [Flux basic data types, use Flux type conversion functions](https://docs.influxdata.com/influxdb/cloud/query-data/parameterized-queries/#supported-parameter-data-types).
+
+Parameterized query example:
+> :warning: Parameterized Queries are supported only in InfluxDB Cloud, currently there is no support in InfluxDB OSS.
+
+```ruby
+client = InfluxDB2::Client.new('https://localhost:8086', 'my-token',
+                              bucket: 'my-bucket',
+                              org: 'my-org')
+
+query = 'from(bucket: params.bucketParam) |> range(start: duration(v: params.startParam))'
+params = { 'bucketParam' => 'my-bucket', 'startParam' => '-1h' }
+
+query_api = client.create_query_api
+result = query_api.query(query: query, params: params)
+
+result[0].records.each { |record| puts "#{record.time} #{record.measurement}: #{record.field} #{record.value}" }
+```
+
 ### Writing data
 The [WriteApi](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/write_api.rb) supports synchronous and batching writes into InfluxDB 2.0. In default api uses synchronous write. To enable batching you can use WriteOption.
 
@@ -400,7 +427,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/models/query.rb

@@ -1,7 +1,7 @@
 =begin
-#Influx OSS API Service
+#InfluxDB OSS API Service
 
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. 
 
 The version of the OpenAPI document: 2.0.0
 
@@ -24,6 +24,9 @@ module InfluxDB2
     # The type of query. Must be \"flux\".
     attr_reader :type
 
+    # Enumeration of key/value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both) 
+    attr_accessor :params
+
     attr_accessor :dialect
 
     # Specifies the time that should be reported as \"now\" in the query. Default is the server's now time.
@@ -57,6 +60,7 @@ module InfluxDB2
         :'extern' => :'extern',
         :'query' => :'query',
         :'type' => :'type',
+        :'params' => :'params',
         :'dialect' => :'dialect',
         :'now' => :'now',
       }
@@ -68,6 +72,7 @@ module InfluxDB2
         :'extern' => :'File',
         :'query' => :'String',
         :'type' => :'String',
+        :'params' => :'Hash<String, Object>',
         :'dialect' => :'Dialect',
         :'now' => :'Time'
       }
@@ -106,6 +111,12 @@ module InfluxDB2
         self.type = attributes[:'type']
       end
 
+      if attributes.key?(:'params')
+        if (value = attributes[:'params']).is_a?(Hash)
+          self.params = value
+        end
+      end
+
       if attributes.key?(:'dialect')
         self.dialect = attributes[:'dialect']
       end
@@ -153,6 +164,7 @@ module InfluxDB2
           extern == o.extern &&
           query == o.query &&
           type == o.type &&
+          params == o.params &&
           dialect == o.dialect &&
           now == o.now
     end
@@ -166,7 +178,7 @@ module InfluxDB2
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [extern, query, type, dialect, now].hash
+      [extern, query, type, params, dialect, now].hash
     end
 
     # Builds the object from hash

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/lib/influxdb2/client/query_api.rb

@@ -36,16 +36,18 @@ module InfluxDB2
 
     # @param [Object] query the flux query to execute. The data could be represent by [String], [Query]
     # @param [String] org specifies the source organization
+    # @param [Enumerable] params represent key/value pairs parameters to be injected into query
     # @return [String] result of query
-    def query_raw(query: nil, org: nil, dialect: DEFAULT_DIALECT)
-      _post_query(query: query, org: org, dialect: dialect).read_body
+    def query_raw(query: nil, org: nil, dialect: DEFAULT_DIALECT, params: nil)
+      _post_query(query: query, org: org, dialect: dialect, params: params).read_body
     end
 
     # @param [Object] query the flux query to execute. The data could be represent by [String], [Query]
     # @param [String] org specifies the source organization
+    # @param [Enumerable] params represent key/value pairs parameters to be injected into query
     # @return [Array] list of FluxTables which are matched the query
-    def query(query: nil, org: nil, dialect: DEFAULT_DIALECT)
-      response = query_raw(query: query, org: org, dialect: dialect)
+    def query(query: nil, org: nil, dialect: DEFAULT_DIALECT, params: nil)
+      response = query_raw(query: query, org: org, dialect: dialect, params: params)
       parser = InfluxDB2::FluxCsvParser.new(response)
 
       parser.parse
@@ -54,20 +56,21 @@ module InfluxDB2
 
     # @param [Object] query the flux query to execute. The data could be represent by [String], [Query]
     # @param [String] org specifies the source organization
+    # @param [Enumerable] params represent key/value pairs parameters to be injected into query
     # @return stream of Flux Records
-    def query_stream(query: nil, org: nil, dialect: DEFAULT_DIALECT)
-      response = _post_query(query: query, org: org, dialect: dialect)
+    def query_stream(query: nil, org: nil, dialect: DEFAULT_DIALECT, params: nil)
+      response = _post_query(query: query, org: org, dialect: dialect, params: params)
 
       InfluxDB2::FluxCsvParser.new(response, stream: true)
     end
 
     private
 
-    def _post_query(query: nil, org: nil, dialect: DEFAULT_DIALECT)
+    def _post_query(query: nil, org: nil, dialect: DEFAULT_DIALECT, params: nil)
       org_param = org || @options[:org]
       _check('org', org_param)
 
-      payload = _generate_payload(query, dialect)
+      payload = _generate_payload(query: query, dialect: dialect, params: params)
       return nil if payload.nil?
 
       uri = _parse_uri('/api/v2/query')
@@ -76,16 +79,17 @@ module InfluxDB2
       _post_json(payload.to_body.to_json, uri)
     end
 
-    def _generate_payload(query, dialect)
+    def _generate_payload(query: nil, dialect: nil, params: nil)
       if query.nil?
         nil
       elsif query.is_a?(Query)
+        query.params = params unless params.nil?
         query
       elsif query.is_a?(String)
         if query.empty?
           nil
         else
-          Query.new(query: query, dialect: dialect, type: nil)
+          Query.new(query: query, dialect: dialect, type: nil, params: params)
         end
       end
     end

data/lib/influxdb2/client/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module InfluxDB2
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.0'.freeze
 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

data/test/influxdb/query_api_test.rb

@@ -49,6 +49,27 @@ class QueryApiTest < MiniTest::Test
     assert_equal result, SUCCESS_DATA
   end
 
+  def test_parameterized_query_raw
+    body = '{"query":"from(bucket: params.bucketParam) |> range(start:  duration(v: params.startParam)) |> last()",' \
+'"params":{"bucketParam":"my-bucket","startParam":"1970-01-01T00:00:00.000000001Z"},' \
+'"dialect":{"header":true,"delimiter":",","annotations":["datatype","group","default"],' \
+'"commentPrefix":"#","dateTimeFormat":"RFC3339"}}'
+    stub_request(:post, 'http://localhost:8086/api/v2/query?org=my-org')
+      .with(body: body)
+      .to_return(body: SUCCESS_DATA)
+
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
+                                   bucket: 'my-bucket',
+                                   org: 'my-org',
+                                   use_ssl: false)
+
+    query = 'from(bucket: params.bucketParam) |> range(start:  duration(v: params.startParam)) |> last()'
+    params = Hash['bucketParam' => 'my-bucket', 'startParam' => '1970-01-01T00:00:00.000000001Z']
+    result = client.create_query_api.query_raw(query: query, params: params)
+
+    assert_equal result, SUCCESS_DATA
+  end
+
   def test_query
     stub_request(:post, 'http://localhost:8086/api/v2/query?org=my-org')
       .to_return(body: SUCCESS_DATA)
@@ -73,6 +94,36 @@ class QueryApiTest < MiniTest::Test
     assert_equal 'free', record1.field
   end
 
+  def test_parameterized_query
+    body = '{"query":"from(bucket: params.bucketParam) |> range(start:  duration(v: params.startParam)) |> last()",' \
+'"params":{"bucketParam":"my-bucket","startParam":"1970-01-01T00:00:00.000000001Z"},' \
+'"dialect":{"header":true,"delimiter":",","annotations":["datatype","group","default"],' \
+'"commentPrefix":"#","dateTimeFormat":"RFC3339"}}'
+    stub_request(:post, 'http://localhost:8086/api/v2/query?org=my-org')
+      .with(body: body)
+      .to_return(body: SUCCESS_DATA)
+
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
+                                   bucket: 'my-bucket',
+                                   org: 'my-org',
+                                   use_ssl: false)
+
+    query = 'from(bucket: params.bucketParam) |> range(start:  duration(v: params.startParam)) |> last()'
+    params = Hash['bucketParam' => 'my-bucket', 'startParam' => '1970-01-01T00:00:00.000000001Z']
+
+    result = client.create_query_api.query(query: query, params: params)
+
+    assert_equal 1, result.length
+    assert_equal 4, result[0].records.length
+
+    record1 = result[0].records[0]
+
+    assert_equal Time.parse('1970-01-01T00:00:10Z').to_datetime.rfc3339(9), record1.time
+    assert_equal 'mem', record1.measurement
+    assert_equal 10, record1.value
+    assert_equal 'free', record1.field
+  end
+
   def test_headers
     stub_request(:post, 'http://localhost:8086/api/v2/query?org=my-org')
       .to_return(body: SUCCESS_DATA)

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.2.0.pre.4244
 platform: ruby
 authors:
 - Jakub Bednar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2022-01-31 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
@@ -188,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Ruby library for InfluxDB 2.