carrierwave 0.9.0 → 2.1.1

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:
@@ -62,6 +60,14 @@ module CarrierWave
         def connection_cache
           @connection_cache ||= {}
         end
+
+        def eager_load
+          # see #1198. This will hopefully no longer be necessary in future release of fog
+          fog_credentials = CarrierWave::Uploader::Base.fog_credentials
+          if fog_credentials.present?
+            CarrierWave::Storage::Fog.connection_cache[fog_credentials] ||= ::Fog::Storage.new(fog_credentials)
+          end
+        end
       end
 
       ##
@@ -96,6 +102,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
@@ -104,6 +161,8 @@ module CarrierWave
       end
 
       class File
+        DEFAULT_S3_REGION = 'us-east-1'
+
         include CarrierWave::Utilities::Uri
 
         ##
@@ -128,7 +187,7 @@ module CarrierWave
 
         ##
         # Return a temporary authenticated url to a private file, if available
-        # Only supported for AWS, Rackspace and Google providers
+        # Only supported for AWS, Rackspace, Google, AzureRM and Aliyun providers
         #
         # === Returns
         #
@@ -137,19 +196,28 @@ module CarrierWave
         # [NilClass] no authenticated url available
         #
         def authenticated_url(options = {})
-          if ['AWS', 'Google', 'Rackspace'].include?(@uploader.fog_credentials[:provider])
+          if ['AWS', 'Google', 'Rackspace', 'OpenStack', 'AzureRM', 'Aliyun', 'backblaze'].include?(@uploader.fog_credentials[:provider])
             # 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 @uploader.fog_credentials[:provider] == "Rackspace"
-              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 = options[:expire_at] || ::Fog::Time.now + @uploader.fog_authenticated_url_expiration
+            case @uploader.fog_credentials[:provider]
+              when 'AWS', 'Google'
+                # Older versions of fog-google do not support options as a parameter
+                if url_options_supported?(local_file)
+                  local_file.url(expire_at, options)
+                else
+                  warn "Options hash not supported in #{local_file.class}. You may need to upgrade your Fog provider."
+                  local_file.url(expire_at)
+                end
+              when 'Rackspace', 'OpenStack'
+                connection.get_object_https_url(@uploader.fog_directory, path, expire_at, options)
+              when 'Aliyun'
+                expire_at = expire_at - Time.now
+                local_file.url(expire_at)
+              else
+                local_file.url(expire_at)
             end
-          else
-            nil
           end
         end
 
@@ -161,7 +229,7 @@ module CarrierWave
         # [String] value of content-type
         #
         def content_type
-          @content_type || file.content_type
+          @content_type || file.try(:content_type)
         end
 
         ##
@@ -184,7 +252,9 @@ module CarrierWave
         #
         def delete
           # avoid a get by just using local reference
-          directory.files.new(:key => path).destroy
+          directory.files.new(:key => path).destroy.tap do |result|
+            @file = nil if result
+          end
         end
 
         ##
@@ -192,10 +262,11 @@ module CarrierWave
         #
         # === Returns
         #
-        # [String] extension of file
+        # [String] extension of file or nil if the file has no extension
         #
         def extension
-          path.split('.').last
+          path_elements = path.split('.')
+          path_elements.last if path_elements.size > 1
         end
 
         ##
@@ -214,7 +285,7 @@ module CarrierWave
         end
 
         def initialize(uploader, base, path)
-          @uploader, @base, @path = uploader, base, path
+          @uploader, @base, @path, @content_type = uploader, base, path, nil
         end
 
         ##
@@ -224,6 +295,16 @@ module CarrierWave
         #
         # [String] contents of file
         def read
+          file_body = file.body
+
+          return if file_body.nil?
+          return file_body unless file_body.is_a?(::File)
+
+          # Fog::Storage::XXX::File#body could return the source file which was upoloaded to the remote server.
+          read_source_file(file_body) if ::File.exist?(file_body.path)
+
+          # If the source file doesn't exist, the remote content is read
+          @file = nil # rubocop:disable Gitlab/ModuleWithInstanceVariables
           file.body
         end
 
@@ -235,7 +316,7 @@ module CarrierWave
         # [Integer] size of file body
         #
         def size
-          file.content_length
+          file.nil? ? 0 : file.content_length
         end
 
         ##
@@ -245,7 +326,7 @@ module CarrierWave
         #
         # [Boolean] true if file exists or false
         def exists?
-          !!directory.files.head(path)
+          !!file
         end
 
         ##
@@ -255,15 +336,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
 
@@ -286,23 +371,35 @@ module CarrierWave
             end
           else
             # AWS/Google optimized for speed over correctness
-            case @uploader.fog_credentials[:provider]
+            case fog_provider
             when 'AWS'
               # check if some endpoint is set in fog_credentials
               if @uploader.fog_credentials.has_key?(:endpoint)
                 "#{@uploader.fog_credentials[:endpoint]}/#{@uploader.fog_directory}/#{encoded_path}"
               else
                 protocol = @uploader.fog_use_ssl_for_aws ? "https" : "http"
+
+                subdomain_regex = /^(?:[a-z]|\d(?!\d{0,2}(?:\d{1,3}){3}$))(?:[a-z0-9\.]|(?![\-])|\-(?![\.])){1,61}[a-z0-9]$/
+                valid_subdomain = @uploader.fog_directory.to_s =~ subdomain_regex && !(protocol == 'https' && @uploader.fog_directory =~ /\./)
+
                 # 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}"
-                else
-                  # directory is not a valid subdomain, so use path style for access
-                  "#{protocol}://s3.amazonaws.com/#{@uploader.fog_directory}/#{encoded_path}"
+                if valid_subdomain
+                  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
+                  region = @uploader.fog_credentials[:region].to_s
+                  host   = case region
+                           when DEFAULT_S3_REGION, ''
+                             's3.amazonaws.com'
+                           else
+                             "s3.#{region}.amazonaws.com"
+                           end
+                  "#{protocol}://#{host}/#{@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
@@ -337,9 +434,24 @@ module CarrierWave
         # [NilClass] no file name available
         #
         def filename(options = {})
-          if file_url = url(options)
-            URI.decode(file_url).gsub(/.*\/(.*?$)/, '\1')
-          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
@@ -382,6 +494,33 @@ module CarrierWave
           @file ||= directory.files.head(path)
         end
 
+        def acl_header
+          if fog_provider == 'AWS'
+            { 'x-amz-acl' => @uploader.fog_public ? 'public-read' : 'private' }
+          else
+            {}
+          end
+        end
+
+        def fog_provider
+          @uploader.fog_credentials[:provider].to_s
+        end
+
+        def read_source_file(file_body)
+          return unless ::File.exist?(file_body.path)
+
+          begin
+            file_body = ::File.open(file_body.path) if file_body.closed? # Reopen if it's already closed
+            file_body.read
+          ensure
+            file_body.close
+          end
+        end
+
+        def url_options_supported?(local_file)
+          parameters = local_file.method(:url).parameters
+          parameters.count == 2 && parameters[1].include?(:options)
+        end
       end
 
     end # Fog

data/lib/carrierwave/storage.rb

@@ -1,9 +1,3 @@
 require "carrierwave/storage/abstract"
 require "carrierwave/storage/file"
-
-begin
-  require "fog"
-rescue LoadError
-end
-
-require "carrierwave/storage/fog" if defined?(Fog)
+require "carrierwave/storage/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
-