comet_backup_ruby_sdk 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f171b686ff819ece50144f9df68d33e4cc19d16f3650a14fa0a8e2ab6085705
-  data.tar.gz: 1c772db480d36ef618b9ae49ffdfbaf7266a8c048e46db97e28861bbf62bf0c7
+  metadata.gz: bcf25f477167c1899508aee3c92beaba73a3832634a7b377915c26c11f5c0dec
+  data.tar.gz: 3a5a94ec4b0cddfd10ed3f819921cd1df9cf192aa76936562eaecd0f61b603b6
 SHA512:
-  metadata.gz: a81c233bc05c79786095deb47dabcb5450d5a70fe14586207c37fad3ec7954bfee346926de2de3c72df1616726de83cd8956b099d21f533d3e477c01597c5f1b
-  data.tar.gz: 9c397ce360202863393420b7c4440274e62aff5862b3eaee47671a662606624641f12cfd6762d0609b5043f624cdcd7d39fc7aee450efaa5334729d04357379d
+  metadata.gz: 435a8de3e5dc71585979cfc43549a1871fbf47d9b4a6b7575e559dd5b9cc1fd4fd3dd0a5aa2c036424b10e2f626cce5d3f18020ea3c884240c94190cbec08354
+  data.tar.gz: 3e876fa42cdfad439f0cf3db82f4536a915ec4e4033721c111d1e9435f15fe01167e79320532fff0a9cb5f9cd41f9195a71e00d26849b1eb3ac88a64f0b7918c

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 2021-10-21 1.9.0
+- Based on 21.9.7
+- Add Support for `HideFiles` parameter in B2 Destination Locations
+- Add support for `RegistrationTime` to `DeviceConfig`
+- Upgrade MYSQL to support new TLS connection options
+- Add support for new API: `AdminMetaReadAllLogsRequest` and `AdminDispatcherRequestWindiskSnapshot`
+
 ## 2021-09-14 1.8.0
 - Based on Comet 21.9.2
 - Support new `custom_headers` field on the `WebhookOption` class for specifying custom HTTP headers

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (1.8.0)
+    comet_backup_ruby_sdk (1.9.0)
 
 GEM
   remote: https://rubygems.org/
@@ -40,4 +40,4 @@ DEPENDENCIES
   rubocop (~> 0.88)
 
 BUNDLED WITH
-   1.17.2
+   2.1.4

data/README.md

@@ -84,7 +84,7 @@ end
 ```ruby
 bundle exec rake rubocop
 
-COMETSERVER_ADDRESS='http://127.0.0.1:8060' \
+  COMETSERVER_ADDRESS='http://127.0.0.1:8060' \
 	COMETSERVER_ADMINUSER=admin \
 	COMETSERVER_ADMINPASS=admin \
 	bundle exec rake test

data/RELEASING.md

@@ -1,5 +1,6 @@
 # Procedure for releasing gem package updates
 
+0. As a cygwin user, with docker installed; `docker run -it -v "c://cygwin64/$PWD":/app -w /app ruby:2.7 bash` will get you with a suitable ruby environment for testing/building and releasing this package9.
 1. All tests passing
 2. Update changelog in `CHANGELOG.md`
 3. Update version number in `comet_backup_ruby_sdk.gemspec`

data/comet_backup_ruby_sdk.gemspec

@@ -12,7 +12,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'comet_backup_ruby_sdk'
-  spec.version       = '1.8.0'
+  spec.version       = '1.9.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/comet_server.rb

@@ -1563,6 +1563,37 @@ module Comet
       ret
     end
 
+    # AdminDispatcherRequestWindiskSnapshot
+    #
+    # Request a Disk Image snapshot with the windiskbrowse-style from a live connected device.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API requires the Auth Role to be enabled.
+    #
+    # @param [String] target_id The live connection GUID
+    # @param [String] destination The Storage Vault ID
+    # @param [String] snapshot_id The Snapshot ID
+    # @return [Comet::DispatcherWindiskSnapshotResponse]
+    def admin_dispatcher_request_windisk_snapshot(target_id, destination, snapshot_id)
+      submit_params = {}
+      raise TypeError, "'target_id' expected String, got #{target_id.class}" unless target_id.is_a? String
+
+      submit_params['TargetID'] = target_id
+      raise TypeError, "'destination' expected String, got #{destination.class}" unless destination.is_a? String
+
+      submit_params['Destination'] = destination
+      raise TypeError, "'snapshot_id' expected String, got #{snapshot_id.class}" unless snapshot_id.is_a? String
+
+      submit_params['SnapshotID'] = snapshot_id
+
+      body = perform_request('api/v1/admin/dispatcher/request-windisk-snapshot', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::DispatcherWindiskSnapshotResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminDispatcherRunBackup
     #
     # Instruct a live connected device to run a scheduled backup.
@@ -2139,6 +2170,7 @@ module Comet
     # Cancel a running job.
     # A request is sent to the live-connected device, asking it to cancel the operation. This may fail if there is no live-connection.
     # Only jobs from Comet 18.3.5 or newer can be cancelled. A job can only be cancelled if it has a non-empty CancellationID field in its properties.
+    # If the device is running Comet 21.9.5 or later, this API will wait up to ten seconds for a confirmation from the client.
     #
     # You must supply administrator authentication credentials to use this API.
     # This API requires the Auth Role to be enabled.
@@ -2318,6 +2350,20 @@ module Comet
       ret
     end
 
+    # AdminMetaReadAllLogs
+    #
+    # Get a ZIP file of all of the server's log files.
+    # On non-Windows platforms, log content uses LF line endings. On Windows, Comet changed from LF to CRLF line endings in 18.3.2.
+    # This API does not automatically convert line endings; around the 18.3.2 timeframe, log content may even contain mixed line-endings.
+    #
+    # You must supply administrator authentication credentials to use this API.
+    # This API is only available for administrator accounts in the top-level Organization, not in any other Organization.
+    #
+    # @return [String]
+    def admin_meta_read_all_logs
+      perform_request('api/v1/admin/meta/read-all-logs')
+    end
+
     # AdminMetaReadLogs
     #
     # Get log file content.

data/lib/comet/definitions.rb

@@ -412,13 +412,13 @@ module Comet
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '21.9.2'
+  APPLICATION_VERSION = '21.9.7'
 
   APPLICATION_VERSION_MAJOR = 21
 
   APPLICATION_VERSION_MINOR = 9
 
-  APPLICATION_VERSION_REVISION = 2
+  APPLICATION_VERSION_REVISION = 7
 
   RELEASE_CODENAME = 'Voyager'
 

data/lib/comet/models/b2destination_location.rb

@@ -29,6 +29,9 @@ module Comet
     # @type [Number] max_connections
     attr_accessor :max_connections
 
+    # @type [Boolean] hide_deleted_files
+    attr_accessor :hide_deleted_files
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -78,6 +81,8 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @max_connections = v
+        when 'HideDeletedFiles'
+          @hide_deleted_files = v
         else
           @unknown_json_fields[k] = v
         end
@@ -102,6 +107,9 @@ module Comet
       unless @max_connections.nil?
         ret['MaxConnections'] = @max_connections
       end
+      unless @hide_deleted_files.nil?
+        ret['HideDeletedFiles'] = @hide_deleted_files
+      end
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/b2virtual_storage_role_settings.rb

@@ -23,6 +23,9 @@ module Comet
     # @type [String] app_key
     attr_accessor :app_key
 
+    # @type [Boolean] hide_deleted_files
+    attr_accessor :hide_deleted_files
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -62,6 +65,8 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @app_key = v
+        when 'HideDeletedFiles'
+          @hide_deleted_files = v
         else
           @unknown_json_fields[k] = v
         end
@@ -74,6 +79,7 @@ module Comet
       ret['MasterBucket'] = @master_bucket
       ret['KeyID'] = @key_id
       ret['AppKey'] = @app_key
+      ret['HideDeletedFiles'] = @hide_deleted_files
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

data/lib/comet/models/device_config.rb

@@ -17,6 +17,9 @@ module Comet
     # @type [String] friendly_name
     attr_accessor :friendly_name
 
+    # @type [Number] registration_time
+    attr_accessor :registration_time
+
     # @type [Comet::OSInfo] platform_version
     attr_accessor :platform_version
 
@@ -35,6 +38,7 @@ module Comet
 
     def clear
       @friendly_name = ''
+      @registration_time = 0
       @platform_version = Comet::OSInfo.new
       @sources = {}
       @device_timezone = ''
@@ -58,6 +62,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @friendly_name = v
+        when 'RegistrationTime'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @registration_time = v
         when 'PlatformVersion'
           @platform_version = Comet::OSInfo.new
           @platform_version.from_hash(v)
@@ -85,6 +93,9 @@ module Comet
     def to_hash
       ret = {}
       ret['FriendlyName'] = @friendly_name
+      unless @registration_time.nil?
+        ret['RegistrationTime'] = @registration_time
+      end
       unless @platform_version.nil?
         ret['PlatformVersion'] = @platform_version
       end

data/lib/comet/models/dispatcher_windisk_snapshot_response.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby --enable-frozen-string-literal
+#
+# Copyright (c) 2020-2021 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+#
+# frozen_string_literal: true
+
+require 'json'
+
+module Comet
+
+  # DispatcherWindiskSnapshotResponse is a typed class wrapper around the underlying Comet Server API data structure.
+  class DispatcherWindiskSnapshotResponse
+
+    # @type [Number] status
+    attr_accessor :status
+
+    # @type [String] message
+    attr_accessor :message
+
+    # @type [Array<Comet::DiskDrive>] windisk_snapshot
+    attr_accessor :windisk_snapshot
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @status = 0
+      @message = ''
+      @windisk_snapshot = []
+      @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 'Status'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @status = v
+        when 'Message'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @message = v
+        when 'WindiskSnapshot'
+          if v.nil?
+            @windisk_snapshot = []
+          else
+            @windisk_snapshot = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @windisk_snapshot[i1] = Comet::DiskDrive.new
+              @windisk_snapshot[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['Status'] = @status
+      ret['Message'] = @message
+      ret['WindiskSnapshot'] = @windisk_snapshot
+      @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/my_sqlconnection.rb

@@ -26,6 +26,21 @@ module Comet
     # @type [String] password
     attr_accessor :password
 
+    # @type [Boolean] use_tls
+    attr_accessor :use_tls
+
+    # @type [Boolean] tlsskip_verify
+    attr_accessor :tlsskip_verify
+
+    # @type [String] tlscustom_server_capath
+    attr_accessor :tlscustom_server_capath
+
+    # @type [String] tlscustom_client_crt_path
+    attr_accessor :tlscustom_client_crt_path
+
+    # @type [String] tlscustom_client_key_path
+    attr_accessor :tlscustom_client_key_path
+
     # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
     attr_accessor :unknown_json_fields
 
@@ -38,6 +53,9 @@ module Comet
       @port = ''
       @username = ''
       @password = ''
+      @tlscustom_server_capath = ''
+      @tlscustom_client_crt_path = ''
+      @tlscustom_client_key_path = ''
       @unknown_json_fields = {}
     end
 
@@ -70,6 +88,22 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @password = v
+        when 'UseTLS'
+          @use_tls = v
+        when 'TLSSkipVerify'
+          @tlsskip_verify = v
+        when 'TLSCustomServerCAPath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @tlscustom_server_capath = v
+        when 'TLSCustomClientCrtPath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @tlscustom_client_crt_path = v
+        when 'TLSCustomClientKeyPath'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @tlscustom_client_key_path = v
         else
           @unknown_json_fields[k] = v
         end
@@ -83,6 +117,11 @@ module Comet
       ret['Port'] = @port
       ret['Username'] = @username
       ret['Password'] = @password
+      ret['UseTLS'] = @use_tls
+      ret['TLSSkipVerify'] = @tlsskip_verify
+      ret['TLSCustomServerCAPath'] = @tlscustom_server_capath
+      ret['TLSCustomClientCrtPath'] = @tlscustom_client_crt_path
+      ret['TLSCustomClientKeyPath'] = @tlscustom_client_key_path
       @unknown_json_fields.each do |k, v|
         ret[k] = v
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,7 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
+- comet_backup_ruby_sdk-1.8.0.gem
 - comet_backup_ruby_sdk.gemspec
 - lib/comet/api_response_error.rb
 - lib/comet/comet_server.rb
@@ -132,6 +133,7 @@ files:
 - lib/comet/models/dispatcher_admin_sources_response.rb
 - lib/comet/models/dispatcher_stored_objects_response.rb
 - lib/comet/models/dispatcher_vault_snapshots_response.rb
+- lib/comet/models/dispatcher_windisk_snapshot_response.rb
 - lib/comet/models/edbfile_info.rb
 - lib/comet/models/email_options.rb
 - lib/comet/models/email_report_config.rb