carrierwave-aws 1.3.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b08e5e5ca8483cb1079391083b6da62061a0552d
-  data.tar.gz: 1044c413b9168267762ba1a3b862bb3eaa32e6c9
+SHA256:
+  metadata.gz: ac60b2f92e091d9a99068561005dbf5cd44376269a0e7f101d0a64b2581cd07d
+  data.tar.gz: fdb3e1990f6c8845bfe79fb48c44f7ab4a04d5126a550dfd3d4196bb305344df
 SHA512:
-  metadata.gz: 3d62d9d5fd5ecdb09df295da2eac7b6d6398ccf76384c1b0eb94405fb003136e351c16d83233f92d51a88d61944aee83e9672f01e197137bf512dbbdc3f17547
-  data.tar.gz: e0ebf6479be16ee6d41082cbcd0034b33c54c1fbc95403fb7494a72f0fcdf4166116ce83632ef9f1e5c3a04936839aa77582773c1eecc00af458284b86a92abd
+  metadata.gz: d3ff06f23bfd7ad4486adbaeb788be01ccee910eb4d81a786428034031bae77d069c0088dd55873df599bf9bc148530e800607d846d66827b7cebe5659d82633
+  data.tar.gz: 4eb6671f489ca213531f3c8bb0aa34da3e6ed6658bae7ae3870d95b321614c1d54ee87f277fc237838ddab3ac9dd537c7a2f7ad817fe862a8bb615ae1fe92a3a

data/lib/carrierwave/aws/version.rb

@@ -2,6 +2,6 @@
 
 module Carrierwave
   module AWS
-    VERSION = '1.3.0'
+    VERSION = '1.6.0'
   end
 end

data/lib/carrierwave/storage/aws_file.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/module/delegation'
+
 module CarrierWave
   module Storage
     class AWSFile
@@ -61,16 +63,16 @@ module CarrierWave
       end
 
       def copy_to(new_path)
-        bucket.object(new_path).copy_from(
-          copy_source: "#{bucket.name}/#{file.key}",
-          acl: uploader.aws_acl
+        file.copy_to(
+          bucket.object(new_path),
+          aws_options.copy_options(self)
         )
       end
 
       def move_to(new_path)
         file.move_to(
           "#{bucket.name}/#{new_path}",
-          acl: uploader.aws_acl
+          aws_options.move_options(self)
         )
       end
 
@@ -79,12 +81,16 @@ module CarrierWave
       end
 
       def authenticated_url(options = {})
+        if asset_host && asset_host == bucket.name
+          # Can't use https, since plain S3 doesn't support custom TLS certificates
+          options = options.reverse_merge(secure: false, virtual_host: true)
+        end
         file.presigned_url(:get, aws_options.expiration_options(options))
       end
 
       def public_url
-        if uploader.asset_host
-          "#{uploader.asset_host}/#{path}"
+        if asset_host
+          "#{asset_host}/#{uri_path}"
         else
           file.public_url.to_s
         end
@@ -93,10 +99,10 @@ module CarrierWave
       def url(options = {})
         if signer
           signed_url(options)
-        elsif uploader.aws_acl.to_s != 'public-read'
-          authenticated_url(options)
-        else
+        elsif public?
           public_url
+        else
+          authenticated_url(options)
         end
       end
 
@@ -109,6 +115,22 @@ module CarrierWave
       def signer
         uploader.aws_signer
       end
+
+      def uri_path
+        path.gsub(%r{[^/]+}) { |segment| Seahorse::Util.uri_escape(segment) }
+      end
+
+      def public?
+        uploader.aws_acl.to_s == 'public-read' || uploader.asset_host_public
+      end
+
+      def asset_host
+        if uploader.asset_host.respond_to? :call
+          uploader.asset_host.call(self)
+        else
+          uploader.asset_host
+        end
+      end
     end
   end
 end

data/lib/carrierwave/storage/aws_options.rb

@@ -3,6 +3,8 @@
 module CarrierWave
   module Storage
     class AWSOptions
+      MULTIPART_TRESHOLD = 15 * 1024 * 1024
+
       attr_reader :uploader
 
       def initialize(uploader)
@@ -21,6 +23,14 @@ module CarrierWave
         }.merge(aws_attributes).merge(aws_write_options)
       end
 
+      def move_options(file)
+        {
+          acl: uploader.aws_acl,
+          multipart_copy: file.size >= MULTIPART_TRESHOLD
+        }.merge(aws_attributes).merge(aws_write_options)
+      end
+      alias copy_options move_options
+
       def expiration_options(options = {})
         uploader_expiration = uploader.aws_authenticated_url_expiration
 
@@ -30,7 +40,10 @@ module CarrierWave
       private
 
       def aws_attributes
-        uploader.aws_attributes || {}
+        attributes = uploader.aws_attributes
+        return {} if attributes.nil?
+
+        attributes.respond_to?(:call) ? attributes.call : attributes
       end
 
       def aws_read_options

data/lib/carrierwave/support/uri_filename.rb

@@ -6,7 +6,7 @@ module CarrierWave
       def self.filename(url)
         path = url.split('?').first
 
-        URI.decode(path).gsub(%r{.*/(.*?$)}, '\1')
+        CGI.unescape(path).gsub(%r{.*/(.*?$)}, '\1')
       end
     end
   end

data/lib/carrierwave-aws.rb

@@ -29,6 +29,7 @@ module CarrierWave
       add_config :aws_write_options
       add_config :aws_acl
       add_config :aws_signer
+      add_config :asset_host_public
 
       configure do |config|
         config.storage_engines[:aws] = 'CarrierWave::Storage::AWS'
@@ -39,6 +40,8 @@ module CarrierWave
       end
 
       def self.normalized_acl(acl)
+        return nil if acl.nil?
+
         normalized = acl.to_s.downcase.sub('_', '-')
 
         unless ACCEPTED_ACL.include?(normalized)
@@ -83,6 +86,14 @@ module CarrierWave
           self.class.aws_signer
         end
       end
+
+      def asset_host_public
+        if instance_variable_defined?('@asset_host_public')
+          @asset_host_public
+        else
+          self.class.asset_host_public
+        end || false
+      end
     end
   end
 end

data/spec/carrierwave/storage/aws_file_spec.rb

@@ -72,11 +72,21 @@ describe CarrierWave::Storage::AWSFile do
       aws_file.url
     end
 
+    it 'requests a public url if asset_host_public' do
+      allow(uploader).to receive(:aws_acl) { :'authenticated-read' }
+      allow(uploader).to receive(:asset_host_public) { true }
+
+      expect(file).to receive(:public_url)
+
+      aws_file.url
+    end
+
     it 'requests an authenticated url if acl is not public readable' do
       allow(uploader).to receive(:aws_acl) { :private }
       allow(uploader).to receive(:aws_authenticated_url_expiration) { 60 }
+      allow(uploader).to receive(:asset_host_public) { false }
 
-      expect(file).to receive(:presigned_url).with(:get, expires_in: 60)
+      expect(file).to receive(:presigned_url).with(:get, { expires_in: 60 })
 
       aws_file.url
     end
@@ -100,6 +110,18 @@ describe CarrierWave::Storage::AWSFile do
 
       expect(aws_file.url).to eq('http://example.com/files/1/file.txt')
     end
+
+    it 'accepts the asset_host given as a proc' do
+      allow(uploader).to receive(:aws_acl) { :'public-read' }
+      allow(uploader).to receive(:asset_host) do
+        proc do |file|
+          expect(file).to be_instance_of(CarrierWave::Storage::AWSFile)
+          'https://example.com'
+        end
+      end
+
+      expect(aws_file.url).to eq('https://example.com/files/1/file.txt')
+    end
   end
 
   describe '#store' do
@@ -126,4 +148,29 @@ describe CarrierWave::Storage::AWSFile do
       end
     end
   end
+
+  describe '#public_url' do
+    it 'uri-encodes the path' do
+      allow(uploader).to receive(:asset_host) { 'http://example.com' }
+      aws_file.path = 'uploads/images/jekyll+and+hyde.txt'
+      expect(aws_file.public_url).to eq 'http://example.com/uploads/images/jekyll%2Band%2Bhyde.txt'
+    end
+  end
+
+  describe '#copy_to' do
+    let(:new_s3_object) { instance_double('Aws::S3::Object') }
+
+    it 'copies file to target path' do
+      new_path = 'files/2/file.txt'
+      expect(bucket).to receive(:object).with(new_path).and_return(new_s3_object)
+      expect(file).to receive(:size).at_least(:once).and_return(1024)
+      expect(file).to(
+        receive(:copy_to).with(
+          new_s3_object,
+          aws_file.aws_options.copy_options(aws_file)
+        )
+      )
+      aws_file.copy_to new_path
+    end
+  end
 end

data/spec/carrierwave/storage/aws_options_spec.rb

@@ -39,8 +39,8 @@ describe CarrierWave::Storage::AWSOptions do
       write_options = options.write_options(file)
 
       expect(write_options).to include(
-        acl:            'public-read',
-        content_type:   'image/png',
+        acl: 'public-read',
+        content_type: 'image/png',
         encryption_key: 'def'
       )
       expect(write_options[:body].path).to eq(file.path)
@@ -52,6 +52,14 @@ describe CarrierWave::Storage::AWSOptions do
       expect { options.write_options(file) }.to_not raise_error
     end
 
+    it 'works if aws_attributes is a Proc' do
+      expect(uploader).to receive(:aws_attributes).and_return(
+        -> { { expires: (Date.today + 7).httpdate } }
+      )
+
+      expect { options.write_options(file) }.to_not raise_error
+    end
+
     it 'works if aws_write_options is nil' do
       expect(uploader).to receive(:aws_write_options) { nil }
 

data/spec/carrierwave/support/uri_filename_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 
 describe CarrierWave::Support::UriFilename do
-  UriFilename = CarrierWave::Support::UriFilename
-
   describe '.filename' do
     it 'extracts a decoded filename from file uri' do
       samples = {
@@ -11,7 +9,7 @@ describe CarrierWave::Support::UriFilename do
       }
 
       samples.each do |uri, name|
-        expect(UriFilename.filename(uri)).to eq(name)
+        expect(CarrierWave::Support::UriFilename.filename(uri)).to eq(name)
       end
     end
   end

data/spec/carrierwave-aws_spec.rb

@@ -20,7 +20,7 @@ describe CarrierWave::Uploader::Base do
   end
 
   describe '#aws_acl' do
-    it 'allows known acess control values' do
+    it 'allows known access control values' do
       expect do
         uploader.aws_acl = 'private'
         uploader.aws_acl = 'public-read'
@@ -28,6 +28,13 @@ describe CarrierWave::Uploader::Base do
       end.not_to raise_exception
     end
 
+    it 'allows nil' do
+      uploader.aws_acl = 'public-read'
+      expect do
+        uploader.aws_acl = nil
+      end.to change { uploader.aws_acl }.from('public-read').to(nil)
+    end
+
     it 'does not allow unknown control values' do
       expect do
         uploader.aws_acl = 'everybody'
@@ -138,4 +145,43 @@ describe CarrierWave::Uploader::Base do
       expect(uploader.aws_signer).to eql(signer_proc)
     end
   end
+
+  describe '#asset_host_public' do
+    it 'can be overridden on an instance level' do
+      instance = uploader.new
+
+      uploader.asset_host_public = true
+      instance.asset_host_public = false
+
+      expect(uploader.asset_host_public).to eq(true)
+      expect(instance.asset_host_public).to eq(false)
+    end
+
+    it 'can be looked up from superclass' do
+      uploader.asset_host_public = true
+      instance = derived_uploader.new
+
+      expect(derived_uploader.asset_host_public).to eq(true)
+      expect(instance.asset_host_public).to eq(true)
+    end
+
+    it 'can be overridden on a class level' do
+      uploader.asset_host_public = true
+      derived_uploader.asset_host_public = false
+
+      base = uploader.new
+      expect(base.asset_host_public).to eq(true)
+
+      instance = derived_uploader.new
+      expect(instance.asset_host_public).to eq(false)
+    end
+
+    it 'can be set with the configure block' do
+      uploader.configure do |config|
+        config.asset_host_public = true
+      end
+
+      expect(uploader.asset_host_public).to eq(true)
+    end
+  end
 end

data/spec/features/storing_files_spec.rb

@@ -73,7 +73,7 @@ describe 'Storing Files', type: :feature do
     image.close
   end
 
-  it 'gets a url for remote files' do
+  it 'gets a public url for remote files' do
     instance.store!(image)
     instance.retrieve_from_store!('image.png')
 
@@ -84,6 +84,34 @@ describe 'Storing Files', type: :feature do
     instance.file.delete
   end
 
+  it 'gets a private url for remote files' do
+    instance.aws_acl = 'private'
+    instance.store!(image)
+    instance.retrieve_from_store!('image.png')
+
+    expect(instance.url).to include(ENV['S3_BUCKET_NAME'])
+    expect(instance.url).to include(instance.path)
+    expect(instance.url).to include('X-Amz-Signature=')
+
+    image.close
+    instance.file.delete
+  end
+
+  it 'respects asset_host for private urls' do
+    allow(instance).to receive(:asset_host).and_return(ENV['S3_BUCKET_NAME'])
+    instance.aws_acl = 'private'
+    instance.store!(image)
+    instance.retrieve_from_store!('image.png')
+
+    expect(URI.parse(instance.url).scheme).to eq 'http'
+    expect(URI.parse(instance.url).hostname).to eq ENV['S3_BUCKET_NAME']
+    expect(instance.url).to include(instance.path)
+    expect(instance.url).to include('X-Amz-Signature=')
+
+    image.close
+    instance.file.delete
+  end
+
   it 'uploads the cache file to the configured bucket' do
     instance.cache!(image)
     instance.retrieve_from_cache!(instance.cache_name)

data/spec/spec_helper.rb

@@ -49,10 +49,15 @@ RSpec.configure do |config|
       cw_config.aws_acl       = :'public-read'
 
       cw_config.aws_credentials = {
-        access_key_id:     ENV['S3_ACCESS_KEY'],
+        access_key_id: ENV['S3_ACCESS_KEY'],
         secret_access_key: ENV['S3_SECRET_ACCESS_KEY'],
-        region:            ENV['AWS_REGION']
-      }
+        region: ENV['AWS_REGION']
+      }.merge(
+        ENV['CI'] && {
+          endpoint: 'http://127.0.0.1:9000',
+          force_path_style: true
+        } || {}
+      )
     end
   end
 end

metadata

@@ -1,61 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-aws
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Parker Selbert
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-27 00:00:00.000000000 Z
+date: 2023-07-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: carrierwave
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk-s3
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -99,7 +113,7 @@ homepage: https://github.com/sorentwo/carrierwave-aws
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,16 +121,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Native aws-sdk support for S3 in CarrierWave
 test_files: