cloudmersive-virus-scan-api-client 2.0.5 → 2.0.6

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1aa22e0c643d86c6436ad703a9282aac3e5548b1582a998f563445899199a7f7
4
- data.tar.gz: bfe914cdcec515255a07c13b34ad1c9ff2b9cdf2aae7b6a0af01e8ddd4be07ec
3
+ metadata.gz: 2b219ed89cc3e638e3eb9346a852aa828a4506074ee28a13275a91e29ce2909c
4
+ data.tar.gz: e50917fa99b594f83a7e0df10eeb30b29ff476137f4e8d4e9892aa39cb4b5c1c
5
5
  SHA512:
6
- metadata.gz: a95720af23249e82bf31da9cf0ea88e4e3013edf6667fa0d54659533a9673fcf61d25f285b0342c18e14878b4294a24f87507bc08460e8b97fd649fbd67a8be5
7
- data.tar.gz: a330e9902de32ce7d2ed3d44b7a2d13655d5bd679c7f6615e5a0024095fdb89691ba354d30ec7b1c02c0f85016d660c1033f3a367912f356ac6dbb72a9067a78
6
+ metadata.gz: e8f7c2d1cf525858c66a4a132441772a101de3f5cb6dcd4a86906f18a11b6ee2329eab4bae1cdc0a80d43f26a6f3676b135def6ab36f075e9b9f49b68ce4af9d
7
+ data.tar.gz: a0012c90dd060ea92615cc53d474ae6865ec616cd0641504dbf662a7e7f70b6ec7e3fac5b4fe12e634f1e072f75b9275d65caf2d55b17f2ffa57c9160cd85b88
data/README.md CHANGED
@@ -7,7 +7,7 @@ The Cloudmersive Virus Scan API lets you scan files and content for viruses and
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 2.0.5
10
+ - Package version: 2.0.6
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-virus-scan-api-client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./cloudmersive-virus-scan-api-client-2.0.5.gem
26
+ gem install ./cloudmersive-virus-scan-api-client-2.0.6.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.0.5.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.0.6.gem` to install the development dependencies)
29
29
 
30
30
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
31
 
32
32
  Finally add this to the Gemfile:
33
33
 
34
- gem 'cloudmersive-virus-scan-api-client', '~> 2.0.5'
34
+ gem 'cloudmersive-virus-scan-api-client', '~> 2.0.6'
35
35
 
36
36
  ### Install from Git
37
37
 
data/docs/ScanApi.md CHANGED
@@ -92,6 +92,7 @@ opts = {
92
92
  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).
93
93
  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).
94
94
  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).
95
+ allow_xml_external_entities: true, # BOOLEAN | Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
95
96
  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.
96
97
  }
97
98
 
@@ -114,6 +115,7 @@ Name | Type | Description | Notes
114
115
  **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]
115
116
  **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]
116
117
  **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]
118
+ **allow_xml_external_entities** | **BOOLEAN**| Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
117
119
  **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]
118
120
 
119
121
  ### Return type
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **contains_password_protected_file** | **BOOLEAN** | True if the scan contained a password protected or encrypted file, which can be a significant risk factor | [optional]
11
11
  **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]
12
12
  **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]
13
+ **contains_xml_external_entities** | **BOOLEAN** | True if the uploaded file contains embedded XML External Entity threats of other embedded threats within the document, which can be a significant risk factor | [optional]
13
14
  **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]
14
15
  **found_viruses** | [**Array<VirusFound>**](VirusFound.md) | Array of viruses found, if any | [optional]
15
16
 
@@ -83,6 +83,7 @@ module CloudmersiveVirusScanApiClient
83
83
  # @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).
84
84
  # @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).
85
85
  # @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).
86
+ # @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
86
87
  # @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.
87
88
  # @return [VirusScanAdvancedResult]
88
89
  def scan_file_advanced(input_file, opts = {})
@@ -99,6 +100,7 @@ module CloudmersiveVirusScanApiClient
99
100
  # @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).
100
101
  # @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).
101
102
  # @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).
103
+ # @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
102
104
  # @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.
103
105
  # @return [Array<(VirusScanAdvancedResult, Fixnum, Hash)>] VirusScanAdvancedResult data, response status code and response headers
104
106
  def scan_file_advanced_with_http_info(input_file, opts = {})
@@ -126,6 +128,7 @@ module CloudmersiveVirusScanApiClient
126
128
  header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?
127
129
  header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
128
130
  header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
131
+ header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
129
132
  header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
130
133
 
131
134
  # form parameters
@@ -36,6 +36,9 @@ module CloudmersiveVirusScanApiClient
36
36
  # True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor
37
37
  attr_accessor :contains_macros
38
38
 
39
+ # True if the uploaded file contains embedded XML External Entity threats of other embedded threats within the document, which can be a significant risk factor
40
+ attr_accessor :contains_xml_external_entities
41
+
39
42
  # 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.
40
43
  attr_accessor :verified_file_format
41
44
 
@@ -52,6 +55,7 @@ module CloudmersiveVirusScanApiClient
52
55
  :'contains_password_protected_file' => :'ContainsPasswordProtectedFile',
53
56
  :'contains_restricted_file_format' => :'ContainsRestrictedFileFormat',
54
57
  :'contains_macros' => :'ContainsMacros',
58
+ :'contains_xml_external_entities' => :'ContainsXmlExternalEntities',
55
59
  :'verified_file_format' => :'VerifiedFileFormat',
56
60
  :'found_viruses' => :'FoundViruses'
57
61
  }
@@ -67,6 +71,7 @@ module CloudmersiveVirusScanApiClient
67
71
  :'contains_password_protected_file' => :'BOOLEAN',
68
72
  :'contains_restricted_file_format' => :'BOOLEAN',
69
73
  :'contains_macros' => :'BOOLEAN',
74
+ :'contains_xml_external_entities' => :'BOOLEAN',
70
75
  :'verified_file_format' => :'String',
71
76
  :'found_viruses' => :'Array<VirusFound>'
72
77
  }
@@ -108,6 +113,10 @@ module CloudmersiveVirusScanApiClient
108
113
  self.contains_macros = attributes[:'ContainsMacros']
109
114
  end
110
115
 
116
+ if attributes.has_key?(:'ContainsXmlExternalEntities')
117
+ self.contains_xml_external_entities = attributes[:'ContainsXmlExternalEntities']
118
+ end
119
+
111
120
  if attributes.has_key?(:'VerifiedFileFormat')
112
121
  self.verified_file_format = attributes[:'VerifiedFileFormat']
113
122
  end
@@ -144,6 +153,7 @@ module CloudmersiveVirusScanApiClient
144
153
  contains_password_protected_file == o.contains_password_protected_file &&
145
154
  contains_restricted_file_format == o.contains_restricted_file_format &&
146
155
  contains_macros == o.contains_macros &&
156
+ contains_xml_external_entities == o.contains_xml_external_entities &&
147
157
  verified_file_format == o.verified_file_format &&
148
158
  found_viruses == o.found_viruses
149
159
  end
@@ -157,7 +167,7 @@ module CloudmersiveVirusScanApiClient
157
167
  # Calculates hash code according to all attributes.
158
168
  # @return [Fixnum] Hash code
159
169
  def hash
160
- [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
170
+ [clean_result, contains_executable, contains_invalid_file, contains_script, contains_password_protected_file, contains_restricted_file_format, contains_macros, contains_xml_external_entities, verified_file_format, found_viruses].hash
161
171
  end
162
172
 
163
173
  # Builds the object from hash
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
11
11
  =end
12
12
 
13
13
  module CloudmersiveVirusScanApiClient
14
- VERSION = '2.0.5'
14
+ VERSION = '2.0.6'
15
15
  end
@@ -54,6 +54,7 @@ describe 'ScanApi' do
54
54
  # @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).
55
55
  # @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).
56
56
  # @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).
57
+ # @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
57
58
  # @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&#x3D;false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
58
59
  # @return [VirusScanAdvancedResult]
59
60
  describe 'scan_file_advanced test' do
@@ -74,6 +74,12 @@ describe 'VirusScanAdvancedResult' do
74
74
  end
75
75
  end
76
76
 
77
+ describe 'test attribute "contains_xml_external_entities"' do
78
+ it 'should work' do
79
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
80
+ end
81
+ end
82
+
77
83
  describe 'test attribute "verified_file_format"' do
78
84
  it 'should work' do
79
85
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cloudmersive-virus-scan-api-client
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.5
4
+ version: 2.0.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Cloudmersive
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-06-27 00:00:00.000000000 Z
11
+ date: 2021-07-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus