groupdocs_comparison_cloud 18.9 → 21.3.1

data/lib/groupdocs_comparison_cloud/api_client.rb

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------------
 # <copyright company="Aspose Pty Ltd" file="api_client.rb">
-#   Copyright (c) 2003-2018 Aspose Pty Ltd
+#   Copyright (c) 2003-2021 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -51,7 +51,7 @@ module GroupDocsComparisonCloud
     def initialize(config)
       @config = config
       @default_headers = {
-        'Content-Type' => "application/json",
+        'Content-Type' => config.api_version == '' ? "application/x-www-form-urlencoded" : "application/json",
         'x-groupdocs-client' => "ruby sdk",
         'x-groupdocs-version' => GroupDocsComparisonCloud::VERSION.to_s
       }
@@ -69,18 +69,8 @@ module GroupDocsComparisonCloud
       end
 
       unless response.success?
-        if response.status == 0
-          # Errors from libcurl will be made visible here
-          raise ApiError.new(:code => 0,
-                            :message => response.reason_phrase)
-        else
-          raise ApiError.new(:code => response.status,
-                            :response_headers => response.headers,
-                            :response_body => response.body),
-               response.reason_phrase
-        end
+        raise ApiError.new(:code => response.status, :response_body => response.body)
       end
-
       
       data = deserialize(response, opts[:return_type]) if opts[:return_type]
       [data, response.status, response.headers]
@@ -250,7 +240,7 @@ module GroupDocsComparisonCloud
       encoding = response.body.encoding
       tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
       @tempfile = tempfile
-      IO.binwrite(tempfile, response.body)
+      tempfile.write(response.body)
       response.on_complete do |resp|
         tempfile.close
         @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
@@ -283,7 +273,9 @@ module GroupDocsComparisonCloud
     # @return [String] HTTP body data in the form of string
     def build_request_body(header_params, form_params, body)
       # http form
-      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
+      if body
+        data = body.is_a?(String) ? body : body.to_json      
+      elsif header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
           header_params['Content-Type'] == 'multipart/form-data'
         data = {}
         form_params.each do |key, value|
@@ -296,8 +288,6 @@ module GroupDocsComparisonCloud
             data[key] = value.to_s
           end
         end
-      elsif body
-        data = body.is_a?(String) ? body : body.to_json
       else
         data = nil
       end

data/lib/groupdocs_comparison_cloud/api_error.rb

@@ -1,6 +1,6 @@
 # -----------------------------------------------------------------------------------
 # <copyright company="Aspose Pty Ltd" file="api_error.rb">
-#   Copyright (c) 2003-2018 Aspose Pty Ltd
+#   Copyright (c) 2003-2021 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -39,13 +39,28 @@ module GroupDocsComparisonCloud
         
         if arg.key?(:response_body) then
           data = JSON.parse(arg[:response_body], :symbolize_names => true)
-          if !data.nil? && !data[:error].nil? then
-            @message = data[:error][:message]
+          if !data.nil? then
+            if !data[:error].nil? then
+              error = data[:error]
+              if error.kind_of?(String) then
+                @message = error
+              else
+                @message = error[:message]
+              end
+            else
+              message = data[:message]
+              if !message.nil? && message.kind_of?(String) then
+                @message = message
+                @code = data[:code]
+              else
+                @message = data
+              end              
+            end
           end
         end
 
         if arg.key?(:arg) then
-          @code = arg[:code]
+          @code = arg[:Code]
         end
         
       else

data/lib/groupdocs_comparison_cloud/configuration.rb

@@ -1,6 +1,6 @@
 # ------------------------------------------------------------------------------------
 # <copyright company="Aspose Pty Ltd" file="configuration.rb">
-#   Copyright (c) 2003-2018 Aspose Pty Ltd
+#   Copyright (c) 2003-2021 Aspose Pty Ltd
 # </copyright>
 # <summary>
 #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -34,7 +34,7 @@ module GroupDocsComparisonCloud
     # @return [String] Api base url
     attr_accessor :api_base_url
 
-    # Api version, default is '/v1'
+    # Api version, default is '/v2.0'
     #
     # @return [String] Api version
     attr_accessor :api_version
