dragonfly 0.7.5 → 0.7.6

data/spec/dragonfly/app_spec.rb

@@ -8,23 +8,23 @@ end
 describe Dragonfly::App do
 
   describe ".instance" do
-    
+
     it "should create a new instance if it didn't already exist" do
       app = Dragonfly::App.instance(:images)
       app.should be_a(Dragonfly::App)
     end
-    
+
     it "should return an existing instance if called by name" do
       app = Dragonfly::App.instance(:images)
       Dragonfly::App.instance(:images).should == app
     end
-    
+
     it "should also work using square brackets" do
       Dragonfly[:images].should == Dragonfly::App.instance(:images)
     end
-    
+
   end
-  
+
   describe ".new" do
     it "should not be callable" do
       lambda{
@@ -69,7 +69,7 @@ describe Dragonfly::App do
         other_app.mime_type_for(:mark).should == 'second/one'
       end
     end
-    
+
     describe "#resolve_mime_type" do
       before(:each) do
         @app = test_app
@@ -129,7 +129,7 @@ describe Dragonfly::App do
       end
 
     end
-    
+
   end
 
   describe "without path prefix or DOS protection" do
@@ -184,7 +184,40 @@ describe Dragonfly::App do
       @app.url_for(@job, :host => 'https://smeedy').should =~ %r{^https://smeedy/\w+$}
     end
   end
+
+  describe "url_suffix" do
+    before(:each) do
+      @app = test_app
+      @job = Dragonfly::Job.new(@app)
+    end
+    it "should add the suffix to the url if configured" do
+      @app.url_suffix = 'hellodudes'
+      @app.url_for(@job).should =~ /\w+hellodudes$/
+    end
+    it "should add the suffix to the url if passed in" do
+      @app.url_for(@job, :suffix => '/howdy.pardner').should =~ /\w+\/howdy\.pardner$/
+    end
+    it "should favour the passed in one" do
+      @app.url_suffix = 'hellodudes'
+      @app.url_for(@job, :suffix => '/howdy.pardner').should =~ /\w+\/howdy\.pardner$/
+    end
+    it "should accept a proc yielding the job" do
+      @app.url_suffix = proc{|job| job.uid }
+      @job.fetch!('some_uid')
+      @app.url_for(@job).should =~ /\w+some_uid$/
+    end
+  end
   
+  describe "url params" do
+    before(:each) do
+      @app = test_app
+      @job = Dragonfly::Job.new(@app)
+    end
+    it "should add extra params to the url query string" do
+      @app.url_for(@job, :suffix => '/suffix', :a => 'thing', :b => 'nuther').should =~ /\w+\/suffix\?a=thing&b=nuther$/
+    end
+  end
+
   describe "Denial of Service protection" do
     before(:each) do
       @app = test_app
@@ -200,7 +233,7 @@ describe Dragonfly::App do
     before(:each) do
       @app = test_app
     end
-    
+
     {
       :rmagick => Dragonfly::Config::RMagick,
       :r_magick => Dragonfly::Config::RMagick,

data/spec/dragonfly/configurable_spec.rb

@@ -108,11 +108,9 @@ describe Dragonfly::Configurable do
       @lazy.sound.should == 'mooo!'
       @lazy.sound.should == 'mooo!'
     end
-    it "should also call a block which has been set as part of the configuration" do
-      @cow.should_receive(:fart).exactly(:once).and_return('paaarrp!')
+    it "should not call an explicitly passed in proc" do
       @lazy.configure{|c| c.sound = lambda{ @cow.fart }}
-      @lazy.sound.should == 'paaarrp!'
-      @lazy.sound.should == 'paaarrp!'
+      @lazy.sound.should be_a(Proc)
     end
   end
   

data/spec/dragonfly/data_storage/file_data_store_spec.rb

@@ -58,7 +58,7 @@ describe Dragonfly::DataStorage::FileDataStore do
 
       it "should use a different filename" do
         touch_file("#{@file_pattern_prefix}file")
-        @data_store.should_receive(:disambiguate).with('file').and_return('file_2')
+        @data_store.should_receive(:disambiguate).with("#{@file_pattern_prefix}file").and_return("#{@file_pattern_prefix}file_2")
         it_should_write_to_file("#{@file_pattern_prefix}file_2", @temp_object)
         @data_store.store(@temp_object)
       end
@@ -66,19 +66,32 @@ describe Dragonfly::DataStorage::FileDataStore do
       it "should use a different filename taking into account the name and ext" do
         @temp_object.should_receive(:name).at_least(:once).and_return('hello.png')
         touch_file("#{@file_pattern_prefix}hello.png")
-        @data_store.should_receive(:disambiguate).with('hello.png').and_return('blah.png')
+        @data_store.should_receive(:disambiguate).with("#{@file_pattern_prefix}hello.png").and_return("#{@file_pattern_prefix}blah.png")
         @data_store.store(@temp_object)
       end
 
       it "should keep trying until it finds a free filename" do
         touch_file("#{@file_pattern_prefix}file")
         touch_file("#{@file_pattern_prefix}file_2")
-        @data_store.should_receive(:disambiguate).with('file').and_return('file_2')
-        @data_store.should_receive(:disambiguate).with('file_2').and_return('file_3')
+        @data_store.should_receive(:disambiguate).with("#{@file_pattern_prefix}file").and_return("#{@file_pattern_prefix}file_2")
+        @data_store.should_receive(:disambiguate).with("#{@file_pattern_prefix}file_2").and_return("#{@file_pattern_prefix}file_3")
         it_should_write_to_file("#{@file_pattern_prefix}file_3", @temp_object)
         @data_store.store(@temp_object)
       end
 
+      describe "specifying the uid" do
+        it "should allow for specifying the path to use" do
+          it_should_write_to_file("#{@data_store.root_path}/hello/there/mate.png", @temp_object)
+          @data_store.store(@temp_object, :path => 'hello/there/mate.png')
+        end
+        it "should correctly disambiguate if the file exists" do
+          touch_file("#{@data_store.root_path}/hello/there/mate.png")
+          @data_store.should_receive(:disambiguate).with("#{@data_store.root_path}/hello/there/mate.png").and_return("#{@data_store.root_path}/hello/there/mate_2.png")
+          it_should_write_to_file("#{@data_store.root_path}/hello/there/mate_2.png", @temp_object)
+          @data_store.store(@temp_object, :path => 'hello/there/mate.png')
+        end
+      end
+
     end
 
     describe "return value" do
@@ -98,13 +111,13 @@ describe Dragonfly::DataStorage::FileDataStore do
   
   describe "disambiguate" do
     it "should add a suffix" do
-      @data_store.disambiguate('file').should =~ /^file_\w+$/
+      @data_store.disambiguate('/some/file').should =~ %r{^/some/file_\w+$}
     end
     it "should add a suffix to the basename" do
-      @data_store.disambiguate('file.png').should =~ /^file_\w+\.png$/
+      @data_store.disambiguate('/some/file.png').should =~ %r{^/some/file_\w+\.png$}
     end
     it "should be random(-ish)" do
-      @data_store.disambiguate('file').should_not == @data_store.disambiguate('file')
+      @data_store.disambiguate('/some/file').should_not == @data_store.disambiguate('/some/file')
     end
   end
   

data/spec/dragonfly/data_storage/s3_data_store_spec.rb

@@ -1,33 +1,41 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
 require File.dirname(__FILE__) + '/data_store_spec'
+require 'yaml'
 
 describe Dragonfly::DataStorage::S3DataStore do
 
   # Change this to test it with an actual internet connection
-  enabled = false
-  
+  if File.exist?(file = File.expand_path('../../../../.s3_spec.yml', __FILE__))
+    config = YAML.load_file(file)
+    KEY = config['key']
+    SECRET = config['secret']
+    enabled = config['enabled']
+  else
+    enabled = false
+  end
+
   if enabled
 
     describe "common data_store behaviour" do
-    
+
       before(:each) do
         @data_store = Dragonfly::DataStorage::S3DataStore.new
         @data_store.configure do |d|
           d.bucket_name = 'dragonfly_test'
-          d.access_key_id = 'XXX'
-          d.secret_access_key = 'XXX'
+          d.access_key_id = KEY
+          d.secret_access_key = SECRET
         end
       end
-    
+
       it_should_behave_like 'data_store'
-    
+
       describe "store" do
         it "should return a unique identifier for each storage" do
           temp_object = Dragonfly::TempObject.new('gollum')
           temp_object2 = Dragonfly::TempObject.new('gollum')
           @data_store.store(temp_object).should_not == @data_store.store(temp_object2)
         end
-      
+
         it "should work ok with files with funny names" do
           temp_object = Dragonfly::TempObject.new('eggheads',
             :name =>  'A Picture with many spaces in its name (at 20:00 pm).png'
@@ -37,8 +45,16 @@ describe Dragonfly::DataStorage::S3DataStore do
           data, extra = @data_store.retrieve(uid)
           data.should == 'eggheads'
         end
+
+        it "should allow for setting the path manually" do
+          temp_object = Dragonfly::TempObject.new('eggheads')
+          uid = @data_store.store(temp_object, :path => 'hello/there')
+          uid.should == 'hello/there'
+          data, extra = @data_store.retrieve(uid)
+          data.should == 'eggheads'
+        end
       end
-    
+
     end
 
   end

data/spec/dragonfly/job_endpoint_spec.rb

@@ -1,6 +1,7 @@
+# encoding: utf-8
 require File.dirname(__FILE__) + '/../spec_helper'
 
-## General tests for Endpoint module go here as it's a pretty simple wrapper around that
+## General tests for Response go here as it's a pretty simple wrapper around that
 
 describe Dragonfly::JobEndpoint do
 
@@ -9,58 +10,111 @@ describe Dragonfly::JobEndpoint do
     Rack::MockRequest.new(endpoint).get('', opts)
   end
 
-  describe "errors" do
+  before(:each) do
+    @app = test_app
+    @app.datastore.stub!(:retrieve).with('egg').and_return(["GUNGLE", {:name => 'gung.txt'}])
+    @job = Dragonfly::Job.new(@app).fetch('egg')
+  end
 
-    before(:each) do
-      @app = test_app
-      @app.datastore.stub!(:retrieve).with('egg').and_return(["GUNGLE", {:name => 'gung.txt'}])
-      @job = Dragonfly::Job.new(@app).fetch('egg')
-    end
+  it "should return a correct response if successful" do
+    response = make_request(@job)
+    response.status.should == 200
+    response['ETag'].should =~ /^"\w+"$/
+    response['Cache-Control'].should == "public, max-age=31536000"
+    response['Content-Type'].should == 'text/plain'
+    response['Content-Length'].should == '6'
+    response['Content-Disposition'].should == 'filename="gung.txt"'
+    response.body.should == 'GUNGLE'
+  end
 
-    it "should return a correct response if successful" do
+  it "should return 404 if the datastore raises data not found" do
+    @job.should_receive(:apply).and_raise(Dragonfly::DataStorage::DataNotFound)
+    response = make_request(@job)
+    response.status.should == 404
+  end
+
+  describe "ETag" do
+    it "should return an ETag" do
       response = make_request(@job)
-      response.status.should == 200
-      response['ETag'].should =~ /^"\w+"$/
-      response['Cache-Control'].should == "public, max-age=31536000"
-      response['Content-Type'].should == 'text/plain'
-      response['Content-Length'].should == '6'
-      response.body.should == 'GUNGLE'
+      response.headers['ETag'].should =~ /^"\w+"$/
     end
 
-    it "should return 404 if the datastore raises data not found" do
-      @job.should_receive(:apply).and_raise(Dragonfly::DataStorage::DataNotFound)
-      response = make_request(@job)
-      response.status.should == 404
+    [
+      "dingle",
+      "dingle, eggheads",
+      '"dingle", "eggheads"',
+      '*'
+    ].each do |header|
+      it "should return a 304 if the correct ETag is specified in HTTP_IF_NONE_MATCH header e.g. #{header}" do
+        @job.should_receive(:unique_signature).at_least(:once).and_return('dingle')
+        response = make_request(@job, 'HTTP_IF_NONE_MATCH' => header)
+        response.status.should == 304
+        response['ETag'].should == '"dingle"'
+        response['Cache-Control'].should == "public, max-age=31536000"
+        response.body.should be_empty
+      end
+    end
+
+    it "should not have applied any steps if the correct ETag is specified in HTTP_IF_NONE_MATCH header" do
+      response = make_request(@job, 'HTTP_IF_NONE_MATCH' => @job.unique_signature)
+      @job.applied_steps.should be_empty
+    end
+  end
+
+  describe "Content Disposition" do
+    before(:each) do
+      @app.encoder.add{|temp_object, format| temp_object }
     end
 
-    describe "ETag" do
-      it "should return an ETag" do
+    describe "filename" do
+      it "should return the original name" do
         response = make_request(@job)
-        response.headers['ETag'].should =~ /^"\w+"$/
+        response['Content-Disposition'].should == 'filename="gung.txt"'
       end
-
-      [
-        "dingle",
-        "dingle, eggheads",
-        '"dingle", "eggheads"',
-        '*'
-      ].each do |header|
-        it "should return a 304 if the correct ETag is specified in HTTP_IF_NONE_MATCH header e.g. #{header}" do
-          @job.should_receive(:unique_signature).at_least(:once).and_return('dingle')
-          response = make_request(@job, 'HTTP_IF_NONE_MATCH' => header)
-          response.status.should == 304
-          response['ETag'].should == '"dingle"'
-          response['Cache-Control'].should == "public, max-age=31536000"
-          response.body.should be_empty
-        end
+      it "should return a filename with a different extension if it's been encoded" do
+        response = make_request(@job.encode(:doogs))
+        response['Content-Disposition'].should == 'filename="gung.doogs"'
       end
-
-      it "should not have applied any steps if the correct ETag is specified in HTTP_IF_NONE_MATCH header" do
-        response = make_request(@job, 'HTTP_IF_NONE_MATCH' => @job.unique_signature)
-        @job.applied_steps.should be_empty
+      it "should not have the filename if name doesn't exist" do
+        response = make_request(@app.new_job("ADFSDF"))
+        response['Content-Disposition'].should be_nil
+      end
+      it "should cope with filenames with no ext" do
+        response = make_request(@app.new_job("ASDF", :name => 'asdf'))
+        response['Content-Disposition'].should == 'filename="asdf"'
+      end
+      it "should uri encode funny characters" do
+        response = make_request(@app.new_job("ASDF", :name => '£@$£ `'))
+        response['Content-Disposition'].should == 'filename="%C2%A3@$%C2%A3%20%60"'
+      end
+      it "should allow for setting the filename using a block" do
+        @app.content_filename = proc{|job, request|
+          job.basename.reverse.upcase + request['a']
+        }
+        response = make_request(@job, 'QUERY_STRING' => 'a=egg')
+        response['Content-Disposition'].should == 'filename="GNUGegg"'
+      end
+      it "should not include the filename if configured to be nil" do
+        @app.content_filename = nil
+        response = make_request(@job)
+        response['Content-Disposition'].should be_nil
+      end
+    end
+    
+    describe "content disposition" do
+      it "should use the app's configured content-disposition" do
+        @app.content_disposition = :attachment
+        response = make_request(@job)
+        response['Content-Disposition'].should == 'attachment; filename="gung.txt"'
+      end
+      it "should allow using a block to set the content disposition" do
+        @app.content_disposition = proc{|job, request|
+          job.basename + request['blah']
+        }
+        response = make_request(@job, 'QUERY_STRING' => 'blah=yo')
+        response['Content-Disposition'].should == 'gungyo; filename="gung.txt"'
       end
     end
-
   end
 
 end

data/spec/dragonfly/job_spec.rb

@@ -176,6 +176,15 @@ describe Dragonfly::Job do
         temp_object.meta.should == {:a => :b}
         temp_object.format.should == :txt
       end
+
+      it "should allow returning an array with extra attributes from the processor" do
+        @app.processor.should_receive(:process).with(@temp_object, :resize, '20x30').and_return(['hi', {:name => 'hello_20x30.txt', :meta => {:eggs => 'asdf'}}])
+        temp_object = @job.apply.temp_object
+        temp_object.data.should == 'hi'
+        temp_object.name.should == 'hello_20x30.txt'
+        temp_object.meta.should == {:a => :b, :eggs => 'asdf'}
+        temp_object.format.should == :txt
+      end
     end
 
     describe "encode" do
@@ -202,6 +211,20 @@ describe Dragonfly::Job do
         @app.encoder.should_receive(:encode).with(@temp_object, :gif, :bitrate => 'mumma').and_return('alo')
         @job.apply.temp_object.format.should == :gif
       end
+
+      it "should allow returning an array with extra attributes form the encoder" do
+        @app.encoder.should_receive(:encode).with(@temp_object, :gif, :bitrate => 'mumma').and_return(['alo', {:name => 'doobie', :meta => {:eggs => 'fish'}}])
+        temp_object = @job.apply.temp_object
+        temp_object.data.should == 'alo'
+        temp_object.name.should == 'doobie'
+        temp_object.meta.should == {:a => :b, :eggs => 'fish'}
+      end
+
+      it "not allow overriding the format" do
+        @app.encoder.should_receive(:encode).with(@temp_object, :gif, :bitrate => 'mumma').and_return(['alo', {:format => :png}])
+        temp_object = @job.apply.temp_object
+        temp_object.format.should == :gif
+      end
     end
   end
 
@@ -499,6 +522,9 @@ describe Dragonfly::Job do
         Dragonfly::Job.from_path("/images/#{@serialized}", @app).should be_a(Dragonfly::Job)
       }.should raise_error(Dragonfly::Serializer::BadString)
     end
+    it "should ignore any suffix" do
+      Dragonfly::Job.from_path("/#{@serialized}asdfJASKLDF*()!@$%{}|/GGG/.png.your.mum", @app).should be_a(Dragonfly::Job)
+    end
   end
 
   describe "serialization" do
@@ -602,4 +628,146 @@ describe Dragonfly::Job do
     end
   end
 
+  describe "setting the name" do
+    before(:each) do
+      @app = test_app
+      @job = @app.new_job("HELLO", :name => 'not.me')
+    end
+    it "should allow setting the name" do
+      @job.name = 'wassup.doc'
+      @job.name.should == 'wassup.doc'
+    end
+  end
+
+  describe "setting the meta" do
+    before(:each) do
+      @app = test_app
+      @job = @app.new_job("HiThere", :meta => {:five => 'beans'})
+    end
+    it "should allow setting the meta" do
+      @job.meta = {:doogie => 'ladders'}
+      @job.meta.should == {:doogie => 'ladders'}
+    end
+    it "should allow updating the meta" do
+      @job.meta[:doogie] = 'ladders'
+      @job.meta.should == {:five => 'beans', :doogie => 'ladders'}
+    end
+  end
+
+  describe "b64_data" do
+    before(:each) do
+      @app = test_app
+    end
+    it "should return a string using the data:URI schema" do
+      job = @app.new_job("HELLO", :name => 'text.txt')
+      job.b64_data.should == "data:text/plain;base64,SEVMTE8=\n"
+    end
+  end
+
+  describe "querying stuff without applying steps" do
+    before(:each) do
+      @app = test_app
+    end
+    
+    describe "fetch_step" do
+      it "should return nil if it doesn't exist" do
+        @app.generate(:ponies).process(:jam).fetch_step.should be_nil
+      end
+      it "should return the fetch step otherwise" do
+        step = @app.fetch('hello').process(:cheese).fetch_step
+        step.should be_a(Dragonfly::Job::Fetch)
+        step.uid.should == 'hello'
+      end
+    end
+    describe "fetched uid" do
+      describe "when there's no fetch step" do
+        before(:each) do
+          @job = @app.new_job("AGG")
+        end
+        it "should return nil for uid" do
+          @job.uid.should be_nil
+        end
+        it "should return nil for uid_basename" do
+          @job.uid_basename.should be_nil
+        end
+        it "should return nil for uid_extname" do
+          @job.uid_extname.should be_nil
+        end
+      end
+      describe "when there is a fetch step" do
+        before(:each) do
+          @job = @app.fetch('gungedin/innit.blud')
+        end
+        it "should return the uid" do
+          @job.uid.should == 'gungedin/innit.blud'
+        end
+        it "should return the uid_basename" do
+          @job.uid_basename.should == 'innit'
+        end
+        it "should return the uid_extname" do
+          @job.uid_extname.should == '.blud'
+        end
+      end
+    end
+
+    describe "fetch_file_step" do
+      it "should return nil if it doesn't exist" do
+        @app.generate(:ponies).process(:jam).fetch_file_step.should be_nil
+      end
+      it "should return the fetch_file step otherwise" do
+        step = @app.fetch_file('/my/file.png').process(:cheese).fetch_file_step
+        step.should be_a(Dragonfly::Job::FetchFile)
+        step.path.should == '/my/file.png'
+      end
+    end
+
+    describe "generate_step" do
+      it "should return nil if it doesn't exist" do
+        @app.fetch('many/ponies').process(:jam).generate_step.should be_nil
+      end
+      it "should return the generate step otherwise" do
+        step = @app.generate(:ponies).process(:cheese).generate_step
+        step.should be_a(Dragonfly::Job::Generate)
+        step.args.should == [:ponies]
+      end
+    end
+    
+    describe "process_steps" do
+      it "should return the processing steps" do
+        job = @app.fetch('many/ponies').process(:jam).process(:eggs).encode(:gif)
+        job.process_steps.should match_steps([
+          Dragonfly::Job::Process,
+          Dragonfly::Job::Process
+        ])
+      end
+    end
+
+    describe "encode_step" do
+      it "should return nil if it doesn't exist" do
+        @app.generate(:ponies).encode_step.should be_nil
+      end
+      it "should return the last encode step otherwise" do
+        step = @app.fetch('hello').encode(:smells).encode(:cheese).encode_step
+        step.should be_a(Dragonfly::Job::Encode)
+        step.format.should == :cheese
+      end
+    end
+    describe "encoded_format" do
+      it "should return nil if there's no encode step" do
+        @app.new_job('asdf').encoded_format.should be_nil
+      end
+      it "should return the last encoded format if it exists" do
+        @app.fetch('gungedin').encode(:a).encode(:b).encoded_format.should == :b
+      end
+    end
+    describe "encoded_extname" do
+      it "should return nil if there's no encode step" do
+        @app.new_job('asdf').encoded_extname.should be_nil
+      end
+      it "should return the last encoded format as an extname if it exists" do
+        @app.fetch('gungedin').encode(:a).encode(:b).encoded_extname.should == '.b'
+      end
+    end
+  end
+
 end