carrierwave 0.4.1 → 0.4.2

data/lib/carrierwave/storage/right_s3.rb

@@ -0,0 +1,183 @@
+# encoding: utf-8
+require 'right_aws'
+
+module CarrierWave
+  module Storage
+
+    ##
+    # Uploads things to Amazon S3 webservices using the RightAWS libraries (right_aws gem). 
+    # In order for CarrierWave to connect to Amazon S3, you'll need to specify an access key id, secret key
+    # and bucket
+    #
+    #     CarrierWave.configure do |config|
+    #       config.s3_access_key_id = "xxxxxx"
+    #       config.s3_secret_access_key = "xxxxxx"
+    #       config.s3_bucket = "my_bucket_name"
+    #     end
+    #
+    # The RightAWS::S3Interface is used directly as opposed to the normal RightAWS::S3::Bucket et.al. classes.
+    # This gives much improved performance and avoids unnecessary requests.
+    #
+    # You can set the access policy for the uploaded files:
+    #
+    #     CarrierWave.configure do |config|
+    #       config.s3_access_policy = 'public-read'
+    #     end
+    #
+    # The default is 'public-read'. For more options see:
+    #
+    # http://docs.amazonwebservices.com/AmazonS3/latest/RESTAccessPolicy.html#RESTCannedAccessPolicies
+    #
+    # You can change the generated url to a cnamed domain by setting the cnamed config:
+    #
+    #     CarrierWave.configure do |config|
+    #       config.s3_cnamed = true
+    #       config.s3_bucket = 'bucketname.domain.tld'
+    #     end
+    #
+    # Now the resulting url will be
+    #     
+    #     http://bucketname.domain.tld/path/to/file
+    #
+    # instead of
+    #
+    #     http://bucketname.domain.tld.s3.amazonaws.com/path/to/file
+    #
+    class RightS3 < Abstract
+
+      class File
+
+        def initialize(uploader, base, path)
+          @uploader = uploader
+          @path = path
+          @base = base
+        end
+
+        ##
+        # Returns the current path of the file on S3
+        #
+        # === Returns
+        #
+        # [String] A path
+        #
+        def path
+          @path
+        end
+
+        ##
+        # Reads the contents of the file from S3
+        #
+        # === Returns
+        #
+        # [String] contents of the file
+        #
+        def read
+          result = connection.get(bucket, @path)
+          headers["content-type"] = result[:headers]["content-type"]
+          result[:object]
+        end
+
+        ##
+        # Remove the file from Amazon S3
+        #
+        def delete
+          connection.delete(bucket, @path)
+        end
+
+        ##
+        # Returns the url on Amazon's S3 service
+        #
+        # === Returns
+        #
+        # [String] file's url
+        #
+        def url
+          if @uploader.s3_cnamed
+            ["http://", @uploader.s3_bucket, @path].compact.join('/')
+          else
+            ["http://#{@uploader.s3_bucket}.s3.amazonaws.com", @path].compact.join('/')
+          end
+        end
+
+        #def about
+        #  s3_object.about
+        #end
+
+        #def metadata
+        #  s3_object.metadata
+        #end
+
+        def content_type
+          headers["content-type"]
+        end
+
+        def content_type=(new_content_type)
+          headers["content-type"] = new_content_type
+        end
+
+        #def content_disposition
+        #  s3_object.content_disposition
+        #end
+
+        #def content_disposition=(new_disposition)
+        #  s3_object.content_disposition = new_disposition
+        #end
+
+        def store(data)
+          connection.put(bucket, @path, data, headers)
+        end
+
+        private
+
+          def headers
+            @headers ||= { 'x-amz-acl' => @uploader.s3_access_policy }
+          end
+
+          def bucket
+            @uploader.s3_bucket
+          end
+
+          def connection
+            @base.connection
+          end
+
+      end
+
+      ##
+      # Store the file on S3
+      #
+      # === Parameters
+      #
+      # [file (CarrierWave::SanitizedFile)] the file to store
+      #
+      # === Returns
+      #
+      # [CarrierWave::Storage::RightS3::File] the stored file
+      #
+      def store!(file)
+        f = CarrierWave::Storage::RightS3::File.new(uploader, self, uploader.store_path)
+        f.store(file.read)
+        f
+      end
+
+      # Do something to retrieve the file
+      #
+      # @param [String] identifier uniquely identifies the file
+      #
+      # [identifier (String)] uniquely identifies the file
+      #
+      # === Returns
+      #
+      # [CarrierWave::Storage::RightS3::File] the stored file
+      #
+      def retrieve!(identifier)
+        CarrierWave::Storage::RightS3::File.new(uploader, self, uploader.store_path(identifier))
+      end
+
+      def connection
+        @connection ||= RightAws::S3Interface.new(uploader.s3_access_key_id, uploader.s3_secret_access_key)
+      end
+
+    end # RightS3
+  end # Storage
+end # CarrierWave

