cloudmersive-convert-api-client 1.6.6 → 1.6.7

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

@@ -0,0 +1,199 @@
+=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.3.1
+
+=end
+
+require 'date'
+
+module CloudmersiveConvertApiClient
+  # Result of detecting text encoding
+  class TextEncodingDetectResponse
+    # True if successful, false otherwise
+    attr_accessor :successful
+
+    # Text encoding used in file; possible values are ASCII, UTF7, UTF8, UTF16, BigEndianUnicode and UTF32
+    attr_accessor :text_encoding
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'successful' => :'Successful',
+        :'text_encoding' => :'TextEncoding'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'successful' => :'BOOLEAN',
+        :'text_encoding' => :'String'
+      }
+    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?(:'TextEncoding')
+        self.text_encoding = attributes[:'TextEncoding']
+      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
+    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
+    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 &&
+          text_encoding == o.text_encoding
+    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, text_encoding].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 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.3.1
 =end
 
 module CloudmersiveConvertApiClient
-  VERSION = "1.6.6"
+  VERSION = "1.6.7"
 end

data/spec/api/convert_document_api_spec.rb

@@ -146,6 +146,7 @@ describe 'ConvertDocumentApi' do
   # Convert Office Word Documents (docx) to text
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :text_formatting_mode Optional; specify how whitespace should be handled when converting the document to text.  Possible values are 'preserveWhitespace' which will attempt to preserve whitespace in the document and relative positioning of text within the document, and 'minimizeWhitespace' which will not insert additional spaces into the document in most cases.  Default is 'minimizeWhitespace'.
   # @return [TextConversionResult]
   describe 'convert_document_docx_to_txt test' do
     it "should work" do

data/spec/api/edit_document_api_spec.rb

@@ -34,7 +34,7 @@ describe 'EditDocumentApi' do
 
   # unit tests for edit_document_begin_editing
   # Begin editing a document
-  # Uploads a document to Cloudmersive to begin a series of one or more editing operations
+  # Uploads a document to Cloudmersive to begin a series of one or more editing operations.  To edit a document, first call Begin Editing on the document.  Then perform operations on the document using the secure URL returned from BeginEditing, such as Word DOCX Delete Pages and Insert Table.  Finally, perform finish editing on the URL to return the resulting edited document.  The editing URL is temporary and only stored in-memory cache, and will automatically expire from the cache after 30 minutes, and cannot be directly accessed.
   # @param input_file Input file to perform the operation on.
   # @param [Hash] opts the optional parameters
   # @return [String]
@@ -58,7 +58,7 @@ describe 'EditDocumentApi' do
 
   # unit tests for edit_document_docx_create_blank_document
   # Create a blank Word DOCX document
-  # Returns a blank Word DOCX Document format file
+  # Returns a blank Word DOCX Document format file.  The file is blank, with no contents.  Use additional editing commands such as Insert Paragraph or Insert Table or Insert Image to populate the document.
   # @param input Document input request
   # @param [Hash] opts the optional parameters
   # @return [CreateBlankDocxResponse]
@@ -381,7 +381,7 @@ describe 'EditDocumentApi' do
   end
 
   # unit tests for edit_document_finish_editing
-  # Download result from document editing
+  # Finish editing document, and download result from document editing
   # Once done editing a document, download the result.  Begin editing a document by calling begin-editing, then perform operations, then call finish-editing to get the result.
   # @param req_config Cloudmersive Document URL to complete editing on
   # @param [Hash] opts the optional parameters

data/spec/api/edit_text_api_spec.rb

@@ -0,0 +1,144 @@
+=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.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for CloudmersiveConvertApiClient::EditTextApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'EditTextApi' do
+  before do
+    # run before each test
+    @instance = CloudmersiveConvertApiClient::EditTextApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EditTextApi' do
+    it 'should create an instance of EditTextApi' do
+      expect(@instance).to be_instance_of(CloudmersiveConvertApiClient::EditTextApi)
+    end
+  end
+
+  # unit tests for edit_text_base64_decode
+  # Base 64 decode, convert base 64 string to binary content
+  # Decodes / converts base 64 UTF-8 text string to binary content
+  # @param request 
+  # @param [Hash] opts the optional parameters
+  # @return [Base64DecodeResponse]
+  describe 'edit_text_base64_decode 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_text_base64_detect
+  # Detect, check if text string is base 64 encoded
+  # Checks, detects if input string is base 64 encoded
+  # @param request 
+  # @param [Hash] opts the optional parameters
+  # @return [Base64DetectResponse]
+  describe 'edit_text_base64_detect 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_text_base64_encode
+  # Base 64 encode, convert binary or file data to a text string
+  # Encodes / converts binary or file data to a text string
+  # @param request 
+  # @param [Hash] opts the optional parameters
+  # @return [Base64EncodeResponse]
+  describe 'edit_text_base64_encode 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_text_change_line_endings
+  # Set, change line endings of a text file
+  # Sets the line ending type of a text file; set to Windows, Unix or Mac.
+  # @param line_ending_type Required; 'Windows' will use carriage return and line feed, 'Unix' will use newline, and 'Mac' will use carriage return
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [ChangeLineEndingResponse]
+  describe 'edit_text_change_line_endings 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_text_detect_line_endings
+  # Detect line endings of a text file
+  # Detect line ending type (Windows, Unix or Mac) of an input file.
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [DetectLineEndingsResponse]
+  describe 'edit_text_detect_line_endings 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_text_remove_all_whitespace
+  # Remove whitespace from text string
+  # Removes all whitespace from text, leaving behind only non-whitespace characters.  Whitespace includes newlines, spaces and other whitespace characters.
+  # @param request 
+  # @param [Hash] opts the optional parameters
+  # @return [RemoveWhitespaceFromTextResponse]
+  describe 'edit_text_remove_all_whitespace 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_text_remove_html
+  # Remove HTML from text string
+  # Removes HTML from text, leaving behind only text.  Formatted text will become plain text.  Important for protecting against HTML and Cross-Site-Scripting attacks.
+  # @param request 
+  # @param [Hash] opts the optional parameters
+  # @return [RemoveHtmlFromTextResponse]
+  describe 'edit_text_remove_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 edit_text_text_encoding_detect
+  # Detect text encoding of file
+  # Checks text encoding of file
+  # @param input_file Input file to perform the operation on.
+  # @param [Hash] opts the optional parameters
+  # @return [TextEncodingDetectResponse]
+  describe 'edit_text_text_encoding_detect 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_text_trim_whitespace
+  # Trim leading and trailing whitespace from text string
+  # Trim leading and trailing whitespace from text, leaving behind a trimmed string.  Whitespace includes newlines, spaces and other whitespace characters.
+  # @param request 
+  # @param [Hash] opts the optional parameters
+  # @return [RemoveWhitespaceFromTextResponse]
+  describe 'edit_text_trim_whitespace 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

@@ -147,6 +147,40 @@ describe 'MergeDocumentApi' do
     end
   end
 
+  # unit tests for merge_document_txt
+  # Merge Two Text (TXT) Files Together
+  # Combine two Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.
+  # @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_txt 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_txt_multi
+  # Merge Multple Text (TXT) Files Together
+  # Combine multiple Text (.TXT) files into a single text document, preserving the order of the input documents in the combined document by stacking them vertically.
+  # @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_txt_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_xlsx
   # Merge Two Excel XLSX Together
   # Combine two Office Excel spreadsheets (xlsx) into a single Office Excel spreadsheet

data/spec/api/split_document_api_spec.rb

@@ -83,6 +83,20 @@ describe 'SplitDocumentApi' do
     end
   end
 
+  # unit tests for split_document_txt_by_string
+  # Split a single Text file (txt) by a string delimiter
+  # Split a Text (txt) Document by a string delimiter, returning each component of the string as an array of strings.
+  # @param input_file Input file to perform the operation on.
+  # @param split_delimiter Required; String to split up the input file on
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :skip_empty_elements Optional; If true, empty elements will be skipped in the output
+  # @return [SplitTextDocumentByStringResult]
+  describe 'split_document_txt_by_string 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 split_document_xlsx
   # Split a single Excel XLSX into Separate Worksheets
   # Split an Excel XLSX Spreadsheet, comprised of multiple Worksheets (or Tabs) into separate Excel XLSX spreadsheet files, with each containing exactly one Worksheet.