httpthumbnailer 0.3.1 → 1.0.0

data/bin/httpthumbnailer

@@ -1,151 +1,94 @@
-#!/usr/bin/ruby
-
-require 'cli'
-require 'ip'
-
-options = CLI.new do
-	description 'HTTP thumbnailing server'
-	switch :no_bind, :description => "Do not bind to TCP socket - useful with -s fastcgi option"
-	switch :no_logging, :description => "Disable logging"
-	switch :debug, :description => "Enable debugging"
-	switch :no_optimization, :description => "Disable size hinting and related optimization (loading, prescaling)"
-	option :bind, :short => :b, :default => IP.new('127.0.0.1'), :cast => IP, :description => "HTTP server bind address - use 0.0.0.0 to bind to all interfaces"
-	option :port, :short => :p, :default => 3100, :cast => Integer, :description => "HTTP server TCP port"
-	option :server, :short => :s, :default => 'mongrel', :description => "Rack server handler like thin, mongrel, webrick, fastcgi etc."
-	option :limit_memory, :default => 128*1024**2, :cast => Integer, :description => "Image cache heap memory size limit in bytes"
-	option :limit_map, :default => 256*1024**2, :cast => Integer, :description => "Image cache memory mapped file size limit in bytes - used when heap memory limit is used up"
-	option :limit_disk, :default => 0, :cast => Integer, :description => "Image cache temporary file size limit in bytes - used when memory mapped file limit is used up"
-end.parse!
-
-require 'sinatra/base'
-require 'haml'
-require 'RMagick'
+#!/usr/bin/env ruby
+require 'unicorn-cuba-base'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'httpthumbnailer/thumbnailer'
-require 'httpthumbnailer/thumbnail_specs'
-
-sinatra = Sinatra.new
-
-unless options.no_bind
-	sinatra.set :port, options.port
-	sinatra.set :bind, options.bind.to_s
-else
-	sinatra.set :port, nil
-	sinatra.set :bind, nil
-end
-sinatra.set :environment, 'production'
-sinatra.set :server, options.server
-sinatra.set :lock, true
-sinatra.set :boundary, "thumnail image data"
-sinatra.set :logging, (not options.no_logging)
-sinatra.set :debug, options.debug
-sinatra.set :optimization, (not options.no_optimization)
-sinatra.set :limit_memory, options.limit_memory
-sinatra.set :limit_map, options.limit_map
-sinatra.set :limit_disk, options.limit_disk
-
-sinatra.before do
-	logger.level = Logger::DEBUG if settings.logging and settings.debug
-	if $thumbnailer.nil? 
-		$thumbnailer = Thumbnailer.new(:logger => logger, :limit_memory => settings.limit_memory, :limit_map => settings.limit_map, :limit_disk => settings.limit_disk)
 
-		$thumbnailer.method('crop') do |image, width, height, options|
-			image.resize_to_fill!(width, height)
-		end
-
-		$thumbnailer.method('fit') do |image, width, height, options|
-			image.resize_to_fit!(width, height)
-		end
-
-		$thumbnailer.method('pad') do |image, width, height, options|
-			image.resize_to_fit!(width, height)
-
-			out = Magick::Image.new(width, height) {
-				self.background_color = Magick::Pixel.new(Magick::MaxRGB, Magick::MaxRGB, Magick::MaxRGB, Magick::MaxRGB) # transparent
-			}.composite!(image, Magick::CenterGravity, Magick::OverCompositeOp)
-
-			image.destroy!
-			out
-		end
+Application.new('httpthumbnailer', port: 3100) do
+	cli do
+		description 'Image thumbnailing HTTP server'
+		switch :formats,
+			short: :F,
+			description: 'print backend versions and supported formats'
+		option :limit_disk,
+			cast: Integer,
+			description: 'image cache temporary file size limit in MiB',
+			default: 1024
+		switch :no_optimization,
+			description: 'disable load time size hinting and prescaling optimizations'
+		version (Pathname.new(__FILE__).dirname + '..' + 'VERSION').read
 	end
-end
 
-sinatra.helpers do
-	def plain_response(msg)
-		headers "Content-Type" => "text/plain"
-		body msg.gsub("\n", "\r\n") + "\r\n"
-	end
+	settings do |settings|
+		if settings.formats
+			require 'httpthumbnailer/plugin/thumbnailer'
+			puts "Versions:"
+			puts "\t#{Plugin::Thumbnailer::Service.rmagick_version}"
+			puts "\t#{Plugin::Thumbnailer::Service.magick_version}"
+			puts
+			puts "Input formats:"
+			puts "\t#{Plugin::Thumbnailer::Service.input_formats.join(' ')}"
+			puts
+			puts "Output formats:"
+			puts "\t#{Plugin::Thumbnailer::Service.output_formats.join(' ')}"
+			exit 0
+		end
 
-	def plain_exception(exception)
-		plain_response("Error: #{exception.class.name}: #{exception}")
+		Controler.settings[:optimization] = (not settings.no_optimization)
+		Controler.settings[:limit_memory] = settings.limit_memory * 1024**2
+		Controler.settings[:limit_map] = settings.limit_disk * 1024**2
+		Controler.settings[:limit_disk] = settings.limit_disk * 1024**2
 	end
-end
-
-sinatra.get '/' do
-	logger.info 'hello'
-end
-
-sinatra.get '/stats/images' do
-	$thumbnailer.images.to_s
-end
 
-sinatra.put %r{^/thumbnail/(.*)} do |specs|
-	thumbnail_specs = ThumbnailSpecs.from_uri(specs)
-
-	opts = {}
-	if settings.optimization
-		opts.merge!({'max-width' => thumbnail_specs.max_width, 'max-height' => thumbnail_specs.max_height})
-	end
+	main do |settings|
+		require 'httpthumbnailer/error_reporter'
+		require 'httpthumbnailer/thumbnailer'
+
+		class HTTPThumbniler < Controler
+			extend Stats
+			def_stats(
+				:workers,
+				:total_requests, 
+				:total_errors 
+			)
+
+			raindrops_stats = Raindrops::Middleware::Stats.new
+			self.use Raindrops::Middleware, stats: raindrops_stats
+
+			StatsReporter << HTTPThumbniler.stats
+			StatsReporter << raindrops_stats
+			StatsReporter << Plugin::Thumbnailer::Service.stats
+			StatsReporter << Plugin::ResponseHelpers.stats
+
+			self.define do
+				HTTPThumbniler.stats.incr_total_requests
+				on error? do
+					HTTPThumbniler.stats.incr_total_errors
+					run ErrorReporter
+				end
+				
+				on 'stats' do
+					run StatsReporter
+				end
 
-	input_image_handler = $thumbnailer.load(request.body, opts)
-	input_image_handler.get do |input_image|
-		status 200
-		headers "Content-Type" => "multipart/mixed; boundary=\"#{settings.boundary}\""
-		headers "X-Input-Image-Content-Type" => input_image.mime_type
+				on 'health_check' do
+					write_plain 200, 'OK'
+				end
 
-		stream do |out| # this is non blocking
-			input_image_handler.use do |input_image|
-				thumbnail_specs.each do |spec|
-					logger.info "Thumbnailing: #{spec}"
-					out << "--#{settings.boundary}\r\n"
+				on root do
+					write_plain 200, 'HTTP Thumbnailer'
+				end
 
-					begin
-						input_image.thumbnail(spec) do |thumbnail|
-							out << "Content-Type: #{thumbnail.mime_type}\r\n\r\n"
-							out << thumbnail.data
-						end
-					rescue => e
-						logger.error "Thumbnailing error: #{e.class.name}: #{e}: \n#{e.backtrace.join("\n")}"
-						out << "Content-Type: text/plain\r\n\r\n"
-						out << "Error: #{e.class.name}: #{e}\r\n"
-					ensure
-						out << "\r\n"
-					end
+				on true do
+					run Thumbnailer
 				end
-				out << "--#{settings.boundary}--"
 			end
 		end
-	end
-end
-
-sinatra.error Thumbnailer::UnsupportedMediaTypeError do
-	plain_exception(env['sinatra.error'])
-	halt 415
-end
-
-sinatra.error Thumbnailer::ImageTooLargeError do
-	plain_exception(env['sinatra.error'])
-	halt 413
-end
 
-sinatra.error 404 do
-	plain_response("Resource '#{request.path_info}' not found")
-end
+		HTTPThumbniler
+	end
 
-sinatra.error do
-	plain_exception(env['sinatra.error'])
+	after_fork do |server, worker|
+		HTTPThumbniler.stats.incr_workers
+	end
 end
 
-sinatra.run!
-

data/features/httpthumbnailer.feature

@@ -1,273 +1,24 @@
-Feature: Generating set of thumbnails with single PUT request
-	In order to generate a set of image thumbnails
-	A user must PUT an image to URL in format
-	/thumbnail[/<thumbnail type>,<width>,<height>,<format>[,<option key>:<option value>]+]+
+Feature: HTTP server
+	It should behave like valid HTTP server
 
 	Background:
-		Given httpthumbnailer log is empty
 		Given httpthumbnailer server is running at http://localhost:3100/
 
-	Scenario: Single thumbnail
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,16,16,PNG
-		Then response status will be 200
-		And I will get multipart response
-		Then first part will contain PNG image of size 16x16
-		And first part mime type will be image/png
-		And there will be no leaked images
-
-	Scenario: Multiple thumbnails
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,16,16,PNG/crop,4,8,JPG/crop,16,32,JPEG
-		Then response status will be 200
-		And I will get multipart response
-		Then first part will contain PNG image of size 16x16
-		And first part mime type will be image/png
-		Then second part will contain JPEG image of size 4x8
-		And second part mime type will be image/jpeg
-		Then third part will contain JPEG image of size 16x32
-		And third part mime type will be image/jpeg
-		And there will be no leaked images
-
-	Scenario: Transparent image to JPEG handling - default background color white
-		Given test-transparent.png file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/fit,128,128,JPEG
-		Then response status will be 200
-		And I will get multipart response
-		And first part body will be saved as test-transparent-default.png for human inspection
-		And first part will contain JPEG image of size 128x128
-		And that image pixel at 32x32 will be of color white
-		And there will be no leaked images
-
-	Scenario: Thumbnails of format INPUT should have same format as input image - for JPEG
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,16,16,PNG/crop,4,8,INPUT/crop,16,32,INPUT
-		Then response status will be 200
-		And I will get multipart response
-		Then first part will contain PNG image of size 16x16
-		And first part mime type will be image/png
-		Then second part will contain JPEG image of size 4x8
-		And second part mime type will be image/jpeg
-		Then third part will contain JPEG image of size 16x32
-		And third part mime type will be image/jpeg
-
-	Scenario: Thumbnails of format INPUT should have same format as input image - for PNG
-		Given test.png file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,16,16,JPEG/crop,4,8,INPUT/crop,16,32,INPUT
-		Then response status will be 200
-		And I will get multipart response
-		Then first part will contain JPEG image of size 16x16
-		And first part mime type will be image/jpeg
-		Then second part will contain PNG image of size 4x8
-		And second part mime type will be image/png
-		Then third part will contain PNG image of size 16x32
-		And third part mime type will be image/png
-
-	Scenario: Thumbnails of width or height INPUT will have input image width or height
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,INPUT,16,JPEG/crop,4,INPUT,PNG/crop,INPUT,INPUT,PNG
-		Then response status will be 200
-		And I will get multipart response
-		Then first part will contain JPEG image of size 509x16
-		And first part mime type will be image/jpeg
-		Then second part will contain PNG image of size 4x719
-		And second part mime type will be image/png
-		Then third part will contain PNG image of size 509x719
-		And third part mime type will be image/png
-
-	Scenario: Fit thumbnailing method
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/fit,128,128,PNG
-		Then response status will be 200
-		And I will get multipart response
-		And first part will contain PNG image of size 91x128
-		And there will be no leaked images
-
-	Scenario: Pad thumbnailing method - default background color white
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/pad,128,128,PNG
-		Then response status will be 200
-		And I will get multipart response
-		And first part body will be saved as test-pad.png for human inspection
-		And first part will contain PNG image of size 128x128
-		And that image pixel at 2x2 will be of color white
-		And there will be no leaked images
-
-	Scenario: Pad thumbnailing method with specified background color
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/pad,128,128,PNG,background-color:green
-		Then response status will be 200
-		And I will get multipart response
-		And first part body will be saved as test-pad-background-color.png for human inspection
-		And first part will contain PNG image of size 128x128
-		And that image pixel at 2x2 will be of color green
-		And there will be no leaked images
-
-	Scenario: Image leaking on error
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,0,0,PNG/fit,0,0,JPG/pad,0,0,JPEG
-		Then response status will be 200
-		And I will get multipart response
-		And first part content type will be text/plain
-		And second part content type will be text/plain
-		And third part content type will be text/plain
-		And there will be no leaked images
-
 	Scenario: Reporitng of missing resource for GET
 		When I do GET request http://localhost:3100/blah
-		Then response status will be 404
-		And response content type will be text/plain
-		And response body will be CRLF endend lines
+		Then response status should be 404
+		And response content type should be text/plain
+		And response body should be CRLF endend lines
 		"""
-		Resource '/blah' not found
+		request for URI '/blah' was not handled by the server
 		"""
 
 	Scenario: Reporitng of missing resource for PUT
-		When I do PUT request http://localhost:3100/blah/thumbnail/crop,0,0,PNG/fit,0,0,JPG/pad,0,0,JPEG
-		Then response status will be 404
-		And response content type will be text/plain
-		And response body will be CRLF endend lines
-		"""
-		Resource '/blah/thumbnail/crop,0,0,PNG/fit,0,0,JPG/pad,0,0,JPEG' not found
-		"""
-
-	Scenario: Reporitng of unsupported media type
-		Given test.txt file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,128,128,PNG
-		Then response status will be 415
-		And response content type will be text/plain
-		And response body will be CRLF endend lines like
-		"""
-		Error: Thumbnailer::UnsupportedMediaTypeError: Magick::ImageMagickError:
-		"""
-
-	Scenario: Reporitng of bad thumbanil spec format - bad dimmension value
-		Given test.txt file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,128,bogous,PNG
-		Then response status will be 500
-		And response content type will be text/plain
-		And response body will be CRLF endend lines
-		"""
-		Error: ThumbnailSpecs::BadThubnailSpecError::BadDimmensionValueError: bad dimmension value: bogous
-		"""
-
-	Scenario: Reporitng of bad thumbanil spec format - missing param
-		Given test.txt file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,128,PNG
-		Then response status will be 500
-		And response content type will be text/plain
-		And response body will be CRLF endend lines
+		When I do PUT request http://localhost:3100/blah/thumbnails/crop,0,0,PNG/fit,0,0,JPG/pad,0,0,JPEG
+		Then response status should be 404
+		And response content type should be text/plain
+		And response body should be CRLF endend lines
 		"""
-		Error: ThumbnailSpecs::BadThubnailSpecError::MissingArgumentError: missing argument in: crop,128,PNG
+		request for URI '/blah/thumbnails/crop,0,0,PNG/fit,0,0,JPG/pad,0,0,JPEG' was not handled by the server
 		"""
 
-	Scenario: Reporitng of bad thumbanil spec format - bad options format
-		Given test.txt file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,128,128,PNG,fas-fda
-		Then response status will be 500
-		And response content type will be text/plain
-		And response body will be CRLF endend lines
-		"""
-		Error: ThumbnailSpecs::BadThubnailSpecError::MissingOptionKeyOrValueError: missing option key or value in: fas-fda
-		"""
-
-	Scenario: Reporitng of image thumbnailing errors
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,16,16,PNG/crop,0,0,JPG/crop,16,32,JPEG
-		Then response status will be 200
-		And I will get multipart response
-		Then first part will contain PNG image of size 16x16
-		And first part mime type will be image/png
-		And second part content type will be text/plain
-		And second part body will be CRLF endend lines
-		"""
-		Error: ArgumentError: invalid result dimension (0, 0 given)
-		"""
-		Then third part will contain JPEG image of size 16x32
-		And third part mime type will be image/jpeg
-		And there will be no leaked images
-
-	Scenario: Handing of large image data - possible thanks to loading size optimization
-		Given test-large.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,16,16,PNG/crop,32,32,JPEG
-		Then response status will be 200
-		And I will get multipart response
-		Then first part will contain PNG image of size 16x16
-		And first part mime type will be image/png
-		Then second part will contain JPEG image of size 32x32
-		And second part mime type will be image/jpeg
-		And there will be no leaked images
-
-	Scenario: Memory limits exhausted while loading
-		Given test-large.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,7000,7000,PNG
-		Then response status will be 413
-		And response content type will be text/plain
-		And response body will be CRLF endend lines like
-		"""
-		Error: Thumbnailer::ImageTooLargeError: Magick::ImageMagickError: cache resources exhausted
-		"""
-		And there will be no leaked images
-
-	Scenario: Memory limits exhausted while thumbnailing
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,16,16,PNG/crop,16000,16000,JPG/crop,16,32,JPEG
-		Then response status will be 200
-		And I will get multipart response
-		Then first part will contain PNG image of size 16x16
-		And first part mime type will be image/png
-		And second part content type will be text/plain
-		And second part body will be CRLF endend lines like
-		"""
-		Error: Thumbnailer::ImageTooLargeError: Magick::ImageMagickError: cache resources exhausted
-		"""
-		Then third part will contain JPEG image of size 16x32
-		And third part mime type will be image/jpeg
-		And there will be no leaked images
-
-	Scenario: Quality option - JPEG
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,32,32,JPEG,quality:10/crop,32,32,JPG,quality:80/crop,32,32,JPEG,quality:90
-		Then response status will be 200
-		And I will get multipart response
-		And first part mime type will be image/jpeg
-		And second part mime type will be image/jpeg
-		And third part mime type will be image/jpeg
-		Then first part will contain body smaller than second part
-		Then second part will contain body smaller than third part
-
-	Scenario: Quality option - JPEG - default 85
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,32,32,JPEG,quality:84/crop,32,32,JPG/crop,32,32,JPEG,quality:86
-		Then response status will be 200
-		And I will get multipart response
-		And first part mime type will be image/jpeg
-		And second part mime type will be image/jpeg
-		And third part mime type will be image/jpeg
-		Then first part will contain body smaller than second part
-		Then second part will contain body smaller than third part
-
-	Scenario: Quality option - PNG (XY where X - zlib compresion level, Y - filter)
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,64,64,PNG,quality:90/crop,64,64,PNG,quality:50/crop,64,64,PNG,quality:10
-		Then response status will be 200
-		And I will get multipart response
-		And first part mime type will be image/png
-		And second part mime type will be image/png
-		And third part mime type will be image/png
-		Then first part will contain body smaller than second part
-		Then second part will contain body smaller than third part
-		And there will be no leaked images
-
-	Scenario: Hint on input image mime type - JPEG
-		Given test.jpg file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,16,16,PNG
-		Then response status will be 200
-		And X-Input-Image-Content-Type header will be image/jpeg
-
-	Scenario: Hint on input image mime type - PNG
-		Given test.png file content as request body
-		When I do PUT request http://localhost:3100/thumbnail/crop,16,16,PNG
-		Then response status will be 200
-		And X-Input-Image-Content-Type header will be image/png
-