groupdocs_annotation_cloud 18.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87ce3312a2efaac314b2356ebddf35f4baed97d4
+  data.tar.gz: 8f42f946da1bc0bac4d24495b533359143963042
+SHA512:
+  metadata.gz: 28f18f6a91420d5db93b06110095de2594b2c87f1bd165950881c79eeeda1dd6de29863da496aa557763e6f741f56c65255fae18829e9566798785260d06d142
+  data.tar.gz: 3b63dc7ecb6341351a3e7da532c2a355fd7ba625af7b9050b6d836807841573ef74abd98f99c25a6051eace76e6141cccc91ddcd2de74a3acdbcaada1c56927f

data/lib/groupdocs_annotation_cloud/api/annotation_api.rb

@@ -0,0 +1,344 @@
+# -----------------------------------------------------------------------------------
+# <copyright company="Aspose Pty Ltd" file="annotation.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 GroupDocsAnnotationCloud
+  #
+  # GroupDocs.Annotation Cloud API
+  #
+  class AnnotationApi
+    attr_accessor :config
+
+    #make AnnotationApi.new private 
+    private_class_method :new
+
+    # Initializes new instance of AnnotationApi
+    #
+    # @param [config] Configuration 
+    # @return [AnnotationApi] New instance of AnnotationApi
+    def initialize(config)
+      @config = config
+      @api_client = ApiClient.new(config)
+      require_all '../models/requests'
+
+      @access_token = nil
+    end
+
+    # Initializes new instance of AnnotationApi
+    #
+    # @param [app_sid] Application identifier (App SID)
+    # @param [app_key] Application private key (App Key)
+    # @return [AnnotationApi] New instance of AnnotationApi
+    def self.from_keys(app_sid, app_key)
+      config = Configuration.new(app_sid, app_key)
+      return new(config)
+    end
+
+    # Initializes new instance of AnnotationApi
+    #
+    # @param [config] Configuration 
+    # @return [AnnotationApi] New instance of AnnotationApi
+    def self.from_config(config)
+      return new(config)
+    end
+
+    # Removes annotations from document.
+    # 
+    # @param request delete_clean_document_request
+    # @return [File]
+    def delete_clean_document(request)
+      data, _status_code, _headers = delete_clean_document_with_http_info(request)
+      data
+    end
+
+    # Removes annotations from document.
+    # 
+    # @param request delete_clean_document_request
+    # @return [Array<(File, Fixnum, Hash)>]
+    # File data, response status code and response headers
+    def delete_clean_document_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? DeleteCleanDocumentRequest
+
+      @api_client.config.logger.debug 'Calling API: AnnotationApi.delete_clean_document ...' if @api_client.config.debugging
+      # verify the required parameter 'name' is set
+      raise ArgumentError, 'Missing the required parameter name when calling AnnotationApi.delete_clean_document' if @api_client.config.client_side_validation && request.name.nil?
+      # resource path
+      local_var_path = '/annotation/{name}/annotations'
+      local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', request.name.to_s)
+
+      # query parameters
+      query_params = {}
+      if local_var_path.include? ('{' + downcase_first_letter('Folder') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('Folder') + '}', request.folder.to_s)
+      else
+        query_params[downcase_first_letter('Folder')] = request.folder unless request.folder.nil?
+      end
+      if local_var_path.include? ('{' + downcase_first_letter('Password') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('Password') + '}', request.password.to_s)
+      else
+        query_params[downcase_first_letter('Password')] = request.password unless request.password.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 = nil
+      data, status_code, headers = @api_client.call_api(:DELETE, 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:
+        AnnotationApi#delete_clean_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Extracts annotations from document.
+    # 
+    # @param request get_import_request
+    # @return [Array<AnnotationInfo>]
+    def get_import(request)
+      data, _status_code, _headers = get_import_with_http_info(request)
+      data
+    end
+
+    # Extracts annotations from document.
+    # 
+    # @param request get_import_request
+    # @return [Array<(Array<AnnotationInfo>, Fixnum, Hash)>]
+    # Array<AnnotationInfo> data, response status code and response headers
+    def get_import_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? GetImportRequest
+
+      @api_client.config.logger.debug 'Calling API: AnnotationApi.get_import ...' if @api_client.config.debugging
+      # verify the required parameter 'name' is set
+      raise ArgumentError, 'Missing the required parameter name when calling AnnotationApi.get_import' if @api_client.config.client_side_validation && request.name.nil?
+      # resource path
+      local_var_path = '/annotation/{name}/annotations'
+      local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', request.name.to_s)
+
+      # query parameters
+      query_params = {}
+      if local_var_path.include? ('{' + downcase_first_letter('Folder') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('Folder') + '}', request.folder.to_s)
+      else
+        query_params[downcase_first_letter('Folder')] = request.folder unless request.folder.nil?
+      end
+      if local_var_path.include? ('{' + downcase_first_letter('Password') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('Password') + '}', request.password.to_s)
+      else
+        query_params[downcase_first_letter('Password')] = request.password unless request.password.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 = nil
+      data, status_code, headers = @api_client.call_api(:GET, 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<AnnotationInfo>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        AnnotationApi#get_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      [data, status_code, headers]
+    end
+
+    # Adds annotations to the document.
+    # 
+    # @param request put_export_request
+    # @return [File]
+    def put_export(request)
+      data, _status_code, _headers = put_export_with_http_info(request)
+      data
+    end
+
+    # Adds annotations to the document.
+    # 
+    # @param request put_export_request
+    # @return [Array<(File, Fixnum, Hash)>]
+    # File data, response status code and response headers
+    def put_export_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? PutExportRequest
+
+      @api_client.config.logger.debug 'Calling API: AnnotationApi.put_export ...' if @api_client.config.debugging
+      # verify the required parameter 'name' is set
+      raise ArgumentError, 'Missing the required parameter name when calling AnnotationApi.put_export' if @api_client.config.client_side_validation && request.name.nil?
+      # resource path
+      local_var_path = '/annotation/{name}/annotations'
+      local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', request.name.to_s)
+
+      # query parameters
+      query_params = {}
+      if local_var_path.include? ('{' + downcase_first_letter('Folder') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('Folder') + '}', request.folder.to_s)
+      else
+        query_params[downcase_first_letter('Folder')] = request.folder unless request.folder.nil?
+      end
+      if local_var_path.include? ('{' + downcase_first_letter('Password') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('Password') + '}', request.password.to_s)
+      else
+        query_params[downcase_first_letter('Password')] = request.password unless request.password.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.body)
+      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:
+        AnnotationApi#put_export\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

data/lib/groupdocs_annotation_cloud/api/image_info_api.rb

@@ -0,0 +1,218 @@
+# -----------------------------------------------------------------------------------
+# <copyright company="Aspose Pty Ltd" file="imageInfo.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 GroupDocsAnnotationCloud
+  #
+  # GroupDocs.Annotation Cloud API
+  #
+  class ImageInfoApi
+    attr_accessor :config
+
+    #make ImageInfoApi.new private 
+    private_class_method :new
+
+    # Initializes new instance of ImageInfoApi
+    #
+    # @param [config] Configuration 
+    # @return [ImageInfoApi] New instance of ImageInfoApi
+    def initialize(config)
+      @config = config
+      @api_client = ApiClient.new(config)
+      require_all '../models/requests'
+
+      @access_token = nil
+    end
+
+    # Initializes new instance of ImageInfoApi
+    #
+    # @param [app_sid] Application identifier (App SID)
+    # @param [app_key] Application private key (App Key)
+    # @return [ImageInfoApi] New instance of ImageInfoApi
+    def self.from_keys(app_sid, app_key)
+      config = Configuration.new(app_sid, app_key)
+      return new(config)
+    end
+
+    # Initializes new instance of ImageInfoApi
+    #
+    # @param [config] Configuration 
+    # @return [ImageInfoApi] New instance of ImageInfoApi
+    def self.from_config(config)
+      return new(config)
+    end
+
+    # Retrieves document's information.
+    # 
+    # @param request get_info_request
+    # @return [DocumentInfo]
+    def get_info(request)
+      data, _status_code, _headers = get_info_with_http_info(request)
+      data
+    end
+
+    # Retrieves document's information.
+    # 
+    # @param request get_info_request
+    # @return [Array<(DocumentInfo, Fixnum, Hash)>]
+    # DocumentInfo data, response status code and response headers
+    def get_info_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? GetInfoRequest
+
+      @api_client.config.logger.debug 'Calling API: ImageInfoApi.get_info ...' if @api_client.config.debugging
+      # verify the required parameter 'name' is set
+      raise ArgumentError, 'Missing the required parameter name when calling ImageInfoApi.get_info' if @api_client.config.client_side_validation && request.name.nil?
+      # resource path
+      local_var_path = '/annotation/{name}/image/info'
+      local_var_path = local_var_path.sub('{' + downcase_first_letter('Name') + '}', request.name.to_s)
+
+      # query parameters
+      query_params = {}
+      if local_var_path.include? ('{' + downcase_first_letter('Folder') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('Folder') + '}', request.folder.to_s)
+      else
+        query_params[downcase_first_letter('Folder')] = request.folder unless request.folder.nil?
+      end
+      if local_var_path.include? ('{' + downcase_first_letter('Password') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('Password') + '}', request.password.to_s)
+      else
+        query_params[downcase_first_letter('Password')] = request.password unless request.password.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 = nil
+      data, status_code, headers = @api_client.call_api(:GET, 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: 'DocumentInfo')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        ImageInfoApi#get_info\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