paperclip 2.4.5 → 2.5.0

data/lib/paperclip/interpolations.rb

@@ -137,11 +137,11 @@ module Paperclip
       attachment.fingerprint
     end
 
-    # Returns a the attachment hash.  See Paperclip::Attachment#hash for
+    # Returns a the attachment hash.  See Paperclip::Attachment#hash_key for
     # more details.
     def hash attachment=nil, style_name=nil
       if attachment && style_name
-        attachment.hash(style_name)
+        attachment.hash_key(style_name)
       else
         super()
       end
@@ -150,10 +150,13 @@ module Paperclip
     # Returns the id of the instance in a split path form. e.g. returns
     # 000/001/234 for an id of 1234.
     def id_partition attachment, style_name
-      if (id = attachment.instance.id).is_a?(Integer)
+      case id = attachment.instance.id
+      when Integer
         ("%09d" % id).scan(/\d{3}/).join("/")
-      else
+      when String
         id.scan(/.{3}/).first(3).join("/")
+      else
+        nil
       end
     end
 

data/lib/paperclip/matchers.rb

@@ -5,13 +5,15 @@ require 'paperclip/matchers/validate_attachment_size_matcher'
 
 module Paperclip
   module Shoulda
-    # Provides rspec-compatible matchers for testing Paperclip attachments.
+    # Provides RSpec-compatible & Test::Unit-compatible matchers for testing Paperclip attachments.
+    #
+    # *RSpec*
     #
     # In spec_helper.rb, you'll need to require the matchers:
     #
     #   require "paperclip/matchers"
     #
-    # And include the module:
+    # And _include_ the module:
     #
     #   Spec::Runner.configure do |config|
     #     config.include Paperclip::Shoulda::Matchers
@@ -27,6 +29,35 @@ module Paperclip
     #     it { should validate_attachment_size(:avatar).
     #                   less_than(2.megabytes) }
     #   end
+    #
+    #
+    # *TestUnit*
+    #
+    # In test_helper.rb, you'll need to require the matchers as well:
+    #
+    #   require "paperclip/matchers"
+    #
+    # And _extend_ the module:
+    #
+    #   class ActiveSupport::TestCase
+    #     extend Paperclip::Shoulda::Matchers
+    #     
+    #     #...other initializers...#
+    #   end
+    #
+    # Example:
+    #   require 'test_helper'
+    #
+    #   class UserTest < ActiveSupport::TestCase
+    #     should have_attached_file(:avatar)
+    #     should validate_attachment_presence(:avatar)
+    #     should validate_attachment_content_type(:avatar).
+    #                  allowing('image/png', 'image/gif').
+    #                  rejecting('text/plain', 'text/xml')
+    #     should validate_attachment_size(:avatar).
+    #                  less_than(2.megabytes)
+    #   end
+    #  
     module Matchers
     end
   end

data/lib/paperclip/missing_attachment_styles.rb

@@ -70,7 +70,7 @@ module Paperclip
     Hash.new.tap do |missing_styles|
       current_styles.each do |klass, attachment_definitions|
         attachment_definitions.each do |attachment_name, styles|
-          registered = registered_styles[klass][attachment_name] rescue []
+          registered = registered_styles[klass][attachment_name] || [] rescue []
           missed = styles - registered 
           if missed.present?
             klass_sym = klass.to_s.to_sym

data/lib/paperclip/railtie.rb

@@ -1,4 +1,5 @@
 require 'paperclip'
+require 'paperclip/schema'
 
 module Paperclip
   if defined? Rails::Railtie
@@ -21,6 +22,10 @@ module Paperclip
       File.send(:include, Paperclip::Upfile)
 
       Paperclip.options[:logger] = defined?(ActiveRecord) ? ActiveRecord::Base.logger : Rails.logger
+
+      ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:include, Paperclip::Schema)
+      ActiveRecord::ConnectionAdapters::Table.send(:include, Paperclip::Schema)
+      ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, Paperclip::Schema)
     end
   end
 end

data/lib/paperclip/schema.rb

