httpimagestore 1.5.0 → 1.6.0

data/.idea/httpimagestore.iml

@@ -62,7 +62,7 @@
     <orderEntry type="library" scope="PROVIDED" name="ruby-ip (v0.9.1, RVM: ruby-1.9.3-p429) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="sdl4r (v0.9.11, RVM: ruby-1.9.3-p429) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="unicorn (v4.6.3, RVM: ruby-1.9.3-p429) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="unicorn-cuba-base (v1.1.1, RVM: ruby-1.9.3-p429) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unicorn-cuba-base (v1.1.2, RVM: ruby-1.9.3-p429) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="uuidtools (v2.1.4, RVM: ruby-1.9.3-p429) [gem]" level="application" />
   </component>
 </module>

data/Gemfile.lock

@@ -39,14 +39,14 @@ GEM
       nokogiri (~> 1.5.2)
       oauth2
     hashie (2.0.5)
-    highline (1.6.19)
+    highline (1.6.20)
     httpauth (0.2.0)
     httpclient (2.3.4.1)
     httpthumbnailer-client (1.1.1)
       cli (~> 1.3)
       httpclient (>= 2.3)
       multipart-parser (~> 0.1.1)
-    jeweler (1.8.7)
+    jeweler (1.8.8)
       builder
       bundler (~> 1.0)
       git (>= 1.2.5)
@@ -55,13 +55,13 @@ GEM
       nokogiri (= 1.5.10)
       rake
       rdoc
-    json (1.8.0)
+    json (1.8.1)
     jwt (0.1.8)
       multi_json (>= 1.5)
     kgio (2.8.1)
     mime-types (1.25)
     msgpack (0.5.5)
-    multi_json (1.8.0)
+    multi_json (1.8.2)
     multi_test (0.0.2)
     multi_xml (0.5.5)
     multipart-parser (0.1.1)

data/README.md

@@ -17,6 +17,10 @@ It is using [HTTP Thumbnailer](https://github.com/jpastuszek/httpthumbnailer) as
 
 ## Changelog
 
+### 1.6.0
+* `output_store_path` and `output_store_url` `path` argument support
+* encoding resulting file storage URL
+
 ### 1.5.0
 * `output_ok` and `output_text` support
 * named captures regexp matcher support
@@ -447,6 +451,10 @@ Arguments:
 
 1. image names - names of images to output storage path for in order
 
+Options:
+
+* `path` - name of predefined path that will be used to generate output path; `#{path}` variable and all derivative will be replaced with given image storage path; if not specified the actual storage path will be provided
+
 Example:
 
 ```sdl
@@ -498,6 +506,10 @@ Arguments:
 
 1. image names - names of images
 
+Options:
+
+* `path` - name of predefined path that will be used to generate output URL path part; `#{path}` variable and all derivative will be replaced with given image storage path; if not specified the original URL will be provided
+
 Example:
 
 ```sdl

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.6.0

data/httpimagestore.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "httpimagestore"
-  s.version = "1.5.0"
+  s.version = "1.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]
-  s.date = "2013-10-22"
+  s.date = "2013-11-04"
   s.description = "Thumbnails images using httpthumbnailer and stored data on HTTP server (S3)"
   s.email = "jpastuszek@gmail.com"
   s.executables = ["httpimagestore"]

data/lib/httpimagestore/configuration/file.rb

@@ -1,6 +1,7 @@
 require 'httpimagestore/configuration/path'
 require 'httpimagestore/configuration/handler'
 require 'pathname'
+require 'uri'
 
 module Configuration
 	class FileStorageOutsideOfRootDirError < ConfigurationError
@@ -18,7 +19,7 @@ module Configuration
 	class FileSourceStoreBase < SourceStoreBase
 		extend Stats
 		def_stats(
-			:total_file_store, 
+			:total_file_store,
 			:total_file_store_bytes,
 			:total_file_source,
 			:total_file_source_bytes
@@ -31,11 +32,11 @@ module Configuration
 			matcher = InclusionMatcher.new(image_name, if_image_name_on)
 
 			self.new(
-				configuration.global, 
-				image_name, 
+				configuration.global,
+				image_name,
 				matcher,
-				root_dir, 
-				path_spec 
+				root_dir,
+				path_spec
 			)
 		end
 
@@ -80,7 +81,7 @@ module Configuration
 					FileSourceStoreBase.stats.incr_total_file_source_bytes(data.bytesize)
 
 					image = Image.new(data)
-					image.source_url = "file://#{rendered_path}"
+					image.source_url = "file://#{URI.encode(rendered_path.to_s)}"
 					image
 				rescue Errno::ENOENT
 					raise NoSuchFileError.new(image_name, rendered_path)
@@ -89,7 +90,7 @@ module Configuration
 		end
 	end
 	Handler::register_node_parser FileSource
-	
+
 	class FileStore < FileSourceStoreBase
 		include ClassLogging
 
@@ -105,7 +106,7 @@ module Configuration
 			get_named_image_for_storage(request_state) do |image_name, image, rendered_path|
 				storage_path = storage_path(rendered_path)
 
-				image.store_url = "file://#{rendered_path.to_s}"
+				image.store_url = "file://#{URI.encode(rendered_path.to_s)}"
 
 				log.info "storing '#{image_name}' in file '#{storage_path}' (#{image.data.length} bytes)"
 				storage_path.open('wb'){|io| io.write image.data}

data/lib/httpimagestore/configuration/output.rb

@@ -1,5 +1,6 @@
 require 'httpimagestore/configuration/handler'
 require 'httpimagestore/ruby_string_template'
+require 'uri'
 
 module Configuration
 	class StorePathNotSetForImage < ConfigurationError
@@ -62,29 +63,59 @@ module Configuration
 	Handler::register_node_parser OutputText
 
 	class OutputMultiBase
-		class ImageName < String
+		class OutputSpec
 			include ConditionalInclusion
+			attr_reader :image_name
+			attr_reader :path_spec
 
-			def initialize(name, matcher)
-				super name
+			def initialize(global, image_name, path_spec, matcher)
+				@global = global
+				@image_name = image_name
+				@path_spec = path_spec
 				inclusion_matcher matcher
 			end
+
+			def store_path(request_state)
+				store_path = request_state.images[@image_name].store_path or raise StorePathNotSetForImage.new(@image_name)
+				return store_path unless @path_spec
+				rendered_path(store_path, request_state)
+			end
+
+			def store_url(request_state)
+				store_url = request_state.images[@image_name].store_url or raise StoreURLNotSetForImage.new(@image_name)
+				return store_url unless @path_spec
+				uri = URI(store_url)
+				uri.path = '/' + URI.encode(rendered_path(URI.decode(uri.path), request_state))
+				uri
+			end
+
+		private
+
+			def rendered_path(store_path, request_state)
+				path = @global.paths[@path_spec]
+				locals = {
+					path: store_path,
+					image_name: @image_name
+				}
+				Pathname.new(path.render(request_state.with_locals(locals))).cleanpath.to_s
+			end
 		end
 
 		def self.parse(configuration, node)
 			nodes = node.values.empty? ? node.children : [node]
-			names = nodes.map do |node|
+			output_specs = nodes.map do |node|
 				image_name = node.grab_values('image name').first
-				matcher = InclusionMatcher.new(image_name, node.grab_attributes('if-image-name-on').first)
-				ImageName.new(image_name, matcher)
+				path_spec, if_image_name_on = *node.grab_attributes('path', 'if-image-name-on')
+				matcher = InclusionMatcher.new(image_name, if_image_name_on)
+				OutputSpec.new(configuration.global, image_name, path_spec, matcher)
 			end
 
 			configuration.output and raise StatementCollisionError.new(node, 'output')
-			configuration.output = self.new(names)
+			configuration.output = self.new(output_specs)
 		end
 
-		def initialize(names)
-			@names = names
+		def initialize(output_specs)
+			@output_specs = output_specs
 		end
 	end
 	Handler::register_node_parser OutputOK
@@ -133,10 +164,10 @@ module Configuration
 		end
 
 		def realize(request_state)
-			paths = @names.select do |name|
-				name.included?(request_state)
-			end.map do |name|
-				request_state.images[name].store_path or raise StorePathNotSetForImage.new(name)
+			paths = @output_specs.select do |output_spec|
+				output_spec.included?(request_state)
+			end.map do |output_spec|
+				output_spec.store_path(request_state)
 			end
 
 			request_state.output do
@@ -152,10 +183,10 @@ module Configuration
 		end
 
 		def realize(request_state)
-			urls = @names.select do |name|
-				name.included?(request_state)
-			end.map do |name|
-				request_state.images[name].store_url or raise StoreURLNotSetForImage.new(name)
+			urls = @output_specs.select do |output_spec|
+				output_spec.included?(request_state)
+			end.map do |output_spec|
+				output_spec.store_url(request_state)
 			end
 
 			request_state.output do

data/spec/configuration_output_spec.rb

@@ -171,13 +171,27 @@ describe Configuration do
 			Pathname.new("/tmp/test.out2")
 		end
 
+		let :test_file do
+			Pathname.new('/tmp/abc/test.out')
+		end
+
+		let :space_test_file do
+			Pathname.new('/tmp/abc/t e s t.out')
+		end
+
 		before :each do
+			test_file.dirname.mkdir
+			test_file.open('w'){|io| io.write('abc')}
+			space_test_file.open('w'){|io| io.write('abc')}
 			in_file.open('w'){|io| io.write('abc')}
 			out_file.unlink if out_file.exist?
 			out2_file.unlink if out2_file.exist?
 		end
 
 		after :each do
+			test_file.exist? and test_file.unlink
+			space_test_file.exist? and space_test_file.unlink
+			test_file.dirname.exist? and test_file.dirname.rmdir
 			out_file.unlink if out_file.exist?
 			out2_file.unlink if out2_file.exist?
 			in_file.unlink
@@ -284,6 +298,62 @@ describe Configuration do
 				end
 			end
 
+			describe 'custom formatting' do
+				it 'should provide formatted file store path' do
+					subject = Configuration.read(<<-'EOF')
+					path  "out"	"abc/test.out"
+					path  "formatted"	"hello/#{dirname}/world/#{basename}-xyz.#{extension}"
+
+					post "single" {
+						store_file "input" root="/tmp" path="out"
+
+						output_store_path "input" path="formatted"
+					}
+					EOF
+
+					subject.handlers[0].sources[0].realize(state)
+					subject.handlers[0].stores[0].realize(state)
+					subject.handlers[0].output.realize(state)
+
+					env.instance_eval &state.output_callback
+					env.res['Content-Type'].should == 'text/plain'
+					env.res.data.should == "hello/abc/world/test-xyz.out\r\n"
+				end
+
+				it 'should provide formatted file store path for each path' do
+					subject = Configuration.read(<<-'EOF')
+					path  "in"	  "test.in"
+					path  "out"	  "abc/test.out"
+					path  "out2"	"test.out2"
+
+					path  "formatted"	  "hello/#{dirname}/world/#{basename}-xyz.#{extension}"
+					path  "formatted2"	"#{image_digest}.#{extension}"
+
+					post "single" {
+						source_file "original" root="/tmp" path="in"
+
+						store_file "input" root="/tmp" path="out"
+						store_file "original" root="/tmp" path="out2"
+
+						output_store_path {
+							"input" path="formatted"
+							"original" path="formatted2"
+						}
+					}
+					EOF
+
+					subject.handlers[0].sources[0].realize(state)
+					subject.handlers[0].sources[1].realize(state)
+					subject.handlers[0].stores[0].realize(state)
+					subject.handlers[0].stores[1].realize(state)
+					subject.handlers[0].output.realize(state)
+
+					env.instance_eval &state.output_callback
+					env.res['Content-Type'].should == 'text/plain'
+					env.res.data.should == "hello/abc/world/test-xyz.out\r\nba7816bf8f01cfea.out2\r\n"
+				end
+			end
+
 			describe 'error handling' do
 				it 'should raise StorePathNotSetForImage for output of not stored image' do
 					subject = Configuration.read(<<-EOF)
@@ -402,6 +472,56 @@ describe Configuration do
 				end
 			end
 
+			describe 'custom formatting' do
+				it 'should provide formatted file store URL' do
+					subject = Configuration.read(<<-'EOF')
+					path  "out"	  "abc/test.out"
+
+					path  "formatted"	  "hello/#{dirname}/world/#{basename}-xyz.#{extension}"
+
+					post "single" {
+						store_file "input" root="/tmp" path="out"
+
+						output_store_url "input" path="formatted"
+					}
+					EOF
+
+					subject.handlers[0].sources[0].realize(state)
+					subject.handlers[0].stores[0].realize(state)
+					subject.handlers[0].output.realize(state)
+
+					env.instance_eval &state.output_callback
+					env.res['Content-Type'].should == 'text/uri-list'
+					env.res.data.should == "file://abc/hello/world/test-xyz.out\r\n"
+				end
+			end
+
+			describe 'URL encoding' do
+				it 'should provide properly encoded file store URL' do
+					subject = Configuration.read(<<-'EOF')
+					path  "out"	  "abc/t e s t.out"
+					path  "formatted"	  "hello/#{dirname}/world/#{basename}-xyz.#{extension}"
+
+					post "single" {
+						store_file "input" root="/tmp" path="out"
+
+						output_store_url {
+							"input"
+							"input" path="formatted"
+						}
+					}
+					EOF
+
+					subject.handlers[0].sources[0].realize(state)
+					subject.handlers[0].stores[0].realize(state)
+					subject.handlers[0].output.realize(state)
+
+					env.instance_eval &state.output_callback
+					env.res['Content-Type'].should == 'text/uri-list'
+					env.res.data.should == "file://abc/t%20e%20s%20t.out\r\nfile://abc/hello/world/t%20e%20s%20t-xyz.out\r\n"
+				end
+			end
+
 			describe 'error handling' do
 				it 'should raise StoreURLNotSetForImage for output of not stored image' do
 					subject = Configuration.read(<<-EOF)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httpimagestore
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-22 00:00:00.000000000 Z
+date: 2013-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicorn-cuba-base
@@ -324,7 +324,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1314462780475505822
+      hash: 3462476370179380761
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: