cloudmersive-convert-api-client 2.1.3 → 2.1.8

data/lib/cloudmersive-convert-api-client/models/xxe_threat_detection_result.rb

@@ -0,0 +1,196 @@
+=begin
+#convertapi
+
+#Convert API lets you effortlessly convert file formats and types.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'date'
+
+module CloudmersiveConvertApiClient
+  # Result of performing an XXE threat detection operation
+  class XxeThreatDetectionResult
+    # True if the operation was successful, false otherwise
+    attr_accessor :successful
+
+    # True if the XML input contains XXE threats, false otherwise
+    attr_accessor :contains_xxe_threat
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'successful' => :'Successful',
+        :'contains_xxe_threat' => :'ContainsXxeThreat'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'successful' => :'BOOLEAN',
+        :'contains_xxe_threat' => :'BOOLEAN'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      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 }
+
+      if attributes.has_key?(:'Successful')
+        self.successful = attributes[:'Successful']
+      end
+
+      if attributes.has_key?(:'ContainsXxeThreat')
+        self.contains_xxe_threat = attributes[:'ContainsXxeThreat']
+      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
+      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?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          successful == o.successful &&
+          contains_xxe_threat == o.contains_xxe_threat
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [successful, contains_xxe_threat].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      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 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) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CloudmersiveConvertApiClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @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) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/cloudmersive-convert-api-client/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.14
 =end
 
 module CloudmersiveConvertApiClient
-  VERSION = '2.1.3'
+  VERSION = '2.1.8'
 end

data/spec/api/edit_document_api_spec.rb

@@ -200,6 +200,18 @@ describe 'EditDocumentApi' do
     end
   end
 
+  # unit tests for edit_document_docx_get_macro_information
+  # Get macro information from a Word DOCX/DOCM document
+  # Returns information about the Macros (e.g. VBA) defined in the Word Document
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [GetMacrosResponse]
+  describe 'edit_document_docx_get_macro_information test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for edit_document_docx_get_metadata_properties
   # Get all metadata properties in Word DOCX document
   # Returns all the metadata properties in an Office Word Document (docx)
@@ -512,6 +524,18 @@ describe 'EditDocumentApi' do
     end
   end
 
+  # unit tests for edit_document_pptx_get_macro_information
+  # Get macro information from a PowerPoint PPTX/PPTM presentation document
+  # Returns information about the Macros (e.g. VBA) defined in the PowerPoint Document
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [GetMacrosResponse]
+  describe 'edit_document_pptx_get_macro_information test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for edit_document_pptx_replace
   # Replace string in PowerPoint PPTX presentation
   # Replace all instances of a string in an Office PowerPoint Document (pptx)
@@ -668,6 +692,18 @@ describe 'EditDocumentApi' do
     end
   end
 
+  # unit tests for edit_document_xlsx_get_macro_information
+  # Get macro information from a Excel XLSX/XLSM spreadsheet, worksheet
+  # Returns information about the Macros (e.g. VBA) defined in the Excel Spreadsheet
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [GetMacrosResponse]
+  describe 'edit_document_xlsx_get_macro_information test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for edit_document_xlsx_get_rows_and_cells
   # Get rows and cells from a Excel XLSX spreadsheet, worksheet
   # Returns the rows and cells defined in the Excel Spreadsheet worksheet

data/spec/api/edit_html_api_spec.rb

@@ -111,4 +111,18 @@ describe 'EditHtmlApi' do
     end
   end
 
+  # unit tests for edit_html_html_get_links
+  # Extract resolved link URLs from HTML File
+  # Extracts the resolved link URLs, fully-qualified if possible, from an input HTML file.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :input_file Optional: Input file to perform the operation on.
+  # @option opts [String] :input_file_url Optional: URL of a file to operate on as input.
+  # @option opts [String] :base_url Optional: Base URL of the page, such as https://mydomain.com
+  # @return [HtmlGetLinksResponse]
+  describe 'edit_html_html_get_links test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
 end

data/spec/api/merge_document_api_spec.rb

@@ -66,6 +66,40 @@ describe 'MergeDocumentApi' do
     end
   end
 
+  # unit tests for merge_document_html
+  # Merge Two HTML (HTM) Files Together
+  # Combine two HTML (.HTM) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.  The title will be taken from the first document.
+  # @param input_file1 First input file to perform the operation on.
+  # @param input_file2 Second input file to perform the operation on (more than 2 can be supplied).
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'merge_document_html test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for merge_document_html_multi
+  # Merge Multple HTML (HTM) Files Together
+  # Combine multiple HTML (.HTM) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.  The title will be taken from the first document.
+  # @param input_file1 First input file to perform the operation on.
+  # @param input_file2 Second input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :input_file3 Third input file to perform the operation on.
+  # @option opts [File] :input_file4 Fourth input file to perform the operation on.
+  # @option opts [File] :input_file5 Fifth input file to perform the operation on.
+  # @option opts [File] :input_file6 Sixth input file to perform the operation on.
+  # @option opts [File] :input_file7 Seventh input file to perform the operation on.
+  # @option opts [File] :input_file8 Eighth input file to perform the operation on.
+  # @option opts [File] :input_file9 Ninth input file to perform the operation on.
+  # @option opts [File] :input_file10 Tenth input file to perform the operation on.
+  # @return [String]
+  describe 'merge_document_html_multi test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for merge_document_pdf
   # Merge Two PDF Files Together
   # Combine two PDF files (pdf) into a single PDF document, preserving the order of the input documents in the combined document

data/spec/api/validate_document_api_spec.rb

@@ -104,6 +104,18 @@ describe 'ValidateDocumentApi' do
     end
   end
 
+  # unit tests for validate_document_html_ssrf_validation
+  # Validate an HTML file and checks for SSRF threats
+  # Validate an HTML document file and checks for SSRF (Server-side Request Forgery) threats in the file; if the document is not valid, identifies the errors in the document
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [HtmlSsrfThreatCheckResult]
+  describe 'validate_document_html_ssrf_validation test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for validate_document_html_validation
   # Validate an HTML file
   # Validate an HTML document file; if the document is not valid, identifies the errors in the document
@@ -128,6 +140,18 @@ describe 'ValidateDocumentApi' do
     end
   end
 
+  # unit tests for validate_document_jpg_validation
+  # Validate a JPG File
+  # Validate a JPEG image file; if the document is not valid, identifies the errors in the document..
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentValidationResult]
+  describe 'validate_document_jpg_validation test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for validate_document_json_validation
   # Validate a JSON file
   # Validate a JSON (JavaScript Object Notation) document file; if the document is not valid, identifies the errors in the document
@@ -164,6 +188,18 @@ describe 'ValidateDocumentApi' do
     end
   end
 
+  # unit tests for validate_document_png_validation
+  # Validate a PNG File
+  # Validate a PNG image file; if the document is not valid, identifies the errors in the document.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentValidationResult]
+  describe 'validate_document_png_validation test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for validate_document_pptx_validation
   # Validate a PowerPoint presentation (PPTX)
   # Validate a PowerPoint presentation (PPTX); if the document is not valid, identifies the errors in the document
@@ -236,6 +272,18 @@ describe 'ValidateDocumentApi' do
     end
   end
 
+  # unit tests for validate_document_xml_xxe_threat_validation
+  # Validate an XML file for XML External Entity (XXE) threats
+  # Validate an XML document file for XML External Entity (XXE) threats; if the document is not valid, identifies the errors in the document.  XXE threats are a type of threat that exploits vulnerabilities in the XML standard relating to external or local entity URIs in XML documents.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [XxeThreatDetectionResult]
+  describe 'validate_document_xml_xxe_threat_validation test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for validate_document_zip_validation
   # Validate a Zip Archive file (zip)
   # Validate a Zip archive file (ZIP)

data/spec/api/zip_archive_api_spec.rb

@@ -88,6 +88,20 @@ describe 'ZipArchiveApi' do
     end
   end
 
+  # unit tests for zip_archive_zip_create_quarantine
+  # Create an encrypted zip file to quarantine a dangerous file
+  # Create a new zip archive by compressing input files, and also applies encryption and password protection to the zip, for the purposes of quarantining the underlyikng file.
+  # @param password Password to place on the Zip file; the longer the password, the more secure
+  # @param input_file1 First input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :encryption_algorithm Encryption algorithm to use; possible values are AES-256 (recommended), AES-128, and PK-Zip (not recommended; legacy, weak encryption algorithm). Default is AES-256.
+  # @return [Object]
+  describe 'zip_archive_zip_create_quarantine test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for zip_archive_zip_decrypt
   # Decrypt and remove password protection on a zip file
   # Decrypts and removes password protection from an encrypted zip file with the specified password

data/spec/models/get_macros_response_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#convertapi
+
+#Convert API lets you effortlessly convert file formats and types.
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.14
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for CloudmersiveConvertApiClient::GetMacrosResponse
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'GetMacrosResponse' do
+  before do
+    # run before each test
+    @instance = CloudmersiveConvertApiClient::GetMacrosResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of GetMacrosResponse' do
+    it 'should create an instance of GetMacrosResponse' do
+      expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::GetMacrosResponse)
+    end
+  end
+  describe 'test attribute "successful"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "contains_vba_macros"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end