comet_backup_ruby_sdk 1.4.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bcd5336d8e52eab1535016a7f4d9c0b0a703491b8f63fb01ccd44b4dfa5f517
-  data.tar.gz: 558c4b7ec014edd0fb7f114eb3a0b2b9dbcc890ca59d3090ff6c1731a885fec5
+  metadata.gz: 9f171b686ff819ece50144f9df68d33e4cc19d16f3650a14fa0a8e2ab6085705
+  data.tar.gz: 1c772db480d36ef618b9ae49ffdfbaf7266a8c048e46db97e28861bbf62bf0c7
 SHA512:
-  metadata.gz: dd095297f0142a76f5d4f458e38e55435fc4b3d9c7e6b366a786e811275922e73bef8ac106eeb21e21f2aaca93e6bc177ba2d8ae158d93ddd1f5dc839f0d22f1
-  data.tar.gz: c752085a6a3cff6fafbe2e03dce5d0f23211f778fbb99030ba1ad67480b97abf0d1890e934a5145622f3c31561f68581c27edba55be7ea26e1772160077b4309
+  metadata.gz: a81c233bc05c79786095deb47dabcb5450d5a70fe14586207c37fad3ec7954bfee346926de2de3c72df1616726de83cd8956b099d21f533d3e477c01597c5f1b
+  data.tar.gz: 9c397ce360202863393420b7c4440274e62aff5862b3eaee47671a662606624641f12cfd6762d0609b5043f624cdcd7d39fc7aee450efaa5334729d04357379d

data/.rubocop.yml

@@ -23,3 +23,8 @@ Layout/EmptyLinesAroundClassBody:
 # with the times when we do need multi-line bodies
 Style/IfUnlessModifier:
   Enabled: false
+
+  # allow rocket hashes
+
+Style/HashSyntax:
+  EnforcedStyle: no_mixed_keys

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # CHANGELOG
 
+## 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
+  to be sent in webhook POST requests from Comet Server
+
+## 2021-09-08 v1.7.0
+- Based on Comet 21.9.1
+- Support new `device_timezone` field on the `DeviceConfig` class. 
+- Add `admin_dispatcher_ping_destination` api method
+- Add support for new retention range type constants: `RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_DAY`
+- Add support for new retention range type constants: `RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_WEEK`
+- Add support for new retention range type constants: `RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_MONTH`
+- Add support for Microsoft Office 365 Sharepoiint constant `STOREDOBJECTTYPE_MSSITELISTDRIVEENTITY`
+- Add Microsoft Office 365 Region cloud region constants `OFFICE_365_REGION_PUBLIC`
+- Add Microsoft Office 365 Region cloud region constants `OFFICE_365_REGION_CHINA`
+- Add Microsoft Office 365 Region cloud region constants `OFFICE_365_REGION_GERMANY`
+- Add Microsoft Office 365 Region cloud region constants `OFFICE_365_REGION_US_GOVT`
+- Add Microsoft Office 365 Region cloud region constants `OFFICE_365_REGION_US_DOD`
+
+## 2021-07-01 v1.6.0
+- Based on Comet 21.6.6
+- Support new `DefaultSourceWithOSRestriction` and `LastSuccessfulBackupJob` fields
+- Support custom credentials when performing a cloud Office 365 restore job
+- Support identifying Microsoft Teams folders inside a Sharepoint backup job
+- Document the `SourceIncludePattern` structure used for `PINCLUDE`/`RINCLUDE` rules in a File-type `EngineProps` array
+- Document existing `BrandingProps` endpoint
+
+## 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

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (1.4.0)
+    comet_backup_ruby_sdk (1.8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -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/RELEASING.md

@@ -2,9 +2,11 @@
 
 1. All tests passing
 2. Update changelog in `CHANGELOG.md`
-3. Update version number in `gemspec`
-4. `gem build comet_backup_ruby_sdk`
+3. Update version number in `comet_backup_ruby_sdk.gemspec`
+4. `bundle install`
+	- Should update our internal version in Gemfile.lock
+5. `gem build comet_backup_ruby_sdk.gemspec`
 	- Should be warning-free
-5. Git tag
+6. Git tag
 	- Respect semver
-6. `gem push comet_backup_ruby_sdk-0.x.x.gem`
+7. `gem push comet_backup_ruby_sdk-1.x.x.gem`

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

data/lib/comet/comet_server.rb

@@ -808,6 +808,7 @@ module Comet
     # This does not remove any storage buckets. Unused storage buckets will be cleaned up by the Constellation Role.
     # Any stored data can not be decrypted without the user profile. Misuse can cause data loss!
     # This also allows to uninstall software from active devices under the user account
+    # This also removes all job history for the user account.
     #
     # You must supply administrator authentication credentials to use this API.
     # This API requires the Auth Role to be enabled.
@@ -1076,6 +1077,33 @@ module Comet
       ret
     end
 
+    # AdminDispatcherPingDestination
+    #
+    # Test the connection to the storage bucket.
+    #
+    # 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::DestinationLocation] extra_data The destination location settings
+    # @return [Comet::CometAPIResponseMessage]
+    def admin_dispatcher_ping_destination(target_id, extra_data)
+      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, "'extra_data' expected Comet::DestinationLocation, got #{extra_data.class}" unless extra_data.is_a? Comet::DestinationLocation
+
+      submit_params['ExtraData'] = extra_data.to_json
+
+      body = perform_request('api/v1/admin/dispatcher/ping-destination', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::CometAPIResponseMessage.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminDispatcherRefetchProfile
     #
     # Instruct a live connected device to refresh their profile.
@@ -1100,6 +1128,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 +1281,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 +1441,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.
@@ -3258,7 +3483,7 @@ module Comet
 
       ret_error = Comet::CometAPIResponseMessage.new
       ret_error.from_hash(obj)
-      raise Comet::APIResponseError.new(ret_error)
+      raise Comet::APIResponseError.new(ret_error), 'Comet API response status was not OK'
     end
 
     # Perform a synchronous HTTP request.
@@ -3295,7 +3520,7 @@ module Comet
 
       form_params = []
       params.each do |k, v|
-        form_params.append [k, v, {:filename => k}]
+        form_params.append [k, v, { :filename => k }]
       end
       req.set_form(form_params, 'multipart/form-data')
 

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
 
@@ -221,8 +224,17 @@ module Comet
   # RetentionRangeType: Uses Weeks, WeekOffset
   RETENTIONRANGE_FIRST_JOB_FOR_LAST_X_WEEKS = 906
 
+  # RetentionRangeType: Uses Jobs
+  RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_DAY = 907
+
+  # RetentionRangeType: Uses Jobs
+  RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_WEEK = 908
+
+  # RetentionRangeType: Uses Jobs
+  RETENTIONRANGE_LAST_X_BACKUPS_ONE_FOR_EACH_MONTH = 909
+
   # RetentionRangeType:
-  RETENTIONRANGE__HIGHEST = 906
+  RETENTIONRANGE__HIGHEST = 909
 
   RETENTIONRANGE_MAXINT = 1_125_899_906_842_624
 
@@ -291,6 +303,8 @@ module Comet
 
   ENGINE_BUILTIN_MONGODB = 'engine1/mongodb'
 
+  ENGINE_BUILTIN_MSOFFICE = 'engine1/winmsofficemail'
+
   # MSSQLAuthMode:
   MSSQL_AUTH_WINDOWS = 'windows'
 
@@ -327,6 +341,39 @@ 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_MSSITE_TEAM = 'mssiteteam'
+
+  # StoredObjectType:
+  STOREDOBJECTTYPE_MSSITELISTENTITY = 'mssitelistentity'
+
+  # StoredObjectType:
+  STOREDOBJECTTYPE_MSSITEITEMENTITY = 'mssiteitementity'
+
+  # StoredObjectType:
+  STOREDOBJECTTYPE_MSSITELISTDRIVEENTITY = 'mssitelistdriveentity'
+
   # ExtraFileExclusionOSRestriction:
   OS_ANY = 0
 
@@ -365,15 +412,15 @@ module Comet
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '21.2.1'
+  APPLICATION_VERSION = '21.9.2'
 
   APPLICATION_VERSION_MAJOR = 21
 
-  APPLICATION_VERSION_MINOR = 2
+  APPLICATION_VERSION_MINOR = 9
 
-  APPLICATION_VERSION_REVISION = 1
+  APPLICATION_VERSION_REVISION = 2
 
-  RELEASE_CODENAME = 'Ganymede'
+  RELEASE_CODENAME = 'Voyager'
 
   ENCRYPTIONMETHOD_UNCONFIGURED = 0
 
@@ -544,6 +591,9 @@ module Comet
   # MacOSCodesignLevel:
   MACOSCODESIGN_LEVEL_SIGN_NOTARISE_STAPLE = 2
 
+  # StreamableEventType:
+  SEVT__MIN = 4000
+
   # StreamableEventType: Event is emitted when the webhook is registered, or when the server starts up. The Data associated is ServerMetaVersionInfo
   SEVT_META_HELLO = 4000
 
@@ -565,4 +615,17 @@ module Comet
   # StreamableEventType: Data is the string bucket ref
   SEVT_BUCKET_NEW = 4300
 
+  # StreamableEventType:
+  SEVT__MAX = 4999
+
+  OFFICE365_REGION_PUBLIC = 'GlobalPublicCloud'
+
+  OFFICE365_REGION_CHINA = 'ChinaCloud'
+
+  OFFICE365_REGION_GERMANY = 'GermanCloud'
+
+  OFFICE365_REGION_US_GOVT = 'USGovtGccCloud'
+
+  OFFICE365_REGION_US_DOD = 'USGovtGccDoDCloud'
+
 end