groupdocs_comparison_cloud 18.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 031e0ebd57fdcec3da78c30ed43a52ad3b743f6c
+  data.tar.gz: 5e004954197669c2a488d028d6959d7a26132623
+SHA512:
+  metadata.gz: be5c9d5c448728199745f4175414855843f721ef01b2562ddc053f95a5bf3869b8eb26edf83ad75aefe5cb6b41bf843f8ac99672e19b6e88e04d728c940b69f7
+  data.tar.gz: eb397692fa0fbceeaf6fd819a720d967491eb95995979585dee1fefc7c73b66b0f5cc16ba2ee1fcbbacdefd78af553d0275d55b2ebabf8cbcda270225e30e80a

data/lib/groupdocs_comparison_cloud.rb

@@ -0,0 +1,76 @@
+# ------------------------------------------------------------------------------------
+# <copyright company="Aspose Pty Ltd" file="groupdocs_comparison_cloud.rb">
+#   Copyright (c) 2003-2018 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>
+# ------------------------------------------------------------------------------------
+
+# Common files
+require_relative 'groupdocs_comparison_cloud/api_client'
+require_relative 'groupdocs_comparison_cloud/api_error'
+require_relative 'groupdocs_comparison_cloud/version'
+require_relative 'groupdocs_comparison_cloud/configuration'
+
+# Models
+require_relative 'groupdocs_comparison_cloud/models/comparison_change'
+require_relative 'groupdocs_comparison_cloud/models/comparison_changes_category_dto'
+require_relative 'groupdocs_comparison_cloud/models/comparison_file_info'
+require_relative 'groupdocs_comparison_cloud/models/comparison_metadata_values'
+require_relative 'groupdocs_comparison_cloud/models/comparison_request'
+require_relative 'groupdocs_comparison_cloud/models/comparison_request_settings'
+require_relative 'groupdocs_comparison_cloud/models/comparison_style_change'
+require_relative 'groupdocs_comparison_cloud/models/link'
+require_relative 'groupdocs_comparison_cloud/models/style_settings_values'
+require_relative 'groupdocs_comparison_cloud/models/value_type'
+require_relative 'groupdocs_comparison_cloud/models/color'
+
+# APIs
+require_relative 'groupdocs_comparison_cloud/api/changes_api'
+require_relative 'groupdocs_comparison_cloud/api/comparison_api'
+
+module GroupDocsComparisonCloud
+  # Main module
+  class << self
+    # Initialize SDK with API keys.
+    # 
+    # app_sid = "xxx"
+    # app_key = "xxx"
+    #
+    # GroupDocsComparisonCloud.from_keys(app_sid, app_key)
+    def from_keys(app_sid, app_key)
+      ComparisonApi.from_keys(app_sid, app_key)
+    end
+
+    # Initialize SDK with Configuration.
+    # 
+    # app_sid = "xxx"
+    # app_key = "xxx"
+    #
+    # config = GroupDocsComparisonCloud::Configuration.new(app_sid, app_key)
+    # config.debugging = true
+    # config.temp_folder_path = "./temp"
+    #
+    # GroupDocsComparisonCloud.from_config(config)
+    def from_config(config)
+      ComparisonApi.from_config(config)
+    end
+  end
+end

data/lib/groupdocs_comparison_cloud/api/changes_api.rb

@@ -0,0 +1,470 @@
+# -----------------------------------------------------------------------------------
+# <copyright company="Aspose Pty Ltd" file="changes.rb">
+#   Copyright (c) 2003-2018 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 'uri'
+require 'date'
+
+module GroupDocsComparisonCloud
+  #
+  # GroupDocs.Comparison Cloud API
+  #
+  class ChangesApi
+    attr_accessor :config
+
+    #make ChangesApi.new private 
+    private_class_method :new
+
+    # Initializes new instance of ChangesApi
+    #
+    # @param [config] Configuration 
+    # @return [ChangesApi] New instance of ChangesApi
+    def initialize(config)
+      @config = config
+      @api_client = ApiClient.new(config)
+      require_all '../models/requests'
+
+      @access_token = nil
+    end
+
+    # Initializes new instance of ChangesApi
+    #
+    # @param [app_sid] Application identifier (App SID)
+    # @param [app_key] Application private key (App Key)
+    # @return [ChangesApi] New instance of ChangesApi
+    def self.from_keys(app_sid, app_key)
+      config = Configuration.new(app_sid, app_key)
+      return new(config)
+    end
+
+    # Initializes new instance of ChangesApi
+    #
+    # @param [config] Configuration 
+    # @return [ChangesApi] New instance of ChangesApi
+    def self.from_config(config)
+      return new(config)
+    end
+
+    # Posts the categories changes.
+    # 
+    # @param request post_categories_changes_request
+    # @return [Array<ComparisonChangesCategoryDto>]
+    def post_categories_changes(request)
+      data, _status_code, _headers = post_categories_changes_with_http_info(request)
+      data
+    end
+
+    # Posts the categories changes.
+    # 
+    # @param request post_categories_changes_request
+    # @return [Array<(Array<ComparisonChangesCategoryDto>, Fixnum, Hash)>]
+    # Array<ComparisonChangesCategoryDto> data, response status code and response headers
+    def post_categories_changes_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? PostCategoriesChangesRequest
+
+      @api_client.config.logger.debug 'Calling API: ChangesApi.post_categories_changes ...' if @api_client.config.debugging
+      # resource path
+      local_var_path = '/comparison/compareDocuments/changes/categories'
+
+      # query parameters
+      query_params = {}
+      if local_var_path.include? ('{' + downcase_first_letter('CategoriesType') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('CategoriesType') + '}', request.categories_type.to_s)
+      else
+        query_params[downcase_first_letter('CategoriesType')] = request.categories_type unless request.categories_type.nil?
+      end
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request.request)
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+                                                        header_params: header_params,
+                                                        query_params: query_params,
+                                                        form_params: form_params,
+                                                        body: post_body,
+                                                        access_token: get_access_token,
+                                                        return_type: 'Array<ComparisonChangesCategoryDto>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        ChangesApi#post_categories_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Returns json result with set of changes between documents
+    # 
+    # @param request post_changes_request
+    # @return [Array<ComparisonChange>]
+    def post_changes(request)
+      data, _status_code, _headers = post_changes_with_http_info(request)
+      data
+    end
+
+    # Returns json result with set of changes between documents
+    # 
+    # @param request post_changes_request
+    # @return [Array<(Array<ComparisonChange>, Fixnum, Hash)>]
+    # Array<ComparisonChange> data, response status code and response headers
+    def post_changes_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? PostChangesRequest
+
+      @api_client.config.logger.debug 'Calling API: ChangesApi.post_changes ...' if @api_client.config.debugging
+      # resource path
+      local_var_path = '/comparison/compareDocuments/changes'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request.request)
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+                                                        header_params: header_params,
+                                                        query_params: query_params,
+                                                        form_params: form_params,
+                                                        body: post_body,
+                                                        access_token: get_access_token,
+                                                        return_type: 'Array<ComparisonChange>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        ChangesApi#post_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Applies changes to the document and returns document with the result of comparison
+    # 
+    # @param request put_changes_document_request
+    # @return [Link]
+    def put_changes_document(request)
+      data, _status_code, _headers = put_changes_document_with_http_info(request)
+      data
+    end
+
+    # Applies changes to the document and returns document with the result of comparison
+    # 
+    # @param request put_changes_document_request
+    # @return [Array<(Link, Fixnum, Hash)>]
+    # Link data, response status code and response headers
+    def put_changes_document_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? PutChangesDocumentRequest
+
+      @api_client.config.logger.debug 'Calling API: ChangesApi.put_changes_document ...' if @api_client.config.debugging
+      # resource path
+      local_var_path = '/comparison/compareDocuments/changes/update'
+
+      # query parameters
+      query_params = {}
+      if local_var_path.include? ('{' + downcase_first_letter('OutPath') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('OutPath') + '}', request.out_path.to_s)
+      else
+        query_params[downcase_first_letter('OutPath')] = request.out_path unless request.out_path.nil?
+      end
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request.request)
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+                                                        header_params: header_params,
+                                                        query_params: query_params,
+                                                        form_params: form_params,
+                                                        body: post_body,
+                                                        access_token: get_access_token,
+                                                        return_type: 'Link')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        ChangesApi#put_changes_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Applies changes to the document and returns stream of document with the result of comparison
+    # 
+    # @param request put_changes_document_stream_request
+    # @return [File]
+    def put_changes_document_stream(request)
+      data, _status_code, _headers = put_changes_document_stream_with_http_info(request)
+      data
+    end
+
+    # Applies changes to the document and returns stream of document with the result of comparison
+    # 
+    # @param request put_changes_document_stream_request
+    # @return [Array<(File, Fixnum, Hash)>]
+    # File data, response status code and response headers
+    def put_changes_document_stream_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? PutChangesDocumentStreamRequest
+
+      @api_client.config.logger.debug 'Calling API: ChangesApi.put_changes_document_stream ...' if @api_client.config.debugging
+      # resource path
+      local_var_path = '/comparison/compareDocuments/changes/stream'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request.request)
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+                                                        header_params: header_params,
+                                                        query_params: query_params,
+                                                        form_params: form_params,
+                                                        body: post_body,
+                                                        access_token: get_access_token,
+                                                        return_type: 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        ChangesApi#put_changes_document_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Applies changes to the document and returns images of document with the result of comparison
+    # 
+    # @param request put_changes_images_request
+    # @return [Array<Link>]
+    def put_changes_images(request)
+      data, _status_code, _headers = put_changes_images_with_http_info(request)
+      data
+    end
+
+    # Applies changes to the document and returns images of document with the result of comparison
+    # 
+    # @param request put_changes_images_request
+    # @return [Array<(Array<Link>, Fixnum, Hash)>]
+    # Array<Link> data, response status code and response headers
+    def put_changes_images_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? PutChangesImagesRequest
+
+      @api_client.config.logger.debug 'Calling API: ChangesApi.put_changes_images ...' if @api_client.config.debugging
+      # resource path
+      local_var_path = '/comparison/compareDocuments/changes/images'
+
+      # query parameters
+      query_params = {}
+      if local_var_path.include? ('{' + downcase_first_letter('OutFolder') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('OutFolder') + '}', request.out_folder.to_s)
+      else
+        query_params[downcase_first_letter('OutFolder')] = request.out_folder unless request.out_folder.nil?
+      end
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request.request)
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+                                                        header_params: header_params,
+                                                        query_params: query_params,
+                                                        form_params: form_params,
+                                                        body: post_body,
+                                                        access_token: get_access_token,
+                                                        return_type: 'Array<Link>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        ChangesApi#put_changes_images\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Applies changes to the document and returns image's streams of document with the result of comparison
+    # 
+    # @param request put_changes_images_stream_request
+    # @return [File]
+    def put_changes_images_stream(request)
+      data, _status_code, _headers = put_changes_images_stream_with_http_info(request)
+      data
+    end
+
+    # Applies changes to the document and returns image&#39;s streams of document with the result of comparison
+    # 
+    # @param request put_changes_images_stream_request
+    # @return [Array<(File, Fixnum, Hash)>]
+    # File data, response status code and response headers
+    def put_changes_images_stream_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? PutChangesImagesStreamRequest
+
+      @api_client.config.logger.debug 'Calling API: ChangesApi.put_changes_images_stream ...' if @api_client.config.debugging
+      # resource path
+      local_var_path = '/comparison/compareDocuments/changes/stream/images'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request.request)
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+                                                        header_params: header_params,
+                                                        query_params: query_params,
+                                                        form_params: form_params,
+                                                        body: post_body,
+                                                        access_token: get_access_token,
+                                                        return_type: 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        ChangesApi#put_changes_images_stream\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    #
+    # Helper method to convert first letter to downcase
+    #
+    private def downcase_first_letter(str)
+      value = str[0].downcase + str[1..-1]
+      value
+    end
+                 
+    #
+    # Retrieves access token
+    #
+    private def get_access_token
+        if @access_token.nil? then
+          request_access_token
+        else 
+          access_token_expired = @access_token_expires_at < DateTime.now
+          if access_token_expired then
+            reset_access_token
+          end
+        end
+        
+        @access_token  
+    end
+
+    #
+    # Gets a access token from server
+    #
+    private def request_access_token
+        auth_config = Configuration.new(@config.app_sid, @config.app_key)
+        auth_config.api_base_url = @config.api_base_url
+        auth_config.debugging = @config.debugging
+        auth_config.logger = @config.logger
+        auth_config.temp_folder_path = @config.temp_folder_path
+        auth_config.client_side_validation = @config.client_side_validation
+        auth_config.api_version = ''
+
+        auth_api_client = ApiClient.new(auth_config)
+
+        request_url = "/oauth2/token"
+        post_data = "grant_type=client_credentials&client_id=#{@config.app_sid}&client_secret=#{@config.app_key}"
+
+        data, _status_code, _header = auth_api_client.call_api(:POST, request_url, :body => post_data, :return_type => 'Object')
+        
+        @access_token = data[:access_token]
+        @refresh_token = data[:refresh_token]
+
+        expires_in_seconds = data[:expires_in].to_i - 5 * 60 
+        expires_in_days = Rational(expires_in_seconds, 60 * 60 * 24)
+        @access_token_expires_at = DateTime.now + expires_in_days
+    end
+
+    #
+    # Resets access token
+    #
+    private def reset_access_token
+        auth_config = Configuration.new(@config.app_sid, @config.app_key)
+        auth_config.api_base_url = @config.api_base_url
+        auth_config.debugging = @config.debugging
+        auth_config.logger = @config.logger
+        auth_config.temp_folder_path = @config.temp_folder_path
+        auth_config.client_side_validation = @config.client_side_validation
+        auth_config.api_version = ''
+
+        auth_api_client = ApiClient.new(auth_config)
+
+        request_url = "/oauth2/token"
+        post_data = "grant_type=refresh_token&refresh_token=#{@refresh_token}"
+
+        data, _status_code, _header = auth_api_client.call_api(:POST, request_url, :body => post_data, :return_type => 'Object')
+        
+        @access_token = data[:access_token]
+        @refresh_token = data[:refresh_token]
+
+        expires_in_seconds = data[:expires_in].to_i - 5 * 60 
+        expires_in_days = Rational(expires_in_seconds, 60 * 60 * 24)
+        @access_token_expires_at = DateTime.now + expires_in_days
+    end
+    
+    # requires all files inside a directory from current dir
+    # @param _dir can be relative path like '/lib' or "../lib"
+    private def require_all(_dir)
+      Dir[File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), _dir)) + "/*.rb"].each do |file|
+        require file
+      end
+    end
+  end
+end