paperclip 4.2.2 → 5.0.0

data/lib/paperclip/storage/fog.rb

@@ -33,6 +33,10 @@ module Paperclip
     #   that is the alias to the S3 domain of your bucket, e.g.
     #   'http://images.example.com'. This can also be used in
     #   conjunction with Cloudfront (http://aws.amazon.com/cloudfront)
+    # * +fog_options+: (optional) A hash of options that are passed
+    #   to fog when the file is created. For example, you could set
+    #   the multipart-chunk size to 100MB with a hash:
+    #     { :multipart_chunk_size => 104857600 }
 
     module Fog
       def self.extended base
@@ -98,12 +102,14 @@ module Paperclip
           log("saving #{path(style)}")
           retried = false
           begin
-            directory.files.create(fog_file.merge(
+            attributes = fog_file.merge(
               :body         => file,
               :key          => path(style),
               :public       => fog_public(style),
               :content_type => file.content_type
-            ))
+            )
+            attributes.merge!(@options[:fog_options]) if @options[:fog_options]
+            directory.files.create(attributes)
           rescue Excon::Errors::NotFound
             raise if retried
             retried = true
@@ -141,8 +147,9 @@ module Paperclip
 
       def expiring_url(time = (Time.now + 3600), style_name = default_style)
         time = convert_time(time)
