pdfcrowd 4.11.0 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0d1b16199c6019f63d1edc09ac55dfb3abe4e8d
-  data.tar.gz: acbcfeb78be46f671a6d59d384f476e390298559
+  metadata.gz: 831ab1316f51b02fcaac6c0f530631784c3ecc6c
+  data.tar.gz: 3f2fb384a6abc373d1a9421b461bd7b4c573a38c
 SHA512:
-  metadata.gz: 0d30398b8bc2bc11e99a93b5a64d35b2f21d48d6712754a98efcf749c3b8cf893fb4ea97f78a5939401d4109c58fa88c5e43cef6e819fb60c3e968d890547e80
-  data.tar.gz: 68a7c0410c0a90482bc7746ddaebc9c583b5f5eb106840d8cfefdc8fa0376221d63d2f13c9a36eeedf3f4d0c83f9bca1b9de5b5b1886345e657bdb03a5dcbd19
+  metadata.gz: fd7873f02b1bf65df5430b0b457f13139399a79001e34e3fbc07700e2e0b48dd6d099c46c2a1bd8c31cbd134d60193c555dfa7ba690348593d7bd3747bf6b238
+  data.tar.gz: 648468cfeab19ee85e491d7cd32d30f1e64c05f4bd816a3e39e38a3c2383eda0df700e53463fc36ff1df7b34e322018da605fc6168349761e1d1a3dabb768206

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 = '4.11.0'
+    CLIENT_VERSION = '4.12.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/4.11.0 (http://pdfcrowd.com)')
+            setUserAgent('pdfcrowd_ruby_client/4.12.0 (http://pdfcrowd.com)')
 
             @retry_count = 1
         end
@@ -724,7 +724,7 @@ module Pdfcrowd
     end
 
     def self.create_invalid_value_message(value, field, converter, hint, id)
-        message = "Invalid value '%s' for a field '%s'." % [value, field]
+        message = "Invalid value '%s' for the field '%s'." % [value, field]
         message += " " + hint if hint
         return message + " " + "Details: https://www.pdfcrowd.com/doc/api/%s/ruby/#%s" % [converter, id]
     end
@@ -1105,11 +1105,11 @@ module Pdfcrowd
 
         # Set the page range to print.
         #
-        # * +pages+ - A comma seperated list of page numbers or ranges.
+        # * +pages+ - A comma separated list of page numbers or ranges.
         # * *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, "pages", "html-to-pdf", "A comma seperated list of page numbers or ranges.", "set_print_page_range"), 470);
+                raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "pages", "html-to-pdf", "A comma separated list of page numbers or ranges.", "set_print_page_range"), 470);
             end
             
             @fields['print_page_range'] = pages
@@ -1118,11 +1118,11 @@ module Pdfcrowd
 
         # 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 seperated list of page numbers.
+        # * +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, "pages", "html-to-pdf", "A comma seperated list of page numbers.", "set_exclude_header_on_pages"), 470);
+                raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "pages", "html-to-pdf", "A comma separated list of page numbers.", "set_exclude_header_on_pages"), 470);
             end
             
             @fields['exclude_header_on_pages'] = pages
@@ -1131,11 +1131,11 @@ module Pdfcrowd
 
         # 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 seperated list of page numbers.
+        # * +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, "pages", "html-to-pdf", "A comma seperated list of page numbers.", "set_exclude_footer_on_pages"), 470);
+                raise Error.new(Pdfcrowd.create_invalid_value_message(pages, "pages", "html-to-pdf", "A comma separated list of page numbers.", "set_exclude_footer_on_pages"), 470);
             end
             
             @fields['exclude_footer_on_pages'] = pages
@@ -1218,6 +1218,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, "data_format", "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.
+        #
+        # * +data_encoding+ - The data file encoding.
+        # * *Returns* - The converter object.
+        def setDataEncoding(data_encoding)
+            @fields['data_encoding'] = data_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.
+        #
+        # * +data_ignore_undefined+ - Set to true to ignore undefined variables.
+        # * *Returns* - The converter object.
+        def setDataIgnoreUndefined(data_ignore_undefined)
+            @fields['data_ignore_undefined'] = data_ignore_undefined
+            self
+        end
+
+        # Auto escape HTML symbols in the input data before placing them into the output.
+        #
+        # * +data_auto_escape+ - Set to true to turn auto escaping on.
+        # * *Returns* - The converter object.
+        def setDataAutoEscape(data_auto_escape)
+            @fields['data_auto_escape'] = data_auto_escape
+            self
+        end
+
+        # Auto trim whitespace around each template command block.
+        #
+        # * +data_trim_blocks+ - Set to true to turn auto trimming on.
+        # * *Returns* - The converter object.
+        def setDataTrimBlocks(data_trim_blocks)
+            @fields['data_trim_blocks'] = data_trim_blocks
+            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.
+        #
+        # * +data_options+ - Comma separated list of options.
+        # * *Returns* - The converter object.
+        def setDataOptions(data_options)
+            @fields['data_options'] = data_options
+            self
+        end
+
         # Apply the first page of the watermark PDF to every page of the output PDF.
         #
         # * +page_watermark+ - The file path to a local watermark PDF file. The file must exist and not be empty.
@@ -1511,7 +1587,7 @@ module Pdfcrowd
             self
         end
 
-        # Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. The maximum value is determined by your API license.
+        # Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your API license defines the maximum wait time by "Max Delay" parameter.
         #
         # * +javascript_delay+ - The number of milliseconds to wait. Must be a positive integer number or 0.
         # * *Returns* - The converter object.
@@ -1745,7 +1821,7 @@ module Pdfcrowd
             self
         end
 
-        # Disallow modification of the ouput PDF.
+        # Disallow modification of the output PDF.
         #
         # * +no_modify+ - Set to true to set the read-only only flag in the output PDF.
         # * *Returns* - The converter object.
@@ -2033,6 +2109,7 @@ module Pdfcrowd
         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.
         #
         # * +use_http+ - Set to true to use HTTP.
         # * *Returns* - The converter object.
@@ -2241,6 +2318,82 @@ module Pdfcrowd
             end
         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, "data_format", "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.
+        #
+        # * +data_encoding+ - The data file encoding.
+        # * *Returns* - The converter object.
+        def setDataEncoding(data_encoding)
+            @fields['data_encoding'] = data_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.
+        #
+        # * +data_ignore_undefined+ - Set to true to ignore undefined variables.
+        # * *Returns* - The converter object.
+        def setDataIgnoreUndefined(data_ignore_undefined)
+            @fields['data_ignore_undefined'] = data_ignore_undefined
+            self
+        end
+
+        # Auto escape HTML symbols in the input data before placing them into the output.
+        #
+        # * +data_auto_escape+ - Set to true to turn auto escaping on.
+        # * *Returns* - The converter object.
+        def setDataAutoEscape(data_auto_escape)
+            @fields['data_auto_escape'] = data_auto_escape
+            self
+        end
+
+        # Auto trim whitespace around each template command block.
+        #
+        # * +data_trim_blocks+ - Set to true to turn auto trimming on.
+        # * *Returns* - The converter object.
+        def setDataTrimBlocks(data_trim_blocks)
+            @fields['data_trim_blocks'] = data_trim_blocks
+            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.
+        #
+        # * +data_options+ - Comma separated list of options.
+        # * *Returns* - The converter object.
+        def setDataOptions(data_options)
+            @fields['data_options'] = data_options
+            self
+        end
+
         # Do not print the background graphics.
         #
         # * +no_background+ - Set to true to disable the background graphics.
@@ -2417,7 +2570,7 @@ module Pdfcrowd
             self
         end
 
-        # Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. The maximum value is determined by your API license.
+        # Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your API license defines the maximum wait time by "Max Delay" parameter.
         #
         # * +javascript_delay+ - The number of milliseconds to wait. Must be a positive integer number or 0.
         # * *Returns* - The converter object.
@@ -2608,6 +2761,7 @@ module Pdfcrowd
         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.
         #
         # * +use_http+ - Set to true to use HTTP.
         # * *Returns* - The converter object.
@@ -2904,6 +3058,7 @@ module Pdfcrowd
         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.
         #
         # * +use_http+ - Set to true to use HTTP.
         # * *Returns* - The converter object.
@@ -3177,7 +3332,7 @@ module Pdfcrowd
             self
         end
 
-        # Disallow modification of the ouput PDF.
+        # Disallow modification of the output PDF.
         #
         # * +no_modify+ - Set to true to set the read-only only flag in the output PDF.
         # * *Returns* - The converter object.
@@ -3381,6 +3536,7 @@ module Pdfcrowd
         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.
         #
         # * +use_http+ - Set to true to use HTTP.
         # * *Returns* - The converter object.
@@ -3664,6 +3820,7 @@ module Pdfcrowd
         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.
         #
         # * +use_http+ - Set to true to use HTTP.
         # * *Returns* - The converter object.

metadata

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