pdfcrowd 6.2.1 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f97c72508c22bb03da1413d7868420657d6e93fe0447913d93b71c1dc9bfa1fb
-  data.tar.gz: 3956525e9d2c6ee9c490684fcda82e933e98fca0bbc5d4176df112ef03c8cf1d
+  metadata.gz: 322ea060c4e7f8e1bd32b97615425c8de400ac4057bb69f773e7f2e77d5c90f8
+  data.tar.gz: 676b0bf43dd8b01c6425b21b6dcdde8deaa6126402c46dece2c1e31c89c81700
 SHA512:
-  metadata.gz: f56fbea6b28e21d0f74bde3cb9e33e04cabbb20f38ee4e3a54f46c722f8dba14ed35be040f0c464b7c0649bbac33b896f7d9d4d136d8f45986c821beab727fde
-  data.tar.gz: 3a50f9412ad1f5236c0ab3d335c50aad84a9f41bf76aef3b9e381c35fd0fb57aac85d62dee9f1056ad2b19f30838d883029e63d69722a57919ecffde75860c22
+  metadata.gz: bfce44ae31033323da751fa12b6dd5eeeece773938a63e398c20fcf220a02777846195df66e43c146de2c2f8127e33dc94f944f7b54d8905ae2e664f5de9fc54
+  data.tar.gz: 0aec6354e8bf6960a6d7d7fe897c6d43d727e71592beb977f33f07cbe163ab386044ed4c554d03efb543a99222779ecd3f945eb82297aaea972a41ccb4ffeed9

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.2.1'
+    CLIENT_VERSION = '6.4.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.2.1 (https://pdfcrowd.com)')
+            setUserAgent('pdfcrowd_ruby_client/6.4.0 (https://pdfcrowd.com)')
 
             @retry_count = 1
             @converter_version = '24.04'
@@ -1512,19 +1512,13 @@ module Pdfcrowd
             self
         end
 
-        # Set the HTTP authentication user name.
-        #
-        # * +user_name+ - The user name.
-        # * *Returns* - The converter object.
+
         def setHttpAuthUserName(user_name)
             @fields['http_auth_user_name'] = user_name
             self
         end
 
-        # Set the HTTP authentication password.
-        #
-        # * +password+ - The password.
-        # * *Returns* - The converter object.
+
         def setHttpAuthPassword(password)
             @fields['http_auth_password'] = password
             self
@@ -2426,7 +2420,7 @@ 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".
+        # 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). backgroundColor: Page background color in RRGGBB or RRGGBBAA hexadecimal format (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.
@@ -2448,6 +2442,21 @@ module Pdfcrowd
             self
         end
 
+
+        def setSubprocessReferrer(referrer)
+            @fields['subprocess_referrer'] = referrer
+            self
+        end
+
+        # Specifies the User-Agent HTTP header that will be used by the converter when a request is made to the converted web page.
+        #
+        # * +agent+ - The user agent.
+        # * *Returns* - The converter object.
+        def setConverterUserAgent(agent)
+            @fields['converter_user_agent'] = agent
+            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.
@@ -2471,6 +2480,15 @@ module Pdfcrowd
             self
         end
 
+        # Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
+        #
+        # * +agent+ - The user agent string.
+        # * *Returns* - The converter object.
+        def setClientUserAgent(agent)
+            @helper.setUserAgent(agent)
+            self
+        end
+
         # Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
         #
         # * +agent+ - The user agent string.
@@ -2864,19 +2882,13 @@ module Pdfcrowd
             self
         end
 
-        # Set the HTTP authentication user name.
-        #
-        # * +user_name+ - The user name.
-        # * *Returns* - The converter object.
+
         def setHttpAuthUserName(user_name)
             @fields['http_auth_user_name'] = user_name
             self
         end
 
-        # Set the HTTP authentication password.
-        #
-        # * +password+ - The password.
-        # * *Returns* - The converter object.
+
         def setHttpAuthPassword(password)
             @fields['http_auth_password'] = password
             self
@@ -3258,6 +3270,21 @@ module Pdfcrowd
             self
         end
 
+
+        def setSubprocessReferrer(referrer)
+            @fields['subprocess_referrer'] = referrer
+            self
+        end
+
+        # Specifies the User-Agent HTTP header that will be used by the converter when a request is made to the converted web page.
+        #
+        # * +agent+ - The user agent.
+        # * *Returns* - The converter object.
+        def setConverterUserAgent(agent)
+            @fields['converter_user_agent'] = agent
+            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.
@@ -3281,6 +3308,15 @@ module Pdfcrowd
             self
         end
 
+        # Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
+        #
+        # * +agent+ - The user agent string.
+        # * *Returns* - The converter object.
+        def setClientUserAgent(agent)
+            @helper.setUserAgent(agent)
+            self
+        end
+
         # Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
         #
         # * +agent+ - The user agent string.
@@ -3889,6 +3925,15 @@ module Pdfcrowd
             self
         end
 
+        # Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
+        #
+        # * +agent+ - The user agent string.
+        # * *Returns* - The converter object.
+        def setClientUserAgent(agent)
+            @helper.setUserAgent(agent)
+            self
+        end
+
         # Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
         #
         # * +agent+ - The user agent string.
@@ -4457,6 +4502,15 @@ module Pdfcrowd
             self
         end
 
+        # Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
+        #
+        # * +agent+ - The user agent string.
+        # * *Returns* - The converter object.
+        def setClientUserAgent(agent)
+            @helper.setUserAgent(agent)
+            self
+        end
+
         # Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
         #
         # * +agent+ - The user agent string.
@@ -5374,6 +5428,15 @@ module Pdfcrowd
             self
         end
 
+        # Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
+        #
+        # * +agent+ - The user agent string.
+        # * *Returns* - The converter object.
+        def setClientUserAgent(agent)
+            @helper.setUserAgent(agent)
+            self
+        end
+
         # Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
         #
         # * +agent+ - The user agent string.
@@ -5738,6 +5801,19 @@ module Pdfcrowd
             self
         end
 
+        # Add the specified prefix to all id and class attributes in the HTML content, creating a namespace for safe integration into another HTML document. This ensures unique identifiers, preventing conflicts when merging with other HTML.
+        #
+        # * +prefix+ - The prefix to add before each id and class attribute name. Start with a letter or underscore, and use only letters, numbers, hyphens, underscores, or colons.
+        # * *Returns* - The converter object.
+        def setHtmlNamespace(prefix)
+            unless /(?i)^[a-z_][a-z0-9_:-]*$/.match(prefix)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(prefix, "setHtmlNamespace", "pdf-to-html", "Start with a letter or underscore, and use only letters, numbers, hyphens, underscores, or colons.", "set_html_namespace"), 470);
+            end
+            
+            @fields['html_namespace'] = prefix
+            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()
@@ -5878,6 +5954,19 @@ module Pdfcrowd
             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.
+        # * *Returns* - The converter object.
+        def setConverterVersion(version)
+            unless /(?i)^(24.04|20.10|18.10|latest)$/.match(version)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(version, "setConverterVersion", "pdf-to-html", "Allowed values are 24.04, 20.10, 18.10, latest.", "set_converter_version"), 470);
+            end
+            
+            @helper.setConverterVersion(version)
+            self
+        end
+
         # Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
         # Warning: Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.
         #
@@ -5888,6 +5977,15 @@ module Pdfcrowd
             self
         end
 
+        # Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
+        #
+        # * +agent+ - The user agent string.
+        # * *Returns* - The converter object.
+        def setClientUserAgent(agent)
+            @helper.setUserAgent(agent)
+            self
+        end
+
         # Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
         #
         # * +agent+ - The user agent string.
@@ -6387,6 +6485,15 @@ module Pdfcrowd
             self
         end
 
+        # Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
+        #
+        # * +agent+ - The user agent string.
+        # * *Returns* - The converter object.
+        def setClientUserAgent(agent)
+            @helper.setUserAgent(agent)
+            self
+        end
+
         # Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
         #
         # * +agent+ - The user agent string.
@@ -6847,6 +6954,15 @@ module Pdfcrowd
             self
         end
 
+        # Specifies the User-Agent HTTP header that the client library will use when interacting with the API.
+        #
+        # * +agent+ - The user agent string.
+        # * *Returns* - The converter object.
+        def setClientUserAgent(agent)
+            @helper.setUserAgent(agent)
+            self
+        end
+
         # Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
         #
         # * +agent+ - The user agent string.

metadata

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