grabzit 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e46954d4956663d54e9e74b16b56779f9a608d05
-  data.tar.gz: 92f87a1e2f4fd45ba920157ad47035373762450f
+  metadata.gz: 17e5e690195e3db9e04ddb68b01c8452d9e78ef9
+  data.tar.gz: 62c853dc8b70e06b8037839cad0d49ff0b22b304
 SHA512:
-  metadata.gz: f34f12ce5d2c01b566e12e6bff84b1d646815aca85df286ec9d92581c71db624d3a550cee2dc46f37d1d557f3b85ad118d5e113039a19ab17d08af1c2904790f
-  data.tar.gz: 1e6d7037338e53771e1c885e007efaceaba3d60b55b47d29fc289af76d1a9ffec0a2762f3c7d6fe898e48f5fb48050fec2acb14c65fd33a68c2b3e87981710de
+  metadata.gz: f4504960048214f2855de361bf232b0910ec25b728e6d230392444cda73cf035dc38f3ec85293346ed2f6be0f84659ed5bd78744dbdb5247d560463a081e5e6f
+  data.tar.gz: 82b9b8811d5606238ffbeb4b5ae128856f6a7c9f7a02c9be3c0925e679dd31f470b41eb556efe7b7d59a9b29cb93e0274b4a7aa3a3ef08e6abdc5e4eb475fc4b

data/lib/grabzit/client.rb

@@ -25,7 +25,7 @@ module GrabzIt
 	# @see http://grabz.it/api/ruby/ GrabzIt Ruby API
 	class Client
 
-		WebServicesBaseURL = "http://grabz.it/services/"
+		WebServicesBaseURL = "http://api.grabz.it/services/"
 		private_constant :WebServicesBaseURL	
 		TrueString = "True"
 		private_constant :TrueString
@@ -45,10 +45,35 @@ module GrabzIt
 			@applicationSecret = applicationSecret
 		end
 
+		# This method sets the parameters required to turn a online video into a animated GIF
+		#
+		# @param url [String] the URL of the online video
+		# @param customId [String, nil] custom identifier that you can pass through to the animated GIF web service. This will be returned with the callback URL you have specified
+		# @param width [Integer, 0] the width of the resulting animated GIF in pixels
+		# @param height [Integer, 0] the height of the resulting animated GIF in pixels
+		# @param start [Integer, 0] the starting position of the video that should be converted into a animated GIF
+		# @param duration [Integer, 0] the length in seconds of the video that should be converted into a animated GIF
+		# @param speed [Float, 0] the speed of the animated GIF from 0.2 to 10 times the original speed
+		# @param framesPerSecond [Float, 0] the number of frames per second that should be captured from the video. From a minimum of 0.2 to a maximum of 60
+		# @param repeat [Integer, 0] the number of times to loop the animated GIF. If 0 it will loop forever
+		# @param reverse [Boolean, false] if true the frames of the animated GIF are reversed
+		# @param customWaterMarkId [String, nil] add a custom watermark to the animated GIF
+		# @param quality [Integer, -1] the quality of the image where 0 is poor and 100 excellent. The default is -1 which uses the recommended quality
+		# @param country [String, nil] request the screenshot from different countries: Default, UK or US
+		# @return [void]		
+		def set_animation_options(url, customId = nil, width = 0, height = 0, start = 0, duration = 0, speed = 0, framesPerSecond = 0, repeat = 0, reverse = false, customWaterMarkId = nil, quality = -1, country = nil)
+			@@startDelay = 0;
+			@@request = WebServicesBaseURL + "takeanimation.ashx?key=" + CGI.escape(nil_check(@applicationKey))+"&url="+CGI.escape(nil_check(url))+"&width="+nil_int_check(width)+"&height="+nil_int_check(height)+"&duration="+nil_int_check(duration)+"&speed="+nil_float_check(speed)+"&start="+nil_int_check(start)+"&customid="+CGI.escape(nil_check(customId))+"&fps="+nil_float_check(framesPerSecond)+"&repeat="+nil_int_check(repeat)+"&customwatermarkid="+CGI.escape(nil_check(customWaterMarkId))+"&reverse="+b_to_str(reverse)+"&country="+CGI.escape(nil_check(country))+"&quality="+nil_int_check(quality)+"&callback="			
+			@@signaturePartOne = @applicationSecret+"|"+nil_check(url)+"|"
+			@@signaturePartTwo = "|"+nil_int_check(height)+"|"+nil_int_check(width)+"|"+nil_check(customId)+"|"+nil_float_check(framesPerSecond)+"|"+nil_float_check(speed)+"|"+nil_int_check(duration)+"|"+nil_int_check(repeat)+"|"+b_to_str(reverse)+"|"+nil_int_check(start)+"|"+nil_check(customWaterMarkId)+"|"+nil_check(country)+"|"+nil_int_check(quality)
+			return nil
+		end
+
+
 		# Sets the parameters required to take a screenshot of a web page.
 		#
 		# @param url [String] the URL that the screenshot should be made of
