scale_down 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    scale_down (0.0.1)
+    scale_down (0.0.3)
       rake (>= 0.8.7)
       rmagick (>= 2.1)
       rmagick (>= 2.1)

data/README.rdoc

@@ -8,54 +8,85 @@ Images are scaled based upon their URL. An HMAC signature is used to prevent mal
 
 For example
 
-    [  image server address  ][ image source ][ size ][ hmac  ]
-    http://images.example.com/images/logo.png/400x300/A3SDACEDF
+  [  image server address  ][ image source ][ size ][ hmac  ]
+  http://images.example.com/images/logo.png/400x300/A3SDACEDF
 
-    would redirect to (via 301) the scaled image
+  would 301 redirect to the scaled image
 
-    http://images.example.com/images/scaled/logo-400x300.png
+  http://images.example.com/images/scaled/logo-400x300.png
 
 To crop an image include the 'cropped' option
 
-    http://images.example.com/images/logo.png/400x300-cropped/A3SDACEDF
+  http://images.example.com/images/logo.png/400x300-cropped/A3SDACEDF
 
 Use 'auto' to have an image scale to one dimension or another.
 
 For example, to ensure an image is 300 pixels wide
 
-    http://images.example.com/images/logo.png/300xauto/A3SDACEDF
+  http://images.example.com/images/logo.png/300xauto/A3SDACEDF
 
+== Installation and Configuration
 
-== Configuration
+  gem install scale_down
 
-    ScaleDown::Scaler.hmac_key    = "secret"
-    ScaleDown::Scaler.hmac_method = HMAC::MD5
-    ScaleDown::Scaler.hmac_length = 8
-    ScaleDown::Scaler.root_path   = "/tmp/scale_down"
+Create a rackup file (config.ru)
 
-== Example URL generator
+  require 'scale_down'
 
-    require 'HMAC::MD5'
+  ScaleDown.tap do |config|
 
-    # ie scaled_image_src('/images/picture.png/400x300-cropped')
-    def scaled_image_src(url)
-      hmac = HMAC::MD5.new("secret").update(url).to_s[0...8]
-      "http://images.myserver.com#{url}/#{hmac}"
-    end
+    # 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
+    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 root path to the images.  Use a symlink if it is helpful
+    config.root_path   = File.expand_path(File.dirname(__FILE__))+"/public"
+  end
+
+  run ScaleDown::Controller
+
+Start the server using whatever server you want.
+
+  thin start -p 3002
+
+
+== Generating the URL
+
+In your application with the images you will need to generate the URL for the image source.
+
+  require 'HMAC::SHA1'
+
+  # 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}"
+  end
+
+Of course this could be done in PHP, Python, or whatever language your application is running.
 
 == TODO
 
 This thing is brand spankin new and is in flux - expect changes.
 
 Define a max image size (do not scale images over this size).
+
 Support DELETE requests to remove scaled images.
-Custom Read/Write methods.  Allow for more than just local storage.
+
+Custom Read/Write methods to allow for more than just local storage.
 
 == Dependencies
 
-Sinatra
-RMagick
-Ruby-HMAC
+* Sinatra
+* RMagick
+* Ruby-HMAC
+
+RMagick can be a bit tricky to install, these links[http://www.google.com/search?q=install+rmagick] might help.
 
 == License
 
@@ -70,4 +101,3 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

data/config_sample.ru

@@ -1,8 +1,19 @@
 require 'scale_down'
 
-ScaleDown::Scaler.hmac_key    = "secret"
-ScaleDown::Scaler.hmac_method = HMAC::MD5
-ScaleDown::Scaler.hmac_length = 8
-ScaleDown::Scaler.root_path   = File.expand_path(File.dirname(__FILE__))+"/public"
+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
+  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 root path to the images
+  config.root_path   = File.expand_path(File.dirname(__FILE__))+"/public"
+end
 
 run ScaleDown::Controller

data/lib/scale_down/scaler.rb

@@ -1,12 +1,6 @@
-require 'RMagick'
-require 'hmac-md5'
-require 'hmac-sha1'
-
 class ScaleDown::Scaler
 
   class << self
-    attr_accessor :hmac_method, :hmac_key, :hmac_length
-    attr_accessor :root_path
 
     def process(params)
       scaler = new(params)
@@ -20,15 +14,6 @@ class ScaleDown::Scaler
         ["Error message", 403]
       end
     end
-
-    def valid_hmac?(params)
-      str = [params[:path], "/", params[:filename], "/", params[:geometry]].join
-      hmac(str) == params[:hmac]
-    end
-
-    def hmac(string)
-      hmac_method.new(hmac_key).update(string).to_s[0...hmac_length]
-    end
   end
 
   def initialize(params)
@@ -51,7 +36,7 @@ class ScaleDown::Scaler
   end
 
   def valid_hmac?
-    self.class.valid_hmac?(@params)
+    ScaleDown.valid_hmac?(@params)
   end
 
   def redirect_path
@@ -67,11 +52,11 @@ class ScaleDown::Scaler
   end
 
   def root_path
-    File.join(self.class.root_path, @params[:path], @params[:filename])
+    File.join(ScaleDown.root_path, @params[:path], @params[:filename])
   end
 
   def scaled_file_path
-    File.join(self.class.root_path, redirect_path)
+    File.join(ScaleDown.root_path, redirect_path)
   end
 
   def scaled_filename

data/lib/scale_down/version.rb

@@ -1,3 +1,3 @@
 module ScaleDown
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/scale_down.rb

@@ -3,10 +3,26 @@ $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
 require 'rubygems'
 require 'sinatra'
+require 'RMagick'
+require 'hmac-sha1'
 
 module ScaleDown
   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
+
+  def self.valid_hmac?(params)
+    str = ["/",params[:path], "/", params[:filename], "/", params[:geometry]].join
+    hmac(str) == params[:hmac]
+  end
+
+  def self.hmac(string)
+    hmac_method.new(hmac_key).update(string).to_s[0...hmac_length]
+  end
 end

data/test/scale_down/scaler_test.rb

@@ -4,12 +4,12 @@ class ScaleDown::Scaler::Test < Test::Unit::TestCase
 
   context "Scaler::Test" do
     setup do
-      ScaleDown::Scaler.hmac_key    = "secret"
-      ScaleDown::Scaler.hmac_method = HMAC::MD5
-      ScaleDown::Scaler.hmac_length = 8
-      ScaleDown::Scaler.root_path   = "/tmp"
+      ScaleDown.hmac_key    = "secret"
+      ScaleDown.hmac_method = HMAC::SHA1
+      ScaleDown.hmac_length = 8
+      ScaleDown.root_path   = "/tmp"
 
-      hmac = HMAC::MD5.new("secret").update("file/path/filename.png/400x300-crop").to_s
+      hmac = HMAC::SHA1.new("secret").update("file/path/filename.png/400x300-crop").to_s
 
       @params = {
         :path     => "file/path",
@@ -19,23 +19,13 @@ class ScaleDown::Scaler::Test < Test::Unit::TestCase
       }
     end
 
-    context "HMAC" do
-      should "validate when the params match the HMAC signature" do
-        assert ScaleDown::Scaler.valid_hmac?(@params)
-      end
-
-      should "not validate when the params do not match the HMAC signature" do
-        assert !ScaleDown::Scaler.valid_hmac?(@params.merge(:path => "file/different"))
-      end
-    end
-
     context "instance" do
       setup do
         @scaler = ScaleDown::Scaler.new @params
       end
 
       should "validate the HMAC" do
-        ScaleDown::Scaler.expects(:valid_hmac?).with(@params).returns true
+        ScaleDown.expects(:valid_hmac?).with(@params).returns true
         assert @scaler.valid_hmac?
       end
 
@@ -89,7 +79,7 @@ class ScaleDown::Scaler::Test < Test::Unit::TestCase
 
         context "with a valid HMAC" do
           setup do
-            ScaleDown::Scaler.expects(:valid_hmac?).returns true
+            ScaleDown.expects(:valid_hmac?).returns true
             ScaleDown::Image.expects(:scale).returns true
           end
 
@@ -104,7 +94,7 @@ class ScaleDown::Scaler::Test < Test::Unit::TestCase
 
         context "without a valid HMAC" do
           should "return a 403 Forbidden response" do
-            ScaleDown::Scaler.expects(:valid_hmac?).returns false
+            ScaleDown.expects(:valid_hmac?).returns false
             assert_equal 403, ScaleDown::Scaler.process(@params)[1]
           end
         end

data/test/scale_down_test.rb

@@ -8,43 +8,69 @@ class ScaleDown::Test < Test::Unit::TestCase
   end
 
   def valid_get(path)
-    get "/#{path}/#{hmac(path, "secret")[0...8]}"
+    get "#{path}/#{ScaleDown.hmac(path)}"
   end
 
-  context "integration test" do
+  context "ScaleDown" do
     setup do
-      ScaleDown::Scaler.hmac_key    = "secret"
-      ScaleDown::Scaler.hmac_method = HMAC::MD5
-      ScaleDown::Scaler.hmac_length = 8
-      ScaleDown::Scaler.root_path   = "/tmp/scale_down"
-
-      FileUtils.mkdir_p("/tmp/scale_down/test_images/example_1")
-      FileUtils.cp tests_path("files/graphic.png"), "/tmp/scale_down/test_images/example_1/graphic.png"
-      FileUtils.mkdir_p("/tmp/scale_down/test_images/example_2")
-      FileUtils.cp tests_path("files/invalid_jpeg.jpg"), "/tmp/scale_down/test_images/example_2/invalid_jpeg.jpg"
+      ScaleDown.hmac_key    = "secret"
+      ScaleDown.hmac_method = HMAC::SHA1
+      ScaleDown.hmac_length = 8
+      ScaleDown.root_path   = "/tmp/scale_down"
     end
 
-    teardown do
-      FileUtils.rm_r("/tmp/scale_down")
-    end
+    context "HMAC" do
+      setup do
+        hmac = HMAC::SHA1.new("secret").update("/file/path/filename.png/400x300-crop").to_s
 
-    should "get an image and scale it" do
-      valid_get 'test_images/example_1/graphic.png/400x300-cropped'
-      assert_equal 301, last_response.status
-      assert_equal "/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
+        @params = {
+          :path     => "file/path",
+          :filename => "filename.png",
+          :geometry => "400x300-crop",
+          :hmac     => hmac[0...8]
+        }
+      end
 
-    should "get a nonexistant image and return a 404" do
-      valid_get "test_exmaples/example_none/image.jpg"
-      assert_equal 404, last_response.status
+      should "validate when the params match the HMAC signature" do
+        assert ScaleDown.valid_hmac?(@params)
+      end
+
+      should "not validate when the params do not match the HMAC signature" do
+        assert !ScaleDown.valid_hmac?(@params.merge(:path => "file/different"))
+      end
     end
 
-    should "get an invalid image and return a 403" do
-      valid_get 'test_images/example_2/invalid_jpeg.jpg/400x300-cropped'
 
-      assert_equal 403, last_response.status
-      assert !File.exists?("/tmp/scale_down/test_images/example_2/scaled/invalid_jpeg-400x300-cropped.jpg")
+    context "integration test" do
+      setup do
+        FileUtils.mkdir_p("/tmp/scale_down/test_images/example_1")
+        FileUtils.cp tests_path("files/graphic.png"), "/tmp/scale_down/test_images/example_1/graphic.png"
+        FileUtils.mkdir_p("/tmp/scale_down/test_images/example_2")
+        FileUtils.cp tests_path("files/invalid_jpeg.jpg"), "/tmp/scale_down/test_images/example_2/invalid_jpeg.jpg"
+      end
+
+      teardown do
+        FileUtils.rm_r("/tmp/scale_down")
+      end
+
+      should "get an image and scale it" do
+        valid_get '/test_images/example_1/graphic.png/400x300-cropped'
+        assert_equal 301, last_response.status
+        assert_equal "/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
+
+      should "get a nonexistant image and return a 404" do
+        valid_get "/test_exmaples/example_none/image.jpg"
+        assert_equal 404, last_response.status
+      end
+
+      should "get an invalid image and return a 403" do
+        valid_get '/test_images/example_2/invalid_jpeg.jpg/400x300-cropped'
+
+        assert_equal 403, last_response.status
+        assert !File.exists?("/tmp/scale_down/test_images/example_2/scaled/invalid_jpeg-400x300-cropped.jpg")
+      end
     end
   end
 end

data/test/scaled_image_tag_test.rb

@@ -3,21 +3,19 @@ require File.expand_path(File.dirname(__FILE__))+'/test_helper'
 class ScaleDown::Test < Test::Unit::TestCase
 
   def scaled_image_src(url)
-    hmac = HMAC::MD5.new("secret").update(url).to_s[0...8]
+    hmac = HMAC::SHA1.new("secret").update(url).to_s[0...8]
     "http://images.myserver.com#{url}/#{hmac}"
   end
 
   setup do
-    ScaleDown::Scaler.hmac_key    = "secret"
-    ScaleDown::Scaler.hmac_method = HMAC::MD5
-    ScaleDown::Scaler.hmac_length = 8
-    ScaleDown::Scaler.root_path   = "/tmp"
+    ScaleDown.hmac_key    = "secret"
+    ScaleDown.hmac_method = HMAC::SHA1
+    ScaleDown.hmac_length = 8
+    ScaleDown.root_path   = "/tmp"
   end
 
   should "create a URL with the HMAC signature" do
-    hmac = ScaleDown::Scaler.hmac("/images/graphic.png/400x300-cropped")
+    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")
   end
 end
-
-

data/test/test_helper.rb

@@ -11,7 +11,7 @@ require 'forwardable'
 class Test::Unit::TestCase
 
   def hmac(path, secret)
-    hmac = HMAC::MD5.new(secret).update(path).to_s
+    hmac = HMAC::SHA1.new(secret).update(path).to_s
   end
 
   def tests_path(append)

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
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - John Weir