influxdb-client 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c567a9747fbb62687569311a2a23d75115eab950713766a8a7e8ac0a65d8a7b
+  data.tar.gz: 1fdb87086e8f18ff65d2da79a51d34c397887bc6ad0ae87dd3904b3cbb1787e0
+SHA512:
+  metadata.gz: bbc770f809525bd1799e1698d4c8214893a4364f9563fcb972e47f5446720cbbfda6e07acdb0c253b2cad0c6d86decda03fbdcb8ac5639f3428a4362f2f59819
+  data.tar.gz: 3469d334c5fe3bade7cca71291db812f617a56231a8a6a5abe309b2ecb97a381a6f547df81699da7ba0a8c67b20742a620cba020b2bed366802a259463881df0

data/.circleci/config.yml

@@ -0,0 +1,157 @@
+#
+# 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.
+#
+
+version: 2.1
+
+commands:
+  influxdb-onboarding:
+    steps:
+      - run:
+          name: "Post onBoarding request to InfluxDB 2"
+          command: ./bin/influxdb-onboarding.sh
+  prepare:
+    description: "Prepare environment to tests"
+    steps:
+      - checkout
+      - influxdb-onboarding
+  test:
+    parameters:
+      ruby-image:
+        type: string
+    steps:
+      - restore_cache:
+          name: Restoring Gem Cache
+          keys:
+            - &cache-key gem-cache-{{ checksum "influxdb-client.gemspec" }}-<< parameters.ruby-image >>
+            - gem-cache-{{ checksum "influxdb-client.gemspec" }}
+            - gem-cache-
+      - run:
+          name: Install dependencies
+          command: |
+            gem install bundler
+            bundle config set path 'vendor/bundle'
+            bundle install --jobs=4 --retry=3
+      - run:
+          name: Static code analyze
+          command: |
+            bundle exec rake rubocop
+      - run:
+          name: Run tests
+          command: |
+            export MINITEST_REPORTER=JUnitReporter
+            bundle exec rake test
+      - save_cache:
+          name: Saving Gem Cache
+          key: *cache-key
+          paths:
+            - ./vendor/bundle
+          when: always
+  storing-test-results:
+    steps:
+      - store_test_results:
+          path: test/reports
+
+jobs:
+  tests-ruby:
+    parameters:
+      ruby-image:
+        type: string
+        default: &default-ruby-image "circleci/ruby:2.6-stretch"
+      influxdb-image:
+        type: string
+        default: &default-influxdb-image "influxdb:2.0.0-beta"
+    docker:
+      - image: << parameters.ruby-image >>
+      - image: &influx-image quay.io/influxdb/<< parameters.influxdb-image >>
+    steps:
+      - prepare
+      - test:
+          ruby-image: << parameters.ruby-image >>
+      - storing-test-results
+
+  deploy-preview:
+    parameters:
+      influxdb-image:
+        type: string
+        default: *default-influxdb-image
+    docker:
+      - image: *default-ruby-image
+      - image: *influx-image
+    steps:
+      - run:
+          name: Early return if this build is from a forked repository
+          command: |
+            if [[ $CIRCLE_PROJECT_USERNAME != "influxdata" ]]; then
+              echo "Nothing to do for forked repositories, so marking this step successful"
+              circleci step halt
+            fi
+      - checkout
+      - run:
+          name: Setup Rubygems
+          command: bash .circleci/setup-rubygems.sh
+      - run:
+          name: Build a Gem bundle
+          command: |
+            gem build influxdb-client.gemspec
+      - run:
+          name: Deploy pre-release into https://rubygems.org
+          command: |
+            gem push influxdb-client-*.pre.$CIRCLE_BUILD_NUM.gem
+workflows:
+  version: 2
+  build:
+    jobs:
+      - tests-ruby:
+          name: ruby-2.7
+          ruby-image: "circleci/ruby:2.7-buster"
+      - tests-ruby:
+          name: ruby-2.6
+      - tests-ruby:
+          name: ruby-2.6-nightly
+          influxdb-image: "influx:nightly"
+      - tests-ruby:
+          name: ruby-2.5
+          ruby-image: "circleci/ruby:2.5-stretch"
+      - tests-ruby:
+          name: ruby-2.4
+          ruby-image: "circleci/ruby:2.4-stretch"
+      - deploy-preview:
+          requires:
+            - ruby-2.7
+            - ruby-2.6
+            - ruby-2.6-nightly
+            - ruby-2.5
+            - ruby-2.4
+          filters:
+            branches:
+              only: master
+
+  nightly:
+    triggers:
+      - schedule:
+          cron: "0 0 * * *"
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - tests-ruby

data/.circleci/setup-rubygems.sh

@@ -0,0 +1,3 @@
+mkdir ~/.gem || true
+echo -e "---\r\n:rubygems_api_key: $GEM_HOST_API_KEY" > ~/.gem/credentials
+chmod 0600 ~/.gem/credentials

data/.codecov.yml

@@ -0,0 +1,3 @@
+ignore:
+  - "lib/influxdb2/client/models/**/*"
+  - "test/influxdb/**/*"

data/.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,8 @@
+Closes #
+
+_Briefly describe your proposed changes:_
+
+  - [ ] CHANGELOG.md updated
+  - [ ] Rebased/mergeable
+  - [ ] Tests pass
+  - [ ] Sign [CLA](https://influxdata.com/community/cla/) (if not already signed)

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.idea/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+/test/reports/
+.rakeTasks
+/influxdb-client-*.gem
+/TAGS
+/vendor
+/.openapi-generator/

data/.rubocop.yml

@@ -0,0 +1,38 @@
+#
+# 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.
+#
+
+AllCops:
+  Exclude:
+    - 'lib/influxdb2/client/models/**/*'
+    - 'vendor/**/*'
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 30
+Metrics/ClassLength:
+  Max: 200
+Metrics/AbcSize:
+  Max: 30
+Metrics/CyclomaticComplexity:
+  Max: 15
+Metrics/PerceivedComplexity:
+  Max: 15

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 1.1.0 [2020-02-14]
+
+### Features
+1. [#14](https://github.com/influxdata/influxdb-client-ruby/issues/14): Added QueryApi
+2. [#17](https://github.com/influxdata/influxdb-client-ruby/issues/17): Added possibility to stream query result
+3. [#19](https://github.com/influxdata/influxdb-client-ruby/issues/19): Added WriteOptions and possibility to batch write
+ 
+## 1.0.0.beta [2020-01-17]
+
+### Features
+1. [#4](https://github.com/influxdata/influxdb-client-ruby/pull/4): Added WriteApi that will be used for Fluentd plugin
+ 

data/Gemfile

@@ -0,0 +1,24 @@
+# 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.
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in influxdb-client.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Influxdata, Inc.
+
+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.

data/README.md

@@ -0,0 +1,226 @@
+# influxdb-client-ruby
+
+[![CircleCI](https://circleci.com/gh/influxdata/influxdb-client-ruby.svg?style=svg)](https://circleci.com/gh/influxdata/influxdb-client-ruby)
+[![codecov](https://codecov.io/gh/influxdata/influxdb-client-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/influxdata/influxdb-client-ruby)
+[![Gem Version](https://badge.fury.io/rb/influxdb-client.svg)](https://badge.fury.io/rb/influxdb-client)
+[![License](https://img.shields.io/github/license/influxdata/influxdb-client-ruby.svg)](https://github.com/influxdata/influxdb-client-ruby/blob/master/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues-raw/influxdata/influxdb-client-ruby.svg)](https://github.com/influxdata/influxdb-client-ruby/issues)
+[![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.
+
+#### Note: This library is for use with InfluxDB 2.x. For connecting to InfluxDB 1.x instances, please use the [influxdb-ruby](https://github.com/influxdata/influxdb-ruby) client.
+#### Disclaimer: This library is a work in progress and should not be considered production ready yet.
+
+## Installation
+
+The InfluxDB 2 client is bundled as a gem and is hosted on [Rubygems](https://rubygems.org/gems/influxdb-client).
+
+### Install the Gem
+
+The client can be installed manually or with bundler.
+
+To install the client gem manually:
+
+```
+gem install influxdb-client -v 1.1.0
+```
+
+## Usage
+
+### Creating a client
+
+Use **InfluxDB::Client** to create a client connected to a running InfluxDB 2 instance.
+
+```ruby
+client = InfluxDB2::Client.new('https://localhost:9999', 'my-token')
+```
+
+#### Client Options
+
+| Option | Description | Type | Default |
+|---|---|---|---|
+| bucket | Default destination bucket for writes | String | none |
+| org | Default organization bucket for writes | String | none |
+| precision | Default precision for the unix timestamps within the body line-protocol | String | none |
+| open_timeout | Number of seconds to wait for the connection to open | Integer | 10 |
+| 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 |
+| use_ssl | Turn on/off SSL for HTTP communication | bool | true |
+
+```ruby
+client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+  bucket: 'my-bucket',
+  org: 'my-org',
+  precision: InfluxDB2::WritePrecision::NANOSECOND)
+```
+
+### Queries
+
+The result retrieved by [QueryApi](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/query_api.rb) could be formatted as a:
+
+   1. Raw query response
+   2. Flux data structure: [FluxTable, FluxColumn and FluxRecord](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/flux_table.rb)
+   3. Stream of [FluxRecord](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/flux_table.rb)
+
+#### Query raw
+
+Synchronously executes the Flux query and return result as unprocessed String
+```ruby
+client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+                              bucket: 'my-bucket',
+                              org: 'my-org')
+
+query_api = client.create_query_api
+result = query_api.query_raw(query: 'from(bucket:"' + bucket + '") |> range(start: 1970-01-01T00:00:00.000000001Z) |> last()')
+```
+#### Synchronous query
+Synchronously executes the Flux query and return result as a Array of [FluxTables](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/flux_table.rb)
+```ruby
+client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+                              bucket: 'my-bucket',
+                              org: 'my-org')
+
+query_api = client.create_query_api
+result = query_api.query(query: 'from(bucket:"' + bucket + '") |> range(start: 1970-01-01T00:00:00.000000001Z) |> last()')
+```
+
+#### Query stream
+Synchronously executes the Flux query and return stream of [FluxRecord](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/flux_table.rb)
+```ruby
+client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+                              bucket: 'my-bucket',
+                              org: 'my-org')
+
+query_api = client.create_query_api
+
+query = 'from(bucket: "my-bucket") |> range(start: -10m, stop: now()) ' \
+      "|> filter(fn: (r) => r._measurement == \"#{measurement}\")"
+
+query_api.query_stream(query: query).each do |record|
+  puts record.to_s
+end
+```
+
+### 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.
+
+```ruby
+client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+                              bucket: 'my-bucket',
+                              org: 'my-org',
+                              precision: InfluxDB2::WritePrecision::NANOSECOND)
+
+write_api = client.create_write_api
+write_api.write(data: 'h2o,location=west value=33i 15')
+```
+
+#### Batching
+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 |
+
+```ruby
+write_options = InfluxDB2::WriteOptions.new(write_type: InfluxDB2::WriteType::BATCHING,
+                                            batch_size: 10, flush_interval: 5_000)
+client = InfluxDB2::Client.new('http://localhost:9999',
+                               'my-token',
+                               bucket: 'my-bucket',
+                               org: 'my-org',
+                               precision: InfluxDB2::WritePrecision::NANOSECOND,
+                               use_ssl: false)
+
+write_api = client.create_write_api(write_options: write_options)
+write_api.write(data: 'h2o,location=west value=33i 15')
+```
+
+#### Time precision
+
+Configure default time precision:
+```ruby
+client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+                              bucket: 'my-bucket',
+                              org: 'my-org',
+                              precision: InfluxDB2::WritePrecision::NANOSECOND)
+```
+
+Configure precision per write:
+```ruby
+client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+                                  bucket: 'my-bucket',
+                                  org: 'my-org')
+
+write_api = client.create_write_api
+write_api.write(data: 'h2o,location=west value=33i 15', precision: InfluxDB2::WritePrecision::SECOND)
+```
+Allowed values for precision are:
+- `InfluxDB::WritePrecision::NANOSECOND` for nanosecond
+- `InfluxDB::WritePrecision::MICROSECOND` for microsecond
+- `InfluxDB::WritePrecision::MILLISECOND` for millisecond
+- `InfluxDB::WritePrecision::SECOND` for second
+
+#### Configure destination
+
+Default `bucket` and `organization` destination are configured via `InfluxDB::Client`:
+```ruby
+client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+                              bucket: 'my-bucket',
+                              org: 'my-org')
+```
+
+but there is also possibility to override configuration per write:
+
+```ruby
+client = InfluxDB2::Client.new('https://localhost:9999', 'my-token')
+
+write_api = client.create_write_api
+write_api.write(data: 'h2o,location=west value=33i 15', bucket: 'production-data', org: 'customer-1')
+```
+
+#### Data format
+
+The data could be written as:
+
+1. `String` that is formatted as a InfluxDB's line protocol
+1. `Hash` with keys: name, tags, fields and time
+1. [Data Point](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb/client/point.rb#L28) structure
+1. `Array` of above items
+
+```ruby
+client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+                              bucket: 'my-bucket',
+                              org: 'my-org',
+                              precision: InfluxDB2::WritePrecision::NANOSECOND)
+
+point = InfluxDB2::Point.new(name: 'h2o')
+                       .add_tag('location', 'europe')
+                       .add_field('level', 2)
+
+hash = { name: 'h2o',
+         tags: { host: 'aws', region: 'us' },
+         fields: { level: 5, saturation: '99%' }, time: 123 }
+
+write_api = client.create_write_api
+write_api.write(data: ['h2o,location=west value=33i 15', point, hash])
+```
+
+## Local tests
+
+```
+brew install wget # on a mac, if not yet installed!
+bin/influxdb-restart.sh
+rake test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/influxdata/influxdb-client-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).