grabzit 3.3.4.1 → 3.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e54b7a156348da8b07ac68291a087989bdda1a3d
-  data.tar.gz: add47bd227816eb7fff782c529712d053b74740b
+SHA256:
+  metadata.gz: 5da69eddc38e96180e23be4dba32f6385c2b91e7d255ef8118d87d19b0a8933a
+  data.tar.gz: 6b9cc4715644808114913bf3887f2090ae53a05f15e0bdb720799ce48588a01a
 SHA512:
-  metadata.gz: 797fd441594b640c6c85c3dbc63d9b9b271291b1c65351578767d31893063719f50dde9bfa7d59722f86292ab737223844f79744ef02e25ad3a8e58101cfc651
-  data.tar.gz: 942eaa771d1d3445a5a25d11efdd21f46e53c895fe9ff66eaaf350e89915ab53890f0fa9feb050a004e3036bdf259143e42f4bce566ad38dbf66fc54a83e5808
+  metadata.gz: 8891fd909276778b78ba6d177779ed4db9e6a8a1cace9c2120a92859d53a3622366d1e71828cb4bc6eca9f6ab355e886dd5681bc6c5309dd4f0a36cd5b5247c2
+  data.tar.gz: 6901c0f929e3676f90f448d40ad6c929d84bc8bf90c6d408d5e778d4af26af0905e5ac1712bcbd60c716a9008ce1045451bfe2e12bb25b60fb7c903e11b1e259

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')
@@ -46,6 +47,8 @@ module GrabzIt
 		private_constant :TakePDF
 		TakeDOCX = "takedocx.ashx"
 		private_constant :TakeDOCX
+		TakeHTML = "takehtml.ashx"
+		private_constant :TakeHTML
 		TrueString = "True"
 		private_constant :TrueString
 		
@@ -114,6 +117,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 + WebServicesBaseURLGet + 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 + WebServicesBaseURLPost + 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
 		#

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grabzit
 version: !ruby/object:Gem::Version
-  version: 3.3.4.1
+  version: 3.3.5
 platform: ruby
 authors:
 - GrabzIt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-11 00:00:00.000000000 Z
+date: 2019-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -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
@@ -71,8 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: GrabzIt Ruby Client