influxdb-client 1.6.0.pre.916 → 1.7.0.pre.1015

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c77af86f0b9b7749ddbf9d5111c76839f492f587ecb38d104a817af22048a2f
-  data.tar.gz: 290a21b26ce9eeb84ee746ff29bc7100c825b37548c795e8f398c8dafbfa1784
+  metadata.gz: 8f7d3acebd47909037578d03e9c41a563328fc8a112019ef705417f4ce0b5dc7
+  data.tar.gz: f5fd4db9b000fb952eedd3ef7cbdc93fec3b5806101d819fd5c9febc33b95a68
 SHA512:
-  metadata.gz: f979e9911c370f77d376dc99035055c35241588007f9d30864fb9bd5db3be87b257a358a6ae6dbacdee68e5a5b95da871f2556e572078fdf939f02f7a6479a69
-  data.tar.gz: 5d40d9c3981bed04fab6ac9d45d881e8367abe80449a42294bf6eeec775ba830beeba8edc331910d68f286c6db574fcc921924bae5c9035b9d159c19fcc380bd
+  metadata.gz: 1da2d03a086ad92b8c7d82a29cdff3e228dd9140808df9b3ae1ed961670535ad8125d3345202b5dc6dad0f7d370057f24e8607f9bfc6479d756bbea61e04cebd
+  data.tar.gz: 1fe5947810dff9c7d97ec8eefc4d2d54d8e67db663c42e2ae606747f444bd96b9083beb1439e27fb2d2fd1c1fc6bae055d3ffd9816f0819b85039eb47b37f7a8

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+<!--
+
+Thank you for reporting a bug. 
+
+* Please add a :+1: or comment on a similar existing bug report instead of opening a new one.
+    * https://github.com/influxdata/influxdb-client-ruby/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+is%3Aclosed+sort%3Aupdated-desc+label%3Abug+
+* Please check whether the bug can be reproduced with the latest release.
+* The fastest way to fix a bug is to open a Pull Request.
+    * https://github.com/influxdata/influxdb-client-ruby/pulls
+
+-->
+
+__Steps to reproduce:__
+List the minimal actions needed to reproduce the behavior.
+
+1. ...
+2. ...
+3. ...
+
+__Expected behavior:__
+Describe what you expected to happen.
+
+__Actual behavior:__
+Describe What actually happened.
+
+__Specifications:__
+ - Client Version:
+ - InfluxDB Version:
+ - Platform:

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,28 @@
+---
+name: Feature request
+about: Opening a feature request kicks off a discussion
+---
+
+<!--
+
+Thank you for suggesting an idea to improve this client. 
+
+* Please add a :+1: or comment on a similar existing feature request instead of opening a new one.
+    * https://github.com/influxdata/influxdb-client-ruby/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+is%3Aclosed+sort%3Aupdated-desc+label%3A%22enhancement%22+
+
+-->
+
+__Proposal:__
+Short summary of the feature.
+
+__Current behavior:__
+Describe what currently happens.
+
+__Desired behavior:__
+Describe what you want.
+
+__Alternatives considered:__
+Describe other solutions or features you considered.
+
+__Use case:__
+Why is this important (helps with prioritizing requests)?

data/.github/PULL_REQUEST_TEMPLATE

@@ -1,8 +1,16 @@
 Closes #
 
+## Proposed Changes
+
 _Briefly describe your proposed changes:_
 
+## Checklist
+
+<!-- Checkboxes below this note can be erased if not applicable to your Pull Request. -->
+
 - [ ] CHANGELOG.md updated
 - [ ] Rebased/mergeable
