lib/comet/models/osinfo.rb



# frozen_string_literal: true

# Copyright (c) 2020-2024 Comet Licensing Ltd.
# Please see the LICENSE file for usage information.
#
# SPDX-License-Identifier: MIT

require 'json'

module Comet

  # OSInfo is a typed class wrapper around the underlying Comet Server API data structure.
  # OSInfo represents the common set of version information between all operating systems
  class OSInfo

    # The primary version number (e.g. on Windows: 1703 / 2009, on Linux: 20.04 / 22.04)
    # @type [String] version
    attr_accessor :version

    # The primary presentation name (e.g. "Windows 10 Pro", "debian", "Synology DSM")
    # @type [String] distribution
    attr_accessor :distribution

    # The detailed build number (e.g. 19043)
    # @type [String] build
    attr_accessor :build

    # The GOOS value
    # This field is available in Comet 23.6.0 and later.
    # @type [String] os
    attr_accessor :os

    # The GOARCH value
    # This field is available in Comet 23.6.0 and later.
    # @type [String] arch
    attr_accessor :arch

    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
    attr_accessor :unknown_json_fields

    def initialize
      clear
    end

    def clear
      @version = ''
      @distribution = ''
      @build = ''
      @os = ''
      @arch = ''
      @unknown_json_fields = {}
    end

    # @param [String] json_string The complete object in JSON format
    def from_json(json_string)
      raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

      from_hash(JSON.parse(json_string))
    end

    # @param [Hash] obj The complete object as a Ruby hash
    def from_hash(obj)
      raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

      obj.each do |k, v|
        case k
        when 'version'
          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

          @version = v
        when 'distribution'
          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

          @distribution = v
        when 'build'
          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

          @build = v
        when 'os'
          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

          @os = v
        when 'arch'
          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

          @arch = v
        else
          @unknown_json_fields[k] = v
        end
      end
    end

    # @return [Hash] The complete object as a Ruby hash
    def to_hash
      ret = {}
      unless @version.nil?
        ret['version'] = @version
      end
      unless @distribution.nil?
        ret['distribution'] = @distribution
      end
      unless @build.nil?
        ret['build'] = @build
      end
      unless @os.nil?
        ret['os'] = @os
      end
      unless @arch.nil?
        ret['arch'] = @arch
      end
      @unknown_json_fields.each do |k, v|
        ret[k] = v
      end
      ret
    end

    # @return [Hash] The complete object as a Ruby hash
    def to_h
      to_hash
    end

    # @return [String] The complete object as a JSON string
    def to_json(options = {})
      to_hash.to_json(options)
    end
  end
end