httpthumbnailer 0.0.3 → 0.0.4

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/bin/httpthumbnailer

@@ -17,30 +17,42 @@ sinatra.set :server, ['mongrel']
 sinatra.set :lock, true
 sinatra.set :boundary, "thumnail image data"
 sinatra.set :logging, true
+sinatra.set :debug, true
 
 sinatra.before do
-	unless @thumbnailer 
-		@thumbnailer = Thumbnailer.new(:logger => logger)
-		@thumbnailer.method('crop') do |image, spec|
-			image.resize_to_fill(spec.width, spec.height)
+	logger.level = Logger::DEBUG if settings.debug == true
+	if $thumbnailer.nil? 
+		$thumbnailer = Thumbnailer.new(:logger => logger)
+
+		$thumbnailer.method('crop') do |image, spec|
+			image.resize_to_fill!(spec.width, spec.height)
 		end
 
-		@thumbnailer.method('fit') do |image, spec|
-			image.resize_to_fit(spec.width, spec.height)
+		$thumbnailer.method('fit') do |image, spec|
+			image.resize_to_fit!(spec.width, spec.height)
 		end
 
-		@thumbnailer.method('pad') do |image, spec|
-			Magick::Image.new(spec.width, spec.height) {
+		$thumbnailer.method('pad') do |image, spec|
+			image.resize_to_fit!(spec.width, spec.height)
+
+			out = Magick::Image.new(spec.width, spec.height) {
 				self.background_color = Magick::Pixel.new(Magick::MaxRGB, Magick::MaxRGB, Magick::MaxRGB, Magick::MaxRGB) # transparent
-			}.composite!(image.resize_to_fit(spec.width, spec.height), Magick::CenterGravity, Magick::OverCompositeOp)
+			}.composite!(image, Magick::CenterGravity, Magick::OverCompositeOp)
+
+			image.destroy!
+			out
 		end
 	end
 end
 
 sinatra.helpers do
-	def plain_exception(exception)
+	def plain_response(msg)
 		headers "Content-Type" => "text/plain"
-		body "Error: #{exception.class.name}: #{exception}\n"
+		body msg.gsub("\n", "\r\n") + "\r\n"
+	end
+
+	def plain_exception(exception)
+		plain_response("Error: #{exception.class.name}: #{exception}")
 	end
 end
 
@@ -48,45 +60,50 @@ sinatra.get '/' do
 	logger.info 'hello'
 end
 
-sinatra.put %r{/thumbnail/(.*)} do |specs|
-	image = begin
-		@thumbnailer.load('current', request.body)
-	rescue => e
-		plain_exception(e)
-		halt 415
-	end
+sinatra.get '/stats/images' do
+	$thumbnailer.images.to_s
+end
 
+sinatra.put %r{/thumbnail/(.*)} do |specs|
 	thumbnail_specs = ThumbnailSpecs.from_uri(specs)
-
-	status 200
-	headers "Content-Type" => "multipart/mixed; boundary=\"#{settings.boundary}\""
-	stream do |out|
-		thumbnail_specs.each do |spec|
-			logger.info "Thumbnailing: #{spec}"
-			out << "--#{settings.boundary}\r\n"
-
-			begin
-				thumbnail = @thumbnailer.thumbnail('current', spec)
-				thumbnail_data = thumbnail.to_blob do |inf|
-					inf.format = spec.format
+	$thumbnailer.load(request.body) do |original_image_handler|
+		status 200
+		headers "Content-Type" => "multipart/mixed; boundary=\"#{settings.boundary}\""
+
+		stream do |out| # this is non blocking
+			original_image_handler.use do |original_image|
+				thumbnail_specs.each do |spec|
+					logger.info "Thumbnailing: #{spec}"
+					out << "--#{settings.boundary}\r\n"
+
+					begin
+						thumbnail_data = original_image.thumbnail(spec)
+
+						out << "Content-Type: #{spec.mime}\r\n\r\n"
+						out << thumbnail_data
+					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
 				end
-
-				out << "Content-Type: #{spec.mime}\r\n\r\n"
-				out << thumbnail_data
-
-				thumbnail_data = nil
-				thumbnail.destroy!
-			rescue => e
-				out << "Content-Type: text/plain\r\n\r\n"
-				out << "Error: #{e.class.name}: #{e}\r\n"
-			ensure
-				out << "\r\n"
+				out << "--#{settings.boundary}--"
 			end
 		end
-		out << "--#{settings.boundary}--"
 	end
 end
 
+sinatra.error Thumbnailer::UnsupportedMediaTypeError do
+	plain_exception(env['sinatra.error'])
+	halt 415
+end
+
+sinatra.error 404 do
+	plain_response("Resource '#{request.path_info}' not found")
+end
+
 sinatra.error do
 	plain_exception(env['sinatra.error'])
 end

data/features/httpthumbnailer.feature

@@ -4,53 +4,131 @@ Feature: Generating set of thumbnails with single PUT request
 	/thumbnail[/<thumbnail type>,<width>,<height>,<format>[,<option key>:<option value>]+]+
 
 	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 I will get multipart response
-		Then first part mime type will be image/png
-		And first part will contain PNG image of size 16x16
+		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 I will get multipart response
-		Then first part mime type will be image/png
-		And first part will contain PNG image of size 16x16
-		Then second part mime type will be image/jpeg
-		And second part will contain JPEG image of size 4x8
-		Then third part mime type will be image/jpeg
-		And third part will contain JPEG image of size 16x32
+		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 I will get multipart response
+		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: 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 I will get multipart response
+		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 I will get multipart response
+		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 I will get multipart response
+		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
+		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
+		"""
+		Resource '/blah' 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 - 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
+		"""
+		Error: ThumbnailSpecs::BadThubnailSpecFormat: missing argument in: crop,128,PNG
+		"""
+
+	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::BadThubnailSpecFormat: 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
 

data/features/step_definitions/httpthumbnailer_steps.rb

@@ -1,3 +1,7 @@
+Given /httpthumbnailer log is empty/ do
+		(support_dir + 'server.log').truncate(0)
+end
+
 Given /httpthumbnailer server is running at (.*)/ do |url|
 	start_server(
 		"bundle exec #{script('httpthumbnailer')}",
@@ -20,10 +24,37 @@ Then /I will get multipart response/ do
 	@response_multipart = MultipartResponse.new(@response.header['Content-Type'].last, @response.body)
 end
 
+Then /response body will be CRLF endend lines like/ do |body|	
+	@response.body.should match(body)
+	@response.body.each do |line|
+		line[-2,2].should == "\r\n"
+	end
+end
+
+Then /response body will be CRLF endend lines$/ do |body|	
+	@response.body.should == body.gsub("\n", "\r\n") + "\r\n"
+end
+
+Then /response status will be (.*)/ do |status|
+	@response.status.should == status.to_i
+end
+
+Then /response content type will be (.*)/ do |content_type|
+	@response.header['Content-Type'].first.should == content_type
+end
+
 Then /(.*) part mime type will be (.*)/ do |part, mime|
 	@response_multipart.part[part_no(part)].header['Content-Type'].should == mime
 end
 
+Then /(.*) part content type will be (.*)/ do |part, content_type|
+	@response_multipart.part[part_no(part)].header['Content-Type'].should == content_type
+end
+
+Then /(.*) part body will be CRLF endend lines$/ do |part, body|	
+	@response_multipart.part[part_no(part)].body.should == body.gsub("\n", "\r\n") + "\r\n"
+end
+
 Then /(.*) part will contain (.*) image of size (.*)x(.*)/ do |part, format, width, height|
 	mime = @response_multipart.part[part_no(part)].header['Content-Type']
 	data = @response_multipart.part[part_no(part)].body
@@ -46,3 +77,8 @@ And /that image pixel at (.*)x(.*) will be of color (.*)/ do |x, y, color|
 	@image.pixel_color(x.to_i, y.to_i).to_color.sub(/^#/, '0x').should == color
 end
 
+
+And /there will be no leaked images/ do
+	HTTPClient.new.get_content("http://localhost:3100/stats/images").to_i.should == 0
+end
+

data/features/support/test.txt

@@ -0,0 +1 @@
+hello world

data/httpthumbnailer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "httpthumbnailer"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]
-  s.date = "2011-11-28"
+  s.date = "2011-11-29"
   s.description = "Provides HTTP API for thumbnailing images"
   s.email = "jpastuszek@gmail.com"
   s.executables = ["httpthumbnailer"]
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
     "features/support/env.rb",
     "features/support/test-transparent.png",
     "features/support/test.jpg",
+    "features/support/test.txt",
     "httpthumbnailer.gemspec",
     "lib/httpthumbnailer/multipart_response.rb",
     "lib/httpthumbnailer/thumbnail_specs.rb",

data/lib/httpthumbnailer/thumbnail_specs.rb

@@ -1,16 +1,22 @@
 require 'httpthumbnailer/thumbnailer'
 
 class ThumbnailSpecs < Array
+	class BadThubnailSpecFormat < ArgumentError
+	end
+
 	def self.from_uri(specs)
 		ts = ThumbnailSpecs.new
 		specs.split('/').each do |spec|
 			method, width, height, format, *options = *spec.split(',')
+			raise BadThubnailSpecFormat, "missing argument in: #{spec}" unless method and width and height and format
+
 			width = width.to_i
 			height = height.to_i
 
 			opts = {}
 			options.each do |option|
 				key, value = option.split(':')
+				raise BadThubnailSpecFormat, "missing option key or value in: #{option}" unless key and value
 				opts[key] = value
 			end
 

data/lib/httpthumbnailer/thumbnailer.rb

@@ -1,5 +1,18 @@
 require 'logger'
 
+class Magick::Image
+	def render_on_background!(background_color)
+		Thumbnailer::ImageHandler.new do
+			self
+		end.use do |image|
+			Magick::Image.new(image.columns, image.rows) {
+				self.background_color = background_color
+			}.composite!(image, Magick::CenterGravity, Magick::OverCompositeOp)
+		end
+	end
+end
+
+
 class ThumbnailSpec
 	def initialize(method, width, height, format, options = {})
 		@method = method
@@ -31,55 +44,120 @@ class Thumbnailer
 		end
 	end
 
-	class ImageNotFound < ArgumentError
-		def initialize(id)
-			super("No image of ID '#{id}' found")
+	class UnsupportedMediaTypeError < ArgumentError
+		def initialize(e)
+			super("#{e.class.name}: #{e}")
+		end
+	end
+
+	class ImageHandler
+		class ImageDestroyedError < RuntimeError
+			def initialize
+				super("image was already used")
+			end
+		end
+
+		def initialize
+			@image = yield
+		end
+
+		def use
+			raise ImageDestroyedError unless @image
+			begin
+				yield @image
+			ensure
+				@image.destroy!
+				@image = nil
+			end
+		end
+
+		def destroy!
+			return unless @image
+			@image.destroy!
+			@image = nil
+		end
+	end
+
+	class OriginalImage
+		def initialize(io, methods, options = {})
+			@options = options
+			@logger = (options[:logger] or Logger.new('/dev/null'))
+
+			begin
+				@image = Magick::Image.from_blob(io.read).first.strip!
+			rescue Magick::ImageMagickError => e
+				raise UnsupportedMediaTypeError, e
+			end
+			@methods = methods
+		end
+
+		def thumbnail(spec)
+			ImageHandler.new do
+				process_image(@image, spec).render_on_background!((spec.options['background-color'] or 'white').sub(/^0x/, '#'))
+			end.use do |thumb|
+				thumb.to_blob do |inf|
+					inf.format = spec.format
+				end
+			end
+		end
+
+		def destroy!
+			@image.destroy!
+		end
+
+		private
+
+		def process_image(image, spec)
+			impl = @methods[spec.method] or raise UnsupportedMethodError.new(spec.method)
+			copy = image.copy
+			begin
+				impl.call(copy, spec)
+			rescue
+				copy.destroy!
+				raise
+			end
 		end
 	end
 
 	def initialize(options = {})
-		@images = {}
 		@methods = {}
 		@options = options
-		@options = options
 		@logger = (options[:logger] or Logger.new('/dev/null'))
-	end
 
-	def load(id, io)
-		@logger.info "Loading image #{id}"
-		@images[id] = Magick::Image.from_blob(io.read).first
-		@images[id].strip!
+		@logger.info "Initializing thumbniler"
 
-		return @images[id] unless block_given?
-		begin
-			yield @images[id]
-			@logger.info "Done with image #{id}"
-		ensure
-			@logger.info "Destroying image #{id}"
-			@images[id].destroy!
-			@images.delete(id)
+		@images = 0
+		Magick.trace_proc = lambda do |which, description, id, method|
+			case which
+			when :c
+				@images += 1
+			when :d
+				@images -= 1
+			end
+			@logger.debug "Image event: #{which}, #{description}, #{id}, #{method}: loaded images: #{images}"
 		end
 	end
 
-	def method(method, &impl)
-		@methods[method] = impl
-	end
+	def load(io)
+		h = ImageHandler.new do
+			OriginalImage.new(io, @methods, @options)
+		end
 
-	def thumbnail(id, spec)
-		image = @images[id] or raise ImageNotFound.new(id)
-		thumb = process_image(image, spec)
-		replace_transparency(thumb, spec)
+		begin
+			yield h
+		rescue
+			# make sure that we destroy original image if there was an error before it could be used
+			h.destroy!
+			raise
+		end
 	end
 
-	def replace_transparency(image, spec)
-		Magick::Image.new(image.columns, image.rows) {
-			self.background_color = (spec.options['background-color'] or 'white').sub(/^0x/, '#')
-		}.composite!(image, Magick::CenterGravity, Magick::OverCompositeOp)
+	def images
+		@images
 	end
 
-	def process_image(image, spec)
-		impl = @methods[spec.method] or raise UnsupportedMethodError.new(spec.method)
-		impl.call(image, spec)
+	def method(method, &impl)
+		@methods[method] = impl
 	end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: httpthumbnailer
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jakub Pastuszek
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-28 00:00:00 Z
+date: 2011-11-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -221,6 +221,7 @@ files:
 - features/support/env.rb
 - features/support/test-transparent.png
 - features/support/test.jpg
+- features/support/test.txt
 - httpthumbnailer.gemspec
 - lib/httpthumbnailer/multipart_response.rb
 - lib/httpthumbnailer/thumbnail_specs.rb