influxdb-client 1.12.0.pre.1894 → 1.12.0.pre.1923

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 348cc579c1aa802928e344e2075f7aa4896363108f9e30407e07c8fe8d293686
-  data.tar.gz: 434a5039b83030ce068a3b913880e2c3d084f495cfbd119a839428ceb08f4f5e
+  metadata.gz: 362357eca37d1e260da7a5849ba03a1cb171b3ab7b2d42d3f38d270b1527be07
+  data.tar.gz: 0651ff8e0891520e83abc964b32a2c59cf885a9b8bea6c069440fe662230f81a
 SHA512:
-  metadata.gz: f917dc680761aabd57d033211da42712cb560c7461cec2f15f581e40e9f22b6e511c1e8c9874ceaa6f8dc8502c512dc09640f4cdbfdce7e601ba970670ab1788
-  data.tar.gz: e5d9bc0d90cf42b3b9b8cd2e10c771f095cbe176adeb022ed903b27e347b028abde77c01bcb59113a419589dcfcce92bb429a4881e82269d5dcf0abedbf7fa2d
+  metadata.gz: 900e575115840c8e482efc3e916382c4c2d60c48225eb43e5f880df21ca088423939dcf903cc7afa5b5c03131021160de69b08ea2cb2bec2e9e77c850e248cf6
+  data.tar.gz: 429664825449c2c62f0ecaf25f9b61adb657b22dd7d90c79cfa70d627bfe186e748f81364ddfa5c01f1c36cc65a8ba8b925e7045a9eee0996ab5eb1b5f425da1

data/CHANGELOG.md

@@ -1,6 +1,7 @@
 ## 1.12.0 [unreleased]
 
 ### Features
+1. [#69](https://github.com/influxdata/influxdb-client-ruby/pull/69): Created `influxdb-client-apis` package for Management API
 1. [#71](https://github.com/influxdata/influxdb-client-ruby/pull/71): Added possibility to specify the certification verification behaviour
 
 ## 1.11.0 [2021-01-29]

data/README.md

@@ -12,6 +12,37 @@ This repository contains the reference Ruby client for the InfluxDB 2.0.
 
 #### 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.
 
+- [Features](#features)
+- [Installation](#installation)
+    - [Install the Gem](#install-the-gem)
+- [Usage](#usage)
+    - [Creating a client](#creating-a-client)
+    - [Writing data](#writing-data)
+    - [Querying data](#queries)
+    - [Delete data](#delete-data)
+    - [Management API](#management-api)
+- [Advanced Usage](#advanced-usage)
+    - [Default Tags](#default-tags)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Features
+
+InfluxDB 2.0 client consists of two packages
+
+- `influxdb-client`
+    - Querying data using the Flux language
+    - Writing data
+        - batched in chunks on background
+        - automatic retries on write failures
+- `influxdb-client-apis`
+    - provides all other InfluxDB 2.0 APIs for managing
+        - buckets
+        - labels
+        - authorizations
+        - ...
+    - built on top of `influxdb-client`
+
 ## Installation
 
 The InfluxDB 2 client is bundled as a gem and is hosted on [Rubygems](https://rubygems.org/gems/influxdb-client).
@@ -26,6 +57,12 @@ To install the client gem manually:
 gem install influxdb-client -v 1.11.0
 ```
 
+For management API:
+
+```
+gem install influxdb-client-apis --pre
+```
+
 ## Usage
 
 ### Creating a client
@@ -267,6 +304,86 @@ The time range could be specified as:
 1. DateTime - `DateTime.rfc3339('2019-03-03T04:05:06+07:00')`
 1. Time - `Time.utc(2015, 10, 16, 8, 20, 15)`
 
+### Management API
+
+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 |
+
+
+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).
+
+```ruby
+#
+# This is an example how to create new bucket with permission to write.
+#
+# You could run example via: `cd apis && bundle exec ruby ../examples/create_new_bucket.rb`
+#
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'influxdb-client'
+$LOAD_PATH.unshift File.expand_path('../apis/lib', __dir__)
+require 'influxdb-client-apis'
+
+url = 'http://localhost:8086'
+bucket = 'my-bucket'
+org = 'my-org'
+token = 'my-token'
+
+client = InfluxDB2::Client.new(url,
+                               token,
+                               bucket: bucket,
+                               org: org,
+                               use_ssl: false,
+                               precision: InfluxDB2::WritePrecision::NANOSECOND)
+
+api = InfluxDB2::API::Client.new(client)
+
+# Find my organization
+organization = api.create_organizations_api
+                  .get_orgs
+                  .orgs
+                  .select { |it| it.name == 'my-org' }
+                  .first
+
+#
+# Create new Bucket
+#
+retention_rule = InfluxDB2::API::RetentionRule.new(type: 'expire', every_seconds: 3600)
+bucket_name = 'new-bucket-name'
+request = InfluxDB2::API::PostBucketRequest.new(org_id: organization.id,
+                                                name: bucket_name,
+                                                retention_rules: [retention_rule])
+bucket = api.create_buckets_api
+            .post_buckets(request)
+
+#
+# Create Permission to read/write from Bucket
+#
+resource = InfluxDB2::API::Resource.new(type: 'buckets',
+                                        id: bucket.id,
+                                        org_id: organization.id)
+authorization = InfluxDB2::API::Authorization.new(description: "Authorization to read/write bucket: #{bucket.name}",
+                                                  org_id: organization.id,
+                                                  permissions: [
+                                                    InfluxDB2::API::Permission.new(action: 'read', resource: resource),
+                                                    InfluxDB2::API::Permission.new(action: 'write', resource: resource)
+                                                  ])
+result = api.create_authorizations_api
+            .post_authorizations(authorization)
+
+print("The token: '#{result.token}' is authorized to read/write from/to bucket: '#{bucket.name}'.")
+
+client.close!
+
+```
+- sources - [create_new_bucket.rb](/examples/create_new_bucket.rb)
+
 ## Advanced Usage
 
 ### Check the server status 

data/influxdb-client.gemspec

@@ -22,6 +22,7 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'influxdb2/client/version'
 
+# noinspection DuplicatedCode
 Gem::Specification.new do |spec|
   spec.name          = 'influxdb-client'
   spec.version       = ENV['CIRCLE_BUILD_NUM'] ? "#{InfluxDB2::VERSION}-#{ENV['CIRCLE_BUILD_NUM']}" : InfluxDB2::VERSION
@@ -37,8 +38,9 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri'] = 'https://github.com/influxdata/influxdb-client-ruby'
   spec.metadata['changelog_uri'] = 'https://raw.githubusercontent.com/influxdata/influxdb-client-ruby/master/CHANGELOG.md'
 
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features|smoke)/})
+  spec.files = Dir.glob('lib/**/*')
+  spec.files += %w[influxdb-client.gemspec LICENSE README.md CHANGELOG.md Rakefile]
+  spec.test_files = Dir.glob('test/**/*')
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.2.0'
 
@@ -46,7 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'codecov', '~> 0.1.16'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.4'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rubocop', '~> 0.66.0'
   spec.add_development_dependency 'simplecov', '~> 0.17.1'
   spec.add_development_dependency 'webmock', '~> 3.7'

data/lib/influxdb2/client/models/delete_predicate_request.rb

@@ -3,14 +3,15 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-OpenAPI spec version: 0.1.0
+The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 3.3.4
+OpenAPI Generator version: 5.0.0-beta3
 
 =end
 
 require 'date'
+require 'time'
 
 module InfluxDB2
   # The delete predicate request.
@@ -24,41 +25,54 @@ module InfluxDB2
     # InfluxQL-like delete statement
     attr_accessor :predicate
 
-    # Attribute mapping from ruby-style variable name to JSON key.
+    # Attribute mapping from ruby-style variable name to JSON key
     def self.attribute_map
       {
         :'start' => :'start',
         :'stop' => :'stop',
-        :'predicate' => :'predicate'
+        :'predicate' => :'predicate',
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'start' => :'DateTime',
-        :'stop' => :'DateTime',
-        :'predicate' => :'String'
+        :'start' => :'Time',
+        :'stop' => :'Time',
+        :'predicate' => :'String',
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `InfluxDB2::DeletePredicateRequest` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `InfluxDB2::DeletePredicateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
 
-      if attributes.has_key?(:'start')
+      if attributes.key?(:'start')
         self.start = attributes[:'start']
       end
 
-      if attributes.has_key?(:'stop')
+      if attributes.key?(:'stop')
         self.stop = attributes[:'stop']
       end
 
-      if attributes.has_key?(:'predicate')
+      if attributes.key?(:'predicate')
         self.predicate = attributes[:'predicate']
       end
     end
@@ -103,9 +117,16 @@ module InfluxDB2
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [start, stop, predicate].hash
+      [start, stop, predicate, ].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
     end
 
     # Builds the object from hash
@@ -114,15 +135,17 @@ module InfluxDB2
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       self.class.openapi_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
             self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
+        end
       end
 
       self
@@ -134,8 +157,8 @@ module InfluxDB2
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -144,7 +167,7 @@ module InfluxDB2
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -165,8 +188,7 @@ module InfluxDB2
           end
         end
       else # model
-        temp_model = InfluxDB2.const_get(type).new
-        temp_model.build_from_hash(value)
+        InfluxDB2.const_get(type).build_from_hash(value)
       end
     end
 
@@ -188,7 +210,11 @@ module InfluxDB2
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
         hash[param] = _to_hash(value)
       end
       hash
@@ -211,5 +237,6 @@ module InfluxDB2
         value
       end
     end
+
   end
 end

data/lib/influxdb2/client/models/dialect.rb

@@ -3,14 +3,15 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-OpenAPI spec version: 0.1.0
+The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 3.3.4
+OpenAPI Generator version: 5.0.0-beta3
 
 =end
 
 require 'date'
+require 'time'
 
 module InfluxDB2
   # Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions
@@ -19,16 +20,16 @@ module InfluxDB2
     attr_accessor :header
 
     # Separator between cells; the default is ,
-    attr_accessor :delimiter
+    attr_reader :delimiter
 
-    # Https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns
+    # https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns
     attr_accessor :annotations
 
     # Character prefixed to comment strings
-    attr_accessor :comment_prefix
+    attr_reader :comment_prefix
 
     # Format of timestamps
-    attr_accessor :date_time_format
+    attr_reader :date_time_format
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -52,62 +53,75 @@ module InfluxDB2
       end
     end
 
-    # Attribute mapping from ruby-style variable name to JSON key.
+    # Attribute mapping from ruby-style variable name to JSON key
     def self.attribute_map
       {
         :'header' => :'header',
         :'delimiter' => :'delimiter',
         :'annotations' => :'annotations',
         :'comment_prefix' => :'commentPrefix',
-        :'date_time_format' => :'dateTimeFormat'
+        :'date_time_format' => :'dateTimeFormat',
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'header' => :'BOOLEAN',
+        :'header' => :'Boolean',
         :'delimiter' => :'String',
         :'annotations' => :'Array<String>',
         :'comment_prefix' => :'String',
-        :'date_time_format' => :'String'
+        :'date_time_format' => :'String',
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `InfluxDB2::Dialect` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `InfluxDB2::Dialect`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
 
-      if attributes.has_key?(:'header')
+      if attributes.key?(:'header')
         self.header = attributes[:'header']
       else
         self.header = true
       end
 
-      if attributes.has_key?(:'delimiter')
+      if attributes.key?(:'delimiter')
         self.delimiter = attributes[:'delimiter']
       else
         self.delimiter = ','
       end
 
-      if attributes.has_key?(:'annotations')
+      if attributes.key?(:'annotations')
         if (value = attributes[:'annotations']).is_a?(Array)
           self.annotations = value
         end
       end
 
-      if attributes.has_key?(:'commentPrefix')
-        self.comment_prefix = attributes[:'commentPrefix']
+      if attributes.key?(:'comment_prefix')
+        self.comment_prefix = attributes[:'comment_prefix']
       else
         self.comment_prefix = '#'
       end
 
-      if attributes.has_key?(:'dateTimeFormat')
-        self.date_time_format = attributes[:'dateTimeFormat']
+      if attributes.key?(:'date_time_format')
+        self.date_time_format = attributes[:'date_time_format']
       else
         self.date_time_format = 'RFC3339'
       end
@@ -143,7 +157,7 @@ module InfluxDB2
       return false if !@delimiter.nil? && @delimiter.to_s.length < 1
       return false if !@comment_prefix.nil? && @comment_prefix.to_s.length > 1
       return false if !@comment_prefix.nil? && @comment_prefix.to_s.length < 0
-      date_time_format_validator = EnumAttributeValidator.new('String', ['RFC3339', 'RFC3339Nano'])
+      date_time_format_validator = EnumAttributeValidator.new('String', ["RFC3339", "RFC3339Nano"])
       return false unless date_time_format_validator.valid?(@date_time_format)
       true
     end
@@ -179,9 +193,9 @@ module InfluxDB2
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] date_time_format Object to be assigned
     def date_time_format=(date_time_format)
-      validator = EnumAttributeValidator.new('String', ['RFC3339', 'RFC3339Nano'])
+      validator = EnumAttributeValidator.new('String', ["RFC3339", "RFC3339Nano"])
       unless validator.valid?(date_time_format)
-        fail ArgumentError, 'invalid value for "date_time_format", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"date_time_format\", must be one of #{validator.allowable_values}."
       end
       @date_time_format = date_time_format
     end
@@ -205,9 +219,16 @@ module InfluxDB2
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [header, delimiter, annotations, comment_prefix, date_time_format].hash
+      [header, delimiter, annotations, comment_prefix, date_time_format, ].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
     end
 
     # Builds the object from hash
@@ -216,15 +237,17 @@ module InfluxDB2
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       self.class.openapi_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
             self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
+        end
       end
 
       self
@@ -236,8 +259,8 @@ module InfluxDB2
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -246,7 +269,7 @@ module InfluxDB2
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -267,8 +290,7 @@ module InfluxDB2
           end
         end
       else # model
-        temp_model = InfluxDB2.const_get(type).new
-        temp_model.build_from_hash(value)
+        InfluxDB2.const_get(type).build_from_hash(value)
       end
     end
 
@@ -290,7 +312,11 @@ module InfluxDB2
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
         hash[param] = _to_hash(value)
       end
       hash
@@ -313,5 +339,6 @@ module InfluxDB2
         value
       end
     end
+
   end
 end