mugshot 0.5.1 → 0.6.2

data/README.md

@@ -25,71 +25,49 @@ Using
 
 Mugshot provides you with a Sinatra application. You can create a **config.ru** file with these contents to start using Mugshot:
 
-<pre>
-  # -*- encoding: utf-8 -*-
-  require "rubygems"
-  require "mugshot"
-
-  run Mugshot::Application.new(:storage => Mugshot::FSStorage.new("/tmp/mugshot"))
-</pre>
 
+Using activeresource (3.0.6)
 Then you can run it with:
 
-<pre>
-  $ rackup config.ru
-</pre>
+    $ rackup config.ru
 
 And access in your browser:
 
-<pre>
-  http://localhost:9292/myimg/some-name.jpg
-</pre>
+    http://localhost:9292/myimg/some-name.jpg
 
 This would simply return the image located at /tmp/mugshot/myimg, converting it to a JPEG. Additionaly you can pass some operations to be performed over the image:
 
-<pre>
   http://localhost:9292/resize/100x100/myimg/some-name.jpg   # resizing to 100x100 pixels
   http://localhost:9292/resize/100x/myimg/some-name.jpg   # resizing to 100 pixels in width maintaining aspect ratio
   http://localhost:9292/resize/x100/myimg/some-name.jpg   # resizing to 100 pixels in height maintaining aspect ratio
   http://localhost:9292/crop/200x150/myimg/some-name.jpg   # resize and crop image to 200x150
   http://localhost:9292/quality/70/crop/200x150/myimg/some-name.jpg   # convert it to JPEG with quality of 70% and resize and crop image to 200x150
   http://localhost:9292/background/red/crop/200x150/myimg/some-name.jpg   # convert it to JPEG with red background and resize and crop image to 200x150
-</pre>
 
 Supported operations
 --------------------
 
 ### Resize
 
