paperclip 2.3.3 → 2.3.4

data/lib/paperclip/storage/filesystem.rb

@@ -0,0 +1,73 @@
+module Paperclip
+  module Storage
+    # The default place to store attachments is in the filesystem. Files on the local
+    # filesystem can be very easily served by Apache without requiring a hit to your app.
+    # They also can be processed more easily after they've been saved, as they're just
+    # normal files. There is one Filesystem-specific option for has_attached_file.
+    # * +path+: The location of the repository of attachments on disk. This can (and, in
+    #   almost all cases, should) be coordinated with the value of the +url+ option to
+    #   allow files to be saved into a place where Apache can serve them without
+    #   hitting your app. Defaults to
+    #   ":rails_root/public/:attachment/:id/:style/:basename.:extension"
+    #   By default this places the files in the app's public directory which can be served
+    #   directly. If you are using capistrano for deployment, a good idea would be to
+    #   make a symlink to the capistrano-created system directory from inside your app's
+    #   public directory.
+    #   See Paperclip::Attachment#interpolate for more information on variable interpolaton.
+    #     :path => "/var/app/attachments/:class/:id/:style/:basename.:extension"
+    module Filesystem
+      def self.extended base
+      end
+
+      def exists?(style_name = default_style)
+        if original_filename
+          File.exist?(path(style_name))
+        else
+          false
+        end
+      end
+
+      # Returns representation of the data of the file assigned to the given
+      # style, in the format most representative of the current storage.
+      def to_file style_name = default_style
+        @queued_for_write[style_name] || (File.new(path(style_name), 'rb') if exists?(style_name))
+      end
+
+      def flush_writes #:nodoc:
+        @queued_for_write.each do |style_name, file|
+          file.close
+          FileUtils.mkdir_p(File.dirname(path(style_name)))
+          log("saving #{path(style_name)}")
+          FileUtils.mv(file.path, path(style_name))
+          FileUtils.chmod(0644, path(style_name))
+        end
+        @queued_for_write = {}
+      end
+
+      def flush_deletes #:nodoc:
+        @queued_for_delete.each do |path|
+          begin
+            log("deleting #{path}")
+            FileUtils.rm(path) if File.exist?(path)
+          rescue Errno::ENOENT => e
+            # ignore file-not-found, let everything else pass
+          end
+          begin
+            while(true)
+              path = File.dirname(path)
+              FileUtils.rmdir(path)
+              break if File.exists?(path) # Ruby 1.9.2 does not raise if the removal failed.
+            end
+          rescue Errno::EEXIST, Errno::ENOTEMPTY, Errno::ENOENT, Errno::EINVAL, Errno::ENOTDIR
+            # Stop trying to remove parent directories
+          rescue SystemCallError => e
+            log("There was an unexpected error while deleting directories: #{e.class}")
+            # Ignore it
+          end
+        end
+        @queued_for_delete = []
+      end
+    end
+
+  end
+end

data/lib/paperclip/storage/s3.rb

@@ -0,0 +1,191 @@
+module Paperclip
+  module Storage
+    # Amazon's S3 file hosting service is a scalable, easy place to store files for
+    # distribution. You can find out more about it at http://aws.amazon.com/s3
+    # There are a few S3-specific options for has_attached_file:
+    # * +s3_credentials+: Takes a path, a File, or a Hash. The path (or File) must point
+    #   to a YAML file containing the +access_key_id+ and +secret_access_key+ that Amazon
+    #   gives you. You can 'environment-space' this just like you do to your
+    #   database.yml file, so different environments can use different accounts:
+    #     development:
+    #       access_key_id: 123...
+    #       secret_access_key: 123...
+    #     test:
+    #       access_key_id: abc...
+    #       secret_access_key: abc...
+    #     production:
+    #       access_key_id: 456...
+    #       secret_access_key: 456...
+    #   This is not required, however, and the file may simply look like this:
+    #     access_key_id: 456...
+    #     secret_access_key: 456...
+    #   In which case, those access keys will be used in all environments. You can also
+    #   put your bucket name in this file, instead of adding it to the code directly.
+    #   This is useful when you want the same account but a different bucket for
+    #   development versus production.
+    # * +s3_permissions+: This is a String that should be one of the "canned" access
+    #   policies that S3 provides (more information can be found here:
+    #   http://docs.amazonwebservices.com/AmazonS3/2006-03-01/RESTAccessPolicy.html#RESTCannedAccessPolicies)
+    #   The default for Paperclip is :public_read.
+    # * +s3_protocol+: The protocol for the URLs generated to your S3 assets. Can be either
+    #   'http' or 'https'. Defaults to 'http' when your :s3_permissions are :public_read (the
+    #   default), and 'https' when your :s3_permissions are anything else.
+    # * +s3_headers+: A hash of headers such as {'Expires' => 1.year.from_now.httpdate}
+    # * +bucket+: This is the name of the S3 bucket that will store your files. Remember
+    #   that the bucket must be unique across all of Amazon S3. If the bucket does not exist
+    #   Paperclip will attempt to create it. The bucket name will not be interpolated.
+    #   You can define the bucket as a Proc if you want to determine it's name at runtime.
+    #   Paperclip will call that Proc with attachment as the only argument.
+    # * +s3_host_alias+: The fully-qualified domain name (FQDN) that is the alias to the
+    #   S3 domain of your bucket. Used with the :s3_alias_url url interpolation. See the
+    #   link in the +url+ entry for more information about S3 domains and buckets.
+    # * +url+: There are three options for the S3 url. You can choose to have the bucket's name
+    #   placed domain-style (bucket.s3.amazonaws.com) or path-style (s3.amazonaws.com/bucket).
+    #   Lastly, you can specify a CNAME (which requires the CNAME to be specified as
+    #   :s3_alias_url. You can read more about CNAMEs and S3 at
+    #   http://docs.amazonwebservices.com/AmazonS3/latest/index.html?VirtualHosting.html
+    #   Normally, this won't matter in the slightest and you can leave the default (which is
+    #   path-style, or :s3_path_url). But in some cases paths don't work and you need to use
+    #   the domain-style (:s3_domain_url). Anything else here will be treated like path-style.
+    #   NOTE: If you use a CNAME for use with CloudFront, you can NOT specify https as your
+    #   :s3_protocol; This is *not supported* by S3/CloudFront. Finally, when using the host
+    #   alias, the :bucket parameter is ignored, as the hostname is used as the bucket name
+    #   by S3.
+    # * +path+: This is the key under the bucket in which the file will be stored. The
+    #   URL will be constructed from the bucket and the path. This is what you will want
+    #   to interpolate. Keys should be unique, like filenames, and despite the fact that
+    #   S3 (strictly speaking) does not support directories, you can still use a / to
+    #   separate parts of your file name.
+    module S3
+      def self.extended base
+        begin
+          require 'aws/s3'
+        rescue LoadError => e
+          e.message << " (You may need to install the aws-s3 gem)"
+          raise e
+        end
+
+        base.instance_eval do
+          @s3_credentials = parse_credentials(@options[:s3_credentials])
+          @bucket         = @options[:bucket]         || @s3_credentials[:bucket]
+          @bucket         = @bucket.call(self) if @bucket.is_a?(Proc)
+          @s3_options     = @options[:s3_options]     || {}
+          @s3_permissions = @options[:s3_permissions] || :public_read
+          @s3_protocol    = @options[:s3_protocol]    || (@s3_permissions == :public_read ? 'http' : 'https')
+          @s3_headers     = @options[:s3_headers]     || {}
+          @s3_host_alias  = @options[:s3_host_alias]
+          unless @url.to_s.match(/^:s3.*url$/)
+            @path          = @path.gsub(/:url/, @url)
+            @url           = ":s3_path_url"
+          end
+          AWS::S3::Base.establish_connection!( @s3_options.merge(
+            :access_key_id => @s3_credentials[:access_key_id],
+            :secret_access_key => @s3_credentials[:secret_access_key]
+          ))
+        end
+        Paperclip.interpolates(:s3_alias_url) do |attachment, style|
+          "#{attachment.s3_protocol}://#{attachment.s3_host_alias}/#{attachment.path(style).gsub(%r{^/}, "")}"
+        end
+        Paperclip.interpolates(:s3_path_url) do |attachment, style|
+          "#{attachment.s3_protocol}://s3.amazonaws.com/#{attachment.bucket_name}/#{attachment.path(style).gsub(%r{^/}, "")}"
+        end
+        Paperclip.interpolates(:s3_domain_url) do |attachment, style|
+          "#{attachment.s3_protocol}://#{attachment.bucket_name}.s3.amazonaws.com/#{attachment.path(style).gsub(%r{^/}, "")}"
+        end
+      end
+
+      def expiring_url(time = 3600)
+        AWS::S3::S3Object.url_for(path, bucket_name, :expires_in => time )
+      end
+
+      def bucket_name
+        @bucket
+      end
+
+      def s3_host_alias
+        @s3_host_alias
+      end
+
+      def parse_credentials creds
+        creds = find_credentials(creds).stringify_keys
+        (creds[Rails.env] || creds).symbolize_keys
+      end
+
+      def exists?(style = default_style)
+        if original_filename
+          AWS::S3::S3Object.exists?(path(style), bucket_name)
+        else
+          false
+        end
+      end
+
+      def s3_protocol
+        @s3_protocol
+      end
+
+      # Returns representation of the data of the file assigned to the given
+      # style, in the format most representative of the current storage.
+      def to_file style = default_style
+        return @queued_for_write[style] if @queued_for_write[style]
+        filename = path(style).split(".")
+        extname  = File.extname(filename)
+        basename = File.basename(filename, extname)
+        file = Tempfile.new(basename, extname)
+        file.write(AWS::S3::S3Object.value(path(style), bucket_name))
+        file.rewind
+        return file
+      end
+
+      def create_bucket
+        AWS::S3::Bucket.create(bucket_name)
+      end
+
+      def flush_writes #:nodoc:
+        @queued_for_write.each do |style, file|
+          begin
+            log("saving #{path(style)}")
+            AWS::S3::S3Object.store(path(style),
+                                    file,
+                                    bucket_name,
+                                    {:content_type => instance_read(:content_type),
+                                     :access => @s3_permissions,
+                                    }.merge(@s3_headers))
+          rescue AWS::S3::NoSuchBucket => e
+            create_bucket
+            retry
+          rescue AWS::S3::ResponseError => e
+            raise
+          end
+        end
+        @queued_for_write = {}
+      end
+
+      def flush_deletes #:nodoc:
+        @queued_for_delete.each do |path|
+          begin
+            log("deleting #{path}")
+            AWS::S3::S3Object.delete(path, bucket_name)
+          rescue AWS::S3::ResponseError
+            # Ignore this.
+          end
+        end
+        @queued_for_delete = []
+      end
+
+      def find_credentials creds
+        case creds
+        when File
+          YAML::load(ERB.new(File.read(creds.path)).result)
+        when String, Pathname
+          YAML::load(ERB.new(File.read(creds)).result)
+        when Hash
+          creds
+        else
+          raise ArgumentError, "Credentials are not a path, file, or hash."
+        end
+      end
+      private :find_credentials
+
+    end
+  end
+end

data/lib/paperclip/thumbnail.rb

@@ -45,19 +45,20 @@ module Paperclip
     # that contains the new image.
     def make
       src = @file
-      dst = Tempfile.new([@basename, @format].compact.join("."))
+      dst = Tempfile.new([@basename, @format ? ".#{@format}" : ''])
       dst.binmode
 
       begin
-        options = [
-          source_file_options,
-          "#{ File.expand_path(src.path) }[0]",
-          transformation_command,
-          convert_options,
-          "#{ File.expand_path(dst.path) }"
-        ].flatten.compact
+        parameters = []
+        parameters << source_file_options
+        parameters << ":source"
+        parameters << transformation_command
+        parameters << convert_options
+        parameters << ":dest"
 
-        success = Paperclip.run("convert", *options)
+        parameters = parameters.flatten.compact.join(" ").strip.squeeze(" ")
+
+        success = Paperclip.run("convert", parameters, :source => "#{File.expand_path(src.path)}[0]", :dest => File.expand_path(dst.path))
       rescue PaperclipCommandLineError => e
         raise PaperclipError, "There was an error processing the thumbnail for #{@basename}" if @whiny
       end
@@ -70,8 +71,8 @@ module Paperclip
     def transformation_command
       scale, crop = @current_geometry.transformation_to(@target_geometry, crop?)
       trans = []
-      trans << "-resize" << scale unless scale.nil? || scale.empty?
-      trans << "-crop" << crop << "+repage" if crop
+      trans << "-resize" << %["#{scale}"] unless scale.nil? || scale.empty?
+      trans << "-crop" << %["#{crop}"] << "+repage" if crop
       trans
     end
   end

data/lib/paperclip/upfile.rb

@@ -17,7 +17,7 @@ module Paperclip
       when "csv", "xml", "css"       then "text/#{type}"
       else
         # On BSDs, `file` doesn't give a result code of 1 if the file doesn't exist.
-        content_type = (Paperclip.run("file", "--mime-type", self.path).split(':').last.strip rescue "application/x-#{type}")
+        content_type = (Paperclip.run("file", "-b --mime-type :file", :file => self.path).split(':').last.strip rescue "application/x-#{type}")
         content_type = "application/x-#{type}" if content_type.match(/\(.*?\)/)
         content_type
       end
@@ -32,18 +32,26 @@ module Paperclip
     def size
       File.size(self)
     end
+
+    # Returns the hash of the file.
+    def fingerprint
+      Digest::MD5.hexdigest(self.read)
+    end
   end
 end
 
 if defined? StringIO
   class StringIO
-    attr_accessor :original_filename, :content_type
+    attr_accessor :original_filename, :content_type, :fingerprint
     def original_filename
       @original_filename ||= "stringio.txt"
     end
     def content_type
       @content_type ||= "text/plain"
     end
+    def fingerprint
+      @fingerprint ||= Digest::MD5.hexdigest(self.string)
+    end
   end
 end
 

data/lib/paperclip/version.rb

@@ -1,3 +1,3 @@
 module Paperclip
-  VERSION = "2.3.3" unless defined? Paperclip::VERSION
+  VERSION = "2.3.4" unless defined? Paperclip::VERSION
 end

data/shoulda_macros/paperclip.rb

@@ -1,5 +1,4 @@
 require 'paperclip/matchers'
-require 'action_controller'
 
 module Paperclip
   # =Paperclip Shoulda Macros

data/test/attachment_test.rb

@@ -338,9 +338,29 @@ class AttachmentTest < Test::Unit::TestCase
     end
   end
 
+  should "include the filesystem module when loading the filesystem storage" do
+    rebuild_model :storage => :filesystem
+    @dummy = Dummy.new
+    assert @dummy.avatar.is_a?(Paperclip::Storage::Filesystem)
+  end
+
+  should "include the filesystem module even if capitalization is wrong" do
+    rebuild_model :storage => :FileSystem
+    @dummy = Dummy.new
+    assert @dummy.avatar.is_a?(Paperclip::Storage::Filesystem)
+  end
+
+  should "raise an error if you try to include a storage module that doesn't exist" do
+    rebuild_model :storage => :not_here
+    @dummy = Dummy.new
+    assert_raises(Paperclip::StorageMethodNotFound) do
+      @dummy.avatar
+    end
+  end
+
   context "An attachment with styles but no processors defined" do
     setup do
