influxdb-client 2.3.0 → 2.4.0.pre.4821

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 316f4772056e8f3b586f03b942c44bf079f84b8db92c08a0cf412fab564cbf9f
-  data.tar.gz: 53af125e89c229f5a71e09c69e5a44fbd73398cb11803a0c1cc40a0be6bf9602
+  metadata.gz: d5ef02d36ae695e1bdaa6cba01ce9f6a383295cabe4af6c532d89a1a9a44577d
+  data.tar.gz: 6e77b330945e1d15f1df2ce5ac387159c3b886a5e8295450b700770b09fdc415
 SHA512:
-  metadata.gz: ac2cbb3aff1dd1738f2b2a888247146d60eb21b673d5553ecac78fc90143ed81fa62671041a0970af4fec765845fef1ac3dd5489fda772f807f1d3ed9618fa23
-  data.tar.gz: eeb63dc4b4371762243e6b67ba4cd7d48da1618cef76ca51d2efb0dc2a8cfaa4225ca731f8ced6c610bd1c6967b9992d4cbbb5900ae7f74f34f4638cda3aa74e
+  metadata.gz: fca02aadc5268810c5a91a76c11acf847e4c594c6fcb1f25e618e40ec69486794e8e7190072f86a3ecb5ace26129a0be21b17fd6f8f206a30c85f55d2fafe1b2
+  data.tar.gz: 44f9dfd7eb9e549533f59c71f866a464c87b57b673188349eaf41c321547c2ba3bbc0ad57e86daf1975d5fc4fd5c7389a113630dd2863990cd3651861d174499

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.4.0 [unreleased]
+
+### Features
+1. [#101](https://github.com/influxdata/influxdb-client-ruby/pull/101): Add `InvocableScriptsApi` to create, update, list, delete and invoke scripts by seamless way
+
 ## 2.3.0 [2022-03-18]
 
 ### Bug Fixes

data/README.md

@@ -8,7 +8,7 @@
 [![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/influxdata/influxdb-client-ruby.svg)](https://github.com/influxdata/influxdb-client-ruby/pulls)
 [![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://www.influxdata.com/slack)
 
-This repository contains the reference Ruby client for the InfluxDB 2.0.
+This repository contains the reference Ruby client for the InfluxDB 2.x.
 
 #### Note: Use this client library with InfluxDB 2.x and InfluxDB 1.8+ ([see details](#influxdb-18-api-compatibility)). For connecting to InfluxDB 1.7 or earlier instances, use the [influxdb-ruby](https://github.com/influxdata/influxdb-ruby) client library.
 
@@ -31,14 +31,14 @@ This repository contains the reference Ruby client for the InfluxDB 2.0.
 
 This section contains links to the client library documentation.
 
-* [Product documentation](https://docs.influxdata.com/influxdb/v2.0/api-guide/client-libraries/), [Getting Started](#installation)
+* [Product documentation](https://docs.influxdata.com/influxdb/latest/api-guide/client-libraries/), [Getting Started](#installation)
 * [Examples](examples)
 * [API Reference](https://influxdata.github.io/influxdb-client-ruby/InfluxDB2.html)
 * [Changelog](CHANGELOG.md)
 
 ## Features
 
-InfluxDB 2.0 client consists of two packages
+InfluxDB 2.x client consists of two packages
 
 - `influxdb-client`
     - Querying data using the Flux language
@@ -46,7 +46,7 @@ InfluxDB 2.0 client consists of two packages
         - batched in chunks on background
         - automatic retries on write failures
 - `influxdb-client-apis`
-    - provides all other InfluxDB 2.0 APIs for managing
+    - provides all other InfluxDB 2.x APIs for managing
         - buckets
         - labels
         - authorizations
@@ -180,7 +180,7 @@ result[0].records.each { |record| puts "#{record.time} #{record.measurement}: #{
 ```
 
 ### 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.
+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.x. In default api uses synchronous write. To enable batching you can use WriteOption.
 
 ```ruby
 client = InfluxDB2::Client.new('https://localhost:8086', 'my-token',
@@ -324,7 +324,7 @@ write_api.write(data: InfluxDB2::Point.new(name: 'h2o')
 
 ### 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.
+The [DeleteApi](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/delete_api.rb) supports deletes [points](https://docs.influxdata.com/influxdb/latest/reference/key-concepts/data-elements/#point) from an InfluxDB bucket.
 
 ```ruby
 client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
@@ -347,16 +347,16 @@ The time range could be specified as:
 
 The client supports following management API:
 
-|  | API docs |
-| --- | --- |
-| [**AuthorizationsApi**](https://influxdata.github.io/influxdb-client-ruby/InfluxDB2/API/AuthorizationsApi.html) | https://docs.influxdata.com/influxdb/v2.0/api/#tag/Authorizations |
-| [**BucketsApi**](https://influxdata.github.io/influxdb-client-ruby/InfluxDB2/API/BucketsApi.html) | https://docs.influxdata.com/influxdb/v2.0/api/#tag/Buckets |
-| [**LabelsApi**](https://influxdata.github.io/influxdb-client-ruby/InfluxDB2/API/LabelsApi.html) | https://docs.influxdata.com/influxdb/v2.0/api/#tag/Labels |
-| [**OrganizationsApi**](https://influxdata.github.io/influxdb-client-ruby/InfluxDB2/API/OrganizationsApi.html) | https://docs.influxdata.com/influxdb/v2.0/api/#tag/Organizations |
-| [**UsersApi**](https://influxdata.github.io/influxdb-client-ruby/InfluxDB2/API/UsersApi.html) | https://docs.influxdata.com/influxdb/v2.0/api/#tag/Users |
+|  | API docs                                                            |
+| --- |---------------------------------------------------------------------|
+| [**AuthorizationsApi**](https://influxdata.github.io/influxdb-client-ruby/InfluxDB2/API/AuthorizationsApi.html) | https://docs.influxdata.com/influxdb/latest/api/#tag/Authorizations |
+| [**BucketsApi**](https://influxdata.github.io/influxdb-client-ruby/InfluxDB2/API/BucketsApi.html) | https://docs.influxdata.com/influxdb/latest/api/#tag/Buckets          |
+| [**LabelsApi**](https://influxdata.github.io/influxdb-client-ruby/InfluxDB2/API/LabelsApi.html) | https://docs.influxdata.com/influxdb/latest/api/#tag/Labels           |
+| [**OrganizationsApi**](https://influxdata.github.io/influxdb-client-ruby/InfluxDB2/API/OrganizationsApi.html) | https://docs.influxdata.com/influxdb/latest/api/#tag/Organizations    |
+| [**UsersApi**](https://influxdata.github.io/influxdb-client-ruby/InfluxDB2/API/UsersApi.html) | https://docs.influxdata.com/influxdb/latest/api/#tag/Users            |
 
 
-The following example demonstrates how to use a InfluxDB 2.0 Management API to create new bucket. For further information see docs and [examples](/examples).
+The following example demonstrates how to use a InfluxDB 2.x Management API to create new bucket. For further information see docs and [examples](/examples).
 
 ```ruby
 #
@@ -427,7 +427,7 @@ client.close!
 
 ### Check the server status 
 
-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/).
+Server availability can be checked using the `client.ping` method. That is equivalent of the [influx ping](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/ping/).
 
 ### Proxy configuration
 
@@ -445,15 +445,15 @@ To overcome this limitation you have to set the client property `redirect_forwar
 
 ### InfluxDB 1.8 API compatibility
 
-[InfluxDB 1.8.0 introduced forward compatibility APIs](https://docs.influxdata.com/influxdb/v1.8/tools/api/#influxdb-2-0-api-compatibility-endpoints) for InfluxDB 2.0. This allow you to easily move from InfluxDB 1.x to InfluxDB 2.0 Cloud or open source.
+[InfluxDB 1.8.0 introduced forward compatibility APIs](https://docs.influxdata.com/influxdb/v1.8/tools/api/#influxdb-2-0-api-compatibility-endpoints) for InfluxDB 2.x. This allow you to easily move from InfluxDB 1.x to InfluxDB 2.x Cloud or open source.
 
 The following forward compatible APIs are available:
 
-| API | Endpoint | Description |
-|:----------|:----------|:----------|
-| [query_api.rb](lib/influxdb2/client/query_api.rb) | [/api/v2/query](https://docs.influxdata.com/influxdb/latest/tools/api/#api-v2-query-http-endpoint) | Query data in InfluxDB 1.8.0+ using the InfluxDB 2.0 API and [Flux](https://docs.influxdata.com/flux/latest/) _(endpoint should be enabled by [`flux-enabled` option](https://docs.influxdata.com/influxdb/latest/administration/config/#flux-enabled-false))_  |
-| [write_api.rb](lib/influxdb2/client/write_api.rb) | [/api/v2/write](https://docs.influxdata.com/influxdb/latest/tools/api/#api-v2-write-http-endpoint) | Write data to InfluxDB 1.8.0+ using the InfluxDB 2.0 API |
-| [health_api.rb](lib/influxdb2/client/health_api.rb) | [/health](https://docs.influxdata.com/influxdb/latest/tools/api/#health-http-endpoint) | Check the health of your InfluxDB instance |    
+| API | Endpoint | Description                                                                                                                                                                                                                                                    |
+|:----------|:----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [query_api.rb](lib/influxdb2/client/query_api.rb) | [/api/v2/query](https://docs.influxdata.com/influxdb/latest/tools/api/#api-v2-query-http-endpoint) | Query data in InfluxDB 1.8.0+ using the InfluxDB 2.x API and [Flux](https://docs.influxdata.com/flux/latest/) _(endpoint should be enabled by [`flux-enabled` option](https://docs.influxdata.com/influxdb/latest/administration/config/#flux-enabled-false))_ |
+| [write_api.rb](lib/influxdb2/client/write_api.rb) | [/api/v2/write](https://docs.influxdata.com/influxdb/latest/tools/api/#api-v2-write-http-endpoint) | Write data to InfluxDB 1.8.0+ using the InfluxDB 2.x API                                                                                                                                                                                                       |
+| [health_api.rb](lib/influxdb2/client/health_api.rb) | [/health](https://docs.influxdata.com/influxdb/latest/tools/api/#health-http-endpoint) | Check the health of your InfluxDB instance                                                                                                                                                                                                                     |    
 
 For detail info see [InfluxDB 1.8 example](examples/influxdb_18_example.rb).
 

data/lib/influxdb-client.rb

@@ -27,6 +27,13 @@ require 'influxdb2/client/query_api'
 require 'influxdb2/client/delete_api'
 require 'influxdb2/client/health_api'
 require 'influxdb2/client/ping_api'
+require 'influxdb2/client/invocable_scripts_api'
 require 'influxdb2/client/point'
 require 'influxdb2/client/flux_table'
 require 'influxdb2/client/write_retry'
+require 'influxdb2/client/models/script'
+require 'influxdb2/client/models/scripts'
+require 'influxdb2/client/models/script_create_request'
+require 'influxdb2/client/models/script_language'
+require 'influxdb2/client/models/script_update_request'
+require 'influxdb2/client/models/script_invocation_params'

data/lib/influxdb2/client/client.rb

@@ -85,6 +85,13 @@ module InfluxDB2
       DeleteApi.new(options: @options)
     end
 
+    # Create an InvocableScripts API instance.
+    #
+    # @return [InvocableScriptsApi] New instance of InvocableScriptsApi.
+    def create_invocable_scripts_api
+      InvocableScriptsApi.new(options: @options)
+    end
+
     # Get the health of an instance.
     #
     # @deprecated Use `ping` instead

data/lib/influxdb2/client/default_api.rb

@@ -63,33 +63,28 @@ module InfluxDB2
       URI.parse(File.join(@options[:url], api_path))
     end
 
-    def _post_json(payload, uri, headers: {})
+    def _request_json(payload, uri, headers: {}, method: Net::HTTP::Post)
       _check_arg_type(:headers, headers, Hash)
-      _post(payload, uri, headers: headers.merge(HEADER_CONTENT_TYPE => 'application/json'))
+      _request(payload, uri, headers: headers.merge(HEADER_CONTENT_TYPE => 'application/json'), method: method)
     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, add_authorization: true, headers: {})
-      _request(payload, uri, limit: limit, add_authorization: add_authorization,
-                             headers: headers, request: Net::HTTP::Post)
+      _request(payload, uri, headers: headers.merge(HEADER_CONTENT_TYPE => 'text/plain'))
     end
 
     def _get(uri, limit: @max_redirect_count, add_authorization: true, headers: {})
       _request(nil, uri, limit: limit, add_authorization: add_authorization,
-                         headers: headers.merge('Accept' => 'application/json'), request: Net::HTTP::Get)
+                         headers: headers.merge('Accept' => 'application/json'), method: Net::HTTP::Get)
     end
 
     def _request(payload, uri, limit: @max_redirect_count, add_authorization: true, headers: {},
-                 request: Net::HTTP::Post)
+                 method: Net::HTTP::Post)
       raise InfluxError.from_message("Too many HTTP redirects. Exceeded limit: #{@max_redirect_count}") if limit.zero?
 
       http = _prepare_http_client(uri)
 
-      request = request.new(uri.request_uri)
+      request = method.new(uri.request_uri)
       request['Authorization'] = "Token #{@options[:token]}" if add_authorization
       request['User-Agent'] = "influxdb-client-ruby/#{InfluxDB2::VERSION}"
       headers.each { |k, v| request[k] = v }
@@ -111,8 +106,8 @@ module InfluxDB2
 
           redirect_forward_authorization ||= (uri_redirect.host == uri.host) && (uri_redirect.port == uri.port)
 
-          _post(payload, uri_redirect, limit: limit - 1, add_authorization: redirect_forward_authorization,
-                                       headers: headers)
+          _request(payload, uri_redirect, limit: limit - 1, add_authorization: redirect_forward_authorization,
+                                          headers: headers, method: method)
         else
           raise InfluxError.from_response(response)
         end

data/lib/influxdb2/client/delete_api.rb

@@ -64,7 +64,7 @@ module InfluxDB2
       uri = _parse_uri('/api/v2/delete')
       uri.query = URI.encode_www_form(org: org_param, bucket: bucket_param)
 
-      _post_json(delete_request.to_body.to_json, uri)
+      _request_json(delete_request.to_body.to_json, uri)
     end
 
     def _to_rfc3339(time)

data/lib/influxdb2/client/flux_csv_parser.rb

@@ -41,11 +41,23 @@ module InfluxDB2
     end
   end
 
+  # The configuration for expected amount of metadata response from InfluxDB.
+  #
+  class FluxResponseMode
+    # full information about types, default values and groups
+    FULL = 'full'.freeze
+    # useful for Invocable scripts
+    ONLY_NAMES = 'only_names'.freeze
+  end
+
   # This class us used to construct FluxResult from CSV.
   #
   class FluxCsvParser
     include Enumerable
-    def initialize(response, stream: false)
+    # @param [String|HTTPResponse] data to be parse
+    # @param [Boolean] stream set to true if the response is stream otherwise (`string`) set `false`
+    # @param [str] response_mode set the amount of metadata expected in response
+    def initialize(response, stream: false, response_mode: InfluxDB2::FluxResponseMode::FULL)
       @response = response
       @stream = stream
       @tables = {}
@@ -58,6 +70,7 @@ module InfluxDB2
       @parsing_state_error = false
 
       @closed = false
+      @response_mode = response_mode
     end
 
     attr_reader :tables, :closed
@@ -112,7 +125,9 @@ module InfluxDB2
       token = csv[0]
 
       # start new table
-      if (ANNOTATIONS.include? token) && !@start_new_table
+      if ((ANNOTATIONS.include? token) && !@start_new_table) ||
+         (@response_mode == InfluxDB2::FluxResponseMode::ONLY_NAMES && @table.nil?)
+
         # Return already parsed DataFrame
         @start_new_table = true
         @table = InfluxDB2::FluxTable.new
@@ -177,6 +192,10 @@ module InfluxDB2
     def _parse_values(csv)
       # parse column names
       if @start_new_table
+        if @response_mode == InfluxDB2::FluxResponseMode::ONLY_NAMES && @table.columns.empty?
+          _add_data_types(@table, csv.map { |_| 'string' })
+          @groups = csv.map { |_| 'false' }
+        end
         _add_groups(@table, @groups)
         _add_column_names_and_tags(@table, csv)
         @start_new_table = false

data/lib/influxdb2/client/health_api.rb

@@ -20,7 +20,7 @@
 require_relative 'models/health_check'
 
 module InfluxDB2
-  # The client of the InfluxDB 2.0 that implement Health HTTP API endpoint.
+  # The client of the InfluxDB 2.x that implement Health HTTP API endpoint.
   #
   # @deprecated Use `PingApi` instead
   class HealthApi < DefaultApi

data/lib/influxdb2/client/invocable_scripts_api.rb

@@ -0,0 +1,147 @@
+# 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/script'
+
+module InfluxDB2
+  # Use API invokable scripts to create custom InfluxDB API endpoints that query, process, and shape data.
+  #
+  # API invokable scripts let you assign scripts to API endpoints and then execute them as standard REST operations
+  # in InfluxDB Cloud.
+  class InvocableScriptsApi < DefaultApi
+    # @param [Hash] options The options to be used by the client.
+    def initialize(options:)
+      super(options: options)
+    end
+
+    # Create a script.
+    #
+    # @param script_create_request [ScriptCreateRequest] The script to create.
+    #
+    # @return [Script] The created script.
+    def create_script(script_create_request)
+      uri = _parse_uri('/api/v2/scripts')
+
+      response = _request_json(script_create_request.to_body.to_json, uri, headers: { 'Accept' => 'application/json' })
+
+      _to_object(response, Script)
+    end
+
+    # Update a script.
+    #
+    # @param script_id [String] The ID of the script to update. (required)
+    # @param update_request [ScriptUpdateRequest] Script updates to apply (required)
+    #
+    # @return [Script] The updated script.
+    def update_script(script_id, update_request)
+      uri = _parse_uri_script(script_id)
+
+      response = _request_json(update_request.to_body.to_json, uri, headers: { 'Accept' => 'application/json' },
+                                                                    method: Net::HTTP::Patch)
+      _to_object(response, Script)
+    end
+
+    # Delete a script.
+    #
+    # @param script_id [String] The ID of the script to delete. (required)
+    def delete_script(script_id)
+      uri = _parse_uri_script(script_id)
+
+      _request_json('', uri, headers: { 'Accept' => 'application/json' },
+                             method: Net::HTTP::Delete)
+    end
+
+    # List scripts.
+    #
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit The number of scripts to return.
+    # @option opts [Integer] :offset The offset for pagination.
+    #
+    # @return [Script]
+    def find_scripts(opts = {})
+      limit = !opts[:limit].nil? ? opts[:limit] : []
+      offset = !opts[:offset].nil? ? opts[:offset] : []
+      uri = _parse_uri('/api/v2/scripts')
+      uri.query = URI.encode_www_form(limit: limit, offset: offset)
+
+      response = _request_json('', uri, headers: { 'Accept' => 'application/json' },
+                                        method: Net::HTTP::Get)
+
+      _to_object(response, Scripts).scripts
+    end
+
+    # Invoke synchronously a script and return result as a [String].
+    #
+    # @param script_id [String] The ID of the script to invoke. (required)
+    # @param [Enumerable] params represent key/value pairs parameters to be injected into script
+    #
+    # @return [String] result of query
+    def invoke_script_raw(script_id, params: nil)
+      _invoke_script(script_id, params: params).read_body
+    end
+
+    # Invoke synchronously a script and return result as a [FluxTable].
+    #
+    # @param script_id [String] The ID of the script to invoke. (required)
+    # @param [Enumerable] params represent key/value pairs parameters to be injected into script
+    #
+    # @return [Array] list of FluxTables which are matched the query
+    def invoke_script(script_id, params: nil)
+      response = invoke_script_raw(script_id, params: params)
+      parser = InfluxDB2::FluxCsvParser.new(response, stream: false,
+                                                      response_mode: InfluxDB2::FluxResponseMode::ONLY_NAMES)
+
+      parser.parse
+      parser.tables
+    end
+
+    # Invoke synchronously a script and return result as a stream of FluxRecord.
+    #
+    # @param script_id [String] The ID of the script to invoke. (required)
+    # @param [Enumerable] params represent key/value pairs parameters to be injected into script
+    #
+    # @return stream of Flux Records
+    def invoke_script_stream(script_id, params: nil)
+      response = _invoke_script(script_id, params: params)
+
+      InfluxDB2::FluxCsvParser.new(response, stream: true, response_mode: InfluxDB2::FluxResponseMode::ONLY_NAMES)
+    end
+
+    private
+
+    def _parse_uri_script(script_id, path = nil)
+      _parse_uri('/api/v2/scripts/' + URI.encode_www_form_component(script_id) + (path.nil? ? '' : "/#{path}"))
+    end
+
+    def _to_object(response, model)
+      body = response.body
+
+      data = JSON.parse("[#{body}]", symbolize_names: true)[0]
+      model.build_from_hash(data)
+    end
+
+    def _invoke_script(script_id, params: nil)
+      uri = _parse_uri_script(script_id, 'invoke')
+
+      script_invocation_params = InfluxDB2::ScriptInvocationParams.new(params: params)
+      _request_json(script_invocation_params.to_body.to_json, uri, headers: { 'Accept' => 'application/json' })
+    end
+  end
+end