@@ -0,0 +1,39 @@
+module Paperclip
+  # Provides two helpers that can be used in migrations.
+  #
+  # In order to use this module, the target class should implement a
+  # +column+ method that takes the column name and type, both as symbols,
+  # as well as a +remove_column+ method that takes a table and column name,
+  # also both symbols.
+  module Schema
+    @@columns = {:file_name    => :string,
+                 :content_type => :string,
+                 :file_size    => :integer,
+                 :updated_at   => :datetime}
+
+    def has_attached_file(attachment_name)
+      with_columns_for(attachment_name) do |column_name, column_type|
+        column(column_name, column_type)
+      end
+    end
+
+    def drop_attached_file(table_name, attachment_name)
+      with_columns_for(attachment_name) do |column_name, column_type|
+        remove_column(table_name, column_name)
+      end
+    end
+
+    protected
+
+    def with_columns_for(attachment_name)
+      @@columns.each do |suffix, column_type|
+        column_name = full_column_name(attachment_name, suffix)
+        yield column_name, column_type
+      end
+    end
+
+    def full_column_name(attachment_name, column_name)
+      "#{attachment_name}_#{column_name}".to_sym
+    end
+  end
+end

data/lib/paperclip/storage/fog.rb

@@ -41,9 +41,9 @@ module Paperclip
         end unless defined?(Fog)
 
         base.instance_eval do
-          unless @options.url.to_s.match(/^:fog.*url$/)
-            @options.path  = @options.path.gsub(/:url/, @options.url)
-            @options.url   = ':fog_public_url'
+          unless @options[:url].to_s.match(/^:fog.*url$/)
+            @options[:path]  = @options[:path].gsub(/:url/, @options[:url])
+            @options[:url]   = ':fog_public_url'
           end
           Paperclip.interpolates(:fog_public_url) do |attachment, style|
             attachment.public_url(style)
@@ -51,6 +51,8 @@ module Paperclip
         end
       end
 
+      AWS_BUCKET_SUBDOMAIN_RESTRICTON_REGEX = /^(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}$))(?:[a-z0-9]|\.(?![\.\-])|\-(?![\.])){1,61}[a-z0-9]$/
+
       def exists?(style = default_style)
         if original_filename
           !!directory.files.head(path(style))
@@ -60,16 +62,16 @@ module Paperclip
       end
 
       def fog_credentials
-        @fog_credentials ||= parse_credentials(@options.fog_credentials)
+        @fog_credentials ||= parse_credentials(@options[:fog_credentials])
       end
 
       def fog_file
-        @fog_file ||= @options.fog_file || {}
+        @fog_file ||= @options[:fog_file] || {}
       end
 
       def fog_public
         return @fog_public if defined?(@fog_public)
-        @fog_public = defined?(@options.fog_public) ? @options.fog_public : true
+        @fog_public = defined?(@options[:fog_public]) ? @options[:fog_public] : true
       end
 
       def flush_writes
@@ -122,11 +124,20 @@ module Paperclip
       end
 
       def public_url(style = default_style)
-        if @options.fog_host
-          host = (@options.fog_host =~ /%d/) ? @options.fog_host % (path(style).hash % 4) : @options.fog_host
+        if @options[:fog_host]
+          host = (@options[:fog_host] =~ /%d/) ? @options[:fog_host] % (path(style).hash % 4) : @options[:fog_host]
           "#{host}/#{path(style)}"
         else
-          directory.files.new(:key => path(style)).public_url
+          if fog_credentials[:provider] == 'AWS'
+            if @options[:fog_directory].to_s =~ Fog::AWS_BUCKET_SUBDOMAIN_RESTRICTON_REGEX
+              "https://#{@options[:fog_directory]}.s3.amazonaws.com/#{path(style)}"
+            else
+              # directory is not a valid subdomain, so use path style for access
+              "https://s3.amazonaws.com/#{@options[:fog_directory]}/#{path(style)}"
+            end
+          else
+            directory.files.new(:key => path(style)).public_url
+          end
         end
       end
 
@@ -156,7 +167,7 @@ module Paperclip
       end
 
       def directory
-        @directory ||= connection.directories.new(:key => @options.fog_directory)
+        @directory ||= connection.directories.new(:key => @options[:fog_directory])
       end
     end
   end

data/lib/paperclip/storage/s3.rb

@@ -2,6 +2,9 @@ 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
+    #
+    # To use Paperclip with S3, include the +aws-sdk+ gem in your Gemfile:
+    #   gem 'aws-sdk'
     # 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
@@ -38,7 +41,9 @@ module Paperclip
     # * +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}
+    # * +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.
     # * +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.
@@ -67,41 +72,56 @@ module Paperclip
     #   S3 (strictly speaking) does not support directories, you can still use a / to
     #   separate parts of your file name.
     # * +s3_host_name+: If you are using your bucket in Tokyo region etc, write host_name.
+    # * +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.
+    # * +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
+    #   costs by storing non-critical, reproducible data at lower
+    #   levels of redundancy than Amazon S3's standard storage.
     module S3
       def self.extended base
         begin
-          require 'aws/s3'
+          require 'aws-sdk'
         rescue LoadError => e
-          e.message << " (You may need to install the aws-s3 gem)"
+          e.message << " (You may need to install the aws-sdk gem)"
           raise e
-        end unless defined?(AWS::S3)
+        end unless defined?(AWS::Core)
 
         base.instance_eval do
-          @s3_options     = @options.s3_options     || {}
-          @s3_permissions = set_permissions(@options.s3_permissions)
-          @s3_protocol    = @options.s3_protocol    ||
+          @s3_options     = @options[:s3_options]     || {}
+          @s3_permissions = set_permissions(@options[:s3_permissions])
+          @s3_protocol    = @options[:s3_protocol]    ||
             Proc.new do |style, attachment|
               permission  = (@s3_permissions[style.to_sym] || @s3_permissions[:default])
               permission  = permission.call(attachment, style) if permission.is_a?(Proc)
               (permission == :public_read) ? 'http' : 'https'
             end
-          @s3_headers     = @options.s3_headers     || {}
-
-          unless @options.url.to_s.match(/^:s3.*url$/) || @options.url == ":asset_host"
-            @options.path         = @options.path.gsub(/:url/, @options.url).gsub(/^:rails_root\/public\/system/, '')
-            @options.url          = ":s3_path_url"
+          @s3_metadata = @options[:s3_metadata] || {}
+          @s3_headers = @options[:s3_headers] || {}
+          @s3_headers = @s3_headers.call(instance) if @s3_headers.is_a?(Proc)
+          @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
-          @options.url = @options.url.inspect if @options.url.is_a?(Symbol)
 
-          @http_proxy = @options.http_proxy || nil
-          if @http_proxy
-            @s3_options.merge!({:proxy => @http_proxy})
+          @s3_headers[:storage_class] = @options[:s3_storage_class] if @options[:s3_storage_class]
+
+          unless @options[:url].to_s.match(/^:s3.*url$/) || @options[:url] == ":asset_host"
+            @options[:path] = @options[:path].gsub(/:url/, @options[:url]).gsub(/^:rails_root\/public\/system/, '')
+            @options[:url]  = ":s3_path_url"
           end
+          @options[:url] = @options[:url].inspect if @options[:url].is_a?(Symbol)
 
-          AWS::S3::Base.establish_connection!( @s3_options.merge(
-            :access_key_id => s3_credentials[:access_key_id],
-            :secret_access_key => s3_credentials[:secret_access_key]
-          ))
+          @http_proxy = @options[:http_proxy] || nil
         end
         Paperclip.interpolates(:s3_alias_url) do |attachment, style|
           "#{attachment.s3_protocol(style)}://#{attachment.s3_host_alias}/#{attachment.path(style).gsub(%r{^/}, "")}"
@@ -118,27 +138,61 @@ module Paperclip
       end
 
       def expiring_url(time = 3600, style_name = default_style)
-        AWS::S3::S3Object.url_for(path(style_name), bucket_name, :expires_in => time, :use_ssl => (s3_protocol(style_name) == 'https'))
+        if path
+          s3_object(style_name).url_for(:read, :expires => time, :secure => use_secure_protocol?(style_name)).to_s
+        end
       end
 
       def s3_credentials
-        @s3_credentials ||= parse_credentials(@options.s3_credentials)
+        @s3_credentials ||= parse_credentials(@options[:s3_credentials])
       end
 
       def s3_host_name
-        @options.s3_host_name || s3_credentials[:s3_host_name] || "s3.amazonaws.com"
+        @options[:s3_host_name] || s3_credentials[:s3_host_name] || "s3.amazonaws.com"
       end
 
       def s3_host_alias
-        @s3_host_alias = @options.s3_host_alias
+        @s3_host_alias = @options[:s3_host_alias]
         @s3_host_alias = @s3_host_alias.call(self) if @s3_host_alias.is_a?(Proc)
         @s3_host_alias
       end
 
       def bucket_name
-        @bucket = @options.bucket || s3_credentials[:bucket]
+        @bucket = @options[:bucket] || s3_credentials[:bucket]
         @bucket = @bucket.call(self) if @bucket.is_a?(Proc)
-        @bucket
+        @bucket or raise ArgumentError, "missing required :bucket option"
+      end
+
+      def s3_interface
+        @s3_interface ||= begin
+          config = { :s3_endpoint => s3_host_name }
+
+          if using_http_proxy?
+
+            proxy_opts = { :host => http_proxy_host }
+            proxy_opts[:port] = http_proxy_port if http_proxy_port
+            if http_proxy_user
+              userinfo = http_proxy_user.to_s
+              userinfo += ":#{http_proxy_password}" if http_proxy_password
+              proxy_opts[:userinfo] = userinfo
+            end
+            config[:proxy_uri] = URI::HTTP.build(proxy_opts)
+          end
+
+          [:access_key_id, :secret_access_key].each do |opt|
+            config[opt] = s3_credentials[opt] if s3_credentials[opt]
+          end
+
+          AWS::S3.new(config.merge(@s3_options))
+        end
+      end
+
+      def s3_bucket
+        @s3_bucket ||= s3_interface.buckets[bucket_name]
+      end
+
+      def s3_object style_name = default_style
+        s3_bucket.objects[path(style_name).sub(%r{^/},'')]
       end
 
       def using_http_proxy?
@@ -178,7 +232,7 @@ module Paperclip
 
       def exists?(style = default_style)
         if original_filename
-          AWS::S3::S3Object.exists?(path(style), bucket_name)
+          s3_object(style).exists?
         else
           false
         end
@@ -207,30 +261,31 @@ module Paperclip
         basename = File.basename(filename, extname)
         file = Tempfile.new([basename, extname])
         file.binmode
-        file.write(AWS::S3::S3Object.value(path(style), bucket_name))
+        file.write(s3_object(style).read)
         file.rewind
         return file
       end
 
       def create_bucket
-        AWS::S3::Bucket.create(bucket_name)
+        s3_interface.buckets.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 => file.content_type.to_s.strip,
-                                     :access => s3_permissions(style),
-                                    }.merge(@s3_headers))
-          rescue AWS::S3::NoSuchBucket => e
+            acl = @s3_permissions[style] || @s3_permissions[:default]
+            acl = acl.call(self, style) if acl.respond_to?(:call)
+            write_options = {
+              :content_type => file.content_type.to_s.strip,
+              :acl => acl
+            }
+            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
             retry
-          rescue AWS::S3::ResponseError => e
-            raise
           end
         end
 
@@ -243,8 +298,8 @@ module Paperclip
         @queued_for_delete.each do |path|
           begin
             log("deleting #{path}")
-            AWS::S3::S3Object.delete(path, bucket_name)
-          rescue AWS::S3::ResponseError
+            s3_bucket.objects[path.sub(%r{^/},'')].delete
+          rescue AWS::Errors::Base => e
             # Ignore this.
           end
         end
@@ -265,6 +320,18 @@ module Paperclip
       end
       private :find_credentials
 
+      def establish_connection!
+        @connection ||= 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
+      private :establish_connection!
+
+      def use_secure_protocol?(style_name)
+        s3_protocol(style_name) == "https"
+      end
+      private :use_secure_protocol?
     end
   end
 end