groupdocs_conversion_cloud 19.4 → 19.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 318acced2d73772d827e8c49c490eb12a7d02c55
-  data.tar.gz: f4ace8c6f615d561befa441256d35ba0857d9b14
+  metadata.gz: 3a1dca17f4620ca552157873b944b15c0a44906b
+  data.tar.gz: 8eb3447134dae6e2a2f947f25c45acdcb23b01b3
 SHA512:
-  metadata.gz: f69b1560c1b2cb04f01b116cfaf30ae730466ad1151a8cb18234f684cf3733e7f4063a78b8051a52640d0b8dce8a8c5b337c369a2c34735350d387a925c06194
-  data.tar.gz: 4fec31cd43d930f23fdf952341e3aec5364b0281a9ef8c23ac6a08565528f35ad1e528263dd290f47e9b8190d0ae1baad39c96dd32daa94b21c99add498dcd70
+  metadata.gz: 0dbdcba425c30e3866194ca06db8b839c8a44189f37358b24f4fc4b885bcbcf15f4d77b86dc635bf560506cd292b45369ec5d24e911fe892f6f01367612f6d61
+  data.tar.gz: 90213f9a638f4cb9178805a7c1533c5ae4f2d62b1a44419f96f6d6a9345cd57c7f44241558a239173da8751ab1e604097708d03fb92f1f24a7d0d86d3f215ec5

data/lib/groupdocs_conversion_cloud.rb

@@ -33,6 +33,7 @@ require_relative 'groupdocs_conversion_cloud/configuration'
 require_relative 'groupdocs_conversion_cloud/models/convert_options'
 require_relative 'groupdocs_conversion_cloud/models/convert_settings'
 require_relative 'groupdocs_conversion_cloud/models/disc_usage'
+require_relative 'groupdocs_conversion_cloud/models/document_metadata'
 require_relative 'groupdocs_conversion_cloud/models/error'
 require_relative 'groupdocs_conversion_cloud/models/error_details'
 require_relative 'groupdocs_conversion_cloud/models/file_versions'
@@ -199,7 +200,8 @@ require_relative 'groupdocs_conversion_cloud/models/jpx_convert_options'
 require_relative 'groupdocs_conversion_cloud/models/tif_convert_options'
 
 # APIs
-require_relative 'groupdocs_conversion_cloud/api/conversion_api'
+require_relative 'groupdocs_conversion_cloud/api/convert_api'
 require_relative 'groupdocs_conversion_cloud/api/file_api'
 require_relative 'groupdocs_conversion_cloud/api/folder_api'
+require_relative 'groupdocs_conversion_cloud/api/info_api'
 require_relative 'groupdocs_conversion_cloud/api/storage_api'

data/lib/groupdocs_conversion_cloud/api/convert_api.rb

@@ -0,0 +1,218 @@
+# -----------------------------------------------------------------------------------
+# <copyright company="Aspose Pty Ltd" file="convert.rb">
+#   Copyright (c) 2003-2019 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 GroupDocsConversionCloud
+  #
+  # GroupDocs.Conversion Cloud API
+  #
+  class ConvertApi
+    attr_accessor :config
+
+    #make ConvertApi.new private 
+    private_class_method :new
+
+    # Initializes new instance of ConvertApi
+    #
+    # @param [config] Configuration 
+    # @return [ConvertApi] New instance of ConvertApi
+    def initialize(config)
+      @config = config
+      @api_client = ApiClient.new(config)
+      @access_token = nil
+    end
+
+    # Initializes new instance of ConvertApi
+    #
+    # @param [app_sid] Application identifier (App SID)
+    # @param [app_key] Application private key (App Key)
+    # @return [ConvertApi] New instance of ConvertApi
+    def self.from_keys(app_sid, app_key)
+      config = Configuration.new(app_sid, app_key)
+      return new(config)
+    end
+
+    # Initializes new instance of ConvertApi
+    #
+    # @param [config] Configuration 
+    # @return [ConvertApi] New instance of ConvertApi
+    def self.from_config(config)
+      return new(config)
+    end
+
+    # Converts specified input document to format specified in the convertSettings with specified options
+    # 
+    # @param request convert_document_request
+    # @return [Array<StoredConvertedResult>]
+    def convert_document(request)
+      data, _status_code, _headers = convert_document_with_http_info(request)
+      data
+    end
+
+    # Converts specified input document to format specified in the convertSettings with specified options
+    # 
+    # @param request convert_document_request
+    # @return [Array<(Array<StoredConvertedResult>, Fixnum, Hash)>]
+    # Array<StoredConvertedResult> data, response status code and response headers
+    def convert_document_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? ConvertDocumentRequest
+
+      @api_client.config.logger.debug 'Calling API: ConversionApi.convert_document ...' if @api_client.config.debugging
+      # verify the required parameter 'convert_settings' is set
+      raise ArgumentError, 'Missing the required parameter convert_settings when calling ConversionApi.convert_document' if @api_client.config.client_side_validation && request.convert_settings.nil?
+      # resource path
+      local_var_path = '/conversion'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(request.convert_settings)
+      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: if request.convert_settings.output_path.nil? then 'File' else 'Array<StoredConvertedResult>' end)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called:
+        ConversionApi#convert_document\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
+        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 = "/connect/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]
+
+        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
+ #
+ # --------------------------------------------------------------------------------------------------------------------
+ # <copyright company="Aspose Pty Ltd" file="convert_document_request.rb">
+ #   Copyright (c) 2003-2019 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>
+ # --------------------------------------------------------------------------------------------------------------------
+ #
+
+module GroupDocsConversionCloud
+
+  #
+  # Request model for convert_document operation.
+  #
+  class ConvertDocumentRequest
+
+        # Gets or sets convert_settings
+        attr_accessor :convert_settings
+	
+        #
+        # Initializes a new instance.
+        # @param convert_settings 
+        def initialize(convert_settings)
+           self.convert_settings = convert_settings
+        end
+  end
+end

