dragonfly 0.8.6 → 0.9.0

data/spec/dragonfly/core_ext/string_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require 'spec_helper'
 
 describe String do
   
@@ -13,5 +13,5 @@ describe String do
       end
     end
   end
-  
+
 end

data/spec/dragonfly/core_ext/symbol_spec.rb

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

data/spec/dragonfly/data_storage/couch_data_store_spec.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+require 'spec_helper'
+require File.dirname(__FILE__) + '/shared_data_store_examples'
+require 'net/http'
+require 'uri'
+
+describe Dragonfly::DataStorage::CouchDataStore do
+
+  before(:each) do
+    WebMock.allow_net_connect!
+    @data_store = Dragonfly::DataStorage::CouchDataStore.new(
+      :database => "dragonfly_test"
+    )
+    begin
+      @data_store.db.get('ping')
+    rescue Errno::ECONNREFUSED => e
+      pending "You need to start CouchDB on localhost:5984 to test the CouchDataStore"
+    rescue RestClient::ResourceNotFound
+    end
+    
+  end
+  
+  it_should_behave_like 'data_store'
+  
+  describe "destroy" do
+    before(:each) do
+      @temp_object = Dragonfly::TempObject.new('gollum')
+    end
+    
+    it "should raise an error if the data doesn't exist on destroy" do
+      uid = @data_store.store(@temp_object)
+      @data_store.destroy(uid)
+      lambda{
+        @data_store.destroy(uid)
+      }.should raise_error(Dragonfly::DataStorage::DataNotFound)
+    end
+  end
+  
+  describe "url_for" do
+    it "should give the correct url" do
+      @data_store.url_for('asd7fas9df/thing.txt').should == 'http://localhost:5984/dragonfly_test/asd7fas9df/thing.txt'
+    end
+    
+    it "should assume the attachment is called 'file' if not given" do
+      @data_store.url_for('asd7fas9df').should == 'http://localhost:5984/dragonfly_test/asd7fas9df/file'
+    end
+  end
+  
+  describe "serving from couchdb" do
+
+    def get_content(url)
+      uri = URI.parse(url)
+      Net::HTTP.start(uri.host, uri.port) {|http|
+        http.get(uri.path)
+      }
+    end
+
+    before(:each) do
+      @temp_object = Dragonfly::TempObject.new('testingyo')
+    end
+    
+    it "should use the fallback by default" do
+      uid = @data_store.store(@temp_object)
+      response = get_content(@data_store.url_for(uid))
+      response.body.should == 'testingyo'
+      response['Content-Type'].should == 'application/octet-stream'
+    end
+    
+    it "should allow setting on store with 'content_type'" do
+      uid = @data_store.store(@temp_object, :content_type => 'text/plain')
+      response = get_content(@data_store.url_for(uid))
+      response.body.should == 'testingyo'
+      response['Content-Type'].should == 'text/plain'
+    end
+    
+    it "should allow setting on store with 'mime_type'" do
+      uid = @data_store.store(@temp_object, :mime_type => 'text/plain-yo')
+      response = get_content(@data_store.url_for(uid))
+      response.body.should == 'testingyo'
+      response['Content-Type'].should == 'text/plain-yo'
+    end
+  end
+  
+end

data/spec/dragonfly/data_storage/file_data_store_spec.rb

@@ -1,5 +1,5 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
-require File.dirname(__FILE__) + '/data_store_spec'
+require 'spec_helper'
+require File.dirname(__FILE__) + '/shared_data_store_examples'
 
 describe Dragonfly::DataStorage::FileDataStore do
   
@@ -42,14 +42,25 @@ describe Dragonfly::DataStorage::FileDataStore do
       @data_store.store(@temp_object)
     end
 
-    it "should use the temp_object name if it exists" do
-      @temp_object.should_receive(:name).at_least(:once).and_return('hello.there')
+    it "should use the temp_object original filename if it exists" do
+      @temp_object.should_receive(:original_filename).at_least(:once).and_return('hello.there')
       it_should_write_to_file("#{@file_pattern_prefix}hello.there", @temp_object)
       @data_store.store(@temp_object)
     end
 
