comet_backup_ruby_sdk 0.2.0

data/lib/comet/models/spanned_destination_location.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # SpannedDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
+  class SpannedDestinationLocation
+
+    # @type [Array<Comet::DestinationLocation>] span_targets
+    attr_accessor :span_targets
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @span_targets = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' 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 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'SpanTargets'
+          if v.nil?
+            @span_targets = []
+          else
+            @span_targets = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @span_targets[i1] = Comet::DestinationLocation.new
+              @span_targets[i1].from_hash(v1)
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['SpanTargets'] = @span_targets
+      @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

data/lib/comet/models/spanned_storage_extra_info.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # SpannedStorageExtraInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  class SpannedStorageExtraInfo
+
+    # @type [Array<Comet::StorageFreeSpaceInfo>] targets
+    attr_accessor :targets
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @targets = []
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' 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 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Targets'
+          if v.nil?
+            @targets = []
+          else
+            @targets = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @targets[i1] = Comet::StorageFreeSpaceInfo.new
+              @targets[i1].from_hash(v1)
+            end
+          end
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Targets'] = @targets
+      @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

data/lib/comet/models/sshconnection.rb

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # SSHConnection is a typed class wrapper around the underlying Comet Server API data structure.
+  class SSHConnection
+
+    # @type [String] sshserver
+    attr_accessor :sshserver
+
+    # @type [String] sshusername
+    attr_accessor :sshusername
+
+    # @type [Number] sshauth_mode
+    attr_accessor :sshauth_mode
+
+    # @type [String] sshpassword
+    attr_accessor :sshpassword
+
+    # @type [String] sshprivate_key
+    attr_accessor :sshprivate_key
+
+    # @type [Boolean] sshcustom_auth__use_known_hosts_file
+    attr_accessor :sshcustom_auth__use_known_hosts_file
+
+    # @type [String] sshcustom_auth__known_hosts_file
+    attr_accessor :sshcustom_auth__known_hosts_file
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' 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 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'SSHServer'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @sshserver = v
+        when 'SSHUsername'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @sshusername = v
+        when 'SSHAuthMode'
+          @sshauth_mode = v
+        when 'SSHPassword'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @sshpassword = v
+        when 'SSHPrivateKey'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @sshprivate_key = v
+        when 'SSHCustomAuth_UseKnownHostsFile'
+          @sshcustom_auth__use_known_hosts_file = v
+        when 'SSHCustomAuth_KnownHostsFile'
+          raise TypeError 'expected string' unless v.is_a? String
+
+          @sshcustom_auth__known_hosts_file = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['SSHServer'] = @sshserver
+      ret['SSHUsername'] = @sshusername
+      ret['SSHAuthMode'] = @sshauth_mode
+      ret['SSHPassword'] = @sshpassword
+      ret['SSHPrivateKey'] = @sshprivate_key
+      ret['SSHCustomAuth_UseKnownHostsFile'] = @sshcustom_auth__use_known_hosts_file
+      ret['SSHCustomAuth_KnownHostsFile'] = @sshcustom_auth__known_hosts_file
+      @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

data/lib/comet/models/stat_result.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # StatResult is a typed class wrapper around the underlying Comet Server API data structure.
+  class StatResult
+
+    # @type [Number] buckets
+    attr_accessor :buckets
+
+    # @type [Number] users
+    attr_accessor :users
+
+    # @type [Number] devices
+    attr_accessor :devices
+
+    # @type [Number] boosters
+    attr_accessor :boosters
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' 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 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Buckets'
+          @buckets = v
+        when 'Users'
+          @users = v
+        when 'Devices'
+          @devices = v
+        when 'Boosters'
+          @boosters = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Buckets'] = @buckets
+      ret['Users'] = @users
+      ret['Devices'] = @devices
+      ret['Boosters'] = @boosters
+      @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

data/lib/comet/models/storage_free_space_info.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2020 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # StorageFreeSpaceInfo is a typed class wrapper around the underlying Comet Server API data structure.
+  class StorageFreeSpaceInfo
+
+    # @type [Boolean] unlimited
+    attr_accessor :unlimited
+
+    # @type [Number] used_percent
+    attr_accessor :used_percent
+
+    # @type [Number] available_bytes
+    attr_accessor :available_bytes
+
+    # @type [Comet::SpannedStorageExtraInfo] spanned
+    attr_accessor :spanned
+
+    # @type [Comet::B2StorageExtraInfo] b2
+    attr_accessor :b2
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      @unknown_json_fields = {}
+    end
+
+    # @param [String] json_string The complete object in JSON format
+    def from_json(json_string)
+      raise TypeError 'expected string' 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 'expected hash' unless obj.is_a? Hash
+
+      obj.each do |k, v|
+        case k
+        when 'Unlimited'
+          @unlimited = v
+        when 'UsedPercent'
+          @used_percent = v
+        when 'AvailableBytes'
+          @available_bytes = v
+        when 'Spanned'
+          @spanned = Comet::SpannedStorageExtraInfo.new
+          @spanned.from_hash(v)
+        when 'B2'
+          @b2 = Comet::B2StorageExtraInfo.new
+          @b2.from_hash(v)
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      ret['Unlimited'] = @unlimited
+      ret['UsedPercent'] = @used_percent
+      ret['AvailableBytes'] = @available_bytes
+      unless @spanned.nil?
+        ret['Spanned'] = @spanned
+      end
+      unless @b2.nil?
+        ret['B2'] = @b2
+      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