dragonfly 0.8.6 → 0.9.0

data/spec/dragonfly/loggable_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 class Testoast
   include Dragonfly::Loggable
@@ -10,7 +10,7 @@ describe Dragonfly::Loggable do
     @object = Testoast.new
   end
 
-  describe "common", :shared => true do
+  shared_examples_for "common" do
     it "should return a log" do
       @object.log.should be_a(Logger)
     end

data/spec/dragonfly/middleware_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 require 'rack'
 
 def dummy_rack_app
@@ -13,27 +13,21 @@ describe Dragonfly::Middleware do
 
   before(:each) do
     @stack = Rack::Builder.new do
-      use Dragonfly::Middleware, :images, '/media'
+      use Dragonfly::Middleware, :images
       run dummy_rack_app
     end
   end
 
-  it "should pass through for urls with incorrect prefix" do
-    Dragonfly[:images].should_not_receive(:call)
-    response = make_request(@stack, '/hello.png?howare=you')
-    response.status.should == 200
-    response.body.should == 'dummy_rack_app body'
-  end
-
-  it "should pass through if the app returns and X-Cascade: pass" do
+  it "should pass through if the app returns X-Cascade: pass" do
     Dragonfly[:images].should_receive(:call).and_return(
       [404, {"Content-Type" => 'text/plain', 'X-Cascade' => 'pass'}, ['Not found']]
     )
     response = make_request(@stack, '/media/hello.png?howare=you')
     response.body.should == 'dummy_rack_app body'
+    response.status.should == 200
   end
 
-  it "should return a 404 if the app returns a 404 for that url but no X-Cascade: pass" do
+  it "should return a 404 if the app returns a 404" do
     Dragonfly[:images].should_receive(:call).and_return(
       [404, {"Content-Type" => 'text/plain'}, ['Not found']]
     )
@@ -41,21 +35,6 @@ describe Dragonfly::Middleware do
     response.status.should == 404
   end
 
-  %w(0.1 0.9 0.10 1.0 1.0.0 1.0.1).each do |version|
-    it "should pass through if the rack version is #{version} (i.e. no X-Cascade: pass) and the app returns 404" do
-      Rack.should_receive(:version).and_return(version)
-      Dragonfly[:images].should_receive(:call).and_return(
-        [404, {"Content-Type" => 'text/plain'}, ['Not found']]
-      )
-      response = make_request(@stack, '/media/hello.png?howare=you')
-      response.status.should == 200
-      response.body.should == 'dummy_rack_app body'
-    end
-  end
-
-  %w(1.1 1.1.1 2.9).each do |version|
-  end
-
   it "should return as per the dragonfly app if the app returns a 200" do
     Dragonfly[:images].should_receive(:call).and_return(
       [200, {"Content-Type" => 'text/plain'}, ['ABCD']]

data/spec/dragonfly/routed_endpoint_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 def response_for(array)
   Rack::MockResponse.new(*array)

data/spec/dragonfly/serializer_spec.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Dragonfly::Serializer do
   
@@ -56,19 +56,6 @@ describe Dragonfly::Serializer do
         marshal_decode('ahasdkjfhasdkfjh')
       }.should raise_error(Dragonfly::Serializer::BadString)
     end
-    describe "potentially harmful strings" do
-      ['_', 'hello', 'h2', '__send__', 'F'].each do |variable_name|
-        it "should raise an error if the string passed in is potentially harmful (e.g. contains instance variable #{variable_name})" do
-          class C; end
-          c = C.new
-          c.instance_eval{ instance_variable_set("@#{variable_name}", 1) }
-          string = Dragonfly::Serializer.b64_encode(Marshal.dump(c))
-          lambda{
-            marshal_decode(string)
-          }.should raise_error(Dragonfly::Serializer::MaliciousString)
-        end
-      end
-    end
   end
   
 end

data/spec/dragonfly/server_spec.rb

@@ -0,0 +1,261 @@
+require 'spec_helper'
+require 'rack/mock'
+require 'rack/cache'
+
+def request(app, path)
+  Rack::MockRequest.new(app).get(path)
+end
+
+describe Dragonfly::Server do
+
+  describe "responses" do
+    
+    before(:each) do
+      @app = test_app
+      @uid = @app.store('HELLO THERE')
+      @server = Dragonfly::Server.new(@app)
+      @server.url_format = '/media/:job'
+      @job = @app.fetch(@uid)
+    end
+  
+    after(:each) do
+      @app.destroy(@uid)
+    end
+
+    describe "successful urls" do
+      before(:each) do
+        @server.url_format = '/media/:job/:name.:format'
+      end
+    
+      [
+        '',
+        '/name',
+        '/name.ext'
+      ].each do |suffix|
+    
+        it "should return successfully when given the url with suffix #{suffix.inspect}" do
+          url = "/media/#{@job.serialize}#{suffix}"
+          response = request(@server, url)
+          response.status.should == 200
+          response.body.should == 'HELLO THERE'
+          response.content_type.should == 'application/octet-stream'
+        end
+        
+      end
+
+      it "should return successfully with the correct sha given and protection on" do
+        @server.protect_from_dos_attacks = true
+        url = "/media/#{@job.serialize}?sha=#{@job.sha}"
+        response = request(@server, url)
+        response.status.should == 200
+        response.body.should == 'HELLO THERE'
+      end
+
+      
+      it "should work ok with + symbols" do
+        @app.processor.add(:thumb){|t, geometry| "eggs" }
+        @app.datastore.should_receive(:retrieve).with('2011/04/20/20_55_04_114_female_1.jpg').and_return "EGGS"
+        response = request(@server, '/media/BAhbB1sHOgZmSSIpMjAxMS8wNC8yMC8yMF81NV8wNF8xMTRfZmVtYWxlXzEuanBnBjoGRVRbCDoGcDoKdGh1bWJJIgwxMDB4NzU+BjsGVA')
+        response.status.should == 200
+        response.body.should == 'eggs'
+      end
+    end
+
+    it "should return successfully even if the job is in the query string" do
+      @server.url_format = '/'
+      url = "/?job=#{@job.serialize}"
+      response = request(@server, url)
+      response.status.should == 200
+      response.body.should == 'HELLO THERE'
+    end
+
+    it "should return a 400 if no sha given but protection on" do
+      @server.protect_from_dos_attacks = true
+      url = "/media/#{@job.serialize}"
+      response = request(@server, url)
+      response.status.should == 400
+    end
+  
+    it "should return a 400 if wrong sha given and protection on" do
+      @server.protect_from_dos_attacks = true
+      url = "/media/#{@job.serialize}?sha=asdfs"
+      response = request(@server, url)
+      response.status.should == 400
+    end
+
+    ['/media', '/media/'].each do |url|
+      it "should return a 404 when no job given, e.g. #{url.inspect}" do
+        response = request(@server, url)
+        response.status.should == 404
+        response.body.should == 'Not found'
+        response.content_type.should == 'text/plain'
+        response.headers['X-Cascade'].should == 'pass'
+      end
+    end
+  
+    it "should return a 404 when the url matches but doesn't correspond to a job" do
+      response = request(@server, '/media/sadhfasdfdsfsdf')
+      response.status.should == 404
+      response.body.should == 'Not found'
+      response.content_type.should == 'text/plain'
+      response.headers['X-Cascade'].should be_nil
+    end
+  
+    it "should return a 404 when the url isn't known at all" do
+      response = request(@server, '/jfasd/dsfa')
+      response.status.should == 404
+      response.body.should == 'Not found'
+      response.content_type.should == 'text/plain'
+      response.headers['X-Cascade'].should == 'pass'
+    end
+  
+    it "should return a 404 when the url is a well-encoded but bad array" do
+      url = "/media/#{Dragonfly::Serializer.marshal_encode([[:egg, {:some => 'args'}]])}"
+      response = request(@server, url)
+      response.status.should == 404
+      response.body.should == 'Not found'
+      response.content_type.should == 'text/plain'
+      response.headers['X-Cascade'].should be_nil
+    end
+
+    it "should return a cacheable response" do
+      url = "/media/#{@job.serialize}"
+      cache = Rack::Cache.new(@server, :entitystore => 'heap:/')
+      response = request(cache, url)
+      response.status.should == 200
+      response.headers['X-Rack-Cache'].should == "miss, store"
+      response = request(cache, url)
+      response.status.should == 200
+      response.headers['X-Rack-Cache'].should == "fresh"
+    end
+
+  end
+  
+  describe "dragonfly response" do
+    before(:each) do
+      @app = test_app
+      @server = Dragonfly::Server.new(@app)
+      @server.url_format = '/media/:job'
+    end
+    
+    it "should return a simple text response" do
+      request(@server, '/dragonfly').should be_a_text_response
+    end
+
+    it "should be configurable" do
+      @server.dragonfly_url = '/hello'
+      request(@server, '/hello').should be_a_text_response
+      request(@server, '/dragonfly').status.should == 404
+    end
+
+    it "should be possible to turn it off" do
+      @server.dragonfly_url = nil
+      request(@server, '/').status.should == 404
+      request(@server, '/dragonfly').status.should == 404
+    end
+  end
+
+  describe "urls" do
+    
+    before(:each) do
+      @app = test_app
+      @server = Dragonfly::Server.new(@app)
+      @server.url_format = '/media/:job/:basename.:format'
+      @job = @app.fetch('some_uid')
+    end
+    
+    it "should generate the correct url when no basename/format" do
+      @server.url_for(@job).should == "/media/#{@job.serialize}"
+    end
+    
+    it "should generate the correct url when there is a basename and no format" do
+      @server.url_for(@job, :basename => 'hello').should == "/media/#{@job.serialize}/hello"
+    end
+    
+    it "should generate the correct url when there is a basename and different format" do
+      @server.url_for(@job, :basename => 'hello', :format => 'gif').should == "/media/#{@job.serialize}/hello.gif"
+    end
+
+    it "should add extra params to the url query string" do
+      @server.url_for(@job, :a => 'thing', :b => 'nuther').should == "/media/#{@job.serialize}?a=thing&b=nuther"
+    end
+  
+    it "should add the host to the url if configured" do
+      @server.url_host = 'http://some.server:4000'
+      @server.url_for(@job).should == "http://some.server:4000/media/#{@job.serialize}"
+    end
+
+    it "should add the host to the url if passed in" do
+      @server.url_for(@job, :host => 'https://bungle.com').should == "https://bungle.com/media/#{@job.serialize}"
+    end
+
+    it "should favour the passed in host" do
+      @server.url_host = 'http://some.server:4000'
+      @server.url_for(@job, :host => 'https://smeedy').should == "https://smeedy/media/#{@job.serialize}"
+    end
+  
+    describe "Denial of Service protection" do
+      before(:each) do
+        @app = test_app
+        @server = Dragonfly::Server.new(@app)
+        @server.protect_from_dos_attacks = true
+        @job = @app.fetch('some_uid')
+      end
+      it "should generate the correct url" do
+        @server.url_for(@job).should == "/#{@job.serialize}?sha=#{@job.sha}"
+      end
+    end
+
+  end
+
+  describe "before_serve callback" do
+
+    before(:each) do
+      @app = test_app
+      @app.generator.add(:test){ "TEST" }
+      @server = Dragonfly::Server.new(@app)
+      @job = @app.generate(:test)
+    end
+
+    context "with no stop in the callback" do
+      before(:each) do
+        @x = x = ""
+        @server.before_serve do |job, env|
+          x << job.data
+        end
+      end
+
+      it "should be called before serving" do
+        response = request(@server, "/#{@job.serialize}")
+        response.body.should == 'TEST'
+        @x.should == 'TEST'
+      end
+
+      it "should not be called before serving a 404 page" do
+        response = request(@server, "blah")
+        response.status.should == 404
+        @x.should == ""
+      end
+    end
+
+    context "with a throw :halt in the callback" do
+      before(:each) do
+        @server.before_serve do |job, env|
+          throw :halt, [200, {}, ['hello']]
+        end
+      end
+      
+      it 'return the specified response instead of job.result' do
+        response = request(@server, "/#{@job.serialize}")
+        response.body.should == 'hello'
+      end
+      
+      it "should not apply the job if not asked to" do
+        @app.generator.should_not_receive(:generate)
+        response = request(@server, "/#{@job.serialize}")
+      end
+    end
+
+  end
+
+end

