cloudmersive-virus-scan-api-client 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7caace679782d9c3c94207830526d9155e2fe119c5ccae38f5221313a3fa154
-  data.tar.gz: bd072e674ea3c7b17766963649bf33e0f51a205da72b23f6c01af537733df2b1
+  metadata.gz: 1bede92a24ae5a20f600c48d6123e4b6ff9bf6f89d0d9213acece8b844bc1a64
+  data.tar.gz: bdd0be405c767fb4b1b88a89b90696630b2772d342dc22f68ee7b679c25d55c2
 SHA512:
-  metadata.gz: 8fcba1dd4d2d82279dafee8e8f2abf0f38045dccda0e314ccfd510affa260f10fce7b6cecbcc4ff51ea98e4a99da8e767294d6090619142115f0f40dfa42aa92
-  data.tar.gz: 36f045d42117fbd01b0ef22812f8e0daa99c49cab4ac89d22b731265d6b71e0d93d3e8cafa3b6a86b0a67666438401a54b08cb86165d4154d34d88b01728ab05
+  metadata.gz: 107a9cf60694ab146600c8367e5433261d8a708a4dcfdb4fa8744ffbd93b6967e674a80733deec7cac68acd0e67215deaef44b1276abc67a907e16bc3128e662
+  data.tar.gz: 61946d727cf0263c934b75506bbc6e38d1b7f0ff572866d21e7c93f9c314b61aa521168eb030efc8190141aab51190365416123ccab781c1334eb9eeb74ff5ac

data/README.md

@@ -7,7 +7,7 @@ The Cloudmersive Virus Scan API lets you scan files and content for viruses and
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 2.0.3
+- Package version: 2.0.4
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-virus-scan-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-virus-scan-api-client-2.0.3.gem
+gem install ./cloudmersive-virus-scan-api-client-2.0.4.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.0.3.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.0.4.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudmersive-virus-scan-api-client', '~> 2.0.3'
+    gem 'cloudmersive-virus-scan-api-client', '~> 2.0.4'
 
 ### Install from Git
 

data/docs/ScanApi.md

@@ -91,6 +91,7 @@ opts = {
   allow_invalid_files: true, # BOOLEAN | Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended).
   allow_scripts: true, # BOOLEAN | Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended).
   allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords.  Set to true to allow these file types.  Default is false (recommended).
+  allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended).
   restrict_file_types: 'restrict_file_types_example' # String | Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files.  All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false.  Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
 }
 
@@ -112,6 +113,7 @@ Name | Type | Description  | Notes
  **allow_invalid_files** | **BOOLEAN**| Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended). | [optional] 
  **allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended). | [optional] 
  **allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords.  Set to true to allow these file types.  Default is false (recommended). | [optional] 
+ **allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended). | [optional] 
  **restrict_file_types** | **String**| Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files.  All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false.  Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional] 
 
 ### Return type

data/docs/VirusScanAdvancedResult.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **contains_script** | **BOOLEAN** | True if the scan contained a script (such as a PHP script, Python script, etc.) which can be a significant risk factor | [optional] 
 **contains_password_protected_file** | **BOOLEAN** | True if the scan contained a password protected or encrypted file, which can be a significant risk factor | [optional] 
 **contains_restricted_file_format** | **BOOLEAN** | True if the uploaded file is of a type that is not allowed based on the optional restrictFileTypes parameter, false otherwise; if restrictFileTypes is not set, this will always be false | [optional] 
+**contains_macros** | **BOOLEAN** | True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor | [optional] 
 **verified_file_format** | **String** | For file format verification-supported file formats, the contents-verified file format of the file.  Null indicates that the file format is not supported for contents verification.  If a Virus or Malware is found, this field will always be set to Null. | [optional] 
 **found_viruses** | [**Array<VirusFound>**](VirusFound.md) | Array of viruses found, if any | [optional] 
 

data/lib/cloudmersive-virus-scan-api-client/api/scan_api.rb

@@ -82,6 +82,7 @@ module CloudmersiveVirusScanApiClient
     # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords.  Set to true to allow these file types.  Default is false (recommended).
+    # @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended).
     # @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files.  All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false.  Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
     # @return [VirusScanAdvancedResult]
     def scan_file_advanced(input_file, opts = {})
@@ -97,6 +98,7 @@ module CloudmersiveVirusScanApiClient
     # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended).
     # @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords.  Set to true to allow these file types.  Default is false (recommended).
+    # @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended).
     # @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files.  All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false.  Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
     # @return [Array<(VirusScanAdvancedResult, Fixnum, Hash)>] VirusScanAdvancedResult data, response status code and response headers
     def scan_file_advanced_with_http_info(input_file, opts = {})
@@ -123,6 +125,7 @@ module CloudmersiveVirusScanApiClient
       header_params[:'allowInvalidFiles'] = opts[:'allow_invalid_files'] if !opts[:'allow_invalid_files'].nil?
       header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?
       header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
+      header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
       header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
 
       # form parameters

data/lib/cloudmersive-virus-scan-api-client/models/virus_scan_advanced_result.rb

@@ -33,6 +33,9 @@ module CloudmersiveVirusScanApiClient
     # True if the uploaded file is of a type that is not allowed based on the optional restrictFileTypes parameter, false otherwise; if restrictFileTypes is not set, this will always be false
     attr_accessor :contains_restricted_file_format
 
+    # True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor
+    attr_accessor :contains_macros
+
     # For file format verification-supported file formats, the contents-verified file format of the file.  Null indicates that the file format is not supported for contents verification.  If a Virus or Malware is found, this field will always be set to Null.
     attr_accessor :verified_file_format
 
@@ -48,6 +51,7 @@ module CloudmersiveVirusScanApiClient
         :'contains_script' => :'ContainsScript',
         :'contains_password_protected_file' => :'ContainsPasswordProtectedFile',
         :'contains_restricted_file_format' => :'ContainsRestrictedFileFormat',
+        :'contains_macros' => :'ContainsMacros',
         :'verified_file_format' => :'VerifiedFileFormat',
         :'found_viruses' => :'FoundViruses'
       }
@@ -62,6 +66,7 @@ module CloudmersiveVirusScanApiClient
         :'contains_script' => :'BOOLEAN',
         :'contains_password_protected_file' => :'BOOLEAN',
         :'contains_restricted_file_format' => :'BOOLEAN',
+        :'contains_macros' => :'BOOLEAN',
         :'verified_file_format' => :'String',
         :'found_viruses' => :'Array<VirusFound>'
       }
@@ -99,6 +104,10 @@ module CloudmersiveVirusScanApiClient
         self.contains_restricted_file_format = attributes[:'ContainsRestrictedFileFormat']
       end
 
+      if attributes.has_key?(:'ContainsMacros')
+        self.contains_macros = attributes[:'ContainsMacros']
+      end
+
       if attributes.has_key?(:'VerifiedFileFormat')
         self.verified_file_format = attributes[:'VerifiedFileFormat']
       end
@@ -134,6 +143,7 @@ module CloudmersiveVirusScanApiClient
           contains_script == o.contains_script &&
           contains_password_protected_file == o.contains_password_protected_file &&
           contains_restricted_file_format == o.contains_restricted_file_format &&
+          contains_macros == o.contains_macros &&
           verified_file_format == o.verified_file_format &&
           found_viruses == o.found_viruses
     end
@@ -147,7 +157,7 @@ module CloudmersiveVirusScanApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [clean_result, contains_executable, contains_invalid_file, contains_script, contains_password_protected_file, contains_restricted_file_format, verified_file_format, found_viruses].hash
+      [clean_result, contains_executable, contains_invalid_file, contains_script, contains_password_protected_file, contains_restricted_file_format, contains_macros, verified_file_format, found_viruses].hash
     end
 
     # Builds the object from hash

data/lib/cloudmersive-virus-scan-api-client/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
 =end
 
 module CloudmersiveVirusScanApiClient
-  VERSION = '2.0.3'
+  VERSION = '2.0.4'
 end

data/spec/api/scan_api_spec.rb

@@ -53,6 +53,7 @@ describe 'ScanApi' do
   # @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document.  Default is false (recommended).
   # @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file.  Set to true to allow these file types.  Default is false (recommended).
   # @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords.  Set to true to allow these file types.  Default is false (recommended).
+  # @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats.  Set to true to allow these file types.  Default is false (recommended).
   # @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files.  All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false.  Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
   # @return [VirusScanAdvancedResult]
   describe 'scan_file_advanced test' do

data/spec/models/virus_scan_advanced_result_spec.rb

@@ -68,6 +68,12 @@ describe 'VirusScanAdvancedResult' do
     end
   end
 
+  describe 'test attribute "contains_macros"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "verified_file_format"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudmersive-virus-scan-api-client
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Cloudmersive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-26 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus