pdfcrowd 4.4.1 → 4.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b44f300dd256f8cf5a78649a2b1178c571aa3f6
-  data.tar.gz: 5e9e2d111ef3f5082c24b71bea92513ee39be285
+  metadata.gz: df0f634e6fd4179d59c27374bca727145e33d834
+  data.tar.gz: 7835a6b9caa209ee4d2c9d29e2ed498dbb592906
 SHA512:
-  metadata.gz: 5320c2c115da7612e9d630438fd29cfbaf72379242e67105c3cc2d2ac768f6d8ec34b6c59a59b087e820d0373167861ab6e0a46b7a91640cdafde442dcd96bfa
-  data.tar.gz: e49b46452a95be155ce566dbfc2366df5bd9da72e63f1974df0c61e4ba353b1af132f6c78618814ccc42839946d827f3e89061bc57eb34c32e186b7d39e67e84
+  metadata.gz: 106fcf8b64482a784f7655ece03bb3f8ffbb2b986e34491620b2ac188b7d8e8a66ebf5dc3e632cbbc623981a809f5d50704a1a009f7b3d581e147651cec60a42
+  data.tar.gz: 5ddf56c46fc7258e5283e9d24444b0b0d723e588b972cb4f0f4a3fbc78710e7f18081161ecb0d63f81a35f21f80b9af78dc4334802498529ca689eb9bf3d7748

data/lib/pdfcrowd.rb

@@ -530,7 +530,7 @@ end
 module Pdfcrowd
     HOST = ENV["PDFCROWD_HOST"] || 'api.pdfcrowd.com'
     MULTIPART_BOUNDARY = '----------ThIs_Is_tHe_bOUnDary_$'
-    CLIENT_VERSION = '4.4.1'
+    CLIENT_VERSION = '4.4.2'
 
     class ConnectionHelper
         def initialize(user_name, api_key)
@@ -541,7 +541,7 @@ module Pdfcrowd
 
             setProxy(nil, nil, nil, nil)
             setUseHttp(false)
-            setUserAgent('pdfcrowd_ruby_client/4.4.1 (http://pdfcrowd.com)')
+            setUserAgent('pdfcrowd_ruby_client/4.4.2 (http://pdfcrowd.com)')
 
             @retry_count = 1
         end
@@ -1440,11 +1440,11 @@ module Pdfcrowd
 
         # Set the viewport width in pixels. The viewport is the user's visible area of the page.
         #
-        # * +viewport_width+ - The value must be in a range 96-7680.
+        # * +viewport_width+ - The value must be in the range 96-7680.
         # * *Returns* - The converter object.
         def setViewportWidth(viewport_width)
             if (!(Integer(viewport_width) >= 96 && Integer(viewport_width) <= 7680))
-                raise Error.new(Pdfcrowd.create_invalid_value_message(viewport_width, "viewport_width", "html-to-pdf", "The value must be in a range 96-7680.", "set_viewport_width"), 470);
+                raise Error.new(Pdfcrowd.create_invalid_value_message(viewport_width, "viewport_width", "html-to-pdf", "The value must be in the range 96-7680.", "set_viewport_width"), 470);
             end
             
             @fields['viewport_width'] = viewport_width
@@ -1466,7 +1466,7 @@ module Pdfcrowd
 
         # Set the viewport size. The viewport is the user's visible area of the page.
         #
-        # * +width+ - Set the viewport width in pixels. The viewport is the user's visible area of the page. The value must be in a range 96-7680.
+        # * +width+ - Set the viewport width in pixels. The viewport is the user's visible area of the page. The value must be in the range 96-7680.
         # * +height+ - Set the viewport height in pixels. The viewport is the user's visible area of the page. Must be a positive integer number.
         # * *Returns* - The converter object.
         def setViewport(width, height)
@@ -1475,7 +1475,7 @@ module Pdfcrowd
             self
         end
 
-        # Sets the rendering mode.
+        # Set the rendering mode.
         #
         # * +rendering_mode+ - The rendering mode. Allowed values are default, viewport.
         # * *Returns* - The converter object.
@@ -1490,11 +1490,11 @@ module Pdfcrowd
 
         # Set the scaling factor (zoom) for the main page area.
         #
-        # * +scale_factor+ - The scale factor. The value must be in a range 10-500.
+        # * +scale_factor+ - The percentage value. The value must be in the range 10-500.
         # * *Returns* - The converter object.
         def setScaleFactor(scale_factor)
             if (!(Integer(scale_factor) >= 10 && Integer(scale_factor) <= 500))
-                raise Error.new(Pdfcrowd.create_invalid_value_message(scale_factor, "scale_factor", "html-to-pdf", "The value must be in a range 10-500.", "set_scale_factor"), 470);
+                raise Error.new(Pdfcrowd.create_invalid_value_message(scale_factor, "scale_factor", "html-to-pdf", "The value must be in the range 10-500.", "set_scale_factor"), 470);
             end
             
             @fields['scale_factor'] = scale_factor
@@ -1503,11 +1503,11 @@ module Pdfcrowd
 
         # Set the scaling factor (zoom) for the header and footer.
         #
-        # * +header_footer_scale_factor+ - The scale factor. The value must be in a range 10-500.
+        # * +header_footer_scale_factor+ - The percentage value. The value must be in the range 10-500.
         # * *Returns* - The converter object.
         def setHeaderFooterScaleFactor(header_footer_scale_factor)
             if (!(Integer(header_footer_scale_factor) >= 10 && Integer(header_footer_scale_factor) <= 500))
-                raise Error.new(Pdfcrowd.create_invalid_value_message(header_footer_scale_factor, "header_footer_scale_factor", "html-to-pdf", "The value must be in a range 10-500.", "set_header_footer_scale_factor"), 470);
+                raise Error.new(Pdfcrowd.create_invalid_value_message(header_footer_scale_factor, "header_footer_scale_factor", "html-to-pdf", "The value must be in the range 10-500.", "set_header_footer_scale_factor"), 470);
             end
             
             @fields['header_footer_scale_factor'] = header_footer_scale_factor
@@ -1523,6 +1523,45 @@ module Pdfcrowd
             self
         end
 
+        # Set the quality of embedded JPEG images. Lower quality results in smaller PDF file. Lower quality affects printing or zooming in a PDF viewer.
+        #
+        # * +jpeg_quality+ - The percentage value. The value must be in the range 1-100.
+        # * *Returns* - The converter object.
+        def setJpegQuality(jpeg_quality)
+            if (!(Integer(jpeg_quality) >= 1 && Integer(jpeg_quality) <= 100))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(jpeg_quality, "jpeg_quality", "html-to-pdf", "The value must be in the range 1-100.", "set_jpeg_quality"), 470);
+            end
+            
+            @fields['jpeg_quality'] = jpeg_quality
+            self
+        end
+
+        # Set image categories to be converted into embedded JPEG images. The conversion into JPEG may result in smaller PDF file.
+        #
+        # * +convert_images_to_jpeg+ - The image category. Allowed values are none, opaque, all.
+        # * *Returns* - The converter object.
+        def setConvertImagesToJpeg(convert_images_to_jpeg)
+            unless /(?i)^(none|opaque|all)$/.match(convert_images_to_jpeg)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(convert_images_to_jpeg, "convert_images_to_jpeg", "html-to-pdf", "Allowed values are none, opaque, all.", "set_convert_images_to_jpeg"), 470);
+            end
+            
+            @fields['convert_images_to_jpeg'] = convert_images_to_jpeg
+            self
+        end
+
+        # Set the DPI when embedded image is scaled down. Lower DPI may result in smaller PDF file. Lower DPI affects printing or zooming in a PDF viewer. Use 0 for no scaling down.
+        #
+        # * +image_dpi+ - The DPI value. Must be a positive integer number or 0.
+        # * *Returns* - The converter object.
+        def setImageDpi(image_dpi)
+            if (!(Integer(image_dpi) >= 0))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(image_dpi, "image_dpi", "html-to-pdf", "Must be a positive integer number or 0.", "set_image_dpi"), 470);
+            end
+            
+            @fields['image_dpi'] = image_dpi
+            self
+        end
+
         # Create linearized PDF. This is also known as Fast Web View.
         #
         # * +linearize+ - Set to true to create linearized PDF.
@@ -1766,6 +1805,7 @@ module Pdfcrowd
         end
 
         # Get the number of conversion credits available in your account.
+        # The number is available after calling the conversion. So use the method after convertXYZ method.
         # The returned value can differ from the actual count if you run parallel conversions.
         # The special value 999999 is returned if the information is not available.
         # * *Returns* - The number of credits.
@@ -2288,11 +2328,11 @@ module Pdfcrowd
 
         # Set the output image width in pixels.
         #
-        # * +screenshot_width+ - The value must be in a range 96-7680.
+        # * +screenshot_width+ - The value must be in the range 96-7680.
         # * *Returns* - The converter object.
         def setScreenshotWidth(screenshot_width)
             if (!(Integer(screenshot_width) >= 96 && Integer(screenshot_width) <= 7680))
-                raise Error.new(Pdfcrowd.create_invalid_value_message(screenshot_width, "screenshot_width", "html-to-image", "The value must be in a range 96-7680.", "set_screenshot_width"), 470);
+                raise Error.new(Pdfcrowd.create_invalid_value_message(screenshot_width, "screenshot_width", "html-to-image", "The value must be in the range 96-7680.", "set_screenshot_width"), 470);
             end
             
             @fields['screenshot_width'] = screenshot_width
@@ -2328,6 +2368,7 @@ module Pdfcrowd
         end
 
         # Get the number of conversion credits available in your account.
+        # The number is available after calling the conversion. So use the method after convertXYZ method.
         # The returned value can differ from the actual count if you run parallel conversions.
         # The special value 999999 is returned if the information is not available.
         # * *Returns* - The number of credits.
@@ -2645,6 +2686,7 @@ module Pdfcrowd
         end
 
         # Get the number of conversion credits available in your account.
+        # The number is available after calling the conversion. So use the method after convertXYZ method.
         # The returned value can differ from the actual count if you run parallel conversions.
         # The special value 999999 is returned if the information is not available.
         # * *Returns* - The number of credits.
@@ -2846,6 +2888,7 @@ module Pdfcrowd
         end
 
         # Get the number of conversion credits available in your account.
+        # The number is available after calling the conversion. So use the method after convertXYZ method.
         # The returned value can differ from the actual count if you run parallel conversions.
         # The special value 999999 is returned if the information is not available.
         # * *Returns* - The number of credits.
@@ -3108,6 +3151,7 @@ module Pdfcrowd
         end
 
         # Get the number of conversion credits available in your account.
+        # The number is available after calling the conversion. So use the method after convertXYZ method.
         # The returned value can differ from the actual count if you run parallel conversions.
         # The special value 999999 is returned if the information is not available.
         # * *Returns* - The number of credits.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfcrowd
 version: !ruby/object:Gem::Version
-  version: 4.4.1
+  version: 4.4.2
 platform: ruby
 authors:
 - Pdfcrowd Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2019-01-30 00:00:00.000000000 Z
 dependencies: []
 description: The Pdfcrowd API lets you easily convert between HTML, PDF and various
   image formats.