-<pre>
-  /resize/WIDTHxHEIGHT/id/name.jpg (ex: http://mugshot.ws/resize/200x100/myid/thumb.jpg)
-</pre>
+    /resize/WIDTHxHEIGHT/id/name.jpg (ex: http://mugshot.ws/resize/200x100/myid/thumb.jpg)
 
 ### Resize keeping aspect ratio
 
-<pre>
-  /resize/WIDTHx/id/name.jpg (ex: http://mugshot.ws/resize/200x/myid/thumb.jpg)
+    /resize/WIDTHx/id/name.jpg (ex: http://mugshot.ws/resize/200x/myid/thumb.jpg)
 
-  /resize/xHEIGHT/id/name.jpg (ex: http://mugshot.ws/resize/x100/myid/thumb.jpg)
-</pre>
+    /resize/xHEIGHT/id/name.jpg (ex: http://mugshot.ws/resize/x100/myid/thumb.jpg)
 
 ### Crop
 
-<pre>
-  /crop/WIDTHxHEIGHT/id/name.jpg (ex: http://mugshot.ws/crop/200x100/myid/thumb.jpg)
-</pre>
+    /crop/WIDTHxHEIGHT/id/name.jpg (ex: http://mugshot.ws/crop/200x100/myid/thumb.jpg)
 
 ### Quality
 
-<pre>
-  /quality/QUALITY/id/name.jpg (ex: http://mugshot.ws/quality/70/myid/thumb.jpg)
-</pre>
+    /quality/QUALITY/id/name.jpg (ex: http://mugshot.ws/quality/70/myid/thumb.jpg)
 
 ### Background
 
-<pre>
-  /background/COLOR/id/name.jpg (ex: http://mugshot.ws/background/red/myid/thumb.jpg)
-</pre>
+    /background/COLOR/id/name.jpg (ex: http://mugshot.ws/background/red/myid/thumb.jpg)
 
 
 Configuration
@@ -97,21 +75,19 @@ Configuration
 
 You can further configure your Mugshot::Application when creating it, like so:
 
-<pre>
-  # -*- encoding: utf-8 -*-
-  require "rubygems"
-  require "mugshot"
-
-  run Mugshot::Application.new(
-    :storage => Mugshot::FSStorage.new("/tmp/mugshot"),
-    :cache_duration => 7.days.to_i,                       # duration set in cache header (in seconds)
-    :allowed_sizes => ['640x360', '480x360', '320x240'],  # an array with valid sizes for resize and crop operations
-    :allowed_formats => [:jpg, :png],                     # an array with the allowed formats
-    :allowed_names => ['thumb', 'img'],                   # an array with the allowed names in the URL
-    :quality_range => 1..100,                             # the range of allowed values for quality operations
-    :valid_operations => [:crop, :resize, :quality]       # an array with the valid operations
-  )
-</pre>
+    # -*- encoding: utf-8 -*-
+    require "rubygems"
+    require "mugshot"
+
+    run Mugshot::Application.new(
+      :storage => Mugshot::FSStorage.new("/tmp/mugshot"),
+      :cache_duration => 7.days.to_i,                       # duration set in cache header (in seconds)
+      :allowed_sizes => ['640x360', '480x360', '320x240'],  # an array with valid sizes for resize and crop operations
+      :allowed_formats => [:jpg, :png],                     # an array with the allowed formats
+      :allowed_names => ['thumb', 'img'],                   # an array with the allowed names in the URL
+      :quality_range => 1..100,                             # the range of allowed values for quality operations
+      :valid_operations => [:crop, :resize, :quality]       # an array with the valid operations
+    )
 
 When using the restrictive configurations any value other than the ones allowed will result in a 400 status code being returned. If no restriction is set then any value can be given, which can lead to DOS attacks. Be careful!
 
@@ -120,19 +96,10 @@ Development
 
 Clone the repository and run:
 
-<pre>
-  $ bundle install
-</pre>
+    $ bundle
 
 This will install all dependencies for you. Then you can run the specs and features:
 
-<pre>
-  $ rake spec
-  $ rake cucumber
-</pre>
-
-
-Who's using
------------
+    $ rake spec
+    $ rake cucumber
 
-We currently use Mugshot with Varnish on [Baixatudo](http://www.baixatudo.com.br).

data/lib/mugshot/application.rb

@@ -11,7 +11,7 @@ class Mugshot::Application < Sinatra::Base
   before do
     response['Cache-Control'] = "public, max-age=#{@cache_duration}"
   end
-  
+
   get '/?' do
     'ok'
   end
@@ -28,7 +28,7 @@ class Mugshot::Application < Sinatra::Base
     check_name(name)
     check_operations
   end
-  
+
   get '/*/?:id/:name.:format' do |splat, id, _, format|
     image = @storage.read(id)
     halt 404 if image.blank?
@@ -42,7 +42,7 @@ class Mugshot::Application < Sinatra::Base
     end
   end
 
-  protected
+protected
 
   def initialize(opts)
     opts = {:storage => opts} if opts.kind_of?(Mugshot::Storage)
@@ -57,11 +57,11 @@ class Mugshot::Application < Sinatra::Base
     @allowed_names = opts.delete(:allowed_names)
 
     @default_operations = opts
-    
+
     super(opts)
   end
 
-  private
+private
 
   def operations_from_splat(splat)
     operations = []
@@ -73,19 +73,19 @@ class Mugshot::Application < Sinatra::Base
     end
     operations
   end
-  
+
   def check_format(format)
     halt 400 unless valid_format?(format)
   end
-  
+
   def valid_format?(format)
     @allowed_formats.blank? || @allowed_formats.map(&:to_s).include?(format)
   end
-  
+
   def check_name(name)
     halt 400 unless valid_name?(name)
   end
-  
+
   def valid_name?(name)
     @allowed_names.blank? || @allowed_names.map(&:to_s).include?(name)
   end
@@ -93,19 +93,19 @@ class Mugshot::Application < Sinatra::Base
   def check_operations
     halt 400 unless valid_quality_operation? && valid_resize_operation? && valid_crop_operation?
   end
-  
+
   def valid_quality_operation?
     !@operations.has_key?("quality") || @quality_range.blank? || @quality_range.include?(@operations["quality"].to_i)
   end
-  
+
   def valid_resize_operation?
     valid_operation?("resize", @allowed_sizes)
   end
-  
+
   def valid_crop_operation?
     valid_operation?("crop", @allowed_sizes)
   end
-  
+
   def valid_operation?(operation, range_or_array)
     !@operations.has_key?(operation) || range_or_array.blank? || range_or_array.include?(@operations[operation])
   end
@@ -115,7 +115,7 @@ class Mugshot::Application < Sinatra::Base
       image.send("#{op}!", op_params.to_s)
     end
   end
-  
+
   def send_image(image, format)
     content_type format
     response['Content-Disposition'] = 'inline'

data/lib/mugshot/fs_storage.rb

@@ -2,15 +2,18 @@
 require 'fileutils'
 class Mugshot::FSStorage < Mugshot::Storage
   def write(bin)
-    asset_id.tap do |id|
-      File.open(File.join(@root_path, id), "w") do |fw|
-        fw.write(bin)
-      end
+    id = asset_id
+    path = id_to_path(id)
+    FileUtils.mkdir_p(File.dirname(File.join(@root_path, path)))
+    File.open(File.join(@root_path, path), "w") do |fw|
+      fw.write(bin)
     end
+    id
   end
 
   def read(id)
-    file = File.join(@root_path, id)
+    path = id_to_path(id)
+    file = File.join(@root_path, path)
     return nil unless File.exist? file
     Mugshot::Image.new File.open(file)
   end
@@ -21,4 +24,13 @@ class Mugshot::FSStorage < Mugshot::Storage
     @root_path = root_path
     FileUtils.mkdir_p(root_path)
   end
+
+  def id_to_path(id)
+    path = id.to_s.clone
+    4.times do |i|
+      path = path.insert(3 + (i * 3) + i, '/')
+    end
+    path
+  end
 end
+

data/lib/mugshot/http_storage.rb

@@ -1,12 +1,8 @@
 # -*- encoding: utf-8 -*-
-
 require 'fileutils'
 require 'net/http'
 
 class Mugshot::HTTPStorage < Mugshot::Storage
-  def write(bin)
-    nil
-  end
 
   def read(id)
     url = URI.parse(@url_resolver.call(id))
@@ -17,9 +13,10 @@ class Mugshot::HTTPStorage < Mugshot::Storage
     Mugshot::Image.new(res.body)
   end
 
-  protected
+protected
 
   def initialize(&block)
     @url_resolver = block
   end
+
 end

data/lib/mugshot/image.rb

@@ -45,19 +45,21 @@ class Mugshot::Image
     end
   end
 
-  protected
+protected
+
   def initialize(file_or_blob)
     if file_or_blob.is_a?(File)
       @image = Magick::Image.read(file_or_blob).first
     else
       @image = Magick::Image.from_blob(file_or_blob).first
     end
-    
+
     # initialize attrs
     @background_color = @quality = nil
   end
 
-  private
+private
+
   def parse_size(size)
     size.to_s.split("x").map{|i| i.blank? ? nil : i.to_i}
   end
@@ -67,4 +69,5 @@ class Mugshot::Image
       create_canvas(@image.columns, @image.rows, color).
       composite(@image, Magick::NorthWestGravity, Magick::OverCompositeOp)
   end
+
 end

data/lib/mugshot/magick_factory.rb

@@ -2,11 +2,7 @@
 require 'RMagick'
 
 class Mugshot::MagickFactory
-  class << self
-
-    def create_canvas(columns, rows, color)
-      Magick::Image.new(columns, rows){ self.background_color = color }
-    end
-
+  def self.create_canvas(columns, rows, color)
+    Magick::Image.new(columns, rows){ self.background_color = color }
   end
 end

data/lib/mugshot/storage.rb

@@ -1,8 +1,15 @@
 # -*- encoding: utf-8 -*-
 require 'uuid'
 class Mugshot::Storage
-  protected
+
+  def write(bin)
+    nil
+  end
+
+protected
+
   def asset_id
     UUID.generate :compact
   end
+
 end

data/lib/mugshot/version.rb

@@ -1,3 +1,4 @@
 module Mugshot
-  VERSION = "0.5.1"
+  VERSION = "0.6.2"
 end
+

data/spec/files/test-upload.jpg

@@ -0,0 +1 @@
+image

data/spec/mugshot/application_spec.rb

@@ -37,10 +37,9 @@ describe Mugshot::Application do
   describe "POST /" do
     it "should create image" do
       file_read = nil
-      File.open("spec/files/test.jpg") {|f| file_read = f.read}
+      File.open("spec/files/test-upload.jpg") {|f| file_read = f.read}
       @storage.should_receive(:write).with(file_read).and_return("batata")
-
-      post "/", "file" => Rack::Test::UploadedFile.new("spec/files/test.jpg", "image/jpeg")
+      post "/", "file" => Rack::Test::UploadedFile.new("spec/files/test-upload.jpg", "image/jpeg")
 
       last_response.status.should == 200
     end

data/spec/mugshot/fs_storage_spec.rb

@@ -8,7 +8,7 @@ describe Mugshot::FSStorage do
 
   after :each do
     require 'fileutils'
-    FileUtils.rm_rf("/tmp/mugshot/spec")
+    #FileUtils.rm_rf("/tmp/mugshot/spec")
   end
 
   it "should write an image to the filesystem and read it back" do
@@ -18,12 +18,16 @@ describe Mugshot::FSStorage do
     Mugshot::Image.stub!(:new).and_return(image)
 
     id = @fs.write(bin)
-    image2 = @fs.read(id)
 
+    image2 = @fs.read(id)
     image2.should == image
   end
 
   it "should return nil when an image with the given id doesn't exist on the filesystem" do
     @fs.read('nonexistant-id').should be_nil
   end
+
+  it "should convert an id to path with 4r levels of directories" do
+    @fs.send(:id_to_path, "a9657a30c7df012c736512313b021ce1").should == "a96/57a/30c/7df/012c736512313b021ce1"
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mugshot
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: false
+  hash: 3
+  prerelease: 
   segments: 
   - 0
-  - 5
-  - 1
-  version: 0.5.1
+  - 6
+  - 2
+  version: 0.6.2
 platform: ruby
 authors: 
 - "Cain\xC3\xA3 Nunes"
@@ -15,11 +15,12 @@ authors:
 - Guilherme Cirne
 - Jose Peleteiro
 - Vicente Mundim
+- Anselmo Alves
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-12-28 00:00:00 -02:00
+date: 2011-04-25 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,9 +40,25 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rmagick
+  name: i18n
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -53,11 +70,11 @@ dependencies:
         - 2
         version: 2.12.2
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: uuid
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -69,11 +86,11 @@ dependencies:
         - 2
         version: 2.0.2
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: blankslate
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -86,11 +103,11 @@ dependencies:
         - 3
         version: 2.1.2.3
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: sinatra
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -102,11 +119,11 @@ dependencies:
         - 4
         version: 0.9.4
   type: :runtime
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: fakeweb
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -116,11 +133,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -132,22 +149,6 @@ dependencies:
         - 0
         version: 2.3.0
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: rcov
-  prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 0
-        - 9
-        - 8
-        version: 0.9.8
-  type: :development
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: cucumber
@@ -188,6 +189,7 @@ email:
 - gcirne@gmail.com
 - jose@peleteiro.net
 - vicente.mundim@gmail.com
+- me@anselmoalves.com
 executables: []
 
 extensions: []
@@ -227,6 +229,7 @@ files:
 - features/support/files/with_alpha_channel.png
 - features/upload_image.feature
 - spec/files/firefox_png.png
+- spec/files/test-upload.jpg
 - spec/files/test.jpg
 - spec/files/test_png.png
 - spec/mugshot/application_spec.rb
@@ -266,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: mugshot
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Dead simple image server
@@ -291,6 +294,7 @@ test_files:
 - features/support/files/with_alpha_channel.png
 - features/upload_image.feature
 - spec/files/firefox_png.png
+- spec/files/test-upload.jpg
 - spec/files/test.jpg
 - spec/files/test_png.png
 - spec/mugshot/application_spec.rb