httpthumbnailer-client 1.2.0 → 1.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDY0YzBlNDVlNjUwN2M0MDRhY2E3Mjg1ZjEzMTY2YzFlYjdlNjE1OA==
+  data.tar.gz: !binary |-
+    ZTc3ODZjY2QxNzBmYzgxZjg3ZjM1ZWZlNDEwODk3M2JlMDFlMzgwMA==
+SHA512:
+  metadata.gz: !binary |-
+    OTA5ZDZmZGQ0MjU0NmYzZDdhZjMzMmE3MGYzMzA3Zjg3MDNjNTNjYjIyN2Mx
+    NWVkM2ExMGE1MDQ4ZmNhZTIzM2RjYzkyNmY4NWYzMjhkYmFmMmE2ZDc5NjE0
+    MGM3ZDljNjgxNjkwMTI2ZDZkZGM5ODQ2YzcyM2VhMGZmMmMxMDI=
+  data.tar.gz: !binary |-
+    YmIyZDFkMDIwOTc0M2JhODBiNTNhYzAxZmNhNmM1NWIwNzg4MmJmYjE4YmMz
+    YWRhM2NmNjM1NTMzZTRhYWRkNjAwYTg4ZmFlMzE4ZjU4OTVlZDc4NmMxZGY0
+    ZWMyMTNiODhiZGViMzg1NDgzMmFhN2RlNDQ4OWYxMGM4NDQzYzE=

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 ruby "1.9.3"
 
-gem "httpclient", ">= 2.3"
+gem "httpclient", "~> 2.0", ">= 2.3"
 gem "cli", "~> 1.3"
 gem "multipart-parser", "~> 0.1.1"
 
@@ -10,11 +10,11 @@ gem "multipart-parser", "~> 0.1.1"
 group :development do
   gem "rspec", "~> 2.13"
   gem "rspec-mocks", "~> 2.13"
-  gem "cucumber", ">= 0"
-  gem "jeweler", "~> 1.8.4"
+  gem 'cucumber', '~> 1.3'
+  gem "jeweler", "~> 1.8", ">= 1.8.8"
   gem "rdoc", "~> 3.9"
   gem "daemon", "~> 1"
   gem "rmagick", "~> 2"
-  gem "httpthumbnailer", path: '../httpthumbnailer'
-  gem "unicorn-cuba-base", path: '../unicorn-cuba-base'
+  gem "httpthumbnailer", "~> 1", path: '../httpthumbnailer'
+  gem "unicorn-cuba-base", "~> 1", path: '../unicorn-cuba-base'
 end

data/Gemfile.lock

@@ -1,53 +1,82 @@
 PATH
   remote: ../httpthumbnailer
   specs:
-    httpthumbnailer (1.2.0)
+    httpthumbnailer (1.3.0)
       rmagick (~> 2)
-      unicorn-cuba-base (~> 1.2.0)
+      unicorn-cuba-base (~> 1.6)
 
 PATH
   remote: ../unicorn-cuba-base
   specs:
-    unicorn-cuba-base (1.2.0)
+    unicorn-cuba-base (1.6.0)
       cli (~> 1.3)
       cuba (~> 3.0)
-      facter (~> 1.6.11)
+      facter (~> 1.6, >= 1.6.18)
       raindrops (~> 0.11)
       ruby-ip (~> 0.9)
-      unicorn (>= 4.6.2)
+      unicorn (~> 4.6, >= 4.6.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    builder (3.0.0)
+    addressable (2.3.8)
+    builder (3.2.2)
     cli (1.3.1)
-    cuba (3.1.1)
+    cuba (3.4.0)
       rack
-    cucumber (1.1.3)
+    cucumber (1.3.17)
       builder (>= 2.1.2)
-      diff-lcs (>= 1.1.2)
-      gherkin (~> 2.6.7)
-      json (>= 1.4.6)
-      term-ansicolor (>= 1.0.6)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
     daemon (1.1.0)
     diff-lcs (1.1.3)
-    facter (1.6.18)
-    gherkin (2.6.7)
-      json (>= 1.4.6)
-    git (1.2.5)
+    facter (1.7.6)
+    faraday (0.8.9)
+      multipart-post (~> 1.2.0)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    git (1.2.9.1)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (3.4.2)
+    highline (1.7.2)
     httpclient (2.3.3)
-    jeweler (1.8.4)
+    jeweler (1.8.8)
+      builder
       bundler (~> 1.0)
       git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
       rake
       rdoc
-    json (1.6.1)
-    kgio (2.9.2)
+    json (1.8.3)
+    jwt (1.5.0)
+    kgio (2.9.3)
+    multi_json (1.10.1)
+    multi_test (0.1.1)
+    multi_xml (0.5.5)
     multipart-parser (0.1.1)
-    rack (1.5.2)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.1)
     raindrops (0.13.0)
-    rake (10.0.4)
-    rdoc (3.9.4)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
     rmagick (2.13.2)
     rspec (2.13.0)
       rspec-core (~> 2.13.0)
@@ -57,9 +86,8 @@ GEM
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.13.1)
-    ruby-ip (0.9.1)
-    term-ansicolor (1.0.7)
-    unicorn (4.8.2)
+    ruby-ip (0.9.3)
+    unicorn (4.9.0)
       kgio (~> 2.6)
       rack
       raindrops (~> 0.7)
@@ -69,14 +97,14 @@ PLATFORMS
 
 DEPENDENCIES
   cli (~> 1.3)
-  cucumber
+  cucumber (~> 1.3)
   daemon (~> 1)
-  httpclient (>= 2.3)
-  httpthumbnailer!
-  jeweler (~> 1.8.4)
+  httpclient (~> 2.0, >= 2.3)
+  httpthumbnailer (~> 1)!
+  jeweler (~> 1.8, >= 1.8.8)
   multipart-parser (~> 0.1.1)
   rdoc (~> 3.9)
   rmagick (~> 2)
   rspec (~> 2.13)
   rspec-mocks (~> 2.13)
-  unicorn-cuba-base!
+  unicorn-cuba-base (~> 1)!

data/README.md

@@ -1,6 +1,13 @@
 # HTTP Thubnailer Client
 
-Ruby client to [httpthumbnailer](http://github.com/jpastuszek/httpthumbnailer) image scaling and conversion HTTP API server.
+Ruby client to [httpthumbnailer](http://github.com/jpastuszek/httpthumbnailer) image thumbnailing, editing and format conversion HTTP API server.
+
+## Changelog
+
+### 1.3.0
+* added edits support
+* better spec parsing and error handling
+* using single thumbnail API if only one thumbnail spec defined
 
 ## Installing
 
@@ -30,7 +37,7 @@ 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
-	thumbnail 'crop', 60, 30, 'jpeg' 
+  thumbnail 'crop', 60, 30, 'jpeg'
 	thumbnail 'crop', 80, 80, 'png'
 	thumbnail 'pad', 40, 40, 'png'
 end
@@ -65,9 +72,28 @@ id = HTTPThumbnailerClient.new('http://localhost:3100').with_headers('XID' => '1
 id.mime_type  # => 'image/jpeg'
 id.width      # => 800
 id.height     # => 600
+
+# generate single thumbnail from image data with additional edits
+thumbnail = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail(data, 'crop', 60, 30, 'jpeg') do
+	edit 'rotate', 90
+	edit 'pixelate', 0.3, 0.2, 0.4, 0.4
+end
+
+# generate set of thumbnails from image data with additional edits
+thumbnails = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail(data) do
+	thumbnail 'crop', 60, 30, 'jpeg' do
+		edit 'rotate', 90
+	end
+	thumbnail 'crop', 80, 80, 'png' do
+		edit 'rotate', 270
+		edit 'pixelate', 0.3, 0.2, 0.4, 0.4
+	end
+	thumbnail 'pad', 40, 40, 'png'
+end
 ```
 
 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).
+Note that when providing only one thumbnail specification using multipart API style the client will actually use single thumbnail API instead.
 
 ### CLI tool
 
@@ -85,10 +111,13 @@ cat image.jpg | httpthumbnailer-client -t crop,100,200,png > thumbnail.png
 
 # generate multiple thumbnails
 cat image.jpg | httpthumbnailer-client -t crop,100,200,jpeg,quality:100 -t pad,200,200,png thumbnail1.jpg thumbnail2.png
+
+# generate thumbnail with edits
+cat image.jpg | httpthumbnailer-client -t 'fit,280,280,png!pixelate,0.3,0.2,0.4,0.4!rectangle,0.04,0.8,0.92,0.17,color:blue' > thumbnail.png
 ```
 
 ## Contributing to HTTP Thubnailer Client
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -99,6 +128,5 @@ cat image.jpg | httpthumbnailer-client -t crop,100,200,jpeg,quality:100 -t pad,2
 
 ## Copyright
 
-Copyright (c) 2013 Jakub Pastuszek. See LICENSE.txt for
-further details.
+Copyright (c) 2013 - 2015 Jakub Pastuszek. See LICENSE.txt for further details.
 

data/Rakefile

@@ -18,9 +18,13 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/jpastuszek/httpthumbnailer-client"
   gem.license = "MIT"
   gem.summary = %Q{API client for httpthumbniler server}
-  gem.description = %Q{Thumbnails images using httpthumbniler server}
+  gem.description = %Q{Ruby client for HTTP API server for image thumbnailing, editing and format conversion.}
   gem.email = "jpastuszek@gmail.com"
   gem.authors = ["Jakub Pastuszek"]
+  gem.files.exclude "features/**/*"
+  gem.files.exclude "spec/**/*"
+  gem.files.exclude "*.gemspec"
+  gem.files.exclude ".rspec"
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/bin/httpthumbnailer-client

@@ -5,20 +5,6 @@ require 'pathname'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'httpthumbnailer-client'
 
-def parse_spec(spec)
-	method, width, height, format, *options = *spec.split(',')
-	fail "missing thumbnail specification argument in: #{spec}" unless method and width and height and format
-
-	opts = {}
-	options.each do |option|
-	key, value = option.split(':')
-		fail "missing option key or value in specifiaction: #{spec}" unless key and value
-	opts[key] = value
-	end
-
-	[method, width, height, format, opts]
-end
-
 settings = CLI.new do
 	description 'Client to httpthumbnailer image scaling and conversion HTTP API server'
 	stdin :image_data,
@@ -43,7 +29,9 @@ settings = CLI.new do
 end.parse! do |settings|
 	STDERR.puts "Warning: there is more thumbnail specifications given than output file names; some thumbnails will not be saved" if settings.thumbnail.length > settings.output_file_name.length
 	fail 'only one thumbnail can be written to STDOUT' if settings.output_file_name.count('-') > 1
-	settings.thumbnail = settings.thumbnail.map{|spec| parse_spec(spec)}
+	settings.thumbnail.map! do |spec|
+		HTTPThumbnailerClient::ThumbnailSpec.from_string(spec)
+	end
 end
 
 thumbnailer = HTTPThumbnailerClient.new("http://#{settings.host}:#{settings.port}")
@@ -56,20 +44,14 @@ if settings.thumbnail.empty?
 	exit
 end
 
-thumbnails = if settings.thumbnail.length == 1
-	[thumbnailer.thumbnail(settings.stdin.read, *settings.thumbnail.first)]
-else
-	thumbnailer.thumbnail(settings.stdin.read) do
-		settings.thumbnail.each do |spec|
-			thumbnail *spec
-		end
-	end
-end
+thumbnails = thumbnailer.thumbnail(settings.stdin.read, *settings.thumbnail)
 
-thumbnails.zip(settings.output_file_name).select do |thumbnail, out_file| 
-	out_file 
+thumbnails.zip(settings.output_file_name).select do |thumbnail, out_file|
+	out_file
 end.each do |thumbnail, out_file|
-	if out_file == '-'
+	if thumbnail.kind_of? HTTPThumbnailerClient::HTTPThumbnailerClientError
+		STDERR.puts "Error: thumbnailing for '#{out_file}' failed: #{thumbnail}"
+	elsif out_file == '-'
 		STDOUT.write thumbnail.data
 	else
 		File.open(out_file, 'w') do |file|

data/lib/httpthumbnailer-client.rb

@@ -2,6 +2,7 @@ require 'httpclient'
 require 'ostruct'
 require 'json'
 require 'multipart_parser/reader'
+require 'httpthumbnailer-client/uri_builder'
 
 class HTTPThumbnailerClient
 	HTTPThumbnailerClientError = Class.new(ArgumentError)
@@ -56,48 +57,6 @@ class HTTPThumbnailerClient
 	UnknownResponseType = Class.new HTTPThumbnailerClientError
 	InvalidMultipartResponseError = Class.new HTTPThumbnailerClientError
 
-	class URIBuilder
-		def initialize(service_uri, &block)
-			@specs = []
-			@service_uri = service_uri
-			instance_eval &block if block
-		end
-
-		def get
-			"#{@service_uri}/#{@specs.join('/')}"
-		end
-
-		def self.thumbnail(*spec)
-			self.new('/thumbnail').thumbnail(*spec).get
-		end
-
-		def self.thumbnails(&block)
-			self.new('/thumbnails', &block).get
-		end
-
-		def thumbnail(method, width, height, format = 'jpeg', options = {})
-			width = width.to_s
-			height = height.to_s
-
-			args = []
-			args << method.to_s
-			width !~ /^([0-9]+|input)$/ and raise InvalidThumbnailSpecificationError.new("bad dimension value: #{width}")
-			args << width
-			height !~ /^([0-9]+|input)$/ and raise InvalidThumbnailSpecificationError.new("bad dimension value: #{height}")
-			args << height
-			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?
-				args << "#{key}:#{options[key]}"
-			end
-
-			@specs << args.join(',')
-			self
-		end
-	end
-
 	class Thumbnail
 		def initialize(mime_type, width, height, data)
 			@mime_type = mime_type
@@ -154,10 +113,14 @@ class HTTPThumbnailerClient
 	attr_reader :keep_alive
 
 	def thumbnail(data, *spec, &block)
-		uri = if block
+		return_array = true
+		uri = if spec.empty?
 			URIBuilder.thumbnails(&block)
+		elsif spec.all?{|s| s.kind_of? ThumbnailSpec}
+			URIBuilder.specs(*spec)
 		else
-			URIBuilder.thumbnail(*spec)
+			return_array = false # for .thumbnail(data, 'crop', 60, 30, 'jpeg') kind of usage
+			URIBuilder.thumbnail(*spec, &block)
 		end
 
 		response = @client.request('PUT', "#{@server_url}#{uri}", nil, data, {'Content-Type' => 'image/autodetect'}.merge(@headers))
@@ -169,7 +132,8 @@ class HTTPThumbnailerClient
 		when 'text/plain'
 			raise error_for_status(response.status, response.body)
 		when /^image\//
-			Thumbnail.new(content_type, response.headers['X-Image-Width'], response.headers['X-Image-Height'], response.body)
+			thumb = Thumbnail.new(content_type, response.headers['X-Image-Width'], response.headers['X-Image-Height'], response.body)
+			return_array ? [thumb] : thumb
 		when /^multipart\/mixed/
 			parts = []
 			parser = MultipartParser::Reader.new(MultipartParser::Reader.extract_boundary_value(content_type))

data/lib/httpthumbnailer-client/thumbnail_spec.rb

@@ -0,0 +1,178 @@
+class HTTPThumbnailerClient
+	#TODO: support for escaping of ! and ,
+	class ThumbnailSpec
+		class Builder
+			def initialize(method, width, height, format = 'jpeg', options = {}, &block)
+				@spec = ThumbnailSpec.new(method, width.to_s, height.to_s, format, options)
+				instance_eval(&block) if block
+			end
+
+			def edit(name, *args)
+				edit_options, args = *args.partition{|e| e.kind_of? Hash}
+				edit_options = edit_options.each.with_object({}) do |opt, hash|
+					hash.merge! opt
+				end
+
+				edit_spec ThumbnailSpec::EditSpec.new(name, args, edit_options)
+				self
+			end
+
+			def edit_spec(spec)
+				@spec.edits << spec
+				self
+			end
+
+			attr_reader :spec
+
+			def to_s
+				@spec.to_s
+			end
+		end
+
+		class InvalidFormatError < ArgumentError
+			def for_edit(name)
+				exception "#{message} for edit '#{name}'"
+			end
+
+			def in_spec(spec)
+				exception "#{message} in spec '#{spec}'"
+			end
+		end
+
+		class MissingArgumentError < InvalidFormatError
+			def initialize(argument)
+				super "missing #{argument} argument"
+			end
+		end
+
+		class InvalidArgumentValueError < InvalidFormatError
+			def initialize(name, value, reason)
+				super "#{name} value '#{value}' is not #{reason}"
+			end
+		end
+
+		class MissingOptionKeyValuePairError < InvalidFormatError
+			def initialize(index)
+				super "missing key-value pair on position #{index + 1}"
+			end
+		end
+
+		class MissingOptionKeyNameError < InvalidFormatError
+			def initialize(value)
+				super "missing option key name for value '#{value}'"
+			end
+		end
+
+		class MissingOptionKeyValueError < InvalidFormatError
+			def initialize(key)
+				super "missing option value for key '#{key}'"
+			end
+		end
+
+		class EditSpec
+			attr_reader :name, :args, :options
+
+			def self.from_string(string)
+				args = HTTPThumbnailerClient::ThumbnailSpec.split_args(string)
+				args, options = HTTPThumbnailerClient::ThumbnailSpec.partition_args_options(args)
+				name = args.shift
+
+				begin
+					options = HTTPThumbnailerClient::ThumbnailSpec.parse_options(options)
+				rescue InvalidFormatError => error
+					raise error.for_edit(name)
+				end
+				new(name, args, options)
+			end
+
+			def initialize(name, args, options = {})
+				name.nil? or name.empty? and raise MissingArgumentError, 'edit name'
+
+				@name = name
+				@args = args
+				@options = options
+			end
+
+			def to_s
+				begin
+					[@name, *@args, *HTTPThumbnailerClient::ThumbnailSpec.options_to_s(@options)].join(',')
+				rescue InvalidFormatError => error
+					raise error.for_edit(name)
+				end
+			end
+		end
+
+		attr_reader :method, :width, :height, :format, :options, :edits
+
+		def self.from_string(string)
+			edits = split_edits(string)
+			spec = edits.shift
+			args = split_args(spec)
+			args, options = partition_args_options(args)
+			method, width, height, format = *args.shift(4) # ignore extra args
+
+			options = parse_options(options)
+			edits = edits.map{|e| EditSpec.from_string(e)}
+
+			new(method, width, height, format, options, edits)
+		rescue InvalidFormatError => error
+			raise error.in_spec(string)
+		end
+
+		def initialize(method, width, height, format, options = {}, edits = [])
+			method.nil? or method.empty? and raise MissingArgumentError, 'method'
+			width.nil? or width.empty? and raise MissingArgumentError, 'width'
+			height.nil? or height.empty? and raise MissingArgumentError, 'height'
+			format.nil? or format.empty? and raise MissingArgumentError, 'format'
+
+			width !~ /^([0-9]+|input)$/ and raise InvalidArgumentValueError.new('width', width, "an integer or 'input'")
+			height !~ /^([0-9]+|input)$/ and raise InvalidArgumentValueError.new('height', height, "an integer or 'input'")
+			@method = method
+			@width = width
+			@height = height
+			@format = format
+			@options = options
+			@edits = edits
+		end
+
+		def to_s
+			[[@method, @width, @height, @format, *self.class.options_to_s(@options)].join(','), *@edits.map(&:to_s)].join('!')
+		end
+
+		def self.split_edits(string)
+			string.split('!')
+		end
+
+		def self.split_args(string)
+			string.split(',')
+		end
+
+		def self.partition_args_options(args)
+			options = args.drop_while{|a| not a.include?(':')}
+			args = args.take_while{|a| not a.include?(':')}
+			[args, options]
+		end
+
+		def self.parse_options(options)
+			Hash[options.map.with_index do |pair, index|
+				pair.empty? and raise MissingOptionKeyValuePairError, index
+				pair.split(':', 2)
+			end].tap do |map|
+				map.each do |key, value|
+					key.nil? or key.empty? and raise MissingOptionKeyNameError, value
+					value.nil? or value.empty? and raise MissingOptionKeyValueError, key
+				end
+			end
+		end
+
+		def self.options_to_s(options)
+			options.sort_by{|k,v| k}.map do |key, value|
+				raise MissingOptionKeyNameError, value if key.nil? or key.to_s.empty?
+				raise MissingOptionKeyValueError, key if value.nil? or value.to_s.empty?
+				key = key.to_s.gsub('_', '-') if key.kind_of? Symbol
+				"#{key}:#{value}"
+			end
+		end
+	end
+end
+