comet_backup_ruby_sdk 2.11.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d6a5ccdbb19a7a417c00bfbd4dfc033b95a0e173188156efaac65217517e6d7
-  data.tar.gz: 9b824422ee089951b33143150891724d457a0e945d8377d704e830356908db85
+  metadata.gz: dd580d387bff734854661ad2a96745a0687538a2fc1597ca3fa193a37451bc1c
+  data.tar.gz: d64c702fbd3f7aabd58a4653f6753374b1e54faad802eb184b5e9804bc59c54d
 SHA512:
-  metadata.gz: a5a9419659e7d24216dd9221af230f9012c3c17d42cc476428f33583189835e95937f6dbac9d517ad72440528315e649b856ccb8472cf00bdd250874adcfb373
-  data.tar.gz: cd7d60617d3682eb905f926837dce922e8474d2ca5551337b377ad170498614d46111f7645e47caedd620f2e864d2baa2b6f9408b9a0a54f2488d9b60ab81de5
+  metadata.gz: e1a4cb81494020fb4fba9c5c0d524ec22f01afe605eb87568a0f6d4b91b9c7327e79ac8b8970cde56c70f6ee2bb343e3c7cfea325b88ec92db5c3c6c6fa94817
+  data.tar.gz: d76d0ce3aa82f4d986271ef1568271937edb3e397bd289e7e206c559dd8007a62eff01d073e91aad83d8d357c3bd63e4b56d037e21bea72c745cf7e8ce097789

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 2023-08-29 v2.13.0
+
+- Based on Comet 23.8.0
+- Improve documentation of JobStatus constants
+
+## 2023-08-09 v2.12.0
+
+- Based on Comet 23.6.9
+- Added WebDAV `DestinationLocation`
+
 ## 2023-08-02 v2.11.0
 
 - Based on Comet 23.6.9

data/Gemfile.lock

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

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

data/lib/comet/comet_server.rb

@@ -4100,7 +4100,6 @@ module Comet
     #
     # You must supply administrator authentication credentials to use this API.
     # Access to this API may be prevented on a per-administrator basis.
-    # This API requires the Storage Role to be enabled.
     # This API is only available for top-level administrator accounts, not for Tenant administrator accounts.
     #
     # @param [Comet::DestinationLocation] extra_data The destination location settings

data/lib/comet/definitions.rb

@@ -7,13 +7,13 @@
 
 module Comet
 
-  APPLICATION_VERSION = '23.6.9'
+  APPLICATION_VERSION = '23.8.0'
 
   APPLICATION_VERSION_MAJOR = 23
 
-  APPLICATION_VERSION_MINOR = 6
+  APPLICATION_VERSION_MINOR = 8
 
-  APPLICATION_VERSION_REVISION = 9
+  APPLICATION_VERSION_REVISION = 0
 
   # AutoRetentionLevel: The system will automatically choose how often to run an automatic Retention Pass after each backup job.
   BACKUPJOBAUTORETENTION_AUTOMATIC = 0
@@ -115,6 +115,8 @@ module Comet
   # Storj
   DESTINATIONTYPE_STORJ = 1009
 
+  DESTINATIONTYPE_WEBDAV = 1010
+
   # When defining a schedule via policy, use this option to dynamically select the Storage Vault that was created most recently.
   DESTINATIONTYPE_LATEST = 1100
 
@@ -262,7 +264,7 @@ module Comet
   # JobStatus: If the BackupJobDetail.Status field is a 5xxx code, the job has stopped for a successful reason.
   JOB_STATUS_STOP_SUCCESS__MIN = 5000
 
-  # JobStatus
+  # JobStatus: The job is complete and was successful.
   JOB_STATUS_STOP_SUCCESS = 5000
 
   # JobStatus
@@ -274,10 +276,10 @@ module Comet
   # JobStatus: Unused
   JOB_STATUS_RUNNING_INDETERMINATE = 6000
 
-  # JobStatus
+  # JobStatus: The last information the server received from the device is that the job is currently running.
   JOB_STATUS_RUNNING_ACTIVE = 6001
 
