pdfcrowd 6.0.1 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd5433b839fb55dd482f13ea76bf6e74d203c071f748fd5d6ee8e09150a25f59
-  data.tar.gz: d55b65b1bdcd54cc604eb2176e950dad8d8ce1b876414f37da5f2819724d892b
+  metadata.gz: 5ced48bdced7379753e37229aab427f954e8f072a8cbc1d7f9dd5fcec926db33
+  data.tar.gz: a00e3aec16dd5fcdc70534b28955ca2240095090c0b34235c90afdc75583082b
 SHA512:
-  metadata.gz: 042b5798eb2361402cae04bfc61b465657e608c7d5b09a576123442a77e8da70af92cd4c4c39cf1d0ab33684093f8ac5bc5a4353944e7fe1452a78be6801ae46
-  data.tar.gz: d27d21a7ff8446ee0d3388e21feb37eaf73c647460ecb567e22c3843c41c684b90ede884a8440034c7804d11f205caf5c1745b42e9305f21261480ea7a90bc38
+  metadata.gz: 6f256d7dd7f6ca51472abe629e158238eaad99e2033f9ea8b05c21f9ab547de857f8d2463b573edaa071ed9bf47296f9afb6192452b78eec0b69b1020b8053ba
+  data.tar.gz: 7c31d569baf3b0a1dc81eb9966d10d517befdee64ed75021202e999a2155d60d57c7e6504178b508ec0eaf954cce9d44d6bef57bcf4075c296cd17a30d842f03

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.1'
+    CLIENT_VERSION = '6.2.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.1 (https://pdfcrowd.com)')
+            setUserAgent('pdfcrowd_ruby_client/6.2.0 (https://pdfcrowd.com)')
 
             @retry_count = 1
             @converter_version = '24.04'
@@ -1085,26 +1085,17 @@ module Pdfcrowd
 
         # Set the page range to print.
         #
-        # * +pages+ - A comma separated list of page numbers or ranges.
+        # * +pages+ - A comma separated list of page numbers or ranges. Special strings may be used, such as `odd`, `even` and `last`.
         # * *Returns* - The converter object.
         def setPrintPageRange(pages)
-            unless /^(?:\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*,\s*)*\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*))\s*$/.match(pages)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "setPrintPageRange", "html-to-pdf", "A comma separated list of page numbers or ranges.", "set_print_page_range"), 470);
+            unless /^(?:\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*)|odd|even|last)\s*,\s*)*\s*(?:\d+|(?:\d*\s*\-\s*\d+)|(?:\d+\s*\-\s*\d*)|odd|even|last)\s*$/.match(pages)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "setPrintPageRange", "html-to-pdf", "A comma separated list of page numbers or ranges. Special strings may be used, such as `odd`, `even` and `last`.", "set_print_page_range"), 470);
             end
             
             @fields['print_page_range'] = pages
             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.
@@ -1262,7 +1253,7 @@ module Pdfcrowd
             self
         end
 
-        # The page header is not printed on the specified pages.
+        # The page header content is not printed on the specified pages. To remove the entire header area, use the conversion config.
         #
         # * +pages+ - List of physical page numbers. Negative numbers count backwards from the last page: -1 is the last page, -2 is the last but one page, and so on. A comma separated list of page numbers.
         # * *Returns* - The converter object.
@@ -1275,7 +1266,7 @@ module Pdfcrowd
             self
         end
 
-        # The page footer is not printed on the specified pages.
+        # The page footer content is not printed on the specified pages. To remove the entire footer area, use the conversion config.
         #
         # * +pages+ - List of physical page numbers. Negative numbers count backwards from the last page: -1 is the last page, -2 is the last but one page, and so on. A comma separated list of page numbers.
         # * *Returns* - The converter object.
@@ -1301,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.
@@ -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. Special strings may be used, such as `odd`, `even` and `last`. 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 odd,2: the 2nd page and all odd pages 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.
@@ -5681,6 +5703,19 @@ module Pdfcrowd
             self
         end
 
+        # Sets the processing mode for handling Type 3 fonts.
+        #
+        # * +mode+ - The type3 font mode. Allowed values are raster, convert.
+        # * *Returns* - The converter object.
+        def setType3Mode(mode)
+            unless /(?i)^(raster|convert)$/.match(mode)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(mode, "setType3Mode", "pdf-to-html", "Allowed values are raster, convert.", "set_type3_mode"), 470);
+            end
+            
+            @fields['type3_mode'] = mode
+            self
+        end
+
         # Converts ligatures, two or more letters combined into a single glyph, back into their individual ASCII characters.
         #
         # * +value+ - Set to true to split ligatures.
@@ -5690,6 +5725,19 @@ module Pdfcrowd
             self
         end
 
+        # Apply custom CSS to the output HTML document. It allows you to modify the visual appearance and layout. 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", "pdf-to-html", "The string must not be empty.", "set_custom_css"), 470);
+            end
+            
+            @fields['custom_css'] = css
+            self
+        end
+
         # A helper method to determine if the output file is a zip archive. The output of the conversion may be either an HTML file or a zip file containing the HTML and its external assets.
         # * *Returns* - True if the conversion output is a zip file, otherwise False.
         def isZippedOutput()

metadata

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