comet_backup_ruby_sdk 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bcd5336d8e52eab1535016a7f4d9c0b0a703491b8f63fb01ccd44b4dfa5f517
-  data.tar.gz: 558c4b7ec014edd0fb7f114eb3a0b2b9dbcc890ca59d3090ff6c1731a885fec5
+  metadata.gz: e207ce3e89091839b912a7f7ee7de17315de2474890d7560b5b79f1afee434c5
+  data.tar.gz: d85eddeaa1e27a71d3d1415742afa28808e8575f2a46bf20d56a7b0da75a3c9f
 SHA512:
-  metadata.gz: dd095297f0142a76f5d4f458e38e55435fc4b3d9c7e6b366a786e811275922e73bef8ac106eeb21e21f2aaca93e6bc177ba2d8ae158d93ddd1f5dc839f0d22f1
-  data.tar.gz: c752085a6a3cff6fafbe2e03dce5d0f23211f778fbb99030ba1ad67480b97abf0d1890e934a5145622f3c31561f68581c27edba55be7ea26e1772160077b4309
+  metadata.gz: 566f2c136d8c7af458ab75d6fd9f0117ab68a5c114e1ab589af8990773f8e6850326d323380aec56a36332e6bfc85686ce5cbdafeeb358ccb5a0058a2d051e0e
+  data.tar.gz: c92c6256810c4dcaec62ee81ff44ebc2944b97c41a5fa193200b340f523973ea74fee4c4372d37321356020c9323723e7137d2b4593b8fc381ef00abcd96212c

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## 2021-05-25 v1.5.0
+- Based on Comet 21.6.1
+- Add new APIs to remotely browse MySQL, MongoDB, MSSQL database servers
+- Add Microsoft Office 365 properties on BackupJobDetail and on StoredObject
+- Add Microsoft Office 365 browsing APIs
+- Add Microsoft Office 365 Engine definition (`ENGINE_BUILTIN_MSOFFICE`) and associated `EngineProp` data structure definitions
+- Add `AdminDispatcherRegisterOfficeApplication` APIs
+- Add `RESTORETYPE_OFFICE365_CLOUD` constant
+- Support suspending organizations
+- Support reading the Server Self-Backup status
+- Support new `PathMenuBarIcnsFile` branding option for Comet Backup on macOS
+- Add more detailed description for `AdminDispatcherRequestStoredObjects`
+
 ## 2021-03-03 v1.4.0
 - Based on Comet 21.2.1
 - Support restoring files to original paths

data/Gemfile.lock

@@ -14,7 +14,7 @@ GEM
     rainbow (3.0.0)
     rake (13.0.1)
     regexp_parser (1.7.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rubocop (0.88.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.1)

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

data/lib/comet/comet_server.rb

@@ -1100,6 +1100,62 @@ module Comet
       ret
     end
 
+    # AdminDispatcherRegisterOfficeApplicationBegin
+    #
+    # Begin the process of registering a new Azure AD application that can access Office 365 for backup.
+    # After calling this API, you should supply the login details to the end-user, and then begin polling the AdminDispatcherRegisterOfficeApplicationCheck with the supplied "Continuation" parameter to check on the registration process.
+    #
+    # 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] email_address The email address of the Azure AD administrator
+    # @return [Comet::RegisterOfficeApplicationBeginResponse]
+    def admin_dispatcher_register_office_application_begin(target_id, email_address)
+      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, "'email_address' expected String, got #{email_address.class}" unless email_address.is_a? String
+
+      submit_params['EmailAddress'] = email_address
+
+      body = perform_request('api/v1/admin/dispatcher/register-office-application/begin', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::RegisterOfficeApplicationBeginResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRegisterOfficeApplicationCheck
+    #
+    # Check the process of registering a new Azure AD application that can access Office 365 for backup.
+    # You should begin the process by calling AdminDispatcherRegisterOfficeApplicationBegin and asking the end-user to complete the Azure authentication steps.
+    #
+    # 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] continuation The ID returned from the AdminDispatcherRegisterOfficeApplicationBegin endpoint
+    # @return [Comet::RegisterOfficeApplicationCheckResponse]
+    def admin_dispatcher_register_office_application_check(target_id, continuation)
+      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, "'continuation' expected String, got #{continuation.class}" unless continuation.is_a? String
+
+      submit_params['Continuation'] = continuation
+
+      body = perform_request('api/v1/admin/dispatcher/register-office-application/check', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::RegisterOfficeApplicationCheckResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminDispatcherReindexStorageVault
     #
     # Instruct a live connected device to rebuild Storage Vault indexes now.
@@ -1197,6 +1253,90 @@ module Comet
       ret
     end
 
+    # AdminDispatcherRequestBrowseMongodb
+    #
+    # Request a list of tables in MongoDB database.
+    # The remote device must have given consent for an MSP to browse their files.
+    #
+    # 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 [Comet::MongoDBConnection] credentials The Mongo database authentication settings
+    # @return [Comet::BrowseSQLServerResponse]
+    def admin_dispatcher_request_browse_mongodb(target_id, credentials)
+      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, "'credentials' expected Comet::MongoDBConnection, got #{credentials.class}" unless credentials.is_a? Comet::MongoDBConnection
+
+      submit_params['Credentials'] = credentials.to_json
+
+      body = perform_request('api/v1/admin/dispatcher/request-browse-mongodb', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseSQLServerResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRequestBrowseMssql
+    #
+    # Request a list of tables in MSSQL database.
+    # The remote device must have given consent for an MSP to browse their files.
+    #
+    # 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 [Comet::MSSQLConnection] credentials The MSSQL database authentication settings
+    # @return [Comet::BrowseSQLServerResponse]
+    def admin_dispatcher_request_browse_mssql(target_id, credentials)
+      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, "'credentials' expected Comet::MSSQLConnection, got #{credentials.class}" unless credentials.is_a? Comet::MSSQLConnection
+
+      submit_params['Credentials'] = credentials.to_json
+
+      body = perform_request('api/v1/admin/dispatcher/request-browse-mssql', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseSQLServerResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRequestBrowseMysql
+    #
+    # Request a list of tables in MySQL database.
+    # The remote device must have given consent for an MSP to browse their files.
+    #
+    # 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 [Comet::MySQLConnection] credentials The MySQL database authentication settings
+    # @return [Comet::BrowseSQLServerResponse]
+    def admin_dispatcher_request_browse_mysql(target_id, credentials)
+      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, "'credentials' expected Comet::MySQLConnection, got #{credentials.class}" unless credentials.is_a? Comet::MySQLConnection
+
+      submit_params['Credentials'] = credentials.to_json
+
+      body = perform_request('api/v1/admin/dispatcher/request-browse-mysql', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseSQLServerResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminDispatcherRequestBrowseVssAaw
     #
     # Request a list of installed VSS Writers (Application-Aware Writers) from a live connected device.
@@ -1273,10 +1413,67 @@ module Comet
       ret
     end
 
+    # AdminDispatcherRequestOffice365Accounts
+    #
+    # Request a list of Office365 mailbox accounts.
+    # The remote device must have given consent for an MSP to browse their files.
+    #
+    # 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 [Comet::Office365Credential] credentials The Office365 account credential
+    # @return [Comet::BrowseOffice365ObjectsResponse]
+    def admin_dispatcher_request_office_365accounts(target_id, credentials)
+      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, "'credentials' expected Comet::Office365Credential, got #{credentials.class}" unless credentials.is_a? Comet::Office365Credential
+
+      submit_params['Credentials'] = credentials.to_json
+
+      body = perform_request('api/v1/admin/dispatcher/request-office365-accounts', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseOffice365ObjectsResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
+    # AdminDispatcherRequestOffice365Sites
+    #
+    # Request a list of Office365 sites.
+    # The remote device must have given consent for an MSP to browse their files.
+    #
+    # 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 [Comet::Office365Credential] credentials The Office365 account credential
+    # @return [Comet::BrowseOffice365ObjectsResponse]
+    def admin_dispatcher_request_office_365sites(target_id, credentials)
+      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, "'credentials' expected Comet::Office365Credential, got #{credentials.class}" unless credentials.is_a? Comet::Office365Credential
+
+      submit_params['Credentials'] = credentials.to_json
+
+      body = perform_request('api/v1/admin/dispatcher/request-office365-sites', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseOffice365ObjectsResponse.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminDispatcherRequestStoredObjects
     #
     # Request a list of stored objects inside an existing backup job.
     # The remote device must have given consent for an MSP to browse their files.
+    # To service this request, the remote device must connect to the Storage Vault and load index data. There may be a small delay. If the remote device is running Comet 20.12.0 or later, the necessary index data is cached when this API is first called, for 15 minutes after the last repeated call. This can improve performance for interactively browsing an entire tree of stored objects.
     #
     # You must supply administrator authentication credentials to use this API.
     # This API requires the Auth Role to be enabled.

data/lib/comet/definitions.rb

@@ -176,6 +176,9 @@ module Comet
   # RestoreType:
   RESTORETYPE_FILE_ARCHIVE = 5
 
+  # RestoreType:
+  RESTORETYPE_OFFICE365_CLOUD = 6
+
   # RestoreType: RESTORETYPE_PROCESS_ARCHIVE
   RESTORETYPE_PROCESS_TARBALL = 3
 
@@ -291,6 +294,8 @@ module Comet
 
   ENGINE_BUILTIN_MONGODB = 'engine1/mongodb'
 
+  ENGINE_BUILTIN_MSOFFICE = 'engine1/winmsofficemail'
+
   # MSSQLAuthMode:
   MSSQL_AUTH_WINDOWS = 'windows'
 
@@ -327,6 +332,33 @@ module Comet
   # StoredObjectType:
   STOREDOBJECTTYPE_WINEFS = 'winefs'
 
+  # StoredObjectType: "file"
+  STOREDOBJECTTYPE_EMAILMESSAGE = 'emailmessage\"'
+
+  # StoredObjectType: "dir"
+  STOREDOBJECTTYPE_EMAILFOLDER = 'mailfolder\"'
+
+  # StoredObjectType: "file"
+  STOREDOBJECTTYPE_OFFICECONTACT = 'contact\"'
+
+  # StoredObjectType: "dir"
+  STOREDOBJECTTYPE_OFFICECONTACTFOLDER = 'contactfolder\"'
+
+  # StoredObjectType: "file"
+  STOREDOBJECTTYPE_OFFICECALENDAREVENT = 'calendarevent\"'
+
+  # StoredObjectType: "dir"
+  STOREDOBJECTTYPE_OFFICECALENDAR = 'calendar\"'
+
+  # StoredObjectType:
+  STOREDOBJECTTYPE_MSSITE = 'mssite'
+
+  # StoredObjectType:
+  STOREDOBJECTTYPE_MSSITELISTENTITY = 'mssitelistentity'
+
+  # StoredObjectType:
+  STOREDOBJECTTYPE_MSSITEITEMENTITY = 'mssiteitementity'
+
   # ExtraFileExclusionOSRestriction:
   OS_ANY = 0
 
@@ -365,15 +397,15 @@ module Comet
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '21.2.1'
+  APPLICATION_VERSION = '21.6.1'
 
   APPLICATION_VERSION_MAJOR = 21
 
-  APPLICATION_VERSION_MINOR = 2
+  APPLICATION_VERSION_MINOR = 6
 
   APPLICATION_VERSION_REVISION = 1
 
-  RELEASE_CODENAME = 'Ganymede'
+  RELEASE_CODENAME = 'Voyager'
 
   ENCRYPTIONMETHOD_UNCONFIGURED = 0
 

data/lib/comet/models/backup_job_detail.rb

@@ -65,6 +65,15 @@ module Comet
     # @type [Number] download_size
     attr_accessor :download_size
 
+    # @type [Number] total_mails_count
+    attr_accessor :total_mails_count
+
+    # @type [Number] total_sites_count
+    attr_accessor :total_sites_count
+
+    # @type [Number] total_accounts_count
+    attr_accessor :total_accounts_count
+
     # @type [String] cancellation_id
     attr_accessor :cancellation_id
 
@@ -96,6 +105,9 @@ module Comet
       @total_chunks = 0
       @upload_size = 0
       @download_size = 0
+      @total_mails_count = 0
+      @total_sites_count = 0
+      @total_accounts_count = 0
       @cancellation_id = ''
       @progress = Comet::BackupJobProgress.new
       @unknown_json_fields = {}
@@ -182,6 +194,18 @@ module Comet
           raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
 
           @download_size = v
+        when 'TotalMailsCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_mails_count = v
+        when 'TotalSitesCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_sites_count = v
+        when 'TotalAccountsCount'
+          raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric
+
+          @total_accounts_count = v
         when 'CancellationID'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -217,6 +241,15 @@ module Comet
       ret['TotalChunks'] = @total_chunks
       ret['UploadSize'] = @upload_size
       ret['DownloadSize'] = @download_size
+      unless @total_mails_count.nil?
+        ret['TotalMailsCount'] = @total_mails_count
+      end
+      unless @total_sites_count.nil?
+        ret['TotalSitesCount'] = @total_sites_count
+      end
+      unless @total_accounts_count.nil?
+        ret['TotalAccountsCount'] = @total_accounts_count
+      end
       unless @cancellation_id.nil?
         ret['CancellationID'] = @cancellation_id
       end

data/lib/comet/models/branding_options.rb

@@ -59,6 +59,9 @@ module Comet
     # @type [String] path_icns_file
     attr_accessor :path_icns_file
 
+    # @type [String] path_menu_bar_icns_file
+    attr_accessor :path_menu_bar_icns_file
+
     # @type [String] path_eula_rtf
     attr_accessor :path_eula_rtf
 
@@ -121,6 +124,7 @@ module Comet
       @account_register_url = ''
       @path_ico_file = ''
       @path_icns_file = ''
+      @path_menu_bar_icns_file = ''
       @path_eula_rtf = ''
       @path_tile_png = ''
       @path_header_image = ''
@@ -205,6 +209,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @path_icns_file = v
+        when 'PathMenuBarIcnsFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path_menu_bar_icns_file = v
         when 'PathEulaRtf'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -284,6 +292,7 @@ module Comet
       ret['HideBackgroundLogo'] = @hide_background_logo
       ret['PathIcoFile'] = @path_ico_file
       ret['PathIcnsFile'] = @path_icns_file
+      ret['PathMenuBarIcnsFile'] = @path_menu_bar_icns_file
       ret['PathEulaRtf'] = @path_eula_rtf
       ret['PathTilePng'] = @path_tile_png
       ret['PathHeaderImage'] = @path_header_image

data/lib/comet/models/branding_properties.rb

@@ -44,6 +44,9 @@ module Comet
     # @type [String] path_icns_file
     attr_accessor :path_icns_file
 
+    # @type [String] path_menu_bar_icns_file
+    attr_accessor :path_menu_bar_icns_file
+
     # @type [String] path_eula_rtf
     attr_accessor :path_eula_rtf
 
@@ -102,6 +105,7 @@ module Comet
       @account_register_url = ''
       @path_ico_file = ''
       @path_icns_file = ''
+      @path_menu_bar_icns_file = ''
       @path_eula_rtf = ''
       @path_tile_png = ''
       @path_header_image = ''
@@ -168,6 +172,10 @@ module Comet
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
           @path_icns_file = v
+        when 'PathMenuBarIcnsFile'
+          raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
+
+          @path_menu_bar_icns_file = v
         when 'PathEulaRtf'
           raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String
 
@@ -242,6 +250,7 @@ module Comet
       ret['HideBackgroundLogo'] = @hide_background_logo
       ret['PathIcoFile'] = @path_ico_file
       ret['PathIcnsFile'] = @path_icns_file
+      ret['PathMenuBarIcnsFile'] = @path_menu_bar_icns_file
       ret['PathEulaRtf'] = @path_eula_rtf
       ret['PathTilePng'] = @path_tile_png
       ret['PathHeaderImage'] = @path_header_image