grabzit 3.2.1 → 3.2.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDVhNGE1NWE2YmM0MjE5ZWI3MzA3YzlmMGU3NzAzYTM0MjRhMzA4Mw==
-  data.tar.gz: !binary |-
-    ZGVkMDlmZTNkODUyNjI4OWI0YzdiZGNmMDIyYjhkMWFmODU3MDg1ZA==
+SHA1:
+  metadata.gz: a2fab032ddbf0b70c9d7c235f51385c7c8d74740
+  data.tar.gz: a85040b9ffcd1bf88aa4c6949cb363128d9f163f
 SHA512:
-  metadata.gz: !binary |-
-    YTgwY2U4NzgzZTEwNTg4Mjg5ZmI2NTI3YzViZjEzYjg5MmRhMGEwOTFiNjQz
-    NjZkMWJkZTY5YmUyZjhmNDM0NmRiNGRhMzZjOWRmMmUxYWEzN2IzMGQwODQ2
-    ZjgzZmQ5NWY5MWQ0Y2RlM2I4ZDIwNDZmMmY0ZjQxZTQ4M2JkM2M=
-  data.tar.gz: !binary |-
-    MzEwYTIwZGI3YjA3ZmZhZDAzMDRhZWZmMWNiNWE1MTkxMzBkOGU2MmEyY2Nl
-    NTJlMGJkYTk2NDA3MGYxYjE2NmMyZTc4ODAyYTAyNDA2MTE0NjdkNjZiOTdj
-    ZTA5MmNiNmNlZDY1OWFiYWMwYWM0NDA0MjM2NmM1ZWRkZTY2ZmU=
+  metadata.gz: b74fd192d70be252a149e0056c2169eda80a6e24ef4bf7f52606e88a8e3243aeb29a4d5ca770f4c5720710b8dc4a9c8ea455a3b7745f3043e23c437257049e3d
+  data.tar.gz: 625c1b571df5b2f8bac75616c6ba13a61599075992d8b31960e6ab01d9b0e463657e6cf04234d5945a821d0b1075bf85a25a444d825629b3da858493982796f9

data/lib/grabzit/animationoptions.rb

@@ -165,7 +165,7 @@ module GrabzIt
 			GrabzIt::Utility.nil_float_check(@framesPerSecond)+"|"+GrabzIt::Utility.nil_float_check(@speed)+"|"+GrabzIt::Utility.nil_int_check(@duration)+
 			"|"+GrabzIt::Utility.nil_int_check(@repeat)+"|"+GrabzIt::Utility.b_to_str(@reverse)+"|"+GrabzIt::Utility.nil_int_check(@start)+
 			"|"+GrabzIt::Utility.nil_check(@customWaterMarkId)+"|"+GrabzIt::Utility.nil_check(@country)+"|"+GrabzIt::Utility.nil_int_check(@quality)+
-			"|"+GrabzIt::Utility.nil_check(@exportURL)
+			"|"+GrabzIt::Utility.nil_check(@exportURL)+"|"+GrabzIt::Utility.nil_check(@encryptionKey)
 		end		
 
 		# @!visibility private

data/lib/grabzit/baseoptions.rb

@@ -7,6 +7,7 @@ module GrabzIt
 			@customId = nil
 			@country = nil
 			@exportURL = nil
+			@encryptionKey = nil
 			@delay = nil
 		end	
 		
@@ -31,7 +32,7 @@ module GrabzIt
 		# Set the country the capture should be created from: Default = "", Singapore = "SG", UK = "UK", US = "US".
 		#
 		# @param value [String] the country to use
-		# @return [void]				
+		# @return [void]
 		def country(value)
 			@country = value
 		end
@@ -41,14 +42,27 @@ module GrabzIt
 			@exportURL
 		end
 
-		# Set the export URL that should be used to transfer the capture to a third party location
+		# Set the export URL that should be used to transfer the capture to a third party location.
 		#
 		# @param value [String] export URL to use
-		# @return [void]				
+		# @return [void]
 		def exportURL(value)
 			@exportURL = value
 		end
 		
+		# @return [String] the encryption key that will be used to encrypt your capture.
+		def encryptionKey
+			@encryptionKey
+		end
+
+		# Set the encryption key that will be used to encrypt your capture.
+		#
+		# @param value [String] encryption key to use
+		# @return [void]
+		def encryptionKey(value)
+			@encryptionKey = value
+		end		
+		
 		# @!visibility private
 		def startDelay
 			if @delay == nil
@@ -65,6 +79,7 @@ module GrabzIt
 			params['customid'] = GrabzIt::Utility.nil_check(@customId)
 			params['callback'] = GrabzIt::Utility.nil_check(callBackURL)
 			params['export'] = GrabzIt::Utility.nil_check(@exportURL)
+			params['encryption'] = GrabzIt::Utility.nil_check(@encryptionKey)
 			params['sig'] = sig
 			params[dataName] = GrabzIt::Utility.nil_check(dataValue)
 

data/lib/grabzit/client.rb

@@ -5,7 +5,9 @@ module GrabzIt
 	require 'digest/md5'
 	require 'net/http'
 	require 'rexml/document'
+	require 'base64'
 	require 'cgi'
+	require 'openssl'
 	require 'uri'
 	require File.join(File.dirname(__FILE__), 'utility')
 	require File.join(File.dirname(__FILE__), 'screenshotstatus')
@@ -15,7 +17,8 @@ module GrabzIt
 	require File.join(File.dirname(__FILE__), 'animationoptions')
 	require File.join(File.dirname(__FILE__), 'imageoptions')
 	require File.join(File.dirname(__FILE__), 'tableoptions')
-	require File.join(File.dirname(__FILE__), 'pdfoptions')	
+	require File.join(File.dirname(__FILE__), 'pdfoptions')
+	require File.join(File.dirname(__FILE__), 'docxoptions')
 	
 	# This client provides access to the GrabzIt web services
 	# This API allows you to take screenshot of websites for free and convert them into images, PDF's and tables.
@@ -107,7 +110,7 @@ module GrabzIt
 		# @param options [ImageOptions, nil] a instance of the ImageOptions class that defines any special options to use when creating the image
 		# @return [void]		
 		def file_to_image(path, options = nil)		
-			html_to_image(read_html_file(path), options)
+			html_to_image(read_file(path), options)
 		end
 		
 		# This method specifies the URL that the HTML tables should be extracted from
@@ -146,7 +149,7 @@ module GrabzIt
 		# @param options [TableOptions, nil] a instance of the TableOptions class that defines any special options to use when converting the HTML table
 		# @return [void]		
 		def file_to_table(path, options = nil)		
-			html_to_table(read_html_file(path), options)
+			html_to_table(read_file(path), options)
 		end		
 		
 		# This method specifies the URL that should be converted into a PDF
@@ -185,7 +188,7 @@ module GrabzIt
 		# @param options [PDFOptions, nil] a instance of the PDFOptions class that defines any special options to use when creating the PDF
 		# @return [void]		
 		def file_to_pdf(path, options = nil)		
-			html_to_pdf(read_html_file(path), options)
+			html_to_pdf(read_file(path), options)
 		end		
 		
 		# This method specifies the URL that should be converted into a DOCX
@@ -224,7 +227,7 @@ module GrabzIt
 		# @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)
+			html_to_docx(read_file(path), options)
 		end			
 		
 		# Calls the GrabzIt web service to take the screenshot
@@ -296,7 +299,7 @@ module GrabzIt
 
 					screenshot = File.new(saveToFile, "wb")
 					screenshot.write(result)
-					screenshot.close				
+					screenshot.close
 
 					break
 				end
@@ -515,6 +518,44 @@ module GrabzIt
 				@protocol = 'http'
 			end
 		end
+		
+		# This method creates a cryptographically secure encryption key to pass to the encryption key parameter.
+		#
+		# @return [String] a encryption key
+		def create_encryption_key()
+			Base64.strict_encode64(OpenSSL::Random.random_bytes(32));
+		end
+		
+		# This method will decrypt a encrypted capture file, using the key you passed to the encryption key parameter.
+		#
+		# @param path [String] the path of the encrypted capture
+		# @param key [String] the encryption key
+		def decrypt_file(path, key)
+			data = read_file(path)
+			decryptedFile = File.new(path, "wb")
+			decryptedFile.write(decrypt(data, key))
+			decryptedFile.close
+		end
+
+		# This method will decrypt a encrypted capture, using the key you passed to the encryption key parameter.
+		#
+		# @param path [String] the encrypted bytes
+		# @param key [String] the encryption key
+		# @return [Array<Byte>] an array of decrypted bytes
+		def decrypt(data, key)
+			if data == nil
+				return nil
+			end
+			iv = data[0..15]
+			payload = data[16..-1]
+			cipher = OpenSSL::Cipher::Cipher.new("aes-256-cbc")
+			cipher.padding = 0
+			cipher.key = Base64.strict_decode64(key);
+			cipher.iv = iv
+			decrypted = cipher.update(payload);
+			decrypted << cipher.final();
+			return decrypted
+		end
 
 		private
 		def get_watermarks(identifier = nil)
@@ -568,7 +609,7 @@ module GrabzIt
 		
 		private
 		def check_for_exception(doc)
-			if (doc == nil)
+			if doc == nil
 				return
 			end
 			
@@ -586,13 +627,13 @@ module GrabzIt
 		end
 
 		private
-		def read_html_file(path)
+		def read_file(path)
 			if !File.file?(path)
 				raise "File: " + path + " does not exist"
 			end
 
 			file = File.open(path, "rb")
-			return file.read			
+			return file.read
 		end
 		
 		private 

data/lib/grabzit/docxoptions.rb

@@ -236,7 +236,7 @@ module GrabzIt
 			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_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)      
 		end
 		
 		# @!visibility private

data/lib/grabzit/exception.rb

@@ -67,6 +67,7 @@ module GrabzIt
 		PARAMETER_INVALID_EXPORT_URL = 168
 		PARAMETER_INVALID_WAIT_FOR_VALUE = 169
 		PARAMETER_INVALID_TRANSPARENT_VALUE = 170
+		PARAMETER_INVALID_ENCRYPTION_KEY = 171
 		NETWORK_SERVER_OFFLINE = 200
 		NETWORK_GENERAL_ERROR = 201
 		NETWORK_DDOS_ATTACK = 202

data/lib/grabzit/imageoptions.rb

@@ -204,7 +204,7 @@ module GrabzIt
 			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)+"|"+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(@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)
 		end
 	
 		# @!visibility private

data/lib/grabzit/pdfoptions.rb

@@ -292,7 +292,7 @@ module GrabzIt
 			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_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)  
 		end
 		
 		# @!visibility private

data/lib/grabzit/tableoptions.rb

@@ -107,7 +107,8 @@ module GrabzIt
 			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)+"|"+GrabzIt::Utility.nil_check(@exportURL)
+			GrabzIt::Utility.nil_int_check(@requestAs)+"|"+GrabzIt::Utility.nil_check(@country)+"|"+GrabzIt::Utility.nil_check(@exportURL)+"|"+
+			GrabzIt::Utility.nil_check(@encryptionKey)
 		end
 
 		# @!visibility private

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: grabzit
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.2
 platform: ruby
 authors:
 - GrabzIt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-04 00:00:00.000000000 Z
+date: 2017-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Use GrabzIt to convert HTML or URL's into images, PDF or DOCX documents.
@@ -61,17 +61,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: GrabzIt Ruby Client