httpimagestore 0.5.0 → 1.0.0

data/spec/configuration_spec.rb

@@ -1,116 +1,91 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require_relative 'spec_helper'
 require 'httpimagestore/configuration'
-require 'sinatra/base'
 
-describe Configuration do
-	it "should provide thumbnail classes" do
-		c = Configuration.new do
-			thumbnail_class 'small', 'crop', 128, 128, 'JPEG', :magick => 'option', :number => 42
-			thumbnail_class 'tiny', 'pad', 32, 48, 'PNG'
-			thumbnail_class 'test', 'pad', 32, 48
-		end.get
-
-		tc = c.thumbnail_classes['small']
-		tc.name.should == 'small'
-		tc.method.should == 'crop'
-		tc.width.should == 128
-		tc.height.should == 128
-		tc.format.should == 'JPEG'
-		tc.options.should == { :magick => 'option', :number => 42}
-
-		tc = c.thumbnail_classes['tiny']
-		tc.name.should == 'tiny'
-		tc.method.should == 'pad'
-		tc.width.should == 32
-		tc.height.should == 48
-		tc.format.should == 'PNG'
-		tc.options.should == {}
-
-		tc = c.thumbnail_classes['test']
-		tc.name.should == 'test'
-		tc.method.should == 'pad'
-		tc.width.should == 32
-		tc.height.should == 48
-		tc.format.should == 'JPEG'
-		tc.options.should == {}
-	end
-
-	it "should provide S3 key id and secret" do
-		c = Configuration.new do
-			s3_key 'abc', 'xyz'
-		end.get
-
-		c.s3_key_id.should == 'abc'
-		c.s3_key_secret.should == 'xyz'
-	end
-
-	it "should provide S3 bucket" do
-		c = Configuration.new do
-			s3_bucket 'test'
-		end.get
+Configuration::Scope.logger = Logger.new('/dev/null')
 
-		c.s3_bucket.should == 'test'
-	end
-
-	it "should provide thumbnailer_url defaulting to http://localhost:3100" do
-		c = Configuration.new do
-		end.get
-
-		c.thumbnailer_url.should == 'http://localhost:3100'
-
-		c = Configuration.new do
-			thumbnailer_url 'http://test'
-		end.get
+require 'pathname'
+Pathname.glob('lib/httpimagestore/configuration/*.rb').each do |conf|
+	require conf.relative_path_from(Pathname.new 'lib').to_s
+end
 
-		c.thumbnailer_url.should == 'http://test'
+describe Configuration do
+	it 'should parse configuration file' do
+		Configuration.from_file(support_dir + 'full.cfg')
 	end
 
-	it "can set sinatra settings with configured keys" do
-		sinatra = Sinatra.new
-		c = Configuration.new do
-			s3_key 'abc', 'xyz'
-			s3_bucket 'test'
-			thumbnailer_url 'http://test'
-		end.put(sinatra)
-
-		sinatra.settings.s3_key_id.should == 'abc'
-		sinatra.settings.s3_key_secret.should == 'xyz'
-		sinatra.settings.s3_bucket.should == 'test'
-		sinatra.settings.thumbnailer_url.should == 'http://test'
+	it 'should read configuration from string' do
+		Configuration.read (support_dir + 'full.cfg').read
 	end
 
-	it "should load configuration from file" do
-		Dir.chdir(File.dirname(__FILE__))
-		c = Configuration.from_file('test.cfg').get
-
-		c.s3_key_id.should == 'abc'
-		c.s3_key_secret.should == 'xyz'
-		c.s3_bucket.should == 'test'
-		c.thumbnailer_url.should == 'http://test'
-
-		tc = c.thumbnail_classes['small']
-		tc.name.should == 'small'
-		tc.method.should == 'crop'
-		tc.width.should == 128
-		tc.height.should == 128
-		tc.format.should == 'JPEG'
-		tc.options.should == { :magick => 'option', :number => 42}
-
-		tc = c.thumbnail_classes['tiny']
-		tc.name.should == 'tiny'
-		tc.method.should == 'pad'
-		tc.width.should == 32
-		tc.height.should == 48
-		tc.format.should == 'PNG'
-		tc.options.should == {}
-
-		tc = c.thumbnail_classes['test']
-		tc.name.should == 'test'
-		tc.method.should == 'pad'
-		tc.width.should == 32
-		tc.height.should == 48
-		tc.format.should == 'JPEG'
-		tc.options.should == {}
+	describe Configuration::SDL4RTagExtensions do
+		let :configuration do
+			SDL4R::read <<-'EOF'
+			test "hello" "world" abc=123 xyz=321 qwe=true asd="fd"
+			EOF
+		end
+
+		subject do
+			configuration.children.first
+		end
+
+		describe '#required_attributes' do
+			it 'should raise NoAttributeError if there is missing required attribute' do
+				subject.required_attributes('abc', 'xyz')
+
+				expect {
+					subject.required_attributes('abc', 'xyz', 'blah')
+				}.to raise_error Configuration::NoAttributeError, %{syntax error while parsing 'test "hello" "world" abc=123 asd="fd" qwe=true xyz=321': expected 'blah' attribute to be set}
+			end
+		end
+
+		describe '#grab_attributes' do
+			it 'should grab list of attributes form node' do
+				list = subject.grab_attributes('abc', 'xyz', 'qwe', 'opt', 'asd')
+				list.should == [123, 321, true, nil, 'fd']
+			end
+
+			it 'should raise UnexpectedAttributesError if unlisted attribut is on closed attribute list' do
+				expect {
+					subject.grab_attributes('abc', 'qwe')
+				}.to raise_error Configuration::UnexpectedAttributesError, %{syntax error while parsing 'test "hello" "world" abc=123 asd="fd" qwe=true xyz=321': unexpected attributes: 'xyz', 'asd'}
+			end
+		end
+
+		describe '#grab_attributes_with_remaining' do
+			it 'should grab list of attributes form node and all other remaining attributes' do
+				*list, remaining = *subject.grab_attributes_with_remaining('abc', 'xyz')
+				list.should == [123, 321]
+				remaining.should == {'qwe' => true, 'asd' => 'fd'}
+			end
+		end
+
+		describe '#valid_attribute_values' do
+			it 'should rise BadAttributeValueError if attribute value is not on defined value list' do
+				subject.valid_attribute_values('qwe', true, false)
+
+				expect {
+					subject.valid_attribute_values('qwe', 'hello', 'world')
+				}.to raise_error Configuration::BadAttributeValueError, %{syntax error while parsing 'test "hello" "world" abc=123 asd="fd" qwe=true xyz=321': expected 'qwe' attribute value to be "hello" or "world"; got: true}
+			end
+		end
+
+		describe '#grab_values' do
+			it 'should grab list of values' do
+				subject.grab_values('value 1', 'value 2').should == ['hello', 'world']
+			end
+
+			it 'should raise NoValueError if there is not enought values' do
+				expect {
+					subject.grab_values('value 1', 'value 2', 'value 3')
+				}.to raise_error Configuration::NoValueError, %{syntax error while parsing 'test "hello" "world" abc=123 asd="fd" qwe=true xyz=321': expected value 3}
+			end
+
+			it 'should raise UnexpectedValueError if there is too many values' do
+				expect {
+					subject.grab_values('value 1')
+				}.to raise_error Configuration::UnexpectedValueError, %{syntax error while parsing 'test "hello" "world" abc=123 asd="fd" qwe=true xyz=321': unexpected values: "world"}
+			end
+		end
 	end
 end
 

data/spec/configuration_thumbnailer_spec.rb