-		# @param customId [String, nil] custom identifier that you can pass through to the screenshot webservice. This will be returned with the callback URL you have specified.	
+		# @param customId [String, nil] custom identifier that you can pass through to the screenshot web service. This will be returned with the callback URL you have specified.	
 		# @param browserWidth [Integer, nil] the width of the browser in pixels
 		# @param browserHeight [Integer, nil] the height of the browser in pixels
 		# @param width [Integer, nil] the width of the resulting thumbnail in pixels
@@ -79,11 +104,11 @@ module GrabzIt
 		# Sets the parameters required to extract one or more tables from a web page.
 		#
 		# @param url [String] the URL that the should be used to extract tables
-		# @param customId [String, nil] a custom identifier that you can pass through to the webservice. This will be returned with the callback URL you have specified.	
+		# @param customId [String, nil] a custom identifier that you can pass through to the web service. This will be returned with the callback URL you have specified.	
 		# @param tableNumberToInclude [Integer, 1] 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 format [String, 'csv'] the format the table should be in: csv, xlsx
 		# @param includeHeaderNames [Boolean, true] if true header names will be included in the table
-		# @param includeAllTables [Boolean, true] if true all table on the web page will be extracted with each table appearing in a seperate spreadsheet sheet. Only available with the XLSX format.
+		# @param includeAllTables [Boolean, true] if true all table on the web page will be extracted with each table appearing in a separate spreadsheet sheet. Only available with the XLSX format.
 		# @param targetElement [String, nil] the id of the only HTML element in the web page that should be used to extract tables from
 		# @param requestAs [Integer, 0] request the screenshot in different forms: Standard Browser = 0, Mobile Browser = 1, Search Engine = 2 and Fallback Browser = 3
 		# @param country [String, nil] request the screenshot from different countries: Default = "", UK = "UK", US = "US"		
@@ -101,7 +126,7 @@ module GrabzIt
 		# Sets the parameters required to convert a web page into a PDF.
 		#
 		# @param url url [String] the URL that the should be converted into a pdf
-		# @param customId [String, nil] a custom identifier that you can pass through to the webservice. This will be returned with the callback URL you have specified.
+		# @param customId [String, nil] a custom identifier that you can pass through to the web service. This will be returned with the callback URL you have specified.
 		# @param includeBackground [Boolean, true] if true the background of the web page should be included in the screenshot
 		# @param pagesize [String, 'A4'] the page size of the PDF to be returned: 'A3', 'A4', 'A5', 'B3', 'B4', 'B5', 'Letter'.
 		# @param orientation [String, 'Portrait'] the orientation of the PDF to be returned: 'Landscape' or 'Portrait'
@@ -240,6 +265,10 @@ module GrabzIt
 		# @return [Object] returns the screenshot
 		# @raise [RuntimeError] if the GrabzIt service reports an error with the request it will be raised as a RuntimeError
 		def get_result(id)
+			if id == nil || id == ""
+				return nil
+			end
+			
 			return get(WebServicesBaseURL + "getfile.ashx?id=" + nil_check(id))
 		end
 
@@ -344,7 +373,7 @@ module GrabzIt
 
 			boundary = '--------------------------'+Time.now.to_f.to_s
 
-			url = WebServicesBaseURL + "addwatermark.ashx"
+			url = "http://grabz.it/services/addwatermark.ashx"
 			uri = URI.parse(url)
 
 			file = File.open(path, "rb")
@@ -510,6 +539,16 @@ module GrabzIt
 		def nil_int_check(param)
 			return param.to_i.to_s
 		end
+
+		private
+		def nil_float_check(param)
+			val = param.to_f
+			if ((val % 1) == 0)
+				return val.to_i.to_s
+			end
+			
+			return val.to_s
+		end
 		
 		private
 		def check_for_exception(doc)

data/lib/grabzit/exception.rb

