grabzit 3.0.4 → 3.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjI5OGU4Y2FiMzQ5ZjAyMTBmZTM4NjkyZjYyOWVlNjQzNDdmNTdkZQ==
+    OWZkOTRkMWE1YWRmY2Y2YTJlNjA3NzAzMzdlZDBlZTk1M2ZjMjhjNA==
   data.tar.gz: !binary |-
-    YmM5MDU5ODVhMzk5MTlkNjllN2NiNGYyN2Q5OGQ3YzJmMmI3M2VhNQ==
+    NjFkZTk3MWYyNmIyYmEzOTI2Mzg2YjQ2NTM3ZTg3NzI5MTJkZjFkZg==
 SHA512:
   metadata.gz: !binary |-
-    YmFlZjdlOTJhMzU3OTQxMTIwOTVlNmRkNjUyY2IwNmM0ZWNlN2RmNDcxMzlh
-    ZmEwYzc0NGFhYzNhYjFlOWRjZGU1OGVlZGYzNTYzODhmMjhiOGY1ZTBhZDE4
-    ZTRkYzZiNmI4N2E3ZWNlOThhYWI5ODM2MTZhNjVjNTU1MGJmYzQ=
+    YWFmMWNiZTc0MTA5MTY0MDJiZjRjMjBlMTFlYmQ5YTNlZDIwZTcyYjI2NWVm
+    YzE4NWU4MDhkZGE1MmMzZjUxMWZiZWRhYWIxNjUyN2YxZmY3NjYxZjIyZGI3
+    ZDkyZmJhYmNlNTYzN2QzZjQ5ZTE0OTcyMDZkOGU3NjZkY2I5NzE=
   data.tar.gz: !binary |-
-    NzA0ZDMyZDZkN2MyOTZhYTI2MTllZGEyZjNkYThmYWIwNjc2ZGE4MWY2NDkw
-    NzM3OWE3ZGZmMzk1NjM4MWE4MWRkNGJiOTQ4ZjZmYWEzMThhMDVjMmJhMWM3
-    Yjk0YTBkNDQyN2RkYzExMzQ4OWQxODAxNWNjMTJmODEwMTY2MjE=
+    MGNjMDA0ZWJkNmU1MDgyMzk2OTk5ZDBkYjZkNThmMDQ1ZDdmYjkyZmYyYTUw
+    OWExOTY2YzYzYzhkZGRhYzVmMjkxNzQ2MDJkMGRiNGZkMDc2NDkyNWViNjE5
+    NGE0NGE5ODQzZmQxODM2MDRkZWJkNGRkMDkwMjc0MjY1YTdmOTU=

data/lib/grabzit/client.rb

@@ -40,6 +40,8 @@ module GrabzIt
 		private_constant :TakeTable
 		TakePDF = "takepdf.ashx"
 		private_constant :TakePDF
+		TakeDOCX = "takedocx.ashx"
+		private_constant :TakeDOCX
 		TrueString = "True"
 		private_constant :TrueString
 		
@@ -185,6 +187,45 @@ module GrabzIt
 			html_to_pdf(read_html_file(path), options)
 		end		
 		
+		# This method specifies the URL that should be converted into a DOCX
+		#
+		# @param url [String] the URL to capture as a DOCX
+		# @param options [DOCXOptions, nil] a instance of the DOCXOptions class that defines any special options to use when creating the DOCX		
+		# @return [void]
+		def url_to_docx(url, options = nil)
+		
+			if options == nil
+				options = DOCXOptions.new()
+			end
+		
+			@request = Request.new(WebServicesBaseURLGet + TakeDOCX, false, options, url)
+			return nil			
+		end	
+		
+		# This method specifies the HTML that should be converted into a DOCX
+		#
+		# @param html [String] the HTML to convert into a DOCX
+		# @param options [DOCXOptions, nil] a instance of the DOCXOptions class that defines any special options to use when creating the DOCX
+		# @return [void]		
+		def html_to_docx(html, options = nil)		
+
+			if options == nil
+				options = DOCXOptions.new()
+			end
+		
+			@request = Request.new(WebServicesBaseURLPost + TakeDOCX, true, options, html)
+			return nil
+		end		
+
+		# This method specifies a HTML file that should be converted into a DOCX
+		#
+		# @param path [String] the file path of a HTML file to convert into a DOCX
+		# @param options [DOCXOptions, nil] a instance of the DOCXOptions class that defines any special options to use when creating the DOCX
+		# @return [void]		
+		def file_to_docx(path, options = nil)		
+			html_to_docx(read_html_file(path), options)
+		end			
+		
 		# Calls the GrabzIt web service to take the screenshot
 		#
 		# The handler will be passed a URL with the following query string parameters:

data/lib/grabzit/docxoptions.rb

@@ -0,0 +1,249 @@
+module GrabzIt
+	require File.join(File.dirname(__FILE__), 'baseoptions')
+	
+	# Represents all of the options available when creating a DOCX
+	# @version 3.1
+	# @author GrabzIt
+	class DOCXOptions < BaseOptions
+		def initialize()
+			@includeBackground = true
+			@pagesize = 'A4'
+			@orientation = 'Portrait'
+			@includeLinks = true
+			@includeImages = true
+			@title = nil
+			@marginTop = 10
+			@marginLeft = 10
+			@marginBottom = 10
+			@marginRight = 10
+			@requestAs = 0
+			@quality = -1
+			@hideElement = nil
+		end
+		
+		# @return [Boolean] true if the background images of the web page should be included in the DOCX
+		def includeBackground
+			@includeBackground
+		end
+		
+		# Set to true if the background images of the web page should be included in the DOCX
+		#
+		# @param value [Boolean] include background images
+		# @return [void]		
+		def includeBackground(value)
+			@includeBackground = value
+		end
+
+		# @return [String] the page size of the DOCX to be returned
+		def pagesize
+			@pagesize
+		end
+		
+		# Set the page size of the DOCX 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 DOCX to be returned
+		def orientation
+			@orientation
+		end
+		
+		# Set the orientation of the DOCX 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 DOCX
+		def includeLinks
+			@includeLinks
+		end
+		
+		# Set to true if links should be included in the DOCX
+		#
+		# @param value [Boolean] include links
+		# @return [void]		
+		def includeLinks(value)
+			@includeLinks = value
+		end		
+		
+		# @return [Boolean] true if web page images should be included
+		def includeImages
+			@includeImages
+		end
+		
+		# Set to true if web page images should be included
+		#
+		# @param value [Boolean] include images
+		# @return [void]		
+		def includeImages(value)
+			@includeImages = value
+		end	
+		
+		# @return [String] a title for the DOCX document
+		def title
+			@title
+		end
+		
+		# Set a title for the DOCX document
+		#
+		# @param value [String] DOCX title
+		# @return [void]		
+		def title(value)
+			@title = value
+		end	
+
+		# @return [Integer] the margin that should appear at the top of the DOCX document page
+		def marginTop
+			@marginTop
+		end
+		
+		# Set the margin that should appear at the top of the DOCX 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 DOCX document page
+		def marginLeft
+			@marginLeft
+		end
+		
+		# Set the margin that should appear at the left of the DOCX 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 DOCX document page
+		def marginBottom
+			@marginBottom
+		end
+		
+		# Set the margin that should appear at the bottom of the DOCX 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 DOCX document
+		def marginRight
+			@marginRight
+		end
+		
+		# Set the margin that should appear at the right of the DOCX 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 [Integer] the quality of the DOCX.
+		def quality
+			@quality
+		end
+		
+		# Set the quality of the DOCX 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
+		
+		# @return [String] get the CSS selector(s) of the one or more HTML elements in the web page to hide
+		def hideElement
+			@hideElement
+		end
+		
+		# Set the CSS selector(s) of the one or more HTML elements in the web page to hide
+		#
+		# @param value [String] the element(s) to hide
+		# @return [void]		
+		def hideElement(value)
+			@hideElement = 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.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)  
+		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['includelinks'] = GrabzIt::Utility.b_to_str(@includeLinks)
+			params['includeimages'] = GrabzIt::Utility.b_to_str(@includeImages)
+			params['title'] = GrabzIt::Utility.nil_check(@title)
+			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)
+			params['hide'] = GrabzIt::Utility.nil_check(@hideElement)
+			
+			return params;
+		end		
+	end
+end

data/lib/grabzit/exception.rb

@@ -63,6 +63,7 @@ module GrabzIt
 		PARAMETER_NO_HTML = 163
 		PARAMETER_INVALID_TARGET_VALUE = 165
 		PARAMETER_INVALID_HIDE_VALUE = 166
+		PARAMETER_INVALID_INCLUDE_IMAGES = 167
 		NETWORK_SERVER_OFFLINE = 200
 		NETWORK_GENERAL_ERROR = 201
 		NETWORK_DDOS_ATTACK = 202

data/lib/grabzit/pdfoptions.rb

@@ -78,6 +78,19 @@ module GrabzIt
 			@includeLinks = value
 		end		
 		
+		# @return [Boolean] true if the PDF outline should be included
+		def includeOutline
+			@includeOutline
+		end
+		
+		# Set to true if the PDF outline should be included
+		#
+		# @param value [Boolean] include links
+		# @return [void]		
+		def includeOutline(value)
+			@includeOutline = value
+		end			
+		
 		# @return [String] a title for the PDF document
 		def title
 			@title

data/test/test_grabzit.rb

@@ -213,6 +213,14 @@ class GrabzItTest < Test::Unit::TestCase
 		end	
 	end	
 	
+	def test_take_docx
+		assert_nothing_raised "An error occured when trying to take a docx screenshot" do
+			grabzItClient = GrabzIt::Client.new(@applicationKey, @applicationSecret)
+			grabzItClient.url_to_docx("http://www.google.com")
+			assert_not_nil(grabzItClient.save(), "Failed to take screenshot using url_to_docx method")
+		end	
+	end		
+	
 	def test_take_pdf_hide_popup
 		assert_nothing_raised "An error occured when trying to take a pdf screenshot" 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.0.4
+  version: 3.1.0
 platform: ruby
 authors:
 - GrabzIt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-24 00:00:00.000000000 Z
+date: 2017-05-26 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 take PDF or image screenshots of websites or convert HTML
-  to images or PDF's. 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 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.
 email: support@grabz.it
 executables: []
 extensions: []
@@ -40,6 +40,7 @@ files:
 - lib/grabzit/baseoptions.rb
 - lib/grabzit/client.rb
 - lib/grabzit/cookie.rb
+- lib/grabzit/docxoptions.rb
 - lib/grabzit/exception.rb
 - lib/grabzit/imageoptions.rb
 - lib/grabzit/pdfoptions.rb