influxdb-client 1.17.0 → 2.1.0.pre.3380

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b45b4e1aba281b91906e7aec477b1b0e4d96d8b19619f523646f82e84528b7a
-  data.tar.gz: bdc517dfa75b6605c509f89f95df9400c6a009f129b1d5f9bafe5757ba4d6f60
+  metadata.gz: 594977f22ac698a141e1123cbdb730dc87b16933f2f28d03098eec6480791ff1
+  data.tar.gz: 20ef07b3c2e19e50c8ba031d768c86747e3f3c13ca80b1bf416cdbe9e0f066d0
 SHA512:
-  metadata.gz: c3913078eded2b90435abc49a6fd85ccdfac827c01c01d5ae38d37a0454e5b37a1315a7228221eb9966ace146df3fa3cb7ecb60af76e4fc0edbe5a6b995f8ebe
-  data.tar.gz: 18c86b9c78f939ba131bd23e40070104794659b1fd000b4fccc3bb892ce19b951f5d6ffc71beb56c11c96b56c0787233b06d8e3ed9e320ce2b1b4f8532be6147
+  metadata.gz: a0adda077801b92b62e22a735f4c0bcb3494716d0f0694191c4da50b51927fea24f37c3d67c57df12354b10baf652e41bca9baca1cd7c59aaafe138a5a786b51
+  data.tar.gz: 6c6c84ba4068dd6189244de3fe3921f6baa1642d75c5dadd4009e4e7cb7924e641b6ad194766d7486e375b84cccb2a780ba0fd5585c32eea6320b2c2cc3c4e2e

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 2.1.0 [unreleased]
+
+## 2.0.0 [2021-09-13]
+
+### Bug Fixes
+1. [#90](https://github.com/influxdata/influxdb-client-ruby/pull/90): Fix parse text plain 503 error response  
+1. [#89](https://github.com/influxdata/influxdb-client-ruby/pull/89): Correct redirect location
+
+### Breaking Changes
+Due to a security reason `Authorization` header is not forwarded when redirect leads to a different domain.
+To overcome this limitation you have to set the client property `redirect_forward_authorization` to `true`.
+
+### Features
+1. [#89](https://github.com/influxdata/influxdb-client-ruby/pull/89): `Authorization` header is not forwarded when redirect leads to a different domain
+ 
 ## 1.17.0 [2021-08-20]
 
 ### Bug Fixes

data/README.md

@@ -23,6 +23,7 @@ This repository contains the reference Ruby client for the InfluxDB 2.0.
     - [Management API](#management-api)
 - [Advanced Usage](#advanced-usage)
     - [Default Tags](#default-tags)
+    - [Proxy configuration](#proxy-configuration)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -63,13 +64,13 @@ The client can be installed manually or with bundler.
 To install the client gem manually:
 
 ```
-gem install influxdb-client -v 1.17.0
+gem install influxdb-client -v 2.0.0
 ```
 
 For management API:
 
 ```
-gem install influxdb-client-apis -v 1.17.0
+gem install influxdb-client-apis -v 2.0.0
 ```
 
 ## Usage
@@ -93,6 +94,7 @@ client = InfluxDB2::Client.new('https://localhost:8086', 'my-token')
 | write_timeout | Number of seconds to wait for one block of data to be written | Integer | 10 |
 | read_timeout | Number of seconds to wait for one block of data to be read | Integer | 10 |
 | max_redirect_count | Maximal number of followed HTTP redirects | Integer | 10 |
+| redirect_forward_authorization | Pass Authorization header to different domain during HTTP redirect. | bool | false |
 | use_ssl | Turn on/off SSL for HTTP communication | bool | true |
 | verify_mode | Sets the flags for the certification verification at beginning of SSL/TLS session. | `OpenSSL::SSL::VERIFY_NONE` or `OpenSSL::SSL::VERIFY_PEER` | none |
 
@@ -400,6 +402,20 @@ client.close!
 
 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/).
 
+### Proxy configuration
+
+You can configure the client to tunnel requests through an HTTP proxy. To configure the proxy use a `http_proxy` environment variable. 
+
+```ruby
+ENV['HTTP_PROXY'] = 'http://my-user:my-password@my-proxy:8099'
+```
+
+Client automatically follows HTTP redirects. The default redirect policy is to follow up to 10 consecutive requests.
+You can configure redirect counts by the client property: `max_redirect_count`. 
+
+Due to a security reason `Authorization` header is not forwarded when redirect leads to a different domain. 
+To overcome this limitation you have to set the client property `redirect_forward_authorization` to `true`.
+
 ### 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.

data/lib/influxdb2/client/client.rb

@@ -42,6 +42,8 @@ module InfluxDB2
     # @option options [Integer] :write_timeout Number of seconds to wait for one block of data to be written
     # @option options [Integer] :read_timeout Number of seconds to wait for one block of data to be read
     # @option options [Integer] :max_redirect_count Maximal number of followed HTTP redirects
+    # @option options [bool] :redirect_forward_authorization Pass Authorization header to different domain
+    #   during HTTP redirect.
     # @option options [bool] :use_ssl Turn on/off SSL for HTTP communication
     # @option options [Integer] :verify_mode Sets the flags for the certification verification
     #   at beginning of SSL/TLS session. Could be one of `OpenSSL::SSL::VERIFY_NONE` or `OpenSSL::SSL::VERIFY_PEER`.

data/lib/influxdb2/client/default_api.rb

@@ -73,21 +73,24 @@ module InfluxDB2
       _post(payload, uri, headers: headers.merge(HEADER_CONTENT_TYPE => 'text/plain'))
     end
 
-    def _post(payload, uri, limit: @max_redirect_count, headers: {})
-      _request(payload, uri, limit: limit, headers: headers, request: Net::HTTP::Post)
+    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)
     end
 
-    def _get(uri, limit: @max_redirect_count, headers: {})
-      _request(nil, uri, limit: limit, headers: headers.merge('Accept' => 'application/json'), request: Net::HTTP::Get)
+    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)
     end
 
-    def _request(payload, uri, limit: @max_redirect_count, headers: {}, request: Net::HTTP::Post)
+    def _request(payload, uri, limit: @max_redirect_count, add_authorization: true, headers: {},
+                 request: 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['Authorization'] = "Token #{@options[:token]}"
+      request['Authorization'] = "Token #{@options[:token]}" if add_authorization
       request['User-Agent'] = "influxdb-client-ruby/#{InfluxDB2::VERSION}"
       headers.each { |k, v| request[k] = v }
 
@@ -100,7 +103,16 @@ module InfluxDB2
           response
         when Net::HTTPRedirection then
           location = response['location']
-          _post(payload, URI.parse(location), limit: limit - 1, headers: headers)
+          redirect_forward_authorization = @options[:redirect_forward_authorization] || false
+
+          uri_redirect = URI.parse(location)
+          uri_redirect.query = uri.query
+          uri_redirect.path = File.join(uri_redirect.path, uri.path)
+
+          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)
         else
           raise InfluxError.from_response(response)
         end

data/lib/influxdb2/client/influx_error.rb

@@ -35,6 +35,9 @@ module InfluxDB2
       obj = new(message: json['message'] || '', code: response.code, reference: json['code'] || '',
                 retry_after: response['Retry-After'] || '')
       obj
+    rescue JSON::ParserError
+      new(message: response.body || '', code: response.code, reference: '',
+          retry_after: response['Retry-After'] || '')
     end
 
     def self.from_message(message)

data/lib/influxdb2/client/version.rb

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

data/test/influxdb/redirect_test.rb

@@ -0,0 +1,145 @@
+# 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 'test_helper'
+
+class WriteApiTest < MiniTest::Test
+  def setup
+    WebMock.disable_net_connect!
+  end
+
+  def test_redirect_same
+    stub_request(:any, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 307, headers:
+        { 'location' => 'http://localhost:8086' })
+      .then.to_return(status: 204)
+    stub_request(:any, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
+                                   bucket: 'my-bucket',
+                                   org: 'my-org',
+                                   precision: InfluxDB2::WritePrecision::NANOSECOND,
+                                   use_ssl: false)
+
+    client.create_write_api.write(data: 'h2o,location=west value=33i 15')
+
+    headers = {
+      'Authorization' => 'Token my-token',
+      'User-Agent' => "influxdb-client-ruby/#{InfluxDB2::VERSION}",
+      'Content-Type' => 'text/plain'
+    }
+
+    assert_requested(:post, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'h2o,location=west value=33i 15', headers: headers)
+  end
+
+  def test_redirect_301
+    stub_request(:any, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 301, headers:
+        { 'location' => 'http://localhost:9090/' })
+      .then.to_return(status: 204)
+    stub_request(:any, 'http://localhost:9090/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
+                                   bucket: 'my-bucket',
+                                   org: 'my-org',
+                                   precision: InfluxDB2::WritePrecision::NANOSECOND,
+                                   use_ssl: false)
+
+    client.create_write_api.write(data: 'h2o,location=west value=33i 15')
+
+    headers = {
+      'Authorization' => 'Token my-token',
+      'User-Agent' => "influxdb-client-ruby/#{InfluxDB2::VERSION}",
+      'Content-Type' => 'text/plain'
+    }
+
+    assert_requested(:post, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'h2o,location=west value=33i 15', headers: headers)
+
+    assert_not_requested(:post, 'http://localhost:9090/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                         times: 1, body: 'h2o,location=west value=33i 15', headers: headers)
+
+    assert_requested(:post, 'http://localhost:9090/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'h2o,location=west value=33i 15')
+  end
+
+  def test_redirect_301_allow
+    stub_request(:any, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 301, headers:
+        { 'location' => 'http://localhost:9090/' })
+      .then.to_return(status: 204)
+    stub_request(:any, 'http://localhost:9090/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
+                                   bucket: 'my-bucket',
+                                   org: 'my-org',
+                                   precision: InfluxDB2::WritePrecision::NANOSECOND,
+                                   use_ssl: false,
+                                   redirect_forward_authorization: true)
+
+    client.create_write_api.write(data: 'h2o,location=west value=33i 15')
+
+    headers = {
+      'Authorization' => 'Token my-token',
+      'User-Agent' => "influxdb-client-ruby/#{InfluxDB2::VERSION}",
+      'Content-Type' => 'text/plain'
+    }
+
+    assert_requested(:post, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'h2o,location=west value=33i 15', headers: headers)
+
+    assert_requested(:post, 'http://localhost:9090/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'h2o,location=west value=33i 15', headers: headers)
+  end
+
+  def test_redirect_different_path
+    stub_request(:any, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 301, headers:
+        { 'location' => 'http://localhost:8086/influxdb/' })
+      .then.to_return(status: 204)
+    stub_request(:any, 'http://localhost:8086/influxdb/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
+                                   bucket: 'my-bucket',
+                                   org: 'my-org',
+                                   precision: InfluxDB2::WritePrecision::NANOSECOND,
+                                   use_ssl: false,
+                                   redirect_forward_authorization: true)
+
+    client.create_write_api.write(data: 'h2o,location=west value=33i 15')
+
+    headers = {
+      'Authorization' => 'Token my-token',
+      'User-Agent' => "influxdb-client-ruby/#{InfluxDB2::VERSION}",
+      'Content-Type' => 'text/plain'
+    }
+
+    assert_requested(:post, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'h2o,location=west value=33i 15', headers: headers)
+
+    assert_requested(:post, 'http://localhost:8086/influxdb/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'h2o,location=west value=33i 15', headers: headers)
+  end
+end

data/test/influxdb/write_api_batching_test.rb

@@ -210,11 +210,6 @@ class WriteApiBatchingTest < MiniTest::Test
     @write_client.write(data: ['h2o_feet,location=coyote_creek water_level=1.0 1',
                                'h2o_feet,location=coyote_creek water_level=2.0 2'])
 
-    sleep(0.05)
-
-    assert_requested(:post, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
-                     times: 0, body: request)
-
     sleep(2)
 
     assert_requested(:post, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
@@ -617,4 +612,28 @@ class WriteApiRetryStrategyTest < MiniTest::Test
     assert_gte backoff, 1_600
     assert_lte backoff, 2_000
   end
+
+  def test_write_error_plain_retry
+    error_body = 'Service Unavailable'
+    stub_request(:any, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 503, headers: { 'content-type' => 'text/plain', 'Retry-After' => '2' }, body: error_body)
+      .to_return(status: 503, headers: { 'content-type' => 'text/plain' }, body: error_body).to_return(status: 204)
+
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
+                                   bucket: 'my-bucket',
+                                   org: 'my-org',
+                                   precision: InfluxDB2::WritePrecision::NANOSECOND,
+                                   use_ssl: false)
+
+    @write_options = InfluxDB2::WriteOptions.new(write_type: InfluxDB2::WriteType::BATCHING,
+                                                 batch_size: 1, flush_interval: 1_000, retry_interval: 1_000)
+
+    write_api = client.create_write_api(write_options: @write_options)
+    request = 'h2o,location=west value=33i 15'
+    write_api.write(data: request)
+
+    sleep(10)
+    assert_requested(:post, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 3, body: request)
+  end
 end

data/test/influxdb/write_api_test.rb

@@ -201,7 +201,7 @@ class WriteApiTest < MiniTest::Test
   def test_follow_redirect
     stub_request(:any, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
       .to_return(status: 307, headers:
-          { 'location' => 'http://localhost:9090/api/v2/write?bucket=my-bucket&org=my-org&precision=ns' })
+          { 'location' => 'http://localhost:9090/' })
       .then.to_return(status: 204)
     stub_request(:any, 'http://localhost:9090/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
       .to_return(status: 204)
@@ -223,7 +223,7 @@ class WriteApiTest < MiniTest::Test
   def test_follow_redirect_max
     stub_request(:any, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
       .to_return(status: 307, headers:
-          { 'location' => 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns' })
+          { 'location' => 'http://localhost:8086/' })
 
     client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
                                    bucket: 'my-bucket',
@@ -384,4 +384,25 @@ class WriteApiDefaultTagsTest < MiniTest::Test
     assert_requested(:post, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
                      times: 1, body: expected)
   end
+
+  def test_write_error_plain
+    error_body = 'Service Unavailable'
+    stub_request(:any, 'http://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 503, headers: { 'content-type' => 'text/plain' },
+                 body: error_body)
+
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
+                                   bucket: 'my-bucket',
+                                   org: 'my-org',
+                                   precision: InfluxDB2::WritePrecision::NANOSECOND,
+                                   use_ssl: false)
+
+    error = assert_raises InfluxDB2::InfluxError do
+      write_api = client.create_write_api
+      write_api.write(data: 'h2o,location=west value=33i 15')
+    end
+
+    assert_equal '503', error.code
+    assert_equal 'Service Unavailable', error.message
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-client
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 2.1.0.pre.3380
 platform: ruby
 authors:
 - Jakub Bednar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-20 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -161,6 +161,7 @@ files:
 - test/influxdb/query_api_integration_test.rb
 - test/influxdb/query_api_stream_test.rb
 - test/influxdb/query_api_test.rb
+- test/influxdb/redirect_test.rb
 - test/influxdb/write_api_batching_test.rb
 - test/influxdb/write_api_integration_test.rb
 - test/influxdb/write_api_test.rb
@@ -183,9 +184,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.1
 signing_key: 
@@ -201,6 +202,7 @@ test_files:
 - test/influxdb/query_api_integration_test.rb
 - test/influxdb/query_api_stream_test.rb
 - test/influxdb/query_api_test.rb
+- test/influxdb/redirect_test.rb
 - test/influxdb/write_api_batching_test.rb
 - test/influxdb/write_api_integration_test.rb
 - test/influxdb/write_api_test.rb