@@ -81,7 +81,7 @@ module GroupDocsComparisonCloud
     # @return [Configuration] New instance of Configuration
     def initialize(app_sid, app_key)
       @api_base_url = "https://api.groupdocs.cloud"
-      @api_version = '/v1'
+      @api_version = '/v2.0'
       @app_sid = app_sid
       @app_key = app_key
       @client_side_validation = true

data/lib/groupdocs_comparison_cloud/models/{comparison_change.rb → apply_revisions_options.rb}

@@ -1,7 +1,7 @@
  #
  # --------------------------------------------------------------------------------------------------------------------
- # <copyright company="Aspose Pty Ltd" file="comparison_change.rb">
- #   Copyright (c) 2003-2018 Aspose Pty Ltd
+ # <copyright company="Aspose Pty Ltd" file="apply_revisions_options.rb">
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
  # </copyright>
  # <summary>
  #  Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -28,48 +28,43 @@
 require 'date'
 
 module GroupDocsComparisonCloud
-  # ComparisonChange dto
-  class ComparisonChange
+  # Options for apply revisions method
+  class ApplyRevisionsOptions
 
-    # The identifier
-    attr_accessor :id
+    # Information about source file
+    attr_accessor :source_file
 
-    # The type change
-    attr_accessor :type
+    # Revisions to apply or reject.
+    attr_accessor :revisions
 
-    # The text
-    attr_accessor :text
+    # Indicates whether to apply all revisions in the document
+    attr_accessor :accept_all
 
-    # The authors
-    attr_accessor :authors
+    # Indicates whether to reject all revisions in the document
+    attr_accessor :reject_all
 
-    # The action
-    attr_accessor :action
-
-    # The style changes
-    attr_accessor :style_changes
+    # Path to the resultant document (if not specified the document will not be saved)
+    attr_accessor :output_path
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'type' => :'type',
-        :'text' => :'text',
-        :'authors' => :'authors',
-        :'action' => :'action',
-        :'style_changes' => :'styleChanges'
+        :'source_file' => :'SourceFile',
+        :'revisions' => :'Revisions',
+        :'accept_all' => :'AcceptAll',
+        :'reject_all' => :'RejectAll',
+        :'output_path' => :'OutputPath'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'Integer',
-        :'type' => :'String',
-        :'text' => :'String',
-        :'authors' => :'Array<String>',
-        :'action' => :'String',
-        :'style_changes' => :'Array<ComparisonStyleChange>'
+        :'source_file' => :'FileInfo',
+        :'revisions' => :'Array<RevisionInfo>',
+        :'accept_all' => :'BOOLEAN',
+        :'reject_all' => :'BOOLEAN',
+        :'output_path' => :'String'
       }
     end
 
@@ -81,32 +76,26 @@ module GroupDocsComparisonCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
-      end
-
-      if attributes.key?(:'type')
-        self.type = attributes[:'type']
+      if attributes.key?(:'SourceFile')
+        self.source_file = attributes[:'SourceFile']
       end
 
-      if attributes.key?(:'text')
-        self.text = attributes[:'text']
+      if attributes.key?(:'Revisions')
+        if (value = attributes[:'Revisions']).is_a?(Array)
+          self.revisions = value
+        end
       end
 
-      if attributes.key?(:'authors')
-        if (value = attributes[:'authors']).is_a?(Array)
-          self.authors = value
-        end
+      if attributes.key?(:'AcceptAll')
+        self.accept_all = attributes[:'AcceptAll']
       end
 
-      if attributes.key?(:'action')
-        self.action = attributes[:'action']
+      if attributes.key?(:'RejectAll')
+        self.reject_all = attributes[:'RejectAll']
       end
 
-      if attributes.key?(:'styleChanges')
-        if (value = attributes[:'styleChanges']).is_a?(Array)
-          self.style_changes = value
-        end
+      if attributes.key?(:'OutputPath')
+        self.output_path = attributes[:'OutputPath']
       end
 
     end
@@ -115,8 +104,12 @@ module GroupDocsComparisonCloud
     # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = []
-      if @id.nil?
-        invalid_properties.push("invalid value for 'id', id cannot be nil.")
+      if @accept_all.nil?
+        invalid_properties.push("invalid value for 'accept_all', accept_all cannot be nil.")
+      end
+
+      if @reject_all.nil?
+        invalid_properties.push("invalid value for 'reject_all', reject_all cannot be nil.")
       end
 
       return invalid_properties
