influxdb-client 1.2.0

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

data/lib/influxdb2/client/point.rb

@@ -0,0 +1,215 @@
+# 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
+  DEFAULT_WRITE_PRECISION = WritePrecision::NANOSECOND
+  ESCAPE_KEY_LIST = ['\\'.freeze, ','.freeze, ' '.freeze, '='.freeze].freeze
+  ESCAPE_VALUE_LIST = ['\\'.freeze, '"'.freeze].freeze
+
+  # Point defines the values that will be written to the database.
+  # Ref: http://bit.ly/influxdata-point
+  class Point
+    # Create DataPoint instance for specified measurement name.
+    #
+    # @example InfluxDB::Point.new(name: "h2o",
+    #   tags: {host: 'aws', region: 'us'},
+    #   fields: {level: 5, saturation: "99%"},
+    #   time: 123)
+    #
+    # @param [String] name the measurement name for the point.
+    # @param [Hash] tags the tag set for the point
+    # @param [Hash] fields the fields for the point
+    # @param [Integer] time the timestamp for the point
+    # @param [WritePrecision] precision the precision for the unix timestamps within the body line-protocol
+    def initialize(name:, tags: nil, fields: nil, time: nil, precision: DEFAULT_WRITE_PRECISION)
+      @name = name
+      @tags = tags || {}
+      @fields = fields || {}
+      @time = time
+      @precision = precision
+    end
+    attr_reader :precision
+
+    # Create DataPoint instance from specified data.
+    #
+    # @example Point.fromHash({
+    #   name: 'cpu',
+    #   tags: { host: 'server_nl', regios: 'us' },
+    #   fields: {internal: 5, external: 6},
+    #   time: 1422568543702900257
+    # })
+    #
+    # @param [Hash] data
+    def self.from_hash(data)
+      obj = new(name: data[:name], tags: data[:tags], fields: data[:fields], time: data[:time])
+      obj
+    end
+
+    # Adds or replaces a tag value for a point.
+    #
+    # @example InfluxDB::Point.new(name: "h2o")
+    #   .add_tag("location", "europe")
+    #   .add_field("level", 2)
+    #
+    # @param [Object] key the tag name
+    # @param [Object] value the tag value
+    def add_tag(key, value)
+      @tags[key] = value
+      self
+    end
+
+    # Adds or replaces a field value for a point.
+    #
+    # @example InfluxDB::Point.new(name: "h2o")
+    #   .add_tag("location", "europe")
+    #   .add_field("level", 2)
+    #
+    # @param [Object] key the field name
+    # @param [Object] value the field value
+    def add_field(key, value)
+      @fields[key] = value
+      self
+    end
+
+    # Updates the timestamp for the point.
+    #
+    # @example InfluxDB::Point.new(name: "h2o")
+    #   .add_tag("location", "europe")
+    #   .add_field("level", 2)
+    #   .time(Time.new(2015, 10, 15, 8, 20, 15), InfluxDB::WritePrecision::MILLISECOND)
+    #
+    # @example InfluxDB::Point.new(name: "h2o")
+    #   .add_tag("location", "europe")
+    #   .add_field("level", 2)
+    #   .time(123, InfluxDB::WritePrecision::NANOSECOND)
+    #
+    # @param [Object] time the timestamp
+    # @param [WritePrecision] precision the timestamp precision
+    def time(time, precision)
+      @time = time
+      @precision = precision
+      self
+    end
+
+    # If there is no field then return nil.
+    #
+    # @return a string representation of the point
+    def to_line_protocol
+      line_protocol = ''
+      measurement = _escape_key(@name || '')
+
+      line_protocol << measurement
+
+      tags = _escape_tags
+      line_protocol << ",#{tags}" unless tags.empty?
+      line_protocol << ' '.freeze if line_protocol[-1] == '\\'
+
+      fields = _escape_fields
+      return nil if fields.empty?
+
+      line_protocol << " #{fields}" if fields
+      timestamp = _escape_time
+      line_protocol << " #{timestamp}" if timestamp
+
+      line_protocol
+    end
+
+    private
+
+    def _escape_tags
+      return if @tags.nil?
+
+      @tags.sort.to_h.map do |k, v|
+        key = _escape_key(k.to_s)
+        value = _escape_key(v.to_s)
+        if key.empty? || value.empty?
+          nil
+        else
+          "#{key}=#{value}"
+        end
+      end.reject(&:nil?).join(','.freeze)
+    end
+
+    def _escape_fields
+      return if @fields.nil?
+
+      @fields.sort.to_h.map do |k, v|
+        key = _escape_key(k.to_s)
+        value = _escape_value(v)
+        if key.empty? || value.empty?
+          nil
+        else
+          "#{key}=#{value}"
+        end
+      end.reject(&:nil?).join(','.freeze)
+    end
+
+    def _escape_key(value)
+      result = value.dup
+      ESCAPE_KEY_LIST.each do |ch|
+        result = result.gsub(ch) { "\\#{ch}" }
+      end
+      result
+    end
+
+    def _escape_value(value)
+      if value.nil?
+        ''
+      elsif value.is_a?(String)
+        result = value.dup
+        ESCAPE_VALUE_LIST.each do |ch|
+          result = result.gsub(ch) { "\\#{ch}" }
+        end
+        '"'.freeze + result + '"'.freeze
+      elsif value.is_a?(Integer)
+        "#{value}i"
+      elsif [Float::INFINITY, -Float::INFINITY].include?(value)
+        ''
+      else
+        value.to_s
+      end
+    end
+
+    def _escape_time
+      if @time.nil?
+        nil
+      elsif @time.is_a?(Integer)
+        @time.to_s
+      elsif @time.is_a?(Float)
+        @time.round.to_s
+      elsif @time.is_a?(Time)
+        nano_seconds = @time.to_i * 1e9
+        nano_seconds += @time.tv_nsec
+        case @precision || DEFAULT_WRITE_PRECISION
+        when InfluxDB2::WritePrecision::MILLISECOND then
+          (nano_seconds / 1e6).round
+        when InfluxDB2::WritePrecision::SECOND then
+          (nano_seconds / 1e9).round
+        when InfluxDB2::WritePrecision::MICROSECOND then
+          (nano_seconds / 1e3).round
+        when InfluxDB2::WritePrecision::NANOSECOND then
+          nano_seconds.round
+        end
+      else
+        @time.to_s
+      end
+    end
+  end
+end