thumbalizr 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 061c7b5cea1fb9702f9dd4bece06025aa92ab5515cb23cbef6733b414b5e89bd
+  data.tar.gz: 4f44936ae4da2f261c86549d55c1f61315d8ccd32f10177465c594b2733d8160
+SHA512:
+  metadata.gz: 403fac924cfe6a6c70ff61db427babd956263ac39d0e4637a7b567b81c0f8c848f7ea10249cc2ecee02154f5957df1d920504dac4ab140a8bdbe6a931c562eb2
+  data.tar.gz: 8f5f3d62e0023a2562c3dfe391403be00f79c556257cef2d2a2e575ba0ba6ec59eda87ebba528904d38512e46dabf5ff6ee5453b214eb3f90562f36eb63638ba

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+# Dependencies required to use thumbalizr
+
+gem "url", ">= 0"
+
+group :test do
+  gem 'shoulda'
+	gem 'test-unit'
+end

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+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/thumbalizr.rb

@@ -0,0 +1,141 @@
+# The library requires an API key and secret from Thumbalizr.
+# Sign up for a free account a http://thumbalizr.com/
+# 
+# See README for more information abouth Thumbalizr
+# and this library.
+#
+# @author    Julien Sobrier  (mailto:jsobrier@browshot.com)
+# Copyright: Copyright (c) 2019 Browshot
+# License:   Distributes under the same terms as Ruby
+
+require 'rubygems'
+require 'url'
+require 'net/http'
+require 'net/https'
+require "cgi"
+
+class Thumbalizr
+	# @!attribute [r]
+	# Embed API key
+	attr_reader :key
+	# @!attribute [r]
+	# Thumbalizr secret
+	attr_reader :secret
+	# @!attribute [r]
+	# 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.
+	attr_reader :base
+	# @!attribute [r]
+	# print debug output to the standard output
+	attr_reader :debug
+	
+	# New client
+	#
+	# @param key [String] Embed API key
+	# @param secret [String] Thumbalizr secret
+	# @param debug [Boolean] Set to true to print debug output to the standard output. false (disabled) by default.
+	# @param base [String] Base URL for all API requests. You should use the default base provided by the library.
+	def initialize(key='', secret='', debug=false, base='https://api.thumbalizr.com/api/v1/embed/')
+		@key = key || ''
+		@secret = secret || ''
+		@base = base || 'https://api.thumbalizr.com/api/v1/embed/'
+		@debug = debug || false
+	end
+	
+	# Return the Thumbalizr URL for the screenshot requested
+	#
+	# @param url [String] URL of the web page
+	# @param parameters  [Array<Symbol, Symbol>] Additional options
+	# See http://tumbalizr.com/api/documentation for the full list of possible options
+	# @return url [String] Thumbalizr URL fo the thumbnail
+	def url(url='', parameters={})
+		query = 'url=' + CGI::escape(url.to_s)
+  
+		parameters.each_pair do |key, value|
+			query += "&#{key}=" + CGI::escape(value.to_s)
+		end
+  
+		token = Digest::MD5.hexdigest(query + @secret)
+  
+		return "#{@base}#{@key}/#{token}/?#{query}"
+	end
+	
+	# Download a Thumbalizr thumbnail
+	#
+	# @param url [String] Thumbalizr URL generated by url()
+	# @param url [String] Option local file name to save the image file to.
+	# @return [Array<Symbol, Symbol>] !{:result => <result>, :image => <content>} if no file is specified, or {:result => <result>, :file => <file namet>} if file is specified
+	# result is either OK, FAILED or QUEUED. If the screenshot failed or is not finished, the image content or file name will be empty
+  def download(url='', file='')
+		begin
+			response = fetch(url.to_s)
+			case response
+				when Net::HTTPSuccess     then 
+					status = response.header['X-Thumbalizr-Status']
+					data = ''
+					if (status == 'OK')
+						if (file == '')
+							data = response.response.body
+						else
+							File.open(file, 'w') {|f| f.write(response.response.body) }
+							data = file
+						end
+					elsif (status == 'FAILED')
+						puts "Error: {response.header['X-Thumbalizr-Error']}" if (@debug)
+					end
+					
+					return {:result => status, :image => data}
+				else
+					puts "Error: #{response.header['X-Thumbalizr-Error']}" if (@debug)
+					return {:result => response.header['X-Thumbalizr-Status'], :image => ''}
+			end
+		rescue Exception => e
+			puts "{e.message}" if (@debug)
+			raise e
+		end
+  end
+	
+	# Download a Thumbalizr thumbnail. Unlike the download() function, this function waits until the screenshto is etiehr finished or failed.
+	#
+	# @param url [String] Thumbalizr URL generated by url()
+	# @param url [String] Option local file name to save the image file to.
+	# @return [Array<Symbol, Symbol>] !{:result => <result>, :image => <content>} if no file is specified, or {:result => <result>, :file => <file namet>} if file is specified
+	# result is either OK, FAILED or QUEUED. If the screenshot failed or is not finished, the image content or file name will be empty
+  def download_wait(url='', file='', wait=10)
+		result = download(url, file)
+		while (result[:result] == 'QUEUED')
+			puts "Waiting #{wait}s" if (@debug)
+			sleep(wait)
+			result = download(url, file)
+		end
+		
+		return result
+  end
+	
+	
+	def fetch(url, limit=3)
+		raise ArgumentError, 'HTTP redirect too deep' if (limit == 0)
+
+		uri = URI.parse(url)
+		http = Net::HTTP.new(uri.host, uri.port)
+		http.open_timeout = 240
+		http.read_timeout = 240
+
+		request = Net::HTTP::Get.new(uri.request_uri, {'User-Agent' => 'Thumbalizr Ruby 1.0'})
+		if (uri.scheme == 'https')
+			http.use_ssl = true
+			http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+	  end
+	  
+		response = http.request(request)
+
+	  case response
+			when Net::HTTPRedirection then 
+					path = response['location']
+					url = URL.new( URI.join(@base, path).to_s )
+					return fetch(url.to_s, limit - 1)
+			else
+					return response
+	   end
+	end
+	
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: thumbalizr
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julien Sobrier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: url
+  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: Generate screenshot of any page.
+email: jsobrier@thumbalizr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- lib/thumbalizr.rb
+homepage: https://thumbalizr.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Client for https://thumbalizr.com/
+test_files: []