grabzit 3.5.4 → 3.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a8a19888be59015aa66b1794e2bd0ccf7c395272c98e65b7156b4d921b7f8c6
-  data.tar.gz: 57d2ac4496d215398896a0e30162c71885e8b29e955a5fedfa9f279484367b24
+  metadata.gz: df792693d263dcc1b31d91efdf5f9f525ee841606d2eccd42ad22b6ba164b8bf
+  data.tar.gz: 3444e66ad75242f483cb70a432f8598a6cff04fa00171922942c22d9bc4f9282
 SHA512:
-  metadata.gz: bf4947d9f5b5055806281a167944ab1d83ef3b9d14bb32204393f6d47a9a70cab5e5e88785c871eeaf31657ae59d7c4a50693ac41eef1d78a3d55640cbd31981
-  data.tar.gz: 6d735f28a68c328d3187ca76638660380777399e3bc4a4536adc850536e5bcd29e4a9174978bebbb946da5c936fae3d5816e00821eb91530a82ff19e03d1c668
+  metadata.gz: c68b013f321fdf1b0450bc16e0d87f12a49b487a3d84bf98963cc18649b9fa8eaf60d8890ac261d03fe7a75d62296a41cf57d4d8311145d31ddd2f7c3943d795
+  data.tar.gz: 61c79394dcb208bcc1ee540c8b48a0f2115e6b99ae65d308d8d89ba51b8c5255fc0e6854fa77e3516029049b1c2aba6fcc851584b06e411579d0f7fd8c347a61

data/lib/grabzit/docxoptions.rb

@@ -33,6 +33,7 @@ module GrabzIt
 			@address = nil
 			@password = nil
 			@clickElement = nil
+			@jsCode = nil
 		end
 		
 		# @return [Boolean] true if the background images of the web page should be included in the DOCX
@@ -392,6 +393,19 @@ module GrabzIt
 		def add_template_parameter(name, value)
 			@templateVariables = appendParameter(@templateVariables, name, value)
 		end
+
+		# @return [String] get the JavaScript code that will be execute in the web page before the capture is performed
+		def jsCode
+			@jsCode
+		end
+		
+		# Set the JavaScript code that will be execute in the web page before the capture is performed
+		#
+		# @param value [String] the javascript to execute
+		# @return [void]		
+		def jsCode=(value)
+			@jsCode = value
+		end	
 		
 		# @!visibility private
 		def _getSignatureString(applicationSecret, callBackURL, url = nil)
@@ -401,7 +415,7 @@ module GrabzIt
 				items.push(GrabzIt::Utility.nil_check(url))
 			end
 			
-			items.push(GrabzIt::Utility.nil_check(callBackURL),GrabzIt::Utility.nil_check(@customId),GrabzIt::Utility.b_to_str(@includeBackground),@pagesize ,@orientation,GrabzIt::Utility.b_to_str(@includeImages),GrabzIt::Utility.b_to_str(@includeLinks),GrabzIt::Utility.nil_check(@title),GrabzIt::Utility.nil_int_check(@marginTop),GrabzIt::Utility.nil_int_check(@marginLeft),GrabzIt::Utility.nil_int_check(@marginBottom),GrabzIt::Utility.nil_int_check(@marginRight),GrabzIt::Utility.nil_int_check(@delay),GrabzIt::Utility.nil_int_check(@requestAs),GrabzIt::Utility.nil_check(@country),GrabzIt::Utility.nil_int_check(@quality),GrabzIt::Utility.nil_check(@hideElement),GrabzIt::Utility.nil_check(@exportURL),GrabzIt::Utility.nil_check(@waitForElement),GrabzIt::Utility.nil_check(@encryptionKey),GrabzIt::Utility.b_to_str(@noAds),GrabzIt::Utility.nil_check(@post),GrabzIt::Utility.nil_check(@targetElement),GrabzIt::Utility.nil_check(@templateId),GrabzIt::Utility.nil_check(@templateVariables),GrabzIt::Utility.nil_int_check(@height),GrabzIt::Utility.nil_int_check(@width),GrabzIt::Utility.nil_int_check(@browserWidth),GrabzIt::Utility.nil_check(@proxy),GrabzIt::Utility.nil_check(@mergeId),GrabzIt::Utility.nil_check(@address),GrabzIt::Utility.b_to_str(@noCookieNotifications),GrabzIt::Utility.nil_check(@password),GrabzIt::Utility.nil_check(@clickElement))
+			items.push(GrabzIt::Utility.nil_check(callBackURL),GrabzIt::Utility.nil_check(@customId),GrabzIt::Utility.b_to_str(@includeBackground),@pagesize ,@orientation,GrabzIt::Utility.b_to_str(@includeImages),GrabzIt::Utility.b_to_str(@includeLinks),GrabzIt::Utility.nil_check(@title),GrabzIt::Utility.nil_int_check(@marginTop),GrabzIt::Utility.nil_int_check(@marginLeft),GrabzIt::Utility.nil_int_check(@marginBottom),GrabzIt::Utility.nil_int_check(@marginRight),GrabzIt::Utility.nil_int_check(@delay),GrabzIt::Utility.nil_int_check(@requestAs),GrabzIt::Utility.nil_check(@country),GrabzIt::Utility.nil_int_check(@quality),GrabzIt::Utility.nil_check(@hideElement),GrabzIt::Utility.nil_check(@exportURL),GrabzIt::Utility.nil_check(@waitForElement),GrabzIt::Utility.nil_check(@encryptionKey),GrabzIt::Utility.b_to_str(@noAds),GrabzIt::Utility.nil_check(@post),GrabzIt::Utility.nil_check(@targetElement),GrabzIt::Utility.nil_check(@templateId),GrabzIt::Utility.nil_check(@templateVariables),GrabzIt::Utility.nil_int_check(@height),GrabzIt::Utility.nil_int_check(@width),GrabzIt::Utility.nil_int_check(@browserWidth),GrabzIt::Utility.nil_check(@proxy),GrabzIt::Utility.nil_check(@mergeId),GrabzIt::Utility.nil_check(@address),GrabzIt::Utility.b_to_str(@noCookieNotifications),GrabzIt::Utility.nil_check(@password),GrabzIt::Utility.nil_check(@clickElement),GrabzIt::Utility.nil_check(@jsCode))
 			return items.join("|")
 		end
 		
@@ -436,6 +450,7 @@ module GrabzIt
 			params['nonotify'] = GrabzIt::Utility.b_to_str(@noCookieNotifications)
 			params['password'] = GrabzIt::Utility.nil_check(@password)
 			params['click'] = GrabzIt::Utility.nil_check(@clickElement)
+			params['jscode'] = GrabzIt::Utility.nil_check(@jsCode)
 			
 			return params;
 		end		

data/lib/grabzit/htmloptions.rb

@@ -14,6 +14,8 @@ module GrabzIt
 			@noAds = false
 			@noCookieNotifications = false
 			@address = nil
+			@clickElement = nil
+			@jsCode = nil
 		end
 		
 		# @return [Integer] the width of the browser in pixels
@@ -67,6 +69,19 @@ module GrabzIt
 		def waitForElement=(value)
 			@waitForElement = value
 		end		
+
+		# @return [String] get the CSS selector of the HTML element in the web page that must clicked before the capture is performed
+		def clickElement
+			@clickElement
+		end
+		
+		# Set the CSS selector of the HTML element in the web page that must clicked before the capture is performed
+		#
+		# @param value [String] the element to click
+		# @return [void]		
+		def clickElement=(value)
+			@clickElement = value
+		end		
 		
 		# @return [Integer] get which user agent type should be used
 		def requestAs
@@ -119,6 +134,19 @@ module GrabzIt
 		def address=(value)
 			@address = value
 		end		
+
+		# @return [String] get the JavaScript code that will be execute in the web page before the capture is performed
+		def jsCode
+			@jsCode
+		end
+		
+		# Set the JavaScript code that will be execute in the web page before the capture is performed
+		#
+		# @param value [String] the javascript to execute
+		# @return [void]		
+		def jsCode=(value)
+			@jsCode = value
+		end		
 		
 		# Define a HTTP Post parameter and optionally value, this method can be called multiple times to add multiple parameters. Using this method will force 
 		# GrabzIt to perform a HTTP post.
@@ -137,7 +165,7 @@ module GrabzIt
 				items.push(GrabzIt::Utility.nil_check(url))
 			end
 			
-			items.push(GrabzIt::Utility.nil_check(callBackURL),GrabzIt::Utility.nil_int_check(@browserHeight),GrabzIt::Utility.nil_int_check(@browserWidth),GrabzIt::Utility.nil_check(@customId),GrabzIt::Utility.nil_int_check(@delay),GrabzIt::Utility.nil_int_check(@requestAs),GrabzIt::Utility.nil_check(@country),GrabzIt::Utility.nil_check(@exportURL),GrabzIt::Utility.nil_check(@waitForElement),GrabzIt::Utility.nil_check(@encryptionKey),GrabzIt::Utility.b_to_str(@noAds),GrabzIt::Utility.nil_check(@post),GrabzIt::Utility.nil_check(@proxy),GrabzIt::Utility.nil_check(@address),GrabzIt::Utility.b_to_str(@noCookieNotifications))
+			items.push(GrabzIt::Utility.nil_check(callBackURL),GrabzIt::Utility.nil_int_check(@browserHeight),GrabzIt::Utility.nil_int_check(@browserWidth),GrabzIt::Utility.nil_check(@customId),GrabzIt::Utility.nil_int_check(@delay),GrabzIt::Utility.nil_int_check(@requestAs),GrabzIt::Utility.nil_check(@country),GrabzIt::Utility.nil_check(@exportURL),GrabzIt::Utility.nil_check(@waitForElement),GrabzIt::Utility.nil_check(@encryptionKey),GrabzIt::Utility.b_to_str(@noAds),GrabzIt::Utility.nil_check(@post),GrabzIt::Utility.nil_check(@proxy),GrabzIt::Utility.nil_check(@address),GrabzIt::Utility.b_to_str(@noCookieNotifications),GrabzIt::Utility.nil_check(@clickElement),GrabzIt::Utility.nil_check(@jsCode))
 			
 			return items.join("|")
 		end
@@ -154,6 +182,8 @@ module GrabzIt
 			params['post'] = GrabzIt::Utility.nil_check(@post)
 			params['address'] = GrabzIt::Utility.nil_check(@address)
 			params['nonotify'] = GrabzIt::Utility.b_to_str(@noCookieNotifications)
+			params['click'] = GrabzIt::Utility.nil_check(@clickElement)
+			params['jscode'] = GrabzIt::Utility.nil_check(@jsCode)
 			
 			return params
 		end

data/lib/grabzit/imageoptions.rb

@@ -24,6 +24,7 @@ module GrabzIt
 			@address = nil
 			@hd = false
 			@clickElement = nil
+			@jsCode = nil
 		end
 		
 		# @return [Integer] the width of the browser in pixels
@@ -259,6 +260,19 @@ module GrabzIt
 		def address=(value)
 			@address = value
 		end		
+
+		# @return [String] get the JavaScript code that will be execute in the web page before the capture is performed
+		def jsCode
+			@jsCode
+		end
+		
+		# Set the JavaScript code that will be execute in the web page before the capture is performed
+		#
+		# @param value [String] the javascript to execute
+		# @return [void]		
+		def jsCode=(value)
+			@jsCode = value
+		end	
 		
 		# Define a HTTP Post parameter and optionally value, this method can be called multiple times to add multiple parameters. Using this method will force 
 		# GrabzIt to perform a HTTP post.
@@ -277,7 +291,7 @@ module GrabzIt
 				items.push(GrabzIt::Utility.nil_check(url))
 			end
 			
-			items.push(GrabzIt::Utility.nil_check(callBackURL),GrabzIt::Utility.nil_check(@format),GrabzIt::Utility.nil_int_check(@height),GrabzIt::Utility.nil_int_check(@width),GrabzIt::Utility.nil_int_check(@browserHeight),GrabzIt::Utility.nil_int_check(@browserWidth),GrabzIt::Utility.nil_check(@customId),GrabzIt::Utility.nil_int_check(@delay),GrabzIt::Utility.nil_check(@targetElement),GrabzIt::Utility.nil_check(@customWaterMarkId),GrabzIt::Utility.nil_int_check(@requestAs),GrabzIt::Utility.nil_check(@country),GrabzIt::Utility.nil_int_check(@quality),GrabzIt::Utility.nil_check(@hideElement),GrabzIt::Utility.nil_check(@exportURL),GrabzIt::Utility.nil_check(@waitForElement),GrabzIt::Utility.b_to_str(@transparent),GrabzIt::Utility.nil_check(@encryptionKey),GrabzIt::Utility.b_to_str(@noAds),GrabzIt::Utility.nil_check(@post),GrabzIt::Utility.nil_check(@proxy),GrabzIt::Utility.nil_check(@address),GrabzIt::Utility.b_to_str(@noCookieNotifications),GrabzIt::Utility.b_to_str(@hd),GrabzIt::Utility.nil_check(@clickElement))
+			items.push(GrabzIt::Utility.nil_check(callBackURL),GrabzIt::Utility.nil_check(@format),GrabzIt::Utility.nil_int_check(@height),GrabzIt::Utility.nil_int_check(@width),GrabzIt::Utility.nil_int_check(@browserHeight),GrabzIt::Utility.nil_int_check(@browserWidth),GrabzIt::Utility.nil_check(@customId),GrabzIt::Utility.nil_int_check(@delay),GrabzIt::Utility.nil_check(@targetElement),GrabzIt::Utility.nil_check(@customWaterMarkId),GrabzIt::Utility.nil_int_check(@requestAs),GrabzIt::Utility.nil_check(@country),GrabzIt::Utility.nil_int_check(@quality),GrabzIt::Utility.nil_check(@hideElement),GrabzIt::Utility.nil_check(@exportURL),GrabzIt::Utility.nil_check(@waitForElement),GrabzIt::Utility.b_to_str(@transparent),GrabzIt::Utility.nil_check(@encryptionKey),GrabzIt::Utility.b_to_str(@noAds),GrabzIt::Utility.nil_check(@post),GrabzIt::Utility.nil_check(@proxy),GrabzIt::Utility.nil_check(@address),GrabzIt::Utility.b_to_str(@noCookieNotifications),GrabzIt::Utility.b_to_str(@hd),GrabzIt::Utility.nil_check(@clickElement),GrabzIt::Utility.nil_check(@jsCode))
 			
 			return items.join("|")
 		end
@@ -304,6 +318,7 @@ module GrabzIt
 			params['nonotify'] = GrabzIt::Utility.b_to_str(@noCookieNotifications)
 			params['hd'] = GrabzIt::Utility.b_to_str(@hd)
 			params['click'] = GrabzIt::Utility.nil_check(@clickElement)
+			params['jscode'] = GrabzIt::Utility.nil_check(@jsCode)
 			
 			return params
 		end

data/lib/grabzit/pdfoptions.rb

@@ -36,6 +36,7 @@ module GrabzIt
 			@cssMediaType = nil
 			@password = nil
 			@clickElement = nil
+			@jsCode = nil
 		end
 		
 		# @return [Boolean] true if the background of the web page should be included in the PDF
@@ -417,6 +418,19 @@ module GrabzIt
 		def password=(value)
 			@password = value
 		end
+
+		# @return [String] get the JavaScript code that will be execute in the web page before the capture is performed
+		def jsCode
+			@jsCode
+		end
+		
+		# Set the JavaScript code that will be execute in the web page before the capture is performed
+		#
+		# @param value [String] the javascript to execute
+		# @return [void]		
+		def jsCode=(value)
+			@jsCode = value
+		end		
 		
 		# Define a HTTP Post parameter and optionally value, this method can be called multiple times to add multiple parameters. Using this method will force 
 		# GrabzIt to perform a HTTP post.
@@ -443,7 +457,7 @@ module GrabzIt
 				items.push(GrabzIt::Utility.nil_check(url))
 			end
 			
-			items.push(GrabzIt::Utility.nil_check(callBackURL),GrabzIt::Utility.nil_check(@customId),GrabzIt::Utility.b_to_str(@includeBackground),@pagesize ,@orientation,GrabzIt::Utility.nil_check(@customWaterMarkId),GrabzIt::Utility.b_to_str(@includeLinks),GrabzIt::Utility.b_to_str(@includeOutline),GrabzIt::Utility.nil_check(@title),GrabzIt::Utility.nil_check(@coverURL),GrabzIt::Utility.nil_int_check(@marginTop),GrabzIt::Utility.nil_int_check(@marginLeft),GrabzIt::Utility.nil_int_check(@marginBottom),GrabzIt::Utility.nil_int_check(@marginRight),GrabzIt::Utility.nil_int_check(@delay),GrabzIt::Utility.nil_int_check(@requestAs),GrabzIt::Utility.nil_check(@country),GrabzIt::Utility.nil_int_check(@quality),GrabzIt::Utility.nil_check(@templateId),GrabzIt::Utility.nil_check(@hideElement),GrabzIt::Utility.nil_check(@targetElement),GrabzIt::Utility.nil_check(@exportURL),GrabzIt::Utility.nil_check(@waitForElement),GrabzIt::Utility.nil_check(@encryptionKey),GrabzIt::Utility.b_to_str(@noAds),GrabzIt::Utility.nil_check(@post),GrabzIt::Utility.nil_int_check(@browserWidth),GrabzIt::Utility.nil_int_check(@height),GrabzIt::Utility.nil_int_check(@width),GrabzIt::Utility.nil_check(@templateVariables),GrabzIt::Utility.nil_check(@proxy),GrabzIt::Utility.nil_check(@mergeId),GrabzIt::Utility.nil_check(@address),GrabzIt::Utility.b_to_str(@noCookieNotifications),GrabzIt::Utility.nil_check(@cssMediaType),GrabzIt::Utility.nil_check(@password),GrabzIt::Utility.nil_check(@clickElement))
+			items.push(GrabzIt::Utility.nil_check(callBackURL),GrabzIt::Utility.nil_check(@customId),GrabzIt::Utility.b_to_str(@includeBackground),@pagesize ,@orientation,GrabzIt::Utility.nil_check(@customWaterMarkId),GrabzIt::Utility.b_to_str(@includeLinks),GrabzIt::Utility.b_to_str(@includeOutline),GrabzIt::Utility.nil_check(@title),GrabzIt::Utility.nil_check(@coverURL),GrabzIt::Utility.nil_int_check(@marginTop),GrabzIt::Utility.nil_int_check(@marginLeft),GrabzIt::Utility.nil_int_check(@marginBottom),GrabzIt::Utility.nil_int_check(@marginRight),GrabzIt::Utility.nil_int_check(@delay),GrabzIt::Utility.nil_int_check(@requestAs),GrabzIt::Utility.nil_check(@country),GrabzIt::Utility.nil_int_check(@quality),GrabzIt::Utility.nil_check(@templateId),GrabzIt::Utility.nil_check(@hideElement),GrabzIt::Utility.nil_check(@targetElement),GrabzIt::Utility.nil_check(@exportURL),GrabzIt::Utility.nil_check(@waitForElement),GrabzIt::Utility.nil_check(@encryptionKey),GrabzIt::Utility.b_to_str(@noAds),GrabzIt::Utility.nil_check(@post),GrabzIt::Utility.nil_int_check(@browserWidth),GrabzIt::Utility.nil_int_check(@height),GrabzIt::Utility.nil_int_check(@width),GrabzIt::Utility.nil_check(@templateVariables),GrabzIt::Utility.nil_check(@proxy),GrabzIt::Utility.nil_check(@mergeId),GrabzIt::Utility.nil_check(@address),GrabzIt::Utility.b_to_str(@noCookieNotifications),GrabzIt::Utility.nil_check(@cssMediaType),GrabzIt::Utility.nil_check(@password),GrabzIt::Utility.nil_check(@clickElement),GrabzIt::Utility.nil_check(@jsCode))
 			
 			return items.join("|")
 		end
@@ -482,7 +496,8 @@ module GrabzIt
 			params['media'] = GrabzIt::Utility.nil_check(@cssMediaType)
 			params['password'] = GrabzIt::Utility.nil_check(@password)
 			params['click'] = GrabzIt::Utility.nil_check(@clickElement)
-
+			params['jscode'] = GrabzIt::Utility.nil_check(@jsCode)
+			
 			return params;
 		end		
 	end

data/lib/grabzit/videooptions.rb

@@ -21,6 +21,7 @@ module GrabzIt
 			@start = 0
 			@duration = 10
 			@framesPerSecond = 0
+			@jsCode = nil
 		end
 		
 		# @return [Integer] the width of the browser in pixels
@@ -204,6 +205,19 @@ module GrabzIt
 		def framesPerSecond=(value)
 			@framesPerSecond = value
 		end			
+
+		# @return [String] get the JavaScript code that will be execute in the web page before the capture is performed
+		def jsCode
+			@jsCode
+		end
+		
+		# Set the JavaScript code that will be execute in the web page before the capture is performed
+		#
+		# @param value [String] the javascript to execute
+		# @return [void]		
+		def jsCode=(value)
+			@jsCode = value
+		end		
 		
 		# Define a HTTP Post parameter and optionally value, this method can be called multiple times to add multiple parameters. Using this method will force 
 		# GrabzIt to perform a HTTP post.
@@ -242,7 +256,8 @@ module GrabzIt
 			GrabzIt::Utility.nil_float_check(@framesPerSecond),
 			GrabzIt::Utility.nil_int_check(@duration),
 			GrabzIt::Utility.nil_int_check(@width),
-			GrabzIt::Utility.nil_int_check(@height))
+			GrabzIt::Utility.nil_int_check(@height),
+			GrabzIt::Utility.nil_check(@jsCode))
 			
 			return items.join("|")
 		end
@@ -265,7 +280,8 @@ module GrabzIt
 			params['duration'] = GrabzIt::Utility.nil_int_check(@duration)
 			params['width'] = GrabzIt::Utility.nil_int_check(@width)
 			params['height'] = GrabzIt::Utility.nil_int_check(@height)			
-
+			params['jscode'] = GrabzIt::Utility.nil_check(@jsCode)
+			
 			return params
 		end
 	end

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: grabzit
 version: !ruby/object:Gem::Version
-  version: 3.5.4
+  version: 3.5.5
 platform: ruby
 authors:
 - GrabzIt
-autorequire:
 bindir: bin
 cert_chain: []
 date: 2024-02-07 00:00:00.000000000 Z
@@ -58,7 +57,6 @@ homepage: https://grabz.it/api/ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -73,8 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: GrabzIt Ruby Client
 test_files: []