comet_backup_ruby_sdk 1.15.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 856c001592ef3dad994ed3d321f8fa68e9f01829770a33117f688a4d22312801
-  data.tar.gz: b31ac9bbebfd4b3696d079b15ede4fcab8c7a927e087f84651861714a38a8172
+  metadata.gz: 32e7a6800c1e43d0b3f33497694693dd69a090317a03ecee5a4ab8dcdbf3a8a5
+  data.tar.gz: ecbcdf90a4cf337d0f02c52c927481607611cc8f1c0c0859f2ff300e27e36a0a
 SHA512:
-  metadata.gz: 1cf63478b5051ef36b844cbc82c8f20344e27a12e73898aec44e7f31f09a1cbd07e9d17ab58c0d1685de10716467d4643d90662208a331c0a3ec99eb0c96cfa2
-  data.tar.gz: ee74bad01ce9338fa8536c02a38a66e9d8838b1dfe5560b1180163f978a81a75a8c438b885a95f6c4049d15cf26908ca60146b9b51689da4e5ef12f18454c24b
+  metadata.gz: 1d27e14ede1f37a25afb39292f5151b85822111c9222c45718e2e3fe25a6e0496d3dd0d327eff7887eebd50c3cc817bc6e68be1034963eb451081dc32cb9fad3
+  data.tar.gz: e76b0af2406eb542afc776130c1ae1d56e4ec6d94bca5ea4118eca1b1563a0f4b925c38ddacc686014bd19d69462da4c80a608d47c97e6de269b62b639ec019c

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 2022-06-28 v2.0.0
+- Based on 22.6.2
+- **BREAKING:** The `Organization.Email` class member is now declared as `EmailOptions` type instead of `AdminEmailOptions`. This change is fully backward-compatible on the HTTP/JSON level, but may cause issues if your application code checked this type explicitly
+- **BREAKING:** The `AdminOrganizationDeleteRequest` API's response type has changed to be `APIResponseMessage`, not `OrganizationResponse`. The Comet Server API had only ever filled in the `APIResponseMessage`-compatible fields of the `OrganizationResponse` structure, so the HTTP/JSON response is unchanged, but this may cause issues if your application code checked this type explicitly
+- Move `frozen_string_literal` declaration to the top line of all `*.rb` files
+- "Requestable" Storage Vaults have been renamed to "Storage Templates". The API endpoint is unchanged, so this is backward-compatible with older Comet Server instances
+- Document all `ServerConfigOptions` types for the `AdminMetaServerConfigSet` and `AdminMetaServerConfigGet` APIs
+- Add new `FallbackServers` option for LDAP external authentication sources
+- Add new `RandomDelaySecs` option for job schedules
+
 ## 2022-06-03 v1.15.0
 - Based on 22.5.0
 - Add `COMPRESS_*` compression settings for Self-Backups
@@ -9,7 +19,7 @@
 ## 2022-05-25 v1.14.0
 - Based on 22.3.7
 - Add new `REMOTESERVER_S3_GENERIC` `RemoteServerType`
-- add new `S3GenericVirtualStorageRole` support to the `RemoteServerAddress`
+- Add new `S3GenericVirtualStorageRole` support to the `RemoteServerAddress`
 
 ## 2022-05-10 v1.13.0
 - Based on 22.3.5

data/Gemfile

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 source 'https://rubygems.org'
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (1.14.0)
+    comet_backup_ruby_sdk (2.0.0)
 
 GEM
   remote: https://rubygems.org/

data/Rakefile

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'rake/testtask'
 require 'rubocop/rake_task'

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.15.0'
+  spec.version       = '2.0.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 

data/lib/comet/api_response_error.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 module Comet
 

data/lib/comet/comet_server.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'net/http'
 require 'json'
@@ -2192,7 +2190,9 @@ module Comet
     #
     # This API will return all jobs that either started or ended within the supplied range.
     #
-    # Incomplete jobs have an end time of `0`. You can use this API to find incomplete jobs by setting both `Start` and `End` to `0`.
+    # Incomplete jobs have an end time of `0`. You can use this API to find only incomplete jobs by setting both `Start` and `End` to `0`.
+    #
+    # Prior to Comet Server 22.6.0, additional Incomplete jobs may have been returned if you specified non-zero arguments for both `Start` and `End`.
     #
     # You must supply administrator authentication credentials to use this API.
     # This API requires the Auth Role to be enabled.
@@ -2598,7 +2598,7 @@ module Comet
 
     # AdminMetaRemoteStorageVaultSet
     #
-    # Set Requestable Remote Storage Vault options.
+    # Set Storage template vault options.
     #
     # You must supply administrator authentication credentials to use this API.
     # Access to this API may be prevented on a per-administrator basis.
@@ -2986,12 +2986,14 @@ module Comet
     #
     # Delete an organization and all related users.
     #
+    # Prior to Comet 22.6.0, this API was documented as returning the OrganizationResponse type. However, it always has returned only a CometAPIResponseMessage.
+    #
     # 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.
     #
     # @param [String] organization_id (Optional) (No description available)
     # @param [Comet::UninstallConfig] uninstall_config (Optional) Uninstall software configuration
-    # @return [Comet::OrganizationResponse]
+    # @return [Comet::CometAPIResponseMessage]
     def admin_organization_delete(organization_id = nil, uninstall_config = nil)
       submit_params = {}
       unless organization_id.nil?
@@ -3008,7 +3010,7 @@ module Comet
       body = perform_request('api/v1/admin/organization/delete', submit_params)
       json_body = JSON.parse body
       check_status json_body
-      ret = Comet::OrganizationResponse.new
+      ret = Comet::CometAPIResponseMessage.new
       ret.from_hash(json_body)
       ret
     end
@@ -3041,6 +3043,8 @@ module Comet
     #
     # Create or Update an Organization.
     #
+    # Prior to Comet 22.6.0, the 'ID' and 'Organization' fields were not present in the response.
+    #
     # 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.
     #
@@ -3308,7 +3312,7 @@ module Comet
     # This API requires the Auth Role to be enabled.
     #
     # @param [String] target_user The user to receive the new Storage Vault
-    # @param [String] storage_provider ID for the Requestable destination
+    # @param [String] storage_provider ID for the storage template destination
     # @param [String] self_address (Optional) The external URL for this server. Used to resolve conflicts
     # @return [Comet::RequestStorageVaultResponseMessage]
     def admin_request_storage_vault(target_user, storage_provider, self_address = nil)
@@ -3342,7 +3346,7 @@ module Comet
     # You must supply administrator authentication credentials to use this API.
     # This API requires the Auth Role to be enabled.
     #
-    # @param [String] target_organization (Optional) If present, list the requestable Storage Vault options belonging to another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)
+    # @param [String] target_organization (Optional) If present, list the storage template options belonging to another organization. Only allowed for administrator accounts in the top-level organization. (>= 22.3.7)
     # @return [Hash{String => String}]
     def admin_request_storage_vault_providers(target_organization = nil)
       submit_params = {}

data/lib/comet/definitions.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 module Comet
 
@@ -322,6 +320,9 @@ module Comet
 
   SCHEDULE_FREQUENCY_HIGHEST = 8015
 
+  # Maximum random delay (5 hours)
+  SCHEDULE_MAX_RANDOM_DELAY_SECS = 18_000
+
   # 2^50 (1 << 50)
   SCHEDULE_MAXINT = 1_125_899_906_842_624
 
@@ -468,15 +469,15 @@ module Comet
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '22.5.0'
+  APPLICATION_VERSION = '22.6.3'
 
   APPLICATION_VERSION_MAJOR = 22
 
-  APPLICATION_VERSION_MINOR = 5
+  APPLICATION_VERSION_MINOR = 6
 
-  APPLICATION_VERSION_REVISION = 0
+  APPLICATION_VERSION_REVISION = 3
 
-  RELEASE_CODENAME = 'Lysithea'
+  RELEASE_CODENAME = 'Voyager'
 
   ENCRYPTIONMETHOD_UNCONFIGURED = 0
 
@@ -661,10 +662,13 @@ module Comet
   # RemoteServerType:
   REMOTESERVER_AWS = 'aws'
 
+  # LDAPSecurityMethod:
   LDAPSECURITYMETHOD_PLAIN = 'plain'
 
+  # LDAPSecurityMethod:
   LDAPSECURITYMETHOD_LDAPS = 'ldaps'
 
+  # LDAPSecurityMethod:
   LDAPSECURITYMETHOD_STARTTLS = 'starttls'
 
   # MacOSCodesignLevel:
@@ -676,6 +680,12 @@ module Comet
   # MacOSCodesignLevel:
   MACOSCODESIGN_LEVEL_SIGN_NOTARISE_STAPLE = 2
 
