scale_down 0.1.0 → 0.1.1

data/.gitignore

@@ -3,3 +3,4 @@ pkg/*
 .bundle
 gen_tags
 public
+config.ru

data/README.rdoc

@@ -49,10 +49,7 @@ Create a rackup file (config.ru)
     # The length of the HMAC signature to use
     config.hmac_length = 8
 
-    # The root path to the images.  Use a symlink if it is helpful
-    config.root_path   = File.expand_path(File.dirname(__FILE__))+"/public"
-
-    # The public path for serving static(scaled) images, probably identical to the above.
+    # The path to the public directory
     config.public_path = File.expand_path(File.dirname(__FILE__))+"/public"
 
   end
@@ -68,16 +65,20 @@ Start the server using whatever server you want.
 
 In your application with the images you will need to generate the URL for the image source.
 
+Filenames can have characters (# ? /) which may need to be escaped. So it is important that you CGI escape them.
+
+They should be CGI escaped AFTER the HMAC is generated, and only escape the filename, not the path or options.
+
+  # Example ruby function to generate signed URL
   require 'HMAC::SHA1'
+  require 'cgi'
 
-  # ie scaled_image_src('/images/picture.png/400x300-cropped')
-  def scaled_image_src(url)
-    hmac = HMAC::SHA1.new("secret").update(url).to_s[0...8]
-    "http://images.myserver.com#{URI.encode(url)}/#{hmac}"
+  # ie signed_image_url('/images/picture.png/400x300-cropped')
+  def signed_image_url(path, filename, options)
+    hmac = HMAC::SHA1.new("secret").update([path, filename, options].join("/")).to_s[0...8]
+    "http://images.myserver.com#{[path, CGI.escape(filename), options, hmac].join("/")}"
   end
 
-Files names might require URI encoding.  This should be done after generating the HMAC.
-
 Of course this could be done in PHP, Python, or whatever language your application is running.
 
 == TODO

data/config_sample.ru

@@ -12,9 +12,6 @@ ScaleDown.tap do |config|
   # The length of the HMAC signature to use
   config.hmac_length = 8
 
-  # The root path to the images
-  config.root_path   = File.expand_path(File.dirname(__FILE__))+"/public"
-
   # The location of the public directory for serving static files
   # This might be redudant since it will always, maybe, maybe not, be the same as root_path
   config.public_path = "#{File.expand_path(File.dirname(__FILE__))}/public"

data/lib/scale_down/configuration.rb

@@ -29,9 +29,6 @@ module ScaleDown
       ScaleDown::Controller.public = str
     end
 
-    # The path the root of the images directory
-    attr_accessor :root_path
-
     # Defaults
     ScaleDown.max_file_size  = 10 * 1_048_576
     ScaleDown.max_dimensions = [1200,1200]

data/lib/scale_down/controller.rb

@@ -9,7 +9,7 @@ class ScaleDown::Controller < Sinatra::Application
   end
 
   get '/*/info' do
-    info = ScaleDown::Scaler.info(params[:splat].join("/"))
+    info = ScaleDown::Dispatcher.info(params[:splat].join("/"))
     if info
       [200, info]
     else
@@ -28,7 +28,7 @@ class ScaleDown::Controller < Sinatra::Application
       :filename => parts.pop,
       :splat    => parts
     }
-    path, status = scaler(params)
+    path, status = dispatch(params)
 
     # TODO Eh? Shouldn't it be if 301
     unless status == 403
@@ -40,8 +40,8 @@ class ScaleDown::Controller < Sinatra::Application
   end
 
   protected
-  def scaler(params)
-    ScaleDown::Scaler.process \
+  def dispatch(params)
+    ScaleDown::Dispatcher.process \
       :path     => params[:splat].join("/"),
       :filename => params[:filename],
       :geometry => params[:geometry],

data/lib/scale_down/{scaler.rb → dispatcher.rb}

@@ -1,22 +1,24 @@
-class ScaleDown::Scaler
+class ScaleDown::Dispatcher
+
+  # Controls flow to ensure that the file exists and has the proper HMAC signature.
 
   class << self
 
     def process(params)
-      scaler = new(params)
+      dispatcher = new(params)
 
-      return ["Missing file", 404] unless scaler.root_file_exists?
-      return [scaler.redirect_path, 301] if scaler.scaled_file_exists?
+      return ["Missing file", 404] unless dispatcher.root_file_exists?
+      return [dispatcher.redirect_path, 301] if dispatcher.scaled_file_exists?
 
-      if scaler.valid_hmac? && scaler.scale
-        [scaler.redirect_path, 301]
-      else
-        ["Error message", 403]
-      end
+      return ["Invalid HMAC signature", 403] unless dispatcher.valid_hmac?
+      return ["File failed to scale. The file may be corrupt.", 500] unless dispatcher.scale
+
+      [dispatcher.redirect_path, 301]
     end
 
+    # TODO return a JSON response with a full set of image details
     def info(relative_path)
-      path = [ScaleDown.root_path, relative_path].join("/")
+      path = [ScaleDown.public_path, relative_path].join("/")
       if File.exists?(path)
         image = MiniMagick::Image.open(path)
         [image[:width],image[:height]].join('x')
@@ -62,11 +64,11 @@ class ScaleDown::Scaler
   end
 
   def root_path
-    File.join(ScaleDown.root_path, @params[:path], @params[:filename])
+    File.join(ScaleDown.public_path, @params[:path], @params[:filename])
   end
 
   def scaled_file_path
-    File.join(ScaleDown.root_path, redirect_path)
+    File.join(ScaleDown.public_path, redirect_path)
   end
 
   def scaled_filename

data/lib/scale_down/image.rb

@@ -2,6 +2,14 @@ require 'pathname'
 
 class ScaleDown::Image
 
+  # This class should only
+  #   load an image
+  #   ensure an RGB colorspace
+  #   correct the orientation
+  #   scale the image to the dimensions
+  #   save the scaled image to the specified path
+  #
+  # This is not the place for any other logic.
   include Magick
 
   class << self
@@ -31,24 +39,23 @@ class ScaleDown::Image
   end
 
   def initialize(properties = {})
-    @file     = load_file(properties[:file])
-    @out      = properties[:out]
-    @geometry = geometry(properties[:options])
-    @options  = properties[:options]
-    @wrote    = false
-
-    if @file
-      save
-      @file.destroy! #release the memory
+    load_file(properties[:file]) do |file|
+      resize(file, properties[:options])
+      fix_color_space(file)
+
+      @valid = write(file, properties[:out])
     end
   end
 
   def load_file(file_path)
     self.class.validate_file_size(file_path)
     begin
-      Magick::Image.read(file_path).first
+      file = Magick::Image.read(file_path).first
+      unless file.nil?
+        yield file
+        file.destroy!
+      end
     rescue Magick::ImageMagickError => e
-      return nil
     end
   end
 
@@ -57,37 +64,33 @@ class ScaleDown::Image
   end
 
   def valid?
-    @wrote
+    @valid ||= false
   end
 
   protected
 
-    def save
-      path = Pathname.new(@out).dirname.to_s
-      FileUtils.mkdir_p path unless FileTest.directory? path
-      resize
-      fix_color_space
-      write
-    end
-
-    def fix_color_space
-      if @file.colorspace == Magick::CMYKColorspace
-        @file.add_profile "#{File.expand_path(File.dirname(__FILE__))}/../../color_profiles/sRGB.icm"
-        @file = @file.quantize 2**24, Magick::RGBColorspace
+    def fix_color_space(file)
+      if file.colorspace == Magick::CMYKColorspace
+        file.add_profile "#{File.expand_path(File.dirname(__FILE__))}/../../color_profiles/sRGB.icm"
+        file = file.quantize 2**24, Magick::RGBColorspace
       end
     end
 
-    def resize
-      @file.auto_orient!
-      if @options[:crop]
-        @file.crop_resized!(@geometry.width, @geometry.height, Magick::CenterGravity)
+    def resize(file, properties)
+      geo = geometry(properties)
+      file.auto_orient!
+      if properties[:crop]
+        file.crop_resized!(geo.width, geo.height, Magick::CenterGravity)
       else
-        @file.change_geometry!(@geometry) {|cols, rows, img| img.resize!(cols,rows)}
+        file.change_geometry!(geo) {|cols, rows, img| img.resize!(cols,rows)}
       end
     end
 
-    def write
-      @file.write(@out) { self.quality = 85 }
-      @wrote = true
+    def write(file, file_out)
+      path = Pathname.new(file_out).dirname.to_s
+      FileUtils.mkdir_p path unless FileTest.directory? path
+
+      file.write(file_out) { self.quality = 85 }
+      true
     end
 end

data/lib/scale_down/version.rb

@@ -1,3 +1,3 @@
 module ScaleDown
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/scale_down.rb

@@ -11,7 +11,7 @@ module ScaleDown
   require 'scale_down/configuration'
   require 'scale_down/version'
   require 'scale_down/controller'
-  require 'scale_down/scaler'
+  require 'scale_down/dispatcher'
   require 'scale_down/image'
 
   class InvalidGeometry < Exception; end

data/test/scale_down/controller_test.rb

@@ -9,7 +9,7 @@ class ScaleDown::Controller::Test < Test::Unit::TestCase
 
   context "parsing a request" do
     should "have an image path" do
-      ScaleDown::Scaler.expects(:process).with(
+      ScaleDown::Dispatcher.expects(:process).with(
         :path     => "user/path",
         :filename => "filename.png",
         :geometry => "400x300-cropped-grayscale",
@@ -22,7 +22,7 @@ class ScaleDown::Controller::Test < Test::Unit::TestCase
 
   context "a valid request" do
     should "redirect to the image path" do
-      ScaleDown::Scaler.expects(:process).returns ["/image-path", 301]
+      ScaleDown::Dispatcher.expects(:process).returns ["/image-path", 301]
       get "/path/filename/geo/hmac"
 
       assert_equal 301, last_response.status
@@ -33,7 +33,7 @@ class ScaleDown::Controller::Test < Test::Unit::TestCase
   context "an invalid request" do
 
     should "respond with a 403 and error message" do
-      ScaleDown::Scaler.expects(:process).returns ["Error description", 403]
+      ScaleDown::Dispatcher.expects(:process).returns ["Error description", 403]
 
       get "/path/filename/geo/hmac"
 
@@ -45,7 +45,7 @@ class ScaleDown::Controller::Test < Test::Unit::TestCase
   context "get dimensions" do
     context "for image which exists" do
       setup do
-        ScaleDown::Scaler.expects(:info).with("image/path/image.jpg").returns "400x300"
+        ScaleDown::Dispatcher.expects(:info).with("image/path/image.jpg").returns "400x300"
       end
 
       should "return the width and height as json" do
@@ -58,7 +58,7 @@ class ScaleDown::Controller::Test < Test::Unit::TestCase
 
     context "for a non-existant image" do
       setup do
-        ScaleDown::Scaler.expects(:info).with("image/path/image.jpg").returns nil
+        ScaleDown::Dispatcher.expects(:info).with("image/path/image.jpg").returns nil
       end
 
       should "respond with a 404" do

data/test/scale_down/{scaler_test.rb → dispatcher_test.rb}

@@ -1,13 +1,13 @@
 require File.expand_path(File.dirname(__FILE__))+'/../test_helper'
 
-class ScaleDown::Scaler::Test < Test::Unit::TestCase
+class ScaleDown::Dispatcher::Test < Test::Unit::TestCase
 
-  context "Scaler::Test" do
+  context "Dispatcher::Test" do
     setup do
       ScaleDown.hmac_key    = "secret"
       ScaleDown.hmac_method = HMAC::SHA1
       ScaleDown.hmac_length = 8
-      ScaleDown.root_path   = "/tmp"
+      ScaleDown.public_path = "/tmp"
 
       hmac = HMAC::SHA1.new("secret").update("file/path/filename.png/400x300-crop").to_s
 
@@ -21,51 +21,51 @@ class ScaleDown::Scaler::Test < Test::Unit::TestCase
 
     context "instance" do
       setup do
-        @scaler = ScaleDown::Scaler.new @params
+        @dispatcher = ScaleDown::Dispatcher.new @params
       end
 
       should "validate the HMAC" do
         ScaleDown.expects(:valid_hmac?).with(@params).returns true
-        assert @scaler.valid_hmac?
+        assert @dispatcher.valid_hmac?
       end
 
       should "determine root file existance" do
         File.expects(:exists?).with("/tmp/file/path/filename.png").returns true
-        assert @scaler.root_file_exists?
+        assert @dispatcher.root_file_exists?
       end
 
       should "deterimine the scaled image's existance" do
         File.expects(:exists?).with("/tmp/file/path/scaled/filename-400x300-crop.png").returns true
-        assert @scaler.scaled_file_exists?
+        assert @dispatcher.scaled_file_exists?
       end
 
       should "parse the geometry params into options" do
-        assert_equal({:width => 400, :height => 300, :crop => true}, @scaler.image_options)
+        assert_equal({:width => 400, :height => 300, :crop => true}, @dispatcher.image_options)
       end
 
       should "have a redirect path" do
-        assert_equal "/file/path/scaled/filename-400x300-crop.png", @scaler.redirect_path
+        assert_equal "/file/path/scaled/filename-400x300-crop.png", @dispatcher.redirect_path
       end
 
       should "process the image" do
         ScaleDown::Image.expects(:scale).with(
-          :file    => @scaler.root_path,
-          :out     => @scaler.scaled_file_path,
-          :options => @scaler.image_options).returns true
+          :file    => @dispatcher.root_path,
+          :out     => @dispatcher.scaled_file_path,
+          :options => @dispatcher.image_options).returns true
 
-          assert @scaler.scale
+          assert @dispatcher.scale
       end
 
       should "default to a jpg out file" do
         ["jpg", "tga", "tif", "pdf", "psd"].each do |ext|
-          scaler = ScaleDown::Scaler.new @params.merge(:filename => "test.#{ext}")
-          assert_match /\.jpg$/, scaler.scaled_file_path
+          dispatcher = ScaleDown::Dispatcher.new @params.merge(:filename => "test.#{ext}")
+          assert_match /\.jpg$/, dispatcher.scaled_file_path
         end
       end
 
       should "use a png for png graphics" do
-        scaler = ScaleDown::Scaler.new @params.merge(:filename => "test.png")
-        assert_match /\.png$/, scaler.scaled_file_path
+        dispatcher = ScaleDown::Dispatcher.new @params.merge(:filename => "test.png")
+        assert_match /\.png$/, dispatcher.scaled_file_path
       end
     end
 
@@ -84,18 +84,18 @@ class ScaleDown::Scaler::Test < Test::Unit::TestCase
           end
 
           should "scale the image" do
-            ScaleDown::Scaler.process(@params)
+            ScaleDown::Dispatcher.process(@params)
           end
 
           should "return a 301 redirect to the processed image's URL" do
-            assert_equal ["/file/path/scaled/filename-400x300-crop.png", 301], ScaleDown::Scaler.process(@params)
+            assert_equal ["/file/path/scaled/filename-400x300-crop.png", 301], ScaleDown::Dispatcher.process(@params)
           end
         end
 
         context "without a valid HMAC" do
           should "return a 403 Forbidden response" do
             ScaleDown.expects(:valid_hmac?).returns false
-            assert_equal 403, ScaleDown::Scaler.process(@params)[1]
+            assert_equal 403, ScaleDown::Dispatcher.process(@params)[1]
           end
         end
       end
@@ -107,7 +107,7 @@ class ScaleDown::Scaler::Test < Test::Unit::TestCase
         end
 
         should "return a 301 redirect to the processed image's URL" do
-          assert_equal ["/file/path/scaled/filename-400x300-crop.png", 301], ScaleDown::Scaler.process(@params)
+          assert_equal ["/file/path/scaled/filename-400x300-crop.png", 301], ScaleDown::Dispatcher.process(@params)
         end
       end
 
@@ -117,7 +117,7 @@ class ScaleDown::Scaler::Test < Test::Unit::TestCase
         end
 
         should "return a 404" do
-          assert_equal 404, ScaleDown::Scaler.process(@params)[1]
+          assert_equal 404, ScaleDown::Dispatcher.process(@params)[1]
         end
       end
     end
@@ -125,15 +125,15 @@ class ScaleDown::Scaler::Test < Test::Unit::TestCase
 
   context "#info" do
     setup do
-      ScaleDown.root_path = File.join(File.expand_path(File.dirname(__FILE__)), "..")
+      ScaleDown.public_path = File.join(File.expand_path(File.dirname(__FILE__)), "..")
     end
 
     should "return the width x height for an image" do
-      assert_equal "200x400", ScaleDown::Scaler.info("files/graphic.png")
+      assert_equal "200x400", ScaleDown::Dispatcher.info("files/graphic.png")
     end
 
     should "return nil for a non-existant image" do
-      assert_equal nil, ScaleDown::Scaler.info("files/notthere.jpg")
+      assert_equal nil, ScaleDown::Dispatcher.info("files/notthere.jpg")
     end
   end
 

data/test/scale_down_test.rb

@@ -16,7 +16,7 @@ class ScaleDown::Test < Test::Unit::TestCase
       ScaleDown.hmac_key    = "secret"
       ScaleDown.hmac_method = HMAC::SHA1
       ScaleDown.hmac_length = 8
-      ScaleDown.root_path   = "/tmp/scale_down"
+      ScaleDown.public_path = "/tmp/scale_down"
     end
 
     context "HMAC" do
@@ -40,7 +40,6 @@ class ScaleDown::Test < Test::Unit::TestCase
       end
     end
 
-
     context "integration test" do
       setup do
         FileUtils.mkdir_p("/tmp/scale_down/test_images/example_1")
@@ -65,10 +64,10 @@ class ScaleDown::Test < Test::Unit::TestCase
         assert_equal 404, last_response.status
       end
 
-      should "get an invalid image and return a 403" do
+      should "get an invalid image and return a 500" do
         valid_get '/test_images/example_2/invalid_jpeg.jpg/400x300-cropped'
 
-        assert_equal 403, last_response.status
+        assert_equal 500, last_response.status
         assert !File.exists?("/tmp/scale_down/test_images/example_2/scaled/invalid_jpeg-400x300-cropped.jpg")
       end
     end

data/test/scaled_image_tag_test.rb

@@ -1,21 +1,33 @@
 require File.expand_path(File.dirname(__FILE__))+'/test_helper'
 
+require 'cgi'
+
 class ScaleDown::Test < Test::Unit::TestCase
 
-  def scaled_image_src(url)
-    hmac = HMAC::SHA1.new("secret").update(url).to_s[0...8]
-    "http://images.myserver.com#{url}/#{hmac}"
+  def signed_image_url(path, filename, options)
+    hmac = HMAC::SHA1.new("secret").update([path, filename, options].join("/")).to_s[0...8]
+    "http://images.myserver.com#{[path, CGI.escape(filename), options, hmac].join("/")}"
   end
 
   setup do
     ScaleDown.hmac_key    = "secret"
     ScaleDown.hmac_method = HMAC::SHA1
     ScaleDown.hmac_length = 8
-    ScaleDown.root_path   = "/tmp"
+    ScaleDown.public_path = "/tmp"
   end
 
   should "create a URL with the HMAC signature" do
     hmac = ScaleDown.hmac("/images/graphic.png/400x300-cropped")
-    assert_equal "http://images.myserver.com/images/graphic.png/400x300-cropped/#{hmac}", scaled_image_src("/images/graphic.png/400x300-cropped")
+    assert_equal\
+      "http://images.myserver.com/images/graphic.png/400x300-cropped/#{hmac}",
+      signed_image_url("/images","graphic.png","400x300-cropped")
+  end
+
+  should "create a URL when the filename has URI break characters" do
+    filename = "# !%23?.png"
+    hmac = ScaleDown.hmac("/images/#{filename}/400x300-cropped")
+    assert_equal\
+      "http://images.myserver.com/images/#{CGI.escape filename}/400x300-cropped/#{hmac}",
+      signed_image_url("/images", filename, "400x300-cropped")
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: scale_down
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - John Weir
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-01 00:00:00 -04:00
+date: 2010-11-05 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -148,8 +148,8 @@ files:
 - lib/scale_down.rb
 - lib/scale_down/configuration.rb
 - lib/scale_down/controller.rb
+- lib/scale_down/dispatcher.rb
 - lib/scale_down/image.rb
-- lib/scale_down/scaler.rb
 - lib/scale_down/version.rb
 - scale_down.gemspec
 - test/files/cmyk.tif
@@ -158,8 +158,8 @@ files:
 - test/files/orient.jpg
 - test/scale_down/configuration_test.rb
 - test/scale_down/controller_test.rb
+- test/scale_down/dispatcher_test.rb
 - test/scale_down/image_test.rb
-- test/scale_down/scaler_test.rb
 - test/scale_down_test.rb
 - test/scaled_image_tag_test.rb
 - test/test_helper.rb
@@ -204,8 +204,8 @@ test_files:
 - test/files/orient.jpg
 - test/scale_down/configuration_test.rb
 - test/scale_down/controller_test.rb
+- test/scale_down/dispatcher_test.rb
 - test/scale_down/image_test.rb
-- test/scale_down/scaler_test.rb
 - test/scale_down_test.rb
 - test/scaled_image_tag_test.rb
 - test/test_helper.rb