pdfcrowd 5.20.0 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca4f095e5ea75c2cb312f3b2e8e3dab4dcf9dc9446e2ae858c8d31c42ceed5e5
-  data.tar.gz: b9106fc83ff0bd4255932da5f265f4aec382fc12845f52182d4b7550439cabc3
+  metadata.gz: bd5433b839fb55dd482f13ea76bf6e74d203c071f748fd5d6ee8e09150a25f59
+  data.tar.gz: d55b65b1bdcd54cc604eb2176e950dad8d8ce1b876414f37da5f2819724d892b
 SHA512:
-  metadata.gz: f4d0ba40598d6b635260887bd8a8dfb8bf0cdf71b5880bb70d2b5e00ebc99909e49d51b2b14122231720c571babe673e5236570934a47721ecb8d6c077b58f1e
-  data.tar.gz: 14eca890286ea656c45c78d5e96a3594e72b84c2f588c33c032a4c13d1aa7d81c7f11ab10b7fcbbd93985d7aa1c67ee3af5e9597c2fe63ef89839f007c5766e6
+  metadata.gz: 042b5798eb2361402cae04bfc61b465657e608c7d5b09a576123442a77e8da70af92cd4c4c39cf1d0ab33684093f8ac5bc5a4353944e7fe1452a78be6801ae46
+  data.tar.gz: d27d21a7ff8446ee0d3388e21feb37eaf73c647460ecb567e22c3843c41c684b90ede884a8440034c7804d11f205caf5c1745b42e9305f21261480ea7a90bc38

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 = '5.20.0'
+    CLIENT_VERSION = '6.0.1'
 
     class ConnectionHelper
         def initialize(user_name, api_key)
@@ -541,10 +541,10 @@ module Pdfcrowd
 
             setProxy(nil, nil, nil, nil)
             setUseHttp(false)
-            setUserAgent('pdfcrowd_ruby_client/5.20.0 (https://pdfcrowd.com)')
+            setUserAgent('pdfcrowd_ruby_client/6.0.1 (https://pdfcrowd.com)')
 
             @retry_count = 1
-            @converter_version = '20.10'
+            @converter_version = '24.04'
         end
 
         def post(fields, files, raw_data, out_stream = nil)
@@ -1105,93 +1105,52 @@ module Pdfcrowd
             self
         end
 
-        # Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
+        # Set the viewport width for formatting the HTML content when generating a PDF. By specifying a viewport width, you can control how the content is rendered, ensuring it mimics the appearance on various devices or matches specific design requirements.
         #
-        # * +x+ - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
+        # * +width+ - The width of the viewport. The value must be "balanced", "small", "medium", "large", "extra-large", or a number in the range 96-65000.
         # * *Returns* - The converter object.
-        def setContentAreaX(x)
-            unless /(?i)^0$|^\-?[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(x)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(x, "setContentAreaX", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\". It may contain a negative value.", "set_content_area_x"), 470);
+        def setContentViewportWidth(width)
+            unless /(?i)^(balanced|small|medium|large|extra-large|[0-9]+)$/.match(width)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(width, "setContentViewportWidth", "html-to-pdf", "The value must be \"balanced\", \"small\", \"medium\", \"large\", \"extra-large\", or a number in the range 96-65000.", "set_content_viewport_width"), 470);
             end
             
-            @fields['content_area_x'] = x
+            @fields['content_viewport_width'] = width
             self
         end
 
-        # Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
+        # Set the viewport height for formatting the HTML content when generating a PDF. By specifying a viewport height, you can enforce loading of lazy-loaded images and also affect vertical positioning of absolutely positioned elements within the content.
         #
-        # * +y+ - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
+        # * +height+ - The viewport height. The value must be "auto", "large", or a number.
         # * *Returns* - The converter object.
-        def setContentAreaY(y)
-            unless /(?i)^0$|^\-?[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(y)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(y, "setContentAreaY", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\". It may contain a negative value.", "set_content_area_y"), 470);
-            end
-            
-            @fields['content_area_y'] = y
-            self
-        end
-
-        # Set the width of the content area. It should be at least 1 inch.
-        #
-        # * +width+ - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
-        # * *Returns* - The converter object.
-        def setContentAreaWidth(width)
-            unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(width)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(width, "setContentAreaWidth", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_content_area_width"), 470);
-            end
-            
-            @fields['content_area_width'] = width
-            self
-        end
-
-        # Set the height of the content area. It should be at least 1 inch.
-        #
-        # * +height+ - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
-        # * *Returns* - The converter object.
-        def setContentAreaHeight(height)
-            unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(height)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setContentAreaHeight", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_content_area_height"), 470);
+        def setContentViewportHeight(height)
+            unless /(?i)^(auto|large|[0-9]+)$/.match(height)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setContentViewportHeight", "html-to-pdf", "The value must be \"auto\", \"large\", or a number.", "set_content_viewport_height"), 470);
             end
             
-            @fields['content_area_height'] = height
+            @fields['content_viewport_height'] = height
             self
         end
 
-        # Set the content area position and size. The content area enables to specify a web page area to be converted.
+        # Specifies the mode for fitting the HTML content to the print area by upscaling or downscaling it.
         #
-        # * +x+ - Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
-        # * +y+ - Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
-        # * +width+ - Set the width of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
-        # * +height+ - Set the height of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
+        # * +mode+ - The fitting mode. Allowed values are auto, smart-scaling, no-scaling, viewport-width, content-width, single-page, single-page-ratio.
         # * *Returns* - The converter object.
-        def setContentArea(x, y, width, height)
-            setContentAreaX(x)
-            setContentAreaY(y)
-            setContentAreaWidth(width)
-            setContentAreaHeight(height)
-            self
-        end
-
-        # Specifies behavior in presence of CSS @page rules. It may affect the page size, margins and orientation.
-        #
-        # * +mode+ - The page rule mode. Allowed values are default, mode1, mode2.
-        # * *Returns* - The converter object.
-        def setCssPageRuleMode(mode)
-            unless /(?i)^(default|mode1|mode2)$/.match(mode)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(mode, "setCssPageRuleMode", "html-to-pdf", "Allowed values are default, mode1, mode2.", "set_css_page_rule_mode"), 470);
+        def setContentFitMode(mode)
+            unless /(?i)^(auto|smart-scaling|no-scaling|viewport-width|content-width|single-page|single-page-ratio)$/.match(mode)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(mode, "setContentFitMode", "html-to-pdf", "Allowed values are auto, smart-scaling, no-scaling, viewport-width, content-width, single-page, single-page-ratio.", "set_content_fit_mode"), 470);
             end
             
-            @fields['css_page_rule_mode'] = mode
+            @fields['content_fit_mode'] = mode
             self
         end
 
         # Specifies which blank pages to exclude from the output document.
         #
-        # * +pages+ - The empty page behavior. Allowed values are trailing, none.
+        # * +pages+ - The empty page behavior. Allowed values are trailing, all, none.
         # * *Returns* - The converter object.
         def setRemoveBlankPages(pages)
-            unless /(?i)^(trailing|none)$/.match(pages)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "setRemoveBlankPages", "html-to-pdf", "Allowed values are trailing, none.", "set_remove_blank_pages"), 470);
+            unless /(?i)^(trailing|all|none)$/.match(pages)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "setRemoveBlankPages", "html-to-pdf", "Allowed values are trailing, all, none.", "set_remove_blank_pages"), 470);
             end
             
             @fields['remove_blank_pages'] = pages
@@ -1627,6 +1586,19 @@ module Pdfcrowd
             self
         end
 
+        # Specifies behavior in presence of CSS @page rules. It may affect the page size, margins and orientation.
+        #
+        # * +mode+ - The page rule mode. Allowed values are default, mode1, mode2.
+        # * *Returns* - The converter object.
+        def setCssPageRuleMode(mode)
+            unless /(?i)^(default|mode1|mode2)$/.match(mode)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(mode, "setCssPageRuleMode", "html-to-pdf", "Allowed values are default, mode1, mode2.", "set_css_page_rule_mode"), 470);
+            end
+            
+            @fields['css_page_rule_mode'] = mode
+            self
+        end
+
         # Apply custom CSS to the input HTML document. It allows you to modify the visual appearance and layout of your HTML content dynamically. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles.
         #
         # * +css+ - A string containing valid CSS. The string must not be empty.
@@ -2319,6 +2291,73 @@ module Pdfcrowd
             self
         end
 
+        # Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
+        #
+        # * +x+ - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
+        # * *Returns* - The converter object.
+        def setContentAreaX(x)
+            unless /(?i)^0$|^\-?[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(x)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(x, "setContentAreaX", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\". It may contain a negative value.", "set_content_area_x"), 470);
+            end
+            
+            @fields['content_area_x'] = x
+            self
+        end
+
+        # Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
+        #
+        # * +y+ - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
+        # * *Returns* - The converter object.
+        def setContentAreaY(y)
+            unless /(?i)^0$|^\-?[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(y)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(y, "setContentAreaY", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\". It may contain a negative value.", "set_content_area_y"), 470);
+            end
+            
+            @fields['content_area_y'] = y
+            self
+        end
+
+        # Set the width of the content area. It should be at least 1 inch.
+        #
+        # * +width+ - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
+        # * *Returns* - The converter object.
+        def setContentAreaWidth(width)
+            unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(width)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(width, "setContentAreaWidth", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_content_area_width"), 470);
+            end
+            
+            @fields['content_area_width'] = width
+            self
+        end
+
+        # Set the height of the content area. It should be at least 1 inch.
+        #
+        # * +height+ - The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
+        # * *Returns* - The converter object.
+        def setContentAreaHeight(height)
+            unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(height)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setContentAreaHeight", "html-to-pdf", "The value must be specified in inches \"in\", millimeters \"mm\", centimeters \"cm\", pixels \"px\", or points \"pt\".", "set_content_area_height"), 470);
+            end
+            
+            @fields['content_area_height'] = height
+            self
+        end
+
+        # Set the content area position and size. The content area enables to specify a web page area to be converted.
+        #
+        # * +x+ - Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
+        # * +y+ - Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt". It may contain a negative value.
+        # * +width+ - Set the width of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
+        # * +height+ - Set the height of the content area. It should be at least 1 inch. The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
+        # * *Returns* - The converter object.
+        def setContentArea(x, y, width, height)
+            setContentAreaX(x)
+            setContentAreaY(y)
+            setContentAreaWidth(width)
+            setContentAreaHeight(height)
+            self
+        end
+
         # A 2D transformation matrix applied to the main contents on each page. The origin [0,0] is located at the top-left corner of the contents. The resolution is 72 dpi.
         #
         # * +matrix+ - A comma separated string of matrix elements: "scaleX,skewX,transX,skewY,scaleY,transY"
@@ -2389,11 +2428,11 @@ module Pdfcrowd
 
         # Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
         #
-        # * +version+ - The version identifier. Allowed values are latest, 24.04, 20.10, 18.10.
+        # * +version+ - The version identifier. Allowed values are 24.04, 20.10, 18.10, latest.
         # * *Returns* - The converter object.
         def setConverterVersion(version)
-            unless /(?i)^(latest|24.04|20.10|18.10)$/.match(version)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "html-to-pdf", "Allowed values are latest, 24.04, 20.10, 18.10.", "set_converter_version"), 470);
+            unless /(?i)^(24.04|20.10|18.10|latest)$/.match(version)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "html-to-pdf", "Allowed values are 24.04, 20.10, 18.10, latest.", "set_converter_version"), 470);
             end
             
             @helper.setConverterVersion(version)
