carrierwave 0.10.0 → 1.2.0

data/lib/carrierwave/storage/fog.rb

@@ -1,7 +1,3 @@
-# encoding: utf-8
-
-require "fog"
-
 module CarrierWave
   module Storage
 
@@ -20,6 +16,8 @@ module CarrierWave
     # [:fog_authenticated_url_expiration] (optional) time (in seconds) that authenticated urls
     #   will be valid, when fog_public is false and provider is AWS or Google, defaults to 600
     # [:fog_use_ssl_for_aws]              (optional) #public_url will use https for the AWS generated URL]
+    # [:fog_aws_accelerate]               (optional) #public_url will use s3-accelerate subdomain
+    #   instead of s3, defaults to false
     #
     #
     # AWS credentials contain the following keys:
@@ -27,7 +25,7 @@ module CarrierWave
     # [:aws_access_key_id]
     # [:aws_secret_access_key]
     # [:region]                 (optional) defaults to 'us-east-1'
-    #   :region should be one of ['eu-west-1', 'us-east-1', 'ap-southeast-1', 'us-west-1', 'ap-northeast-1']
+    #   :region should be one of ['eu-west-1', 'us-east-1', 'ap-southeast-1', 'us-west-1', 'ap-northeast-1', 'eu-central-1']
     #
     #
     # Google credentials contain the following keys:
@@ -96,6 +94,57 @@ module CarrierWave
         CarrierWave::Storage::Fog::File.new(uploader, self, uploader.store_path(identifier))
       end
 
+      ##
+      # Stores given file to cache directory.
+      #
+      # === Parameters
+      #
+      # [new_file (File, IOString, Tempfile)] any kind of file object
+      #
+      # === Returns
+      #
+      # [CarrierWave::SanitizedFile] a sanitized file
+      #
+      def cache!(new_file)
+        f = CarrierWave::Storage::Fog::File.new(uploader, self, uploader.cache_path)
+        f.store(new_file)
+        f
+      end
+
+      ##
+      # Retrieves the file with the given cache_name from the cache.
+      #
+      # === Parameters
+      #
+      # [cache_name (String)] uniquely identifies a cache file
+      #
+      # === Raises
+      #
+      # [CarrierWave::InvalidParameter] if the cache_name is incorrectly formatted.
+      #
+      def retrieve_from_cache!(identifier)
+        CarrierWave::Storage::Fog::File.new(uploader, self, uploader.cache_path(identifier))
+      end
+
+      ##
+      # Deletes a cache dir
+      #
+      def delete_dir!(path)
+        # do nothing, because there's no such things as 'empty directory'
+      end
+
+      def clean_cache!(seconds)
+        connection.directories.new(
+          :key    => uploader.fog_directory,
+          :public => uploader.fog_public
+        ).files.all(:prefix => uploader.cache_dir).each do |file|
+          # generate_cache_id returns key formated TIMEINT-PID-COUNTER-RND
+          time = file.key.scan(/(\d+)-\d+-\d+-\d+/).first.map { |t| t.to_i }
+          time = Time.at(*time)
+          file.destroy if time < (Time.now.utc - seconds)
+        end
+      end
+
       def connection
         @connection ||= begin
           options = credentials = uploader.fog_credentials
@@ -141,15 +190,17 @@ module CarrierWave
             # avoid a get by using local references
             local_directory = connection.directories.new(:key => @uploader.fog_directory)
             local_file = local_directory.files.new(:key => path)
-            if @uploader.fog_credentials[:provider] == "AWS"
-              local_file.url(::Fog::Time.now + @uploader.fog_authenticated_url_expiration, options)
-            elsif ['Rackspace', 'OpenStack'].include?(@uploader.fog_credentials[:provider])
-              connection.get_object_https_url(@uploader.fog_directory, path, ::Fog::Time.now + @uploader.fog_authenticated_url_expiration)
-            else
-              local_file.url(::Fog::Time.now + @uploader.fog_authenticated_url_expiration)
+            expire_at = ::Fog::Time.now + @uploader.fog_authenticated_url_expiration
+            case @uploader.fog_credentials[:provider]
+              when 'AWS'
+                local_file.url(expire_at, options)
+              when 'Rackspace'
+                connection.get_object_https_url(@uploader.fog_directory, path, expire_at, options)
+              when 'OpenStack'
+                connection.get_object_https_url(@uploader.fog_directory, path, expire_at)
+              else
+                local_file.url(expire_at)
             end
-          else
-            nil
           end
         end
 
@@ -161,7 +212,7 @@ module CarrierWave
         # [String] value of content-type
         #
         def content_type
-          @content_type || file.content_type
+          @content_type || !file.nil? && file.content_type
         end
 
         ##
@@ -236,7 +287,7 @@ module CarrierWave
         # [Integer] size of file body
         #
         def size
-          file.content_length
+          file.nil? ? 0 : file.content_length
         end
 
         ##
@@ -246,7 +297,7 @@ module CarrierWave
         #
         # [Boolean] true if file exists or false
         def exists?
-          !!directory.files.head(path)
+          !!file
         end
 
         ##
@@ -256,15 +307,19 @@ module CarrierWave
         #
         # [Boolean] true on success or raises error
         def store(new_file)
-          fog_file = new_file.to_file
-          @content_type ||= new_file.content_type
-          @file = directory.files.create({
-            :body         => fog_file ? fog_file : new_file.read,
-            :content_type => @content_type,
-            :key          => path,
-            :public       => @uploader.fog_public
-          }.merge(@uploader.fog_attributes))
-          fog_file.close if fog_file && !fog_file.closed?
+          if new_file.is_a?(self.class)
+            new_file.copy_to(path)
+          else
+            fog_file = new_file.to_file
+            @content_type ||= new_file.content_type
+            @file = directory.files.create({
+              :body         => (fog_file ? fog_file : new_file).read,
+              :content_type => @content_type,
+              :key          => path,
+              :public       => @uploader.fog_public
+            }.merge(@uploader.fog_attributes))
+            fog_file.close if fog_file && !fog_file.closed?
+          end
           true
         end
 
@@ -287,7 +342,7 @@ module CarrierWave
             end
           else
             # AWS/Google optimized for speed over correctness
-            case @uploader.fog_credentials[:provider]
+            case @uploader.fog_credentials[:provider].to_s
             when 'AWS'
               # check if some endpoint is set in fog_credentials
               if @uploader.fog_credentials.has_key?(:endpoint)
@@ -296,14 +351,16 @@ module CarrierWave
                 protocol = @uploader.fog_use_ssl_for_aws ? "https" : "http"
                 # if directory is a valid subdomain, use that style for access
                 if @uploader.fog_directory.to_s =~ /^(?:[a-z]|\d(?!\d{0,2}(?:\d{1,3}){3}$))(?:[a-z0-9\.]|(?![\-])|\-(?![\.])){1,61}[a-z0-9]$/
-                  "#{protocol}://#{@uploader.fog_directory}.s3.amazonaws.com/#{encoded_path}"
+                  s3_subdomain = @uploader.fog_aws_accelerate ? "s3-accelerate" : "s3"
+                  "#{protocol}://#{@uploader.fog_directory}.#{s3_subdomain}.amazonaws.com/#{encoded_path}"
                 else
                   # directory is not a valid subdomain, so use path style for access
                   "#{protocol}://s3.amazonaws.com/#{@uploader.fog_directory}/#{encoded_path}"
                 end
               end
             when 'Google'
-              "https://commondatastorage.googleapis.com/#{@uploader.fog_directory}/#{encoded_path}"
+              # https://cloud.google.com/storage/docs/access-public-data
+              "https://storage.googleapis.com/#{@uploader.fog_directory}/#{encoded_path}"
             else
               # avoid a get by just using local reference
               directory.files.new(:key => path).public_url
@@ -338,9 +395,24 @@ module CarrierWave
         # [NilClass] no file name available
         #
         def filename(options = {})
-          if file_url = url(options)
-            URI.decode(file_url).gsub(/.*\/(.*?$)/, '\1').split('?').first
-          end
+          return unless file_url = url(options)
+          CGI.unescape(file_url.split('?').first).gsub(/.*\/(.*?$)/, '\1')
+        end
+
+        ##
+        # Creates a copy of this file and returns it.
+        #
+        # === Parameters
+        #
+        # [new_path (String)] The path where the file should be copied to.
+        #
+        # === Returns
+        #
+        # @return [CarrierWave::Storage::Fog::File] the location where the file will be stored.
+        #
+        def copy_to(new_path)
+          connection.copy_object(@uploader.fog_directory, file.key, @uploader.fog_directory, new_path, acl_header)
+          CarrierWave::Storage::Fog::File.new(@uploader, @base, new_path)
         end
 
       private
@@ -383,6 +455,9 @@ module CarrierWave
           @file ||= directory.files.head(path)
         end
 
+        def acl_header
+          {'x-amz-acl' => @uploader.fog_public ? 'public-read' : 'private'}
+        end
       end
 
     end # Fog

data/lib/carrierwave/storage.rb

@@ -1,9 +1,2 @@
 require "carrierwave/storage/abstract"
 require "carrierwave/storage/file"
-
-begin
-  require "fog"
-rescue LoadError
-end
-
-require "carrierwave/storage/fog" if defined?(Fog)

data/lib/carrierwave/test/matchers.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Test
 
@@ -23,13 +21,16 @@ module CarrierWave
           "expected #{@actual.inspect} to be identical to #{@expected.inspect}"
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.inspect} to not be identical to #{@expected.inspect}"
         end
 
         def description
           "be identical to #{@expected.inspect}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def be_identical_to(expected)
@@ -51,13 +52,16 @@ module CarrierWave
           "expected #{@actual.current_path.inspect} to have permissions #{@expected.to_s(8)}, but they were #{(File.stat(@actual.path).mode & 0777).to_s(8)}"
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} not to have permissions #{@expected.to_s(8)}, but it did"
         end
 
         def description
           "have permissions #{@expected.to_s(8)}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def have_permissions(expected)
@@ -79,13 +83,16 @@ module CarrierWave
           "expected #{File.dirname @actual.current_path.inspect} to have permissions #{@expected.to_s(8)}, but they were #{(File.stat(@actual.path).mode & 0777).to_s(8)}"
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{File.dirname @actual.current_path.inspect} not to have permissions #{@expected.to_s(8)}, but it did"
         end
 
         def description
           "have permissions #{@expected.to_s(8)}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def have_directory_permissions(expected)
@@ -110,13 +117,16 @@ module CarrierWave
           "expected #{@actual.current_path.inspect} to be no larger than #{@width} by #{@height}, but it was #{@actual_width} by #{@actual_height}."
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} to be larger than #{@width} by #{@height}, but it wasn't."
         end
 
         def description
           "be no larger than #{@width} by #{@height}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def be_no_larger_than(width, height)
@@ -141,13 +151,16 @@ module CarrierWave
           "expected #{@actual.current_path.inspect} to have an exact size of #{@width} by #{@height}, but it was #{@actual_width} by #{@actual_height}."
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} not to have an exact size of #{@width} by #{@height}, but it did."
         end
 
         def description
           "have an exact size of #{@width} by #{@height}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def have_dimensions(width, height)
@@ -171,13 +184,16 @@ module CarrierWave
           "expected #{@actual.current_path.inspect} to have an exact size of #{@height}, but it was #{@actual_height}."
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} not to have an exact size of #{@height}, but it did."
         end
 
         def description
           "have an exact height of #{@height}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def have_height(height)
@@ -201,13 +217,16 @@ module CarrierWave
           "expected #{@actual.current_path.inspect} to have an exact size of #{@width}, but it was #{@actual_width}."
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} not to have an exact size of #{@width}, but it did."
         end
 
         def description
           "have an exact width of #{@width}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def have_width(width)
@@ -231,13 +250,16 @@ module CarrierWave
           "expected #{@actual.current_path.inspect} to be no wider than #{@width}, but it was #{@actual_width}."
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} not to be wider than #{@width}, but it is."
         end
 
         def description
           "have a width less than or equal to #{@width}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def be_no_wider_than(width)
@@ -261,19 +283,55 @@ module CarrierWave
           "expected #{@actual.current_path.inspect} to be no taller than #{@height}, but it was #{@actual_height}."
         end
 
-        def negative_failure_message
+        def failure_message_when_negated
           "expected #{@actual.current_path.inspect} not to be taller than #{@height}, but it is."
         end
 
         def description
           "have a height less than or equal to #{@height}"
         end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
       end
 
       def be_no_taller_than(height)
         BeNoTallerThan.new(height)
       end
 
+      class BeFormat # :nodoc:
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(actual)
+          @actual = actual
+          # Satisfy expectation here. Return false or raise an error if it's not met.
+          image = ImageLoader.load_image(@actual.current_path)
+          @actual_expected = image.format
+          !@expected.nil? && @actual_expected.casecmp(@expected).zero?
+        end
+
+        def failure_message
+          "expected #{@actual.current_path.inspect} to have #{@expected} format, but it was #{@actual_expected}."
+        end
+
+        def failure_message_when_negated
+          "expected #{@actual.current_path.inspect} not to have #{@expected} format, but it did."
+        end
+
+        def description
+          "have #{@expected} format"
+        end
+
+        # RSpec 2 compatibility:
+        alias_method :negative_failure_message, :failure_message_when_negated
+      end
+
+      def be_format(expected)
+        BeFormat.new(expected)
+      end
+
       class ImageLoader # :nodoc:
         def self.load_image(filename)
           if defined? ::MiniMagick
@@ -303,6 +361,10 @@ module CarrierWave
           image.rows
         end
 
+        def format
+          image.format
+        end
+
         def initialize(filename)
           @image = ::Magick::Image.read(filename).first
         end
@@ -318,6 +380,10 @@ module CarrierWave
           image[:height]
         end
 
+        def format
+          image[:format]
+        end
+
         def initialize(filename)
           @image = ::MiniMagick::Image.open(filename)
         end
@@ -326,4 +392,3 @@ module CarrierWave
     end # Matchers
   end # Test
 end # CarrierWave
-

data/lib/carrierwave/uploader/cache.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
 
   class FormNotMultipart < UploadError
@@ -8,15 +6,27 @@ module CarrierWave
     end
   end
 
+  class CacheCounter
+    @@counter = 0
+
+    def self.increment
+      @@counter += 1
+    end
+  end
+
   ##
   # Generates a unique cache id for use in the caching system
   #
   # === Returns
   #
-  # [String] a cache id in the format TIMEINT-PID-RND
+  # [String] a cache id in the format TIMEINT-PID-COUNTER-RND
   #
   def self.generate_cache_id
-    Time.now.utc.to_i.to_s + '-' + Process.pid.to_s + '-' + ("%04d" % rand(9999))
+    [Time.now.utc.to_i,
+      Process.pid,
+      '%04d' % (CarrierWave::CacheCounter.increment % 1000),
+      '%04d' % rand(9999)
+    ].map(&:to_s).join('-')
   end
 
   module Uploader
@@ -42,13 +52,7 @@ module CarrierWave
         # It's recommended that you keep cache files in one place only.
         #
         def clean_cached_files!(seconds=60*60*24)
-          Dir.glob(File.expand_path(File.join(cache_dir, '*'), CarrierWave.root)).each do |dir|
-            time = dir.scan(/(\d+)-\d+-\d+/).first.map { |t| t.to_i }
-            time = Time.at(*time)
-            if time < (Time.now.utc - seconds)
-              FileUtils.rm_rf(dir)
-            end
-          end
+          cache_storage.new(CarrierWave::Uploader::Base.new).clean_cache!(seconds)
         end
       end
 
@@ -77,10 +81,8 @@ module CarrierWave
         _content = file.read
         if _content.is_a?(File) # could be if storage is Fog
           sanitized = CarrierWave::Storage::Fog.new(self).retrieve!(File.basename(_content.path))
-          sanitized.read if sanitized.exists?
-
         else
-          sanitized = SanitizedFile.new :tempfile => StringIO.new(file.read),
+          sanitized = SanitizedFile.new :tempfile => StringIO.new(_content),
             :filename => File.basename(path), :content_type => file.content_type
         end
         sanitized
@@ -91,7 +93,7 @@ module CarrierWave
       #
       # === Returns
       #
-      # [String] a cache name, in the format YYYYMMDD-HHMM-PID-RND/filename.txt
+      # [String] a cache name, in the format TIMEINT-PID-COUNTER-RND/filename.txt
       #
       def cache_name
         File.join(cache_id, full_original_filename) if cache_id and original_filename
@@ -115,22 +117,28 @@ module CarrierWave
       #
       def cache!(new_file = sanitized_file)
         new_file = CarrierWave::SanitizedFile.new(new_file)
+        return if new_file.empty?
 
-        unless new_file.empty?
-          raise CarrierWave::FormNotMultipart if new_file.is_path? && ensure_multipart_form
+        raise CarrierWave::FormNotMultipart if new_file.is_path? && ensure_multipart_form
 
-          with_callbacks(:cache, new_file) do
-            self.cache_id = CarrierWave.generate_cache_id unless cache_id
+        self.cache_id = CarrierWave.generate_cache_id unless cache_id
 
-            @filename = new_file.filename
-            self.original_filename = new_file.filename
+        @filename = new_file.filename
+        self.original_filename = new_file.filename
 
-            if move_to_cache
-              @file = new_file.move_to(cache_path, permissions, directory_permissions)
-            else
-              @file = new_file.copy_to(cache_path, permissions, directory_permissions)
-            end
+        begin
+          # first, create a workfile on which we perform processings
+          if move_to_cache
+            @file = new_file.move_to(File.expand_path(workfile_path, root), permissions, directory_permissions)
+          else
+            @file = new_file.copy_to(File.expand_path(workfile_path, root), permissions, directory_permissions)
           end
+
+          with_callbacks(:cache, @file) do
+            @file = cache_storage.cache!(@file)
+          end
+        ensure
+          FileUtils.rm_rf(workfile_path(''))
         end
       end
 
@@ -149,14 +157,29 @@ module CarrierWave
         with_callbacks(:retrieve_from_cache, cache_name) do
           self.cache_id, self.original_filename = cache_name.to_s.split('/', 2)
           @filename = original_filename
-          @file = CarrierWave::SanitizedFile.new(cache_path)
+          @file = cache_storage.retrieve_from_cache!(full_filename(original_filename))
         end
       end
 
+      ##
+      # Calculates the path where the cache file should be stored.
+      #
+      # === Parameters
+      #
+      # [for_file (String)] name of the file <optional>
+      #
+      # === Returns
+      #
+      # [String] the cache path
+      #
+      def cache_path(for_file=full_filename(original_filename))
+        File.join(*[cache_dir, @cache_id, for_file].compact)
+      end
+
     private
 
-      def cache_path
-        File.expand_path(File.join(cache_dir, cache_name), root)
+      def workfile_path(for_file=original_filename)
+        File.join(CarrierWave.tmp_path, @cache_id, version_name.to_s, for_file)
       end
 
       attr_reader :cache_id, :original_filename
@@ -165,7 +188,9 @@ module CarrierWave
       alias_method :full_original_filename, :original_filename
 
       def cache_id=(cache_id)
-        raise CarrierWave::InvalidParameter, "invalid cache id" unless cache_id =~ /\A[\d]+\-[\d]+\-[\d]{4}\z/
+        # Earlier version used 3 part cache_id. Thus we should allow for
+        # the cache_id to have both 3 part and 4 part formats.
+        raise CarrierWave::InvalidParameter, "invalid cache id" unless cache_id =~ /\A(-)?[\d]+\-[\d]+(\-[\d]{4})?\-[\d]{4}\z/
         @cache_id = cache_id
       end
 
@@ -174,6 +199,9 @@ module CarrierWave
         @original_filename = filename
       end
 
+      def cache_storage
+        @cache_storage ||= self.class.cache_storage.new(self)
+      end
     end # Cache
   end # Uploader
 end # CarrierWave

data/lib/carrierwave/uploader/callbacks.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module CarrierWave
   module Uploader
     module Callbacks