data/lib/groupdocs_conversion_cloud/api/file_api.rb

@@ -378,7 +378,7 @@ module GroupDocsConversionCloud
 
       # http body (model)
       post_body = nil
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
                                                         header_params: header_params,
                                                         query_params: query_params,
                                                         form_params: form_params,

data/lib/groupdocs_conversion_cloud/api/folder_api.rb

@@ -174,7 +174,7 @@ module GroupDocsConversionCloud
 
       # http body (model)
       post_body = nil
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
                                                         header_params: header_params,
                                                         query_params: query_params,
                                                         form_params: form_params,

data/lib/groupdocs_conversion_cloud/api/{conversion_api.rb → info_api.rb}

@@ -1,5 +1,5 @@
 # -----------------------------------------------------------------------------------
-# <copyright company="Aspose Pty Ltd" file="conversion.rb">
+# <copyright company="Aspose Pty Ltd" file="info.rb">
 #   Copyright (c) 2003-2019 Aspose Pty Ltd
 # </copyright>
 # <summary>
@@ -30,65 +30,73 @@ module GroupDocsConversionCloud
   #
   # GroupDocs.Conversion Cloud API
   #
-  class ConversionApi
+  class InfoApi
     attr_accessor :config
 
-    #make ConversionApi.new private 
+    #make InfoApi.new private 
     private_class_method :new
 
-    # Initializes new instance of ConversionApi
+    # Initializes new instance of InfoApi
     #
     # @param [config] Configuration 
-    # @return [ConversionApi] New instance of ConversionApi
+    # @return [InfoApi] New instance of InfoApi
     def initialize(config)
       @config = config
       @api_client = ApiClient.new(config)
       @access_token = nil
     end
 
-    # Initializes new instance of ConversionApi
+    # Initializes new instance of InfoApi
     #
     # @param [app_sid] Application identifier (App SID)
     # @param [app_key] Application private key (App Key)
-    # @return [ConversionApi] New instance of ConversionApi
+    # @return [InfoApi] New instance of InfoApi
     def self.from_keys(app_sid, app_key)
       config = Configuration.new(app_sid, app_key)
       return new(config)
     end
 
-    # Initializes new instance of ConversionApi
+    # Initializes new instance of InfoApi
     #
     # @param [config] Configuration 
-    # @return [ConversionApi] New instance of ConversionApi
+    # @return [InfoApi] New instance of InfoApi
     def self.from_config(config)
       return new(config)
     end
 
-    # Converts specified input document to format specified in the convertSettings with specified options
+    # Returns metadata for provided document
     # 
-    # @param request convert_document_request
-    # @return [Array<StoredConvertedResult>]
-    def convert_document(request)
-      data, _status_code, _headers = convert_document_with_http_info(request)
+    # @param request get_document_metadata_request
+    # @return [DocumentMetadata]
+    def get_document_metadata(request)
+      data, _status_code, _headers = get_document_metadata_with_http_info(request)
       data
     end
 
-    # Converts specified input document to format specified in the convertSettings with specified options
+    # Returns metadata for provided document
     # 
