httpthumbnailer-client 1.0.0 → 1.1.0

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: ../httpthumbnailer
   specs:
-    httpthumbnailer (1.0.0)
+    httpthumbnailer (1.1.0)
       rmagick (~> 2)
-      unicorn-cuba-base (~> 1.0)
+      unicorn-cuba-base (~> 1.1)
 
 PATH
   remote: ../unicorn-cuba-base
   specs:
-    unicorn-cuba-base (1.0.0)
+    unicorn-cuba-base (1.1.0)
       cli (~> 1.1.0)
       cuba (~> 3.0)
       facter (~> 1.6.11)
@@ -42,13 +42,13 @@ GEM
       rake
       rdoc
     json (1.6.1)
-    kgio (2.8.0)
+    kgio (2.8.1)
     multipart-parser (0.1.1)
     rack (1.5.2)
-    raindrops (0.11.0)
+    raindrops (0.12.0)
     rake (10.0.4)
     rdoc (3.9.4)
-    rmagick (2.13.1)
+    rmagick (2.13.2)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
       rspec-expectations (~> 2.13.0)

data/README.md

@@ -23,8 +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.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
@@ -34,15 +36,29 @@ thumbnails = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail(data)
 end
 
 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[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)
+
+# just identify the image
+id = HTTPThumbnailerClient.new('http://localhost:3100').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).
@@ -55,11 +71,14 @@ This gem provides `httpthumbnailer-client` command line tool that can be used to
 # start thumbnailing server (to stop: kill `cat httpthumbnailer.pid`)
 httpthumbnailer
 
+# identify image
+cat image.jpg | httpthumbnailer-client
+
 # thumbnail to standard output
-cat ~/Pictures/compute.jpg | httpthumbnailer-client -t crop,100,200,png > thumbnail.png
+cat image.jpg | httpthumbnailer-client -t crop,100,200,png > thumbnail.png
 
 # generate multiple thumbnails
-cat ~/Pictures/compute.jpg | httpthumbnailer-client -t crop,100,200,jpeg,quality:100 -t pad,200,200,png thumbnail1.jpg thumbnail2.png
+cat image.jpg | httpthumbnailer-client -t crop,100,200,jpeg,quality:100 -t pad,200,200,png thumbnail1.jpg thumbnail2.png
 ```
 
 ## Contributing to HTTP Thubnailer Client

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/bin/httpthumbnailer-client

@@ -34,8 +34,7 @@ settings = CLI.new do
 		default: 3100
 	options :thumbnail,
 		short: :t,
-		description: 'thumbnail specification in format <operation type>,<width>,<height>,<format>[,<option key>:<option value>]* - see httpthumbnailer documenation for more information',
-		required: true
+		description: 'thumbnail specification in format <operation type>,<width>,<height>,<format>[,<option key>:<option value>]* - see httpthumbnailer documenation for more information'
 	arguments :output_file_name,
 		short: :f,
 		description: 'file name to store resulting thumbnail; when multiple --thumbail options are used the same number of output file names should be specified; use "-" to write to STDOUT',
@@ -49,6 +48,14 @@ end
 
 thumbnailer = HTTPThumbnailerClient.new("http://#{settings.host}:#{settings.port}")
 
+if settings.thumbnail.empty?
+	id = thumbnailer.identify(settings.stdin.read)
+	id.instance_variables.each do |iv|
+		puts "#{iv.to_s.delete '@'}: #{id.instance_variable_get iv}"
+	end
+	exit
+end
+
 thumbnails = if settings.thumbnail.length == 1
 	[thumbnailer.thumbnail(settings.stdin.read, *settings.thumbnail.first)]
 else

data/httpthumbnailer-client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "httpthumbnailer-client"
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Pastuszek"]
-  s.date = "2013-07-16"
+  s.date = "2013-09-11"
   s.description = "Thumbnails images using httpthumbniler server"
   s.email = "jpastuszek@gmail.com"
   s.executables = ["httpthumbnailer-client"]
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
     "httpthumbnailer-client.gemspec",
     "lib/httpthumbnailer-client.rb",
     "spec/httpthumbnailer-client_spec.rb",
+    "spec/identify_spec.rb",
     "spec/spec_helper.rb",
     "spec/support/test-large.jpg",
     "spec/support/test.jpg",

data/lib/httpthumbnailer-client.rb

@@ -1,4 +1,6 @@
 require 'httpclient'
+require 'ostruct'
+require 'json'
 require 'multipart_parser/reader'
 
 class HTTPThumbnailerClient
@@ -97,16 +99,40 @@ class HTTPThumbnailerClient
 	end
 
 	class Thumbnail
-		def initialize(mime_type, data)
+		def initialize(mime_type, width, height, data)
 			@mime_type = mime_type
 			@data = data
+
+			# 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	
 
-		attr_reader :mime_type, :data
+		attr_reader :mime_type
+		attr_reader :width
+		attr_reader :height
+		attr_reader :data
 	end
 
-	module ThumbnailsInputMimeTypeMeta
+	module ThumbnailsInputIdentifyMeta
 		attr_accessor :input_mime_type
+
+		# added to thumbnailer v1.1.0 so may be nil for older server
+		attr_accessor :input_width
+		attr_accessor :input_height
+	end
+
+	class ImageID
+		def initialize(body)
+			id = JSON.load(body)
+			@mime_type = id['mimeType']
+			@width = id['width']
+			@height = id['height']
+		end
+
+		attr_reader :mime_type
+		attr_reader :width
+		attr_reader :height
 	end
 
 	def initialize(server_url, options = {})
@@ -140,7 +166,7 @@ class HTTPThumbnailerClient
 		when 'text/plain'
 			raise error_for_status(response.status, response.body)
 		when /^image\//
-			Thumbnail.new(content_type, response.body)
+			Thumbnail.new(content_type, response.headers['X-Image-Width'], response.headers['X-Image-Height'], response.body)
 		when /^multipart\/mixed/
 			parts = []
 			parser = MultipartParser::Reader.new(MultipartParser::Reader.extract_boundary_value(content_type))
@@ -164,7 +190,7 @@ class HTTPThumbnailerClient
 							parts << error
 						end
 					when /^image\//
-						parts << Thumbnail.new(part_content_type, data)
+						parts << Thumbnail.new(part_content_type, part.headers['x-image-width'], part.headers['x-image-height'], data)
 					else
 						raise UnknownResponseType, part_content_type
 					end
@@ -178,16 +204,37 @@ class HTTPThumbnailerClient
 			raise UnknownResponseType, content_type
 		end
 
-		unless response.header['X-Input-Image-Content-Type'].empty?
-			thumbnails.extend(ThumbnailsInputMimeTypeMeta)
-			thumbnails.input_mime_type = response.header['X-Input-Image-Content-Type'].first
-		end
+		thumbnails.extend(ThumbnailsInputIdentifyMeta)
+		thumbnails.input_mime_type = response.header['X-Input-Image-Content-Type'].first unless response.header['X-Input-Image-Content-Type'].empty? # deprecated
+		thumbnails.input_mime_type = response.header['X-Input-Image-Mime-Type'].first unless response.header['X-Input-Image-Mime-Type'].empty?
+		thumbnails.input_width = response.header['X-Input-Image-Width'].first.to_i unless response.header['X-Input-Image-Width'].empty?
+		thumbnails.input_height = response.header['X-Input-Image-Height'].first.to_i unless response.header['X-Input-Image-Height'].empty?
 
 		return thumbnails
 	rescue HTTPClient::KeepAliveDisconnected
 		raise RemoteServerError, 'empty response'
 	end
 
+	def identify(data)
+		response = @client.request('PUT', "#{@server_url}/identify", nil, data, {'Content-Type' => 'image/autodetect'})
+		@client.reset_all unless @keep_alive
+
+		content_type = response.header['Content-Type'].last
+
+		image_id = case content_type
+		when 'text/plain'
+			raise error_for_status(response.status, response.body)
+		when 'application/json'
+			ImageID.new(response.body)
+		else
+			raise UnknownResponseType, content_type
+		end
+
+		return image_id
+	rescue HTTPClient::KeepAliveDisconnected
+		raise RemoteServerError, 'empty response'
+	end
+
 	def inspect
 		"#<#{self.class.name} server_url=#{server_url.inspect} keep_alive=#{keep_alive.inspect}>"
 	end

data/spec/identify_spec.rb

@@ -0,0 +1,33 @@
+require_relative 'spec_helper'
+
+describe HTTPThumbnailerClient, 'identify API' do
+	before :all do
+		log = support_dir + 'server.log'
+		start_server(
+			"httpthumbnailer -f -d -l #{log}",
+			'/tmp/httpthumbnailer.pid',
+			log,
+			'http://localhost:3100/'
+		)
+	end
+
+	after :all do
+		stop_server('/tmp/httpthumbnailer.pid')
+	end
+
+	it 'should return input image identification information' do
+		input_id = HTTPThumbnailerClient.new('http://localhost:3100').identify((support_dir + 'test.jpg').read)
+		input_id.mime_type.should == 'image/jpeg'
+		input_id.width.should == 509
+		input_id.height.should == 719
+	end
+
+	describe 'general error handling' do
+		it 'should raise HTTPThumbnailerClient::UnsupportedMediaTypeError error on unsupported media type error' do
+			lambda {
+				HTTPThumbnailerClient.new('http://localhost:3100').identify((support_dir + 'test.txt').read)
+			}.should raise_error HTTPThumbnailerClient::UnsupportedMediaTypeError
+		end
+	end
+end
+

data/spec/thumbnail_spec.rb

@@ -20,6 +20,9 @@ describe HTTPThumbnailerClient, 'single thumbnail API' do
 
 		thumbnail.should be_kind_of HTTPThumbnailerClient::Thumbnail
 		thumbnail.mime_type.should == 'image/jpeg'
+		thumbnail.width.should == 6
+		thumbnail.height.should == 3
+
 		i = identify(thumbnail.data)
 		i.format.should == 'JPEG'
 		i.width.should == 6
@@ -31,6 +34,12 @@ describe HTTPThumbnailerClient, 'single thumbnail API' do
 			thumbnail = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail((support_dir + 'test.jpg').read, 'crop', 6, 3, 'jpeg')
 			thumbnail.input_mime_type.should == 'image/jpeg'
 		end
+
+		it 'should provide input image size' do
+			thumbnail = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail((support_dir + 'test.jpg').read, 'crop', 6, 3, 'jpeg')
+			thumbnail.input_width.should == 509
+			thumbnail.input_height.should == 719
+		end
 	end
 
 	describe 'general error handling' do

data/spec/thumbnails_spec.rb

@@ -24,6 +24,8 @@ describe HTTPThumbnailerClient, 'multipart API' do
 
 		thumbs[0].should be_kind_of HTTPThumbnailerClient::Thumbnail
 		thumbs[0].mime_type.should == 'image/jpeg'
+		thumbs[0].width.should == 60
+		thumbs[0].height.should == 30
 		i = identify(thumbs[0].data)
 		i.format.should == 'JPEG'
 		i.width.should == 60
@@ -31,6 +33,8 @@ describe HTTPThumbnailerClient, 'multipart API' do
 
 		thumbs[1].should be_kind_of HTTPThumbnailerClient::Thumbnail
 		thumbs[1].mime_type.should == 'image/png'
+		thumbs[1].width.should == 80
+		thumbs[1].height.should == 80
 		i = identify(thumbs[1].data)
 		i.format.should == 'PNG'
 		i.width.should == 80
@@ -38,6 +42,8 @@ describe HTTPThumbnailerClient, 'multipart API' do
 
 		thumbs[2].should be_kind_of HTTPThumbnailerClient::Thumbnail
 		thumbs[2].mime_type.should == 'image/png'
+		thumbs[2].width.should == 40
+		thumbs[2].height.should == 40
 		i = identify(thumbs[2].data)
 		i.format.should == 'PNG'
 		i.width.should == 40
@@ -51,6 +57,14 @@ describe HTTPThumbnailerClient, 'multipart API' do
 			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' 
+			end
+			thumbs.input_width.should == 509
+			thumbs.input_height.should == 719
+		end
 	end
 
 	describe 'returns HTTPThumbnailerClient::HTTPThumbnailerClientError object within set of returned thumbnails' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httpthumbnailer-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -226,6 +226,7 @@ files:
 - httpthumbnailer-client.gemspec
 - lib/httpthumbnailer-client.rb
 - spec/httpthumbnailer-client_spec.rb
+- spec/identify_spec.rb
 - spec/spec_helper.rb
 - spec/support/test-large.jpg
 - spec/support/test.jpg
@@ -248,7 +249,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1060783674130423041
+      hash: -4370277079170178883
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: