aspose_html_cloud 22.9.1 → 22.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0ee38be8e80fbbf3b5471460173be7545102079954bdb387f0243000de77819
-  data.tar.gz: 2d79ec884dbea3dcd875b1fc499e89642d3528d47ee97e79e7cc1600abe863e5
+  metadata.gz: 7135c0c7df6333484c04dea4f15aa948f4a4988015eee7cbac931941ffe8fb6a
+  data.tar.gz: 96dfb00ce014ab9b3ac72f170f4b8f6629cef2314fe78a811b7e56e8eb3022b7
 SHA512:
-  metadata.gz: 58e35fcbf539b7b950b4cc8c2d599b1ad5b8b6567a3fb3e0db2bb9110f38e975ed5890eb6081c20805b276be5caa87a5edfe6af0291b3fbbb9878f472d5b974e
-  data.tar.gz: fa33b97b8268c0e3d809855f009f097c4de51c5f54addc9f0b8eca2bd3facf03fd527bca316838f1e4d9eed3e777c45a79a3b9c909c543b5bfc5cdec40b85d9b
+  metadata.gz: 7d1a073130cb87d6b26b1e72646adc7f2d012f080df138235f95cbb01cfcbce254c5312844f622780542caab750c7e1df591dc235ac539b342b6574bb132e994
+  data.tar.gz: aa892430a7b25fa79b7d0f6de6aa44adc8c50b4e6c9cff499d4d0682816b341c0097440813c66e01c735ebbd2ecd5c3d63314251cca9953bff72ad1bcfb2f4f6

data/lib/aspose_html_cloud/api/html_api.rb

@@ -43,17 +43,16 @@ module AsposeHtml
     #
     # @param src Full path to source file.
     # @param dst Full path to a result file (pdf, xps, docx, md, mhtml, jpeg, png, bmp, tiff, gif).
-    # @param [Hash] options the optional parameters
-    # @option options [Integer] :width Resulting image width.
-    # @option opts [Integer] :height Resulting image height.
-    # @option opts [Integer] :left_margin Left resulting image margin.
-    # @option opts [Integer] :right_margin Right resulting image margin.
-    # @option opts [Integer] :top_margin Top resulting image margin.
-    # @option opts [Integer] :bottom_margin Bottom resulting image margin.
-    # @option opts [Integer] :resolution Resolution of resulting image.
+    # @param [Hash, nil] options the optional parameters
+    # @option options [Double] :width Resulting width. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :height Resulting height. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :left_margin Left resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :right_margin Right resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :top_margin Top resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :bottom_margin Bottom resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
     # @return [ConversionResult] Result of conversion. See ConversionResult object.
     def convert_local_to_local(src, dst, options = nil)
-      return convert(src, dst, true, true, false, options)
+      convert(src, dst, true, true, false, options)
     end
 
     # Converting the HTML, EPUB document from the local file and putting the result in the storage
@@ -61,17 +60,16 @@ module AsposeHtml
     # @param src Full path to source file.
     # @param dst Full path to a result file (pdf, xps, docx, md, mhtml, jpeg, png, bmp, tiff, gif).
     # @param storage Storage name. Default storage is nil.
-    # @param [Hash] options the optional parameters
-    # @option options [Integer] :width Resulting image width.
-    # @option opts [Integer] :height Resulting image height.
-    # @option opts [Integer] :left_margin Left resulting image margin.
-    # @option opts [Integer] :right_margin Right resulting image margin.
-    # @option opts [Integer] :top_margin Top resulting image margin.
-    # @option opts [Integer] :bottom_margin Bottom resulting image margin.
-    # @option opts [Integer] :resolution Resolution of resulting image.
+    # @param [Hash, nil] options the optional parameters
+    # @option options [Double] :width Resulting width. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :height Resulting height. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :left_margin Left resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :right_margin Right resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :top_margin Top resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :bottom_margin Bottom resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
     # @return [ConversionResult] Result of conversion. See ConversionResult object.
     def convert_local_to_storage(src, dst, storage, options=nil)
