pdfcrowd 5.7.0 → 5.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff7de4a25d9f583b82184eecd989139565f33110d7a79e6328688dd9c7418a21
-  data.tar.gz: d9324022e428d2ba86fa45b20d29885211a7178939eec40cbd4b95a32f06c262
+  metadata.gz: 1a5acbb283c6b75918ea9f34e667cbf48c1a6fb04527ddfb7635094306c40645
+  data.tar.gz: f4932f2c8cbe494a14c42dee45212d0eae455f1aadd560765e0aca046f8dfe8d
 SHA512:
-  metadata.gz: e7802a0a0f86a33936ac0d9f0d844dd50e8cb23bd7d8f45198806343fe7d19090b7f3bce732a83c8d8bcbdf3bd37140fe691f3de0737c6bf756d1d5edb53f307
-  data.tar.gz: 1cbec0e536718b03c390787c182568cf1583e35b9b5f88e40aa08df1fe48a9c933e0c6f3c50081f98aa95e9e466ea0ead9b6b6e93a3378755d6575725eecd559
+  metadata.gz: 9bc88c22538231821ac6ad2e99b8acdb3df27f5c0da3ff7339aa6e8bdde66cb970bbb4c4884b2abf90ba655a97dc1b656e502fad4637278a432cec390f96a252
+  data.tar.gz: 81937c8b7d2d32683b2f807d0da6f1b592d96607587fcbfd0c64f79a649fda1436462d2c7a2c58d2539a3fc2125a248908842ab853e4bdfd8503ff3dd0ee76ad

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.7.0'
+    CLIENT_VERSION = '5.9.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.7.0 (https://pdfcrowd.com)')
+            setUserAgent('pdfcrowd_ruby_client/5.9.0 (https://pdfcrowd.com)')
 
             @retry_count = 1
             @converter_version = '20.10'
@@ -597,6 +597,10 @@ module Pdfcrowd
             @page_count
         end
 
+        def getTotalPageCount()
+            @total_page_count
+        end
+
         def getOutputSize()
             @output_size
         end
@@ -613,6 +617,7 @@ module Pdfcrowd
             @consumed_credits = 0
             @job_id = ''
             @page_count = 0
+            @total_page_count = 0
             @output_size = 0
             @retry = 0
         end
@@ -699,6 +704,7 @@ module Pdfcrowd
                             @consumed_credits = (response["X-Pdfcrowd-Consumed-Credits"] || 0).to_i
                             @job_id = response["X-Pdfcrowd-Job-Id"] || ''
                             @page_count = (response["X-Pdfcrowd-Pages"] || 0).to_i
+                            @total_page_count = (response["X-Pdfcrowd-Total-Pages"] || 0).to_i
                             @output_size = (response["X-Pdfcrowd-Output-Size"] || 0).to_i
 
                             raise Error.new('test 502', '502') \
@@ -1327,9 +1333,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply the first page of the watermark PDF to every page of the output PDF.
+        # 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 watermark PDF file. The file must exist and not be empty.
+        # * +watermark+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setPageWatermark(watermark)
             if (!(File.file?(watermark) && !File.zero?(watermark)))
@@ -1340,7 +1346,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a watermark PDF from the specified URL and apply the first page of the watermark PDF to every page of the output PDF.
+        # Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. 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.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -1353,9 +1359,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply each page of the specified watermark PDF to the corresponding page of the output PDF.
+        # Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
         #
-        # * +watermark+ - The file path to a local watermark PDF file. The file must exist and not be empty.
+        # * +watermark+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setMultipageWatermark(watermark)
             if (!(File.file?(watermark) && !File.zero?(watermark)))
@@ -1366,7 +1372,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a watermark PDF from the specified URL and apply each page of the specified watermark PDF to the corresponding page of the output PDF.
+        # Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -1379,9 +1385,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply the first page of the specified PDF to the background of every page of the output PDF.
+        # Apply a background to each page of the output PDF file. A background 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 background.
         #
-        # * +background+ - The file path to a local background PDF file. The file must exist and not be empty.
+        # * +background+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setPageBackground(background)
             if (!(File.file?(background) && !File.zero?(background)))
@@ -1392,7 +1398,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a background PDF from the specified URL and apply the first page of the background PDF to every page of the output PDF.
+        # Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background 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 background.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -1405,9 +1411,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply each page of the specified PDF to the background of the corresponding page of the output PDF.
+        # Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
         #
-        # * +background+ - The file path to a local background PDF file. The file must exist and not be empty.
+        # * +background+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setMultipageBackground(background)
             if (!(File.file?(background) && !File.zero?(background)))
@@ -1418,7 +1424,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a background PDF from the specified URL and apply each page of the specified background PDF to the corresponding page of the output PDF.
+        # Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -1714,11 +1720,11 @@ module Pdfcrowd
 
         # The input HTML is automatically enhanced to improve the readability.
         #
-        # * +enhancements+ - Allowed values are none, readability-v1, readability-v2, readability-v3.
+        # * +enhancements+ - Allowed values are none, readability-v1, readability-v2, readability-v3, readability-v4.
         # * *Returns* - The converter object.
         def setReadabilityEnhancements(enhancements)
-            unless /(?i)^(none|readability-v1|readability-v2|readability-v3)$/.match(enhancements)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(enhancements, "setReadabilityEnhancements", "html-to-pdf", "Allowed values are none, readability-v1, readability-v2, readability-v3.", "set_readability_enhancements"), 470);
+            unless /(?i)^(none|readability-v1|readability-v2|readability-v3|readability-v4)$/.match(enhancements)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(enhancements, "setReadabilityEnhancements", "html-to-pdf", "Allowed values are none, readability-v1, readability-v2, readability-v3, readability-v4.", "set_readability_enhancements"), 470);
             end
             
             @fields['readability_enhancements'] = enhancements
@@ -2197,12 +2203,18 @@ module Pdfcrowd
             return @helper.getJobId()
         end
 
-        # Get the total number of pages in the output document.
+        # Get the number of pages in the output document.
         # * *Returns* - The page count.
         def getPageCount()
             return @helper.getPageCount()
         end
 
+        # Get the total number of pages in the original output document, including the pages excluded by setPrintPageRange().
+        # * *Returns* - The total page count.
+        def getTotalPageCount()
+            return @helper.getTotalPageCount()
+        end
+
         # Get the size of the output in bytes.
         # * *Returns* - The count of bytes.
         def getOutputSize()
@@ -2880,11 +2892,11 @@ module Pdfcrowd
 
         # The input HTML is automatically enhanced to improve the readability.
         #
-        # * +enhancements+ - Allowed values are none, readability-v1, readability-v2, readability-v3.
+        # * +enhancements+ - Allowed values are none, readability-v1, readability-v2, readability-v3, readability-v4.
         # * *Returns* - The converter object.
         def setReadabilityEnhancements(enhancements)
-            unless /(?i)^(none|readability-v1|readability-v2|readability-v3)$/.match(enhancements)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(enhancements, "setReadabilityEnhancements", "html-to-image", "Allowed values are none, readability-v1, readability-v2, readability-v3.", "set_readability_enhancements"), 470);
+            unless /(?i)^(none|readability-v1|readability-v2|readability-v3|readability-v4)$/.match(enhancements)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(enhancements, "setReadabilityEnhancements", "html-to-image", "Allowed values are none, readability-v1, readability-v2, readability-v3, readability-v4.", "set_readability_enhancements"), 470);
             end
             
             @fields['readability_enhancements'] = enhancements
@@ -3626,9 +3638,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply the first page of the watermark PDF to every page of the output PDF.
+        # 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 watermark PDF file. The file must exist and not be empty.
+        # * +watermark+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setPageWatermark(watermark)
             if (!(File.file?(watermark) && !File.zero?(watermark)))
@@ -3639,7 +3651,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a watermark PDF from the specified URL and apply the first page of the watermark PDF to every page of the output PDF.
+        # Load a file from the specified URL and apply the file as a watermark to each page of the output PDF. 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.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -3652,9 +3664,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply each page of the specified watermark PDF to the corresponding page of the output PDF.
+        # Apply each page of a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
         #
-        # * +watermark+ - The file path to a local watermark PDF file. The file must exist and not be empty.
+        # * +watermark+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setMultipageWatermark(watermark)
             if (!(File.file?(watermark) && !File.zero?(watermark)))
@@ -3665,7 +3677,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a watermark PDF from the specified URL and apply each page of the specified watermark PDF to the corresponding page of the output PDF.
+        # Load a file from the specified URL and apply each page of the file as a watermark to the corresponding page of the output PDF. A watermark can be either a PDF or an image.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -3678,9 +3690,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply the first page of the specified PDF to the background of every page of the output PDF.
+        # Apply a background to each page of the output PDF file. A background 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 background.
         #
-        # * +background+ - The file path to a local background PDF file. The file must exist and not be empty.
+        # * +background+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setPageBackground(background)
             if (!(File.file?(background) && !File.zero?(background)))
@@ -3691,7 +3703,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a background PDF from the specified URL and apply the first page of the background PDF to every page of the output PDF.
+        # Load a file from the specified URL and apply the file as a background to each page of the output PDF. A background 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 background.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -3704,9 +3716,9 @@ module Pdfcrowd
             self
         end
 
-        # Apply each page of the specified PDF to the background of the corresponding page of the output PDF.
+        # Apply each page of a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
         #
-        # * +background+ - The file path to a local background PDF file. The file must exist and not be empty.
+        # * +background+ - The file path to a local file. The file must exist and not be empty.
         # * *Returns* - The converter object.
         def setMultipageBackground(background)
             if (!(File.file?(background) && !File.zero?(background)))
@@ -3717,7 +3729,7 @@ module Pdfcrowd
             self
         end
 
-        # Load a background PDF from the specified URL and apply each page of the specified background PDF to the corresponding page of the output PDF.
+        # Load a file from the specified URL and apply each page of the file as a background to the corresponding page of the output PDF. A background can be either a PDF or an image.
         #
         # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
@@ -4006,7 +4018,7 @@ module Pdfcrowd
             return @helper.getJobId()
         end
 
-        # Get the total number of pages in the output document.
+        # Get the number of pages in the output document.
         # * *Returns* - The page count.
         def getPageCount()
             return @helper.getPageCount()
@@ -4791,7 +4803,7 @@ module Pdfcrowd
             return @helper.getJobId()
         end
 
-        # Get the total number of pages in the output document.
+        # Get the number of pages in the output document.
         # * *Returns* - The page count.
         def getPageCount()
             return @helper.getPageCount()

metadata

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