pdfcrowd 5.13.1 → 5.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3b46f24d1656d84d213fa15a588861bc11e4bedc6bd93ac5a87b3c2e50a25ca
-  data.tar.gz: 154772540e506f59ffbd6c3cc64e25e859482e2845c230a10eb7ac5e4dc47a2c
+  metadata.gz: 7d96eee1f2494868b0edd320d65d8176e42291b823034832cf717edbc48bba44
+  data.tar.gz: 0b9def3cb91cb453bc8b7328b45c4b131971f37c0816639ced5d87a864cdd710
 SHA512:
-  metadata.gz: f91d281e04c15b4236d4360cb94ae82da42fc2c7ca9da4db7e9176b1803047e514f6eebacf3b942c0a9e37d515ae8efb698a2453bd1b5c4bb209ab609053f90b
-  data.tar.gz: 8e2c56c82011c3095e3f44976d28920b43245f3597be42d3eea68c2decb057f68bd2a0b6f45dd7eadc8c41850c17fd53686a496ee8372988d864e1bd41cf724d
+  metadata.gz: 5f0e397040820e52b4c4a7f248ba7999685eb9b66b44e31e6aca14fd2870248237649394fc30c38d76f89f5d072ec6c777d59fd8abc5bfd7e170959d0b7ae230
+  data.tar.gz: 7ef83fc8034db9c2e998e714767284539eb94751ed8114dfc32b9e83150599fcf75adfbaab80e09cfe97bf8eb6ffd585a6f415d31a177115935a76cddfefd6f7

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.13.1'
+    CLIENT_VERSION = '5.15.0'
 
     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/5.13.1 (https://pdfcrowd.com)')
+            setUserAgent('pdfcrowd_ruby_client/5.15.0 (https://pdfcrowd.com)')
 
             @retry_count = 1
             @converter_version = '20.10'
@@ -1627,6 +1627,19 @@ module Pdfcrowd
             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.
+        # * *Returns* - The converter object.
+        def setCustomCss(css)
+            if (!(!css.nil? && !css.empty?))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(css, "setCustomCss", "html-to-pdf", "The string must not be empty.", "set_custom_css"), 470);
+            end
+            
+            @fields['custom_css'] = css
+            self
+        end
+
         # Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
         #
         # * +javascript+ - A string containing a JavaScript code. The string must not be empty.
@@ -2361,6 +2374,19 @@ module Pdfcrowd
             self
         end
 
+        # Set the maximum time to load the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading.
+        #
+        # * +max_time+ - The number of seconds to wait. The value must be in the range 10-30.
+        # * *Returns* - The converter object.
+        def setMaxLoadingTime(max_time)
+            if (!(Integer(max_time) >= 10 && Integer(max_time) <= 30))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(max_time, "setMaxLoadingTime", "html-to-pdf", "The value must be in the range 10-30.", "set_max_loading_time"), 470);
+            end
+            
+            @fields['max_loading_time'] = max_time
+            self
+        end
+
         # 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, 20.10, 18.10.
@@ -2631,6 +2657,58 @@ module Pdfcrowd
             self
         end
 
+        # Set the output image width in pixels.
+        #
+        # * +width+ - The value must be in the range 96-65000.
+        # * *Returns* - The converter object.
+        def setScreenshotWidth(width)
+            if (!(Integer(width) >= 96 && Integer(width) <= 65000))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(width, "setScreenshotWidth", "html-to-image", "The value must be in the range 96-65000.", "set_screenshot_width"), 470);
+            end
+            
+            @fields['screenshot_width'] = width
+            self
+        end
+
+        # Set the output image height in pixels. If it is not specified, actual document height is used.
+        #
+        # * +height+ - Must be a positive integer number.
+        # * *Returns* - The converter object.
+        def setScreenshotHeight(height)
+            if (!(Integer(height) > 0))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setScreenshotHeight", "html-to-image", "Must be a positive integer number.", "set_screenshot_height"), 470);
+            end
+            
+            @fields['screenshot_height'] = height
+            self
+        end
+
+        # Set the scaling factor (zoom) for the output image.
+        #
+        # * +factor+ - The percentage value. Must be a positive integer number.
+        # * *Returns* - The converter object.
+        def setScaleFactor(factor)
+            if (!(Integer(factor) > 0))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(factor, "setScaleFactor", "html-to-image", "Must be a positive integer number.", "set_scale_factor"), 470);
+            end
+            
+            @fields['scale_factor'] = factor
+            self
+        end
+
+        # The output image background color.
+        #
+        # * +color+ - The value must be in RRGGBB or RRGGBBAA hexadecimal format.
+        # * *Returns* - The converter object.
+        def setBackgroundColor(color)
+            unless /^[0-9a-fA-F]{6,8}$/.match(color)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(color, "setBackgroundColor", "html-to-image", "The value must be in RRGGBB or RRGGBBAA hexadecimal format.", "set_background_color"), 470);
+            end
+            
+            @fields['background_color'] = color
+            self
+        end
+
         # Use the print version of the page if available (@media print).
         #
         # * +value+ - Set to true to use the print version of the page.
@@ -2799,6 +2877,19 @@ module Pdfcrowd
             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.
+        # * *Returns* - The converter object.
+        def setCustomCss(css)
+            if (!(!css.nil? && !css.empty?))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(css, "setCustomCss", "html-to-image", "The string must not be empty.", "set_custom_css"), 470);
+            end
+            
+            @fields['custom_css'] = css
+            self
+        end
+
         # Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.
         #
         # * +javascript+ - A string containing a JavaScript code. The string must not be empty.
@@ -2912,58 +3003,6 @@ module Pdfcrowd
             self
         end
 
-        # Set the output image width in pixels.
-        #
-        # * +width+ - The value must be in the range 96-65000.
-        # * *Returns* - The converter object.
-        def setScreenshotWidth(width)
-            if (!(Integer(width) >= 96 && Integer(width) <= 65000))
-                raise Error.new(Pdfcrowd.create_invalid_value_message(width, "setScreenshotWidth", "html-to-image", "The value must be in the range 96-65000.", "set_screenshot_width"), 470);
-            end
-            
-            @fields['screenshot_width'] = width
-            self
-        end
-
-        # Set the output image height in pixels. If it is not specified, actual document height is used.
-        #
-        # * +height+ - Must be a positive integer number.
-        # * *Returns* - The converter object.
-        def setScreenshotHeight(height)
-            if (!(Integer(height) > 0))
-                raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setScreenshotHeight", "html-to-image", "Must be a positive integer number.", "set_screenshot_height"), 470);
-            end
-            
-            @fields['screenshot_height'] = height
-            self
-        end
-
-        # Set the scaling factor (zoom) for the output image.
-        #
-        # * +factor+ - The percentage value. Must be a positive integer number.
-        # * *Returns* - The converter object.
-        def setScaleFactor(factor)
-            if (!(Integer(factor) > 0))
-                raise Error.new(Pdfcrowd.create_invalid_value_message(factor, "setScaleFactor", "html-to-image", "Must be a positive integer number.", "set_scale_factor"), 470);
-            end
-            
-            @fields['scale_factor'] = factor
-            self
-        end
-
-        # The output image background color.
-        #
-        # * +color+ - The value must be in RRGGBB or RRGGBBAA hexadecimal format.
-        # * *Returns* - The converter object.
-        def setBackgroundColor(color)
-            unless /^[0-9a-fA-F]{6,8}$/.match(color)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(color, "setBackgroundColor", "html-to-image", "The value must be in RRGGBB or RRGGBBAA hexadecimal format.", "set_background_color"), 470);
-            end
-            
-            @fields['background_color'] = color
-            self
-        end
-
         # Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.
         #
         # * +data_string+ - The input data string.
@@ -3145,6 +3184,19 @@ module Pdfcrowd
             self
         end
 
+        # Set the maximum time to load the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading.
+        #
+        # * +max_time+ - The number of seconds to wait. The value must be in the range 10-30.
+        # * *Returns* - The converter object.
+        def setMaxLoadingTime(max_time)
+            if (!(Integer(max_time) >= 10 && Integer(max_time) <= 30))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(max_time, "setMaxLoadingTime", "html-to-image", "The value must be in the range 10-30.", "set_max_loading_time"), 470);
+            end
+            
+            @fields['max_loading_time'] = max_time
+            self
+        end
+
         # 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, 20.10, 18.10.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfcrowd
 version: !ruby/object:Gem::Version
-  version: 5.13.1
+  version: 5.15.0
 platform: ruby
 authors:
 - Pdfcrowd Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies: []
 description: The Pdfcrowd API lets you easily convert between HTML, PDF and various
   image formats.