comet_backup_ruby_sdk 1.6.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7343bc96e2ac87ca1b4ff694fbe25e01c6cca99b8dfe6da063050ab3c462530
-  data.tar.gz: ce7ea45a2480321db18a7bc3758d742464810d8feb1c6e2a652df13365404c92
+  metadata.gz: 1351a43776da0134fbbc0f29301c07bf21684f24fad024a2b24311c6c5f1993b
+  data.tar.gz: a21014914d06619f590dce35f990036d4369a76287a6d654a5565fb373ebf003
 SHA512:
-  metadata.gz: 420c4b3892475409d56b1cc64a6a90e9d06ad8dcc4ad7ec3550ad0b861a5ad14807b0f21f4c4bfa542ff010b6beb833a91e627195c8ba215badc7528f7861072
-  data.tar.gz: 19ff57505c136f8d4150987cdd05c7d2133f7541c30256b579b46d83ae373847ea6a1af86c5b2cf2f0f61d672eeb3cff806bd0795d1d27762375df13b371a5f4
+  metadata.gz: 6c1267509de43041f58a02f46edd7aeb2d57eb7a464b5ba018d86398132bff04f94a5cc75bd6f04942a04fdd08a3a7e558c31cea467aae5090f192a75cb11a07
+  data.tar.gz: 8f5b8df8f2d55019e6ca2efd9ad5025d5d31e9bb00babd2fc82c3aeb3a434f4e6f790385cd8643170b4eb69ba2f30cb6d6fc4f59460f5177865f01678ec0ac08

data/.gitignore

@@ -0,0 +1 @@
+*.gem

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,40 @@
 # CHANGELOG
 
+## 2021-11-24 v3.18.0
+- Based on 21.9.12
+- Add support for Thai and Danish localizations
+- Add From and To fields to the EmailReportGenerated API
+- Add `AdminDispatcherEmailPreview` api method for requesting the HTML content of an email
+- Add `ImageEtag` field to the response of the ServerMetaBrandingProperties endpoint.
+- Add support for new engine properties on the Office365 backup type.
+- Add `AdminDispatcherOffice365ListVirtualAccounts` api method for requesting Objects that Office365 is capable of backing up.
+
+## 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
+  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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    comet_backup_ruby_sdk (1.6.0)
+    comet_backup_ruby_sdk (1.10.0)
 
 GEM
   remote: https://rubygems.org/
@@ -33,11 +33,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (~> 2.1.4)
   comet_backup_ruby_sdk!
   minitest (~> 5.14)
   rake (~> 13.0)
   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,12 +1,13 @@
 # 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`
 4. `bundle install`
 	- Should update our internal version in Gemfile.lock
-4. `gem build comet_backup_ruby_sdk.gemspec`
+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-1.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.6.0'
+  spec.version       = '1.10.0'
   spec.authors       = ['Comet Licensing Ltd.']
   spec.email         = ['hello@cometbackup.com']
 
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
   spec.add_development_dependency 'minitest', '~> 5.14'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rubocop', '~> 0.88'

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.
@@ -1000,6 +1001,42 @@ module Comet
       ret
     end
 
+    # AdminDispatcherEmailPreview
+    #
+    # Request HTML content of an email.
+    # The remote device must have given consent for an MSP to browse their mail
+    #
+    # 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] snapshot where the email belongs to
+    # @param [String] destination The Storage Vault ID
+    # @param [String] path of the email to view
+    # @return [Comet::EmailReportGeneratedPreview]
+    def admin_dispatcher_email_preview(target_id, snapshot, destination, path)
+      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, "'snapshot' expected String, got #{snapshot.class}" unless snapshot.is_a? String
+
+      submit_params['Snapshot'] = snapshot
+      raise TypeError, "'destination' expected String, got #{destination.class}" unless destination.is_a? String
+
+      submit_params['Destination'] = destination
+      raise TypeError, "'path' expected String, got #{path.class}" unless path.is_a? String
+
+      submit_params['Path'] = path
+
+      body = perform_request('api/v1/admin/dispatcher/email-preview', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::EmailReportGeneratedPreview.new
+      ret.from_hash(json_body)
+      ret
+    end
+
     # AdminDispatcherImportApply
     #
     # Instruct a live connected device to import settings from an installed product.
@@ -1076,6 +1113,61 @@ module Comet
       ret
     end
 
+    # AdminDispatcherOffice365ListVirtualAccounts
+    #
+    # Request a list of Office365 Resources (groups, sites, teams groups and users).
+    # 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::BrowseOffice365ListVirtualAccountsResponse]
+    def admin_dispatcher_office_365list_virtual_accounts(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/office365-list-virtual-accounts', submit_params)
+      json_body = JSON.parse body
+      check_status json_body
+      ret = Comet::BrowseOffice365ListVirtualAccountsResponse.new
+      ret.from_hash(json_body)
+      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.
@@ -1535,6 +1627,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.
@@ -2111,6 +2234,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.
@@ -2290,6 +2414,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.
@@ -3455,7 +3593,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.
@@ -3492,7 +3630,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

@@ -155,6 +155,24 @@ module Comet
 
   MONGODB_DEFAULT_PORT = 27_017
 
+  SERVICE_CALENDAR = 1
+
+  SERVICE_CONTACT = 2
+
+  SERVICE_MAIL = 4
+
+  SERVICE_SHAREPOINT = 8
+
+  SERVICE_ONEDRIVE = 16
+
+  MIXED_VIRTUAL_ACCOUNT_TYPE_USER = 1
+
+  MIXED_VIRTUAL_ACCOUNT_TYPE_GROUP = 2
+
+  MIXED_VIRTUAL_ACCOUNT_TYPE_TEAM_GROUP = 3
+
+  MIXED_VIRTUAL_ACCOUNT_TYPE_SHAREPOINT_ONLY = 4
+
   # RestoreType:
   RESTORETYPE_INVALID = -1
 
@@ -224,8 +242,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
 
@@ -362,6 +389,9 @@ module Comet
   # StoredObjectType:
   STOREDOBJECTTYPE_MSSITEITEMENTITY = 'mssiteitementity'
 
+  # StoredObjectType:
+  STOREDOBJECTTYPE_MSSITELISTDRIVEENTITY = 'mssitelistdriveentity'
+
   # ExtraFileExclusionOSRestriction:
   OS_ANY = 0
 
@@ -400,13 +430,13 @@ module Comet
 
   DEFAULT_TIMEZONE = 'UTC'
 
-  APPLICATION_VERSION = '21.6.6'
+  APPLICATION_VERSION = '21.9.12'
 
   APPLICATION_VERSION_MAJOR = 21
 
-  APPLICATION_VERSION_MINOR = 6
+  APPLICATION_VERSION_MINOR = 9
 
-  APPLICATION_VERSION_REVISION = 6
+  APPLICATION_VERSION_REVISION = 12
 
   RELEASE_CODENAME = 'Voyager'
 
@@ -579,6 +609,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
 
@@ -600,4 +633,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

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