pdfcrowd 5.0.0 → 5.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc58c568c0a12634d68d5dac7c41204f0f85700625b51ca8a88e71d4b6561cf7
-  data.tar.gz: a468401553b1ddaa4baf20d7941e0e5c62ed3f5a96b4a39dfb804186598454af
+  metadata.gz: e22bed7779bf0e1ef8c80b87beb45fa1f282de154265bd58c6d4caacfa709d6b
+  data.tar.gz: 2e1d7202fface710faeed72d73bbe0cd7698595e175223c52b005f86c3739854
 SHA512:
-  metadata.gz: 51baf77a8349fccdbd38959e3beca4d8db1640f28151ee58808c617679315a3b6aac98334e5a83549a9bd61d184391791bf5ecc210faf60195defc1dc05f7bbe
-  data.tar.gz: 5b0f93f5c60e5e7eba9406deeed8d1d13d2a215dc98b55082c399c7a5816b109840b92c527f8f55662c9b2a7893aaf4defe5a3bf7da2c9fb492b10849c6cc9e6
+  metadata.gz: 1223499de57fd5db8ff4a3ff0bd4dbf32017c1b9bc1b63733d4f4b40bfccb6934f8ac8a4dd9cc95d91913d577b9671182cc33acadac5857b1349d1995583a8bf
+  data.tar.gz: 8555f3aa2b3d0b617bef88bad26430cc0cf772655beec1c1915ebd7602594c6656fc1941a27d4a4dc71add24d81eabf40f44fb2f262d324306fef2b2b914f5ca

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.0.0'
+    CLIENT_VERSION = '5.2.2'
 
     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.0.0 (http://pdfcrowd.com)')
+            setUserAgent('pdfcrowd_ruby_client/5.2.2 (https://pdfcrowd.com)')
 
             @retry_count = 1
             @converter_version = '20.10'
@@ -626,7 +626,7 @@ module Pdfcrowd
             body << 'Content-Disposition: form-data; name="%s"; filename="%s"' % [name, file_name]
             body << 'Content-Type: application/octet-stream'
             body << ''
-            body << data
+            body << data.force_encoding('UTF-8')
         end
 
         def self.encode_multipart_post_data(fields, files, raw_data)
@@ -735,7 +735,7 @@ module Pdfcrowd
     def self.create_invalid_value_message(value, field, converter, hint, id)
         message = "Invalid value '%s' for %s." % [value, field]
         message += " " + hint if hint
-        return message + " " + "Details: https://www.pdfcrowd.com/doc/api/%s/ruby/#%s" % [converter, id]
+        return message + " " + "Details: https://www.pdfcrowd.com/doc/api/%s/ruby/ref/#%s" % [converter, id]
     end
 
 # generated code
@@ -895,6 +895,53 @@ module Pdfcrowd
             end
         end
 
+        # Convert the contents of an input stream.
+        #
+        # * +in_stream+ - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).
+        # * *Returns* - Byte array containing the conversion output.
+        def convertStream(in_stream)
+            @raw_data['stream'] = in_stream.read
+            @helper.post(@fields, @files, @raw_data)
+        end
+
+        # Convert the contents of an input stream and write the result to an output stream.
+        #
+        # * +in_stream+ - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).
+        # * +out_stream+ - The output stream that will contain the conversion output.
+        def convertStreamToStream(in_stream, out_stream)
+            @raw_data['stream'] = in_stream.read
+            @helper.post(@fields, @files, @raw_data, out_stream)
+        end
+
+        # Convert the contents of an input stream and write the result to a local file.
+        #
+        # * +in_stream+ - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).
+        # * +file_path+ - The output file path. The string must not be empty.
+        def convertStreamToFile(in_stream, file_path)
+            if (!(!file_path.nil? && !file_path.empty?))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "convertStreamToFile::file_path", "html-to-pdf", "The string must not be empty.", "convert_stream_to_file"), 470);
+            end
+            
+            output_file = open(file_path, "wb")
+            begin
+                convertStreamToStream(in_stream, output_file)
+                output_file.close()
+            rescue Error => why
+                output_file.close()
+                FileUtils.rm(file_path)
+                raise
+            end
+        end
+
+        # Set the file name of the main HTML document stored in the input archive. If not specified, the first HTML file in the archive is used for conversion. Use this method if the input archive contains multiple HTML documents.
+        #
+        # * +filename+ - The file name.
+        # * *Returns* - The converter object.
+        def setZipMainFilename(filename)
+            @fields['zip_main_filename'] = filename
+            self
+        end
+
         # Set the output page size.
         #
         # * +size+ - Allowed values are A0, A1, A2, A3, A4, A5, A6, Letter.
@@ -1034,93 +1081,6 @@ module Pdfcrowd
             self
         end
 
-        # Load an HTML code from the specified URL and use it as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of a converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals Arabic numerals are used by default. Roman numerals can be generated by the roman and roman-lowercase values Example: <span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span> data-pdfcrowd-placement - specifies where to place the source URL, allowed values: The URL is inserted to the content Example: <span class='pdfcrowd-source-url'></span> will produce <span>http://example.com</span> href - the URL is set to the href attribute Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a> will produce <a href='http://example.com'>Link to source</a> href-and-content - the URL is set to the href attribute and to the content Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a> will produce <a href='http://example.com'>http://example.com</a>
-        #
-        # * +url+ - The supported protocols are http:// and https://.
-        # * *Returns* - The converter object.
-        def setHeaderUrl(url)
-            unless /(?i)^https?:\/\/.*$/.match(url)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setHeaderUrl", "html-to-pdf", "The supported protocols are http:// and https://.", "set_header_url"), 470);
-            end
-            
-            @fields['header_url'] = url
-            self
-        end
-
-        # Use the specified HTML code as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of a converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals Arabic numerals are used by default. Roman numerals can be generated by the roman and roman-lowercase values Example: <span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span> data-pdfcrowd-placement - specifies where to place the source URL, allowed values: The URL is inserted to the content Example: <span class='pdfcrowd-source-url'></span> will produce <span>http://example.com</span> href - the URL is set to the href attribute Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a> will produce <a href='http://example.com'>Link to source</a> href-and-content - the URL is set to the href attribute and to the content Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a> will produce <a href='http://example.com'>http://example.com</a>
-        #
-        # * +html+ - The string must not be empty.
-        # * *Returns* - The converter object.
-        def setHeaderHtml(html)
-            if (!(!html.nil? && !html.empty?))
-                raise Error.new(Pdfcrowd.create_invalid_value_message(html, "setHeaderHtml", "html-to-pdf", "The string must not be empty.", "set_header_html"), 470);
-            end
-            
-            @fields['header_html'] = html
-            self
-        end
-
-        # Set the header height.
-        #
-        # * +height+ - Can be specified in inches (in), millimeters (mm), centimeters (cm), or points (pt).
-        # * *Returns* - The converter object.
-        def setHeaderHeight(height)
-            unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(height)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setHeaderHeight", "html-to-pdf", "Can be specified in inches (in), millimeters (mm), centimeters (cm), or points (pt).", "set_header_height"), 470);
-            end
-            
-            @fields['header_height'] = height
-            self
-        end
-
-        # Load an HTML code from the specified URL and use it as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of a converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals Arabic numerals are used by default. Roman numerals can be generated by the roman and roman-lowercase values Example: <span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span> data-pdfcrowd-placement - specifies where to place the source URL, allowed values: The URL is inserted to the content Example: <span class='pdfcrowd-source-url'></span> will produce <span>http://example.com</span> href - the URL is set to the href attribute Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a> will produce <a href='http://example.com'>Link to source</a> href-and-content - the URL is set to the href attribute and to the content Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a> will produce <a href='http://example.com'>http://example.com</a>
-        #
-        # * +url+ - The supported protocols are http:// and https://.
-        # * *Returns* - The converter object.
-        def setFooterUrl(url)
-            unless /(?i)^https?:\/\/.*$/.match(url)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setFooterUrl", "html-to-pdf", "The supported protocols are http:// and https://.", "set_footer_url"), 470);
-            end
-            
-            @fields['footer_url'] = url
-            self
-        end
-
-        # Use the specified HTML as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of a converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals Arabic numerals are used by default. Roman numerals can be generated by the roman and roman-lowercase values Example: <span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span> data-pdfcrowd-placement - specifies where to place the source URL, allowed values: The URL is inserted to the content Example: <span class='pdfcrowd-source-url'></span> will produce <span>http://example.com</span> href - the URL is set to the href attribute Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a> will produce <a href='http://example.com'>Link to source</a> href-and-content - the URL is set to the href attribute and to the content Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a> will produce <a href='http://example.com'>http://example.com</a>
-        #
-        # * +html+ - The string must not be empty.
-        # * *Returns* - The converter object.
-        def setFooterHtml(html)
-            if (!(!html.nil? && !html.empty?))
-                raise Error.new(Pdfcrowd.create_invalid_value_message(html, "setFooterHtml", "html-to-pdf", "The string must not be empty.", "set_footer_html"), 470);
-            end
-            
-            @fields['footer_html'] = html
-            self
-        end
-
-        # Set the footer height.
-        #
-        # * +height+ - Can be specified in inches (in), millimeters (mm), centimeters (cm), or points (pt).
-        # * *Returns* - The converter object.
-        def setFooterHeight(height)
-            unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(height)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setFooterHeight", "html-to-pdf", "Can be specified in inches (in), millimeters (mm), centimeters (cm), or points (pt).", "set_footer_height"), 470);
-            end
-            
-            @fields['footer_height'] = height
-            self
-        end
-
-        # Disable horizontal page margins for header and footer. The header/footer contents width will be equal to the physical page width.
-        #
-        # * +value+ - Set to true to disable horizontal margins for header and footer.
-        # * *Returns* - The converter object.
-        def setNoHeaderFooterHorizontalMargins(value)
-            @fields['no_header_footer_horizontal_margins'] = value
-            self
-        end
-
         # Set the page range to print.
         #
         # * +pages+ - A comma separated list of page numbers or ranges.
@@ -1134,32 +1094,6 @@ module Pdfcrowd
             self
         end
 
-        # The page header is not printed on the specified pages.
-        #
-        # * +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.
-        def setExcludeHeaderOnPages(pages)
-            unless /^(?:\s*\-?\d+\s*,)*\s*\-?\d+\s*$/.match(pages)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "setExcludeHeaderOnPages", "html-to-pdf", "A comma separated list of page numbers.", "set_exclude_header_on_pages"), 470);
-            end
-            
-            @fields['exclude_header_on_pages'] = pages
-            self
-        end
-
-        # The page footer is not printed on the specified pages.
-        #
-        # * +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.
-        def setExcludeFooterOnPages(pages)
-            unless /^(?:\s*\-?\d+\s*,)*\s*\-?\d+\s*$/.match(pages)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "setExcludeFooterOnPages", "html-to-pdf", "A comma separated list of page numbers.", "set_exclude_footer_on_pages"), 470);
-            end
-            
-            @fields['exclude_footer_on_pages'] = pages
-            self
-        end
-
         # Set an offset between physical and logical page numbers.
         #
         # * +offset+ - Integer specifying page offset.
@@ -1249,79 +1183,147 @@ module Pdfcrowd
             self
         end
 
-        # Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.
+        # Load an HTML code from the specified URL and use it as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of a converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: <span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span> data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: <span class='pdfcrowd-source-url'></span> will produce <span>http://example.com</span> href - the URL is set to the href attribute Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a> will produce <a href='http://example.com'>Link to source</a> href-and-content - the URL is set to the href attribute and to the content Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a> will produce <a href='http://example.com'>http://example.com</a>
         #
-        # * +data_string+ - The input data string.
+        # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
-        def setDataString(data_string)
-            @fields['data_string'] = data_string
+        def setHeaderUrl(url)
+            unless /(?i)^https?:\/\/.*$/.match(url)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setHeaderUrl", "html-to-pdf", "The supported protocols are http:// and https://.", "set_header_url"), 470);
+            end
+            
+            @fields['header_url'] = url
             self
         end
 
-        # Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
+        # Use the specified HTML code as the page header. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of a converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: <span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span> data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: <span class='pdfcrowd-source-url'></span> will produce <span>http://example.com</span> href - the URL is set to the href attribute Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a> will produce <a href='http://example.com'>Link to source</a> href-and-content - the URL is set to the href attribute and to the content Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a> will produce <a href='http://example.com'>http://example.com</a>
         #
-        # * +data_file+ - The file path to a local file containing the input data.
+        # * +html+ - The string must not be empty.
         # * *Returns* - The converter object.
-        def setDataFile(data_file)
-            @files['data_file'] = data_file
+        def setHeaderHtml(html)
+            if (!(!html.nil? && !html.empty?))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(html, "setHeaderHtml", "html-to-pdf", "The string must not be empty.", "set_header_html"), 470);
+            end
+            
+            @fields['header_html'] = html
             self
         end
 
-        # Specify the input data format.
+        # Set the header height.
         #
-        # * +data_format+ - The data format. Allowed values are auto, json, xml, yaml, csv.
+        # * +height+ - Can be specified in inches (in), millimeters (mm), centimeters (cm), or points (pt).
         # * *Returns* - The converter object.
-        def setDataFormat(data_format)
-            unless /(?i)^(auto|json|xml|yaml|csv)$/.match(data_format)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(data_format, "setDataFormat", "html-to-pdf", "Allowed values are auto, json, xml, yaml, csv.", "set_data_format"), 470);
+        def setHeaderHeight(height)
+            unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(height)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setHeaderHeight", "html-to-pdf", "Can be specified in inches (in), millimeters (mm), centimeters (cm), or points (pt).", "set_header_height"), 470);
             end
             
-            @fields['data_format'] = data_format
+            @fields['header_height'] = height
             self
         end
 
-        # Set the encoding of the data file set by setDataFile.
+        # Set the file name of the header HTML document stored in the input archive. Use this method if the input archive contains multiple HTML documents.
         #
-        # * +encoding+ - The data file encoding.
+        # * +filename+ - The file name.
         # * *Returns* - The converter object.
-        def setDataEncoding(encoding)
-            @fields['data_encoding'] = encoding
+        def setZipHeaderFilename(filename)
+            @fields['zip_header_filename'] = filename
             self
         end
 
-        # Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {% if variable is defined %} to check if the variable is defined.
+        # Load an HTML code from the specified URL and use it as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of a converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: <span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span> data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: <span class='pdfcrowd-source-url'></span> will produce <span>http://example.com</span> href - the URL is set to the href attribute Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a> will produce <a href='http://example.com'>Link to source</a> href-and-content - the URL is set to the href attribute and to the content Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a> will produce <a href='http://example.com'>http://example.com</a>
         #
-        # * +value+ - Set to true to ignore undefined variables.
+        # * +url+ - The supported protocols are http:// and https://.
         # * *Returns* - The converter object.
-        def setDataIgnoreUndefined(value)
-            @fields['data_ignore_undefined'] = value
+        def setFooterUrl(url)
+            unless /(?i)^https?:\/\/.*$/.match(url)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(url, "setFooterUrl", "html-to-pdf", "The supported protocols are http:// and https://.", "set_footer_url"), 470);
+            end
+            
+            @fields['footer_url'] = url
             self
         end
 
-        # Auto escape HTML symbols in the input data before placing them into the output.
+        # Use the specified HTML as the page footer. The following classes can be used in the HTML. The content of the respective elements will be expanded as follows: pdfcrowd-page-count - the total page count of printed pages pdfcrowd-page-number - the current page number pdfcrowd-source-url - the source URL of a converted document The following attributes can be used: data-pdfcrowd-number-format - specifies the type of the used numerals. Allowed values: arabic - Arabic numerals, they are used by default roman - Roman numerals eastern-arabic - Eastern Arabic numerals bengali - Bengali numerals devanagari - Devanagari numerals thai - Thai numerals east-asia - Chinese, Vietnamese, Japanese and Korean numerals chinese-formal - Chinese formal numerals Please contact us if you need another type of numerals. Example: <span class='pdfcrowd-page-number' data-pdfcrowd-number-format='roman'></span> data-pdfcrowd-placement - specifies where to place the source URL. Allowed values: The URL is inserted to the content Example: <span class='pdfcrowd-source-url'></span> will produce <span>http://example.com</span> href - the URL is set to the href attribute Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href'>Link to source</a> will produce <a href='http://example.com'>Link to source</a> href-and-content - the URL is set to the href attribute and to the content Example: <a class='pdfcrowd-source-url' data-pdfcrowd-placement='href-and-content'></a> will produce <a href='http://example.com'>http://example.com</a>
         #
-        # * +value+ - Set to true to turn auto escaping on.
+        # * +html+ - The string must not be empty.
         # * *Returns* - The converter object.
-        def setDataAutoEscape(value)
-            @fields['data_auto_escape'] = value
+        def setFooterHtml(html)
+            if (!(!html.nil? && !html.empty?))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(html, "setFooterHtml", "html-to-pdf", "The string must not be empty.", "set_footer_html"), 470);
+            end
+            
+            @fields['footer_html'] = html
             self
         end
 
-        # Auto trim whitespace around each template command block.
+        # Set the footer height.
         #
-        # * +value+ - Set to true to turn auto trimming on.
+        # * +height+ - Can be specified in inches (in), millimeters (mm), centimeters (cm), or points (pt).
         # * *Returns* - The converter object.
-        def setDataTrimBlocks(value)
-            @fields['data_trim_blocks'] = value
+        def setFooterHeight(height)
+            unless /(?i)^0$|^[0-9]*\.?[0-9]+(pt|px|mm|cm|in)$/.match(height)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(height, "setFooterHeight", "html-to-pdf", "Can be specified in inches (in), millimeters (mm), centimeters (cm), or points (pt).", "set_footer_height"), 470);
+            end
+            
+            @fields['footer_height'] = height
             self
         end
 
-        # Set the advanced data options:csv_delimiter - The CSV data delimiter, the default is ,.xml_remove_root - Remove the root XML element from the input data.data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data.
+        # Set the file name of the footer HTML document stored in the input archive. Use this method if the input archive contains multiple HTML documents.
         #
-        # * +options+ - Comma separated list of options.
+        # * +filename+ - The file name.
         # * *Returns* - The converter object.
-        def setDataOptions(options)
-            @fields['data_options'] = options
+        def setZipFooterFilename(filename)
+            @fields['zip_footer_filename'] = filename
+            self
+        end
+
+        # Disable horizontal page margins for header and footer. The header/footer contents width will be equal to the physical page width.
+        #
+        # * +value+ - Set to true to disable horizontal margins for header and footer.
+        # * *Returns* - The converter object.
+        def setNoHeaderFooterHorizontalMargins(value)
+            @fields['no_header_footer_horizontal_margins'] = value
+            self
+        end
+
+        # The page header is not printed on the specified pages.
+        #
+        # * +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.
+        def setExcludeHeaderOnPages(pages)
+            unless /^(?:\s*\-?\d+\s*,)*\s*\-?\d+\s*$/.match(pages)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "setExcludeHeaderOnPages", "html-to-pdf", "A comma separated list of page numbers.", "set_exclude_header_on_pages"), 470);
+            end
+            
+            @fields['exclude_header_on_pages'] = pages
+            self
+        end
+
+        # The page footer is not printed on the specified pages.
+        #
+        # * +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.
+        def setExcludeFooterOnPages(pages)
+            unless /^(?:\s*\-?\d+\s*,)*\s*\-?\d+\s*$/.match(pages)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "setExcludeFooterOnPages", "html-to-pdf", "A comma separated list of page numbers.", "set_exclude_footer_on_pages"), 470);
+            end
+            
+            @fields['exclude_footer_on_pages'] = pages
+            self
+        end
+
+        # Set the scaling factor (zoom) for the header and footer.
+        #
+        # * +factor+ - The percentage value. The value must be in the range 10-500.
+        # * *Returns* - The converter object.
+        def setHeaderFooterScaleFactor(factor)
+            if (!(Integer(factor) >= 10 && Integer(factor) <= 500))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(factor, "setHeaderFooterScaleFactor", "html-to-pdf", "The value must be in the range 10-500.", "set_header_footer_scale_factor"), 470);
+            end
+            
+            @fields['header_footer_scale_factor'] = factor
             self
         end
 
@@ -1666,7 +1668,7 @@ module Pdfcrowd
             self
         end
 
-        # Specify the DOM handling when only a part of the document is converted.
+        # Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.
         #
         # * +mode+ - Allowed values are cut-out, remove-siblings, hide-siblings.
         # * *Returns* - The converter object.
@@ -1768,19 +1770,6 @@ module Pdfcrowd
             self
         end
 
-        # Set the scaling factor (zoom) for the header and footer.
-        #
-        # * +factor+ - The percentage value. The value must be in the range 10-500.
-        # * *Returns* - The converter object.
-        def setHeaderFooterScaleFactor(factor)
-            if (!(Integer(factor) >= 10 && Integer(factor) <= 500))
-                raise Error.new(Pdfcrowd.create_invalid_value_message(factor, "setHeaderFooterScaleFactor", "html-to-pdf", "The value must be in the range 10-500.", "set_header_footer_scale_factor"), 470);
-            end
-            
-            @fields['header_footer_scale_factor'] = factor
-            self
-        end
-
         # Set the quality of embedded JPEG images. A lower quality results in a smaller PDF file but can lead to compression artifacts.
         #
         # * +quality+ - The percentage value. The value must be in the range 1-100.
@@ -1919,6 +1908,15 @@ module Pdfcrowd
             self
         end
 
+        # Extract meta tags (author, keywords and description) from the input HTML and use them in the output PDF.
+        #
+        # * +value+ - Set to true to extract meta tags.
+        # * *Returns* - The converter object.
+        def setExtractMetaTags(value)
+            @fields['extract_meta_tags'] = value
+            self
+        end
+
         # Specify the page layout to be used when the document is opened.
         #
         # * +layout+ - Allowed values are single-page, one-column, two-column-left, two-column-right.
@@ -2033,17 +2031,93 @@ module Pdfcrowd
         #
         # * +value+ - Set to true to display the title.
         # * *Returns* - The converter object.
-        def setDisplayTitle(value)
-            @fields['display_title'] = value
+        def setDisplayTitle(value)
+            @fields['display_title'] = value
+            self
+        end
+
+        # Set the predominant reading order for text to right-to-left. This option has no direct effect on the document's contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up
+        #
+        # * +value+ - Set to true to set right-to-left reading order.
+        # * *Returns* - The converter object.
+        def setRightToLeft(value)
+            @fields['right_to_left'] = value
+            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.
+        # * *Returns* - The converter object.
+        def setDataString(data_string)
+            @fields['data_string'] = data_string
+            self
+        end
+
+        # Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
+        #
+        # * +data_file+ - The file path to a local file containing the input data.
+        # * *Returns* - The converter object.
+        def setDataFile(data_file)
+            @files['data_file'] = data_file
+            self
+        end
+
+        # Specify the input data format.
+        #
+        # * +data_format+ - The data format. Allowed values are auto, json, xml, yaml, csv.
+        # * *Returns* - The converter object.
+        def setDataFormat(data_format)
+            unless /(?i)^(auto|json|xml|yaml|csv)$/.match(data_format)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(data_format, "setDataFormat", "html-to-pdf", "Allowed values are auto, json, xml, yaml, csv.", "set_data_format"), 470);
+            end
+            
+            @fields['data_format'] = data_format
+            self
+        end
+
+        # Set the encoding of the data file set by setDataFile.
+        #
+        # * +encoding+ - The data file encoding.
+        # * *Returns* - The converter object.
+        def setDataEncoding(encoding)
+            @fields['data_encoding'] = encoding
+            self
+        end
+
+        # Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {% if variable is defined %} to check if the variable is defined.
+        #
+        # * +value+ - Set to true to ignore undefined variables.
+        # * *Returns* - The converter object.
+        def setDataIgnoreUndefined(value)
+            @fields['data_ignore_undefined'] = value
+            self
+        end
+
+        # Auto escape HTML symbols in the input data before placing them into the output.
+        #
+        # * +value+ - Set to true to turn auto escaping on.
+        # * *Returns* - The converter object.
+        def setDataAutoEscape(value)
+            @fields['data_auto_escape'] = value
+            self
+        end
+
+        # Auto trim whitespace around each template command block.
+        #
+        # * +value+ - Set to true to turn auto trimming on.
+        # * *Returns* - The converter object.
+        def setDataTrimBlocks(value)
+            @fields['data_trim_blocks'] = value
             self
         end
 
-        # Set the predominant reading order for text to right-to-left. This option has no direct effect on the document's contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up
+        # Set the advanced data options:csv_delimiter - The CSV data delimiter, the default is ,.xml_remove_root - Remove the root XML element from the input data.data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data.
         #
-        # * +value+ - Set to true to set right-to-left reading order.
+        # * +options+ - Comma separated list of options.
         # * *Returns* - The converter object.
-        def setRightToLeft(value)
-            @fields['right_to_left'] = value
+        def setDataOptions(options)
+            @fields['data_options'] = options
             self
         end
 
@@ -2449,79 +2523,50 @@ module Pdfcrowd
             end
         end
 
-        # Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.
+        # Convert the contents of an input stream.
         #
-        # * +data_string+ - The input data string.
-        # * *Returns* - The converter object.
-        def setDataString(data_string)
-            @fields['data_string'] = data_string
-            self
+        # * +in_stream+ - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).
+        # * *Returns* - Byte array containing the conversion output.
+        def convertStream(in_stream)
+            @raw_data['stream'] = in_stream.read
+            @helper.post(@fields, @files, @raw_data)
         end
 
-        # Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
+        # Convert the contents of an input stream and write the result to an output stream.
         #
-        # * +data_file+ - The file path to a local file containing the input data.
-        # * *Returns* - The converter object.
-        def setDataFile(data_file)
-            @files['data_file'] = data_file
-            self
+        # * +in_stream+ - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).
+        # * +out_stream+ - The output stream that will contain the conversion output.
+        def convertStreamToStream(in_stream, out_stream)
+            @raw_data['stream'] = in_stream.read
+            @helper.post(@fields, @files, @raw_data, out_stream)
         end
 
-        # Specify the input data format.
+        # Convert the contents of an input stream and write the result to a local file.
         #
-        # * +data_format+ - The data format. Allowed values are auto, json, xml, yaml, csv.
-        # * *Returns* - The converter object.
-        def setDataFormat(data_format)
-            unless /(?i)^(auto|json|xml|yaml|csv)$/.match(data_format)
-                raise Error.new(Pdfcrowd.create_invalid_value_message(data_format, "setDataFormat", "html-to-image", "Allowed values are auto, json, xml, yaml, csv.", "set_data_format"), 470);
+        # * +in_stream+ - The input stream with source data. The stream can contain either HTML code or an archive (.zip, .tar.gz, .tar.bz2).The archive can contain HTML code and its external assets (images, style sheets, javascript).
+        # * +file_path+ - The output file path. The string must not be empty.
+        def convertStreamToFile(in_stream, file_path)
+            if (!(!file_path.nil? && !file_path.empty?))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "convertStreamToFile::file_path", "html-to-image", "The string must not be empty.", "convert_stream_to_file"), 470);
             end
             
-            @fields['data_format'] = data_format
-            self
-        end
-
-        # Set the encoding of the data file set by setDataFile.
-        #
-        # * +encoding+ - The data file encoding.
-        # * *Returns* - The converter object.
-        def setDataEncoding(encoding)
-            @fields['data_encoding'] = encoding
-            self
-        end
-
-        # Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {% if variable is defined %} to check if the variable is defined.
-        #
-        # * +value+ - Set to true to ignore undefined variables.
-        # * *Returns* - The converter object.
-        def setDataIgnoreUndefined(value)
-            @fields['data_ignore_undefined'] = value
-            self
-        end
-
-        # Auto escape HTML symbols in the input data before placing them into the output.
-        #
-        # * +value+ - Set to true to turn auto escaping on.
-        # * *Returns* - The converter object.
-        def setDataAutoEscape(value)
-            @fields['data_auto_escape'] = value
-            self
-        end
-
-        # Auto trim whitespace around each template command block.
-        #
-        # * +value+ - Set to true to turn auto trimming on.
-        # * *Returns* - The converter object.
-        def setDataTrimBlocks(value)
-            @fields['data_trim_blocks'] = value
-            self
+            output_file = open(file_path, "wb")
+            begin
+                convertStreamToStream(in_stream, output_file)
+                output_file.close()
+            rescue Error => why
+                output_file.close()
+                FileUtils.rm(file_path)
+                raise
+            end
         end
 
-        # Set the advanced data options:csv_delimiter - The CSV data delimiter, the default is ,.xml_remove_root - Remove the root XML element from the input data.data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data.
+        # Set the file name of the main HTML document stored in the input archive. If not specified, the first HTML file in the archive is used for conversion. Use this method if the input archive contains multiple HTML documents.
         #
-        # * +options+ - Comma separated list of options.
+        # * +filename+ - The file name.
         # * *Returns* - The converter object.
-        def setDataOptions(options)
-            @fields['data_options'] = options
+        def setZipMainFilename(filename)
+            @fields['zip_main_filename'] = filename
             self
         end
 
@@ -2749,7 +2794,7 @@ module Pdfcrowd
             self
         end
 
-        # Specify the DOM handling when only a part of the document is converted.
+        # Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.
         #
         # * +mode+ - Allowed values are cut-out, remove-siblings, hide-siblings.
         # * *Returns* - The converter object.
@@ -2827,6 +2872,82 @@ module Pdfcrowd
             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.
+        # * *Returns* - The converter object.
+        def setDataString(data_string)
+            @fields['data_string'] = data_string
+            self
+        end
+
+        # Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.
+        #
+        # * +data_file+ - The file path to a local file containing the input data.
+        # * *Returns* - The converter object.
+        def setDataFile(data_file)
+            @files['data_file'] = data_file
+            self
+        end
+
+        # Specify the input data format.
+        #
+        # * +data_format+ - The data format. Allowed values are auto, json, xml, yaml, csv.
+        # * *Returns* - The converter object.
+        def setDataFormat(data_format)
+            unless /(?i)^(auto|json|xml|yaml|csv)$/.match(data_format)
+                raise Error.new(Pdfcrowd.create_invalid_value_message(data_format, "setDataFormat", "html-to-image", "Allowed values are auto, json, xml, yaml, csv.", "set_data_format"), 470);
+            end
+            
+            @fields['data_format'] = data_format
+            self
+        end
+
+        # Set the encoding of the data file set by setDataFile.
+        #
+        # * +encoding+ - The data file encoding.
+        # * *Returns* - The converter object.
+        def setDataEncoding(encoding)
+            @fields['data_encoding'] = encoding
+            self
+        end
+
+        # Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {% if variable is defined %} to check if the variable is defined.
+        #
+        # * +value+ - Set to true to ignore undefined variables.
+        # * *Returns* - The converter object.
+        def setDataIgnoreUndefined(value)
+            @fields['data_ignore_undefined'] = value
+            self
+        end
+
+        # Auto escape HTML symbols in the input data before placing them into the output.
+        #
+        # * +value+ - Set to true to turn auto escaping on.
+        # * *Returns* - The converter object.
+        def setDataAutoEscape(value)
+            @fields['data_auto_escape'] = value
+            self
+        end
+
+        # Auto trim whitespace around each template command block.
+        #
+        # * +value+ - Set to true to turn auto trimming on.
+        # * *Returns* - The converter object.
+        def setDataTrimBlocks(value)
+            @fields['data_trim_blocks'] = value
+            self
+        end
+
+        # Set the advanced data options:csv_delimiter - The CSV data delimiter, the default is ,.xml_remove_root - Remove the root XML element from the input data.data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data.
+        #
+        # * +options+ - Comma separated list of options.
+        # * *Returns* - The converter object.
+        def setDataOptions(options)
+            @fields['data_options'] = options
+            self
+        end
+
         # Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.
         #
         # * +value+ - Set to true to enable the debug logging.
@@ -3134,6 +3255,44 @@ module Pdfcrowd
             end
         end
 
+        # Convert the contents of an input stream.
+        #
+        # * +in_stream+ - The input stream with source data.
+        # * *Returns* - Byte array containing the conversion output.
+        def convertStream(in_stream)
+            @raw_data['stream'] = in_stream.read
+            @helper.post(@fields, @files, @raw_data)
+        end
+
+        # Convert the contents of an input stream and write the result to an output stream.
+        #
+        # * +in_stream+ - The input stream with source data.
+        # * +out_stream+ - The output stream that will contain the conversion output.
+        def convertStreamToStream(in_stream, out_stream)
+            @raw_data['stream'] = in_stream.read
+            @helper.post(@fields, @files, @raw_data, out_stream)
+        end
+
+        # Convert the contents of an input stream and write the result to a local file.
+        #
+        # * +in_stream+ - The input stream with source data.
+        # * +file_path+ - The output file path. The string must not be empty.
+        def convertStreamToFile(in_stream, file_path)
+            if (!(!file_path.nil? && !file_path.empty?))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "convertStreamToFile::file_path", "image-to-image", "The string must not be empty.", "convert_stream_to_file"), 470);
+            end
+            
+            output_file = open(file_path, "wb")
+            begin
+                convertStreamToStream(in_stream, output_file)
+                output_file.close()
+            rescue Error => why
+                output_file.close()
+                FileUtils.rm(file_path)
+                raise
+            end
+        end
+
         # The format of the output file.
         #
         # * +output_format+ - Allowed values are png, jpg, gif, tiff, bmp, ico, ppm, pgm, pbm, pnm, psb, pct, ras, tga, sgi, sun, webp.
@@ -3554,6 +3713,55 @@ module Pdfcrowd
             self
         end
 
+        # Set the title of the PDF.
+        #
+        # * +title+ - The title.
+        # * *Returns* - The converter object.
+        def setTitle(title)
+            @fields['title'] = title
+            self
+        end
+
+        # Set the subject of the PDF.
+        #
+        # * +subject+ - The subject.
+        # * *Returns* - The converter object.
+        def setSubject(subject)
+            @fields['subject'] = subject
+            self
+        end
+
+        # Set the author of the PDF.
+        #
+        # * +author+ - The author.
+        # * *Returns* - The converter object.
+        def setAuthor(author)
+            @fields['author'] = author
+            self
+        end
+
+        # Associate keywords with the document.
+        #
+        # * +keywords+ - The string with the keywords.
+        # * *Returns* - The converter object.
+        def setKeywords(keywords)
+            @fields['keywords'] = keywords
+            self
+        end
+
+        # Use metadata (title, subject, author and keywords) from the n-th input PDF.
+        #
+        # * +index+ - Set the index of the input PDF file from which to use the metadata. 0 means no metadata. Must be a positive integer number or 0.
+        # * *Returns* - The converter object.
+        def setUseMetadataFrom(index)
+            if (!(Integer(index) >= 0))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(index, "setUseMetadataFrom", "pdf-to-pdf", "Must be a positive integer number or 0.", "set_use_metadata_from"), 470);
+            end
+            
+            @fields['use_metadata_from'] = index
+            self
+        end
+
         # Specify the page layout to be used when the document is opened.
         #
         # * +layout+ - Allowed values are single-page, one-column, two-column-left, two-column-right.
@@ -3947,6 +4155,44 @@ module Pdfcrowd
             end
         end
 
+        # Convert the contents of an input stream.
+        #
+        # * +in_stream+ - The input stream with source data.
+        # * *Returns* - Byte array containing the conversion output.
+        def convertStream(in_stream)
+            @raw_data['stream'] = in_stream.read
+            @helper.post(@fields, @files, @raw_data)
+        end
+
+        # Convert the contents of an input stream and write the result to an output stream.
+        #
+        # * +in_stream+ - The input stream with source data.
+        # * +out_stream+ - The output stream that will contain the conversion output.
+        def convertStreamToStream(in_stream, out_stream)
+            @raw_data['stream'] = in_stream.read
+            @helper.post(@fields, @files, @raw_data, out_stream)
+        end
+
+        # Convert the contents of an input stream and write the result to a local file.
+        #
+        # * +in_stream+ - The input stream with source data.
+        # * +file_path+ - The output file path. The string must not be empty.
+        def convertStreamToFile(in_stream, file_path)
+            if (!(!file_path.nil? && !file_path.empty?))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(file_path, "convertStreamToFile::file_path", "image-to-pdf", "The string must not be empty.", "convert_stream_to_file"), 470);
+            end
+            
+            output_file = open(file_path, "wb")
+            begin
+                convertStreamToStream(in_stream, output_file)
+                output_file.close()
+            rescue Error => why
+                output_file.close()
+                FileUtils.rm(file_path)
+                raise
+            end
+        end
+
         # Resize the image.
         #
         # * +resize+ - The resize percentage or new image dimensions.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfcrowd
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.2
 platform: ruby
 authors:
 - Pdfcrowd Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies: []
 description: The Pdfcrowd API lets you easily convert between HTML, PDF and various
   image formats.
@@ -37,7 +37,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A client for the Pdfcrowd API.