grabzit 3.5.2 → 3.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2920fbc96f29ee4d9b7f7a1c83e7fe1d2ead558fc74b4baa5cd335f73cc9efd7
-  data.tar.gz: 8104b2962af11846171eced2a038a48d1f33f768d6684293f52a73103aaed85c
+  metadata.gz: 2a8a19888be59015aa66b1794e2bd0ccf7c395272c98e65b7156b4d921b7f8c6
+  data.tar.gz: 57d2ac4496d215398896a0e30162c71885e8b29e955a5fedfa9f279484367b24
 SHA512:
-  metadata.gz: 3fd0f39c45172d5f685e1c76b9664d0f4b1e5de08c37a0d3c565a64eaf85712c4a254506b1468fb64cbb45b7135a507f89420f1746f89dcd5914810fb6427744
-  data.tar.gz: 1afc1b4fcbd2e0008d58ce9b6572a48981ac6febd4c2434b4abca92561c4b4536dbf9c4408a75ec5c10cccecbb48ccb197e9484b9de27ee06ec1a2b172f46488
+  metadata.gz: bf4947d9f5b5055806281a167944ab1d83ef3b9d14bb32204393f6d47a9a70cab5e5e88785c871eeaf31657ae59d7c4a50693ac41eef1d78a3d55640cbd31981
+  data.tar.gz: 6d735f28a68c328d3187ca76638660380777399e3bc4a4536adc850536e5bcd29e4a9174978bebbb946da5c936fae3d5816e00821eb91530a82ff19e03d1c668

data/lib/grabzit/client.rb

@@ -1,4 +1,4 @@
-# The public REST API for http://grabz.it
+# The public REST API for https://grabz.it
 # @example To include the GrabzIt module do the following
 #    require 'grabzit'
 module GrabzIt	
@@ -32,13 +32,15 @@ module GrabzIt
 	#    grabzItClient.save("http://www.mysite.com/grabzit/handler")
 	# @version 3.0
 	# @author GrabzIt
-	# @see http://grabz.it/api/ruby/ GrabzIt Ruby API
+	# @see https://grabz.it/api/ruby/ GrabzIt Ruby API
 	class Client
 
 		WebServicesBaseURL = "://api.grabz.it/services/"
 		private_constant :WebServicesBaseURL	
 		TakePicture = "takepicture"	
 		private_constant :TakePicture
+		TakeVideo = "takevideo"	
+		private_constant :TakeVideo	
 		TakeTable = "taketable"
 		private_constant :TakeTable
 		TakePDF = "takepdf"
@@ -54,7 +56,7 @@ module GrabzIt
 		#
 		# @param applicationKey [String] your application key
 		# @param applicationSecret [String] your application secret
-		# @see http://grabz.it/register.aspx You can get an application key and secret by registering for free with GrabzIt		
+		# @see https://grabz.it/login/create/ You can get an application key and secret by registering for free with GrabzIt		
 		def initialize(applicationKey, applicationSecret)
 			@applicationKey = applicationKey
 			@applicationSecret = applicationSecret
@@ -116,6 +118,45 @@ module GrabzIt
 			html_to_image(read_file(path), options)
 		end
 
+		# This method specifies the URL that should be converted into a video
+		#
+		# @param url [String] the URL to capture as a video
+		# @param options [VideoOptions, nil] a instance of the VideoOptions class that defines any special options to use when creating a video
+		# @return [void]		
+		def url_to_video(url, options = nil)		
+
+			if options == nil
+				options = VideoOptions.new()
+			end
+		
+			@request = Request.new(@protocol + WebServicesBaseURL + TakeVideo, false, options, url)
+			return nil
+		end
+
+		# This method specifies the HTML that should be converted into a video
+		#
+		# @param html [String] the HTML to convert into a video
+		# @param options [VideoOptions, nil] a instance of the VideoOptions class that defines any special options to use when creating a video
+		# @return [void]		
+		def html_to_video(html, options = nil)		
+
+			if options == nil
+				options = VideoOptions.new()
+			end
+		
+			@request = Request.new(@protocol + WebServicesBaseURL + TakeVideo, true, options, html)
+			return nil
+		end		
+
+		# This method specifies a HTML file that should be converted into a video
+		#
+		# @param path [String] the file path of a HTML file to convert into a video
+		# @param options [VideoOptions, nil] a instance of the VideoOptions class that defines any special options to use when creating a video
+		# @return [void]		
+		def file_to_video(path, options = nil)		
+			html_to_video(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
@@ -627,7 +668,7 @@ module GrabzIt
 
 		# This method will decrypt a encrypted capture, using the key you passed to the encryption key parameter.
 		#
-		# @param path [String] the encrypted bytes
+		# @param data [Array<Byte>] the encrypted bytes
 		# @param key [String] the encryption key
 		# @return [Array<Byte>] an array of decrypted bytes
 		def decrypt(data, key)

data/lib/grabzit/videooptions.rb

@@ -0,0 +1,272 @@
+module GrabzIt
+	require File.join(File.dirname(__FILE__), 'baseoptions')
+	
+	# Represents all of the options available when creating an video
+	# @version 3.0
+	# @author GrabzIt
+	class VideoOptions < BaseOptions
+		def initialize()
+			super()
+			@browserWidth = nil
+			@browserHeight = nil
+			@width = nil
+			@height = nil			
+			@waitForElement = nil
+			@requestAs = 0
+			@customWaterMarkId = nil
+			@noAds = false
+			@noCookieNotifications = false
+			@address = nil
+			@clickElement = nil
+			@start = 0
+			@duration = 10
+			@framesPerSecond = 0
+		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 width of the resulting video in pixels
+		def width
+			@width
+		end
+		
+		# Set the width of the resulting video in pixels
+		#
+		# @param value [Integer] the width
+		# @return [void]		
+		def width=(value)
+			@width = value
+		end			
+		
+		# @return [Integer] get the height of the resulting video in pixels
+		def height
+			@height
+		end
+		
+		# Set the height of the resulting video in pixels
+		#
+		# @param value [Integer] the height
+		# @return [void]		
+		def height=(value)
+			@height = 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 [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
+			@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 [String] the custom watermark id.
+		def customWaterMarkId
+			@customWaterMarkId
+		end
+		
+		# Set a custom watermark to add to the screenshot.
+		#
+		# @param value [String] custom watermark id
+		# @return [void]		
+		def customWaterMarkId=(value)
+			@customWaterMarkId = 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
+		
+		# @return [Integer] the starting time of the web page that should be converted into a video
+		def start
+			@start
+		end
+		
+		# Set the starting time of the web page that should be converted into a video
+		#
+		# @param value [Integer] the second to start at
+		# @return [void]		
+		def start=(value)
+			@start = value
+		end			
+
+		# @return [Integer] the length in seconds of the web page that should be converted into a video
+		def duration
+			@duration
+		end
+		
+		# Set the length in seconds of the web page that should be converted into a video
+		#
+		# @param value [Integer] the number of seconds
+		# @return [void]		
+		def duration=(value)
+			@duration = value
+		end		
+		
+		# @return [Float] the number of frames per second that should be used to create the video. From a minimum of 0.2 to a maximum of 10
+		def framesPerSecond
+			@framesPerSecond
+		end
+		
+		# Set the number of frames per second that should be used to create the video. From a minimum of 0.2 to a maximum of 10
+		#
+		# @param value [Float] the number of frames per second
+		# @return [void]		
+		def framesPerSecond=(value)
+			@framesPerSecond = 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_check(@customWaterMarkId),
+			GrabzIt::Utility.nil_int_check(@start),
+			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_float_check(@framesPerSecond),
+			GrabzIt::Utility.nil_int_check(@duration),
+			GrabzIt::Utility.nil_int_check(@width),
+			GrabzIt::Utility.nil_int_check(@height))
+			
+			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['customwatermarkid'] = GrabzIt::Utility.nil_check(@customWaterMarkId)
+			params['bheight'] = GrabzIt::Utility.nil_int_check(@browserHeight)
+			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)
+			params['click'] = GrabzIt::Utility.nil_check(@clickElement)
+			params['start'] = GrabzIt::Utility.nil_int_check(@start)
+			params['fps'] = GrabzIt::Utility.nil_float_check(@framesPerSecond)
+			params['duration'] = GrabzIt::Utility.nil_int_check(@duration)
+			params['width'] = GrabzIt::Utility.nil_int_check(@width)
+			params['height'] = GrabzIt::Utility.nil_int_check(@height)			
+
+			return params
+		end
+	end
+end

data/test/test_grabzit.rb

@@ -1,5 +1,5 @@
 require 'test/unit'
-require 'grabzit'
+require_relative '../lib/grabzit.rb'
 
 class GrabzItTest < Test::Unit::TestCase
 	Cookie_Name = "test_cookie"
@@ -31,6 +31,14 @@ class GrabzItTest < Test::Unit::TestCase
 		end		
 	end
 
+	def test_html_to_video
+		assert_nothing_raised "An error occured when trying to take convert HTML to a video" do
+			grabzItClient = GrabzIt::Client.new(@applicationKey, @applicationSecret)
+			grabzItClient.html_to_video("<h1>Hello world</h1>");
+			assert_not_equal(false, grabzItClient.save(), "HTML not converted")
+		end		
+	end	
+
 	def test_html_to_pdf
 		assert_nothing_raised "An error occured when trying to take convert HTML to a pdf" do
 			grabzItClient = GrabzIt::Client.new(@applicationKey, @applicationSecret)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grabzit
 version: !ruby/object:Gem::Version
-  version: 3.5.2
+  version: 3.5.4
 platform: ruby
 authors:
 - GrabzIt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,8 +24,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-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,
+description: Use GrabzIt to convert HTML or URL's into images, PDF, videos, 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.
@@ -50,6 +50,7 @@ files:
 - lib/grabzit/screenshotstatus.rb
 - lib/grabzit/tableoptions.rb
 - lib/grabzit/utility.rb
+- lib/grabzit/videooptions.rb
 - lib/grabzit/watermark.rb
 - test/test.png
 - test/test_grabzit.rb
@@ -72,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: GrabzIt Ruby Client