grabzit 2.3.0 → 3.0.0

data/lib/grabzit/imageoptions.rb

@@ -0,0 +1,185 @@
+module GrabzIt
+	require File.join(File.dirname(__FILE__), 'baseoptions')
+	
+	# Represents all of the options available when creating an image
+	# @version 3.0
+	# @author GrabzIt
+	class ImageOptions < BaseOptions
+		def initialize()
+			@browserWidth = nil
+			@browserHeight = nil
+			@width = nil
+			@height = nil
+			@format = nil
+			@targetElement = nil
+			@requestAs = 0
+			@customWaterMarkId = nil
+			@quality = -1
+		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 screenshot in pixels.
+		def width
+			@width
+		end
+		
+		# Set the width of the resulting screenshot in pixels. Use -1 to not reduce the width of the screenshot
+		#
+		# @param value [Integer] the width
+		# @return [void]		
+		def width(value)
+			@width = value
+		end			
+		
+		# @return [Integer] get the height of the resulting screenshot in pixels
+		def height
+			@height
+		end
+		
+		# Set the height of the resulting screenshot in pixels. Use -1 to not reduce the height of the screenshot
+		#
+		# @param value [Integer] the height
+		# @return [void]		
+		def height(value)
+			@height = value
+		end
+
+		# @return [String] get the format of the screenshot image
+		def format
+			@format
+		end
+		
+		# Set the format the screenshot should be in: bmp8, bmp16, bmp24, bmp, tiff, jpg, png
+		#
+		# @param value [String] the format
+		# @return [void]		
+		def format(value)
+			@format = 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 id of the only HTML element in the web page to turn into a screenshot
+		def targetElement
+			@targetElement
+		end
+		
+		# Set the id of the only HTML element in the web page to turn into a screenshot
+		#
+		# @param value [String] the target element
+		# @return [void]		
+		def targetElement(value)
+			@targetElement = 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 [Integer] the quality of the screenshot.
+		def quality
+			@quality
+		end
+		
+		# Set the quality of the screenshot where 0 is poor and 100 excellent. The default is -1 which uses the recommended quality
+		#
+		# @param value [Integer] the custom identifier
+		# @return [void]		
+		def quality(value)
+			@quality = value
+		end	
+
+		# @!visibility private
+		def _getSignatureString(applicationSecret, callBackURL, url = nil)
+			urlParam = ''
+			if (url != nil)
+				urlParam = GrabzIt::Utility.nil_check(url)+"|"
+			end		
+			
+			callBackURLParam = ''
+			if (callBackURL != nil)
+				callBackURLParam = GrabzIt::Utility.nil_check(callBackURL)
+			end					
+
+			return applicationSecret+"|"+ urlParam + callBackURLParam +
+			"|"+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)	  
+		end
+	
+		# @!visibility private
+		def _getParameters(applicationKey, sig, callBackURL, dataName, dataValue)
+			params = createParameters(applicationKey, sig, callBackURL, dataName, dataValue)		
+			params['width'] = GrabzIt::Utility.nil_int_check(@width)
+			params['height'] = GrabzIt::Utility.nil_int_check(@height)
+			params['format'] = GrabzIt::Utility.nil_check(@format)
+			params['bwidth'] = GrabzIt::Utility.nil_int_check(@browserWidth)
+			params['customwatermarkid'] = GrabzIt::Utility.nil_check(@customWaterMarkId)
+			params['bheight'] = GrabzIt::Utility.nil_int_check(@browserHeight)
+			params['delay'] = GrabzIt::Utility.nil_int_check(@delay)
+			params['target'] = GrabzIt::Utility.nil_check(@targetElement)
+			params['requestmobileversion'] = GrabzIt::Utility.nil_int_check(@requestAs)		
+			params['quality'] = GrabzIt::Utility.nil_int_check(@quality)
+			
+			return params		
+		end
+	end
+end

data/lib/grabzit/pdfoptions.rb

@@ -0,0 +1,266 @@
+module GrabzIt
+	require File.join(File.dirname(__FILE__), 'baseoptions')
+	
+	# Represents all of the options available when creating a PDF
+	# @version 3.0
+	# @author GrabzIt
+	class PDFOptions < BaseOptions
+		def initialize()
+			@includeBackground = true
+			@pagesize = 'A4'
+			@orientation = 'Portrait'
+			@includeLinks = true
+			@includeOutline = false
+			@title = nil
+			@coverURL = nil
+			@marginTop = 10
+			@marginLeft = 10
+			@marginBottom = 10
+			@marginRight = 10
+			@requestAs = 0
+			@templateId = nil
+			@customWaterMarkId = nil
+			@quality = -1
+		end
+		
+		# @return [Boolean] true if the background of the web page should be included in the PDF
+		def includeBackground
+			@includeBackground
+		end
+		
+		# Set to true if the background of the web page should be included in the PDF
+		#
+		# @param value [Boolean] include background
+		# @return [void]		
+		def includeBackground(value)
+			@includeBackground = value
+		end
+
+		# @return [String] the page size of the PDF to be returned
+		def pagesize
+			@pagesize
+		end
+		
+		# Set the page size of the PDF to be returned: 'A3', 'A4', 'A5', 'A6', 'B3', 'B4', 'B5', 'B6', 'Letter'
+		#
+		# @param value [String] page size
+		# @return [void]		
+		def pagesize(value)
+			value = GrabzIt::Utility.nil_check(value).upcase
+			@pagesize = value
+		end		
+		
+		# @return [String] the orientation of the PDF to be returned
+		def orientation
+			@orientation
+		end
+		
+		# Set the orientation of the PDF to be returned: 'Landscape' or 'Portrait'
+		#
+		# @param value [String] page orientation
+		# @return [void]		
+		def orientation(value)
+			value = GrabzIt::Utility.nil_check(value).capitalize
+			@orientation = value
+		end		
+		
+		# @return [Boolean] true if the links should be included in the PDF
+		def includeLinks
+			@includeLinks
+		end
+		
+		# Set to true if links should be included in the PDF
+		#
+		# @param value [Boolean] include links
+		# @return [void]		
+		def includeLinks(value)
+			@includeLinks = value
+		end		
+		
+		# @return [String] a title for the PDF document
+		def title
+			@title
+		end
+		
+		# Set a title for the PDF document
+		#
+		# @param value [String] PDF title
+		# @return [void]		
+		def title(value)
+			@title = value
+		end	
+
+		# @return [String] the URL of a web page that should be used as a cover page for the PDF
+		def coverURL
+			@coverURL
+		end
+		
+		# Set the URL of a web page that should be used as a cover page for the PDF
+		#
+		# @param value [String] cover URL
+		# @return [void]		
+		def coverURL(value)
+			@coverURL = value
+		end
+
+		# @return [Integer] the margin that should appear at the top of the PDF document page
+		def marginTop
+			@marginTop
+		end
+		
+		# Set the margin that should appear at the top of the PDF document page
+		#
+		# @param value [Integer] margin top
+		# @return [void]		
+		def marginTop(value)
+			@marginTop = value
+		end		
+		
+		# @return [Integer] the margin that should appear at the left of the PDF document page
+		def marginLeft
+			@marginLeft
+		end
+		
+		# Set the margin that should appear at the left of the PDF document page
+		#
+		# @param value [Integer] margin left
+		# @return [void]		
+		def marginLeft(value)
+			@marginLeft = value
+		end	
+
+		# @return [Integer] the margin that should appear at the bottom of the PDF document page
+		def marginBottom
+			@marginBottom
+		end
+		
+		# Set the margin that should appear at the bottom of the PDF document page
+		#
+		# @param value [Integer] margin bottom
+		# @return [void]		
+		def marginBottom(value)
+			@marginBottom = value
+		end			
+		
+		# @return [Integer] the margin that should appear at the right of the PDF document
+		def marginRight
+			@marginRight
+		end
+		
+		# Set the margin that should appear at the right of the PDF document
+		#
+		# @param value [Integer] margin right
+		# @return [void]		
+		def marginRight(value)
+			@marginRight = value
+		end		
+		
+		# @return [Integer] 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] delay
+		# @return [void]		
+		def delay(value)
+			@delay = 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 PDF template ID that specifies the header and footer of the PDF document
+		def templateId
+			@templateId
+		end
+		
+		# Set a PDF template ID that specifies the header and footer of the PDF document
+		#
+		# @param value [String] template id
+		# @return [void]		
+		def templateId(value)
+			@templateId = value
+		end		
+		
+		# @return [String] the custom watermark id.
+		def customWaterMarkId
+			@customWaterMarkId
+		end
+		
+		# Set a custom watermark to add to the PDF.
+		#
+		# @param value [String] custom watermark id
+		# @return [void]		
+		def customWaterMarkId(value)
+			@customWaterMarkId = value
+		end					
+		
+		# @return [Integer] the quality of the PDF.
+		def quality
+			@quality
+		end
+		
+		# Set the quality of the PDF where 0 is poor and 100 excellent. The default is -1 which uses the recommended quality
+		#
+		# @param value [Integer] quality
+		# @return [void]		
+		def quality(value)
+			@quality = value
+		end		
+		
+		# @!visibility private
+		def _getSignatureString(applicationSecret, callBackURL, url = nil)
+			urlParam = ''
+			if (url != nil)
+				urlParam = GrabzIt::Utility.nil_check(url)+"|"
+			end		
+			
+			callBackURLParam = ''
+			if (callBackURL != nil)
+				callBackURLParam = GrabzIt::Utility.nil_check(callBackURL)
+			end					
+
+			return applicationSecret+"|"+ urlParam + callBackURLParam +
+			"|"+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)	  
+		end
+		
+		# @!visibility private
+		def _getParameters(applicationKey, sig, callBackURL, dataName, dataValue)
+			params = createParameters(applicationKey, sig, callBackURL, dataName, dataValue)		
+			params['background'] = GrabzIt::Utility.b_to_str(@includeBackground)
+			params['pagesize'] = @pagesize
+			params['orientation'] = @orientation
+			params['templateid'] = GrabzIt::Utility.nil_check(@templateId)
+			params['customwatermarkid'] = GrabzIt::Utility.nil_check(@customWaterMarkId)
+			params['includelinks'] = GrabzIt::Utility.b_to_str(@includeLinks)
+			params['includeoutline'] = GrabzIt::Utility.b_to_str(@includeOutline)
+			params['title'] = GrabzIt::Utility.nil_check(@title)
+			params['coverurl'] = GrabzIt::Utility.nil_check(@coverURL)
+			params['mleft'] = GrabzIt::Utility.nil_int_check(@marginLeft)
+			params['mright'] = GrabzIt::Utility.nil_int_check(@marginRight)
+			params['mtop'] = GrabzIt::Utility.nil_int_check(@marginTop)
+			params['mbottom'] = GrabzIt::Utility.nil_int_check(@marginBottom)
+			params['delay'] = GrabzIt::Utility.nil_int_check(@delay)
+			params['requestmobileversion'] = GrabzIt::Utility.nil_int_check(@requestAs)		
+			params['quality'] = GrabzIt::Utility.nil_int_check(@quality)			
+			
+			return params;
+		end		
+	end
+end

data/lib/grabzit/request.rb

@@ -0,0 +1,36 @@
+module GrabzIt
+	# @version 3.0
+	# @author GrabzIt
+	# @!visibility private
+	class Request
+		def initialize(url, isPost, options, data = nil)
+			@url = url
+			@isPost = isPost
+			@options = options
+			@data = data
+		end	
+		
+		def url
+			@url
+		end
+		
+		def isPost
+			@isPost
+		end
+		
+		def options
+			@options
+		end
+		
+		def data
+			@data
+		end
+		
+		def getTargetUrl
+			if (@isPost)
+				return nil
+			end
+			return @data		
+		end
+	end
+end

data/lib/grabzit/screenshotstatus.rb

@@ -1,9 +1,9 @@
 module GrabzIt
 	# This class represents the screenshot status
-	# @version 2.1
+	# @version 3.0
 	# @author GrabzIt
 	class ScreenShotStatus
-		# @api private
+		# @!visibility private
 		def initialize(processing = false, cached = false, expired = false, message = '')
 			@Processing = processing
 			@Cached = cached

data/lib/grabzit/tableoptions.rb

@@ -0,0 +1,126 @@
+module GrabzIt
+	require File.join(File.dirname(__FILE__), 'baseoptions')
+	
+	# Represents all of the options available when extracting tabular data
+	# @version 3.0
+	# @author GrabzIt
+	class TableOptions < BaseOptions
+		def initialize()
+			@tableNumberToInclude = 1
+			@format = 'csv'
+			@includeHeaderNames = true
+			@includeAllTables = false
+			@targetElement = nil
+			@requestAs = 0
+		end
+		
+		# @return [Integer] the index of the table to be converted
+		def tableNumberToInclude
+			@tableNumberToInclude
+		end
+		
+		# Set the index of the table to be converted, were all tables in a web page are ordered from the top of the web page to bottom
+		#
+		# @param value [Integer] the table number
+		# @return [void]		
+		def tableNumberToInclude(value)
+			@tableNumberToInclude = value
+		end		
+		
+		# @return [String] the format of the table should be
+		def format
+			@format
+		end
+		
+		# Set the format the table should be in: 'csv', 'xlsx' or 'json'
+		#
+		# @param value [String] the format
+		# @return [void]		
+		def format(value)
+			@format = value
+		end		
+		
+		# @return [Boolean] if the header names are included in the table
+		def includeHeaderNames
+			@includeHeaderNames
+		end
+		
+		# Set to true to include header names into the table
+		#
+		# @param value [Boolean] include header names
+		# @return [void]		
+		def includeHeaderNames(value)
+			@includeHeaderNames = value
+		end		
+		
+		# @return [Boolean] if every table on will be extracted with each table appearing in a separate spreadsheet sheet
+		def includeAllTables
+			@includeAllTables
+		end
+		
+		# Set to true to extract every table on the web page into a separate spreadsheet sheet. Only available with the XLSX and JSON formats
+		#
+		# @param value [Boolean] include all tables
+		# @return [void]		
+		def includeAllTables(value)
+			@includeAllTables = value
+		end		
+		
+		# @return [String] the id of the only HTML element in the web page that should be used to extract tables from
+		def targetElement
+			@targetElement
+		end
+		
+		# Set the id of the only HTML element in the web page that should be used to extract tables from
+		#
+		# @param value [String] target
+		# @return [void]		
+		def targetElement(value)
+			@targetElement = 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	
+
+		# @!visibility private
+		def _getSignatureString(applicationSecret, callBackURL, url = nil)
+			urlParam = ''
+			if (url != nil)
+				urlParam = GrabzIt::Utility.nil_check(url)+"|"
+			end		
+			
+			callBackURLParam = ''
+			if (callBackURL != nil)
+				callBackURLParam = GrabzIt::Utility.nil_check(callBackURL)
+			end					
+
+			return applicationSecret+"|"+ urlParam + callBackURLParam +
+			"|"+GrabzIt::Utility.nil_check(@customId)+"|"+GrabzIt::Utility.nil_int_check(@tableNumberToInclude)+"|"+GrabzIt::Utility.b_to_str(@includeAllTables)+
+			"|"+GrabzIt::Utility.b_to_str(@includeHeaderNames)+"|"+GrabzIt::Utility.nil_check(@targetElement)+"|"+GrabzIt::Utility.nil_check(@format)+"|"+
+			GrabzIt::Utility.nil_int_check(@requestAs)+"|"+GrabzIt::Utility.nil_check(@country)
+		end
+
+		# @!visibility private
+		def _getParameters(applicationKey, sig, callBackURL, dataName, dataValue)
+			params = createParameters(applicationKey, sig, callBackURL, dataName, dataValue)
+			params['includeAllTables'] = GrabzIt::Utility.b_to_str(@includeAllTables)
+			params['includeHeaderNames'] = GrabzIt::Utility.b_to_str(@includeHeaderNames)
+			params['format'] = GrabzIt::Utility.nil_check(@format)
+			params['tableToInclude'] = GrabzIt::Utility.nil_int_check(@tableNumberToInclude)
+			params['target'] = GrabzIt::Utility.nil_check(@targetElement)
+			params['requestmobileversion'] = GrabzIt::Utility.nil_int_check(@requestAs)
+
+			return params
+		end
+	end
+end

data/lib/grabzit/utility.rb

@@ -0,0 +1,31 @@
+module GrabzIt	
+	# @!visibility private
+	module Utility
+		def self.b_to_str(bValue)
+			if bValue
+				return 1.to_s
+			end
+			return 0.to_s
+		end
+
+		def self.nil_check(param)
+			if param == nil
+				return ""
+			end
+			return param
+		end
+
+		def self.nil_int_check(param)
+			return param.to_i.to_s
+		end
+
+		def self.nil_float_check(param)
+			val = param.to_f
+			if ((val % 1) == 0)
+				return val.to_i.to_s
+			end
+			
+			return val.to_s
+		end
+	end	
+end

data/lib/grabzit/watermark.rb

@@ -1,9 +1,9 @@
 module GrabzIt
 	# This class represents the custom watermarks stored in GrabzIt
-	# @version 2.1
+	# @version 3.0
 	# @author GrabzIt
 	class WaterMark
-		# @api private
+		# @!visibility private
 		def initialize(identifier = '', xPosition = 0, yPosition = 0, format = '')
 			@Identifier = identifier
 			@XPosition = xPosition