browshot 1.14.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51442cd950b03b0460cc2688dc05836ee21988a5
-  data.tar.gz: 8beba4478dc66aa0723ee3a1511dba76d9b51f5c
+  metadata.gz: b028681c4d0960152ecc9202204806a51fe50c46
+  data.tar.gz: 40fd0ccc8878200afe4f52d56c1d275f8a446d2f
 SHA512:
-  metadata.gz: 547ad76a3d2ab3f6d12df58b6fb33c0f4587e8f4d8c9621f347eb699f594b4fbf3bfcece97f10de75360279d606a20ad7058a96ecdce3503fb94710e887a2ffd
-  data.tar.gz: 008bf622b3d388335f9c4e590264154d1bb3c9e755696c86599c14f564b2fa265535540417edf6da8ee8b6ddab4f4eab9c05784269e12ed63885d61330934e4f
+  metadata.gz: c05b5fb8570efe864ec45acb4afb0d9c73aaac3dcfdc5b06ad8241e9e26df40eda540b4d7800748156a478aacfc92b7e0154b2a5715aedfeeb1e78d8a9544326
+  data.tar.gz: 19cdc44a170a87d70cbddba7141102ee2c957aca6946506de600a403018626508959d4a77978711a34999fbfab2afff965bf0ac812546fa4c27f8045fc99738a

data/Gemfile

@@ -4,3 +4,6 @@ source "http://rubygems.org"
 gem "json", ">= 0"
 gem "url", ">= 0"
 
+group :test do
+  gem 'shoulda'
+end

data/Rakefile

@@ -5,4 +5,14 @@ Rake::TestTask.new do |t|
 end
 
 desc "Run tests"
-task :default => :test
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "browshot #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/browshot.rb

@@ -5,7 +5,7 @@
 # and this library.
 #
 # @author    Julien Sobrier  (mailto:jsobrier@browshot.com)
-# Copyright:: Copyright (c) 2013 Browshot
+# Copyright:: Copyright (c) 2016 Browshot
 # License::   Distributes under the same terms as Ruby
 
 require 'rubygems'
@@ -13,6 +13,7 @@ require 'url'
 require 'json'
 require 'net/http'
 require 'net/https'
+require "cgi"
 
 class Browshot
 	# @!attribute [r]
@@ -28,17 +29,17 @@ class Browshot
 	# New client
 	#
 	# @param key [String] API key
-	# @param base [String] Base URL for all API requests. You should use the default base provided by the library. Be careful if you decide to use HTTP instead of HTTPS as your API key could be sniffed and your account could be used without your consent.
 	# @param debug [Boolean] Set to true to print debug output to the standard output. false (disabled) by default.
-	def initialize(key='', base='https://api.browshot.com/api/v1/', debug=false)
+	# @param base [String] Base URL for all API requests. You should use the default base provided by the library. Be careful if you decide to use HTTP instead of HTTPS as your API key could be sniffed and your account could be used without your consent.
+	def initialize(key='', debug=false, base='https://api.browshot.com/api/v1/')
 		@key = key || ''
-		@base = base || 'http://127.0.0.1:3000/api/v1/'
+		@base = base || 'https://api.browshot.com/api/v1/'
 		@debug = debug || false
 	end
 
 	# Return the API version handled by the library. Note that this library can usually handle new arguments in requests without requiring an update.
 	def api_version()
-		return "1.14"
+		return "1.16"
 	end
 
     # Retrieve a screenshot with one call. See {https://browshot.com/api/documentation#simple} for the full list of possible arguments.
@@ -87,10 +88,6 @@ class Browshot
 		return return_reply('instance/info', { 'id' => id })
 	end
 
-	# Create a private instance. See http://browshot.com/api/documentation#instance_create for the response format.
-	def instance_create(parameters={})
-		return return_reply('instance/create', parameters)
-	end
 
 	# Return the list of browsers. See http://browshot.com/api/documentation#browser_list for the response format.
 	def browser_list()
@@ -104,10 +101,6 @@ class Browshot
 		return return_reply('browser/info', { 'id' => id })
 	end
 
-	# Create a custom browser. See http://browshot.com/api/documentation#browser_create for the response format.
-	def browser_create(parameters={})
-		return return_reply('browser/create', parameters)
-	end
 
 	# Request a screenshot. See http://browshot.com/api/documentation#screenshot_create for the response format.
 	#
@@ -221,11 +214,7 @@ class Browshot
 	# Request multiple screenshots. See http://browshot.com/api/documentation#screenshot_multiple for the response format.
 	#
 	# See http://browshot.com/api/documentation#screenshot_multiple for the full list of possible arguments.
-	# 
-	# @param url [String] URL of the website to create a screenshot of
-	def screenshot_multiple(url='', parameters={})
-		parameters[:url] = url
-
+	def screenshot_multiple(parameters={})
 		return return_reply('screenshot/multiple', parameters)
 	end
 	
@@ -236,7 +225,7 @@ class Browshot
 	# @param id [Integer] Instance ID
 	# @param file [String] Path to the text file which contains the list of URLs
 	def batch_create(id=0, file='', parameters={})
-		parameters[:id] = id
+		parameters[:instance_id] = id
 		parameters[:file] = file
 
 		return return_post_reply('batch/create', parameters)
@@ -262,11 +251,21 @@ class Browshot
 	private
 
 	def make_url(action='', parameters={})
-		url =  URL.new("#{@base}#{action}?key=#{@key}")
+		url =  "#{@base}#{action}?key=#{@key}"
 		
 		
 		parameters.each_pair do |key, value|
-			url.params[key] = value
+			if (key == 'urls')
+				value.each { |val|
+				  url += '&url=' + CGI::escape(val.to_s)
+				}
+			elsif (key == 'instances')
+				value.each { |instance|
+				  url += '&instance_id=' + CGI::escape(instance.to_s)
+				}
+			else
+				url += "&#{key}=" + CGI::escape(value.to_s)
+			end
 		end
 
 		puts "#{url}" if (@debug)
@@ -302,9 +301,9 @@ class Browshot
 		begin
 			url = make_url(action, parameters)
 			
-			response = url.get
+			response = Net::HTTP.get_response(URI(url))
 
-			if (response.success? == false)
+			if (response.code == 200)
 				puts "Error from #{url}: #{response.code}" if (@debug)
 			end
 			return response.response.body
@@ -320,7 +319,7 @@ class Browshot
 			parameters.delete(:file)
 			url = make_url(action, parameters)
 			
-			response = post(url.to_s,file)
+			response = post(url,file)
 
 			case response
 			  when Net::HTTPSuccess     then 

data/test/helper.rb

@@ -1,5 +1,7 @@
 require 'rubygems'
+require 'shoulda'
 require 'bundler'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -7,8 +9,10 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
+
+require 'rubygems'
 require 'test/unit'
-require 'shoulda'
+# require 'shoulda'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_browshot.rb

@@ -14,7 +14,7 @@ class TestBrowshot < Test::Unit::TestCase
     end
 
     should "get the API version" do
-      assert_equal '1.14', @browshot.api_version()
+      assert_equal '1.16', @browshot.api_version()
     end
 
     should "get a screenshot with the simple method" do
@@ -32,17 +32,17 @@ class TestBrowshot < Test::Unit::TestCase
     should "get the list of instances available" do
 #       assert_equal 10, @calculator.product(2, 5)
 	  instances = @browshot.instance_list()
-	  assert_equal false, instances['free'].nil?,				"List of free instances is missing"
-	  assert_equal true,  instances['free'].kind_of?(Array),	"List of free instances is incorrect"
-	  assert_equal true,  instances['free'].length > 0,			"There should be at least 1 free instance"
+	  assert_equal false, instances['free'].nil?,					"List of free instances is missing"
+	  assert_equal true,  instances['free'].kind_of?(Array),			"List of free instances is incorrect"
+	  assert_equal true,  instances['free'].length > 0,				"There should be at least 1 free instance"
 
-	  assert_equal false, instances['shared'].nil?,				"List of shared instances is missing"
-	  assert_equal true,  instances['shared'].kind_of?(Array),	"List of shared instances is incorrect"
-	  assert_equal true,  instances['shared'].length > 0,		"There should be at least 1 shared instance"
+	  assert_equal false, instances['shared'].nil?,					"List of shared instances is missing"
+	  assert_equal true,  instances['shared'].kind_of?(Array),			"List of shared instances is incorrect"
+	  assert_equal true,  instances['shared'].length > 0,				"There should be at least 1 shared instance"
 
-	  assert_equal false, instances['private'].nil?,			"List of private instances is missing"
-	  assert_equal true,  instances['private'].kind_of?(Array),	"List of private instances is incorrect"
-	  assert_equal true,  instances['private'].length == 0,		"There should be at least no private instance"
+	  assert_equal false, instances['private'].nil?,				"List of private instances is missing"
+	  assert_equal true,  instances['private'].kind_of?(Array),			"List of private instances is incorrect"
+	  assert_equal true,  instances['private'].length == 1,				"There should be at least no private instance"
 
 	  free = instances['free'][0]
 	  assert_equal false, free['id'].nil?,						"Missing instance ID"
@@ -50,14 +50,14 @@ class TestBrowshot < Test::Unit::TestCase
 	  assert_equal false, free['height'].nil?,					"Missing instance screen height"
 	  assert_equal false, free['load'].nil?,					"Missing instance load"
 	  assert_equal false, free['browser'].nil?,					"Missing instance browser"
-	  assert_equal false, free['browser']['id'].nil?,			"Missing instance browser ID"
-	  assert_equal false, free['browser']['name'].nil?,			"Missing instance browser name"
-	  assert_equal false, free['browser']['javascript'].nil?,	"Missing instance browser javascript capability"
-	  assert_equal false, free['browser']['flash'].nil?,		"Missing instance browser flash capability"
-	  assert_equal false, free['browser']['mobile'].nil?,		"Missing instance browser mobile capability"
+	  assert_equal false, free['browser']['id'].nil?,				"Missing instance browser ID"
+	  assert_equal false, free['browser']['name'].nil?,				"Missing instance browser name"
+	  assert_equal false, free['browser']['javascript'].nil?,			"Missing instance browser javascript capability"
+	  assert_equal false, free['browser']['flash'].nil?,				"Missing instance browser flash capability"
+	  assert_equal false, free['browser']['mobile'].nil?,				"Missing instance browser mobile capability"
 	  assert_equal false, free['type'].nil?,					"Missing instance type"
-	  assert_equal false, free['screenshot_cost'].nil?,			"Missing instance cost"
-	  assert_equal 0,     free['screenshot_cost'].to_i,			"Cost should be 0"
+	  assert_equal false, free['screenshot_cost'].nil?,				"Missing instance cost"
+	  assert_equal 0,     free['screenshot_cost'].to_i,				"Cost should be 0"
     end
 
     should "get an instance information" do
@@ -65,17 +65,17 @@ class TestBrowshot < Test::Unit::TestCase
 	  free = instances['free'][0]
 
 	  instance = @browshot.instance_info(free['id'])
-	  assert_equal free['id'], instance['id'],										"Mismatch instance ID"
-	  assert_equal free['width'], instance['width'],								"Mismatch instance screen width"
-	  assert_equal free['height'], instance['height'],								"Mismatch instance screen height"
-# 	  assert_equal free['load'], instance['load'],									"Mismatch instance load"
-	  assert_equal free['browser']['id'], instance['browser']['id'],				"Mismatch instance browser ID"
-	  assert_equal free['browser']['name'], instance['browser']['name'],			"Mismatch instance browser name"
+	  assert_equal free['id'], instance['id'],					"Mismatch instance ID"
+	  assert_equal free['width'], instance['width'],				"Mismatch instance screen width"
+	  assert_equal free['height'], instance['height'],				"Mismatch instance screen height"
+# 	  assert_equal free['load'], instance['load'],					"Mismatch instance load"
+	  assert_equal free['browser']['id'], instance['browser']['id'],		"Mismatch instance browser ID"
+	  assert_equal free['browser']['name'], instance['browser']['name'],		"Mismatch instance browser name"
 	  assert_equal free['browser']['javascript'], instance['browser']['javascript'],"Mismatch instance browser javascript capability"
-	  assert_equal free['browser']['flash'], instance['browser']['flash'],			"Mismatch instance browser flash capability"
-	  assert_equal free['browser']['mobile'], instance['browser']['mobile'],		"Mismatch instance browser mobile capability"
-	  assert_equal free['type'], instance['type'],									"Mismatch instance type"
-	  assert_equal free['screenshot_cost'], instance['screenshot_cost'],			"Mismatch instance cost"
+	  assert_equal free['browser']['flash'], instance['browser']['flash'],		"Mismatch instance browser flash capability"
+	  assert_equal free['browser']['mobile'].to_i, instance['browser']['mobile'].to_i,	"Mismatch instance browser mobile capability"
+	  assert_equal free['type'], instance['type'],					"Mismatch instance type"
+	  assert_equal free['screenshot_cost'].to_i, instance['screenshot_cost'].to_i,		"Mismatch instance cost"
     end
 
     should "send an error for the wrong instance ID" do
@@ -85,29 +85,29 @@ class TestBrowshot < Test::Unit::TestCase
  	  assert_equal false, instance['status'].nil?,					"Instance should not be found"
     end
 
-    should "send an errror when creating a instance with ivalid arguments" do
-	  instance = @browshot.instance_create({'width' => 3000})
- 	  assert_equal false, instance['error'].nil?,					"Instance width should be too large"
-
-	  instance = @browshot.instance_create({'height' => 3000})
- 	  assert_equal false, instance['error'].nil?,					"Instance width should be too large"
-
-	  instance = @browshot.instance_create({'browser_id' => -1})
- 	  assert_equal false, instance['error'].nil?,					"Instance browser ID should be invalid"
-    end
+#     should "send an errror when creating a instance with ivalid arguments" do
+# 	  instance = @browshot.instance_create({'width' => 3000})
+#  	  assert_equal false, instance['error'].nil?,					"Instance width should be too large"
+# 
+# 	  instance = @browshot.instance_create({'height' => 3000})
+#  	  assert_equal false, instance['error'].nil?,					"Instance width should be too large"
+# 
+# 	  instance = @browshot.instance_create({'browser_id' => -1})
+#  	  assert_equal false, instance['error'].nil?,					"Instance browser ID should be invalid"
+#     end
 
-    should "create a new instance" do
-# 	  Option disabled for most accounts
-	  instance = @browshot.instance_create()
-
-	  assert_equal false, instance['error'].nil?,					"Instance cannot be created for this account"
-# 	  assert_equal false, instance['id'].nil?,						"Instance ID should be present"
-# 	  assert_equal false, instance['width'].nil?,					"Instance screen width should be present"
-# 	  assert_equal false, instance['height'].nil?,					"Instance screen height should be present"
-# 	  assert_equal 1, 	  instance['active'].to_i,					"Instance should be active"
-# 	  assert_equal false, instance['browser'].nil?,					"Instance browser should be present"
-# 	  assert_equal false, instance['browser']['id'].nil?,			"Instance browser ID should be present"
-    end
+#     should "create a new instance" do
+# # 	  Option disabled for most accounts
+# 	  instance = @browshot.instance_create()
+# 
+# 	  assert_equal false, instance['error'].nil?,					"Instance cannot be created for this account"
+# # 	  assert_equal false, instance['id'].nil?,						"Instance ID should be present"
+# # 	  assert_equal false, instance['width'].nil?,					"Instance screen width should be present"
+# # 	  assert_equal false, instance['height'].nil?,					"Instance screen height should be present"
+# # 	  assert_equal 1, 	  instance['active'].to_i,					"Instance should be active"
+# # 	  assert_equal false, instance['browser'].nil?,					"Instance browser should be present"
+# # 	  assert_equal false, instance['browser']['id'].nil?,			"Instance browser ID should be present"
+#     end
 
     should "get the list of browsers" do
 	  browsers = @browshot.browser_list()
@@ -135,23 +135,23 @@ class TestBrowshot < Test::Unit::TestCase
 	  assert_equal false, browser['flash'].nil?,					"Browser flash capability should be present"
     end
 
-    should "create a browser" do
-	  # Option disabled for most accounts
-	  browser = @browshot.browser_create({'mobile' => 1, 'flash' => 1, 'user_agent' => 'test'})
-
-	  assert_equal false, browser['error'].nil?,					"Browser cannot be created for this account"
-# 	  assert_equal false, browser['name'].nil?,						"Browser name should be present"
-# 	  assert_equal false, browser['user_agent'].nil?,				"Browser user_agent should be present"
-# 	  assert_equal false, browser['appname'].nil?,					"Browser appname should be present"
-# 	  assert_equal false, browser['vendorsub'].nil?,				"Browser vendorsub should be present"
-# 	  assert_equal false, browser['appcodename'].nil?,				"Browser appcodename should be present"
-# 	  assert_equal false, browser['platform'].nil?,					"Browser platform should be present"
-# 	  assert_equal false, browser['vendor'].nil?,					"Browser vendor should be present"
-# 	  assert_equal false, browser['appversion'].nil?,				"Browser appversion should be present"
-# 	  assert_equal false, browser['javascript'].nil?,				"Browser javascript capability should be present"
-# 	  assert_equal false, browser['mobile'].nil?,					"Browser mobile capability should be present"
-# 	  assert_equal false, browser['flash'].nil?,					"Browser flash capability should be present"
-    end
+#     should "create a browser" do
+# 	  # Option disabled for most accounts
+# 	  browser = @browshot.browser_create({'mobile' => 1, 'flash' => 1, 'user_agent' => 'test'})
+# 
+# 	  assert_equal false, browser['error'].nil?,					"Browser cannot be created for this account"
+# # 	  assert_equal false, browser['name'].nil?,						"Browser name should be present"
+# # 	  assert_equal false, browser['user_agent'].nil?,				"Browser user_agent should be present"
+# # 	  assert_equal false, browser['appname'].nil?,					"Browser appname should be present"
+# # 	  assert_equal false, browser['vendorsub'].nil?,				"Browser vendorsub should be present"
+# # 	  assert_equal false, browser['appcodename'].nil?,				"Browser appcodename should be present"
+# # 	  assert_equal false, browser['platform'].nil?,					"Browser platform should be present"
+# # 	  assert_equal false, browser['vendor'].nil?,					"Browser vendor should be present"
+# # 	  assert_equal false, browser['appversion'].nil?,				"Browser appversion should be present"
+# # 	  assert_equal false, browser['javascript'].nil?,				"Browser javascript capability should be present"
+# # 	  assert_equal false, browser['mobile'].nil?,					"Browser mobile capability should be present"
+# # 	  assert_equal false, browser['flash'].nil?,					"Browser flash capability should be present"
+#     end
 
     should "fail to create screenshot" do
 	  screenshot = @browshot.screenshot_create()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: browshot
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Julien Sobrier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-20 00:00:00.000000000 Z
+date: 2016-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -125,11 +125,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Take website screenshtos with Browshot
+summary: Take website screenshots with Browshot
 test_files:
 - test/helper.rb
 - test/test_browshot.rb
-has_rdoc: