paperclip 4.3.7 → 5.0.0.beta1

data/UPGRADING

@@ -1,14 +1,14 @@
 ##################################################
-#  NOTE FOR UPGRADING FROM PRE-3.0 VERSION       #
+#  NOTE FOR UPGRADING FROM 4.3.0 OR EARLIER       #
 ##################################################
 
-Paperclip 3.0 introduces a non-backward compatible change in your attachment
-path. This will help to prevent attachment name clashes when you have
-multiple attachments with the same name. If you didn't alter your
-attachment's path and are using Paperclip's default, you'll have to add
-`:path` and `:url` to your `has_attached_file` definition. For example:
+Paperclip is now compatible with aws-sdk >= 2.0.0.
 
-    has_attached_file :avatar,
-      :path => ":rails_root/public/system/:attachment/:id/:style/:filename",
-      :url => "/system/:attachment/:id/:style/:filename"
+If you are using S3 storage, aws-sdk >= 2.0.0 requires you to make a few small
+changes:
 
+* You must set the `s3_region`
+* If you are explicitly setting permissions anywhere, such as in an initializer,
+  note that the format of the permissions changed from using an underscore to
+  using a hyphen. For example, `:public_read` needs to be changed to
+  `public-read`.

data/features/basic_integration.feature

@@ -69,6 +69,7 @@ Feature: Rails integration
       bucket: paperclip
       access_key_id: access_key
       secret_access_key: secret_key