-        if path(style_name) && directory.files.respond_to?(:get_http_url)
-          expiring_url = directory.files.get_http_url(path(style_name), time)
+        http_url_method = "get_#{scheme}_url"
+        if path(style_name) && directory.files.respond_to?(http_url_method)
+          expiring_url = directory.files.public_send(http_url_method, path(style_name), time)
 
           if @options[:fog_host]
             expiring_url.gsub!(/#{host_name_for_directory}/, dynamic_fog_host_for_style(style_name))
@@ -156,14 +163,14 @@ module Paperclip
 
       def parse_credentials(creds)
         creds = find_credentials(creds).stringify_keys
-        env = Object.const_defined?(:Rails) ? Rails.env : nil
-        (creds[env] || creds).symbolize_keys
+        (creds[RailsEnvironment.get] || creds).symbolize_keys
       end
 
       def copy_to_local_file(style, local_dest_path)
         log("copying #{path(style)} to local file #{local_dest_path}")
         ::File.open(local_dest_path, 'wb') do |local_file|
           file = directory.files.get(path(style))
+          return false unless file
           local_file.write(file.body)
         end
       rescue ::Fog::Errors::Error => e
@@ -189,10 +196,10 @@ module Paperclip
       end
 
       def host_name_for_directory
-        if @options[:fog_directory].to_s =~ Fog::AWS_BUCKET_SUBDOMAIN_RESTRICTON_REGEX
-          "#{@options[:fog_directory]}.s3.amazonaws.com"
+        if directory_name.to_s =~ Fog::AWS_BUCKET_SUBDOMAIN_RESTRICTON_REGEX
+          "#{directory_name}.s3.amazonaws.com"
         else
-          "s3.amazonaws.com/#{@options[:fog_directory]}"
+          "s3.amazonaws.com/#{directory_name}"
         end
       end
 
@@ -218,13 +225,15 @@ module Paperclip
       end
 
       def directory
-        dir = if @options[:fog_directory].respond_to?(:call)
+        @directory ||= connection.directories.new(key: directory_name)
+      end
+
+      def directory_name
+        if @options[:fog_directory].respond_to?(:call)
           @options[:fog_directory].call(self)
         else
           @options[:fog_directory]
         end
-
-        @directory ||= connection.directories.new(:key => dir)
       end
 
       def scheme

data/lib/paperclip/storage/s3.rb

@@ -41,7 +41,7 @@ module Paperclip
     # * +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.aws.amazon.com/AmazonS3/latest/dev/ACLOverview.html)
-    #   The default for Paperclip is :public_read.
+    #   The default for Paperclip is public-read.
     #
     #   You can set permission on a per style bases by doing the following:
     #     :s3_permissions => {
@@ -61,7 +61,7 @@ module Paperclip
     # * +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.
+    #   You can define the bucket as a Proc if you want to determine its 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
@@ -93,6 +93,7 @@ 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_region+: For aws-sdk v2, s3_region is required.
     # * +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
@@ -117,21 +118,10 @@ module Paperclip
         rescue LoadError => e
           e.message << " (You may need to install the aws-sdk gem)"
           raise e
-        end unless defined?(AWS::Core)
-
-        # Overriding log formatter to make sure it return a UTF-8 string
-        if defined?(AWS::Core::LogFormatter)
-          AWS::Core::LogFormatter.class_eval do
-            def summarize_hash(hash)
-              hash.map { |key, value| ":#{key}=>#{summarize_value(value)}".force_encoding('UTF-8') }.sort.join(',')
-            end
-          end
-        elsif defined?(AWS::Core::ClientLogging)
-          AWS::Core::ClientLogging.class_eval do
-            def sanitize_hash(hash)
-              hash.map { |key, value| "#{sanitize_value(key)}=>#{sanitize_value(value)}".force_encoding('UTF-8') }.sort.join(',')
-            end
-          end
+        end
+        if Gem::Version.new(Aws::VERSION) >= Gem::Version.new(2) &&
+           Gem::Version.new(Aws::VERSION) <= Gem::Version.new("2.0.33")
+          raise LoadError, "paperclip does not support aws-sdk versions 2.0.0 - 2.0.33.  Please upgrade aws-sdk to a newer version."
         end
 
         base.instance_eval do
@@ -141,7 +131,7 @@ module Paperclip
             Proc.new do |style, attachment|
               permission  = (@s3_permissions[style.to_s.to_sym] || @s3_permissions[:default])
               permission  = permission.call(attachment, style) if permission.respond_to?(:call)
-              (permission == :public_read) ? 'http' : 'https'
+              (permission == :"public-read") ? 'http'.freeze : 'https'.freeze
             end
           @s3_metadata = @options[:s3_metadata] || {}
           @s3_headers = {}
@@ -149,7 +139,7 @@ module Paperclip
 
           @s3_storage_class = set_storage_class(@options[:s3_storage_class])
 
-          @s3_server_side_encryption = :aes256
+          @s3_server_side_encryption = "AES256"
           if @options[:s3_server_side_encryption].blank?
             @s3_server_side_encryption = false
           end
@@ -157,9 +147,9 @@ module Paperclip
             @s3_server_side_encryption = @options[:s3_server_side_encryption]
           end
 
-          unless @options[:url].to_s.match(/\A:s3.*url\Z/) || @options[:url] == ":asset_host"
-            @options[:path] = path_option.gsub(/:url/, @options[:url]).gsub(/\A:rails_root\/public\/system/, '')
-            @options[:url]  = ":s3_path_url"
+          unless @options[:url].to_s.match(/\A:s3.*url\Z/) || @options[:url] == ":asset_host".freeze
+            @options[:path] = path_option.gsub(/:url/, @options[:url]).sub(/\A:rails_root\/public\/system/, "".freeze)
+            @options[:url]  = ":s3_path_url".freeze
           end
           @options[:url] = @options[:url].inspect if @options[:url].is_a?(Symbol)
 
@@ -167,23 +157,26 @@ module Paperclip
         end
 
         Paperclip.interpolates(:s3_alias_url) do |attachment, style|
-          "#{attachment.s3_protocol(style, true)}//#{attachment.s3_host_alias}/#{attachment.path(style).gsub(%r{\A/}, "")}"
+          "#{attachment.s3_protocol(style, true)}//#{attachment.s3_host_alias}/#{attachment.path(style).sub(%r{\A/}, "".freeze)}"
         end unless Paperclip::Interpolations.respond_to? :s3_alias_url
         Paperclip.interpolates(:s3_path_url) do |attachment, style|
-          "#{attachment.s3_protocol(style, true)}//#{attachment.s3_host_name}/#{attachment.bucket_name}/#{attachment.path(style).gsub(%r{\A/}, "")}"
+          "#{attachment.s3_protocol(style, true)}//#{attachment.s3_host_name}/#{attachment.bucket_name}/#{attachment.path(style).sub(%r{\A/}, "".freeze)}"
         end unless Paperclip::Interpolations.respond_to? :s3_path_url
         Paperclip.interpolates(:s3_domain_url) do |attachment, style|
-          "#{attachment.s3_protocol(style, true)}//#{attachment.bucket_name}.#{attachment.s3_host_name}/#{attachment.path(style).gsub(%r{\A/}, "")}"
+          "#{attachment.s3_protocol(style, true)}//#{attachment.bucket_name}.#{attachment.s3_host_name}/#{attachment.path(style).sub(%r{\A/}, "".freeze)}"
         end unless Paperclip::Interpolations.respond_to? :s3_domain_url
         Paperclip.interpolates(:asset_host) do |attachment, style|
-          "#{attachment.path(style).gsub(%r{\A/}, "")}"
+          "#{attachment.path(style).sub(%r{\A/}, "".freeze)}"
         end unless Paperclip::Interpolations.respond_to? :asset_host
       end
 
       def expiring_url(time = 3600, style_name = default_style)
         if path(style_name)
-          base_options = { :expires => time, :secure => use_secure_protocol?(style_name) }
-          s3_object(style_name).url_for(:read, base_options.merge(s3_url_options)).to_s
+          base_options = { expires_in: time }
+          s3_object(style_name).presigned_url(
+            :get,
+            base_options.merge(s3_url_options),
+          ).to_s
         else
           url(style_name)
         end
@@ -197,7 +190,14 @@ module Paperclip
         host_name = @options[:s3_host_name]
         host_name = host_name.call(self) if host_name.is_a?(Proc)
 
-        host_name || s3_credentials[:s3_host_name] || "s3.amazonaws.com"
+        host_name || s3_credentials[:s3_host_name] || "s3.amazonaws.com".freeze
+      end
+
+      def s3_region
+        region = @options[:s3_region]
+        region = region.call(self) if region.is_a?(Proc)
+
+        region || s3_credentials[:s3_region]
       end
 
       def s3_host_alias
@@ -220,7 +220,7 @@ module Paperclip
 
       def s3_interface
         @s3_interface ||= begin
-          config = { :s3_endpoint => s3_host_name }
+          config = { region: s3_region }
 
           if using_http_proxy?
 
@@ -234,7 +234,7 @@ module Paperclip
             config[:proxy_uri] = URI::HTTP.build(proxy_opts)
           end
 
-          [:access_key_id, :secret_access_key, :credential_provider].each do |opt|
+          [:access_key_id, :secret_access_key, :credential_provider, :credentials].each do |opt|
             config[opt] = s3_credentials[opt] if s3_credentials[opt]
           end
 
@@ -244,15 +244,19 @@ module Paperclip
 
       def obtain_s3_instance_for(options)
         instances = (Thread.current[:paperclip_s3_instances] ||= {})
-        instances[options] ||= AWS::S3.new(options)
+        instances[options] ||= ::Aws::S3::Resource.new(options)
       end
 
       def s3_bucket
-        @s3_bucket ||= s3_interface.buckets[bucket_name]
+        @s3_bucket ||= s3_interface.bucket(bucket_name)
+      end
+
+      def style_name_as_path(style_name)
+        path(style_name).sub(%r{\A/},'')
       end
 
       def s3_object style_name = default_style
-        s3_bucket.objects[path(style_name).sub(%r{\A/},'')]
+        s3_bucket.object style_name_as_path(style_name)
       end
 
       def using_http_proxy?
@@ -277,7 +281,7 @@ module Paperclip
 
       def set_permissions permissions
         permissions = { :default => permissions } unless permissions.respond_to?(:merge)
-        permissions.merge :default => (permissions[:default] || :public_read)
+        permissions.merge :default => (permissions[:default] || :"public-read")
       end
 
       def set_storage_class(storage_class)
@@ -286,10 +290,9 @@ module Paperclip
       end
 
       def parse_credentials creds
-        creds = creds.respond_to?('call') ? creds.call(self) : creds
+        creds = creds.respond_to?(:call) ? creds.call(self) : creds
         creds = find_credentials(creds).stringify_keys
-        env = Object.const_defined?(:Rails) ? Rails.env : nil
-        (creds[env] || creds).symbolize_keys
+        (creds[RailsEnvironment.get] || creds).symbolize_keys
       end
 
       def exists?(style = default_style)
@@ -298,7 +301,7 @@ module Paperclip
         else
           false
         end
-      rescue AWS::Errors::Base => e
+      rescue Aws::Errors::ServiceError => e
         false
       end
 
@@ -324,7 +327,7 @@ module Paperclip
       end
 
       def create_bucket
-        s3_interface.buckets.create(bucket_name)
+        s3_interface.bucket(bucket_name).create
       end
 
       def flush_writes #:nodoc:
@@ -332,11 +335,9 @@ module Paperclip
         retries = 0
           begin
             log("saving #{path(style)}")
-            acl = @s3_permissions[style] || @s3_permissions[:default]
-            acl = acl.call(self, style) if acl.respond_to?(:call)
             write_options = {
               :content_type => file.content_type,
-              :acl => acl
+              :acl => s3_permissions(style)
             }
 
             # add storage class for this style if defined
@@ -357,11 +358,11 @@ module Paperclip
             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
+            s3_object(style).upload_file(file.path, write_options)
+          rescue ::Aws::S3::Errors::NoSuchBucket
             create_bucket
             retry
-          rescue AWS::S3::Errors::SlowDown
+          rescue ::Aws::S3::Errors::SlowDown
             retries += 1
             if retries <= 5
               sleep((2 ** retries) * 0.5)
@@ -383,8 +384,8 @@ module Paperclip
         @queued_for_delete.each do |path|
           begin
             log("deleting #{path}")
-            s3_bucket.objects[path.sub(%r{\A/},'')].delete
-          rescue AWS::Errors::Base => e
+            s3_bucket.object(path.sub(%r{\A/}, "")).delete
+          rescue Aws::Errors::ServiceError => e
             # Ignore this.
           end
         end
@@ -394,11 +395,11 @@ module Paperclip
       def copy_to_local_file(style, local_dest_path)
         log("copying #{path(style)} to local file #{local_dest_path}")
         ::File.open(local_dest_path, 'wb') do |local_file|
-          s3_object(style).read do |chunk|
+          s3_object(style).get do |chunk|
             local_file.write(chunk)
           end
         end
-      rescue AWS::Errors::Base => e
+      rescue Aws::Errors::ServiceError => e
         warn("#{e} - cannot copy #{path(style)} to local file #{local_dest_path}")
         false
       end

data/lib/paperclip/thumbnail.rb

@@ -29,7 +29,6 @@ module Paperclip
       super
 
       geometry             = options[:geometry].to_s
-      @file                = file
       @crop                = geometry[-1,1] == '#'
       @target_geometry     = options.fetch(:string_geometry_parser, Geometry).parse(geometry)
       @current_geometry    = options.fetch(:file_geometry_parser, Geometry).from_file(@file)
@@ -64,8 +63,8 @@ module Paperclip
     # that contains the new image.
     def make
       src = @file
-      dst = Tempfile.new([@basename, @format ? ".#{@format}" : ''])
-      dst.binmode
+      filename = [@basename, @format ? ".#{@format}" : ""].join
+      dst = TempfileFactory.new.generate(filename)
 
       begin
         parameters = []

data/lib/paperclip/validators/attachment_size_validator.rb

@@ -71,13 +71,7 @@ module Paperclip
       end
 
       def human_size(size)
-        if defined?(ActiveSupport::NumberHelper) # Rails 4.0+
-          ActiveSupport::NumberHelper.number_to_human_size(size)
-        else
-          storage_units_format = I18n.translate(:'number.human.storage_units.format', :locale => options[:locale], :raise => true)
-          unit = I18n.translate(:'number.human.storage_units.units.byte', :locale => options[:locale], :count => size.to_i, :raise => true)
-          storage_units_format.gsub(/%n/, size.to_i.to_s).gsub(/%u/, unit).html_safe
-        end
+        ActiveSupport::NumberHelper.number_to_human_size(size)
       end
 
       def min_value_in_human_size(record)

data/lib/paperclip/version.rb

@@ -1,3 +1,5 @@
 module Paperclip
-  VERSION = "4.2.2" unless defined? Paperclip::VERSION
+  unless defined?(Paperclip::VERSION)
+    VERSION = "5.0.0".freeze
+  end
 end

data/lib/paperclip.rb

@@ -55,11 +55,21 @@ require 'paperclip/helpers'
 require 'paperclip/has_attached_file'
 require 'paperclip/attachment_registry'
 require 'paperclip/filename_cleaner'
-require 'mime/types'
+require 'paperclip/rails_environment'
+
+begin
+  # Use mime/types/columnar if available, for reduced memory usage
+  require "mime/types/columnar"
+rescue LoadError
+  require "mime/types"
+end
+
+require 'mimemagic'
+require 'mimemagic/overlay'
 require 'logger'
 require 'cocaine'
 
-require 'paperclip/railtie' if defined?(Rails)
+require 'paperclip/railtie' if defined?(Rails::Railtie)
 
 # The base module that gets included in ActiveRecord::Base. See the
 # documentation for Paperclip::ClassMethods for more useful information.
@@ -87,7 +97,8 @@ module Paperclip
       :log_command => true,
       :swallow_stderr => true,
       :content_type_mappings => {},
-      :use_exif_orientation => true
+      :use_exif_orientation => true,
+      :read_timeout => nil
     }
   end
 
@@ -136,7 +147,7 @@ module Paperclip
     #     user.avatar.url # => "/avatars/23/normal_me.png"
     # * +keep_old_files+: Keep the existing attachment files (original + resized) from
     #   being automatically deleted when an attachment is cleared or updated. Defaults to +false+.
-    # * +preserve_files+: Keep the existing attachment files in all cases, even if the parent 
+    # * +preserve_files+: Keep the existing attachment files in all cases, even if the parent
     #   record is destroyed. Defaults to +false+.
     # * +whiny+: Will raise an error if Paperclip cannot post_process an uploaded file due
     #   to a command line error. This will override the global setting for this attachment.

data/lib/tasks/paperclip.rake

@@ -18,7 +18,7 @@ module Paperclip
         raise "Class #{klass.name} has no attachments specified"
       end
 
-      if !name.blank? && attachment_names.map(&:to_s).include?(name.to_s)
+      if name.present? && attachment_names.map(&:to_s).include?(name.to_s)
         [ name ]
       else
         attachment_names
@@ -108,4 +108,20 @@ namespace :paperclip do
       end
     end
   end
+
+ desc "find missing attachments. Useful to know which attachments are broken"
+  task :find_broken_attachments => :environment do
+    klass = Paperclip::Task.obtain_class
+    names = Paperclip::Task.obtain_attachments(klass)
+    names.each do |name|
+      Paperclip.each_instance_with_attachment(klass, name) do |instance|
+        attachment = instance.send(name)
+        if attachment.exists?
+          print "."
+        else
+          Paperclip::Task.log_error("#{instance.class}##{attachment.name}, #{instance.id}, #{attachment.url}")
+        end
+      end
+    end
+  end
 end

