scale_down 0.0.4 → 0.0.5

data/.gitignore

@@ -1,3 +1,5 @@
 pkg/*
 *.gem
 .bundle
+gen_tags
+public

data/README.rdoc

@@ -47,6 +47,10 @@ Create a rackup file (config.ru)
 
     # 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.
+    config.public_path = File.expand_path(File.dirname(__FILE__))+"/public"
+
   end
 
   run ScaleDown::Controller
@@ -65,9 +69,11 @@ In your application with the images you will need to generate the URL for the im
   # 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#{url}/#{hmac}"
+    "http://images.myserver.com#{URI.encode(url)}/#{hmac}"
   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

@@ -14,6 +14,11 @@ ScaleDown.tap do |config|
 
   # 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"
+
 end
 
 run ScaleDown::Controller

data/lib/scale_down/configuration.rb

@@ -0,0 +1,40 @@
+module ScaleDown
+  class << self
+
+    # Defines the method to use for generating an HMAC
+    # For example
+    #   ScaleDown.hmac_method = HMAC::SHA2
+    attr_accessor :hmac_method
+
+    # The shared secret for generating the hmac
+    attr_accessor :hmac_key
+
+    # How many characters of the HMAC are used for validation
+    attr_accessor :hmac_length
+
+    # An array of the max width and height an image can be scaled, in pixels.
+    # [800,600] would limit scaling operations to 800px wide by 600px tall
+    # Default [1200,1200]
+    attr_accessor :max_dimensions
+
+    # The max file size allowed for the file to be scaled, in bytes
+    # Defaults to  10 * 1_048_576
+    attr_accessor :max_file_size
+
+    # The location of the public path for you application
+    # +Must be set+
+    attr_accessor :public_path
+    def public_path=(str)
+      @public_path = str
+      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]
+
+  end
+end

data/lib/scale_down/controller.rb

@@ -3,17 +3,31 @@ class ScaleDown::Controller < Sinatra::Application
   set :raise_errors, true
   set :show_exceptions, false
   set :static, true
-  set :public, "/Users/johnweir/Sites/famedriver/site/public"
 
   get '/' do
     "<b>ScaleDown version #{ScaleDown::VERSION}<b/>"
   end
 
-  get '/*/:filename/:geometry/:hmac' do
+  # get '/*/:filename/:geometry/:hmac'
+  # is what I want, but
+  # this fails when the URL includes things like %23 (an encoded hash tag)
+  get '/*' do
+    parts = params[:splat].join("/").split("/")
+
+    params = {
+      :hmac     => parts.pop,
+      :geometry => parts.pop,
+      :filename => parts.pop,
+      :splat    => parts
+    }
+
     path, status = scaler(params)
+
+    # TODO Eh? Shouldn't it be if 301
     unless status == 403
-      redirect path, status
+      redirect URI.encode(path), status
     else
+      # TODO error messages which explain what went wrong
       [status, "Error: this image could not be processed"]
     end
   end
@@ -22,7 +36,7 @@ class ScaleDown::Controller < Sinatra::Application
   def scaler(params)
     ScaleDown::Scaler.process \
       :path     => params[:splat].join("/"),
-      :filename => params[:filename],
+      :filename => URI.decode(params[:filename]),
       :geometry => params[:geometry],
       :hmac     => params[:hmac]
   end

data/lib/scale_down/image.rb

@@ -1,15 +1,32 @@
 require 'pathname'
 
 class ScaleDown::Image
+
   include Magick
 
   class << self
+
     def scale(properties)
       new(properties).valid?
     end
-    
+
     def geometry(properties)
-      Magick::Geometry.new(properties[:width], properties[:height], nil, nil, ">")
+      validate_geometry Magick::Geometry.new(properties[:width], properties[:height], nil, nil, ">")
+    end
+
+    # Ensures that the dimensions are not both 'auto' and within the max dimensions
+    def validate_geometry(geometry)
+      geometry.tap do |g|
+        total = g.width + g.height
+        raise ScaleDown::InvalidGeometry if total == 0
+        raise ScaleDown::InvalidGeometry if g.width > ScaleDown.max_dimensions[0] || g.height > ScaleDown.max_dimensions[1]
+      end
+    end
+
+    def validate_file_size(file_path)
+      unless File.size(file_path) < ScaleDown.max_file_size
+        raise ScaleDown::FileSizeTooLarge
+      end
     end
   end
 
@@ -23,13 +40,14 @@ class ScaleDown::Image
     save if @file
   end
 
-  def load_file(filepath)
+  def load_file(file_path)
+    self.class.validate_file_size(file_path)
     begin
-      Magick::Image.read(filepath).first
+      Magick::Image.read(file_path).first
     rescue Magick::ImageMagickError => e
       return nil
     end
-  end 
+  end
 
   def geometry(properties)
     self.class.geometry properties