@@ -51,6 +51,15 @@ module GrabzIt
 		PARAMETER_MISSING_PARAMETERS = 143
 		PARAMETER_QUALITY_TOO_LARGE = 144
 		PARAMETER_QUALITY_TOO_SMALL = 145
+		PARAMETER_REPEAT_TOO_SMALL = 149
+		PARAMETER_INVALID_REVERSE = 150
+		PARAMETER_FPS_TOO_LARGE = 151
+		PARAMETER_FPS_TOO_SMALL = 152
+		PARAMETER_SPEED_TOO_FAST = 153
+		PARAMETER_SPEED_TOO_SLOW = 154
+		PARAMETER_INVALID_ANIMATION_COMBINATION = 155
+		PARAMETER_START_TOO_SMALL = 156
+		PARAMETER_DURATION_TOO_LARGE = 157				
 		NETWORK_SERVER_OFFLINE = 200
 		NETWORK_GENERAL_ERROR = 201
 		NETWORK_DDOS_ATTACK = 202

data/test/test_grabzit.rb

@@ -9,10 +9,10 @@ class GrabzItTest < Test::Unit::TestCase
 	Screenshot_Path = "test/tmp.jpg"
 
 	def setup
-		@applicationKey = ""
-		@applicationSecret = ""
+		@applicationKey = "c3VwcG9ydEBncmFiei5pdA=="
+		@applicationSecret = "AD8/aT8/Pz8/Tz8/PwJ3Pz9sVSs/Pz8/Pz9DOzJodoi="
 		#Set to true if the account is subscribed
-		@isSubscribedAccount = false
+		@isSubscribedAccount = true
 	end
 	
 	def test_application_key
@@ -58,6 +58,14 @@ class GrabzItTest < Test::Unit::TestCase
 		File.delete(Screenshot_Path)
 	end
 	
+	def test_save_animation
+		assert_nothing_raised "An error occured when trying to take a animation" do
+			grabzItClient = GrabzIt::Client.new(@applicationKey, @applicationSecret)
+			grabzItClient.set_animation_options("http://www.youtube.com");
+			assert_not_equal(false, grabzItClient.save(), "Animation not taken")
+		end
+	end	
+	
 	def test_save_to_bytes
 		assert_nothing_raised "An error occured when trying to take a image screenshot" do
 			grabzItClient = GrabzIt::Client.new(@applicationKey, @applicationSecret)
@@ -90,7 +98,9 @@ class GrabzItTest < Test::Unit::TestCase
 				  grabzItClient.set_cookie(Cookie_Name, Cookie_Domain)				  
 				end		
 				return
-			end			
+			end
+			
+			sleep(4)
 
 			assert(find_cookie(grabzItClient), "Set cookie has not been found!")
 		end	
@@ -108,10 +118,14 @@ class GrabzItTest < Test::Unit::TestCase
 				return
 			end			
 			
+			sleep(4)
+			
 			assert_equal(true, find_cookie(grabzItClient), "Test cookie not found!")
 			
 			grabzItClient.delete_cookie(Cookie_Name, Cookie_Domain)
 
+			sleep(4)
+
 			assert_equal(false, find_cookie(grabzItClient), "Failed to delete cookie!")
 		end	
 	end		
@@ -133,10 +147,14 @@ class GrabzItTest < Test::Unit::TestCase
 				return
 			end			
 			
+			sleep(5)
+			
 			assert_equal(true, find_watermark(grabzItClient), "Test watermark not found!")
 			
 			grabzItClient.delete_watermark(WaterMark_Identifier)
 
+			sleep(5)
+
 			assert_equal(false, find_watermark(grabzItClient), "Failed to delete watermark!")
 		end	
 	end
@@ -155,7 +173,9 @@ class GrabzItTest < Test::Unit::TestCase
 				  grabzItClient.add_watermark(WaterMark_Identifier, WaterMark_Path, 2, 2)				  
 				end		
 				return
-			end			
+			end
+			
+			sleep(4)
 
 			assert(find_watermark(grabzItClient), "Set watermark has not been found!")
 		end	

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grabzit
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - GrabzIt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -26,7 +26,8 @@ dependencies:
         version: '0'
 description: 'Automatically create screenshots of website for free, with GrabzIt.
   Screenshots can be output in a variety of formats including: JPEG, PNG, TIFF, BMP,
-  PDF, CSV and XLSX.'
+  PDF, CSV and XLSX. Additionally GrabzIt allows you to convert online videos into
+  animated GIF''s.'
 email: support@grabz.it
 executables: []
 extensions: []