data/lib/carrierwave/uploader/configuration.rb

@@ -6,7 +6,8 @@ module CarrierWave
         add_config :root
         add_config :permissions
         add_config :storage_engines
-        add_config :s3_access
+        add_config :s3_access # for aws/s3
+        add_config :s3_access_policy # for right_aws
         add_config :s3_bucket
         add_config :s3_access_key_id
         add_config :s3_secret_access_key
@@ -16,6 +17,7 @@ module CarrierWave
         add_config :grid_fs_access_url
         add_config :store_dir
         add_config :cache_dir
+        add_config :enable_processing
 
         # Mounting
         add_config :ignore_integrity_errors
@@ -29,10 +31,12 @@ module CarrierWave
           config.storage_engines = {
             :file => "CarrierWave::Storage::File",
             :s3 => "CarrierWave::Storage::S3",
-            :grid_fs => "CarrierWave::Storage::GridFS"
+            :grid_fs => "CarrierWave::Storage::GridFS",
+            :right_s3 => "CarrierWave::Storage::RightS3"
           }
           config.storage = :file
           config.s3_access = :public_read
+          config.s3_access_policy = 'public-read'
           config.grid_fs_database = 'carrierwave'
           config.grid_fs_host = 'localhost'
           config.store_dir = 'uploads'
@@ -42,6 +46,7 @@ module CarrierWave
           config.validate_integrity = true
           config.validate_processing = true
           config.root = CarrierWave.root
+          config.enable_processing = true
         end
       end
 

data/lib/carrierwave/uploader/processing.rb

@@ -71,8 +71,10 @@ module CarrierWave
       # Apply all process callbacks added through CarrierWave.process
       #
       def process!(new_file=nil)
-        self.class.processors.each do |method, args|
-          self.send(method, *args)
+        if enable_processing
+          self.class.processors.each do |method, args|
+            self.send(method, *args)
+          end
         end
       end
 

data/spec/orm/datamapper_spec.rb

@@ -2,47 +2,54 @@
 
 require File.dirname(__FILE__) + '/../spec_helper'
 
+require 'dm-core'
+require 'dm-validations'
 require 'carrierwave/orm/datamapper'
 
 DataMapper.setup(:default, 'sqlite3::memory:')
 
 describe CarrierWave::DataMapper do
-  
+
   before do
     uploader = Class.new(CarrierWave::Uploader::Base)
-    
+
     @class = Class.new
     @class.class_eval do
       include DataMapper::Resource
 
       storage_names[:default] = 'events'
-      
+
       property :id, DataMapper::Types::Serial
-      property :image, String
-      
+
+      # auto validation off currently for inferred type
+      # validation. issue is that validations are done on
+      # the value returned by model#property_name which is overloaded
+      # by carrierwave. pull request in @dm-more to remedy this.
+      property :image, String, :auto_validation => false
+
       mount_uploader :image, uploader
     end
-    
+
     @class.auto_migrate!
-    
+
     @uploader = uploader
-    
+
     @event = @class.new
   end
-  
+
   describe '#image' do
-    
+
     it "should return blank uploader when nothing has been assigned" do
       @event.image.should be_blank
     end
-    
+
     it "should return blank uploader when an empty string has been assigned" do
       repository(:default).adapter.query("INSERT INTO events (image) VALUES ('')")
       @event = @class.first
-      
+
       @event.image.should be_blank
     end
-    
+
     it "should retrieve a file from the storage if a value is stored in the database" do
       repository(:default).adapter.query("INSERT INTO events (image) VALUES ('test.jpg')")
       @event = @class.first
