scale_down 0.2.1 → 0.2.2

data/CHANGES

@@ -1,3 +1,10 @@
+== 2011-05-08 ==
+Removed MiniMagick and using RMagick
+MiniMagick was not returning the dimensions on some images. I was able to get RMagick to work without leaking memory
+
+== 2011-04-03 ==
+Fixed CMYK conversion of gray scale images
+
 == 2010-11-19 ==
 
 Changed to url schema to be

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    scale_down (0.1.0)
-      mini_magick (>= 2.3)
+    scale_down (0.2.1)
       rmagick (>= 2.1)
       ruby-hmac (>= 0.4.0)
       sinatra (>= 1.0)
@@ -10,30 +9,25 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    contest (0.1.2)
-    mini_magick (2.3)
-      subexec (~> 0.0.4)
+    contest (0.1.3)
     mocha (0.9.8)
       rake
-    rack (1.2.1)
+    rack (1.2.2)
     rack-test (0.5.6)
       rack (>= 1.0)
     rake (0.8.7)
     rmagick (2.13.1)
     ruby-hmac (0.4.0)
-    sinatra (1.0)
-      rack (>= 1.0)
-    subexec (0.0.4)
+    sinatra (1.2.6)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    tilt (1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   contest (>= 0.1.2)
-  mini_magick (>= 2.3)
   mocha (= 0.9.8)
   rack-test (= 0.5.6)
-  rmagick (>= 2.1)
-  ruby-hmac (>= 0.4.0)
   scale_down!
-  sinatra (>= 1.0)

data/README.rdoc

@@ -1,26 +1,26 @@
 = ScaleDown
 
-A RESTful server for quickly scaling and serving images. Nothing more.
+A Sinatra web server for scaling and serving images on demand, nothing more.
 
-Supports cropping images and converts CMYK to RGB.
+Images are scaled based upon their URL. An HMAC signature is used to prevent unauthorized scaling of images.
 
-Images are scaled based upon their URL. An HMAC signature is used to prevent malicious scaling of images (ie: bring your server down.)
+Supports cropping images and converts CMYK to RGB.
 
-The schema is simple
+The URL schema
 
-  http://:server/:geometry/:path_to_file/:filename?:hmac_signature
+  http://:host/:geometry/:path_to_file/:filename?:hmac_signature
 
-  :server is the address running ScaleDown
+  :host is the address running ScaleDown
 
-  :geometry is widtxheight.  There can be an optional `-crop` flag attached.
+  :geometry is width x height and an optional `-crop`
 
-  :path_to_file is the public path to the file
+  :path_to_file is the public path of the original file
 
   :filename is the name of the image to scale
 
-  :hmac_signature is security measure to validate the request
+  :hmac_signature a security measure to validate the request
 
-For example
+Example
 
   http://images.example.com/400x300/images/logo.png?A3SDACEDF
 
@@ -28,13 +28,13 @@ For example
 
   http://images.example.com/images/scaled/400x300/logo.png
 
-To crop an image include the 'cropped' option
+To crop an image include the 'crop' option.  The image will be scaled and cropped to fit the geometry.
 
-  http://images.example.com/400x300-cropped/images/logo.png?A3SDACEDF
+  http://images.example.com/400x300-crop/images/logo.png?A3SDACEDF
 
-Use 'auto' to have an image scale to one dimension or another.
+Using 'auto' as a dimension will fit the image to other dimension.
 
-For example, to ensure an image is 300 pixels wide
+For example, to ensure an image is 300 pixels wide set the height to auto
 
   http://images.example.com/300xauto/images/logo.png/?A3SDACEDF
 
@@ -46,62 +46,51 @@ There is a very simple `/info` function for getting the image dimesions. It just
 
   gem install scale_down
 
-Create a rackup file (config.ru)
+Create a rackup file (config.ru). See http://rubydoc.info/gems/scale_down/0.2.1/ScaleDown more options
 
+  require 'rubygems'
   require 'scale_down'
 
   ScaleDown.tap do |config|
-
-    # This is the shared secret.  Use something strong
-    # Perhaps a visit to http://www.random.org/strings/?num=10&len=20&digits=on&upperalpha=on&format=html&rnd=new
+    # Shared secret for generating the HMAC signature
     config.hmac_key    = "secret"
 
-    # You can use a different HMAC, see the ruby-hmac gen
-    config.hmac_method = HMAC::SHA1
-
-    # The length of the HMAC signature to use
-    config.hmac_length = 8
-
-    # The path to the public directory
+    # Path to the public directory
     config.public_path = File.expand_path(File.dirname(__FILE__))+"/public"
-
-    # Optional logger
-    config.logger = Logger.new("/tmp/logfile.log")
   end
 
   run ScaleDown::Controller
 
-Start the server using whatever server you want.
-
-  thin start -p 3002
-
+Configure Nginx, Apache, etc to run the server. I use Passenger http://www.modrails.com/
 
-== Generating the URL
+=== Generating the URL
 
-In your application you will need to generate the URL for the image source.
-
-Filenames can have characters (# ? /) which may need to be escaped.
-
-Filenames should be CGI escaped before the HMAC is generated, and only escape the filename, not the path or options.
+Your application will need to generate the image's URL and HMAC signature.
 
   # Example ruby function to generate signed URL
   require 'HMAC::SHA1'
   require 'cgi'
 
   # ie signed_image_url('images', 'picture.png', '400x300-cropped')
-  def signed_image_url(path, filename, options)
-    hmac = HMAC::SHA1.new("secret").update("/#{options}/#{path}/#{filename}").to_s[0..8]
-    "http://images.myserver.com/#{options}/#{path}/#{CGI.escape(filename)}?#{hmac}"
+  def signed_image_url(path, filename, geometry)
+    hmac = HMAC::SHA1.new("secret").update("/#{geometry}/#{path}/#{filename}").to_s[0..8]
+    "http://images.myserver.com/#{geometry}/#{path}/#{CGI.escape(filename)}?#{hmac}"
   end
 
-Of course this could be done in PHP, Python, or whatever language your application is running.
+Of course this could be done in PHP, Node, Python, or other languages.
 
-== TODO
+== Known Issues
 
-Support DELETE requests to remove scaled images.
+Pluses in filenames will not route properly.  Filenames need to have these removed or replaced.
+
+== TODO
 
 Custom Read/Write methods to allow for more than just local storage.
 
+Examples using Node.js
+
+There is an issue on some systems with pluses in filenames.
+
 == Dependencies
 
 * Sinatra
@@ -116,7 +105,7 @@ LICENSE:
 
 (The MIT License)
 
-Copyright © 2010 John Weir & Fame Driver LLC
+Copyright © 2011 John Weir & Fame Driver LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/lib/scale_down/configuration.rb

@@ -4,35 +4,38 @@ module ScaleDown
     # Defines the method to use for generating an HMAC
     # For example
     #   ScaleDown.hmac_method = HMAC::SHA2
+    # Default HMAC::SHA1
     attr_accessor :hmac_method
+    ScaleDown.hmac_method = HMAC::SHA1
 
     # The shared secret for generating the hmac
     attr_accessor :hmac_key
 
     # How many characters of the HMAC are used for validation
+    # Default 8
     attr_accessor :hmac_length
+    ScaleDown.hmac_length = 8
 
     # 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
+    ScaleDown.max_dimensions = [1200,1200]
 
     # The max file size allowed for the file to be scaled, in bytes
-    # Defaults to  10 * 1_048_576
+    # Defaults 10 megabytes
     attr_accessor :max_file_size
+    ScaleDown.max_file_size  = 10 * 1_048_576
 
     # 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
 
-    # Defaults
-    ScaleDown.max_file_size  = 10 * 1_048_576
-    ScaleDown.max_dimensions = [1200,1200]
-
     def logger=(logger)
       @logger = logger
     end

data/lib/scale_down/dispatcher.rb

@@ -22,8 +22,9 @@ class ScaleDown::Dispatcher
     def info(relative_path)
       path = [ScaleDown.public_path, relative_path].join("/")
       if File.exists?(path)
-        image = MiniMagick::Image.open(path)
-        [image[:width],image[:height]].join('x')
+        GC.start
+        image = Magick::Image.read(path).first
+        [image.columns, image.rows].join('x')
       else
         nil
       end

data/lib/scale_down/version.rb

@@ -1,3 +1,3 @@
 module ScaleDown
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/scale_down.rb

@@ -5,7 +5,6 @@ require 'rubygems'
 require 'sinatra'
 require 'logger'
 require 'RMagick'
-require 'mini_magick'
 require 'hmac-sha1'
 
 module ScaleDown

data/scale_down.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |s|
   s.add_dependency "rmagick", ">= 2.1"
   s.add_dependency "sinatra", ">= 1.0"
   s.add_dependency "ruby-hmac", ">= 0.4.0"
-  s.add_dependency "mini_magick", ">= 2.3"
 
   s.add_development_dependency "contest", ">= 0.1.2"
   s.add_development_dependency "mocha", "0.9.8"

data/test/scale_down/controller_test.rb

@@ -12,11 +12,11 @@ class ScaleDown::Controller::Test < Test::Unit::TestCase
       ScaleDown::Dispatcher.expects(:process).with(
         :path     => "user/path",
         :filename => "filename.png",
-        :geometry => "400x300-cropped-grayscale",
+        :geometry => "400x300-crop-grayscale",
         :hmac     => "HMAC").
       returns ["path","status"]
 
-      get '/400x300-cropped-grayscale/user/path/filename.png?HMAC'
+      get '/400x300-crop-grayscale/user/path/filename.png?HMAC'
     end
   end
 
@@ -26,7 +26,7 @@ class ScaleDown::Controller::Test < Test::Unit::TestCase
       get "/geo/path/filename?hmac"
 
       assert_equal 301, last_response.status
-      assert_equal "/image-path", last_response["Location"]
+      assert_equal "http://example.org/image-path", last_response["Location"]
     end
   end
 

data/test/scale_down/image_test.rb

@@ -135,18 +135,26 @@ class ScaleDown::Image::Test < Test::Unit::TestCase
     end
   end
 
-  context "color correction" do
-    setup do
-      @subject = create \
+  context "CMYK images" do
+    should "be converted to RGB" do
+      create \
         tests_path("files/cmyk.tif"),
         tests_path("scaled_test/graphic_scaled.jpg"),
         { :width => "auto", :height => 200}
-    end
 
-    should "be automatic" do
       image = Magick::Image.read(tests_path("scaled_test/graphic_scaled.jpg")).first
       assert_equal Magick::RGBColorspace, image.colorspace
     end
+
+    should "convert JPGs to RGB JPEGS" do
+      create \
+        tests_path("files/cmyk_gray.jpg"),
+        tests_path("scaled_test/graphic_scaled_2.jpg"),
+        { :width => "auto", :height => 200}
+
+      image = Magick::Image.read(tests_path("scaled_test/graphic_scaled_2.jpg")).first
+      assert_equal Magick::RGBColorspace, image.colorspace
+    end
   end
 
 end

data/test/scale_down_test.rb

@@ -52,10 +52,16 @@ class ScaleDown::Test < Test::Unit::TestCase
         FileUtils.rm_r("/tmp/scale_down")
       end
 
+      should "get image info" do
+        FileUtils.cp tests_path("files/cmyk.tif"), "/tmp/scale_down/test_images/example_1/long name .tiff"
+        get "/test_images/example_1/#{CGI.escape 'long name .tiff'}/info"
+        assert_equal "300x500", last_response.body
+      end
+
       should "get an image and scale it" do
         valid_get '/400x300-cropped/test_images/example_1/graphic.png'
         assert_equal 301, last_response.status
-        assert_equal "/test_images/example_1/scaled/graphic-400x300-cropped.png", last_response["Location"]
+        assert_match "/test_images/example_1/scaled/graphic-400x300-cropped.png", last_response["Location"]
         assert File.exists?("/tmp/scale_down/test_images/example_1/scaled/graphic-400x300-cropped.png")
       end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: scale_down
 version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - John Weir
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-11 00:00:00 -05:00
+date: 2011-05-10 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,25 +64,10 @@ dependencies:
         version: 0.4.0
   type: :runtime
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: mini_magick
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 3
-        version: "2.3"
-  type: :runtime
-  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: contest
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -94,11 +79,11 @@ dependencies:
         - 2
         version: 0.1.2
   type: :development
-  version_requirements: *id005
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: mocha
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -110,11 +95,11 @@ dependencies:
         - 8
         version: 0.9.8
   type: :development
-  version_requirements: *id006
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rack-test
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -126,7 +111,7 @@ dependencies:
         - 6
         version: 0.5.6
   type: :development
-  version_requirements: *id007
+  version_requirements: *id006
 description: ""
 email: 
 - john@famedriver.com
@@ -154,6 +139,7 @@ files:
 - lib/scale_down/version.rb
 - scale_down.gemspec
 - test/files/cmyk.tif
+- test/files/cmyk_gray.jpg
 - test/files/graphic.png
 - test/files/invalid_jpeg.jpg
 - test/files/orient.jpg
@@ -194,12 +180,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: scale_down
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: A Sinatra based server for quickly scaling and serving images. Nothing more.
 test_files: 
 - test/files/cmyk.tif
+- test/files/cmyk_gray.jpg
 - test/files/graphic.png
 - test/files/invalid_jpeg.jpg
 - test/files/orient.jpg