paperclip 3.3.1 → 3.4.0

data/lib/paperclip/storage/filesystem.rb

@@ -3,7 +3,7 @@ module Paperclip
     # 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.
+    # normal files. There are two Filesystem-specific options 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
@@ -15,6 +15,12 @@ module Paperclip
     #   public directory.
     #   See Paperclip::Attachment#interpolate for more information on variable interpolaton.
     #     :path => "/var/app/attachments/:class/:id/:style/:basename.:extension"
+    # * +override_file_permissions+: This allows you to override the file permissions for files
+    #   saved by paperclip. If you set this to an explicit octal value (0755, 0644, etc) then
+    #   that value will be used to set the permissions for an uploaded file. The default is 0666.
+    #   If you set :override_file_permissions to false, the chmod will be skipped. This allows
+    #   you to use paperclip on filesystems that don't understand unix file permissions, and has the 
+    #   added benefit of using the storage directories default umask on those that do.
     module Filesystem
       def self.extended base
       end
@@ -35,7 +41,10 @@ module Paperclip
               new_file.write(chunk)
             end
           end
-          FileUtils.chmod(0666&~File.umask, path(style_name))
+          unless @options[:override_file_permissions] == false
+            resolved_chmod = (@options[:override_file_permissions] &~ 0111) || (0666 &~ File.umask)
+            FileUtils.chmod( resolved_chmod, path(style_name) )
+          end
           file.rewind
         end
 

data/lib/paperclip/storage/fog.rb

@@ -18,6 +18,8 @@ module Paperclip
     #   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.
+    # * +fog_file*: This can be hash or lambda returning hash. The
+    #   value is used as base properties for new uploaded file.
     # * +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
@@ -66,18 +68,27 @@ module Paperclip
       end
 
       def fog_file
-        @fog_file ||= @options[:fog_file] || {}
+        @fog_file ||= begin
+          value = @options[:fog_file]
+          if !value
+            {}
+          elsif value.respond_to?(:call)
+            value.call(self)
+          else
+            value
+          end
+        end
       end
 
       def fog_public(style = default_style)
-        if defined?(@options[:fog_public])
-          if defined?(@options[:fog_public][style])
-            return @options[:fog_public][style]
+        if @options.has_key?(:fog_public)
+          if @options[:fog_public].respond_to?(:has_key?) && @options[:fog_public].has_key?(style)
+            @options[:fog_public][style]
           else
-            return @options[:fog_public]
+            @options[:fog_public]
           end
         else
-          return true
+          true
         end
       end
 
@@ -128,10 +139,14 @@ module Paperclip
       end
 
       def expiring_url(time = (Time.now + 3600), style = default_style)
-        expiring_url = directory.files.get_http_url(path(style), time)
+        if directory.files.respond_to?(:get_http_url)
+          expiring_url = directory.files.get_http_url(path(style), time)
 
-        if @options[:fog_host]
-          expiring_url.gsub!(/#{host_name_for_directory}/, dynamic_fog_host_for_style(style))
+          if @options[:fog_host]
+            expiring_url.gsub!(/#{host_name_for_directory}/, dynamic_fog_host_for_style(style))
+          end
+        else
+          expiring_url = public_url
         end
 
         return expiring_url
@@ -145,10 +160,10 @@ module Paperclip
 
       def copy_to_local_file(style, local_dest_path)
         log("copying #{path(style)} to local file #{local_dest_path}")
-        local_file = ::File.open(local_dest_path, 'wb')
-        file = directory.files.get(path(style))
-        local_file.write(file.body)
-        local_file.close
+        ::File.open(local_dest_path, 'wb') do |local_file|
+          file = directory.files.get(path(style))
+          local_file.write(file.body)
+        end
       rescue ::Fog::Errors::Error => e
         warn("#{e} - cannot copy #{path(style)} to local file #{local_dest_path}")
         false

data/lib/paperclip/storage/s3.rb

@@ -35,7 +35,7 @@ module Paperclip
     #     :s3_permissions => {
     #       :original => :private
     #     }
-    #   Or globaly:
+    #   Or globally:
     #     :s3_permissions => :private
     #
     # * +s3_protocol+: The protocol for the URLs generated to your S3 assets. Can be either
@@ -45,6 +45,7 @@ module Paperclip
     # * +s3_headers+: A hash of headers or a Proc. You may specify a hash such as
     #   {'Expires' => 1.year.from_now.httpdate}. If you use a Proc, headers are determined at
     #   runtime. Paperclip will call that Proc with attachment as the only argument.
+    #   Can be defined both globally and within a style-specific hash.
     # * +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.
@@ -83,7 +84,7 @@ module Paperclip
     # * +s3_metadata+: These key/value pairs will be stored with the
     #   object.  This option works by prefixing each key with
     #   "x-amz-meta-" before sending it as a header on the object
-    #   upload request.
+    #   upload request. Can be defined both globally and within a style-specific hash.
     # * +s3_storage_class+: If this option is set to
     #   <tt>:reduced_redundancy</tt>, the object will be stored using Reduced
     #   Redundancy Storage.  RRS enables customers to reduce their
@@ -123,26 +124,17 @@ module Paperclip
               (permission == :public_read) ? 'http' : 'https'
             end
           @s3_metadata = @options[:s3_metadata] || {}
-          @s3_headers = @options[:s3_headers] || {}
-          @s3_headers = @s3_headers.call(instance) if @s3_headers.respond_to?(:call)
-          @s3_headers = (@s3_headers).inject({}) do |headers,(name,value)|
-            case name.to_s
-            when /^x-amz-meta-(.*)/i
-              @s3_metadata[$1.downcase] = value
-            else
-              name = name.to_s.downcase.sub(/^x-amz-/,'').tr("-","_").to_sym
-              headers[name] = value
-            end
-            headers
-          end
+          @s3_headers = {}
+          merge_s3_headers(@options[:s3_headers], @s3_headers, @s3_metadata)
 
           @s3_headers[:storage_class] = @options[:s3_storage_class] if @options[:s3_storage_class]
 
+          @s3_server_side_encryption = :aes256
           if @options[:s3_server_side_encryption].blank?
-            @options[:s3_server_side_encryption] = false
+            @s3_server_side_encryption = false
           end
-          if @options[:s3_server_side_encryption]
-            @s3_headers['x-amz-server-side-encryption'] = @options[:s3_server_side_encryption].to_s.upcase
+          if @s3_server_side_encryption
+            @s3_server_side_encryption = @options[:s3_server_side_encryption].to_s.upcase
           end
 
           unless @options[:url].to_s.match(/^:s3.*url$/) || @options[:url] == ":asset_host"
@@ -221,10 +213,15 @@ module Paperclip
             config[opt] = s3_credentials[opt] if s3_credentials[opt]
           end
 
-          AWS::S3.new(config.merge(@s3_options))
+          obtain_s3_instance_for(config.merge(@s3_options))
         end
       end
 
+      def obtain_s3_instance_for(options)
+        instances = (Thread.current[:paperclip_s3_instances] ||= {})
+        instances[options] ||= AWS::S3.new(options)
+      end
+
       def s3_bucket
         @s3_bucket ||= s3_interface.buckets[bucket_name]
       end
@@ -306,8 +303,19 @@ module Paperclip
               :content_type => file.content_type,
               :acl => acl
             }
+            if @s3_server_side_encryption
+              write_options[:server_side_encryption] = @s3_server_side_encryption
+            end
+
+            style_specific_options = @options[:styles][style]
+            if style_specific_options.is_a?(Hash)
+              merge_s3_headers( style_specific_options[:s3_headers], @s3_headers, @s3_metadata) if style_specific_options.has_key?(:s3_headers)
+              @s3_metadata.merge!(style_specific_options[:s3_metadata]) if style_specific_options.has_key?(:s3_metadata)
+            end
+
             write_options[:metadata] = @s3_metadata unless @s3_metadata.empty?
             write_options.merge!(@s3_headers)
+
             s3_object(style).write(file, write_options)
           rescue AWS::S3::Errors::NoSuchBucket => e
             create_bucket
@@ -363,6 +371,19 @@ module Paperclip
       def use_secure_protocol?(style_name)
         s3_protocol(style_name) == "https"
       end
+
+      def merge_s3_headers(http_headers, s3_headers, s3_metadata)
+        return if http_headers.nil?
+        http_headers = http_headers.call(instance) if http_headers.respond_to?(:call)
+        http_headers.inject({}) do |headers,(name,value)|
+          case name.to_s
+          when /^x-amz-meta-(.*)/i
+            s3_metadata[$1.downcase] = value
+          else
+            s3_headers[name.to_s.downcase.sub(/^x-amz-/,'').tr("-","_").to_sym] = value
+          end
+        end
+      end
     end
   end
 end

data/lib/paperclip/thumbnail.rb

@@ -39,6 +39,9 @@ module Paperclip
       @format              = options[:format]
       @animated            = options[:animated].nil? ? true : options[:animated]
       @auto_orient         = options[:auto_orient].nil? ? true : options[:auto_orient]
+      if @auto_orient && @current_geometry.respond_to?(:auto_orient)
+        @current_geometry.auto_orient
+      end
 
       @source_file_options = @source_file_options.split(/\s+/) if @source_file_options.respond_to?(:split)
       @convert_options     = @convert_options.split(/\s+/)     if @convert_options.respond_to?(:split)

data/lib/paperclip/validators/attachment_content_type_validator.rb

@@ -8,21 +8,41 @@ module Paperclip
 
       def validate_each(record, attribute, value)
         attribute = "#{attribute}_content_type".to_sym
-        value = record.send(:read_attribute_for_validation, attribute)
-        allowed_types = [options[:content_type]].flatten
+        value = record.send :read_attribute_for_validation, attribute
 
         return if (value.nil? && options[:allow_nil]) || (value.blank? && options[:allow_blank])
 
-        if allowed_types.none? { |type| type === value }
-          record.errors.add(attribute, :invalid, options.merge(
-            :types => allowed_types.join(', ')
-          ))
+        validate_whitelist(record, attribute, value)
+        validate_blacklist(record, attribute, value)
+      end
+
+      def validate_whitelist(record, attribute, value)
+        if allowed_types.present? && allowed_types.none? { |type| type === value }
+          mark_invalid record, attribute, allowed_types
+        end
+      end
+
+      def validate_blacklist(record, attribute, value)
+        if forbidden_types.present? && forbidden_types.any? { |type| type === value }
+          mark_invalid record, attribute, forbidden_types
         end
       end
 
+      def mark_invalid(record, attribute, types)
+        record.errors.add attribute, :invalid, options.merge(:types => types.join(', '))
+      end
+
+      def allowed_types
+        [options[:content_type]].flatten.compact
+      end
+
+      def forbidden_types
+        [options[:not]].flatten.compact
+      end
+
       def check_validity!
-        unless options.has_key?(:content_type)
-          raise ArgumentError, "You must pass in :content_type to the validator"
+        unless options.has_key?(:content_type) || options.has_key?(:not)
+          raise ArgumentError, "You must pass in either :content_type or :not to the validator"
         end
       end
     end
@@ -36,6 +56,7 @@ module Paperclip
       #   may not expect. For example, JPEG images are given image/pjpeg and
       #   PNGs are image/x-png, so keep that in mind when determining how you
       #   match.  Allows all by default.
+      # * +not+: Forbidden content types.
       # * +message+: The message to display when the uploaded file has an invalid
       #   content type.
       # * +if+: A lambda or name of an instance method. Validation will only

data/lib/paperclip/version.rb

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

data/paperclip.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('shoulda')
   s.add_development_dependency('appraisal')
   s.add_development_dependency('mocha')
-  s.add_development_dependency('aws-sdk')
+  s.add_development_dependency('aws-sdk', '>= 1.2.0')
   s.add_development_dependency('bourne')
   s.add_development_dependency('sqlite3', '~> 1.3.4')
   s.add_development_dependency('cucumber', '~> 1.2.1')

data/test/attachment_processing_test.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require './test/helper'
+require 'paperclip/attachment'
+
+class AttachmentProcessingTest < Test::Unit::TestCase
+  def setup
+    rebuild_model
+  end
+
+  should 'process attachments given a valid assignment' do
+    file = File.new(fixture_file("5k.png"))
+    Dummy.validates_attachment_content_type :avatar, :content_type => "image/png"
+    instance = Dummy.new
+    attachment = instance.avatar
+    attachment.expects(:post_process)
+
+    attachment.assign(file)
+  end
+
+  should 'not process attachments if the assignment does not pass validation' do
+    file = File.new(fixture_file("5k.png"))
+    Dummy.validates_attachment_content_type :avatar, :content_type => "image/tiff"
+    instance = Dummy.new
+    attachment = instance.avatar
+    attachment.expects(:post_process).never
+
+    attachment.assign(file)
+  end
+end

data/test/attachment_test.rb

@@ -6,6 +6,29 @@ class Dummy; end
 
 class AttachmentTest < Test::Unit::TestCase
 
+  context "presence" do
+    setup do
+      rebuild_class
+      @dummy = Dummy.new
+    end
+
+    context "when file not set" do
+      should "not be present" do
+        assert @dummy.avatar.blank?
+        refute @dummy.avatar.present?
+      end
+    end
+
+    context "when file set" do
+      setup { @dummy.avatar = File.new(fixture_file("50x50.png"), "rb") }
+
+      should "be present" do
+        refute @dummy.avatar.blank?
+        assert @dummy.avatar.present?
+      end
+    end
+  end
+
   should "process :original style first" do
     file = File.new(fixture_file("50x50.png"), 'rb')
     rebuild_class :styles => { :small => '100x>', :original => '42x42#' }
@@ -115,6 +138,39 @@ class AttachmentTest < Test::Unit::TestCase
     assert mock_url_generator_builder.has_generated_url_with_options?(:escape => true, :timestamp => true)
   end
 
+  should "render JSON as default style" do
+    mock_url_generator_builder = MockUrlGeneratorBuilder.new
+    attachment = Paperclip::Attachment.new(:name,
+                                           :instance,
+                                           :default_style => 'default style',
+                                           :url_generator => mock_url_generator_builder)
+
+    attachment_json = attachment.as_json
+    assert mock_url_generator_builder.has_generated_url_with_style_name?('default style')
+  end
+
+  should "pass the option :escape => true if :escape_url is true and :escape is not passed" do
+    mock_url_generator_builder = MockUrlGeneratorBuilder.new
+    attachment = Paperclip::Attachment.new(:name,
+                                           :instance,
+                                           :url_generator => mock_url_generator_builder,
+                                           :escape_url => true)
+
+    attachment.url(:style_name)
+    assert mock_url_generator_builder.has_generated_url_with_options?(:escape => true)
+  end
+
+  should "pass the option :escape => false if :escape_url is false and :escape is not passed" do
+    mock_url_generator_builder = MockUrlGeneratorBuilder.new
+    attachment = Paperclip::Attachment.new(:name,
+                                           :instance,
+                                           :url_generator => mock_url_generator_builder,
+                                           :escape_url => false)
+
+    attachment.url(:style_name)
+    assert mock_url_generator_builder.has_generated_url_with_options?(:escape => false)
+  end
+
   should "return the path based on the url by default" do
     @attachment = attachment :url => "/:class/:id/:basename"
     @model = @attachment.instance
@@ -132,6 +188,24 @@ class AttachmentTest < Test::Unit::TestCase
     assert_equal expected_path, avatar_attachment.path
   end
 
+  should "render JSON as the URL to the attachment" do
+    avatar_attachment = attachment
+    model = avatar_attachment.instance
+    model.id = 1234
+    model.avatar_file_name = "fake.jpg"
+    assert_equal attachment.url, attachment.as_json
+  end
+
+  should "render JSON from the model when requested by :methods" do
+    rebuild_model
+    dummy = Dummy.new
+    dummy.id = 1234
+    dummy.avatar_file_name = "fake.jpg"
+    expected_string = '{"dummy":{"avatar":"/system/dummies/avatars/000/001/234/original/fake.jpg"}}'
+    # active_model pre-3.2 checks only by calling any? on it, thus it doesn't work if it is empty
+    assert_equal expected_string, dummy.to_json(:only => [:dummy_key_for_old_active_model], :methods => [:avatar])
+  end
+
   context "Attachment default_options" do
     setup do
       rebuild_model
@@ -385,6 +459,25 @@ class AttachmentTest < Test::Unit::TestCase
     end
   end
 
+  context "An attachment with :only_process that is a proc" do
+    setup do
+      rebuild_model :styles => {
+                      :thumb => "100x100",
+                      :large => "400x400"
+                    },
+                    :only_process => lambda { |attachment| [:thumb] }
+
+      @file = StringIO.new("...")
+      @attachment = Dummy.new.avatar
+    end
+
+    should "only process the provided style" do
+      @attachment.expects(:post_process).with(:thumb)
+      @attachment.expects(:post_process).with(:large).never
+      @attachment.assign(@file)
+    end
+  end
+
   context "An attachment with :convert_options that is a proc" do
     setup do
       rebuild_model :styles => {
@@ -691,9 +784,7 @@ class AttachmentTest < Test::Unit::TestCase
   context "Assigning an attachment" do
     setup do
       rebuild_model :styles => { :something => "100x100#" }
-      @file = StringIO.new(".")
-      @file.stubs(:original_filename).returns("5k.png\n\n")
-      @file.stubs(:content_type).returns("image/png\n\n")
+      @file = File.new(fixture_file("5k.png"), "rb")
       @dummy = Dummy.new
       @dummy.avatar = @file
     end
@@ -710,9 +801,7 @@ class AttachmentTest < Test::Unit::TestCase
   context "Assigning an attachment" do
     setup do
       rebuild_model :styles => { :something => "100x100#" }
-      @file = StringIO.new(".")
-      @file.stubs(:original_filename).returns("5k.png\n\n")
-      @file.stubs(:content_type).returns(MIME::Type.new("image/png"))
+      @file = File.new(fixture_file("5k.png"), "rb")
       @dummy = Dummy.new
       @dummy.avatar = @file
     end
@@ -725,11 +814,8 @@ class AttachmentTest < Test::Unit::TestCase
   context "Attachment with strange letters" do
     setup do
       rebuild_model
-
-      @file  = StringIO.new(".")
-      @file.stubs(:original_filename).returns("sheep_say_bæ.png\r\n")
-      @file.stubs(:content_type).returns("image/png\r\n")
-
+      @file = File.new(fixture_file("5k.png"), "rb")
+      @file.stubs(:original_filename).returns("sheep_say_bæ.png")
       @dummy = Dummy.new
       @dummy.avatar = @file
     end