-    it "should get rid of funny characters in the temp_object name" do
-      @temp_object.should_receive(:name).at_least(:once).and_return('A Picture with many spaces in its name (at 20:00 pm).png')
+    it "should use the meta name if it exists" do
+      it_should_write_to_file("#{@file_pattern_prefix}damp.squib", @temp_object)
+      @data_store.store(@temp_object, :meta => {:name => 'damp.squib'})
+    end
+
+    it "should prefer the meta name to the original filename" do
+      @temp_object.stub!(:original_filename).and_return('hello.there')
+      it_should_write_to_file("#{@file_pattern_prefix}damp.squib", @temp_object)
+      @data_store.store(@temp_object, :meta => {:name => 'damp.squib'})
+    end
+
+    it "should get rid of funny characters in the temp_object original filename" do
+      @temp_object.should_receive(:original_filename).at_least(:once).and_return('A Picture with many spaces in its name (at 20:00 pm).png')
       it_should_write_to_file("#{@file_pattern_prefix}A_Picture_with_many_spaces_in_its_name_at_20_00_pm_.png", @temp_object)
       @data_store.store(@temp_object)
     end
@@ -64,7 +75,7 @@ describe Dragonfly::DataStorage::FileDataStore do
       end
     
       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')
+        @temp_object.should_receive(:original_filename).at_least(:once).and_return('hello.png')
         touch_file("#{@file_pattern_prefix}hello.png")
         @data_store.should_receive(:disambiguate).with("#{@file_pattern_prefix}hello.png").and_return("#{@file_pattern_prefix}blah.png")
         @data_store.store(@temp_object)
@@ -101,7 +112,7 @@ describe Dragonfly::DataStorage::FileDataStore do
       end
     
       it "should return the filepath without the root of the stored file when a file name is provided" do
-        @temp_object.should_receive(:name).at_least(:once).and_return('hello.you.png')
+        @temp_object.should_receive(:original_filename).at_least(:once).and_return('hello.you.png')
         @data_store.store(@temp_object).should == "#{@file_pattern_prefix_without_root}hello.you.png"
       end
     
@@ -136,21 +147,27 @@ describe Dragonfly::DataStorage::FileDataStore do
   end
   
   describe "retrieve" do
-    
-    it "should return a closed file" do
+    it "should return a pathname" do
       uid = @data_store.store(@temp_object)
-      file, extra = @data_store.retrieve(uid)
-      file.should be_closed
+      pathname, meta = @data_store.retrieve(uid)
+      pathname.should be_a(Pathname)
     end
-
-    it "should be able to retrieve any file, stored or not (and without extra data)" do
+    
+    it "should be able to retrieve any file, stored or not (and without meta data)" do
       FileUtils.mkdir_p("#{@data_store.root_path}/jelly_beans/are")
       File.open("#{@data_store.root_path}/jelly_beans/are/good", 'w'){|f| f.write('hey dog') }
-      file, meta = @data_store.retrieve("jelly_beans/are/good")
-      File.read(file.path).should == 'hey dog'
+      pathname, meta = @data_store.retrieve("jelly_beans/are/good")
+      pathname.read.should == 'hey dog'
       meta.should == {}
     end
-
+    
+    it "should work even if meta is stored in old .extra file" do
+      uid = @data_store.store(@temp_object, :meta => {:dog => 'food'})
+      FileUtils.mv("#{@data_store.root_path}/#{uid}.meta", "#{@data_store.root_path}/#{uid}.extra")
+      pathname, meta = @data_store.retrieve(uid)
+      meta.should == {:dog => 'food'}
+    end
+    
     it "should raise an error if the file path has .. in it" do
       expect{
         @data_store.retrieve('jelly_beans/../are/good')
@@ -159,16 +176,27 @@ describe Dragonfly::DataStorage::FileDataStore do
   end
   
   describe "destroying" do
-    it "should raise an error if the data doesn't exist" do
+    it "should prune empty directories when destroying" do
+      uid = @data_store.store(@temp_object)
+      @data_store.destroy(uid)
+      @data_store.root_path.should be_an_empty_directory
+    end
+
+    it "should raise an error if the data doesn't exist on destroy" do
+      uid = @data_store.store(@temp_object)
+      @data_store.destroy(uid)
       lambda{
-        @data_store.destroy('gooble/gubbub')
+        @data_store.destroy(uid)
       }.should raise_error(Dragonfly::DataStorage::DataNotFound)
     end
 
-    it "should prune empty directories when destroying" do
+    it "should also destroy old .extra files" do
       uid = @data_store.store(@temp_object)
+      FileUtils.cp("#{@data_store.root_path}/#{uid}.meta", "#{@data_store.root_path}/#{uid}.extra")
       @data_store.destroy(uid)
-      @data_store.root_path.should be_an_empty_directory
+      File.exist?("#{@data_store.root_path}/#{uid}").should be_false
+      File.exist?("#{@data_store.root_path}/#{uid}.meta").should be_false
+      File.exist?("#{@data_store.root_path}/#{uid}.extra").should be_false
     end
 
     it "should raise an error if the file path has .. in it" do
@@ -178,4 +206,103 @@ describe Dragonfly::DataStorage::FileDataStore do
     end
   end
 
-end
+  describe "relative paths" do
+    let(:store) { Dragonfly::DataStorage::FileDataStore.new }
+    let(:relative_path) { "2011/02/11/picture.jpg" }
+    let(:absolute_path) { "#{root_path}#{relative_path}" }
+    let(:root_path) { "/path/to/file/" }
+
+    before do
+      store.root_path = root_path
+    end
+
+    subject { store.send :relative, absolute_path }
+
+    it { should == relative_path }
+
+    context "where root path contains spaces" do
+      let(:root_path) { "/path/to/file name/" }
+      it { should == relative_path }
+    end
+    context "where root path contains special chars" do
+      let(:root_path) { "/path/to/file name (Special backup directory)/" }
+      it { should == relative_path }
+    end
+  end
+  
+  describe "turning meta off" do
+    before(:each) do
+      @data_store.store_meta = false
+    end
+
+    it "should not write a meta file" do
+      uid = @data_store.store(@temp_object, :meta => {:bitrate => '35', :name => 'danny.boy'})
+      path = File.join(@data_store.root_path, uid) + '.meta'
+      File.exist?(path).should be_false
+    end
+
+    it "should return an empty hash on retrieve" do
+      uid = @data_store.store(@temp_object, :meta => {:bitrate => '35', :name => 'danny.boy'})
+      obj, meta = @data_store.retrieve(uid)
+      meta.should == {}
+    end
+    
+    it "should still destroy the meta file if it exists" do
+      @data_store.store_meta = true
+      uid = @data_store.store(@temp_object)
+      @data_store.store_meta = false
+      @data_store.destroy(uid)
+      @data_store.root_path.should be_an_empty_directory
+    end
+
+    it "should still destroy properly if meta is on but the meta file doesn't exist" do
+      uid = @data_store.store(@temp_object)
+      @data_store.store_meta = true
+      @data_store.destroy(uid)
+      @data_store.root_path.should be_an_empty_directory
+    end
+  end
+  
+  describe "urls for serving directly" do
+    before(:each) do
+      @uid = 'some/path/to/file.png'
+      @data_store.root_path = '/var/tmp/eggs'
+    end
+    
+    it "should raise an error if called without configuring" do
+      expect{
+        @data_store.url_for(@uid)
+      }.to raise_error(Dragonfly::Configurable::NotConfigured)
+    end
+    
+    it "should work as expected when the the server root is above the root path" do
+      @data_store.server_root = '/var/tmp'
+      @data_store.url_for(@uid).should == '/eggs/some/path/to/file.png'
+    end
+
+    it "should work as expected when the the server root is the root path" do
+      @data_store.server_root = '/var/tmp/eggs'
+      @data_store.url_for(@uid).should == '/some/path/to/file.png'
+    end
+
+    it "should work as expected when the the server root is below the root path" do
+      @data_store.server_root = '/var/tmp/eggs/some/path'
+      @data_store.url_for(@uid).should == '/to/file.png'
+    end
+
+    it "should raise an error when the server root doesn't coincide with the root path" do
+      @data_store.server_root = '/var/blimey/eggs'
+      expect{
+        @data_store.url_for(@uid)
+      }.to raise_error(Dragonfly::DataStorage::FileDataStore::UnableToFormUrl)
+    end
+
+    it "should raise an error when the server root doesn't coincide with the uid" do
+      @data_store.server_root = '/var/tmp/eggs/some/gooney'
+      expect{
+        @data_store.url_for(@uid)
+      }.to raise_error(Dragonfly::DataStorage::FileDataStore::UnableToFormUrl)
+    end
+  end
+
+end

data/spec/dragonfly/data_storage/mongo_data_store_spec.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
-require File.dirname(__FILE__) + '/../../spec_helper'
-require File.dirname(__FILE__) + '/data_store_spec'
+require 'spec_helper'
+require File.dirname(__FILE__) + '/shared_data_store_examples'
 require 'mongo'
 
 describe Dragonfly::DataStorage::MongoDataStore do
@@ -35,4 +35,23 @@ describe Dragonfly::DataStorage::MongoDataStore do
     end
   end
 
+  describe "sharing already configured stuff" do
+    before(:each) do
+      @connection = Mongo::Connection.new
+      @temp_object = Dragonfly::TempObject.new('asdf')
+    end
+    
+    it "should allow sharing the connection" do
+      @data_store.connection = @connection
+      @connection.should_receive(:db).with('dragonfly_test').and_return(db=mock)
+      @data_store.db.should == db
+    end
+    
+    it "should allow sharing the db" do
+      db = @connection.db('dragonfly_test_yo')
+      @data_store.db = db
+      @data_store.grid.instance_eval{@db}.should == db # so wrong
+    end
+  end
+
 end

data/spec/dragonfly/data_storage/s3_data_store_spec.rb

@@ -1,5 +1,5 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
-require File.dirname(__FILE__) + '/data_store_spec'
+require 'spec_helper'
+require File.dirname(__FILE__) + '/shared_data_store_examples'
 require 'yaml'
 
 describe Dragonfly::DataStorage::S3DataStore do
@@ -19,54 +19,218 @@ describe Dragonfly::DataStorage::S3DataStore do
 
   if enabled
 
-    describe "common data_store behaviour" do
+    # Make sure it's a new bucket name
+    BUCKET_NAME = "dragonfly-test-#{Time.now.to_i.to_s(36)}"
 
-      before(:each) do
-        @data_store = Dragonfly::DataStorage::S3DataStore.new
-        @data_store.configure do |d|
-          d.bucket_name = 'dragonfly_test'
-          d.access_key_id = KEY
-          d.secret_access_key = SECRET
-        end
+    before(:each) do
+      WebMock.allow_net_connect!
+      @data_store = Dragonfly::DataStorage::S3DataStore.new
+      @data_store.configure do |d|
+        d.bucket_name = BUCKET_NAME
+        d.access_key_id = KEY
+        d.secret_access_key = SECRET
+        d.region = 'eu-west-1'
       end
+    end
+    
+  else
+
+    BUCKET_NAME = 'test-bucket'
 
-      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'
-          )
-          uid = @data_store.store(temp_object)
-          uid.should =~ /A_Picture_with_many_spaces_in_its_name_at_20_00_pm_\.png$/
-          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
-        
-        it "should work fine when not using the filesystem" do
-          @data_store.use_filesystem = false
-          temp_object = Dragonfly::TempObject.new('gollum')
-          uid = @data_store.store(temp_object)
-          @data_store.retrieve(uid).should == ["gollum", {:meta=>{}, :format=>nil, :name=>nil}]
-        end
+    before(:each) do
+      Fog.mock!
+      @data_store = Dragonfly::DataStorage::S3DataStore.new
+      @data_store.configure do |d|
+        d.bucket_name = BUCKET_NAME
+        d.access_key_id = 'XXXXXXXXX'
+        d.secret_access_key = 'XXXXXXXXX'
+        d.region = 'eu-west-1'
       end
+    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 use the name in the meta if set" do
+      temp_object = Dragonfly::TempObject.new('eggheads')
+      uid = @data_store.store(temp_object, :meta => {:name =>  'doobie'})
+      uid.should =~ /doobie$/
+      data, meta = @data_store.retrieve(uid)
+      data.should == 'eggheads'
+    end
+
+    it "should work ok with files with funny names" do
+      temp_object = Dragonfly::TempObject.new('eggheads')
+      uid = @data_store.store(temp_object, :meta => {:name =>  'A Picture with many spaces in its name (at 20:00 pm).png'})
+      uid.should =~ /A_Picture_with_many_spaces_in_its_name_at_20_00_pm_\.png$/
+      data, meta = @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, meta = @data_store.retrieve(uid)
+      data.should == 'eggheads'
+    end
+    
+    it "should work fine when not using the filesystem" do
+      @data_store.use_filesystem = false
+      temp_object = Dragonfly::TempObject.new('gollum')
+      uid = @data_store.store(temp_object)
+      @data_store.retrieve(uid).first.should == "gollum"
+    end
+  end
+
+  if enabled # Fog.mock! doesn't work consistently with real one here
+    
+    describe "destroy" do
+      before(:each) do
+        @temp_object = Dragonfly::TempObject.new('gollum')
+      end
+      it "should raise an error if the data doesn't exist on destroy" do
+        uid = @data_store.store(@temp_object)
+        @data_store.destroy(uid)
+        lambda{
+          @data_store.destroy(uid)
+        }.should raise_error(Dragonfly::DataStorage::DataNotFound)
+      end
+    end
+    
+  end
+
+  describe "domain" do
+    it "should default to the US" do
+      @data_store.region = nil
+      @data_store.domain.should == 's3.amazonaws.com'
+    end
+    
+    it "should return the correct domain" do
+      @data_store.region = 'eu-west-1'
+      @data_store.domain.should == 's3-eu-west-1.amazonaws.com'
+    end
+    
+    it "does raise an error if an unknown region is given" do
+      @data_store.region = 'latvia-central'
+      lambda{
+        @data_store.domain
+      }.should raise_error
+    end
+  end
 
+  describe "not configuring stuff properly" do
+    before(:each) do
+      @temp_object = Dragonfly::TempObject.new("Hi guys")
+    end
+    
+    it "should require a bucket name on store" do
+      @data_store.bucket_name = nil
+      proc{ @data_store.store(@temp_object) }.should raise_error(Dragonfly::Configurable::NotConfigured)
+    end
+    
+    it "should require an access_key_id on store" do
+      @data_store.access_key_id = nil
+      proc{ @data_store.store(@temp_object) }.should raise_error(Dragonfly::Configurable::NotConfigured)
+    end
+    
+    it "should require a secret access key on store" do
+      @data_store.secret_access_key = nil
+      proc{ @data_store.store(@temp_object) }.should raise_error(Dragonfly::Configurable::NotConfigured)
+    end
+    
+    it "should require a bucket name on retrieve" do
+      @data_store.bucket_name = nil
+      proc{ @data_store.retrieve('asdf') }.should raise_error(Dragonfly::Configurable::NotConfigured)
     end
+    
+    it "should require an access_key_id on retrieve" do
+      @data_store.access_key_id = nil
+      proc{ @data_store.retrieve('asdf') }.should raise_error(Dragonfly::Configurable::NotConfigured)
+    end
+    
+    it "should require a secret access key on retrieve" do
+      @data_store.secret_access_key = nil
+      proc{ @data_store.retrieve('asdf') }.should raise_error(Dragonfly::Configurable::NotConfigured)
+    end
+  end
 
+  describe "autocreating the bucket" do
+    it "should create the bucket on store if it doesn't exist" do
+      @data_store.bucket_name = "dragonfly-test-blah-blah-#{rand(100000000)}"
+      @data_store.store(Dragonfly::TempObject.new("asdfj"))
+    end
+    
+    it "should not try to create the bucket on retrieve if it doesn't exist" do
+      @data_store.bucket_name = "dragonfly-test-blah-blah-#{rand(100000000)}"
+      @data_store.send(:storage).should_not_receive(:put_bucket)
+      proc{ @data_store.retrieve("gungle") }.should raise_error(Dragonfly::DataStorage::DataNotFound)
+    end
+  end
+  
+  describe "headers" do
+    before(:each) do
+      @temp_object = Dragonfly::TempObject.new('fjkdlsa')
+      @data_store.storage_headers = {'x-amz-foo' => 'biscuithead'}
+    end
+    
+    it "should allow configuring globally" do
+      @data_store.storage.should_receive(:put_object).with('test-bucket', anything, anything,
+        hash_including('x-amz-foo' => 'biscuithead')
+      )
+      @data_store.store(@temp_object)
+    end
+    
+    it "should allow adding per-store" do
+      @data_store.storage.should_receive(:put_object).with('test-bucket', anything, anything,
+        hash_including('x-amz-foo' => 'biscuithead', 'hello' => 'there')
+      )
+      @data_store.store(@temp_object, :headers => {'hello' => 'there'})
+    end
+    
+    it "should let the per-store one take precedence" do
+      @data_store.storage.should_receive(:put_object).with('test-bucket', anything, anything,
+        hash_including('x-amz-foo' => 'override!')
+      )
+      @data_store.store(@temp_object, :headers => {'x-amz-foo' => 'override!'})
+    end
+    
+    it "should not mess with the meta" do
+      @data_store.storage.should_receive(:put_object) do |_, __, ___, headers|
+        headers['x-amz-meta-extra'].should =~ /^\w+$/
+      end
+      @data_store.store(@temp_object, :headers => {'hello' => 'there'})
+    end
+  end
+
+  describe "urls for serving directly" do
+    
+    before(:each) do
+      @uid = 'some/path/on/s3'
+    end
+    
+    it "should use the bucket subdomain" do
+      @data_store.url_for(@uid).should == "http://#{BUCKET_NAME}.s3.amazonaws.com/some/path/on/s3"
+    end
+    
+    it "should use the bucket subdomain for other regions too" do
+      @data_store.region = 'eu-west-1'
+      @data_store.url_for(@uid).should == "http://#{BUCKET_NAME}.s3.amazonaws.com/some/path/on/s3"
+    end
+    
+    it "should give an expiring url" do
+      @data_store.url_for(@uid, :expires => 1301476942).should =~
+        %r{^https://#{@data_store.domain}/#{BUCKET_NAME}/some/path/on/s3\?AWSAccessKeyId=#{@data_store.access_key_id}&Signature=[\w%]+&Expires=1301476942$}
+    end
+    
   end
 
 end