pdfcrowd 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34762c61f54d6cc17ab834a37ad6cc4e8e3849b29bfcc432b493ea0fb97bb5b5
-  data.tar.gz: 6def76bbb1426182fbd92d45b13148f01785190eb58a6c3dd6cbe726ab16d162
+  metadata.gz: cdfb803513e340c4d125a04c7af3c2bb2aa9d7ada652a9636c965eacf964d4cc
+  data.tar.gz: 3f66c527fc9db82d72e2576a240b1a435ee7a72edb60d31f4fc4c012d2457617
 SHA512:
-  metadata.gz: d43f03b05750ecee2d0b4843d8cdee07d522c38be060431dfc5da8a89149d3d838711b3fb034fbaaa7612d813d49681853b7acf10b951050b4d441c7f17e1080
-  data.tar.gz: 60377a449017ce359cc8d4de32d3fe2f200042aafc481a1d2ce04c6c667126517c330cc0b06261e847f91ddba31498f704a57caab642018406e2b1061116f0c9
+  metadata.gz: 9fa86e54a212cfb73b338ec55b30411c054cf58827fa619dab8b7aca68e3e7e1fb6e8bb0d451919c8d6f3020223d7d2333fdba8d7442de16fd040ee3227bae25
+  data.tar.gz: a96652ca6a25ce06aba4fad0f9643a5ce12b5825aa7af87618d5d9e0b9436436a3d7ce012d4516671164bc4bf12dd7cebf60e28c4b33cad16a4a2ca4215872e5

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 = '6.0.0'
+    CLIENT_VERSION = '6.1.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/6.0.0 (https://pdfcrowd.com)')
+            setUserAgent('pdfcrowd_ruby_client/6.1.0 (https://pdfcrowd.com)')
 
             @retry_count = 1
             @converter_version = '24.04'
@@ -1096,15 +1096,6 @@ module Pdfcrowd
             self
         end
 
-        # Set an offset between physical and logical page numbers.
-        #
-        # * +offset+ - Integer specifying page offset.
-        # * *Returns* - The converter object.
-        def setPageNumberingOffset(offset)
-            @fields['page_numbering_offset'] = offset
-            self
-        end
-
         # 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.
         #
         # * +width+ - The width of the viewport. The value must be "balanced", "small", "medium", "large", "extra-large", or a number in the range 96-65000.
@@ -1144,86 +1135,6 @@ 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
-
-        # 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
-
         # Specifies which blank pages to exclude from the output document.
         #
         # * +pages+ - The empty page behavior. Allowed values are trailing, all, none.
@@ -1381,6 +1292,15 @@ module Pdfcrowd
             self
         end
 
+        # Set an offset between physical and logical page numbers.
+        #
+        # * +offset+ - Integer specifying page offset.
+        # * *Returns* - The converter object.
+        def setPageNumberingOffset(offset)
+            @fields['page_numbering_offset'] = offset
+            self
+        end
+
         # Apply a watermark to each page of the output PDF file. A watermark can be either a PDF or an image. If a multi-page file (PDF or TIFF) is used, the first page is used as the watermark.
         #
         # * +watermark+ - The file path to a local file. The file must exist and not be empty.
@@ -1666,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.
@@ -2358,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"
@@ -2426,6 +2426,28 @@ module Pdfcrowd
             self
         end
 
+        # Allows to configure conversion via JSON. The configuration defines various page settings for individual PDF pages or ranges of pages. It provides flexibility in designing each page of the PDF, giving control over each page's size, header, footer etc. If a page or parameter is not explicitly specified, the system will use the default settings for that page or attribute. If a JSON configuration is provided, the settings in the JSON will take precedence over the global options. The structure of the JSON must be: pageSetup: An array of objects where each object defines the configuration for a specific page or range of pages. The following properties can be set for each page object: pages: A comma-separated list of page numbers or ranges. For example: 1-: from page 1 to the end of the document 2: only the 2nd page 2, 4, 6: pages 2, 4, and 6 2-5: pages 2 through 5 pageSize: The page size (optional). Possible values: A0, A1, A2, A3, A4, A5, A6, Letter. pageWidth: The width of the page (optional). pageHeight: The height of the page (optional). marginLeft: Left margin (optional). marginRight: Right margin (optional). marginTop: Top margin (optional). marginBottom: Bottom margin (optional). displayHeader: Header appearance (optional). Possible values: none: completely excluded space: only the content is excluded, the space is used content: the content is printed (default) displayFooter: Footer appearance (optional). Possible values: none: completely excluded space: only the content is excluded, the space is used content: the content is printed (default) headerHeight: Height of the header (optional). footerHeight: Height of the footer (optional). orientation: Page orientation, such as "portrait" or "landscape" (optional). Dimensions may be empty, 0 or specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
+        #
+        # * +json_string+ - The JSON string.
+        # * *Returns* - The converter object.
+        def setConversionConfig(json_string)
+            @fields['conversion_config'] = json_string
+            self
+        end
+
+        # Allows to configure the conversion process via JSON file. See details of the JSON string.
+        #
+        # * +filepath+ - The file path to a local file. The file must exist and not be empty.
+        # * *Returns* - The converter object.
+        def setConversionConfigFile(filepath)
+            if (!(File.file?(filepath) && !File.zero?(filepath)))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(filepath, "setConversionConfigFile", "html-to-pdf", "The file must exist and not be empty.", "set_conversion_config_file"), 470);
+            end
+            
+            @files['conversion_config_file'] = filepath
+            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 24.04, 20.10, 18.10, latest.

metadata

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