-      return convert(src, dst, true, false, false, options, storage)
+      convert(src, dst, true, false, false, options, storage)
     end
 
     # Converting the HTML, EPUB document from the storage and putting the result in the local file
@@ -79,17 +77,16 @@ module AsposeHtml
     # @param src Full path to source file.
     # @param dst Full path to a result file (pdf, xps, docx, md, mhtml, jpeg, png, bmp, tiff, gif).
     # @param storage Storage name. Default storage is nil.
-    # @param [Hash] options the optional parameters
-    # @option options [Integer] :width Resulting image width.
-    # @option opts [Integer] :height Resulting image height.
-    # @option opts [Integer] :left_margin Left resulting image margin.
-    # @option opts [Integer] :right_margin Right resulting image margin.
-    # @option opts [Integer] :top_margin Top resulting image margin.
-    # @option opts [Integer] :bottom_margin Bottom resulting image margin.
-    # @option opts [Integer] :resolution Resolution of resulting image.
+    # @param [Hash, nil] options the optional parameters
+    # @option options [Double] :width Resulting width. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :height Resulting height. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :left_margin Left resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :right_margin Right resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :top_margin Top resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :bottom_margin Bottom resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
     # @return [ConversionResult] Result of conversion. See ConversionResult object.
     def convert_storage_to_local(src, dst, storage, options=nil)
-      return convert(src, dst, false, true, false, options, storage)
+      convert(src, dst, false, true, false, options, storage)
     end
 
     # Converting the HTML, EPUB document from the storage and putting the result in the storage
@@ -97,34 +94,32 @@ module AsposeHtml
     # @param src Full path to source file.
     # @param dst Full path to a result file (pdf, xps, docx, md, mhtml, jpeg, png, bmp, tiff, gif).
     # @param storage Storage name. Default storage is nil.
-    # @param [Hash] options the optional parameters
-    # @option options [Integer] :width Resulting image width.
-    # @option opts [Integer] :height Resulting image height.
-    # @option opts [Integer] :left_margin Left resulting image margin.
-    # @option opts [Integer] :right_margin Right resulting image margin.
-    # @option opts [Integer] :top_margin Top resulting image margin.
-    # @option opts [Integer] :bottom_margin Bottom resulting image margin.
-    # @option opts [Integer] :resolution Resolution of resulting image.
+    # @param [Hash, nil] options the optional parameters
+    # @option options [Double] :width Resulting width. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :height Resulting height. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :left_margin Left resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :right_margin Right resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :top_margin Top resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :bottom_margin Bottom resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
     # @return [ConversionResult] Result of conversion. See ConversionResult object.
     def convert_storage_to_storage(src, dst, storage, options=nil)
-      return convert(src, dst, false, false, false, options, storage)
+      convert(src, dst, false, false, false, options, storage)
     end
 
     # Converting the HTML page from URL and putting the result in the local file
     #
     # @param src URI of the website.
     # @param dst Full path to a result file (pdf, xps, docx, md, mhtml, jpeg, png, bmp, tiff, gif).
-    # @param [Hash] options the optional parameters
-    # @option options [Integer] :width Resulting image width.
-    # @option opts [Integer] :height Resulting image height.
-    # @option opts [Integer] :left_margin Left resulting image margin.
-    # @option opts [Integer] :right_margin Right resulting image margin.
-    # @option opts [Integer] :top_margin Top resulting image margin.
-    # @option opts [Integer] :bottom_margin Bottom resulting image margin.
-    # @option opts [Integer] :resolution Resolution of resulting image.
+    # @param [Hash, nil] options the optional parameters
+    # @option options [Double] :width Resulting width. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :height Resulting height. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :left_margin Left resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :right_margin Right resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :top_margin Top resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :bottom_margin Bottom resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
     # @return [ConversionResult] Result of conversion. See ConversionResult object.
     def convert_url_to_local(src, dst, options=nil)
-      return convert(src, dst, false, true, true, options)
+      convert(src, dst, false, true, true, options)
     end
 
     # Converting the HTML page from URL and putting the result in the storage
@@ -132,17 +127,16 @@ module AsposeHtml
     # @param src URI of the website.
     # @param dst Full path to a result file (pdf, xps, docx, md, mhtml, jpeg, png, bmp, tiff, gif).
     # @param storage Storage name. Default storage is nil.
-    # @param [Hash] options the optional parameters
-    # @option options [Integer] :width Resulting image width.
-    # @option opts [Integer] :height Resulting image height.
-    # @option opts [Integer] :left_margin Left resulting image margin.
-    # @option opts [Integer] :right_margin Right resulting image margin.
-    # @option opts [Integer] :top_margin Top resulting image margin.
-    # @option opts [Integer] :bottom_margin Bottom resulting image margin.
-    # @option opts [Integer] :resolution Resolution of resulting image.
+    # @param [Hash, nil] options the optional parameters
+    # @option options [Double] :width Resulting width. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :height Resulting height. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :left_margin Left resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :right_margin Right resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :top_margin Top resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :bottom_margin Bottom resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
     # @return [ConversionResult] Result of conversion. See ConversionResult object.
     def convert_url_to_storage(src, dst, storage, options=nil)
-      return convert(src, dst, false, false, true, options, storage)
+      convert(src, dst, false, false, true, options, storage)
     end
 
     # Converting the HTML document to various formats
@@ -152,14 +146,13 @@ module AsposeHtml
     # @param src_in_local Flag, true if source in the local file.
     # @param dst_in_local Flag, true if result in the local file.
     # @param is_url Flag, true if source is website.
-    # @param [Hash] options the optional parameters
-    # @option options [Integer] :width Resulting image width.
-    # @option opts [Integer] :height Resulting image height.
-    # @option opts [Integer] :left_margin Left resulting image margin.
-    # @option opts [Integer] :right_margin Right resulting image margin.
-    # @option opts [Integer] :top_margin Top resulting image margin.
-    # @option opts [Integer] :bottom_margin Bottom resulting image margin.
-    # @option opts [Integer] :resolution Resolution of resulting image.
+    # @param [Hash, nil] options the optional parameters
+    # @option options [Double] :width Resulting width. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :height Resulting height. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :left_margin Left resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :right_margin Right resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :top_margin Top resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
+    # @option options [Double] :bottom_margin Bottom resulting margin. For images in pixels, for PDF, XPS, DOCX in inches.
     # @param storage_name Storage name. Default storage is nil.
     # @return [ConversionResult] Result of conversion. See ConversionResult object.
     def convert(src, dst, src_in_local, dst_in_local, is_url, options=nil, storage_name=nil)
@@ -196,15 +189,15 @@ module AsposeHtml
       post_body[:'outputFile'] = out_file.to_s
       post_body[:'storageName'] = storage_name.to_s
 
-      if !options.nil?
+      unless options.nil?
         post_body[:'options'] = {}
-        post_body[:'options'][:'width'] = options[:'width'] if !options[:'width'].nil?
-        post_body[:'options'][:'height'] = options[:'height'] if !options[:'height'].nil?
-        post_body[:'options'][:'leftMargin'] = options[:'left_margin'] if !options[:'left_margin'].nil?
-        post_body[:'options'][:'rightMargin'] = options[:'right_margin'] if !options[:'right_margin'].nil?
-        post_body[:'options'][:'topMargin'] = options[:'top_margin'] if !options[:'top_margin'].nil?
-        post_body[:'options'][:'bottomMargin'] = options[:'bottom_margin'] if !options[:'bottom_margin'].nil?
-        post_body[:'options'][:'resolution'] = options[:'resolution'] if !options[:'resolution'].nil?
+        post_body[:'options'][:'width'] = options[:'width'] unless options[:'width'].nil?
+        post_body[:'options'][:'height'] = options[:'height'] unless options[:'height'].nil?
+        post_body[:'options'][:'leftMargin'] = options[:'left_margin'] unless options[:'left_margin'].nil?
+        post_body[:'options'][:'rightMargin'] = options[:'right_margin'] unless options[:'right_margin'].nil?
+        post_body[:'options'][:'topMargin'] = options[:'top_margin'] unless options[:'top_margin'].nil?
+        post_body[:'options'][:'bottomMargin'] = options[:'bottom_margin'] unless options[:'bottom_margin'].nil?
+        post_body[:'options'][:'resolution'] = options[:'resolution'] unless options[:'resolution'].nil?
       end
 
       query_params = {}
@@ -280,7 +273,7 @@ module AsposeHtml
         when '.HTML', '.HTM'
           return 'html'
         when '.MHT', '.MHTML'
-          return 'mht'
+          return 'mhtml'
         when '.XHTML', '.XML'
           return 'xhtml'
         when '.EPUB'

data/lib/aspose_html_cloud/api_client.rb

@@ -57,7 +57,7 @@ module AsposeHtml
         'User-Agent' => @user_agent,
         'Authorization' => "Bearer #{@config.access_token}",
         'x-aspose-client' => "aspose.html-cloud ruby sdk",
-        'x-aspose-client-version' => "20.8.0"
+        'x-aspose-client-version' => "22.10.2"
       }
     end
 

data/spec/api/html_api_spec.rb

@@ -411,4 +411,172 @@ describe 'Test html_api_V4' do
       }
     end
   end
+
+  describe 'convert markdown local to local' do
+
+    src = File.realpath(__dir__ + '/../../testdata') + '/README.md'
+    dst_dir = File.realpath(__dir__ + '/../../testresult') + '/'
+
+    describe 'convert local to local markdown to doc' do
+
+      %w[pdf xps docx html mhtml mht].each { |ext|
+        it "Convert markdown to " + ext do
+
+          dst = dst_dir + 'locToLocDocMD.' + ext
+          answer = @html_api.convert_local_to_local(src, dst)
+
+          expect(answer.code).to eql(200)
+          expect(answer.status).to eql('completed')
+          expect(File.exist?(answer.file)).to be_truthy
+        end
+      }
+    end
+
+    describe 'convert local to local markdown to doc with options' do
+
+      %w[pdf xps docx].each { |ext|
+        it "Convert markdown to " + ext do
+
+          options_A4 = {
+            width: 8.3,
+            height: 11.7,
+            top_margin: 0.5,
+            bottom_margin: 0.5,
+            left_margin: 0.5,
+            right_margin: 0.5
+          }
+
+          dst = dst_dir + 'locToLocDocMDWithOpts.' + ext
+          answer = @html_api.convert_local_to_local(src, dst, options_A4)
+
+          expect(answer.code).to eql(200)
+          expect(answer.status).to eql('completed')
+          expect(File.exist?(answer.file)).to be_truthy
+        end
+      }
+    end
+
+    describe 'convert local to local markdown to image' do
+
+      %w[jpeg jpg bmp png tiff tif gif].each { |ext|
+        it "Convert markdown to " + ext do
+
+          dst = dst_dir + 'locToLocMDImg.' + ext
+          answer = @html_api.convert_local_to_local(src, dst)
+
+          expect(answer.code).to eql(200)
+          expect(answer.status).to eql('completed')
+          expect(File.exist?(answer.file)).to be_truthy
+        end
+      }
+    end
+
+    describe 'convert local to local markdown to image with options' do
+
+      opts = {
+        width: 800,
+        height: 1000,
+        left_margin: 30,
+        right_margin: 30,
+        top_margin: 50,
+        bottom_margin: 50
+      }
+
+      %w[jpeg jpg bmp png tiff tif gif].each { |ext|
+        it "Convert markdown to " + ext do
+
+          dst = dst_dir + 'locToLocMDImgOpt.' + ext
+          answer = @html_api.convert_local_to_local(src, dst, opts)
+
+          expect(answer.code).to eql(200)
+          expect(answer.status).to eql('completed')
+          expect(File.exist?(answer.file)).to be_truthy
+        end
+      }
+    end
+  end
+
+  describe 'convert MHTML local to local' do
+
+    src = File.realpath(__dir__ + '/../../testdata') + '/fileformatinfo.mht'
+    dst_dir = File.realpath(__dir__ + '/../../testresult') + '/'
+
+    describe 'convert local to local MHTML to doc' do
+
+      %w[pdf xps docx].each { |ext|
+        it "Convert MHTML to " + ext do
+
+          dst = dst_dir + 'locToLocDocMHTML.' + ext
+          answer = @html_api.convert_local_to_local(src, dst)
+
+          expect(answer.code).to eql(200)
+          expect(answer.status).to eql('completed')
+          expect(File.exist?(answer.file)).to be_truthy
+        end
+      }
+    end
+
+    describe 'convert local to local MHTML to doc with options' do
+
+      %w[pdf xps docx].each { |ext|
+        it "Convert MHTML to " + ext do
+
+          options_A4 = {
+            width: 8.3,
+            height: 11.7,
+            top_margin: 0.5,
+            bottom_margin: 0.5,
+            left_margin: 0.5,
+            right_margin: 0.5
+          }
+
+          dst = dst_dir + 'locToLocDocMHTMLWithOpts.' + ext
+          answer = @html_api.convert_local_to_local(src, dst, options_A4)
+
+          expect(answer.code).to eql(200)
+          expect(answer.status).to eql('completed')
+          expect(File.exist?(answer.file)).to be_truthy
+        end
+      }
+    end
+
+    describe 'convert local to local MHTML to image' do
+
+      %w[jpeg jpg bmp png tiff tif gif].each { |ext|
+        it "Convert MHTML to " + ext do
+
+          dst = dst_dir + 'locToLocMHTMLImg.' + ext
+          answer = @html_api.convert_local_to_local(src, dst)
+
+          expect(answer.code).to eql(200)
+          expect(answer.status).to eql('completed')
+          expect(File.exist?(answer.file)).to be_truthy
+        end
+      }
+    end
+
+    describe 'convert local to local MHTML to image with options' do
+
+      opts = {
+        width: 800,
+        height: 1000,
+        left_margin: 30,
+        right_margin: 30,
+        top_margin: 50,
+        bottom_margin: 50
+      }
+
+      %w[jpeg jpg bmp png tiff tif gif].each { |ext|
+        it "Convert MHTML to " + ext do
+
+          dst = dst_dir + 'locToLocMHTMLImgOpt.' + ext
+          answer = @html_api.convert_local_to_local(src, dst, opts)
+
+          expect(answer.code).to eql(200)
+          expect(answer.status).to eql('completed')
+          expect(File.exist?(answer.file)).to be_truthy
+        end
+      }
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -30,10 +30,14 @@
 require 'aspose_html_cloud'
 
 CONFIG = {
-  "basePath": "https://api.aspose.cloud/v4.0",
-  "authPath": "https://api.aspose.cloud/connect/token",
-  "apiKey": "c8dda7d6445d82635b8797d1c8edd153",
-  "appSID": "2225baa2-097b-4731-9831-d0d56c28230f",
+  # "basePath": "https://api.aspose.cloud/v4.0",
+  # "authPath": "https://api.aspose.cloud/connect/token",
+  # "apiKey": "c8dda7d6445d82635b8797d1c8edd153",
+  # "appSID": "2225baa2-097b-4731-9831-d0d56c28230f",
+  "basePath": "http://localhost:5000/v4.0",
+  "authPath": "https://api-qa.aspose.cloud/connect/token",
+  "apiKey": "html.cloud",
+  "appSID": "html.cloud",
   "debug": true
 }
 # from storage api

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aspose_html_cloud
 version: !ruby/object:Gem::Version
-  version: 22.9.1
+  version: 22.10.2
 platform: ruby
 authors:
 - Alexander Makogon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-15 00:00:00.000000000 Z
+date: 2022-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus