grabzit 3.3.4.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e54b7a156348da8b07ac68291a087989bdda1a3d
-  data.tar.gz: add47bd227816eb7fff782c529712d053b74740b
+SHA256:
+  metadata.gz: ee2e4b1cfbe4852f4caef8693d3e615449280c6842de2ec0fb25adadf06bcc96
+  data.tar.gz: edc3e07ea3cb78f48a0fd090fa2520829147ac7503ae78870bdb83a179e86def
 SHA512:
-  metadata.gz: 797fd441594b640c6c85c3dbc63d9b9b271291b1c65351578767d31893063719f50dde9bfa7d59722f86292ab737223844f79744ef02e25ad3a8e58101cfc651
-  data.tar.gz: 942eaa771d1d3445a5a25d11efdd21f46e53c895fe9ff66eaaf350e89915ab53890f0fa9feb050a004e3036bdf259143e42f4bce566ad38dbf66fc54a83e5808
+  metadata.gz: 5ce530ba3115c87a54343cda7c8d35b8e2a51099b0ca9f39e2411a3612b8e08bd6cedd7cfe53e272a71396711ce22d4387f5312565b674f7a4e3f5a905dceef0
+  data.tar.gz: 4d2ab4167a04e2e85dbe69101c5db926e6aff3c45aa2725a6b5127cbc243588000b5619e0ca8d1968511f0a8202e03dd96b9c1df3835d5d097d3df790bdd5221

data/lib/grabzit/client.rb

@@ -16,6 +16,7 @@ module GrabzIt
 	require File.join(File.dirname(__FILE__), 'exception')
 	require File.join(File.dirname(__FILE__), 'animationoptions')
 	require File.join(File.dirname(__FILE__), 'imageoptions')
+	require File.join(File.dirname(__FILE__), 'htmloptions')
 	require File.join(File.dirname(__FILE__), 'tableoptions')
 	require File.join(File.dirname(__FILE__), 'pdfoptions')
 	require File.join(File.dirname(__FILE__), 'docxoptions')
@@ -34,10 +35,8 @@ module GrabzIt
 	# @see http://grabz.it/api/ruby/ GrabzIt Ruby API
 	class Client
 
-		WebServicesBaseURLGet = "://api.grabz.it/services/"
-		private_constant :WebServicesBaseURLGet	
-		WebServicesBaseURLPost = "://grabz.it/services/"
-		private_constant :WebServicesBaseURLPost
+		WebServicesBaseURL = "://api.grabz.it/services/"
+		private_constant :WebServicesBaseURL	
 		TakePicture = "takepicture.ashx"	
 		private_constant :TakePicture
 		TakeTable = "taketable.ashx"
@@ -46,6 +45,8 @@ module GrabzIt
 		private_constant :TakePDF
 		TakeDOCX = "takedocx.ashx"
 		private_constant :TakeDOCX
+		TakeHTML = "takehtml.ashx"
+		private_constant :TakeHTML
 		TrueString = "True"
 		private_constant :TrueString
 		
@@ -72,7 +73,7 @@ module GrabzIt
 				options = AnimationOptions.new()
 			end
 		
-			@request = Request.new(@protocol + WebServicesBaseURLGet + "takeanimation.ashx", false, options, url)
+			@request = Request.new(@protocol + WebServicesBaseURL + "takeanimation.ashx", false, options, url)
 			return nil
 		end
 
@@ -87,7 +88,7 @@ module GrabzIt
 				options = ImageOptions.new()
 			end
 		
-			@request = Request.new(@protocol + WebServicesBaseURLGet + TakePicture, false, options, url)
+			@request = Request.new(@protocol + WebServicesBaseURL + TakePicture, false, options, url)
 			return nil
 		end
 
@@ -102,7 +103,7 @@ module GrabzIt
 				options = ImageOptions.new()
 			end
 		
-			@request = Request.new(@protocol + WebServicesBaseURLPost + TakePicture, true, options, html)
+			@request = Request.new(@protocol + WebServicesBaseURL + TakePicture, true, options, html)
 			return nil
 		end		
 
@@ -114,6 +115,45 @@ module GrabzIt
 		def file_to_image(path, options = nil)		
 			html_to_image(read_file(path), options)
 		end
+
+		# This method specifies the URL that should be converted into rendered HTML
+		#
+		# @param url [String] the URL to capture as rendered HTML
+		# @param options [HTMLOptions, nil] a instance of the HTMLOptions class that defines any special options to use when creating the rendered HTML
+		# @return [void]		
+		def url_to_rendered_html(url, options = nil)		
+
+			if options == nil
+				options = HTMLOptions.new()
+			end
+		
+			@request = Request.new(@protocol + WebServicesBaseURL + TakeHTML, false, options, url)
+			return nil
+		end
+
+		# This method specifies the HTML that should be converted into rendered HTML
+		#
+		# @param html [String] the HTML to convert into rendered HTML
+		# @param options [HTMLOptions, nil] a instance of the HTMLOptions class that defines any special options to use when creating the rendered HTML
+		# @return [void]		
+		def html_to_rendered_html(html, options = nil)		
+
+			if options == nil
+				options = HTMLOptions.new()
+			end
+		
+			@request = Request.new(@protocol + WebServicesBaseURL + TakeHTML, true, options, html)
+			return nil
+		end		
+
+		# This method specifies a HTML file that should be converted into rendered HTML
+		#
+		# @param path [String] the file path of a HTML file to convert into rendered HTML
+		# @param options [HTMLOptions, nil] a instance of the HTMLOptions class that defines any special options to use when creating rendered HTML
+		# @return [void]		
+		def file_to_rendered_html(path, options = nil)		
+			html_to_rendered_html(read_file(path), options)
+		end
 		
 		# This method specifies the URL that the HTML tables should be extracted from
 		#
@@ -126,7 +166,7 @@ module GrabzIt
 				options = TableOptions.new()
 			end
 		
-			@request = Request.new(@protocol + WebServicesBaseURLGet + TakeTable, false, options, url)
+			@request = Request.new(@protocol + WebServicesBaseURL + TakeTable, false, options, url)
 			return nil			
 		end	
 		
@@ -141,7 +181,7 @@ module GrabzIt
 				options = TableOptions.new()
 			end
 		
-			@request = Request.new(@protocol + WebServicesBaseURLPost + TakeTable, true, options, html)
+			@request = Request.new(@protocol + WebServicesBaseURL + TakeTable, true, options, html)
 			return nil
 		end		
 
@@ -165,7 +205,7 @@ module GrabzIt
 				options = PDFOptions.new()
 			end
 		
-			@request = Request.new(@protocol + WebServicesBaseURLGet + TakePDF, false, options, url)
+			@request = Request.new(@protocol + WebServicesBaseURL + TakePDF, false, options, url)
 			return nil			
 		end	
 		
@@ -180,7 +220,7 @@ module GrabzIt
 				options = PDFOptions.new()
 			end
 		
-			@request = Request.new(@protocol + WebServicesBaseURLPost + TakePDF, true, options, html)
+			@request = Request.new(@protocol + WebServicesBaseURL + TakePDF, true, options, html)
 			return nil
 		end		
 
@@ -204,7 +244,7 @@ module GrabzIt
 				options = DOCXOptions.new()
 			end
 		
-			@request = Request.new(@protocol + WebServicesBaseURLGet + TakeDOCX, false, options, url)
+			@request = Request.new(@protocol + WebServicesBaseURL + TakeDOCX, false, options, url)
 			return nil			
 		end	
 		
@@ -219,7 +259,7 @@ module GrabzIt
 				options = DOCXOptions.new()
 			end
 		
-			@request = Request.new(@protocol + WebServicesBaseURLPost + TakeDOCX, true, options, html)
+			@request = Request.new(@protocol + WebServicesBaseURL + TakeDOCX, true, options, html)
 			return nil
 		end		
 
@@ -324,7 +364,7 @@ module GrabzIt
 				return nil
 			end			
 			
-			result = get(@protocol + WebServicesBaseURLGet + "getstatus.ashx?id=" + GrabzIt::Utility.nil_check(id))
+			result = get(@protocol + WebServicesBaseURL + "getstatus.ashx?id=" + GrabzIt::Utility.nil_check(id))
 
 			doc = REXML::Document.new(result)
 
@@ -346,7 +386,7 @@ module GrabzIt
 				return nil
 			end
 			
-			return get(@protocol + WebServicesBaseURLGet + "getfile.ashx?id=" + GrabzIt::Utility.nil_check(id))
+			return get(@protocol + WebServicesBaseURL + "getfile.ashx?id=" + GrabzIt::Utility.nil_check(id))
 		end
 
 		# Get all the cookies that GrabzIt is using for a particular domain. This may include your user set cookies as well
@@ -364,7 +404,7 @@ module GrabzIt
 			qs.concat("&sig=")
 			qs.concat(sig)
 
-			result = get(@protocol + WebServicesBaseURLGet + "getcookies.ashx?" + qs)
+			result = get(@protocol + WebServicesBaseURL + "getcookies.ashx?" + qs)
 
 			doc = REXML::Document.new(result)
 
@@ -419,7 +459,7 @@ module GrabzIt
 			qs.concat("&sig=")
 			qs.concat(sig)
 
-			return (get_result_value(get(@protocol + WebServicesBaseURLGet + "setcookie.ashx?" + qs), "Result") == TrueString)
+			return (get_result_value(get(@protocol + WebServicesBaseURL + "setcookie.ashx?" + qs), "Result") == TrueString)
 		end
 
 		# Delete a custom cookie or block a global cookie from being used
@@ -441,7 +481,7 @@ module GrabzIt
 			qs.concat("&delete=1&sig=")
 			qs.concat(sig)
 
-			return (get_result_value(get(@protocol + WebServicesBaseURLGet + "setcookie.ashx?" + qs), "Result") == TrueString)
+			return (get_result_value(get(@protocol + WebServicesBaseURL + "setcookie.ashx?" + qs), "Result") == TrueString)
 		end
 
 		# Get your uploaded custom watermark
@@ -481,7 +521,7 @@ module GrabzIt
 
 			boundary = '--------------------------'+Time.now.to_f.to_s
 
-			url = @protocol + "://grabz.it/services/addwatermark.ashx"
+			url = @protocol + "://api.grabz.it/services/addwatermark.ashx"
 			uri = URI.parse(url)
 
 			file = File.open(path, "rb")
@@ -541,7 +581,7 @@ module GrabzIt
 			qs.concat("&sig=")
 			qs.concat(sig)
 
-			return (get_result_value(get(@protocol + WebServicesBaseURLGet + "deletewatermark.ashx?" + qs), "Result") == TrueString)
+			return (get_result_value(get(@protocol + WebServicesBaseURL + "deletewatermark.ashx?" + qs), "Result") == TrueString)
 		end
 
 		# This method sets if requests to GrabzIt's API should use SSL or not
@@ -625,7 +665,7 @@ module GrabzIt
 			qs.concat("&sig=")
 			qs.concat(sig)
 
-			result = get(@protocol + WebServicesBaseURLGet + "getwatermarks.ashx?" + qs)
+			result = get(@protocol + WebServicesBaseURL + "getwatermarks.ashx?" + qs)
 
 			doc = REXML::Document.new(result)
 
@@ -665,7 +705,7 @@ module GrabzIt
 			if statusCode == 403
 				raise GrabzItException.new(response.body, GrabzItException::NETWORK_DDOS_ATTACK)
 			elsif statusCode >= 400
-				raise GrabzItException.new("A network error occured when connecting to the GrabzIt servers.", GrabzItException::NETWORK_GENERAL_ERROR)
+				raise GrabzItException.new("A network error occurred when connecting to GrabzIt.", GrabzItException::NETWORK_GENERAL_ERROR)
 			end
 		end
 		
@@ -685,7 +725,7 @@ module GrabzIt
 
 		private
 		def encode(text)
-			return Digest::MD5.hexdigest(text.encode('ascii', {:invalid => :replace, :undef => :replace, :replace => '?'}))
+			return Digest::MD5.hexdigest(text.encode('ascii', **{:invalid => :replace, :undef => :replace, :replace => '?'}))
 		end
 
 		private

data/lib/grabzit/docxoptions.rb

@@ -30,7 +30,9 @@ module GrabzIt
 			@targetElement = nil
 			@mergeId = nil
 			@noCookieNotifications = false
-			@address = nil			
+			@address = nil
+			@password = nil
+			@clickElement = nil
 		end
 		
 		# @return [Boolean] true if the background images of the web page should be included in the DOCX
@@ -295,6 +297,19 @@ module GrabzIt
 			@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 [String] get the ID of a capture that should be merged at the beginning of the new DOCX document
 		def mergeId
 			@mergeId
@@ -346,7 +361,20 @@ module GrabzIt
 		# @return [void]		
 		def address=(value)
 			@address = value
-		end				
+		end	
+		
+		# @return [String] get the password that protects the DOCX document
+		def password
+			@password
+		end
+		
+		# Set the password that protects the DOCX document
+		#
+		# @param value [String] the password
+		# @return [void]		
+		def password=(value)
+			@password = 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.
@@ -373,7 +401,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))
+			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))
 			return items.join("|")
 		end
 		
@@ -406,6 +434,8 @@ module GrabzIt
 			params['mergeid'] = GrabzIt::Utility.nil_check(@mergeId)
 			params['address'] = GrabzIt::Utility.nil_check(@address)
 			params['nonotify'] = GrabzIt::Utility.b_to_str(@noCookieNotifications)
+			params['password'] = GrabzIt::Utility.nil_check(@password)
+			params['click'] = GrabzIt::Utility.nil_check(@clickElement)
 			
 			return params;
 		end		

data/lib/grabzit/exception.rb

@@ -72,6 +72,10 @@ module GrabzIt
 		PARAMETER_INVALID_PROXY = 173
 		PARAMETER_INVALID_NO_NOTIFY = 174
 		PARAMETER_INVALID_HD = 176
+		PARAMETER_INVALID_MEDIA_TYPE = 177
+		PARAMETER_INVALID_PASSWORD = 178
+		PARAMETER_INVALID_MERGE = 179
+		PARAMETER_INVALID_CLICK_VALUE = 180
 		NETWORK_SERVER_OFFLINE = 200
 		NETWORK_GENERAL_ERROR = 201
 		NETWORK_DDOS_ATTACK = 202

data/lib/grabzit/htmloptions.rb

@@ -0,0 +1,161 @@
+module GrabzIt
+	require File.join(File.dirname(__FILE__), 'baseoptions')
+	
+	# Represents all of the options available when creating rendered HTML
+	# @version 3.0
+	# @author GrabzIt
+	class HTMLOptions < BaseOptions
+		def initialize()
+			super()
+			@browserWidth = nil
+			@browserHeight = nil
+			@waitForElement = nil
+			@requestAs = 0
+			@noAds = false
+			@noCookieNotifications = false
+			@address = nil
+		end
+		
+		# @return [Integer] the width of the browser in pixels
+		def browserWidth
+			@browserWidth
+		end
+		
+		# Set the width of the browser in pixels
+		#
+		# @param value [Integer] the browser width
+		# @return [void]		
+		def browserWidth=(value)
+			@browserWidth = value
+		end	
+		
+		# @return [Integer] the height of the browser in pixels
+		def browserHeight
+			@browserHeight
+		end
+		
+		# Set the height of the browser in pixels. Use -1 to screenshot the whole web page
+		#
+		# @param value [Integer] the browser height
+		# @return [void]		
+		def browserHeight=(value)
+			@browserHeight = value
+		end
+
+		# @return [Integer] get the number of milliseconds to wait before creating the capture
+		def delay
+			@delay
+		end
+		
+		# Set the number of milliseconds to wait before creating the capture
+		#
+		# @param value [Integer] the delay
+		# @return [void]		
+		def delay=(value)
+			@delay = value
+		end
+		
+		# @return [String] get the CSS selector of the HTML element in the web page that must be visible before the capture is performed
+		def waitForElement
+			@waitForElement
+		end
+		
+		# Set the CSS selector of the HTML element in the web page that must be visible before the capture is performed
+		#
+		# @param value [String] the element to wait for
+		# @return [void]		
+		def waitForElement=(value)
+			@waitForElement = value
+		end		
+		
+		# @return [Integer] get which user agent type should be used
+		def requestAs
+			@requestAs
+		end
+		
+		# Set which user agent type should be used: Standard Browser = 0, Mobile Browser = 1, Search Engine = 2 and Fallback Browser = 3
+		#
+		# @param value [Integer] the browser type
+		# @return [void]		
+		def requestAs=(value)
+			@requestAs = value
+		end
+		
+		# @return [Boolean] get if adverts should be automatically hidden
+		def noAds
+			@noAds
+		end
+		
+		# Set to true if adverts should be automatically hidden
+		#
+		# @param value [Boolean] hide adverts
+		# @return [void]		
+		def noAds=(value)
+			@noAds = value
+		end		
+
+		# @return [Boolean] get if cookie notifications should be automatically hidden
+		def noCookieNotifications
+			@noCookieNotifications
+		end
+		
+		# Set to true if cookie notifications should be automatically hidden
+		#
+		# @param value [Boolean] hide cookie notifications
+		# @return [void]		
+		def noCookieNotifications=(value)
+			@noCookieNotifications = value
+		end
+
+		# @return [String] get the URL to execute the HTML code in
+		def address
+			@address
+		end
+		
+		# Set the URL to execute the HTML code in
+		#
+		# @param value [String] the address
+		# @return [void]		
+		def address=(value)
+			@address = 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.
+		#
+		# @param name [String] the name of the HTTP Post parameter
+		# @param value [String] the value of the HTTP Post parameter
+		def add_post_parameter(name, value)
+			@post = appendParameter(@post, name, value)
+		end		
+		
+		# @!visibility private
+		def _getSignatureString(applicationSecret, callBackURL, url = nil)
+			items = [applicationSecret]
+			
+			if(url != nil)
+				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))
+			
+			return items.join("|")
+		end
+	
+		# @!visibility private
+		def _getParameters(applicationKey, sig, callBackURL, dataName, dataValue)
+			params = createParameters(applicationKey, sig, callBackURL, dataName, dataValue)		
+			params['bwidth'] = GrabzIt::Utility.nil_int_check(@browserWidth)
+			params['bheight'] = GrabzIt::Utility.nil_int_check(@browserHeight)
+			params['delay'] = GrabzIt::Utility.nil_int_check(@delay)
+			params['waitfor'] = GrabzIt::Utility.nil_check(@waitForElement)
+			params['requestmobileversion'] = GrabzIt::Utility.nil_int_check(@requestAs)		
+			params['noads'] = GrabzIt::Utility.b_to_str(@noAds)
+			params['post'] = GrabzIt::Utility.nil_check(@post)
+			params['address'] = GrabzIt::Utility.nil_check(@address)
+			params['nonotify'] = GrabzIt::Utility.b_to_str(@noCookieNotifications)
+			
+			return params
+		end
+	end
+end

data/lib/grabzit/imageoptions.rb

@@ -23,6 +23,7 @@ module GrabzIt
 			@noCookieNotifications = false
 			@address = nil
 			@hd = false
+			@clickElement = nil
 		end
 		
 		# @return [Integer] the width of the browser in pixels
@@ -140,6 +141,19 @@ module GrabzIt
 		# @return [void]		
 		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
@@ -263,7 +277,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))
+			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))
 			
 			return items.join("|")
 		end
@@ -289,6 +303,7 @@ module GrabzIt
 			params['address'] = GrabzIt::Utility.nil_check(@address)
 			params['nonotify'] = GrabzIt::Utility.b_to_str(@noCookieNotifications)
 			params['hd'] = GrabzIt::Utility.b_to_str(@hd)
+			params['click'] = GrabzIt::Utility.nil_check(@clickElement)
 			
 			return params
 		end

data/lib/grabzit/pdfoptions.rb

@@ -33,6 +33,9 @@ module GrabzIt
 			@mergeId = nil
 			@noCookieNotifications = false
 			@address = nil
+			@cssMediaType = nil
+			@password = nil
+			@clickElement = nil
 		end
 		
 		# @return [Boolean] true if the background of the web page should be included in the PDF
@@ -74,7 +77,21 @@ module GrabzIt
 		def orientation=(value)
 			value = GrabzIt::Utility.nil_check(value).capitalize
 			@orientation = value
-		end		
+		end
+		
+		# @return [String] the CSS Media Type of the PDF to be returned
+		def cssMediaType
+			@cssMediaType
+		end
+		
+		# Set the CSS Media Type of the PDF to be returned: 'Print' or 'Screen'
+		#
+		# @param value [String] CSS Media Type
+		# @return [void]		
+		def cssMediaType=(value)
+			value = GrabzIt::Utility.nil_check(value).capitalize
+			@cssMediaType = value
+		end
 		
 		# @return [Boolean] true if the links should be included in the PDF
 		def includeLinks
@@ -322,6 +339,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 [String] get the ID of a capture that should be merged at the beginning of the new PDF document
 		def mergeId
@@ -373,7 +403,20 @@ module GrabzIt
 		# @return [void]		
 		def address=(value)
 			@address = value
-		end		
+		end
+		
+		# @return [String] get the password that protects the PDF document
+		def password
+			@password
+		end
+		
+		# Set the password that protects the PDF document
+		#
+		# @param value [String] the password
+		# @return [void]		
+		def password=(value)
+			@password = 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.
@@ -400,7 +443,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))
+			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))
 			
 			return items.join("|")
 		end
@@ -436,7 +479,10 @@ module GrabzIt
 			params['mergeid'] = GrabzIt::Utility.nil_check(@mergeId)
 			params['address'] = GrabzIt::Utility.nil_check(@address)
 			params['nonotify'] = GrabzIt::Utility.b_to_str(@noCookieNotifications)
-			
+			params['media'] = GrabzIt::Utility.nil_check(@cssMediaType)
+			params['password'] = GrabzIt::Utility.nil_check(@password)
+			params['click'] = GrabzIt::Utility.nil_check(@clickElement)
+
 			return params;
 		end		
 	end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grabzit
 version: !ruby/object:Gem::Version
-  version: 3.3.4.1
+  version: 3.5.0
 platform: ruby
 authors:
 - GrabzIt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-11 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,11 +24,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Use GrabzIt to convert HTML or URL's into images, PDF or DOCX documents.
-  These captures have highly customizable options include altering quality, delay,
-  size, browser type, geographic location and much more. Additionally GrabzIt can
-  even convert HTML tables on the web into a CSV or Excel spreadsheet. As well as
-  enabling online video's to be converted into animated GIF's.
+description: Use GrabzIt to convert HTML or URL's into images, PDF, rendered HTML
+  or DOCX. These captures have highly customizable options include altering quality,
+  delay, size, browser type, geographic location and much more. Additionally GrabzIt
+  can even convert HTML tables on the web into a CSV or Excel spreadsheet. As well
+  as enabling online video's to be converted into animated GIF's.
 email: support@grabz.it
 executables: []
 extensions: []
@@ -42,6 +42,7 @@ files:
 - lib/grabzit/cookie.rb
 - lib/grabzit/docxoptions.rb
 - lib/grabzit/exception.rb
+- lib/grabzit/htmloptions.rb
 - lib/grabzit/imageoptions.rb
 - lib/grabzit/pdfoptions.rb
 - lib/grabzit/proxy.rb
@@ -56,7 +57,7 @@ homepage: https://grabz.it/api/ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -71,9 +72,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: GrabzIt Ruby Client
 test_files: []