@@ -41,7 +59,7 @@ class ScaleDown::Image
 
   protected
 
-    def save 
+    def save
       path = Pathname.new(@out).dirname.to_s
       FileUtils.mkdir_p path unless FileTest.directory? path
       resize

data/lib/scale_down/version.rb

@@ -1,3 +1,3 @@
 module ScaleDown
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/scale_down.rb

@@ -7,15 +7,15 @@ require 'RMagick'
 require 'hmac-sha1'
 
 module ScaleDown
+  require 'scale_down/configuration'
   require 'scale_down/version'
   require 'scale_down/controller'
   require 'scale_down/scaler'
   require 'scale_down/image'
 
-  class << self
-    attr_accessor :hmac_method, :hmac_key, :hmac_length
-    attr_accessor :root_path
-  end
+  class InvalidGeometry < Exception; end
+  class FileSizeTooLarge < Exception; end
+
 
   def self.valid_hmac?(params)
     str = ["/",params[:path], "/", params[:filename], "/", params[:geometry]].join

data/test/scale_down/configuration_test.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__))+'/../test_helper'
+
+class ScaleDown::Test < Test::Unit::TestCase
+
+  context "Configuration" do
+    context "public_path" do
+      should "set the controller's public setting" do
+        ScaleDown.public_path = "/tmp/directory"
+        assert_equal "/tmp/directory", ScaleDown::Controller.public
+      end
+    end
+  end
+end

data/test/scale_down/controller_test.rb

@@ -42,4 +42,5 @@ class ScaleDown::Controller::Test < Test::Unit::TestCase
       assert_match "Error", last_response.body
     end
   end
+
 end

data/test/scale_down/image_test.rb

@@ -43,7 +43,7 @@ class ScaleDown::Image::Test < Test::Unit::TestCase
       assert_equal 400, geo.height
     end
 
-    should "auto scale" do
+    should "auto scale any one dimensions" do
       assert create \
         tests_path("files/graphic.png"),
         tests_path("scaled_test/graphic_scaled.png"),
@@ -53,6 +53,24 @@ class ScaleDown::Image::Test < Test::Unit::TestCase
       assert_equal 150, image.rows
       assert_equal 75, image.columns
     end
+
+    should "return nil if both dimensions are 'auto'" do
+      assert_raises ScaleDown::InvalidGeometry do
+        ScaleDown::Image.geometry :width => "auto", :height => "auto"
+      end
+    end
+
+    should "raise an error if either dimension is outside of the ScaleDown.max_dimensions" do
+      ScaleDown.max_dimensions = [1200,1200]
+
+      assert_raises ScaleDown::InvalidGeometry do
+        ScaleDown::Image.geometry :width => 1300, :height => 900
+      end
+
+      assert_raises ScaleDown::InvalidGeometry do
+        ScaleDown::Image.geometry :width => 900, :height => 1300
+      end
+    end
   end
 
   context "an invalid file" do
@@ -72,6 +90,21 @@ class ScaleDown::Image::Test < Test::Unit::TestCase
     end
   end
 
+  context "a file larger than the MAX_SIZE" do
+    setup do
+      File.expects(:size).with(tests_path("files/graphic.png")).at_least_once.returns(50 * 1_048_576)
+    end
+
+    should "raise an exception" do
+      assert_raises ScaleDown::FileSizeTooLarge do
+        @subject = create \
+          tests_path("files/graphic.png"),
+          tests_path("scaled_test/graphic_scaled.png"),
+          { :width => 100, :height => 105 }
+      end
+    end
+  end
+
   context "cropping" do
     setup do
       @subject = create \

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: scale_down
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - John Weir
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-19 00:00:00 -04:00
+date: 2010-10-23 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -130,8 +130,8 @@ files:
 - Rakefile
 - color_profiles/sRGB.icm
 - config_sample.ru
-- gen_tags
 - lib/scale_down.rb
+- lib/scale_down/configuration.rb
 - lib/scale_down/controller.rb
 - lib/scale_down/image.rb
 - lib/scale_down/scaler.rb
@@ -141,6 +141,7 @@ files:
 - test/files/graphic.png
 - test/files/invalid_jpeg.jpg
 - test/files/orient.jpg
+- test/scale_down/configuration_test.rb
 - test/scale_down/controller_test.rb
 - test/scale_down/image_test.rb
 - test/scale_down/scaler_test.rb
@@ -186,6 +187,7 @@ test_files:
 - test/files/graphic.png
 - test/files/invalid_jpeg.jpg
 - test/files/orient.jpg
+- test/scale_down/configuration_test.rb
 - test/scale_down/controller_test.rb
 - test/scale_down/image_test.rb
 - test/scale_down/scaler_test.rb

data/gen_tags

@@ -1,2 +0,0 @@
-#!/bin/sh
-ctags -R . /Users/johnweir/.rvm/gems/ruby-1.8.7-p302\@famedriver-images/gems/