influxdb-client 1.1.0

data/lib/influxdb2/client/flux_table.rb

@@ -0,0 +1,99 @@
+# 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.
+
+module InfluxDB2
+  # This class represents the table structure of the Flux CSV Response.
+  # Ref: http://bit.ly/flux-spec#table
+  class FluxTable
+    def initialize
+      @columns = []
+      @records = []
+    end
+    attr_reader :columns, :records
+
+    # A table's group key is subset of the entire columns dataset that assigned to the table.
+    # As such, all records within a table will have the same values for each column that is part of the group key.
+    def group_key
+      columns = []
+
+      @columns.each do |column|
+        columns.push(column) if column.group
+      end
+
+      columns
+    end
+  end
+
+  # A record is a tuple of values. Each record in the table represents a single point in the series.
+  # Ref: http://bit.ly/flux-spec#record
+  class FluxRecord
+    # @param [Integer] table the index of table which contains the record
+    # @param [Hash] values tuple of values
+    def initialize(table, values: nil)
+      @table = table
+      @values = values || {}
+    end
+    attr_reader :table, :values
+    attr_writer :table
+
+    # @return [Time] the inclusive lower time bound of all records
+    def start
+      values['_start']
+    end
+
+    # @return [Time] the exclusive upper time bound of all records
+    def stop
+      values['_stop']
+    end
+
+    # @return [Time] the time of the record
+    def time
+      values['_time']
+    end
+
+    # @return [Object] the value of the record
+    def value
+      values['_value']
+    end
+
+    # @return [String] value with key "_field"
+    def field
+      values['_field']
+    end
+
+    # @return [String] value with key "_measurement"
+    def measurement
+      values['_measurement']
+    end
+  end
+
+  # This class represents a column header specification of FluxTable.
+  class FluxColumn
+    def initialize(index: nil, label: nil, data_type: nil, group: nil, default_value: nil)
+      @index = index
+      @label = label
+      @data_type = data_type
+      @group = group
+      @default_value = default_value
+    end
+    attr_reader :index, :label, :data_type, :group, :default_value
+    attr_writer :index, :label, :data_type, :group, :default_value
+  end
+end

data/lib/influxdb2/client/influx_error.rb

@@ -0,0 +1,27 @@
+module InfluxDB2
+  # InfluxError that is raised during HTTP communication.
+  class InfluxError < StandardError
+    # HTTP status code
+    attr_reader :code
+    # Reference code unique to the error type
+    attr_reader :reference
+
+    def initialize(message:, code:, reference:)
+      super(message)
+
+      @code = code
+      @reference = reference
+    end
+
+    def self.from_response(response)
+      json = JSON.parse(response.body)
+      obj = new(message: json['message'] || '', code: response.code, reference: json['code'] || '')
+      obj
+    end
+
+    def self.from_message(message)
+      obj = new(message: message, code: '', reference: '')
+      obj
+    end
+  end
+end

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

@@ -0,0 +1,317 @@
+=begin
+#Influx API Service
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+OpenAPI spec version: 0.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.4
+
+=end
+
+require 'date'
+
+module InfluxDB2
+  # Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions
+  class Dialect
+    # If true, the results will contain a header row
+    attr_accessor :header
+
+    # Separator between cells; the default is ,
+    attr_accessor :delimiter
+
+    # Https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns
+    attr_accessor :annotations
+
+    # Character prefixed to comment strings
+    attr_accessor :comment_prefix
+
+    # Format of timestamps
+    attr_accessor :date_time_format
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # 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'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'header' => :'BOOLEAN',
+        :'delimiter' => :'String',
+        :'annotations' => :'Array<String>',
+        :'comment_prefix' => :'String',
+        :'date_time_format' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'header')
+        self.header = attributes[:'header']
+      else
+        self.header = true
+      end
+
+      if attributes.has_key?(:'delimiter')
+        self.delimiter = attributes[:'delimiter']
+      else
+        self.delimiter = ','
+      end
+
+      if attributes.has_key?(:'annotations')
+        if (value = attributes[:'annotations']).is_a?(Array)
+          self.annotations = value
+        end
+      end
+
+      if attributes.has_key?(:'commentPrefix')
+        self.comment_prefix = attributes[:'commentPrefix']
+      else
+        self.comment_prefix = '#'
+      end
+
+      if attributes.has_key?(:'dateTimeFormat')
+        self.date_time_format = attributes[:'dateTimeFormat']
+      else
+        self.date_time_format = 'RFC3339'
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@delimiter.nil? && @delimiter.to_s.length > 1
+        invalid_properties.push('invalid value for "delimiter", the character length must be smaller than or equal to 1.')
+      end
+
+      if !@delimiter.nil? && @delimiter.to_s.length < 1
+        invalid_properties.push('invalid value for "delimiter", the character length must be great than or equal to 1.')
+      end
+
+      if !@comment_prefix.nil? && @comment_prefix.to_s.length > 1
+        invalid_properties.push('invalid value for "comment_prefix", the character length must be smaller than or equal to 1.')
+      end
+
+      if !@comment_prefix.nil? && @comment_prefix.to_s.length < 0
+        invalid_properties.push('invalid value for "comment_prefix", the character length must be great than or equal to 0.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if !@delimiter.nil? && @delimiter.to_s.length > 1
+      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'])
+      return false unless date_time_format_validator.valid?(@date_time_format)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] delimiter Value to be assigned
+    def delimiter=(delimiter)
+      if !delimiter.nil? && delimiter.to_s.length > 1
+        fail ArgumentError, 'invalid value for "delimiter", the character length must be smaller than or equal to 1.'
+      end
+
+      if !delimiter.nil? && delimiter.to_s.length < 1
+        fail ArgumentError, 'invalid value for "delimiter", the character length must be great than or equal to 1.'
+      end
+
+      @delimiter = delimiter
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] comment_prefix Value to be assigned
+    def comment_prefix=(comment_prefix)
+      if !comment_prefix.nil? && comment_prefix.to_s.length > 1
+        fail ArgumentError, 'invalid value for "comment_prefix", the character length must be smaller than or equal to 1.'
+      end
+
+      if !comment_prefix.nil? && comment_prefix.to_s.length < 0
+        fail ArgumentError, 'invalid value for "comment_prefix", the character length must be great than or equal to 0.'
+      end
+
+      @comment_prefix = comment_prefix
+    end
+
+    # 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'])
+      unless validator.valid?(date_time_format)
+        fail ArgumentError, 'invalid value for "date_time_format", must be one of #{validator.allowable_values}.'
+      end
+      @date_time_format = date_time_format
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          header == o.header &&
+          delimiter == o.delimiter &&
+          annotations == o.annotations &&
+          comment_prefix == o.comment_prefix &&
+          date_time_format == o.date_time_format
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def 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 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
+          # 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
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = InfluxDB2.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,284 @@
+=begin
+#Influx API Service
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+OpenAPI spec version: 0.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.4
+
+=end
+
+require 'date'
+
+module InfluxDB2
+  # Query influx with specific return formatting.
+  class Query
+    attr_accessor :extern
+
+    # Query script to execute.
+    attr_accessor :query
+
+    # The type of query.
+    attr_accessor :type
+
+    # Required for `influxql` type queries.
+    attr_accessor :db
+
+    # Required for `influxql` type queries.
+    attr_accessor :rp
+
+    # Required for `influxql` type queries.
+    attr_accessor :cluster
+
+    attr_accessor :dialect
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'extern' => :'extern',
+        :'query' => :'query',
+        :'type' => :'type',
+        :'db' => :'db',
+        :'rp' => :'rp',
+        :'cluster' => :'cluster',
+        :'dialect' => :'dialect'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'extern' => :'File',
+        :'query' => :'String',
+        :'type' => :'String',
+        :'db' => :'String',
+        :'rp' => :'String',
+        :'cluster' => :'String',
+        :'dialect' => :'Dialect'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'extern')
+        self.extern = attributes[:'extern']
+      end
+
+      if attributes.has_key?(:'query')
+        self.query = attributes[:'query']
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = 'flux'
+      end
+
+      if attributes.has_key?(:'db')
+        self.db = attributes[:'db']
+      end
+
+      if attributes.has_key?(:'rp')
+        self.rp = attributes[:'rp']
+      end
+
+      if attributes.has_key?(:'cluster')
+        self.cluster = attributes[:'cluster']
+      end
+
+      if attributes.has_key?(:'dialect')
+        self.dialect = attributes[:'dialect']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @query.nil?
+        invalid_properties.push('invalid value for "query", query cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @query.nil?
+      type_validator = EnumAttributeValidator.new('String', ['flux', 'influxql'])
+      return false unless type_validator.valid?(@type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ['flux', 'influxql'])
+      unless validator.valid?(type)
+        fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
+      end
+      @type = type
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          extern == o.extern &&
+          query == o.query &&
+          type == o.type &&
+          db == o.db &&
+          rp == o.rp &&
+          cluster == o.cluster &&
+          dialect == o.dialect
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [extern, query, type, db, rp, cluster, dialect].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+          # 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
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = InfluxDB2.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end