-  # JobStatus: A backup job that was marked as stopped or abandoned, but has somehow continued to run
+  # JobStatus: The job was thought to have been in an Abandoned state but updated the Comet Server with a running status.
   JOB_STATUS_RUNNING_REVIVED = 6002
 
   # JobStatus
@@ -289,25 +291,25 @@ module Comet
   # JobStatus
   JOB_STATUS_FAILED_TIMEOUT = 7000
 
-  # JobStatus
+  # JobStatus: The job is complete but there was a problem that may have resulted in issues with the expected result.
   JOB_STATUS_FAILED_WARNING = 7001
 
-  # JobStatus
+  # JobStatus: There was an error during the job and it did not fully complete.
   JOB_STATUS_FAILED_ERROR = 7002
 
-  # JobStatus
+  # JobStatus: During a backup job either the "All protected items" quota or "Storage Vault" quota was exceeded.
   JOB_STATUS_FAILED_QUOTA = 7003
 
-  # JobStatus
+  # JobStatus: The job did not start at its scheduled time.
   JOB_STATUS_FAILED_SCHEDULEMISSED = 7004
 
-  # JobStatus
+  # JobStatus: The job was cancelled manually, a device shutdown was detected, or the backup time limit was reached.
   JOB_STATUS_FAILED_CANCELLED = 7005
 
-  # JobStatus
+  # JobStatus: The backup job was skipped as there was already a backup running and the "Skip if already running" option was enabled.
   JOB_STATUS_FAILED_SKIPALREADYRUNNING = 7006
 
-  # JobStatus
+  # JobStatus: The job has stopped unexpectedly or has been manually marked as abandoned by an admin.
   JOB_STATUS_FAILED_ABANDONED = 7007
 
   # JobStatus
@@ -405,7 +407,7 @@ module Comet
   # PSAType
   PSA_TYPE_GRADIENT = 1
 
-  RELEASE_CODENAME = 'Voyager'
+  RELEASE_CODENAME = 'Adrastea'
 
   # RemoteServerType
   REMOTESERVER_COMET = 'comet'

data/lib/comet/models/destination_config.rb

@@ -183,6 +183,10 @@ module Comet
     # @type [Comet::B2DestinationLocation] b2
     attr_accessor :b2
 
+    # This field is available in Comet 23.6.9 and later.
+    # @type [Comet::WebDavDestinationLocation] web_dav
+    attr_accessor :web_dav
+
     # @type [Comet::StorjDestinationLocation] storj
     attr_accessor :storj
 
@@ -286,6 +290,7 @@ module Comet
       @localcopy_win_smbpassword_format = 0
       @swift = Comet::SwiftDestinationLocation.new
       @b2 = Comet::B2DestinationLocation.new
+      @web_dav = Comet::WebDavDestinationLocation.new
       @storj = Comet::StorjDestinationLocation.new
       @span_targets = []
       @encryption_key_encryption_method = 0
@@ -509,6 +514,9 @@ module Comet
         when 'B2'
           @b2 = Comet::B2DestinationLocation.new
           @b2.from_hash(v)
+        when 'WebDav'
+          @web_dav = Comet::WebDavDestinationLocation.new
+          @web_dav.from_hash(v)
         when 'Storj'
           @storj = Comet::StorjDestinationLocation.new
           @storj.from_hash(v)
@@ -607,6 +615,7 @@ module Comet
       ret['LocalcopyWinSMBPasswordFormat'] = @localcopy_win_smbpassword_format
       ret['Swift'] = @swift
       ret['B2'] = @b2
+      ret['WebDav'] = @web_dav
       ret['Storj'] = @storj
       ret['SpanTargets'] = @span_targets
       ret['SpanUseStaticSlots'] = @span_use_static_slots

data/lib/comet/models/destination_location.rb

@@ -163,6 +163,10 @@ module Comet
     # @type [Comet::B2DestinationLocation] b2
     attr_accessor :b2
 
+    # This field is available in Comet 23.6.9 and later.
+    # @type [Comet::WebDavDestinationLocation] web_dav
+    attr_accessor :web_dav
+
     # @type [Comet::StorjDestinationLocation] storj
     attr_accessor :storj
 
@@ -227,6 +231,7 @@ module Comet
       @localcopy_win_smbpassword_format = 0
       @swift = Comet::SwiftDestinationLocation.new
       @b2 = Comet::B2DestinationLocation.new
+      @web_dav = Comet::WebDavDestinationLocation.new
       @storj = Comet::StorjDestinationLocation.new
       @span_targets = []
       @unknown_json_fields = {}
@@ -399,6 +404,9 @@ module Comet
         when 'B2'
           @b2 = Comet::B2DestinationLocation.new
           @b2.from_hash(v)
+        when 'WebDav'
+          @web_dav = Comet::WebDavDestinationLocation.new
+          @web_dav.from_hash(v)
         when 'Storj'
           @storj = Comet::StorjDestinationLocation.new
           @storj.from_hash(v)
@@ -465,6 +473,7 @@ module Comet
       ret['LocalcopyWinSMBPasswordFormat'] = @localcopy_win_smbpassword_format
       ret['Swift'] = @swift
       ret['B2'] = @b2
+      ret['WebDav'] = @web_dav
       ret['Storj'] = @storj
       ret['SpanTargets'] = @span_targets
       ret['SpanUseStaticSlots'] = @span_use_static_slots

data/lib/comet/models/web_dav_destination_location.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020-2023 Comet Licensing Ltd.
+# Please see the LICENSE file for usage information.
+#
+# SPDX-License-Identifier: MIT
+
+require 'json'
+
+module Comet
+
+  # WebDavDestinationLocation is a typed class wrapper around the underlying Comet Server API data structure.
+  # This type is available in Comet 23.6.9 and later.
+  class WebDavDestinationLocation
+
+    # The URL of the WebDAV server, including http/https and any custom port
+    # @type [String] dav_server
+    attr_accessor :dav_server
+
+    # The username for logging in to the WebDAV server
+    # @type [String] user_name
+    attr_accessor :user_name
+
+    # The password for logging in to the WebDAV server
+    # @type [String] access_key
+    attr_accessor :access_key
+
+    # The target directory path within the WebDAV server
+    # @type [String] path
+    attr_accessor :path
+
+    # @type [Hash] Hidden storage to preserve future properties for non-destructive roundtrip operations
+    attr_accessor :unknown_json_fields
+
+    def initialize
+      clear
+    end
+
+    def clear
+      @dav_server = ''
+      @user_name = ''
+      @access_key = ''
+      @path = ''
+      @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 'DavServer'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @dav_server = v
+        when 'UserName'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @user_name = v
+        when 'AccessKey'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @access_key = v
+        when 'Path'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path = v
+        else
+          @unknown_json_fields[k] = v
+        end
+      end
+    end
+
+    # @return [Hash] The complete object as a Ruby hash
+    def to_hash
+      ret = {}
+      unless @dav_server.nil?
+        ret['DavServer'] = @dav_server
+      end
+      unless @user_name.nil?
+        ret['UserName'] = @user_name
+      end
+      unless @access_key.nil?
+        ret['AccessKey'] = @access_key
+      end
+      unless @path.nil?
+        ret['Path'] = @path
+      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

data/lib/comet_backup_ruby_sdk.rb

@@ -205,6 +205,7 @@ require_relative 'comet/models/web_authn_relying_party_entity'
 require_relative 'comet/models/web_authn_sign_request'
 require_relative 'comet/models/web_authn_sign_response'
 require_relative 'comet/models/web_authn_user_entity'
+require_relative 'comet/models/web_dav_destination_location'
 require_relative 'comet/models/web_interface_branding_properties'
 require_relative 'comet/models/webhook_option'
 require_relative 'comet/models/win_smbauth'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: comet_backup_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Comet Licensing Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-02 00:00:00.000000000 Z
+date: 2023-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -283,6 +283,7 @@ files:
 - lib/comet/models/web_authn_sign_request.rb
 - lib/comet/models/web_authn_sign_response.rb
 - lib/comet/models/web_authn_user_entity.rb
+- lib/comet/models/web_dav_destination_location.rb
 - lib/comet/models/web_interface_branding_properties.rb
 - lib/comet/models/webhook_option.rb
 - lib/comet/models/win_smbauth.rb