-    # @param request convert_document_request
-    # @return [Array<(Array<StoredConvertedResult>, Fixnum, Hash)>]
-    # Array<StoredConvertedResult> data, response status code and response headers
-    def convert_document_with_http_info(request)
-      raise ArgumentError, 'Incorrect request type' unless request.is_a? ConvertDocumentRequest
-
-      @api_client.config.logger.debug 'Calling API: ConversionApi.convert_document ...' if @api_client.config.debugging
-      # verify the required parameter 'convert_settings' is set
-      raise ArgumentError, 'Missing the required parameter convert_settings when calling ConversionApi.convert_document' if @api_client.config.client_side_validation && request.convert_settings.nil?
+    # @param request get_document_metadata_request
+    # @return [Array<(DocumentMetadata, Fixnum, Hash)>]
+    # DocumentMetadata data, response status code and response headers
+    def get_document_metadata_with_http_info(request)
+      raise ArgumentError, 'Incorrect request type' unless request.is_a? GetDocumentMetadataRequest
+
+      @api_client.config.logger.debug 'Calling API: InfoApi.get_document_metadata ...' if @api_client.config.debugging
       # resource path
-      local_var_path = '/conversion'
+      local_var_path = '/conversion/info'
 
       # query parameters
       query_params = {}
+      if local_var_path.include? ('{' + downcase_first_letter('FilePath') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('FilePath') + '}', request.file_path.to_s)
+      else
+        query_params[downcase_first_letter('FilePath')] = request.file_path unless request.file_path.nil?
+      end
+      if local_var_path.include? ('{' + downcase_first_letter('StorageName') + '}')
+        local_var_path = local_var_path.sub('{' + downcase_first_letter('StorageName') + '}', request.storage_name.to_s)
+      else
+        query_params[downcase_first_letter('StorageName')] = request.storage_name unless request.storage_name.nil?
+      end
 
       # header parameters
       header_params = {}
@@ -101,22 +109,21 @@ module GroupDocsConversionCloud
       form_params = {}
 
       # http body (model)
-      post_body = @api_client.object_to_http_body(request.convert_settings)
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      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: if request.convert_settings.output_path.nil? then 'File' else 'Array<StoredConvertedResult>' end)
+                                                        return_type: 'DocumentMetadata')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called:
-        ConversionApi#convert_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        InfoApi#get_document_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       [data, status_code, headers]
     end
 
-
     # Returns all supported conversion types
     # 
     # @param request get_supported_conversion_types_request
@@ -134,7 +141,7 @@ module GroupDocsConversionCloud
     def get_supported_conversion_types_with_http_info(request)
       raise ArgumentError, 'Incorrect request type' unless request.is_a? GetSupportedConversionTypesRequest
 
-      @api_client.config.logger.debug 'Calling API: ConversionApi.get_supported_conversion_types ...' if @api_client.config.debugging
+      @api_client.config.logger.debug 'Calling API: InfoApi.get_supported_conversion_types ...' if @api_client.config.debugging
       # resource path
       local_var_path = '/conversion/formats'
 
@@ -177,7 +184,7 @@ module GroupDocsConversionCloud
                                                         return_type: 'Array<SupportedFormat>')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called:
-        ConversionApi#get_supported_conversion_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        InfoApi#get_supported_conversion_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       [data, status_code, headers]
     end
@@ -238,7 +245,7 @@ module GroupDocsConversionCloud
 end
  #
  # --------------------------------------------------------------------------------------------------------------------
- # <copyright company="Aspose Pty Ltd" file="convert_document_request.rb">
+ # <copyright company="Aspose Pty Ltd" file="get_document_metadata_request.rb">
  #   Copyright (c) 2003-2019 Aspose Pty Ltd
  # </copyright>
  # <summary>
@@ -266,18 +273,22 @@ end
 module GroupDocsConversionCloud
 
   #
-  # Request model for convert_document operation.
+  # Request model for get_document_metadata operation.
   #
-  class ConvertDocumentRequest
+  class GetDocumentMetadataRequest
 
-        # Gets or sets convert_settings
-        attr_accessor :convert_settings
+        # Absolute path to a document in the storage
+        attr_accessor :file_path
+        # StorageName which contains the document
+        attr_accessor :storage_name
 	
         #
         # Initializes a new instance.
-        # @param convert_settings 
-        def initialize(convert_settings)
-           self.convert_settings = convert_settings
+        # @param file_path Absolute path to a document in the storage
+        # @param storage_name StorageName which contains the document
+        def initialize(file_path = nil, storage_name = nil)
+           self.file_path = file_path
+           self.storage_name = storage_name
         end
   end
 end