-- [ ] Tests pass
-- [ ] Sign [CLA](https://influxdata.com/community/cla/) (if not already signed)
+- [ ] A test has been added if appropriate
+- [ ] `rake test` completes successfully
+- [ ] Commit messages are in [semantic format](https://seesparkbox.com/foundry/semantic_commit_messages)
+- [ ] Sign [CLA](https://influxdata.com/community/cla/) (if not already signed)

data/.github/semantic.yml

@@ -0,0 +1,3 @@
+# docs: https://github.com/probot/semantic-pull-requests#configuration
+# Always validate the PR title AND all the commits
+titleAndCommits: true

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## 1.6.0 [unreleased]
+## 1.7.0 [unreleased]
+
+## 1.6.0 [2020-07-17]
+
+### Bug Fixes
+1. [#42](https://github.com/influxdata/influxdb-client-ruby/pull/42): Fixed serialization of `\n`, `\r` and `\t` to Line Protocol, `=` is valid sign for measurement name  
+1. [#44](https://github.com/influxdata/influxdb-client-ruby/pull/44): Fixed supporting of Ruby 2.2
 
 ## 1.5.0 [2020-06-19]
 

data/README.md

@@ -23,7 +23,7 @@ The client can be installed manually or with bundler.
 To install the client gem manually:
 
 ```
-gem install influxdb-client -v 1.5.0
+gem install influxdb-client -v 1.6.0
 ```
 
 ## Usage
@@ -122,7 +122,7 @@ The writes are processed in batches which are configurable by `WriteOptions`:
 | Property | Description | Default Value |
 | --- | --- | --- |
 | batchSize | the number of data point to collect in batch | 1000 |
-| flushInterval | the number of milliseconds before the batch is written | 1000 |
+| flush_interval | the number of milliseconds before the batch is written | 1000 |
 | retry_interval | the number of milliseconds to retry unsuccessful write. The retry interval is used when the InfluxDB server does not specify "Retry-After" header. | 1000 |
 | jitter_interval | the number of milliseconds to increase the batch flush interval by a random amount | 0 |
 

data/lib/influxdb2/client/point.rb

@@ -21,6 +21,8 @@
 module InfluxDB2
   DEFAULT_WRITE_PRECISION = WritePrecision::NANOSECOND
   ESCAPE_KEY_LIST = ['\\'.freeze, ','.freeze, ' '.freeze, '='.freeze].freeze
+  ESCAPE_MEASUREMENT_LIST = ['\\'.freeze, ','.freeze, ' '.freeze].freeze
+  REPLACE_KEY_LIST = { "\n".freeze => '\n'.freeze, "\r".freeze => '\r'.freeze, "\t".freeze => '\t'.freeze }.freeze
   ESCAPE_VALUE_LIST = ['\\'.freeze, '"'.freeze].freeze
 
   # Point defines the values that will be written to the database.
@@ -113,7 +115,7 @@ module InfluxDB2
     # @return a string representation of the point
     def to_line_protocol
       line_protocol = ''
-      measurement = _escape_key(@name || '')
+      measurement = _escape_key(@name || '', ESCAPE_MEASUREMENT_LIST)
 
       line_protocol << measurement
 
@@ -161,11 +163,14 @@ module InfluxDB2
       end.reject(&:nil?).join(','.freeze)
     end
 
-    def _escape_key(value)
+    def _escape_key(value, escape_list = ESCAPE_KEY_LIST)
       result = value.dup
-      ESCAPE_KEY_LIST.each do |ch|
+      escape_list.each do |ch|
         result = result.gsub(ch) { "\\#{ch}" }
       end
+      REPLACE_KEY_LIST.keys.each do |ch|
+        result = result.gsub(ch) { REPLACE_KEY_LIST[ch] }
+      end
       result
     end
 

data/lib/influxdb2/client/version.rb

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

data/lib/influxdb2/client/worker.rb

@@ -99,7 +99,7 @@ module InfluxDB2
     end
 
     def _write_raw(key, points)
-      if @write_options.jitter_interval.positive?
+      if @write_options.jitter_interval > 0
         jitter_delay = (@write_options.jitter_interval.to_f / 1_000) * rand
         sleep jitter_delay
       end

data/test/influxdb/point_test.rb

@@ -218,4 +218,25 @@ class PointTest < MiniTest::Test
 
     assert_equal 'h2o level=2i 123', point.to_line_protocol
   end
+
+  def test_tag_escaping
+    point = InfluxDB2::Point.new(name: "h\n2\ro\t_data")
+                            .add_tag("new\nline", "new\nline")
+                            .add_tag("carriage\rreturn", "carriage\nreturn")
+                            .add_tag("t\tab", "t\tab")
+                            .add_field('level', 2)
+
+    puts point.to_line_protocol
+
+    assert_equal 'h\\n2\\ro\\t_data,carriage\\rreturn=carriage\\nreturn,new\\nline=new\\nline,t\\tab=t\\tab level=2i',
+                 point.to_line_protocol
+  end
+
+  def test_equal_sign_escaping
+    point = InfluxDB2::Point.new(name: 'h=2o')
+                            .add_tag('l=ocation', 'e=urope')
+                            .add_field('l=evel', 2)
+
+    assert_equal 'h=2o,l\\=ocation=e\\=urope l\\=evel=2i', point.to_line_protocol
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-client
 version: !ruby/object:Gem::Version
-  version: 1.6.0.pre.916
+  version: 1.7.0.pre.1015
 platform: ruby
 authors:
 - Jakub Bednar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,7 +132,10 @@ files:
 - ".circleci/config.yml"
 - ".circleci/setup-rubygems.sh"
 - ".codecov.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE"
+- ".github/semantic.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md