@@ -51,82 +58,64 @@ describe CarrierWave::DataMapper do
       @event.reload
       @event.image.should be_an_instance_of(@uploader)
     end
-    
+
     it "should set the path to the store dir" do
       @event.attribute_set(:image, 'test.jpeg')
       @event.save
       @event.reload
       @event.image.current_path.should == public_path('uploads/test.jpeg')
     end
-  
+
   end
-  
+
   describe '#image=' do
-    
+
     it "should cache a file" do
       @event.image = stub_file('test.jpeg')
       @event.image.should be_an_instance_of(@uploader)
     end
-    
+
     it "should write nothing to the database, to prevent overriden filenames to fail because of unassigned attributes" do
       @event.attribute_get(:image).should be_nil
     end
-    
+
     it "should copy a file into into the cache directory" do
       @event.image = stub_file('test.jpeg')
       @event.image.current_path.should =~ /^#{public_path('uploads/tmp')}/
     end
-    
+
     it "should do nothing when nil is assigned" do
       @event.image = nil
       @event.image.should be_blank
     end
-    
+
     it "should do nothing when an empty string is assigned" do
       @event.image = ''
       @event.image.should be_blank
     end
-    
+
   end
-  
+
   describe '#save' do
-    
+
     it "should do nothing when no file has been assigned" do
       @event.save
       @event.image.should be_blank
     end
-    
+
     it "should copy the file to the upload directory when a file has been assigned" do
       @event.image = stub_file('test.jpeg')
       @event.save
       @event.image.should be_an_instance_of(@uploader)
       @event.image.current_path.should == public_path('uploads/test.jpeg')
     end
-    
-    # it "should do nothing when a validation fails" do
-    #   pending "how do we test with and without dm-validations?"
-    #   @class.validate { |r| r.errors.add :textfile, "FAIL!" }
-    #   @event.image = stub_file('test.jpeg')
-    #   @event.save
-    #   @event.image.should be_an_instance_of(@uploader)
-    #   @event.image.current_path.should =~ /^#{public_path('uploads/tmp')}/
-    # end
-    
+
     it "should assign the filename to the database" do
       @event.image = stub_file('test.jpeg')
       @event.save
       @event.reload
       @event.attribute_get(:image).should == 'test.jpeg'
     end
-    
-    # it "should assign the filename before validation" do
-    #   pending "how do we test with and without dm-validations?"
-    #   @class.validate { |r| r.errors.add_to_base "FAIL!" if r[:image].nil? }
-    #   @event.image = stub_file('test.jpeg')
-    #   @event.save
-    #   @event.reload
-    #   @event.attribute_get(:image).should == 'test.jpeg'
-    # end
 
     it "should remove the image if remove_image? returns true" do
       @event.image = stub_file('test.jpeg')
@@ -138,14 +127,32 @@ describe CarrierWave::DataMapper do
       @event.attribute_get(:image).should == ''
     end
 
+    describe "with validations" do
+      it "should do nothing when a validation fails" do
+        @class.validates_with_block(:textfile) { [false, "FAIL!"] }
+        @event.image = stub_file('test.jpeg')
+        @event.save
+        @event.image.should be_an_instance_of(@uploader)
+        @event.image.current_path.should =~ /^#{public_path('uploads/tmp')}/
+      end
+
+      it "should assign the filename before validation" do
+        @class.validates_with_block(:image) { [false, "FAIL!"] if self.image.nil? }
+        @event.image = stub_file('test.jpeg')
+        @event.save
+        @event.reload
+        @event.attribute_get(:image).should == 'test.jpeg'
+      end
+    end
+
   end
 
   describe '#destroy' do
-    
+
     it "should do nothing when no file has been assigned" do
       @event.destroy
     end
-    
+
     it "should remove the file from the filesystem" do
       @event.image = stub_file('test.jpeg')
       @event.save.should be_true
@@ -157,5 +164,5 @@ describe CarrierWave::DataMapper do
     end
 
   end
-  
+
 end

data/spec/orm/mongoid_spec.rb