@@ -125,7 +118,8 @@ module GroupDocsComparisonCloud
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @id.nil?
+      return false if @accept_all.nil?
+      return false if @reject_all.nil?
       return true
     end
 
@@ -134,12 +128,11 @@ module GroupDocsComparisonCloud
     def ==(other)
       return true if self.equal?(other)
       self.class == other.class &&
-          id == other.id &&
-          type == other.type &&
-          text == other.text &&
-          authors == other.authors &&
-          action == other.action &&
-          style_changes == other.style_changes
+          source_file == other.source_file &&
+          revisions == other.revisions &&
+          accept_all == other.accept_all &&
+          reject_all == other.reject_all &&
+          output_path == other.output_path
     end
 
     # @see the `==` method
@@ -151,7 +144,13 @@ module GroupDocsComparisonCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, type, text, authors, action, style_changes].hash
+      [source_file, revisions, accept_all, reject_all, output_path].hash
+    end
+
+    # Downcases first letter.
+    # @return downcased string
+    def uncap(str)
+      str[0, 1].downcase + str[1..-1]
     end
 
     # Builds the object from hash
@@ -160,14 +159,16 @@ module GroupDocsComparisonCloud
     def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
       self.class.swagger_types.each_pair do |key, type|
+        pname = uncap(self.class.attribute_map[key]).intern
+        value = attributes[pname]
         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) })
+          # is documented as an array but the input is not                    
+          if value.is_a?(Array)
+            self.send("#{key}=", value.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]]))
+        elsif !value.nil?
+          self.send("#{key}=", _deserialize(type, value))
         end
         # or else data not found in attributes(hash), not an issue as the data can be optional
       end
@@ -182,9 +183,9 @@ module GroupDocsComparisonCloud
     def _deserialize(type, value)
       case type.to_sym
       when :DateTime
-        Time.at(/\d/.match(value)[0].to_f).to_datetime
+        Date.parse value
       when :Date
-        Time.at(/\d/.match(value)[0].to_f).to_date
+        Date.parse value
       when :String
         value.to_s
       when :Integer

data/lib/groupdocs_comparison_cloud/models/change_info.rb

@@ -0,0 +1,371 @@
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="change_info.rb">
+ #   Copyright (c) 2003-2021 Aspose Pty Ltd
+ # </copyright>
+ # <summary>
+ #  Permission is hereby granted, free of charge, to any person obtaining a copy
+ #  of this software and associated documentation files (the "Software"), to deal
+ #  in the Software without restriction, including without limitation the rights
+ #  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ #  copies of the Software, and to permit persons to whom the Software is
+ #  furnished to do so, subject to the following conditions:
+ #
+ #  The above copyright notice and this permission notice shall be included in all
+ #  copies or substantial portions of the Software.
+ #
+ #  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ #  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ #  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ #  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ #  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ #  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ #  SOFTWARE.
+ # </summary>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+require 'date'
+
+module GroupDocsComparisonCloud
+  # ChangeInfo Object fields
+  class ChangeInfo
+
+    # Id of change
+    attr_accessor :id
+
+    # Action (accept or reject). This field shows comparison what to do with this change
+    attr_accessor :comparison_action
+
+    # Type of change (Inserted, Deleted or StyleChanged)
+    attr_accessor :type
+
+    # Text of changed element
+    attr_accessor :text
+
+    # Changed text of target doc
+    attr_accessor :target_text
+
+    # Array of authors who made this change (used for multi comparison)
+    attr_accessor :authors
+
+    # Array of style changes
+    attr_accessor :style_change_info
+
+    # Page where current change is placed
+    attr_accessor :page_info
+
+    # Coordinates of changed element
+    attr_accessor :box
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'Id',
+        :'comparison_action' => :'ComparisonAction',
+        :'type' => :'Type',
+        :'text' => :'Text',
+        :'target_text' => :'TargetText',
+        :'authors' => :'Authors',
+        :'style_change_info' => :'StyleChangeInfo',
+        :'page_info' => :'PageInfo',
+        :'box' => :'Box'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'Integer',
+        :'comparison_action' => :'String',
+        :'type' => :'String',
+        :'text' => :'String',
+        :'target_text' => :'String',
+        :'authors' => :'Array<String>',
+        :'style_change_info' => :'Array<StyleChangeInfo>',
+        :'page_info' => :'PageInfo',
+        :'box' => :'Rectangle'
+      }
+    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.key?(:'Id')
+        self.id = attributes[:'Id']
+      end
+
+      if attributes.key?(:'ComparisonAction')
+        self.comparison_action = attributes[:'ComparisonAction']
+      end
+
+      if attributes.key?(:'Type')
+        self.type = attributes[:'Type']
+      end
+
+      if attributes.key?(:'Text')
+        self.text = attributes[:'Text']
+      end
+
+      if attributes.key?(:'TargetText')
+        self.target_text = attributes[:'TargetText']
+      end
+
+      if attributes.key?(:'Authors')
+        if (value = attributes[:'Authors']).is_a?(Array)
+          self.authors = value
+        end
+      end
+
+      if attributes.key?(:'StyleChangeInfo')
+        if (value = attributes[:'StyleChangeInfo']).is_a?(Array)
+          self.style_change_info = value
+        end
+      end
+
+      if attributes.key?(:'PageInfo')
+        self.page_info = attributes[:'PageInfo']
+      end
+
+      if attributes.key?(:'Box')
+        self.box = attributes[:'Box']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = []
+      if @id.nil?
+        invalid_properties.push("invalid value for 'id', id cannot be nil.")
+      end
+
+      if @comparison_action.nil?
+        invalid_properties.push("invalid value for 'comparison_action', comparison_action cannot be nil.")
+      end
+
+      if @type.nil?
+        invalid_properties.push("invalid value for 'type', type cannot be nil.")
+      end
+
+      if @box.nil?
+        invalid_properties.push("invalid value for 'box', box cannot be nil.")
+      end
+
+      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 false if @id.nil?
+      return false if @comparison_action.nil?
+      comparison_action_validator = EnumAttributeValidator.new('String', ["None", "Accept", "Reject"])
+      return false unless comparison_action_validator.valid?(@comparison_action)
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["None", "Modified", "Inserted", "Deleted", "Added", "NotModified", "StyleChanged", "Resized", "Moved", "MovedAndResized", "ShiftedAndResized"])
+      return false unless type_validator.valid?(@type)
+      return false if @box.nil?
+      return true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] comparison_action Object to be assigned
+    def comparison_action=(comparison_action)
+      validator = EnumAttributeValidator.new('String', ["None", "Accept", "Reject"])
+      if comparison_action.to_i == 0
+        unless validator.valid?(comparison_action)
+          raise ArgumentError, "invalid value for 'comparison_action', must be one of #{validator.allowable_values}."
+        end
+        @comparison_action = comparison_action
+      else
+        @comparison_action = validator.allowable_values[comparison_action.to_i]
+      end
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["None", "Modified", "Inserted", "Deleted", "Added", "NotModified", "StyleChanged", "Resized", "Moved", "MovedAndResized", "ShiftedAndResized"])
+      if type.to_i == 0
+        unless validator.valid?(type)
+          raise ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
+        end
+        @type = type
+      else
+        @type = validator.allowable_values[type.to_i]
+      end
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(other)
+      return true if self.equal?(other)
+      self.class == other.class &&
+          id == other.id &&
+          comparison_action == other.comparison_action &&
+          type == other.type &&
+          text == other.text &&
+          target_text == other.target_text &&
+          authors == other.authors &&
+          style_change_info == other.style_change_info &&
+          page_info == other.page_info &&
+          box == other.box
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [id, comparison_action, type, text, target_text, authors, style_change_info, page_info, box].hash
+    end
+
+    # Downcases first letter.
+    # @return downcased string
+    def uncap(str)
+      str[0, 1].downcase + str[1..-1]
+    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|
+        pname = uncap(self.class.attribute_map[key]).intern
+        value = attributes[pname]
+        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 value.is_a?(Array)
+            self.send("#{key}=", value.map { |v| _deserialize($1, v) })
+          end
+        elsif !value.nil?
+          self.send("#{key}=", _deserialize(type, value))
+        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
+        Date.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 = GroupDocsComparisonCloud.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