@@ -0,0 +1,417 @@
+require_relative 'spec_helper'
+require 'httpimagestore/configuration'
+Configuration::Scope.logger = Logger.new('/dev/null')
+
+require 'httpimagestore/configuration/thumbnailer'
+MemoryLimit.logger = Logger.new('/dev/null')
+
+describe Configuration do
+	describe 'thumbnailer' do
+		subject do
+			Configuration.read('')
+		end
+
+		it 'should provide HTTPThumbnailerClient' do
+			subject.thumbnailer.should be_a HTTPThumbnailerClient
+		end
+
+		it 'should use default URL' do
+			subject.thumbnailer.server_url.should == 'http://localhost:3100'
+		end
+
+		it 'should allow to override default URL' do
+			subject = Configuration.read(<<-EOF, thumbnailer_url: 'http://1.1.1.1:8080')
+			EOF
+
+			subject.thumbnailer.server_url.should == 'http://1.1.1.1:8080'
+		end
+
+		it 'should get thumbnailer URL from configuration' do
+			subject = Configuration.read(<<-EOF, thumbnailer_url: 'http://1.1.1.1:8080')
+			thumbnailer url="http://2.2.2.2:1000"
+			EOF
+			
+			subject.thumbnailer.server_url.should == 'http://2.2.2.2:1000'
+		end
+
+		describe 'error handling' do
+			it 'should raise StatementCollisionError on duplicate thumbnailer statement' do
+				expect {
+					Configuration.read(<<-EOF)
+					thumbnailer url="http://2.2.2.2:1000"
+					thumbnailer url="http://2.2.2.2:1000"
+					EOF
+				}.to raise_error Configuration::StatementCollisionError, %{syntax error while parsing 'thumbnailer url="http://2.2.2.2:1000"': only one thumbnailer type statement can be specified within context}
+			end
+
+			it 'should raise NoAttributeError on missing url attribute' do
+				expect {
+					Configuration.read(<<-EOF)
+					thumbnailer
+					EOF
+				}.to raise_error Configuration::NoAttributeError, %{syntax error while parsing 'thumbnailer': expected 'url' attribute to be set}
+			end
+		end
+	end
+
+	describe Configuration::Thumbnail::ThumbnailSpec do
+		describe 'should provide thumbnail spec array based on given locals' do
+			it 'where image name is hash key pointing to array where all values are string and options is hash' do
+				Configuration::Thumbnail::ThumbnailSpec.new('small', 'pad', 100, 100, 'jpeg', 'background-color' => 'red').render.should == {
+					'small' => 
+						['pad', '100', '100', 'jpeg', {'background-color' => 'red'}]
+				}
+			end
+
+			describe 'that are templated' do
+				it 'with local values for operation, width, height and values of options' do
+					locals = {
+						operation: 'fit',
+						width: 99,
+						height: 66,
+						format: 'png',
+						bg: 'white'
+					}
+
+					Configuration::Thumbnail::ThumbnailSpec.new('small', '#{operation}', '#{width}', '#{height}', '#{format}', 'background-color' => '#{bg}').render(locals).should == {
+						'small' => 
+							['fit', '99', '66', 'png', {'background-color' => 'white'}]
+					}
+				end
+
+				it 'with nested options provided by options key in <key>:<value>[,<key>:<value>]* format but not overwriting predefined options' do
+					locals = {
+						operation: 'fit',
+						width: 99,
+						height: 66,
+						format: 'png',
+						opts: 'background-color:blue,quality:100'
+					}
+
+					Configuration::Thumbnail::ThumbnailSpec.new('small', '#{operation}', '#{width}', '#{height}', '#{format}', 'options' => '#{opts}', 'background-color' => 'red').render(locals).should == {
+						'small' => 
+							['fit', '99', '66', 'png', {'background-color' => 'red', 'quality' => '100'}]
+					}
+				end
+			end
+
+			describe 'error handling' do
+				it 'should raise NoValueForSpecTemplatePlaceholerError on missing spec template value' do
+					locals = {
+						width: 99,
+						height: 66,
+						format: 'png'
+					}
+
+					expect {
+						Configuration::Thumbnail::ThumbnailSpec.new('small', '#{operation}', '#{width}', '#{height}', '#{format}').render(locals)
+					}.to raise_error Configuration::NoValueForSpecTemplatePlaceholerError, %q{cannot generate specification for thumbnail 'small': cannot generate value for attribute 'method' from template '#{operation}': no value for #{operation}}
+				end
+
+				it 'should raise NoValueForSpecTemplatePlaceholerError on missing option template value' do
+					locals = {
+						width: 99,
+						height: 66,
+						format: 'png',
+					}
+
+					expect {
+						Configuration::Thumbnail::ThumbnailSpec.new('small', '#{operation}', '#{width}', '#{height}', '#{format}', 'background-color' => '#{bg}').render(locals)
+					}.to raise_error Configuration::NoValueForSpecTemplatePlaceholerError, %q{cannot generate specification for thumbnail 'small': cannot generate value for attribute 'background-color' from template '#{bg}': no value for #{bg}}
+				end
+			end
+		end
+
+		describe 'thumbnail source image' do
+			before :all do
+				log = support_dir + 'server.log'
+				start_server(
+					"httpthumbnailer -f -d -l #{log}",
+					'/tmp/httpthumbnailer.pid',
+					log,
+					'http://localhost:3100/'
+				)
+			end
+
+			let :state do
+				Configuration::RequestState.new(
+					(support_dir + 'compute.jpg').read,
+					operation: 'pad',
+					width: '10',
+					height: '10',
+					options: 'background-color:green',
+					path: nil
+				)
+			end
+
+			before :each do
+				subject.handlers[0].image_sources[0].realize(state)
+			end
+
+			describe 'thumbnailing to single spec' do
+				subject do
+					Configuration.read(<<-'EOF')
+					put ":operation" ":width" ":height" ":options" {
+						thumbnail "input" "original" operation="#{operation}" width="#{width}" height="#{height}" options="#{options}" quality=84 format="jpeg"
+					}
+					EOF
+				end
+
+				before :each do
+					state.images['input'].source_path = 'test.in'
+					state.images['input'].source_url = 'file://test.in'
+				end
+
+				it 'should provide thumbnail data' do
+					subject.handlers[0].image_sources[1].realize(state)
+					state.images['original'].data.should_not be_nil
+				end
+
+				it 'should set thumbnail mime type' do
+					subject.handlers[0].image_sources[1].realize(state)
+					state.images['original'].mime_type.should == 'image/jpeg'
+				end
+
+				it 'should use input image source path and url' do
+					subject.handlers[0].image_sources[1].realize(state)
+					state.images['original'].source_path.should == 'test.in'
+					state.images['original'].source_url.should == 'file://test.in'
+				end
+
+				it 'should set input image mime type' do
+					subject.handlers[0].image_sources[1].realize(state)
+					state.images['input'].mime_type.should == 'image/jpeg'
+				end
+
+				describe 'memory limit' do
+					let :state do
+						Configuration::RequestState.new(
+							(support_dir + 'compute.jpg').read,
+							{operation: 'pad',
+							width: '10',
+							height: '10',
+							options: 'background-color:green',
+							path: nil},
+							MemoryLimit.new(10)
+						)
+					end
+
+					it 'should raise MemoryLimit::MemoryLimitedExceededError when limit is exceeded' do
+						expect {
+							subject.handlers[0].image_sources[1].realize(state)
+						}.to raise_error MemoryLimit::MemoryLimitedExceededError
+					end
+				end
+
+				describe 'error handling' do
+					it 'should raise Thumbnail::ThumbnailingError on realization of bad thumbnail sepc' do
+						state = Configuration::RequestState.new(
+							(support_dir + 'compute.jpg').read,
+							operation: 'pad',
+							width: '0',
+							height: '10',
+							options: 'background-color:green',
+							path: nil
+						)
+
+						expect {
+							subject.handlers[0].image_sources[0].realize(state)
+							subject.handlers[0].image_sources[1].realize(state)
+							}.to raise_error Configuration::Thumbnail::ThumbnailingError # WTF?, "thumbnailing of 'input' into 'original' failed: at least one image dimension is zero: 0x10"
+					end
+
+					it 'should raise NoValueError on missing source image name' do
+						expect {
+							Configuration.read(<<-EOF)
+							put {
+								thumbnail
+							}
+							EOF
+						}.to raise_error Configuration::NoValueError, %{syntax error while parsing 'thumbnail': expected source image name}
+					end
+
+					it 'should raise NoValueError on missing source image name' do
+						expect {
+							Configuration.read(<<-EOF)
+							put {
+								thumbnail "input"
+							}
+							EOF
+						}.to raise_error Configuration::NoValueError, %{syntax error while parsing 'thumbnail "input"': expected thumbnail image name}
+					end
+				end
+			end
+
+			describe 'thumbnailing to multiple specs' do
+				subject do
+					Configuration.read(<<-'EOF')
+					put ":operation" ":width" ":height" ":options" {
+						thumbnail "input" {
+							"original" operation="#{operation}" width="#{width}" height="#{height}" options="#{options}" quality=84 format="jpeg"
+							"small"		operation="crop"	width=128	height=128	format="jpeg"
+							"padded"	operation="pad"		width=128	height=128	format="png"	background-color="gray"
+						}
+					}
+					EOF
+				end
+
+				before :each do
+					state.images['input'].source_path = 'test.in'
+					state.images['input'].source_url = 'file://test.in'
+				end
+
+				it 'should provide thumbnail data' do
+					subject.handlers[0].image_sources[1].realize(state)
+					state.images['original'].data.should_not be_nil
+					state.images['small'].data.should_not be_nil
+					state.images['padded'].data.should_not be_nil
+				end
+
+				it 'should set thumbnail mime type' do
+					subject.handlers[0].image_sources[1].realize(state)
+					state.images['original'].mime_type.should == 'image/jpeg'
+					state.images['small'].mime_type.should == 'image/jpeg'
+					state.images['padded'].mime_type.should == 'image/png'
+				end
+
+				it 'should set input image mime type' do
+					subject.handlers[0].image_sources[1].realize(state)
+					state.images['input'].mime_type.should == 'image/jpeg'
+				end
+
+				it 'should use input image source path and url' do
+					subject.handlers[0].image_sources[1].realize(state)
+					state.images['original'].source_path.should == 'test.in'
+					state.images['original'].source_url.should == 'file://test.in'
+					state.images['small'].source_path.should == 'test.in'
+					state.images['small'].source_url.should == 'file://test.in'
+					state.images['padded'].source_path.should == 'test.in'
+					state.images['padded'].source_url.should == 'file://test.in'
+				end
+
+				describe 'memory limit' do
+					let :state do
+						Configuration::RequestState.new(
+							(support_dir + 'compute.jpg').read,
+							{operation: 'pad',
+							width: '10',
+							height: '10',
+							options: 'background-color:green',
+							path: nil},
+							MemoryLimit.new(10)
+						)
+					end
+
+					it 'should raise MemoryLimit::MemoryLimitedExceededError when limit is exceeded' do
+						expect {
+							subject.handlers[0].image_sources[1].realize(state)
+						}.to raise_error MemoryLimit::MemoryLimitedExceededError
+					end
+				end
+
+				describe 'conditional inclusion support' do
+					subject do 
+						Configuration.read(<<-'EOF')
+						put {
+							thumbnail "input" {
+								"original"	if-image-name-on="#{list}"
+								"small"			if-image-name-on="#{list}"
+								"padded"		if-image-name-on="#{list}"
+							}
+						}
+						EOF
+					end
+
+					let :state do
+						Configuration::RequestState.new(
+							(support_dir + 'compute.jpg').read,
+							operation: 'pad',
+							width: '10',
+							height: '10',
+							options: 'background-color:green',
+							path: nil,
+							list: 'small,padded'
+						)
+					end
+
+					it 'should provide thumbnails that name match if-image-name-on list' do
+						subject.handlers[0].image_sources[1].realize(state)
+						state.images.should_not include 'original'
+						state.images['small'].data.should_not be_nil
+						state.images['padded'].data.should_not be_nil
+					end
+				end
+
+				describe 'error handling' do
+					it 'should raise Thumbnail::ThumbnailingError on realization of bad thumbnail sepc' do
+						state = Configuration::RequestState.new(
+							(support_dir + 'compute.jpg').read,
+							operation: 'pad',
+							width: '0',
+							height: '10',
+							options: 'background-color:green',
+							path: nil
+						)
+
+						subject.handlers[0].image_sources[0].realize(state)
+
+						expect {
+							subject.handlers[0].image_sources[1].realize(state)
+						}.to raise_error Configuration::Thumbnail::ThumbnailingError, "thumbnailing of 'input' into 'original' failed: at least one image dimension is zero: 0x10"
+					end
+
+					it 'should raise NoValueError on missing source image name' do
+						expect {
+							Configuration.read(<<-EOF)
+							put {
+								thumbnail {
+								}
+							}
+							EOF
+						}.to raise_error Configuration::NoValueError, %{syntax error while parsing 'thumbnail': expected source image name}
+					end
+				end
+			end
+		end
+
+		describe 'conditional inclusion support' do
+			let :state do
+				Configuration::RequestState.new(
+					(support_dir + 'compute.jpg').read,
+					list: 'thumbnail1,input4,thumbnail5,input6'
+				)
+			end
+
+			subject do
+				Configuration.read(<<-'EOF')
+				put {
+					thumbnail "input1" "thumbnail1" if-image-name-on="#{list}"
+					thumbnail "input2" "thumbnail2" if-image-name-on="#{list}"
+					thumbnail "input3" if-image-name-on="#{list}" {
+						"thumbnail3" 
+					}
+					thumbnail "input4" if-image-name-on="#{list}" {
+						"thumbnail4" 
+					}
+					thumbnail "input5" if-image-name-on="#{list}" {
+						"thumbnail5" if-image-name-on="#{list}"
+					}
+					thumbnail "input6" if-image-name-on="#{list}" {
+						"thumbnail6" if-image-name-on="#{list}"
+					}
+				}
+				EOF
+			end
+
+			it 'should mark source to be included when output image name in oneline and destination image name in multiline statement match if-image-name-on list' do
+				subject.handlers[0].image_sources[1].excluded?(state).should be_false
+				subject.handlers[0].image_sources[2].excluded?(state).should be_true
+				subject.handlers[0].image_sources[3].excluded?(state).should be_true
+				subject.handlers[0].image_sources[4].excluded?(state).should be_false
+				subject.handlers[0].image_sources[5].excluded?(state).should be_true
+				subject.handlers[0].image_sources[6].excluded?(state).should be_false
+			end
+		end
+	end
+end
+

data/spec/ruby_string_template_spec.rb

@@ -0,0 +1,43 @@
+require_relative 'spec_helper'
+require 'httpimagestore/ruby_string_template'
+
+describe RubyStringTemplate do
+	subject do
+		RubyStringTemplate.new('>#{hello}-#{world}#{test}<')
+	end
+
+	it 'should replace holders with given values' do
+		subject.render(hello: 'hello', world: 'world', test: 123).should == '>hello-world123<'
+	end
+
+	it 'should raise NoValueForTemplatePlaceholderError if template value was not provided' do
+		expect {
+			subject.render(hello: 'hello', test: 123)
+		}.to raise_error RubyStringTemplate::NoValueForTemplatePlaceholderError, %q{no value for '#{world}' in template '>#{hello}-#{world}#{test}<'}
+	end
+
+	describe 'with custom resolver' do
+		subject do
+			RubyStringTemplate.new('>#{hello}-#{world}#{test}<') do |locals, name|
+				case name
+				when :test
+					321
+				else
+					locals[name]
+				end
+			end
+		end
+
+		it 'should ask for values using provided resolver' do
+			subject.render(hello: 'hello', world: 'world').should == '>hello-world321<'
+			subject.render(hello: 'hello', world: 'world', test: 123).should == '>hello-world321<'
+		end
+
+		it 'should raise NoValueForTemplatePlaceholderError if template value was not provided' do
+			expect {
+				subject.render(hello: 'hello', test: 123)
+			}.to raise_error RubyStringTemplate::NoValueForTemplatePlaceholderError, %q{no value for '#{world}' in template '>#{hello}-#{world}#{test}<'}
+		end
+	end
+end
+