pdfcrowd 4.4.2 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df0f634e6fd4179d59c27374bca727145e33d834
-  data.tar.gz: 7835a6b9caa209ee4d2c9d29e2ed498dbb592906
+  metadata.gz: 831c75863b744daaf04e10c823d0f2372f8d1449
+  data.tar.gz: e073a4c1a3fe5781071de35d74cff853e58e2dca
 SHA512:
-  metadata.gz: 106fcf8b64482a784f7655ece03bb3f8ffbb2b986e34491620b2ac188b7d8e8a66ebf5dc3e632cbbc623981a809f5d50704a1a009f7b3d581e147651cec60a42
-  data.tar.gz: 5ddf56c46fc7258e5283e9d24444b0b0d723e588b972cb4f0f4a3fbc78710e7f18081161ecb0d63f81a35f21f80b9af78dc4334802498529ca689eb9bf3d7748
+  metadata.gz: f2b8be81e58098579b3afd6a88d50f3dffe7fe71b2ef430fc097cc9c449ca8cc39a36bb4cc636caf40e334c82d7d29af37a04374d5805d5f51a42d5515d9e56a
+  data.tar.gz: e92afe264b5c4e7ca09faca17704d51875c5795347e0a71030eb1cb97ed91751ffe152112fbc54e9242b418e204e56bdc2708b15c91f58aeb4334955f73e8288

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.4.2'
+    CLIENT_VERSION = '4.5.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.4.2 (http://pdfcrowd.com)')
+            setUserAgent('pdfcrowd_ruby_client/4.5.0 (http://pdfcrowd.com)')
 
             @retry_count = 1
         end
@@ -1360,9 +1360,9 @@ module Pdfcrowd
             self
         end
 
-        # Run a custom JavaScript after the document is loaded. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...).
+        # Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...). The custom JavaScript can use helper functions from our JavaScript library.
         #
-        # * +custom_javascript+ - String containing a JavaScript code. The string must not be empty.
+        # * +custom_javascript+ - A string containing a JavaScript code. The string must not be empty.
         # * *Returns* - The converter object.
         def setCustomJavascript(custom_javascript)
             if (!(!custom_javascript.nil? && !custom_javascript.empty?))
@@ -1373,6 +1373,19 @@ module Pdfcrowd
             self
         end
 
+        # Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation. The custom JavaScript can use helper functions from our JavaScript library.
+        #
+        # * +on_load_javascript+ - A string containing a JavaScript code. The string must not be empty.
+        # * *Returns* - The converter object.
+        def setOnLoadJavascript(on_load_javascript)
+            if (!(!on_load_javascript.nil? && !on_load_javascript.empty?))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(on_load_javascript, "on_load_javascript", "html-to-pdf", "The string must not be empty.", "set_on_load_javascript"), 470);
+            end
+            
+            @fields['on_load_javascript'] = on_load_javascript
+            self
+        end
+
         # Set a custom HTTP header that is sent in Pdfcrowd HTTP requests.
         #
         # * +custom_http_header+ - A string containing the header name and value separated by a colon.
@@ -1523,7 +1536,7 @@ module Pdfcrowd
             self
         end
 
-        # Set the quality of embedded JPEG images. Lower quality results in smaller PDF file. Lower quality affects printing or zooming in a PDF viewer.
+        # Set the quality of embedded JPEG images. A lower quality results in a smaller PDF file but can lead to compression artifacts.
         #
         # * +jpeg_quality+ - The percentage value. The value must be in the range 1-100.
         # * *Returns* - The converter object.
@@ -1536,7 +1549,7 @@ module Pdfcrowd
             self
         end
 
-        # Set image categories to be converted into embedded JPEG images. The conversion into JPEG may result in smaller PDF file.
+        # Specify which image types will be converted to JPEG. Converting lossless compression image formats (PNG, GIF, ...) to JPEG may result in a smaller PDF file.
         #
         # * +convert_images_to_jpeg+ - The image category. Allowed values are none, opaque, all.
         # * *Returns* - The converter object.
@@ -1549,7 +1562,7 @@ module Pdfcrowd
             self
         end
 
-        # Set the DPI when embedded image is scaled down. Lower DPI may result in smaller PDF file. Lower DPI affects printing or zooming in a PDF viewer. Use 0 for no scaling down.
+        # Set the DPI of images in PDF. A lower DPI may result in a smaller PDF file. If the specified DPI is higher than the actual image DPI, the original image DPI is retained (no upscaling is performed). Use 0 to leave the images unaltered.
         #
         # * +image_dpi+ - The DPI value. Must be a positive integer number or 0.
         # * *Returns* - The converter object.
@@ -1805,7 +1818,7 @@ module Pdfcrowd
         end
 
         # Get the number of conversion credits available in your account.
-        # The number is available after calling the conversion. So use the method after convertXYZ method.
+        # This method can only be called after a call to one of the convertXYZ methods.
         # The returned value can differ from the actual count if you run parallel conversions.
         # The special value 999999 is returned if the information is not available.
         # * *Returns* - The number of credits.
@@ -2248,9 +2261,9 @@ module Pdfcrowd
             self
         end
 
-        # Run a custom JavaScript after the document is loaded. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...).
+        # Run a custom JavaScript after the document is loaded and ready to print. The script is intended for post-load DOM manipulation (add/remove elements, update CSS, ...). The custom JavaScript can use helper functions from our JavaScript library.
         #
-        # * +custom_javascript+ - String containing a JavaScript code. The string must not be empty.
+        # * +custom_javascript+ - A string containing a JavaScript code. The string must not be empty.
         # * *Returns* - The converter object.
         def setCustomJavascript(custom_javascript)
             if (!(!custom_javascript.nil? && !custom_javascript.empty?))
@@ -2261,6 +2274,19 @@ module Pdfcrowd
             self
         end
 
+        # Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation. The custom JavaScript can use helper functions from our JavaScript library.
+        #
+        # * +on_load_javascript+ - A string containing a JavaScript code. The string must not be empty.
+        # * *Returns* - The converter object.
+        def setOnLoadJavascript(on_load_javascript)
+            if (!(!on_load_javascript.nil? && !on_load_javascript.empty?))
+                raise Error.new(Pdfcrowd.create_invalid_value_message(on_load_javascript, "on_load_javascript", "html-to-image", "The string must not be empty.", "set_on_load_javascript"), 470);
+            end
+            
+            @fields['on_load_javascript'] = on_load_javascript
+            self
+        end
+
         # Set a custom HTTP header that is sent in Pdfcrowd HTTP requests.
         #
         # * +custom_http_header+ - A string containing the header name and value separated by a colon.
@@ -2368,7 +2394,7 @@ module Pdfcrowd
         end
 
         # Get the number of conversion credits available in your account.
-        # The number is available after calling the conversion. So use the method after convertXYZ method.
+        # This method can only be called after a call to one of the convertXYZ methods.
         # The returned value can differ from the actual count if you run parallel conversions.
         # The special value 999999 is returned if the information is not available.
         # * *Returns* - The number of credits.
@@ -2686,7 +2712,7 @@ module Pdfcrowd
         end
 
         # Get the number of conversion credits available in your account.
-        # The number is available after calling the conversion. So use the method after convertXYZ method.
+        # This method can only be called after a call to one of the convertXYZ methods.
         # The returned value can differ from the actual count if you run parallel conversions.
         # The special value 999999 is returned if the information is not available.
         # * *Returns* - The number of credits.
@@ -2888,7 +2914,7 @@ module Pdfcrowd
         end
 
         # Get the number of conversion credits available in your account.
-        # The number is available after calling the conversion. So use the method after convertXYZ method.
+        # This method can only be called after a call to one of the convertXYZ methods.
         # The returned value can differ from the actual count if you run parallel conversions.
         # The special value 999999 is returned if the information is not available.
         # * *Returns* - The number of credits.
@@ -3151,7 +3177,7 @@ module Pdfcrowd
         end
 
         # Get the number of conversion credits available in your account.
-        # The number is available after calling the conversion. So use the method after convertXYZ method.
+        # This method can only be called after a call to one of the convertXYZ methods.
         # The returned value can differ from the actual count if you run parallel conversions.
         # The special value 999999 is returned if the information is not available.
         # * *Returns* - The number of credits.

metadata

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