cloudmersive-virus-scan-api-client 1.3.1 → 2.0.2

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

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.14
 
 =end
 
@@ -27,6 +27,9 @@ module CloudmersiveVirusScanApiClient
     # True if the scan contained a script (such as a PHP script, Python script, etc.) which can be a significant risk factor
     attr_accessor :contains_script
 
+    # True if the scan contained a password protected or encrypted file, which can be a significant risk factor
+    attr_accessor :contains_password_protected_file
+
     # 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
 
@@ -36,7 +39,6 @@ module CloudmersiveVirusScanApiClient
     # Array of viruses found, if any
     attr_accessor :found_viruses
 
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -44,6 +46,7 @@ module CloudmersiveVirusScanApiClient
         :'contains_executable' => :'ContainsExecutable',
         :'contains_invalid_file' => :'ContainsInvalidFile',
         :'contains_script' => :'ContainsScript',
+        :'contains_password_protected_file' => :'ContainsPasswordProtectedFile',
         :'contains_restricted_file_format' => :'ContainsRestrictedFileFormat',
         :'verified_file_format' => :'VerifiedFileFormat',
         :'found_viruses' => :'FoundViruses'
@@ -57,6 +60,7 @@ module CloudmersiveVirusScanApiClient
         :'contains_executable' => :'BOOLEAN',
         :'contains_invalid_file' => :'BOOLEAN',
         :'contains_script' => :'BOOLEAN',
+        :'contains_password_protected_file' => :'BOOLEAN',
         :'contains_restricted_file_format' => :'BOOLEAN',
         :'verified_file_format' => :'String',
         :'found_viruses' => :'Array<VirusFound>'
@@ -69,7 +73,7 @@ module CloudmersiveVirusScanApiClient
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'CleanResult')
         self.clean_result = attributes[:'CleanResult']
@@ -87,6 +91,10 @@ module CloudmersiveVirusScanApiClient
         self.contains_script = attributes[:'ContainsScript']
       end
 
+      if attributes.has_key?(:'ContainsPasswordProtectedFile')
+        self.contains_password_protected_file = attributes[:'ContainsPasswordProtectedFile']
+      end
+
       if attributes.has_key?(:'ContainsRestrictedFileFormat')
         self.contains_restricted_file_format = attributes[:'ContainsRestrictedFileFormat']
       end
@@ -100,20 +108,19 @@ module CloudmersiveVirusScanApiClient
           self.found_viruses = value
         end
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      return invalid_properties
+      invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return true
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -125,6 +132,7 @@ module CloudmersiveVirusScanApiClient
           contains_executable == o.contains_executable &&
           contains_invalid_file == o.contains_invalid_file &&
           contains_script == o.contains_script &&
+          contains_password_protected_file == o.contains_password_protected_file &&
           contains_restricted_file_format == o.contains_restricted_file_format &&
           verified_file_format == o.verified_file_format &&
           found_viruses == o.found_viruses
@@ -139,7 +147,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_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, verified_file_format, found_viruses].hash
     end
 
     # Builds the object from hash
@@ -149,10 +157,10 @@ module CloudmersiveVirusScanApiClient
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -234,7 +242,7 @@ module CloudmersiveVirusScanApiClient
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map{ |v| _to_hash(v) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -247,5 +255,4 @@ module CloudmersiveVirusScanApiClient
     end
 
   end
-
 end

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

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.14
 
 =end
 
@@ -21,7 +21,6 @@ module CloudmersiveVirusScanApiClient
     # Array of viruses found, if any
     attr_accessor :found_viruses
 
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -44,7 +43,7 @@ module CloudmersiveVirusScanApiClient
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'CleanResult')
         self.clean_result = attributes[:'CleanResult']
@@ -55,20 +54,19 @@ module CloudmersiveVirusScanApiClient
           self.found_viruses = value
         end
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      return invalid_properties
+      invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return true
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -99,10 +97,10 @@ module CloudmersiveVirusScanApiClient
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -184,7 +182,7 @@ module CloudmersiveVirusScanApiClient
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map{ |v| _to_hash(v) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -197,5 +195,4 @@ module CloudmersiveVirusScanApiClient
     end
 
   end
-
 end

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

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.14
 
 =end
 
@@ -18,7 +18,6 @@ module CloudmersiveVirusScanApiClient
     # URL of the website to scan; should begin with http:// or https://
     attr_accessor :url
 
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -39,25 +38,24 @@ module CloudmersiveVirusScanApiClient
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'Url')
         self.url = attributes[:'Url']
       end
-
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      return invalid_properties
+      invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return true
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -87,10 +85,10 @@ module CloudmersiveVirusScanApiClient
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -172,7 +170,7 @@ module CloudmersiveVirusScanApiClient
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map{ |v| _to_hash(v) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -185,5 +183,4 @@ module CloudmersiveVirusScanApiClient
     end
 
   end
-
 end

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

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.14
 
 =end
 
@@ -21,6 +21,12 @@ module CloudmersiveVirusScanApiClient
     # Type of threat returned; can be None, Malware, ForcedDownload or Phishing
     attr_accessor :website_threat_type
 
+    # Array of viruses found, if any
+    attr_accessor :found_viruses
+
+    # The remote server URL HTTP reasponse code; useful for debugging issues with scanning; typically if the remote server returns a 200 or 300-series code this means a successful response, while a 400 or 500 series code would represent an error returned from the remote server for the provided URL.
+    attr_accessor :website_http_response_code
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -47,7 +53,9 @@ module CloudmersiveVirusScanApiClient
     def self.attribute_map
       {
         :'clean_result' => :'CleanResult',
-        :'website_threat_type' => :'WebsiteThreatType'
+        :'website_threat_type' => :'WebsiteThreatType',
+        :'found_viruses' => :'FoundViruses',
+        :'website_http_response_code' => :'WebsiteHttpResponseCode'
       }
     end
 
@@ -55,7 +63,9 @@ module CloudmersiveVirusScanApiClient
     def self.swagger_types
       {
         :'clean_result' => :'BOOLEAN',
-        :'website_threat_type' => :'String'
+        :'website_threat_type' => :'String',
+        :'found_viruses' => :'Array<VirusFound>',
+        :'website_http_response_code' => :'Integer'
       }
     end
 
@@ -65,7 +75,7 @@ module CloudmersiveVirusScanApiClient
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
       if attributes.has_key?(:'CleanResult')
         self.clean_result = attributes[:'CleanResult']
@@ -75,29 +85,38 @@ module CloudmersiveVirusScanApiClient
         self.website_threat_type = attributes[:'WebsiteThreatType']
       end
 
+      if attributes.has_key?(:'FoundViruses')
+        if (value = attributes[:'FoundViruses']).is_a?(Array)
+          self.found_viruses = value
+        end
+      end
+
+      if attributes.has_key?(:'WebsiteHttpResponseCode')
+        self.website_http_response_code = attributes[:'WebsiteHttpResponseCode']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      return invalid_properties
+      invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      website_threat_type_validator = EnumAttributeValidator.new('String', ["None", "Malware", "Phishing", "ForcedDownload", "UnableToConnect"])
+      website_threat_type_validator = EnumAttributeValidator.new('String', ['None', 'Malware', 'Phishing', 'ForcedDownload', 'UnableToConnect'])
       return false unless website_threat_type_validator.valid?(@website_threat_type)
-      return true
+      true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] website_threat_type Object to be assigned
     def website_threat_type=(website_threat_type)
-      validator = EnumAttributeValidator.new('String', ["None", "Malware", "Phishing", "ForcedDownload", "UnableToConnect"])
+      validator = EnumAttributeValidator.new('String', ['None', 'Malware', 'Phishing', 'ForcedDownload', 'UnableToConnect'])
       unless validator.valid?(website_threat_type)
-        fail ArgumentError, "invalid value for 'website_threat_type', must be one of #{validator.allowable_values}."
+        fail ArgumentError, 'invalid value for "website_threat_type", must be one of #{validator.allowable_values}.'
       end
       @website_threat_type = website_threat_type
     end
@@ -108,7 +127,9 @@ module CloudmersiveVirusScanApiClient
       return true if self.equal?(o)
       self.class == o.class &&
           clean_result == o.clean_result &&
-          website_threat_type == o.website_threat_type
+          website_threat_type == o.website_threat_type &&
+          found_viruses == o.found_viruses &&
+          website_http_response_code == o.website_http_response_code
     end
 
     # @see the `==` method
@@ -120,7 +141,7 @@ module CloudmersiveVirusScanApiClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [clean_result, website_threat_type].hash
+      [clean_result, website_threat_type, found_viruses, website_http_response_code].hash
     end
 
     # Builds the object from hash
@@ -130,10 +151,10 @@ module CloudmersiveVirusScanApiClient
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
         if type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the the attribute
+          # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
           if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
@@ -215,7 +236,7 @@ module CloudmersiveVirusScanApiClient
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map{ |v| _to_hash(v) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -228,5 +249,4 @@ module CloudmersiveVirusScanApiClient
     end
 
   end
-
 end

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

@@ -6,10 +6,10 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.14
 
 =end
 
 module CloudmersiveVirusScanApiClient
-  VERSION = "1.3.1"
+  VERSION = '2.0.2'
 end

data/spec/api/scan_api_spec.rb

@@ -6,7 +6,7 @@
 OpenAPI spec version: v1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
+Swagger Codegen version: 2.4.14
 
 =end
 
@@ -39,7 +39,7 @@ describe 'ScanApi' do
   # @param [Hash] opts the optional parameters
   # @return [VirusScanResult]
   describe 'scan_file test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -52,10 +52,11 @@ describe 'ScanApi' do
   # @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file.  Default is false (recommended).
   # @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, Pythong 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 [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
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
@@ -67,7 +68,7 @@ describe 'ScanApi' do
   # @param [Hash] opts the optional parameters
   # @return [WebsiteScanResult]
   describe 'scan_website test' do
-    it "should work" do
+    it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end