@@ -3199,11 +3238,11 @@ module Pdfcrowd
 
         # Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
         #
-        # * +version+ - The version identifier. Allowed values are latest, 24.04, 20.10, 18.10.
+        # * +version+ - The version identifier. Allowed values are 24.04, 20.10, 18.10, latest.
         # * *Returns* - The converter object.
         def setConverterVersion(version)
-            unless /(?i)^(latest|24.04|20.10|18.10)$/.match(version)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "html-to-image", "Allowed values are latest, 24.04, 20.10, 18.10.", "set_converter_version"), 470);
+            unless /(?i)^(24.04|20.10|18.10|latest)$/.match(version)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "html-to-image", "Allowed values are 24.04, 20.10, 18.10, latest.", "set_converter_version"), 470);
             end
             
             @helper.setConverterVersion(version)
@@ -3807,11 +3846,11 @@ module Pdfcrowd
 
         # Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
         #
-        # * +version+ - The version identifier. Allowed values are latest, 24.04, 20.10, 18.10.
+        # * +version+ - The version identifier. Allowed values are 24.04, 20.10, 18.10, latest.
         # * *Returns* - The converter object.
         def setConverterVersion(version)
-            unless /(?i)^(latest|24.04|20.10|18.10)$/.match(version)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "image-to-image", "Allowed values are latest, 24.04, 20.10, 18.10.", "set_converter_version"), 470);
+            unless /(?i)^(24.04|20.10|18.10|latest)$/.match(version)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "image-to-image", "Allowed values are 24.04, 20.10, 18.10, latest.", "set_converter_version"), 470);
             end
             
             @helper.setConverterVersion(version)
@@ -4375,11 +4414,11 @@ module Pdfcrowd
 
         # Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
         #
-        # * +version+ - The version identifier. Allowed values are latest, 24.04, 20.10, 18.10.
+        # * +version+ - The version identifier. Allowed values are 24.04, 20.10, 18.10, latest.
         # * *Returns* - The converter object.
         def setConverterVersion(version)
-            unless /(?i)^(latest|24.04|20.10|18.10)$/.match(version)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "pdf-to-pdf", "Allowed values are latest, 24.04, 20.10, 18.10.", "set_converter_version"), 470);
+            unless /(?i)^(24.04|20.10|18.10|latest)$/.match(version)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "pdf-to-pdf", "Allowed values are 24.04, 20.10, 18.10, latest.", "set_converter_version"), 470);
             end
             
             @helper.setConverterVersion(version)
@@ -5292,11 +5331,11 @@ module Pdfcrowd
 
         # Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.
         #
-        # * +version+ - The version identifier. Allowed values are latest, 24.04, 20.10, 18.10.
+        # * +version+ - The version identifier. Allowed values are 24.04, 20.10, 18.10, latest.
         # * *Returns* - The converter object.
         def setConverterVersion(version)
-            unless /(?i)^(latest|24.04|20.10|18.10)$/.match(version)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "image-to-pdf", "Allowed values are latest, 24.04, 20.10, 18.10.", "set_converter_version"), 470);
+            unless /(?i)^(24.04|20.10|18.10|latest)$/.match(version)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "image-to-pdf", "Allowed values are 24.04, 20.10, 18.10, latest.", "set_converter_version"), 470);
             end
             
             @helper.setConverterVersion(version)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfcrowd
 version: !ruby/object:Gem::Version
-  version: 5.20.0
+  version: 6.0.1
 platform: ruby
 authors:
 - Pdfcrowd Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-07 00:00:00.000000000 Z
+date: 2024-07-09 00:00:00.000000000 Z
 dependencies: []
 description: The Pdfcrowd API lets you easily convert between HTML, PDF and various
   image formats.