locomotive_carrierwave 0.5.0.1.beta1

data/lib/carrierwave/storage/s3.rb

@@ -0,0 +1,249 @@
+# encoding: utf-8
+begin
+  require 'fog'
+rescue LoadError
+  raise "You don't have the 'fog' gem installed. The 'aws', 'aws-s3' and 'right_aws' gems are no longer supported."
+end
+
+module CarrierWave
+  module Storage
+
+    ##
+    # Uploads things to Amazon S3 using the "fog" gem.
+    # You'll need to specify the access_key_id, secret_access_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
+    #
+    # 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
+    #
+    # The following access policies are available:
+    #
+    # [:private]              No one else has any access rights.
+    # [:public_read]          The anonymous principal is granted READ access.
+    #                         If this policy is used on an object, it can be read from a
+    #                         browser with no authentication.
+    # [:public_read_write]    The anonymous principal is granted READ and WRITE access.
+    # [:authenticated_read]   Any principal authenticated as a registered Amazon S3 user
+    #                         is granted READ access.
+    #
+    # You can change the generated url to a cnamed domain by setting the cname config:
+    #
+    #     CarrierWave.configure do |config|
+    #       config.s3_cname = 'bucketname.domain.tld'
+    #       config.s3_bucket = 'bucketname' # only used when storing / deleting files
+    #     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 S3 < 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_object(bucket, @path)
+          @headers = result.headers
+          result.body
+        end
+
+        ##
+        # Remove the file from Amazon S3
+        #
+        def delete
+          connection.delete_object(bucket, @path)
+        end
+
+        def rename(new_path)
+          file = connection.put_object(bucket, new_path, read,
+            {
+              'x-amz-acl' => access_policy.to_s.gsub('_', '-'),
+              'Content-Type' => content_type
+            }.merge(@uploader.s3_headers)
+          )
+          delete
+          file
+        end
+
+        ##
+        # Returns the url on Amazon's S3 service
+        #
+        # === Returns
+        #
+        # [String] file's url
+        #
+        def url
+          if access_policy == :authenticated_read
+            authenticated_url
+          else
+            public_url
+          end
+        end
+
+        def public_url
+          if cnamed?
+            ["http://#{cname}", path].compact.join('/')
+          else
+            ["http://#{bucket}.s3.amazonaws.com", path].compact.join('/')
+          end
+        end
+
+        def authenticated_url
+          connection.get_object_url(bucket, path, Time.now + 60 * 10)
+        end
+
+        def store(file)
+          content_type ||= file.content_type # this might cause problems if content type changes between read and upload (unlikely)
+          connection.put_object(bucket, path, file.read,
+            {
+              'x-amz-acl' => access_policy.to_s.gsub('_', '-'),
+              'Content-Type' => content_type,
+            }.merge(@uploader.s3_headers)
+          )
+        end
+
+        def content_type
+          headers["Content-Type"]
+        end
+
+        def content_type=(type)
+          headers["Content-Type"] = type
+        end
+
+        def size
+           headers['Content-Length'].to_i
+        end
+
+        # Headers returned from file retrieval
+        def headers
+          @headers ||= begin
+            connection.head_object(bucket, @path).headers
+          rescue Excon::Errors::NotFound # Don't die, just return no headers
+            {}
+          end
+        end
+
+      private
+
+        def cname
+          @uploader.s3_cname
+        end
+
+        def cnamed?
+          !@uploader.s3_cname.nil?
+        end
+
+        def access_policy
+          @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::S3::File] the stored file
+      #
+      def store!(file)
+        f = CarrierWave::Storage::S3::File.new(uploader, self, uploader.store_path)
+        f.store(file)
+        f
+      end
+
+      # Do something to retrieve the file
+      #
+      # @param [String] identifier uniquely identifies the file
+      #
+      # [identifier (String)] uniquely identifies the file
+      #
+      # === Returns
+      #
+      # [CarrierWave::Storage::S3::File] the stored file
+      #
+      def retrieve!(identifier)
+        CarrierWave::Storage::S3::File.new(uploader, self, uploader.store_path(identifier))
+      end
+
+      ##
+      # Rename a file on S3
+      #
+      # === Parameters
+      #
+      # [file (CarrierWave::Storage::S3::File)] the file to rename
+      #
+      # === Returns
+      #
+      # [CarrierWave::Storage::S3::File] the renamed file
+      #
+      def rename!(file)
+        path = uploader.store_path
+        file.rename(path)
+        CarrierWave::Storage::S3::File.new(uploader, self, path)
+      end
+
+      def connection
+        @connection ||= Fog::AWS::Storage.new(
+          :aws_access_key_id => uploader.s3_access_key_id,
+          :aws_secret_access_key => uploader.s3_secret_access_key
+        )
+      end
+
+    end # S3
+  end # Storage
+end # CarrierWave
+
+# module CarrierWave; module Storage; class S3 < Abstract; def connection; @connection ||= Fog::AWS::Storage.new(:aws_access_key_id => uploader.s3_access_key_id, :aws_secret_access_key => uploader.s3_secret_access_key, :host => uploader.s3_cnamed ? uploader.s3_bucket : nil); end; end; end; end

data/lib/carrierwave/test/matchers.rb

@@ -0,0 +1,164 @@
+# encoding: utf-8
+
+module CarrierWave
+  module Test
+
+    ##
+    # These are some matchers that can be used in RSpec specs, to simplify the testing
+    # of uploaders.
+    #
+    module Matchers
+
+      class BeIdenticalTo # :nodoc:
+        def initialize(expected)
+          @expected = expected
+        end
+        def matches?(actual)
+          @actual = actual
+          FileUtils.identical?(@actual, @expected)
+        end
+        def failure_message
+          "expected #{@actual.inspect} to be identical to #{@expected.inspect}"
+        end
+        def negative_failure_message
+          "expected #{@actual.inspect} to not be identical to #{@expected.inspect}"
+        end
+      end
+
+      def be_identical_to(expected)
+        BeIdenticalTo.new(expected)
+      end
+
+      class HavePermissions # :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.
+          (File.stat(@actual.path).mode & 0777) == @expected
+        end
+
+        def failure_message
+          "expected #{@actual.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
+          "expected #{@actual.inspect} not to have permissions #{@expected.to_s(8)}, but it did"
+        end
+      end
+
+      def have_permissions(expected)
+        HavePermissions.new(expected)
+      end
+
+      class BeNoLargerThan # :nodoc:
+        def initialize(width, height)
+          @width, @height = width, height
+        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_width = image.width
+          @actual_height = image.height
+          @actual_width <= @width && @actual_height <= @height
+        end
+
+        def failure_message
+          "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
+          "expected #{@actual.current_path.inspect} to be larger than #{@width} by #{@height}, but it wasn't."
+        end
+
+      end
+
+      def be_no_larger_than(width, height)
+        BeNoLargerThan.new(width, height)
+      end
+
+      class HaveDimensions # :nodoc:
+        def initialize(width, height)
+          @width, @height = width, height
+        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_width = image.width
+          @actual_height = image.height
+          @actual_width == @width && @actual_height == @height
+        end
+
+        def failure_message
+          "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
+          "expected #{@actual.current_path.inspect} not to have an exact size of #{@width} by #{@height}, but it did."
+        end
+
+      end
+
+      def have_dimensions(width, height)
+        HaveDimensions.new(width, height)
+      end
+
+      class ImageLoader # :nodoc:
+        def self.load_image(filename)
+          if defined? ::MiniMagick
+            MiniMagickWrapper.new(filename)
+          else
+            unless defined? ::Magick
+              begin
+                require 'rmagick'
+              rescue LoadError
+                require 'RMagick'
+              rescue LoadError
+                puts "WARNING: Failed to require rmagick, image processing may fail!"
+              end
+            end
+            MagickWrapper.new(filename)
+          end
+        end
+      end
+
+      class MagickWrapper # :nodoc:
+        attr_reader :image
+        def width
+          image.columns
+        end
+
+        def height
+          image.rows
+        end
+
+        def initialize(filename)
+          @image = ::Magick::Image.read(filename).first
+        end
+      end
+
+      class MiniMagickWrapper # :nodoc:
+        attr_reader :image
+        def width
+          image[:width]
+        end
+
+        def height
+          image[:height]
+        end
+
+        def initialize(filename)
+          @image = ::MiniMagick::Image.from_file(filename)
+        end
+      end
+
+    end # Matchers
+  end # Test
+end # CarrierWave
+

data/lib/carrierwave/uploader/cache.rb

@@ -0,0 +1,148 @@
+# encoding: utf-8
+
+module CarrierWave
+
+  class FormNotMultipart < UploadError
+    def message
+      "You tried to assign a String or a Pathname to an uploader, for security reasons, this is not allowed.\n\n If this is a file upload, please check that your upload form is multipart encoded."
+    end
+  end
+
+  ##
+  # Generates a unique cache id for use in the caching system
+  #
+  # === Returns
+  #
+  # [String] a cache id in the format YYYYMMDD-HHMM-PID-RND
+  #
+  def self.generate_cache_id
+    Time.now.strftime('%Y%m%d-%H%M') + '-' + Process.pid.to_s + '-' + ("%04d" % rand(9999))
+  end
+
+  module Uploader
+    module Cache
+      extend ActiveSupport::Concern
+
+      include CarrierWave::Uploader::Callbacks
+      include CarrierWave::Uploader::Configuration
+
+      module ClassMethods
+
+        ##
+        # Removes cached files which are older than one day. You could call this method
+        # from a rake task to clean out old cached files.
+        #
+        # You can call this method directly on the module like this:
+        #
+        #   CarrierWave.clean_cached_files!
+        #
+        # === Note
+        #
+        # This only works as long as you haven't done anything funky with your cache_dir.
+        # It's recommended that you keep cache files in one place only.
+        #
+        def clean_cached_files!
+          Dir.glob(File.expand_path(File.join(cache_dir, '*'), CarrierWave.root)).each do |dir|
+            time = dir.scan(/(\d{4})(\d{2})(\d{2})-(\d{2})(\d{2})/).first.map { |t| t.to_i }
+            time = Time.utc(*time)
+            if time < (Time.now - (60*60*24))
+              FileUtils.rm_rf(dir)
+            end
+          end
+        end
+      end
+
+      ##
+      # Returns true if the uploader has been cached
+      #
+      # === Returns
+      #
+      # [Bool] whether the current file is cached
+      #
+      def cached?
+        @cache_id
+      end
+
+      ##
+      # Returns a String which uniquely identifies the currently cached file for later retrieval
+      #
+      # === Returns
+      #
+      # [String] a cache name, in the format YYYYMMDD-HHMM-PID-RND/filename.txt
+      #
+      def cache_name
+        File.join(cache_id, full_original_filename) if cache_id and original_filename
+      end
+
+      ##
+      # Caches the given file. Calls process! to trigger any process callbacks.
+      #
+      # === Parameters
+      #
+      # [new_file (File, IOString, Tempfile)] any kind of file object
+      #
+      # === Raises
+      #
+      # [CarrierWave::FormNotMultipart] if the assigned parameter is a string
+      #
+      def cache!(new_file)
+        new_file = CarrierWave::SanitizedFile.new(new_file)
+        raise CarrierWave::FormNotMultipart if new_file.is_path? && ensure_multipart_form
+
+        unless new_file.empty?
+          with_callbacks(:cache, new_file) do
+            @original_file ||= self.file.clone if self.file
+
+            self.cache_id = CarrierWave.generate_cache_id unless cache_id
+
+            @filename = new_file.filename
+            self.original_filename = new_file.filename
+
+            @file = new_file.copy_to(cache_path, permissions)
+          end
+        end
+      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!(cache_name)
+        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)
+        end
+      end
+
+    private
+
+      def cache_path
+        File.expand_path(File.join(cache_dir, cache_name), root)
+      end
+
+      attr_reader :cache_id, :original_filename
+
+      # We can override the full_original_filename method in other modules
+      alias_method :full_original_filename, :original_filename
+
+      def cache_id=(cache_id)
+        raise CarrierWave::InvalidParameter, "invalid cache id" unless cache_id =~ /\A[\d]{8}\-[\d]{4}\-[\d]+\-[\d]{4}\z/
+        @cache_id = cache_id
+      end
+
+      def original_filename=(filename)
+        raise CarrierWave::InvalidParameter, "invalid filename" unless filename =~ /\A[a-z0-9\.\-\+_]+\z/i
+        @original_filename = filename
+      end
+
+    end # Cache
+  end # Uploader
+end # CarrierWave

data/lib/carrierwave/uploader/callbacks.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module CarrierWave
+  module Uploader
+    module Callbacks
+      extend ActiveSupport::Concern
+
+      included do
+        class_inheritable_accessor :_before_callbacks, :_after_callbacks
+      end
+
+      def with_callbacks(kind, *args)
+        self.class._before_callbacks_for(kind).each { |callback| self.send(callback, *args) }
+        yield
+        self.class._after_callbacks_for(kind).each { |callback| self.send(callback, *args) }
+      end
+
+      module ClassMethods
+        
+        def _before_callbacks_for(kind) #:nodoc:
+          (self._before_callbacks || { kind => [] })[kind] || []
+        end
+
+        def _after_callbacks_for(kind) #:nodoc:
+          (self._after_callbacks || { kind => [] })[kind] || []
+        end
+
+        def before(kind, callback)          
+          self._before_callbacks ||= {}
+          self._before_callbacks[kind] = _before_callbacks_for(kind) + [callback]
+        end
+
+        def after(kind, callback)
+          self._after_callbacks ||= {}
+          self._after_callbacks[kind] = _after_callbacks_for(kind) + [callback]
+        end
+      end # ClassMethods
+
+    end # Callbacks
+  end # Uploader
+end # CarrierWave