data/paperclip.gemspec

@@ -12,40 +12,43 @@ Gem::Specification.new do |s|
   s.description       = "Easy upload management for ActiveRecord"
   s.license           = "MIT"
 
-  s.rubyforge_project = "paperclip"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  if File.exist?('UPGRADING')
+    s.post_install_message = File.read("UPGRADING")
+  end
+
   s.requirements << "ImageMagick"
-  s.required_ruby_version = ">= 1.9.2"
+  s.required_ruby_version = ">= 2.1.0"
 
-  s.add_dependency('activemodel', '>= 3.0.0')
-  s.add_dependency('activesupport', '>= 3.0.0')
-  s.add_dependency('cocaine', '~> 0.5.3')
+  s.add_dependency('activemodel', '>= 4.2.0')
+  s.add_dependency('activesupport', '>= 4.2.0')
+  s.add_dependency('cocaine', '~> 0.5.5')
   s.add_dependency('mime-types')
+  s.add_dependency('mimemagic', '~> 0.3.0')
 
-  s.add_development_dependency('activerecord', '>= 3.0.0')
+  s.add_development_dependency('activerecord', '>= 4.2.0')
   s.add_development_dependency('shoulda')
-  s.add_development_dependency('rspec')
+  s.add_development_dependency('rspec', '~> 3.0')
   s.add_development_dependency('appraisal')
   s.add_development_dependency('mocha')
-  s.add_development_dependency('aws-sdk', '>= 1.5.7')
+  s.add_development_dependency('aws-sdk', '>= 2.0.34', '< 3.0')
   s.add_development_dependency('bourne')
-  s.add_development_dependency('cucumber', '~> 1.3.11')
-  s.add_development_dependency('aruba')
+  s.add_development_dependency('cucumber', '~> 1.3.18')
+  s.add_development_dependency('aruba', '~> 0.9.0')
   s.add_development_dependency('nokogiri')
-  # Ruby version < 1.9.3 can't install capybara > 2.0.3.
-  s.add_development_dependency('capybara', '= 2.0.3')
+  s.add_development_dependency('capybara')
   s.add_development_dependency('bundler')
-  s.add_development_dependency('fog', '~> 1.0')
+  s.add_development_dependency('fog-aws')
+  s.add_development_dependency('fog-local')
   s.add_development_dependency('launchy')
   s.add_development_dependency('rake')
   s.add_development_dependency('fakeweb')
   s.add_development_dependency('railties')
-  s.add_development_dependency('actionmailer', '>= 3.0.0')
+  s.add_development_dependency('actionmailer', '>= 4.2.0')
   s.add_development_dependency('generator_spec')
   s.add_development_dependency('timecop')
 end

data/spec/paperclip/attachment_definitions_spec.rb

@@ -8,6 +8,6 @@ describe "Attachment Definitions" do
     Dummy.do_not_validate_attachment_file_type :avatar
     expected = {avatar: {path: "abc"}, other_attachment: {url: "123"}}
 
-    assert_equal expected, Dummy.attachment_definitions
+    expect(Dummy.attachment_definitions).to eq expected
   end
 end

data/spec/paperclip/attachment_processing_spec.rb

@@ -2,11 +2,9 @@
 require 'spec_helper'
 
 describe 'Attachment Processing' do
-  context 'using validates_attachment_content_type' do
-    before do
-      rebuild_class
-    end
+  before { rebuild_class }
 
+  context 'using validates_attachment_content_type' do
     it 'processes attachments given a valid assignment' do
       file = File.new(fixture_file("5k.png"))
       Dummy.validates_attachment_content_type :avatar, content_type: "image/png"