-      rebuild_model :processors => [], :styles => {:something => 1}
+      rebuild_model :processors => [], :styles => {:something => '1'}
       @dummy = Dummy.new
       @file = StringIO.new("...")
     end
@@ -446,6 +466,8 @@ class AttachmentTest < Test::Unit::TestCase
       @not_file = mock
       @tempfile = mock
       @not_file.stubs(:nil?).returns(false)
+      @not_file.stubs(:fingerprint).returns('bd94545193321376b70136f8b223abf8')
+      @tempfile.stubs(:fingerprint).returns('bd94545193321376b70136f8b223abf8')
       @not_file.expects(:size).returns(10)
       @tempfile.expects(:size).returns(10)
       @not_file.expects(:to_tempfile).returns(@tempfile)
@@ -656,7 +678,7 @@ class AttachmentTest < Test::Unit::TestCase
       end
 
       should "not be able to find the module" do
-        assert_raise(NameError){ Dummy.new.avatar }
+        assert_raise(Paperclip::StorageMethodNotFound){ Dummy.new.avatar }
       end
     end
   end
@@ -754,5 +776,29 @@ class AttachmentTest < Test::Unit::TestCase
         assert_equal @file.size, @dummy.avatar.size
       end
     end
+
+    context "and avatar_fingerprint column" do
+      setup do
+        ActiveRecord::Base.connection.add_column :dummies, :avatar_fingerprint, :string
+        rebuild_class
+        @dummy = Dummy.new
+      end
+
+      should "not error when assigned an attachment" do
+        assert_nothing_raised { @dummy.avatar = @file }
+      end
+
+      should "return the right value when sent #avatar_fingerprint" do
+        @dummy.avatar = @file
+        assert_equal 'aec488126c3b33c08a10c3fa303acf27', @dummy.avatar_fingerprint
+      end
+
+      should "return the right value when saved, reloaded, and sent #avatar_fingerprint" do
+        @dummy.avatar = @file
+        @dummy.save
+        @dummy = Dummy.find(@dummy.id)
+        assert_equal 'aec488126c3b33c08a10c3fa303acf27', @dummy.avatar_fingerprint
+      end
+    end
   end
 end

data/test/command_line_test.rb

@@ -0,0 +1,133 @@
+require 'test/helper'
+
+class CommandLineTest < Test::Unit::TestCase
+  def setup
+    Paperclip::CommandLine.path = nil
+    File.stubs(:exist?).with("/dev/null").returns(true)
+  end
+
+  should "take a command and parameters and produce a shell command for bash" do
+    cmd = Paperclip::CommandLine.new("convert", "a.jpg b.png", :swallow_stderr => false)
+    assert_equal "convert a.jpg b.png", cmd.command
+  end
+
+  should "be able to set a path and produce commands with that path" do
+    Paperclip::CommandLine.path = "/opt/bin"
+    cmd = Paperclip::CommandLine.new("convert", "a.jpg b.png", :swallow_stderr => false)
+    assert_equal "/opt/bin/convert a.jpg b.png", cmd.command
+  end
+
+  should "be able to interpolate quoted variables into the parameters" do
+    cmd = Paperclip::CommandLine.new("convert",
+                                     ":one :{two}",
+                                     :one => "a.jpg",
+                                     :two => "b.png",
+                                     :swallow_stderr => false)
+    assert_equal "convert 'a.jpg' 'b.png'", cmd.command
+  end
+
+  should "quote command line options differently if we're on windows" do
+    File.stubs(:exist?).with("/dev/null").returns(false)
+    cmd = Paperclip::CommandLine.new("convert",
+                                     ":one :{two}",
+                                     :one => "a.jpg",
+                                     :two => "b.png",
+                                     :swallow_stderr => false)
+    assert_equal 'convert "a.jpg" "b.png"', cmd.command
+  end
+
+  should "be able to quote and interpolate dangerous variables" do
+    cmd = Paperclip::CommandLine.new("convert",
+                                     ":one :two",
+                                     :one => "`rm -rf`.jpg",
+                                     :two => "ha'ha.png",
+                                     :swallow_stderr => false)
+    assert_equal "convert '`rm -rf`.jpg' 'ha'\\''ha.png'", cmd.command
+  end
+
+  should "be able to quote and interpolate dangerous variables even on windows" do
+    File.stubs(:exist?).with("/dev/null").returns(false)
+    cmd = Paperclip::CommandLine.new("convert",
+                                     ":one :two",
+                                     :one => "`rm -rf`.jpg",
+                                     :two => "ha'ha.png",
+                                     :swallow_stderr => false)
+    assert_equal %{convert "`rm -rf`.jpg" "ha'ha.png"}, cmd.command
+  end
+
+  should "add redirection to get rid of stderr in bash" do
+    File.stubs(:exist?).with("/dev/null").returns(true)
+    cmd = Paperclip::CommandLine.new("convert",
+                                     "a.jpg b.png",
+                                     :swallow_stderr => true)
+
+    assert_equal "convert a.jpg b.png 2>/dev/null", cmd.command
+  end
+
+  should "add redirection to get rid of stderr in cmd.exe" do
+    File.stubs(:exist?).with("/dev/null").returns(false)
+    cmd = Paperclip::CommandLine.new("convert",
+                                     "a.jpg b.png",
+                                     :swallow_stderr => true)
+
+    assert_equal "convert a.jpg b.png 2>NUL", cmd.command
+  end
+
+  should "raise if trying to interpolate :swallow_stderr or :expected_outcodes" do
+    cmd = Paperclip::CommandLine.new("convert",
+                                     ":swallow_stderr :expected_outcodes",
+                                     :swallow_stderr => false,
+                                     :expected_outcodes => [0, 1])
+    assert_raise(Paperclip::PaperclipCommandLineError) do
+      cmd.command
+    end
+  end
+
+  should "run the #command it's given and return the output" do
+    cmd = Paperclip::CommandLine.new("convert", "a.jpg b.png", :swallow_stderr => false)
+    cmd.class.stubs(:"`").with("convert a.jpg b.png").returns(:correct_value)
+    with_exitstatus_returning(0) do
+      assert_equal :correct_value, cmd.run
+    end
+  end
+
+  should "raise a PaperclipCommandLineError if the result code isn't expected" do
+    cmd = Paperclip::CommandLine.new("convert", "a.jpg b.png", :swallow_stderr => false)
+    cmd.class.stubs(:"`").with("convert a.jpg b.png").returns(:correct_value)
+    with_exitstatus_returning(1) do
+      assert_raises(Paperclip::PaperclipCommandLineError) do
+        cmd.run
+      end
+    end
+  end
+
+  should "not raise a PaperclipCommandLineError if the result code is expected" do
+    cmd = Paperclip::CommandLine.new("convert",
+                                     "a.jpg b.png",
+                                     :expected_outcodes => [0, 1],
+                                     :swallow_stderr => false)
+    cmd.class.stubs(:"`").with("convert a.jpg b.png").returns(:correct_value)
+    with_exitstatus_returning(1) do
+      assert_nothing_raised do
+        cmd.run
+      end
+    end
+  end
+
+  should "log the command" do
+    cmd = Paperclip::CommandLine.new("convert", "a.jpg b.png", :swallow_stderr => false)
+    cmd.class.stubs(:'`')
+    Paperclip.expects(:log).with("convert a.jpg b.png")
+    cmd.run
+  end
+
+  should "detect that the system is unix or windows based on presence of /dev/null" do
+    File.stubs(:exist?).returns(true)
+    assert Paperclip::CommandLine.unix?
+  end
+
+  should "detect that the system is not unix or windows based on absence of /dev/null" do
+    File.stubs(:exist?).returns(false)
+    assert ! Paperclip::CommandLine.unix?
+  end
+end