@@ -0,0 +1,204 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+require 'carrierwave/orm/mongoid'
+
+Mongoid.connect_to("carrierwave_test")
+
+describe CarrierWave::Mongoid do
+
+  before do
+    uploader = Class.new(CarrierWave::Uploader::Base)
+
+    @class = Mongoid::Document
+    @class.class_eval do
+      mount_uploader :image, uploader
+    end
+
+    @uploader = uploader
+  end
+
+  after do
+    @class.collection.drop
+  end
+
+  describe '#image' do
+
+    context "when nothing is assigned" do
+
+      before do
+        @document = @class.new
+      end
+
+      it "returns a blank uploader" do
+        @document.image.should be_blank
+      end
+
+    end
+
+    context "when an empty string is assigned" do
+
+      before do
+        @document = @class.new(:image_filename => "")
+        @document.save
+      end
+
+      it "returns a blank uploader" do
+        @saved_doc = @class.find(:first)
+        @saved_doc.image.should be_blank
+      end
+
+    end
+
+    context "when a filename is saved in the database" do
+
+      before do
+        @document = @class.new(:image_filename => "test.jpg")
+        @document.save
+        @doc = @class.find(:first)
+      end
+
+      it "returns an uploader" do
+        @doc.image.should be_an_instance_of(@uploader)
+      end
+
+      it "sets the path to the store directory" do
+        @doc.image.current_path.should == public_path('uploads/test.jpg')
+      end
+
+    end
+
+  end
+
+  describe '#image=' do
+
+    before do
+      @doc = @class.new
+    end
+
+    context "when nil is assigned" do
+
+      it "does not set the value" do
+        @doc.image = nil
+        @doc.image.should be_blank
+      end
+
+    end
+
+    context "when an empty string is assigned" do
+
+      it "does not set the value" do
+        @doc.image = ''
+        @doc.image.should be_blank
+      end
+
+    end
+
+    context "when a file is assigned" do
+
+      it "should cache a file" do
+        @doc.image = stub_file('test.jpeg')
+        @doc.image.should be_an_instance_of(@uploader)
+      end
+
+      it "should write nothing to the database, to prevent overriden filenames to fail because of unassigned attributes" do
+        @doc.image_filename.should be_nil
+      end
+
+      it "should copy a file into into the cache directory" do
+        @doc.image = stub_file('test.jpeg')
+        @doc.image.current_path.should =~ /^#{public_path('uploads\/tmp')}/
+      end
+
+    end
+
+  end
+
+  describe "#save" do
+
+    before do
+      @doc = @class.new
+    end
+
+    context "when no file is assigned" do
+
+      it "image is blank" do
+        @doc.save
+        @doc.image.should be_blank
+      end
+
+    end
+
+    context "when a file is assigned" do
+
+      it "copies the file to the upload directory" do
+        @doc.image = stub_file('test.jpg')
+        @doc.save
+        @doc.image.should be_an_instance_of(@uploader)
+        @doc.image.current_path.should == public_path('uploads/test.jpg')
+      end
+
+      it "saves the filename in the database" do
+        @doc.image = stub_file('test.jpg')
+        @doc.save
+        @doc.image_filename.should == 'test.jpg'
+      end
+
+      context "when remove_image? is true" do
+
+        it "removes the image" do
+          @doc.image = stub_file('test.jpeg')
+          @doc.save
+          @doc.remove_image = true
+          @doc.save
+          @doc.image.should be_blank
+          @doc.image_filename.should == ''
+        end
+
+      end
+
+    end
+
+  end
+
+  describe '#destroy' do
+
+    before do
+      @doc = @class.new
+    end
+
+    describe "when file assigned" do
+
+      it "removes the file from the filesystem" do
+        @doc.image = stub_file('test.jpeg')
+        @doc.save.should be_true
+        File.exist?(public_path('uploads/test.jpeg')).should be_true
+        @doc.image.should be_an_instance_of(@uploader)
+        @doc.image.current_path.should == public_path('uploads/test.jpeg')
+        @doc.destroy
+        File.exist?(public_path('uploads/test.jpeg')).should be_false
+      end
+
+    end
+
+    describe "when file is not assigned" do
+
+      it "deletes the instance of @class after save" do
+        @doc.save
+        @class.count(:all, {}).should eql(1)
+        @doc.destroy
+      end
+
+      it "deletes the instance of @class after save and then re-looking up the instance" do
+        @doc.save
+        @class.count(:all, {}).should eql(1)
+        @doc = @class.first
+        @doc.destroy
+      end
+
+    end
+
+  end
+
+
+end