data/spec/dragonfly/simple_cache_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Dragonfly::SimpleCache do
   

data/spec/dragonfly/temp_object_spec.rb

@@ -1,11 +1,11 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Dragonfly::TempObject do
 
   ####### Helper Methods #######
 
   def sample_path(filename)
-    File.dirname(__FILE__) + '/../../samples/' + filename
+    File.join(SAMPLES_DIR, filename)
   end
 
   def new_tempfile(data='HELLO')
@@ -15,16 +15,22 @@ describe Dragonfly::TempObject do
     tempfile
   end
 
-  def new_file(data='HELLO')
-    File.open('/tmp/test_file', 'w') do |f|
+  def new_file(data='HELLO', path="/tmp/test_file")
+    File.open(path, 'w') do |f|
       f.write(data)
     end
-    File.new('/tmp/test_file')
+    File.new(path)
   end
 
-  def new_temp_object(data, opts={})
-    klass = opts.delete(:class) || Dragonfly::TempObject
-    klass.new(initialization_object(data), opts)
+  def new_pathname(data='HELLO', path="/tmp/test_file")
+    File.open(path, 'w') do |f|
+      f.write(data)
+    end
+    Pathname.new(path)
+  end
+
+  def new_temp_object(data, klass=Dragonfly::TempObject)
+    klass.new(initialization_object(data))
   end
 
   def initialization_object(data)
@@ -48,7 +54,7 @@ describe Dragonfly::TempObject do
     }.should raise_error(ArgumentError)
   end
 
-  describe "common behaviour", :shared => true do
+  shared_examples_for "common behaviour" do
 
     describe "simple initialization" do
 
@@ -97,8 +103,8 @@ describe Dragonfly::TempObject do
       end
 
       describe "path" do
-        it "should return the absolute file path" do
-          @temp_object.path.should == @temp_object.tempfile.path
+        it "should return an absolute file path" do
+          @temp_object.path.should =~ %r{^/\w+}
         end
       end
 
@@ -133,26 +139,6 @@ describe Dragonfly::TempObject do
 
     end
 
-    describe "initializing attributes too" do
-      it "should set the name" do
-        temp_object = Dragonfly::TempObject.new(initialization_object('HELLO'), :name => 'monkey.egg')
-        temp_object.name.should == 'monkey.egg'
-      end
-      it "should set the meta" do
-        temp_object = Dragonfly::TempObject.new(initialization_object('HELLO'), :meta => {:dr => 'doolittle'})
-        temp_object.meta.should == {:dr => 'doolittle'}
-      end
-      it "should set the format" do
-        temp_object = Dragonfly::TempObject.new(initialization_object('HELLO'), :format => :jpg)
-        temp_object.format.should == :jpg
-      end
-      it "should raise an error if an invalid option is given" do
-        lambda {
-          Dragonfly::TempObject.new(initialization_object('HELLO'), :doobie => 'doo')
-        }.should raise_error(ArgumentError)
-      end
-    end
-
     describe "each" do
       it "should yield 8192 bytes each time" do
         temp_object = new_temp_object(File.read(sample_path('round.gif')))
@@ -164,7 +150,7 @@ describe Dragonfly::TempObject do
       end
       it "should yield the number of bytes specified in the class configuration" do
         klass = Class.new(Dragonfly::TempObject)
-        temp_object = new_temp_object(File.read(sample_path('round.gif')), :class => klass)
+        temp_object = new_temp_object(File.read(sample_path('round.gif')), klass)
         klass.block_size = 3001
         parts = get_parts(temp_object)
         parts[0...-1].each do |part|
@@ -204,6 +190,11 @@ describe Dragonfly::TempObject do
       temp_object.should_not_receive(:data)
       temp_object.each{}
     end
+
+    it "should return the tempfile's path" do
+      temp_object = new_temp_object('HELLO')
+      temp_object.path.should == temp_object.tempfile.path
+    end
   end
 
   describe "initializing from a file" do
@@ -219,133 +210,96 @@ describe Dragonfly::TempObject do
       temp_object.should_not_receive(:data)
       temp_object.each{}
     end
+
+    it "should return the file's path" do
+      file = new_file('HELLO')
+      temp_object = Dragonfly::TempObject.new(file)
+      temp_object.path.should == file.path
+    end
+    
+    it "should return an absolute path even if the file wasn't instantiated like that" do
+      file = new_file('HELLO', 'testfile')
+      temp_object = Dragonfly::TempObject.new(file)
+      temp_object.path.should =~ %r{^/\w.*testfile}
+      file.close
+      FileUtils.rm(file.path)
+    end
+  end
+
+  describe "initializing from a pathname" do
+
+    def initialization_object(data)
+      new_pathname(data)
+    end
+
+    it_should_behave_like "common behaviour"
+
+    it "should not create a data string when calling each" do
+      temp_object = new_temp_object('HELLO')
+      temp_object.should_not_receive(:data)
+      temp_object.each{}
+    end
+
+    it "should return the file's path" do
+      pathname = new_pathname('HELLO')
+      temp_object = Dragonfly::TempObject.new(pathname)
+      temp_object.path.should == pathname.to_s
+    end
+    
+    it "should return an absolute path even if the pathname is relative" do
+      pathname = new_pathname('HELLO', 'testfile')
+      temp_object = Dragonfly::TempObject.new(pathname)
+      temp_object.path.should =~ %r{^/\w.*testfile}
+      pathname.delete
+    end
   end
 
   describe "initializing from another temp object" do
+    
+    def initialization_object(data)
+      Dragonfly::TempObject.new(data)
+    end
+    
     before(:each) do
       @temp_object1 = Dragonfly::TempObject.new(new_tempfile('hello'))
       @temp_object2 = Dragonfly::TempObject.new(@temp_object1)
     end
+    
+    it_should_behave_like "common behaviour"
+    
     it "should not be the same object" do
       @temp_object1.should_not == @temp_object2
     end
     it "should have the same data" do
       @temp_object1.data.should == @temp_object2.data
     end
-    it "should have a different file path" do
-      @temp_object1.path.should_not == @temp_object2.path
+    it "should have the same file path" do
+      @temp_object1.path.should == @temp_object2.path
     end
   end
 
-  describe "name" do
+  describe "original_filename" do
     before(:each) do
       @obj = new_tempfile
     end
-    it "should set the name if the initial object responds to 'original filename'" do
+    it "should set the original_filename if the initial object responds to 'original filename'" do
       def @obj.original_filename
         'jimmy.page'
       end
-      Dragonfly::TempObject.new(@obj).name.should == 'jimmy.page'
+      Dragonfly::TempObject.new(@obj).original_filename.should == 'jimmy.page'
     end
     it "should not set the name if the initial object doesn't respond to 'original filename'" do
-      Dragonfly::TempObject.new(@obj).name.should be_nil
+      Dragonfly::TempObject.new(@obj).original_filename.should be_nil
     end
     it "should set the name if the initial object is a file object" do
       file = File.new(SAMPLES_DIR + '/round.gif')
       temp_object = Dragonfly::TempObject.new(file)
-      temp_object.name.should == 'round.gif'
-    end
-    it "should still be nil if set to empty string on initialize" do
-      temp_object = Dragonfly::TempObject.new('sdf', :name => '')
-      temp_object.name.should be_nil
-    end
-    it "should allow setting" do
-      temp_object = Dragonfly::TempObject.new('sdf')
-      temp_object.name = "jonny.briggs"
-      temp_object.name.should == 'jonny.briggs'
-    end
-  end
-
-  describe "ext" do
-    it "should use the correct extension from name" do
-      temp_object = Dragonfly::TempObject.new('asfsadf', :name => 'hello.there.mate')
-      temp_object.ext.should == 'mate'
-    end
-    it "should be nil if name has none" do
-      temp_object = Dragonfly::TempObject.new('asfsadf', :name => 'hello')
-      temp_object.ext.should be_nil
-    end
-    it "should be nil if name is nil" do
-      temp_object = Dragonfly::TempObject.new('asfsadf')
-      temp_object.ext.should be_nil
-    end
-  end
-
-  describe "basename" do
-    it "should use the correct basename from name" do
-      temp_object = Dragonfly::TempObject.new('A', :name => 'hello.there.mate')
-      temp_object.basename.should == 'hello.there'
-    end
-    it "should be the name if it has no ext" do
-      temp_object = Dragonfly::TempObject.new('A', :name => 'hello')
-      temp_object.basename.should == 'hello'
-    end
-    it "should be nil if name is nil" do
-      temp_object = Dragonfly::TempObject.new('A', :name => nil)
-      temp_object.basename.should be_nil
-    end
-  end
-
-  describe "meta" do
-    before(:each) do
-      @temp_object = Dragonfly::TempObject.new('get outta here!')
-    end
-    it "should return an empty hash if not set" do
-      @temp_object.meta.should == {}
-    end
-    it "should allow setting" do
-      @temp_object.meta = {:teeth => 'many'}
-      @temp_object.meta.should == {:teeth => 'many'}
-    end
-  end
-
-  describe "format" do
-    it "should return nil if not set" do
-      temp_object = Dragonfly::TempObject.new('wassin my belly??!')
-      temp_object.format.should be_nil
-    end
-    it "should allow setting on initialize" do
-      temp_object = Dragonfly::TempObject.new('wassin my belly??!', :format => :jpg)
-      temp_object.format.should == :jpg
-    end
-    it "should allow setting" do
-      temp_object = Dragonfly::TempObject.new('jo*ida pero contenta')
-      temp_object.format = :tiff
-      temp_object.format.should == :tiff
-    end
-  end
-
-  describe "extract_attributes_from" do
-    before(:each) do
-      @temp_object = Dragonfly::TempObject.new("ne'er gonna give you up",
-        :meta => {:a => 4},
-        :name => 'fred.txt',
-        :format => :txt
-      )
-      @attributes = {:meta => {:b => 5}, :ogle => 'bogle', :format => :dungbats}
-      @temp_object.extract_attributes_from(@attributes)
-    end
-    it "should overwrite its own attributes if specified" do
-      @temp_object.format.should == :dungbats
-    end
-    it "should merge its own meta if specified" do
-      @temp_object.meta.should == {:a => 4, :b => 5}
-    end
-    it "should leave non-specified attributes untouched" do
-      @temp_object.name.should == 'fred.txt'
+      temp_object.original_filename.should == 'round.gif'
     end
-    it "should remove attributes from the hash" do
-      @attributes.should == {:ogle => 'bogle'}
+    it "should set the name if the initial object is a pathname" do
+      pathname = Pathname.new(SAMPLES_DIR + '/round.gif')
+      temp_object = Dragonfly::TempObject.new(pathname)
+      temp_object.original_filename.should == 'round.gif'
     end
   end