+  # ClientBrandingBuildMode: Public-Doc: The software client will be custom-built by this Comet Server, allowing custom branding, default server URL, and codesigning.
+  CLIENTBRANDINGBUILD_CUSTOM = 0
+
+  # ClientBrandingBuildMode: Public-Doc: A pre-built software client will be served, with Comet-branding, no server URL, and Comet codesigning.
+  CLIENTBRANDINGBUILD_PREBUILT = 1
+
   # StreamableEventType:
   SEVT__MIN = 4000
 

data/lib/comet/models/add_bucket_response_message.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/admin_account_properties_response.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/admin_email_options.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/admin_resource_response.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/admin_security_options.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/admin_u2fregistration.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'base64'
 require 'json'

data/lib/comet/models/admin_user_permissions.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/admin_web_authn_registration.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'base64'
 require 'json'

data/lib/comet/models/allowed_admin_user.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/amazon_awsvirtual_storage_role_settings.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/authentication_role_options.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2022 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # AuthenticationRoleOptions is a typed class wrapper around the underlying Comet Server API data structure.
+  class AuthenticationRoleOptions
+
+    # @type [Boolean] role_enabled
+    attr_accessor :role_enabled
+
+    # @type [Number] database_check_level
+    attr_accessor :database_check_level
+
+    # @type [Boolean] generate_missed_backup_events
+    attr_accessor :generate_missed_backup_events
+
+    # @type [Number] no_missed_backup_events_before
+    attr_accessor :no_missed_backup_events_before
+
+    # @type [Boolean] generate_scheduled_emails
+    attr_accessor :generate_scheduled_emails
+
+    # @type [Number] prune_logs_after_days
+    attr_accessor :prune_logs_after_days
+
+    # @type [Array<Comet::RemoteStorageOption>] remote_storage
+    attr_accessor :remote_storage
+
+    # @type [Array<Comet::ReplicaServer>] replicate_to
+    attr_accessor :replicate_to
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @database_check_level = 0
+      @no_missed_backup_events_before = 0
+      @prune_logs_after_days = 0
+      @remote_storage = []
+      @replicate_to = []
+      @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 'RoleEnabled'
+          @role_enabled = v
+        when 'DatabaseCheckLevel'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @database_check_level = v
+        when 'GenerateMissedBackupEvents'
+          @generate_missed_backup_events = v
+        when 'NoMissedBackupEventsBefore'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @no_missed_backup_events_before = v
+        when 'GenerateScheduledEmails'
+          @generate_scheduled_emails = v
+        when 'PruneLogsAfterDays'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @prune_logs_after_days = v
+        when 'RemoteStorage'
+          if v.nil?
+            @remote_storage = []
+          else
+            @remote_storage = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @remote_storage[i1] = Comet::RemoteStorageOption.new
+              @remote_storage[i1].from_hash(v1)
+            end
+          end
+        when 'ReplicateTo'
+          if v.nil?
+            @replicate_to = []
+          else
+            @replicate_to = Array.new(v.length)
+            v.each_with_index do |v1, i1|
+              @replicate_to[i1] = Comet::ReplicaServer.new
+              @replicate_to[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['RoleEnabled'] = @role_enabled
+      ret['DatabaseCheckLevel'] = @database_check_level
+      ret['GenerateMissedBackupEvents'] = @generate_missed_backup_events
+      ret['NoMissedBackupEventsBefore'] = @no_missed_backup_events_before
+      ret['GenerateScheduledEmails'] = @generate_scheduled_emails
+      ret['PruneLogsAfterDays'] = @prune_logs_after_days
+      ret['RemoteStorage'] = @remote_storage
+      ret['ReplicateTo'] = @replicate_to
+      @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/available_download.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/azure_destination_location.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/b2destination_location.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/b2storage_extra_info.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/b2transaction_totals.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/b2virtual_storage_role_settings.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/backup_job_advanced_options.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'
 

data/lib/comet/models/backup_job_detail.rb

@@ -1,11 +1,9 @@
-#!/usr/bin/env ruby --enable-frozen-string-literal
-#
+# frozen_string_literal: true
+
 # Copyright (c) 2020-2022 Comet Licensing Ltd.
 # Please see the LICENSE file for usage information.
 #
 # SPDX-License-Identifier: MIT
-#
-# frozen_string_literal: true
 
 require 'json'