httpthumbnailer-client 1.1.1 → 1.2.0

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: ../httpthumbnailer
   specs:
-    httpthumbnailer (1.1.0)
+    httpthumbnailer (1.2.0)
       rmagick (~> 2)
-      unicorn-cuba-base (~> 1.1)
+      unicorn-cuba-base (~> 1.2.0)
 
 PATH
   remote: ../unicorn-cuba-base
   specs:
-    unicorn-cuba-base (1.1.1)
+    unicorn-cuba-base (1.2.0)
       cli (~> 1.3)
       cuba (~> 3.0)
       facter (~> 1.6.11)
@@ -21,7 +21,7 @@ GEM
   specs:
     builder (3.0.0)
     cli (1.3.1)
-    cuba (3.1.0)
+    cuba (3.1.1)
       rack
     cucumber (1.1.3)
       builder (>= 2.1.2)
@@ -42,10 +42,10 @@ GEM
       rake
       rdoc
     json (1.6.1)
-    kgio (2.8.1)
+    kgio (2.9.2)
     multipart-parser (0.1.1)
     rack (1.5.2)
-    raindrops (0.12.0)
+    raindrops (0.13.0)
     rake (10.0.4)
     rdoc (3.9.4)
     rmagick (2.13.2)
@@ -59,7 +59,7 @@ GEM
     rspec-mocks (2.13.1)
     ruby-ip (0.9.1)
     term-ansicolor (1.0.7)
-    unicorn (4.6.3)
+    unicorn (4.8.2)
       kgio (~> 2.6)
       rack
       raindrops (~> 0.7)

data/README.md

@@ -23,10 +23,10 @@ data = File.read('image_file.jpg')
 
 # generate single thumbnail from image data (single thumbnail API)
 thumbnail = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail(data, 'crop', 60, 30, 'jpeg')
-thumbnail.mime_type			# => 'image/jpeg'
-thumbnail.width				# => 60
-thumbnail.height			# => 30
-thumbnail.data				# => 60x30 thumbnail JPEG data String
+thumbnail.mime_type   # => 'image/jpeg'
+thumbnail.width       # => 60
+thumbnail.height      # => 30
+thumbnail.data        # => 60x30 thumbnail JPEG data String
 
 # generate set of thumbnails from image data (multipart API)
 thumbnails = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail(data) do
@@ -35,30 +35,36 @@ thumbnails = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail(data)
 	thumbnail 'pad', 40, 40, 'png'
 end
 
-thumbnails[0].mime_type 	# => 'image/jpeg'
-thumbnails[0].width 		# => 60
-thumbnails[0].height		# => 30
-thumbnails[0].data 			# => 60x30 thumbnail JPEG data String
+thumbnails[0].mime_type # => 'image/jpeg'
+thumbnails[0].width     # => 60
+thumbnails[0].height    # => 30
+thumbnails[0].data      # => 60x30 thumbnail JPEG data String
 
-thumbnails[1].mime_type 	# => 'image/png'
-thumbnails[1].width 		# => 80
-thumbnails[1].height		# => 80
-thumbnails[1].data 			# => 80x80 thumbnail PNG data String
+thumbnails[1].mime_type # => 'image/png'
+thumbnails[1].width     # => 80
+thumbnails[1].height    # => 80
+thumbnails[1].data      # => 80x80 thumbnail PNG data String
 
-thumbnails[2].mime_type		# => 'image/png'
-thumbnails[2].width 		# => 40
-thumbnails[2].height		# => 40
-thumbnails[2].data			# => 40x40 thumbnail PNG data String
+thumbnails[2].mime_type # => 'image/png'
+thumbnails[2].width     # => 40
+thumbnails[2].height    # => 40
+thumbnails[2].data      # => 40x40 thumbnail PNG data String
 
-thumbnails.input_mime_type	# => 'image/jpeg' - detected input image format by API server (content based)
-thumbnails.input_width		# => 800 - detected input image width by API server (content based)
-thumbnails.input_height		# => 600 - detected input image height by API server (content based)
+thumbnails.input_mime_type  # => 'image/jpeg' - detected input image format by API server (content based)
+thumbnails.input_width      # => 800 - detected input image width by API server (content based)
+thumbnails.input_height     # => 600 - detected input image height by API server (content based)
 
 # just identify the image
 id = HTTPThumbnailerClient.new('http://localhost:3100').identify(data)
-id.mime_type				# => 'image/jpeg'
-id.width					# => 800
-id.height					# => 600
+id.mime_type  # => 'image/jpeg'
+id.width      # => 800
+id.height     # => 600
+
+# pass transaction ID header to thumbnailer
+id = HTTPThumbnailerClient.new('http://localhost:3100').with_headers('XID' => '123').identify(data)
+id.mime_type  # => 'image/jpeg'
+id.width      # => 800
+id.height     # => 600
 ```
 
 For more details see RSpec for [single thumbnail API](http://github.com/jpastuszek/httpthumbnailer-client/blob/master/spec/thumbnail_spec.rb) and [multipart API](http://github.com/jpastuszek/httpthumbnailer-client/blob/master/spec/thumbnails_spec.rb).

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.2.0

data/httpthumbnailer-client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "httpthumbnailer-client"
-  s.version = "1.1.1"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]
-  s.date = "2013-10-07"
+  s.date = "2014-07-28"
   s.description = "Thumbnails images using httpthumbniler server"
   s.email = "jpastuszek@gmail.com"
   s.executables = ["httpthumbnailer-client"]
@@ -44,7 +44,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/jpastuszek/httpthumbnailer-client"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
+  s.rubygems_version = "1.8.23"
   s.summary = "API client for httpthumbniler server"
 
   if s.respond_to? :specification_version then

data/lib/httpthumbnailer-client.rb

@@ -88,8 +88,8 @@ class HTTPThumbnailerClient
 			args << format.to_s
 
 			options.keys.sort{|a, b| a.to_s <=> b.to_s}.each do |key|
-				raise InvalidThumbnailSpecificationError.new("empty option key for value '#{options[key]}'") if key.nil? || key.to_s.empty? 
-				raise InvalidThumbnailSpecificationError.new("missing option value for key '#{key}'") if options[key].nil? || options[key].to_s.empty? 
+				raise InvalidThumbnailSpecificationError.new("empty option key for value '#{options[key]}'") if key.nil? || key.to_s.empty?
+				raise InvalidThumbnailSpecificationError.new("missing option value for key '#{key}'") if options[key].nil? || options[key].to_s.empty?
 				args << "#{key}:#{options[key]}"
 			end
 
@@ -106,7 +106,7 @@ class HTTPThumbnailerClient
 			# added to thumbnailer v1.1.0 so may be nil for older server
 			@width = width.to_i if width
 			@height = height.to_i if height
-		end	
+		end
 
 		attr_reader :mime_type
 		attr_reader :width
@@ -143,6 +143,9 @@ class HTTPThumbnailerClient
 		@client.send_timeout = options[:send_timeout] || 300
 		@client.receive_timeout = options[:receive_timeout] || 300
 
+		# additional HTTP headers to be passed with requests
+		@headers = options[:headers] || {}
+
 		# don't use keep alive by default since backend won't support it any way unless fronted with nginx or similar
 		@keep_alive = options[:keep_alive] || false
 	end
@@ -157,7 +160,7 @@ class HTTPThumbnailerClient
 			URIBuilder.thumbnail(*spec)
 		end
 
-		response = @client.request('PUT', "#{@server_url}#{uri}", nil, data, {'Content-Type' => 'image/autodetect'})
+		response = @client.request('PUT', "#{@server_url}#{uri}", nil, data, {'Content-Type' => 'image/autodetect'}.merge(@headers))
 		@client.reset_all unless @keep_alive
 
 		content_type = response.header['Content-Type'].last
@@ -216,7 +219,7 @@ class HTTPThumbnailerClient
 	end
 
 	def identify(data)
-		response = @client.request('PUT', "#{@server_url}/identify", nil, data, {'Content-Type' => 'image/autodetect'})
+		response = @client.request('PUT', "#{@server_url}/identify", nil, data, {'Content-Type' => 'image/autodetect'}.merge(@headers))
 		@client.reset_all unless @keep_alive
 
 		content_type = response.header['Content-Type'].last
@@ -235,6 +238,14 @@ class HTTPThumbnailerClient
 		raise RemoteServerError, 'empty response'
 	end
 
+	attr_accessor :headers
+
+	def with_headers(headers)
+		n = self.dup
+		n.headers = @headers.merge headers
+		n
+	end
+
 	def inspect
 		"#<#{self.class.name} server_url=#{server_url.inspect} keep_alive=#{keep_alive.inspect}>"
 	end

data/spec/identify_spec.rb

@@ -4,7 +4,7 @@ describe HTTPThumbnailerClient, 'identify API' do
 	before :all do
 		log = support_dir + 'server.log'
 		start_server(
-			"httpthumbnailer -f -d -l #{log}",
+			"httpthumbnailer -f -d -x XID -l #{log}",
 			'/tmp/httpthumbnailer.pid',
 			log,
 			'http://localhost:3100/'
@@ -29,5 +29,16 @@ describe HTTPThumbnailerClient, 'identify API' do
 			}.should raise_error HTTPThumbnailerClient::UnsupportedMediaTypeError
 		end
 	end
+
+	describe 'passing custom HTTP request headers' do
+		it '#with_headers should add headers to given request' do
+			xid = rand(0..1000)
+
+			input_id = HTTPThumbnailerClient.new('http://localhost:3100').with_headers('XID' => xid).identify((support_dir + 'test.jpg').read)
+			input_id.mime_type.should == 'image/jpeg'
+
+			(support_dir + 'server.log').read.should include "xid=\"#{xid}\""
+		end
+	end
 end
 

data/spec/thumbnail_spec.rb

@@ -4,7 +4,7 @@ describe HTTPThumbnailerClient, 'single thumbnail API' do
 	before :all do
 		log = support_dir + 'server.log'
 		start_server(
-			"httpthumbnailer -f -d -l #{log}",
+			"httpthumbnailer -f -d -x XID -l #{log}",
 			'/tmp/httpthumbnailer.pid',
 			log,
 			'http://localhost:3100/'
@@ -71,5 +71,32 @@ describe HTTPThumbnailerClient, 'single thumbnail API' do
 			}.should raise_error HTTPThumbnailerClient::ImageTooLargeError
 		end
 	end
+
+	describe 'passing custom HTTP request headers' do
+		it 'should add headers provided with :headers option' do
+			xid = rand(0..1000)
+
+			thumbnail = HTTPThumbnailerClient.new('http://localhost:3100', headers: {'XID' => xid}).thumbnail((support_dir + 'test.jpg').read, 'crop', 6, 3, 'jpeg')
+			thumbnail.should be_kind_of HTTPThumbnailerClient::Thumbnail
+
+			(support_dir + 'server.log').read.should include "xid=\"#{xid}\""
+		end
+
+		it '#with_headers should add headers to given request' do
+			xid = rand(0..1000)
+
+			thumbnail = HTTPThumbnailerClient.new('http://localhost:3100').with_headers('XID' => xid).thumbnail((support_dir + 'test.jpg').read, 'crop', 6, 3, 'jpeg')
+			thumbnail.should be_kind_of HTTPThumbnailerClient::Thumbnail
+
+			(support_dir + 'server.log').read.should include "xid=\"#{xid}\""
+
+			xid = rand(1000..2000)
+
+			thumbnail = HTTPThumbnailerClient.new('http://localhost:3100').with_headers('XID' => xid).thumbnail((support_dir + 'test.jpg').read, 'crop', 6, 3, 'jpeg')
+			thumbnail.should be_kind_of HTTPThumbnailerClient::Thumbnail
+
+			(support_dir + 'server.log').read.should include "xid=\"#{xid}\""
+		end
+	end
 end
 

data/spec/thumbnails_spec.rb

@@ -4,7 +4,7 @@ describe HTTPThumbnailerClient, 'multipart API' do
 	before :all do
 		log = support_dir + 'server.log'
 		start_server(
-			"httpthumbnailer -f -d -l #{log}",
+			"httpthumbnailer -f -d -x XID -l #{log}",
 			'/tmp/httpthumbnailer.pid',
 			log,
 			'http://localhost:3100/'
@@ -17,7 +17,7 @@ describe HTTPThumbnailerClient, 'multipart API' do
 
 	it 'should return set of thumbnails matching specifications' do
 		thumbs = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail((support_dir + 'test.jpg').read) do
-			thumbnail 'crop', 60, 30, 'jpeg' 
+			thumbnail 'crop', 60, 30, 'jpeg'
 			thumbnail 'crop', 80, 80, 'png'
 			thumbnail 'crop', 40, 40, 'png'
 		end
@@ -53,14 +53,14 @@ describe HTTPThumbnailerClient, 'multipart API' do
 	describe 'meta data' do
 		it 'should provide input image mime type' do
 			thumbs = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail((support_dir + 'test.jpg').read) do
-				thumbnail 'crop', 6, 3, 'jpeg' 
+				thumbnail 'crop', 6, 3, 'jpeg'
 			end
 			thumbs.input_mime_type.should == 'image/jpeg'
 		end
 
 		it 'should provide input image size' do
 			thumbs = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail((support_dir + 'test.jpg').read) do
-				thumbnail 'crop', 6, 3, 'jpeg' 
+				thumbnail 'crop', 6, 3, 'jpeg'
 			end
 			thumbs.input_width.should == 509
 			thumbs.input_height.should == 719
@@ -70,7 +70,7 @@ describe HTTPThumbnailerClient, 'multipart API' do
 	describe 'returns HTTPThumbnailerClient::HTTPThumbnailerClientError object within set of returned thumbnails' do
 		it 'in case of error with particluar thumbanil' do
 			thumbs = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail((support_dir + 'test.jpg').read) do
-				thumbnail 'crop', 6, 3, 'jpeg' 
+				thumbnail 'crop', 6, 3, 'jpeg'
 				thumbnail 'crop', 0, 0, 'png'
 				thumbnail 'crop', 4, 4, 'png'
 			end
@@ -96,7 +96,7 @@ describe HTTPThumbnailerClient, 'multipart API' do
 
 		it 'in case of memory exhaustion while thumbnailing' do
 			thumbs = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail((support_dir + 'test.jpg').read) do
-				thumbnail 'crop', 6, 3, 'jpeg' 
+				thumbnail 'crop', 6, 3, 'jpeg'
 				thumbnail 'crop', 16000, 16000, 'png'
 				thumbnail 'crop', 4, 4, 'png'
 			end
@@ -120,5 +120,20 @@ describe HTTPThumbnailerClient, 'multipart API' do
 			i.height.should == 4
 		end
 	end
+
+	describe 'passing custom HTTP request headers' do
+		it '#with_headers should add headers to given request' do
+			xid = rand(0..1000)
+
+			thumbs = HTTPThumbnailerClient.new('http://localhost:3100').with_headers('XID' => xid).thumbnail((support_dir + 'test.jpg').read) do
+				thumbnail 'crop', 60, 30, 'jpeg'
+				thumbnail 'crop', 80, 80, 'png'
+				thumbnail 'crop', 40, 40, 'png'
+			end
+			thumbs[0].should be_kind_of HTTPThumbnailerClient::Thumbnail
+
+			(support_dir + 'server.log').read.should include "xid=\"#{xid}\""
+		end
+	end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httpthumbnailer-client
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -249,7 +249,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3857220952369386674
+      hash: 2965592177310199957
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -258,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: API client for httpthumbniler server