dragonfly 0.1.0

data/spec/dragonfly/url_handler_spec.rb

@@ -0,0 +1,246 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Dragonfly::UrlHandler do
+  
+  before(:each) do
+    @url_handler = Dragonfly::UrlHandler.new
+  end
+  
+  describe "extracting parameters from the url" do
+    
+    before(:each) do
+      @url_handler.configure{|c| c.protect_from_dos_attacks = false}
+      @path = "/images/some_image.jpg"
+      @query_string = "m=b&o[d]=e&o[j]=k&e[l]=m"
+      @parameters = @url_handler.url_to_parameters(@path, @query_string)
+    end
+    
+    it "should correctly extract the uid" do
+      @parameters.uid.should == 'images/some_image'
+    end
+    
+    it "should behave the same if there is no beginning slash" do
+      parameters = @url_handler.url_to_parameters('images/some_image.jpg', @query_string)
+      parameters.uid.should == 'images/some_image'
+    end
+    
+    it "should take into account the path prefix if there is one" do
+      @url_handler.path_prefix = '/images'
+      parameters = @url_handler.url_to_parameters('/images/2009/some_image.jpg', @query_string)
+      parameters.uid.should == '2009/some_image'
+    end
+    
+    it "should raise an UnknownUrl error if the url doesn't have the path prefix" do
+      @url_handler.path_prefix = '/images'
+      lambda{
+        parameters = @url_handler.url_to_parameters('/wrongprefix/2009/some_image.jpg', @query_string)
+      }.should raise_error(Dragonfly::UrlHandler::UnknownUrl)
+    end
+    
+    it "should correctly extract the format" do
+      @parameters.format.should == 'jpg'
+    end
+    
+    it "should correctly extract the processing method" do
+      @parameters.processing_method.should == 'b'
+    end
+    
+    it "should correctly extract the processing_options" do
+      @parameters.processing_options.should == {:j => 'k', :d => 'e'}
+    end
+    
+    it "should correctly extract the encoding" do
+      @parameters.encoding.should == {:l => 'm'}
+    end
+    
+    it "should have processing_options and encoding as optional" do
+      parameters = @url_handler.url_to_parameters(@path, 'm=b')
+      parameters.processing_options.should == {}
+      parameters.encoding.should == {}
+    end
+    
+    it "should use the parameters class passed in if initialized with one" do
+      parameters_class = mock('parameters_class')
+      url_handler = Dragonfly::UrlHandler.new(parameters_class)
+      url_handler.stub!(:validate_parameters)
+      parameters_class.should_receive(:new)
+      url_handler.url_to_parameters(@path, @query_string)
+    end
+    
+    it "should raise an UnknownUrl error if the path doesn't have an extension" do
+      lambda{
+        @url_handler.url_to_parameters('hello', @query_string)
+      }.should raise_error(Dragonfly::UrlHandler::UnknownUrl)
+    end
+
+    it "should raise an UnknownUrl error if the path doesn't have a uid bit" do
+      lambda{
+        @url_handler.url_to_parameters('.hello', @query_string)
+      }.should raise_error(Dragonfly::UrlHandler::UnknownUrl)
+    end
+    
+    it "should raise an UnknownUrl error if the path is only slashes" do
+      lambda{
+        @url_handler.url_to_parameters('/./', @query_string)
+      }.should raise_error(Dragonfly::UrlHandler::UnknownUrl)
+    end
+    
+    it "should set most of the path as the uid if there is more than one dot" do
+      parameters = @url_handler.url_to_parameters('hello.old.bean', @query_string)
+      parameters.uid.should == 'hello.old'
+      parameters.format.should == 'bean'
+    end
+    
+  end
+  
+  describe "forming a url from parameters" do
+    before(:each) do
+      @parameters = Dragonfly::Parameters.new
+      @parameters.uid = 'thisisunique'
+      @parameters.processing_method = 'b'
+      @parameters.processing_options = {:d => 'e', :j => 'k'}
+      @parameters.format = :gif
+      @parameters.encoding = {:x => 'y'}
+      @url_handler.configure{|c| c.protect_from_dos_attacks = false}
+    end
+    it "should correctly form a query string" do
+      @url_handler.parameters_to_url(@parameters).should match_url('/thisisunique.gif?m=b&o[d]=e&o[j]=k&e[x]=y')
+    end
+    it "should correctly form a query string when dos protection turned on" do
+      @url_handler.configure{|c| c.protect_from_dos_attacks = true}
+      @parameters.should_receive(:generate_sha).and_return('thisismysha12345')
+      @url_handler.parameters_to_url(@parameters).should match_url('/thisisunique.gif?m=b&o[d]=e&o[j]=k&e[x]=y&s=thisismysha12345')
+    end
+    it "should leave out any nil parameters" do
+      @parameters.processing_method = nil
+      @url_handler.parameters_to_url(@parameters).should match_url('/thisisunique.gif?o[d]=e&o[j]=k&e[x]=y')
+    end
+    it "should leave out any empty parameters" do
+      @parameters.processing_options = {}
+      @url_handler.parameters_to_url(@parameters).should match_url('/thisisunique.gif?m=b&e[x]=y')
+    end
+    it "should prefix with the path_prefix if there is one" do
+      @url_handler.path_prefix = '/images'
+      @url_handler.parameters_to_url(@parameters).should match_url('/images/thisisunique.gif?m=b&o[d]=e&o[j]=k&e[x]=y')
+    end
+    it "should validate the parameters" do
+      @parameters.should_receive(:validate!)
+      @url_handler.parameters_to_url(@parameters)
+    end
+    it "should escape any non-url friendly characters except for '/'" do
+      parameters = Dragonfly::Parameters.new :uid => 'hello/u"u', :processing_method => 'm"m', :format => 'jpg'
+      @url_handler.parameters_to_url(parameters).should == '/hello/u%22u.jpg?m=m%22m'
+    end
+  end
+  
+  describe "protecting from DOS attacks with SHA" do
+    
+    before(:each) do
+      @url_handler.configure{|c|
+        c.protect_from_dos_attacks = true
+        c.secret     = 'secret'
+        c.sha_length = 16
+      }
+      @path = "/images/some_image.jpg"
+      @query_string = "m=b&o[d]=e&o[j]=k"
+      @parameters = Dragonfly::Parameters.new
+      Dragonfly::Parameters.stub!(:new).and_return(@parameters)
+    end
+    
+    it "should return the parameters as normal if the sha is ok" do
+      @parameters.should_receive(:generate_sha).with('secret', 16).and_return('thisismysha12345')
+      lambda{
+        @url_handler.url_to_parameters(@path, "#{@query_string}&s=thisismysha12345")
+      }.should_not raise_error
+    end
+    
+    it "should raise an error if the sha is incorrect" do
+      @parameters.should_receive(:generate_sha).with('secret', 16).and_return('thisismysha12345')
+      lambda{
+        @url_handler.url_to_parameters(@path, "#{@query_string}&s=heyNOTmysha12345")
+      }.should raise_error(Dragonfly::UrlHandler::IncorrectSHA)
+    end
+    
+    it "should raise an error if the sha isn't given" do
+      lambda{
+        @url_handler.url_to_parameters(@path, @query_string)
+      }.should raise_error(Dragonfly::UrlHandler::SHANotGiven)
+    end
+    
+    describe "specifying the SHA length" do
+
+      before(:each) do
+        @url_handler.configure{|c|
+          c.sha_length = 3
+        }
+        Digest::SHA1.should_receive(:hexdigest).and_return("thisismysha12345")
+      end
+
+      it "should use a SHA of the specified length" do
+          lambda{
+            @url_handler.url_to_parameters(@path, "#{@query_string}&s=thi")
+          }.should_not raise_error
+      end
+
+      it "should raise an error if the SHA is correct but too long" do
+          lambda{
+            @url_handler.url_to_parameters(@path, "#{@query_string}&s=this")
+          }.should raise_error(Dragonfly::UrlHandler::IncorrectSHA)
+      end
+
+      it "should raise an error if the SHA is correct but too short" do
+          lambda{
+            @url_handler.url_to_parameters(@path, "#{@query_string}&s=th")
+          }.should raise_error(Dragonfly::UrlHandler::IncorrectSHA)
+      end
+      
+    end
+    
+    it "should use the secret given to create the sha" do
+      @url_handler.configure{|c| c.secret = 'digby' }
+      Digest::SHA1.should_receive(:hexdigest).with(string_matching(/digby/)).and_return('thisismysha12345')
+      @url_handler.url_to_parameters(@path, "#{@query_string}&s=thisismysha12345")
+    end
+    
+  end
+  
+  describe "#url_for" do
+    
+    it "should pass parameters from Parameter.from_args plus the uid to parameters_to_url" do
+      parameters_class = Class.new(Dragonfly::Parameters)
+      url_handler = Dragonfly::UrlHandler.new(parameters_class)
+      parameters_class.should_receive(:from_args).with(:a, :b, :c).and_return parameters_class.new(:processing_method => :resize)
+      url_handler.should_receive(:parameters_to_url).with(parameters_matching(:processing_method => :resize, :uid => 'some_uid')).and_return 'some.url'
+      url_handler.url_for('some_uid', :a, :b, :c)
+    end
+        
+  end
+  
+  describe "sanity check" do
+    it "parameters_to_url should exactly reverse map url_to_parameters" do
+      Digest::SHA1.should_receive(:hexdigest).exactly(:twice).and_return('thisismysha12345')
+      path = "/images/some_image.gif"
+      query_string = "m=b&o[d]=e&o[j]=k&e[l]=m&s=thisismysha12345"
+      parameters = @url_handler.url_to_parameters(path, query_string)
+      @url_handler.parameters_to_url(parameters).should match_url("#{path}?#{query_string}")
+    end
+    
+    it "url_to_parameters should exactly reverse map parameters_to_url" do
+      @url_handler.configure{|c| c.protect_from_dos_attacks = true}
+      parameters = Dragonfly::Parameters.new(
+        :processing_method => 'b',
+        :processing_options => {
+          :d => 'e',
+          :j => 'k'
+        },
+        :format => 'jpg',
+        :encoding => {:x => 'y'},
+        :uid => 'thisisunique'
+      )
+      
+      url = @url_handler.parameters_to_url(parameters)
+      @url_handler.url_to_parameters(*url.split('?')).should == parameters
+    end
+  end
+  
+end

data/spec/dragonfly_spec.rb

@@ -0,0 +1,4 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Dragonfly" do
+end

data/spec/image_matchers.rb

@@ -0,0 +1,31 @@
+def image_properties(data)
+  tempfile = Tempfile.new('image')
+  tempfile.write(data)
+  tempfile.close
+  details = `identify #{tempfile.path}`
+  # example of details string:
+  # myimage.png PNG 200x100 200x100+0+0 8-bit DirectClass 31.2kb
+  filename, format, geometry, geometry_2, depth, image_class, size = details.split(' ')
+  width, height = geometry.split('x')
+  {
+    :filename => filename,
+    :format => format.downcase,
+    :width => width,
+    :height => height,
+    :depth => depth,
+    :image_class => image_class,
+    :size => size
+  }
+end
+
+def have_width(width)
+  simple_matcher("have width #{width}"){|given| image_properties(given)[:width].to_i.should == width }
+end
+
+def have_height(height)
+  simple_matcher("have height #{height}"){|given| image_properties(given)[:height].to_i.should == height }
+end
+
+def have_format(format)
+  simple_matcher("have format #{format}"){|given| image_properties(given)[:format].should == format }
+end

data/spec/simple_matchers.rb

@@ -0,0 +1,14 @@
+def match_url(url)
+  simple_matcher("match url #{url}") do |given|
+    given_path, given_query_string = given.split('?')
+    path, query_string = url.split('?')
+    
+    path == given_path && given_query_string.split('&').sort == query_string.split('&').sort
+  end
+end
+
+def be_an_empty_directory
+  simple_matcher("be empty") do |given|
+    Dir.entries(given) == ['.','..']
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'spec'
+require 'rubygems'
+require 'ruby-debug'
+
+require File.dirname(__FILE__) + '/../lib/dragonfly'
+$:.unshift(File.dirname(__FILE__))
+require 'argument_matchers'
+require 'simple_matchers'
+require 'image_matchers'
+
+SAMPLES_DIR = File.expand_path(File.dirname(__FILE__) + '/../samples') unless defined?(SAMPLES_DIR)
+
+Spec::Runner.configure do |config|
+  
+end
+
+def todo
+  raise "TODO"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification 
+name: dragonfly
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mark Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-09 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: mark@new-bamboo.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- config.rb
+- config.ru
+- dragonfly-rails.gemspec
+- dragonfly.gemspec
+- features/dragonfly.feature
+- features/steps/common_steps.rb
+- features/steps/dragonfly_steps.rb
+- features/support/env.rb
+- features/support/image_helpers.rb
+- generators/dragonfly_app/USAGE
+- generators/dragonfly_app/dragonfly_app_generator.rb
+- generators/dragonfly_app/templates/custom_processing.erb
+- generators/dragonfly_app/templates/initializer.erb
+- generators/dragonfly_app/templates/metal_file.erb
+- irbrc.rb
+- lib/dragonfly.rb
+- lib/dragonfly/active_record_extensions.rb
+- lib/dragonfly/active_record_extensions/attachment.rb
+- lib/dragonfly/active_record_extensions/class_methods.rb
+- lib/dragonfly/active_record_extensions/instance_methods.rb
+- lib/dragonfly/active_record_extensions/validations.rb
+- lib/dragonfly/analysis/analyser.rb
+- lib/dragonfly/analysis/base.rb
+- lib/dragonfly/analysis/r_magick_analyser.rb
+- lib/dragonfly/app.rb
+- lib/dragonfly/app_configuration.rb
+- lib/dragonfly/configurable.rb
+- lib/dragonfly/core_ext/object.rb
+- lib/dragonfly/data_storage.rb
+- lib/dragonfly/data_storage/base.rb
+- lib/dragonfly/data_storage/file_data_store.rb
+- lib/dragonfly/encoding/base.rb
+- lib/dragonfly/encoding/r_magick_encoder.rb
+- lib/dragonfly/extended_temp_object.rb
+- lib/dragonfly/middleware.rb
+- lib/dragonfly/parameters.rb
+- lib/dragonfly/processing/processor.rb
+- lib/dragonfly/processing/r_magick_processor.rb
+- lib/dragonfly/r_magick_configuration.rb
+- lib/dragonfly/rails/images.rb
+- lib/dragonfly/temp_object.rb
+- lib/dragonfly/url_handler.rb
+- samples/beach.png
+- samples/egg.png
+- samples/round.gif
+- samples/taj.jpg
+- spec/argument_matchers.rb
+- spec/dragonfly/active_record_extensions/attachment_spec.rb
+- spec/dragonfly/active_record_extensions/initializer.rb
+- spec/dragonfly/active_record_extensions/migration.rb
+- spec/dragonfly/active_record_extensions/model_spec.rb
+- spec/dragonfly/active_record_extensions/models.rb
+- spec/dragonfly/active_record_extensions/spec_helper.rb
+- spec/dragonfly/analysis/analyser_spec.rb
+- spec/dragonfly/analysis/r_magick_analyser_spec.rb
+- spec/dragonfly/app_spec.rb
+- spec/dragonfly/configurable_spec.rb
+- spec/dragonfly/data_storage/data_store_spec.rb
+- spec/dragonfly/data_storage/file_data_store_spec.rb
+- spec/dragonfly/extended_temp_object_spec.rb
+- spec/dragonfly/middleware_spec.rb
+- spec/dragonfly/parameters_spec.rb
+- spec/dragonfly/processing/rmagick_processor_spec.rb
+- spec/dragonfly/temp_object_spec.rb
+- spec/dragonfly/url_handler_spec.rb
+- spec/dragonfly_spec.rb
+- spec/image_matchers.rb
+- spec/simple_matchers.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/markevans/dragonfly
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: dragonfly is an on-the-fly processing/encoding framework written as a Rack application. It includes an extension for Ruby on Rails to enable easy image handling
+test_files: 
+- spec/argument_matchers.rb
+- spec/dragonfly/active_record_extensions/attachment_spec.rb
+- spec/dragonfly/active_record_extensions/initializer.rb
+- spec/dragonfly/active_record_extensions/migration.rb
+- spec/dragonfly/active_record_extensions/model_spec.rb
+- spec/dragonfly/active_record_extensions/models.rb
+- spec/dragonfly/active_record_extensions/spec_helper.rb
+- spec/dragonfly/analysis/analyser_spec.rb
+- spec/dragonfly/analysis/r_magick_analyser_spec.rb
+- spec/dragonfly/app_spec.rb
+- spec/dragonfly/configurable_spec.rb
+- spec/dragonfly/data_storage/data_store_spec.rb
+- spec/dragonfly/data_storage/file_data_store_spec.rb
+- spec/dragonfly/extended_temp_object_spec.rb
+- spec/dragonfly/middleware_spec.rb
+- spec/dragonfly/parameters_spec.rb
+- spec/dragonfly/processing/rmagick_processor_spec.rb
+- spec/dragonfly/temp_object_spec.rb
+- spec/dragonfly/url_handler_spec.rb
+- spec/dragonfly_spec.rb
+- spec/image_matchers.rb
+- spec/simple_matchers.rb
+- spec/spec_helper.rb