+      s3_region: us-west-2
       """
     And I start the rails application
     When I go to the new user page

data/features/step_definitions/s3_steps.rb

@@ -1,11 +1,15 @@
 When /^I attach the file "([^"]*)" to "([^"]*)" on S3$/ do |file_path, field|
   definition = Paperclip::AttachmentRegistry.definitions_for(User)[field.downcase.to_sym]
-  path = "https://paperclip.s3.amazonaws.com#{definition[:path]}"
+  path = if defined?(::AWS)
+    "https://paperclip.s3.amazonaws.com#{definition[:path]}"
+  else
+    "https://paperclip.s3-us-west-2.amazonaws.com#{definition[:path]}"
+  end
   path.gsub!(':filename', File.basename(file_path))
   path.gsub!(/:([^\/\.]+)/) do |match|
     "([^\/\.]+)"
   end
-  FakeWeb.register_uri(:put, Regexp.new(path), :body => "OK")
+  FakeWeb.register_uri(:put, Regexp.new(path), :body => defined?(::AWS) ? "OK" : "<xml></xml>")
   step "I attach the file \"#{file_path}\" to \"#{field}\""
 end
 

data/gemfiles/{4.1.gemfile → 4.2.awsv2.0.gemfile}

@@ -3,15 +3,13 @@
 source "https://rubygems.org"
 
 gem "sqlite3", "~> 1.3.8", :platforms => :ruby
-gem "jruby-openssl", :platforms => :jruby
-gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
-gem "rubysl", :platforms => :rbx
-gem "racc", :platforms => :rbx
 gem "pry"
-gem "rails", "~> 4.1.0"
+gem "rails", "~> 4.2.0"
+gem "aws-sdk", "~> 2.0.0"
 
 group :development, :test do
-  gem "mime-types", "~> 1.16"
+  gem "activerecord-import"
+  gem "mime-types"
   gem "builder"
   gem "rubocop", :require => false
 end

data/gemfiles/4.2.awsv2.1.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.8", :platforms => :ruby
+gem "pry"
+gem "rails", "~> 4.2.0"
+gem "aws-sdk", "~> 2.1.0"
+
+group :development, :test do
+  gem "activerecord-import"
+  gem "mime-types", ">= 1.16", "< 4"
+  gem "builder"
+  gem "rubocop", :require => false
+end
+
+gemspec :path => "../"

data/gemfiles/{4.2.gemfile → 4.2.awsv2.gemfile}

@@ -9,6 +9,7 @@ gem "rubysl", :platforms => :rbx
 gem "racc", :platforms => :rbx
 gem "pry"
 gem "rails", "~> 4.2.0"
+gem "aws-sdk", "~> 2.0"
 
 group :development, :test do
   gem "mime-types", "~> 1.16"

data/gemfiles/5.0.awsv2.0.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.8", :platforms => :ruby
+gem "pry"
+gem "rails", "5.0.0.beta3"
+gem "aws-sdk", "~> 2.0.0"
+
+group :development, :test do
+  gem "activerecord-import"
+  gem "mime-types", ">= 1.16", "< 4"
+  gem "builder"
+  gem "rubocop", :require => false
+end
+
+gemspec :path => "../"

data/gemfiles/5.0.awsv2.1.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", "~> 1.3.8", :platforms => :ruby
+gem "pry"
+gem "rails", "5.0.0.beta3"
+gem "aws-sdk", "~> 2.1.0"
+
+group :development, :test do
+  gem "activerecord-import"
+  gem "mime-types"
+  gem "builder"
+  gem "rubocop", :require => false
+end
+
+gemspec :path => "../"

data/gemfiles/{3.2.gemfile → 5.0.awsv2.gemfile}

@@ -8,7 +8,13 @@ gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
 gem "rubysl", :platforms => :rbx
 gem "racc", :platforms => :rbx
 gem "pry"
-gem "rails", "~> 3.2.0"
+gem "rails", :github => "rails/rails"
+gem "sprockets-rails", :github => "rails/sprockets-rails"
+gem "sprockets", :github => "rails/sprockets"
+gem "sass-rails", :github => "rails/sass-rails"
+gem "arel", :github => "rails/arel"
+gem "rack", :github => "rack/rack"
+gem "aws-sdk", "~> 2.0"
 
 group :development, :test do
   gem "mime-types", "~> 1.16"

data/lib/paperclip.rb

@@ -56,7 +56,6 @@ require 'paperclip/has_attached_file'
 require 'paperclip/attachment_registry'
 require 'paperclip/filename_cleaner'
 require 'paperclip/rails_environment'
-require "paperclip/deprecations"
 
 begin
   # Use mime/types/columnar if available, for reduced memory usage
@@ -192,7 +191,6 @@ module Paperclip
     #     end
     #   end
     def has_attached_file(name, options = {})
-      Paperclip::Deprecations.check
       HasAttachedFile.define_on(self, name, options)
     end
   end

data/lib/paperclip/attachment.rb

@@ -2,6 +2,7 @@
 require 'uri'
 require 'paperclip/url_generator'
 require 'active_support/deprecation'
+require 'active_support/core_ext/string/inflections'
 
 module Paperclip
   # The Attachment class manages the files for a given attachment. It saves
@@ -322,7 +323,7 @@ module Paperclip
       OpenSSL::HMAC.hexdigest(OpenSSL::Digest.const_get(@options[:hash_digest]).new, @options[:hash_secret], data)
     end
 
-    # This method really shouldn't be called that often. It's expected use is
+    # This method really shouldn't be called that often. Its expected use is
     # in the paperclip:refresh rake task and that's it. It will regenerate all
     # thumbnails forcefully, by reobtaining the original file and going through
     # the post-process again.
@@ -426,7 +427,7 @@ module Paperclip
     def assign_attributes
       @queued_for_write[:original] = @file
       assign_file_information
-      assign_fingerprint(@file.fingerprint)
+      assign_fingerprint { @file.fingerprint }
       assign_timestamps
     end
 
@@ -436,9 +437,9 @@ module Paperclip
       instance_write(:file_size, @file.size)
     end
 
-    def assign_fingerprint(fingerprint)
+    def assign_fingerprint
       if instance_respond_to?(:fingerprint)
-        instance_write(:fingerprint, fingerprint)
+        instance_write(:fingerprint, yield)
       end
     end
 
@@ -464,7 +465,7 @@ module Paperclip
 
     def reset_file_if_original_reprocessed
       instance_write(:file_size, @queued_for_write[:original].size)
-      assign_fingerprint(@queued_for_write[:original].fingerprint)
+      assign_fingerprint { @queued_for_write[:original].fingerprint }
       reset_updater
     end
 
@@ -500,7 +501,7 @@ module Paperclip
 
       instance.run_paperclip_callbacks(:post_process) do
         instance.run_paperclip_callbacks(:"#{name}_post_process") do
-          unless @options[:check_validity_before_processing] && instance.errors.any?
+          if !@options[:check_validity_before_processing] || !instance.errors.any?
             post_process_styles(*style_args)
           end
         end
@@ -521,7 +522,7 @@ module Paperclip
 
         @queued_for_write[name] = style.processors.inject(@queued_for_write[:original]) do |file, processor|
           file = Paperclip.processor(processor).make(file, style.processor_options, self)
-          intermediate_files << file
+          intermediate_files << file unless file == @queued_for_write[:original]
           file
         end
 
@@ -586,7 +587,7 @@ module Paperclip
 
     # You can either specifiy :restricted_characters or you can define your own
     # :filename_cleaner object. This object needs to respond to #call and takes
-    # the filename that will be cleaned. It should return the cleaned filenme.
+    # the filename that will be cleaned. It should return the cleaned filename.
     def filename_cleaner
       @options[:filename_cleaner] || FilenameCleaner.new(@options[:restricted_characters])
     end

data/lib/paperclip/attachment_registry.rb

@@ -51,7 +51,8 @@ module Paperclip
     end
 
     def definitions_for(klass)
-      klass.ancestors.each_with_object({}) do |ancestor, inherited_definitions|
+      parent_classes = klass.ancestors.reverse
+      parent_classes.each_with_object({}) do |ancestor, inherited_definitions|
         inherited_definitions.deep_merge! @attachments[ancestor]
       end
     end

data/lib/paperclip/callbacks.rb

@@ -7,7 +7,7 @@ module Paperclip
 
     module Defining
       def define_paperclip_callbacks(*callbacks)
-        define_callbacks(*[callbacks, {:terminator => callback_terminator}].flatten)
+        define_callbacks(*[callbacks, { terminator: hasta_la_vista_baby }].flatten)
         callbacks.each do |callback|
           eval <<-end_callbacks
             def before_#{callback}(*args, &blk)
@@ -22,11 +22,13 @@ module Paperclip
 
       private
 
-      def callback_terminator
-        if ::ActiveSupport::VERSION::STRING >= '4.1'
-          lambda { |target, result| result == false }
-        else
-          'result == false'
+      def hasta_la_vista_baby
+        lambda do |_, result|
+          if result.respond_to?(:call)
+            result.call == false
+          else
+            result == false
+          end
         end
       end
     end

data/lib/paperclip/glue.rb

@@ -8,7 +8,7 @@ module Paperclip
       base.extend ClassMethods
       base.send :include, Callbacks
       base.send :include, Validators
-      base.send :include, Schema if defined? ActiveRecord
+      base.send :include, Schema if defined? ActiveRecord::Base
 
       locale_path = Dir.glob(File.dirname(__FILE__) + "/locales/*.{rb,yml}")
       I18n.load_path += locale_path unless I18n.load_path.include?(locale_path)

data/lib/paperclip/has_attached_file.rb

@@ -91,7 +91,13 @@ module Paperclip
       name = @name
       @klass.send(:after_save) { send(name).send(:save) }
       @klass.send(:before_destroy) { send(name).send(:queue_all_for_delete) }
-      @klass.send(:after_commit, :on => :destroy) { send(name).send(:flush_deletes) }
+      if @klass.respond_to?(:after_commit)
+        @klass.send(:after_commit, on: :destroy) do
+          send(name).send(:flush_deletes)
+        end
+      else
+        @klass.send(:after_destroy) { send(name).send(:flush_deletes) }
+      end
     end
 
     def add_paperclip_callbacks

data/lib/paperclip/io_adapters/uri_adapter.rb

@@ -2,8 +2,6 @@ require 'open-uri'
 
 module Paperclip
   class UriAdapter < AbstractAdapter
-    attr_writer :content_type
-
     def initialize(target)
       @target = target
       @content = download_content
@@ -11,40 +9,23 @@ module Paperclip
       @tempfile = copy_to_tempfile(@content)
     end
 
-    private
-
-    def cache_current_values
-      self.content_type = content_type_from_content || "text/html"
-
-      self.original_filename = filename_from_content_disposition ||
-                               filename_from_path ||
-                               default_filename
-      @size = @content.size
-    end
+    attr_writer :content_type
 
-    def content_type_from_content
-      if @content.respond_to?(:content_type)
-        @content.content_type
-      end
-    end
+    private
 
-    def filename_from_content_disposition
-      if @content.meta.has_key?("content-disposition")
-        @content.meta["content-disposition"].
-          match(/filename="([^"]*)"/)[1]
-      end
+    def download_content
+      open(@target)
     end
 
-    def filename_from_path
-      @target.path.split("/").last
-    end
+    def cache_current_values
+      @original_filename = @target.path.split("/").last
+      @original_filename ||= "index.html"
+      self.original_filename = @original_filename.strip
 
-    def default_filename
-      "index.html"
-    end
+      @content_type = @content.content_type if @content.respond_to?(:content_type)
+      @content_type ||= "text/html"
 
-    def download_content
-      open(@target)
+      @size = @content.size
     end
 
     def copy_to_tempfile(src)

data/lib/paperclip/schema.rb

@@ -38,8 +38,7 @@ module Paperclip
         options = attachment_names.extract_options!
 
         attachment_names.each do |attachment_name|
-          COLUMNS.each_pair do |column_name, column_type|
-            column_options = options.merge(options[column_name.to_sym] || {})
+          COLUMNS.keys.each do |column_name|
             remove_column(table_name, "#{attachment_name}_#{column_name}")
           end
         end

data/lib/paperclip/storage/s3.rb

@@ -4,7 +4,7 @@ module Paperclip
     # 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', '~> 1.6'
+    #   gem 'aws-sdk'
     # There are a few S3-specific options for has_attached_file:
     # * +s3_credentials+: Takes a path, a File, a Hash or a Proc. The path (or File) must point
     #   to a YAML file containing the +access_key_id+ and +secret_access_key+ that Amazon
@@ -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
@@ -112,22 +113,33 @@ module Paperclip
 
     module S3
       def self.extended base
-        begin
-          require 'aws-sdk'
-        rescue LoadError => e
-          e.message << " (You may need to install the aws-sdk gem)"
-          raise e
-        end unless defined?(AWS::Core)
+        unless defined?(AWS_CLASS)
+          begin
+            require 'aws-sdk'
+            const_set('AWS_CLASS', defined?(::Aws) ? ::Aws : ::AWS)
+            const_set('AWS_BASE_ERROR',
+              defined?(::Aws) ? Aws::Errors::ServiceError : AWS::Errors::Base)
+            const_set('DEFAULT_PERMISSION',
+              defined?(::AWS) ? :public_read : :'public-read')
+
+          rescue LoadError => e
+            e.message << " (You may need to install the aws-sdk gem)"
+            raise e
+          end
+          if Gem::Version.new(AWS_CLASS::VERSION) >= Gem::Version.new(2) && Gem::Version.new(AWS_CLASS::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
+        end
 
         # Overriding log formatter to make sure it return a UTF-8 string
-        if defined?(AWS::Core::LogFormatter)
-          AWS::Core::LogFormatter.class_eval do
+        if defined?(AWS_CLASS::Core::LogFormatter)
+          AWS_CLASS::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
+        elsif defined?(AWS_CLASS::Core::ClientLogging)
+          AWS_CLASS::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
@@ -141,7 +153,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'.freeze : 'https'.freeze
+              (permission == DEFAULT_PERMISSION) ? 'http'.freeze : 'https'.freeze
             end
           @s3_metadata = @options[:s3_metadata] || {}
           @s3_headers = {}
@@ -149,7 +161,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
@@ -182,8 +194,11 @@ module Paperclip
 
       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
@@ -200,6 +215,13 @@ module Paperclip
         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
         @s3_host_alias = @options[:s3_host_alias]
         @s3_host_alias = @s3_host_alias.call(self) if @s3_host_alias.respond_to?(:call)
@@ -220,7 +242,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 +256,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 +266,19 @@ module Paperclip
 
       def obtain_s3_instance_for(options)
         instances = (Thread.current[:paperclip_s3_instances] ||= {})
-        instances[options] ||= AWS::S3.new(options)
+        instances[options] ||= AWS_CLASS::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 +303,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] || DEFAULT_PERMISSION)
       end
 
       def set_storage_class(storage_class)
@@ -297,7 +323,7 @@ module Paperclip
         else
           false
         end
-      rescue AWS::Errors::Base => e
+      rescue AWS_BASE_ERROR => e
         false
       end
 
@@ -323,7 +349,7 @@ module Paperclip
       end
 
       def create_bucket
-        s3_interface.buckets.create(bucket_name)
+        s3_interface.bucket(bucket_name).create
       end
 
       def flush_writes #:nodoc:
@@ -331,11 +357,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
@@ -356,11 +380,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_CLASS::S3::Errors::NoSuchBucket
             create_bucket
             retry
-          rescue AWS::S3::Errors::SlowDown
+          rescue AWS_CLASS::S3::Errors::SlowDown
             retries += 1
             if retries <= 5
               sleep((2 ** retries) * 0.5)
@@ -382,8 +406,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_BASE_ERROR => e
             # Ignore this.
           end
         end
@@ -393,11 +417,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_BASE_ERROR => e
         warn("#{e} - cannot copy #{path(style)} to local file #{local_dest_path}")
         false
       end