carrierwave-aws 1.0.0.pre.rc.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c592e2b5f772c89d14e60f354483bbd18f48b744
-  data.tar.gz: bd4e6f6c44e26e9aab0b18c09d114633e8f43ae4
+  metadata.gz: 0daf2d106b4a0d27f423cfbaa8745fa019d5f840
+  data.tar.gz: 2213c9acca949bd4d1608a0fd08cbd96ed12b64b
 SHA512:
-  metadata.gz: d174e6f20861ee37b5b536674c0cfc667b1e794048b4401fb6889e80cca88a66586d306702b96bae8213127de8cc7b8ec34dd424107d3316723d907c5da96f67
-  data.tar.gz: 2b50f0def9160aa5255fe65f579c11c79f9c210e546f15ffd60ce6b60a4e6899462116f12cab04bdd703278103d3c6692fbe08f44d5916282d2477f36f42b3d6
+  metadata.gz: fa5b275f21820fb4fed97d1cd183a3f1ae909de304e1dd6616d64d4a047fa9d285b340a66fea9ad4a720df9ee6bf8e2ee3eb485277d58974fb22cde1b185ec7b
+  data.tar.gz: abffdcdca5ee8d72c7daf90f4e6fc9ee18df1b3c30cc4e0a4e692214ea02b851254449364155b1b020f4a205e3f1f6ea20cb20bef6f264cb92318ffa803ff9f2

data/.travis.yml

@@ -1,8 +1,13 @@
+sudo: false
 language: ruby
 rvm:
-- 2.1.5
-- 2.2.2
-script: bundle exec rspec spec
+  - 2.1.5
+  - 2.2.2
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+script: bundle exec rspec
 env:
   global:
   - secure: |-

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## Version 1.0.0 2015-09-18
+
+* Added: ACL options are verified when they are set, and coerced into usable
+  values when possible.
+* Added: Specify an `aws_signer` lambda for use signing authenticated content
+  served through services like CloudFront.
+
 ## Version 1.0.0-rc.1 2015-07-02
 
 * Continues where 0.6.0 left off. This wraps AWS-SDK v2 and all of the breaking

data/README.md

@@ -58,6 +58,10 @@ CarrierWave.configure do |config|
     secret_access_key: ENV.fetch('AWS_SECRET_ACCESS_KEY'),
     region:            ENV.fetch('AWS_REGION') # Required
   }
+
+  # Optional: Signing of download urls, e.g. for serving private
+  # content through CloudFront.
+  config.aws_signer = -> (unsigned_url, options) { Aws::CF::Signer.sign_url unsigned_url, options }
 end
 ```
 

data/Rakefile

@@ -1 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler'
+require 'bundler/gem_tasks'
+
+Bundler.setup
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/carrierwave-aws.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'carrierwave', '~> 0.7'
-  gem.add_dependency 'aws-sdk',     '~> 2.0.47'
+  gem.add_dependency 'aws-sdk',     '~> 2.0'
 
   gem.add_development_dependency 'rspec', '~> 3'
 end

data/lib/carrierwave-aws.rb

@@ -6,15 +6,71 @@ require 'carrierwave/storage/aws_options'
 require 'carrierwave/support/uri_filename'
 
 class CarrierWave::Uploader::Base
+  ACCEPTED_ACL = %w[
+    private
+    public-read
+    public-read-write
+    authenticated-read
+    bucket-owner-read
+    bucket-owner-full-control
+  ].freeze
+
+  ConfigurationError = Class.new(StandardError)
+
   add_config :aws_attributes
   add_config :aws_authenticated_url_expiration
   add_config :aws_credentials
   add_config :aws_bucket
-  add_config :aws_acl
   add_config :aws_read_options
   add_config :aws_write_options
+  add_config :aws_acl
+  add_config :aws_signer
 
   configure do |config|
     config.storage_engines[:aws] = 'CarrierWave::Storage::AWS'
   end
+
+  def self.aws_acl=(acl)
+    @aws_acl = normalized_acl(acl)
+  end
+
+  def self.normalized_acl(acl)
+    normalized = acl.to_s.downcase.sub('_', '-')
+
+    unless ACCEPTED_ACL.include?(normalized)
+      raise ConfigurationError.new("Invalid ACL option: #{normalized}")
+    end
+
+    normalized
+  end
+
+  def self.aws_signer(value = nil)
+    self.aws_signer = value if value
+
+    if instance_variable_defined?('@aws_signer')
+      @aws_signer
+    elsif superclass.respond_to? :aws_signer
+      superclass.aws_signer
+    end
+  end
+
+  def self.aws_signer=(signer)
+    @aws_signer = validated_signer(signer)
+  end
+
+  def self.validated_signer(signer)
+    unless signer.nil? || signer.instance_of?(Proc) && signer.arity == 2
+      raise ConfigurationError.new("Invalid signer option. Signer proc has to respond to '.call(unsigned_url, options)'")
+    end
+
+    signer
+  end
+
+  def aws_acl=(acl)
+    @aws_acl = self.class.normalized_acl(acl)
+  end
+
+  def aws_signer
+    instance_variable_defined?('@aws_signer') ? @aws_signer : self.class.aws_signer
+ end
 end

data/lib/carrierwave/aws/version.rb

@@ -1,5 +1,5 @@
 module Carrierwave
   module AWS
-    VERSION = '1.0.0-rc.1'
+    VERSION = '1.0.0'
   end
 end

data/lib/carrierwave/storage/aws_file.rb

@@ -60,6 +60,10 @@ module CarrierWave
         bucket.object(new_path).copy_from(copy_source: "#{bucket.name}/#{file.key}")
       end
 
+      def signed_url(options = {})
+        signer.call(public_url, options)
+      end
+
       def authenticated_url(options = {})
         file.presigned_url(:get, aws_options.expiration_options(options))
       end
@@ -73,7 +77,9 @@ module CarrierWave
       end
 
       def url(options = {})
-        if uploader.aws_acl.to_s != 'public-read'
+        if signer
+          signed_url(options)
+        elsif uploader.aws_acl.to_s != 'public-read'
           authenticated_url(options)
         else
           public_url
@@ -85,6 +91,10 @@ module CarrierWave
       def bucket
         @bucket ||= connection.bucket(uploader.aws_bucket)
       end
+
+      def signer
+        uploader.aws_signer
+      end
     end
   end
 end

data/spec/carrierwave-aws_spec.rb

@@ -1,13 +1,140 @@
 require 'spec_helper'
 
 describe CarrierWave::Uploader::Base do
-  it 'defines aws specific storage options' do
-    expect(described_class).to respond_to(:aws_attributes)
+  let(:uploader) do
+    Class.new(CarrierWave::Uploader::Base)
+  end
+
+  let(:derived_uploader) do
+    Class.new(uploader)
   end
 
   it 'inserts aws as a known storage engine' do
-    described_class.configure do |config|
+    uploader.configure do |config|
       expect(config.storage_engines).to have_key(:aws)
     end
   end
+
+  it 'defines aws specific storage options' do
+    expect(uploader).to respond_to(:aws_attributes)
+  end
+
+  describe '#aws_acl' do
+    it 'allows known acess control values' do
+      expect {
+        uploader.aws_acl = 'private'
+        uploader.aws_acl = 'public-read'
+        uploader.aws_acl = 'authenticated-read'
+      }.not_to raise_exception
+    end
+
+    it 'does not allow unknown control values' do
+      expect {
+        uploader.aws_acl = 'everybody'
+      }.to raise_exception(CarrierWave::Uploader::Base::ConfigurationError)
+    end
+
+    it 'normalizes the set value' do
+      uploader.aws_acl = :'public-read'
+      expect(uploader.aws_acl).to eq('public-read')
+
+      uploader.aws_acl = 'PUBLIC_READ'
+      expect(uploader.aws_acl).to eq('public-read')
+    end
+
+    it 'can be overridden on an instance level' do
+      instance = uploader.new
+
+      uploader.aws_acl = 'private'
+      instance.aws_acl = 'public-read'
+
+      expect(uploader.aws_acl).to eq('private')
+      expect(instance.aws_acl).to eq('public-read')
+    end
+
+    it 'can be looked up from superclass' do
+      uploader.aws_acl = 'private'
+      instance = derived_uploader.new
+
+      expect(derived_uploader.aws_acl).to eq('private')
+      expect(instance.aws_acl).to eq('private')
+    end
+
+    it 'can be overridden on a class level' do
+      uploader.aws_acl = 'public-read'
+      derived_uploader.aws_acl = 'private'
+
+      base = uploader.new
+      expect(base.aws_acl).to eq('public-read')
+
+      instance = derived_uploader.new
+      expect(instance.aws_acl).to eq('private')
+    end
+
+    it 'can be set with the configure block' do
+      uploader.configure do |config|
+        config.aws_acl = 'public-read'
+      end
+
+      expect(uploader.aws_acl).to eq('public-read')
+    end
+  end
+
+  describe '#aws_signer' do
+    let(:signer_proc) { -> (unsigned_url, options) { } }
+    let(:other_signer) { -> (unsigned_url, options) { } }
+
+    it 'allows proper signer object' do
+      expect { uploader.aws_signer = signer_proc }.not_to raise_exception
+    end
+
+    it 'does not allow signer with unknown api' do
+      signer_proc = -> (unsigned_url) { }
+
+      expect { uploader.aws_signer = signer_proc }.to raise_exception(CarrierWave::Uploader::Base::ConfigurationError)
+    end
+
+    it 'can be overridden on an instance level' do
+      instance = uploader.new
+
+      uploader.aws_signer = signer_proc
+      instance.aws_signer = other_signer
+
+      expect(uploader.aws_signer).to eql(signer_proc)
+      expect(instance.aws_signer).to eql(other_signer)
+    end
+
+    it 'can be overridden on a class level' do
+      uploader.aws_signer = signer_proc
+      derived_uploader.aws_signer = other_signer
+
+      base = uploader.new
+      expect(base.aws_signer).to eq(signer_proc)
+
+      instance = derived_uploader.new
+      expect(instance.aws_signer).to eql(other_signer)
+    end
+
+    it 'can be looked up from superclass' do
+      uploader.aws_signer = signer_proc
+      instance = derived_uploader.new
+
+      expect(derived_uploader.aws_signer).to eq(signer_proc)
+      expect(instance.aws_signer).to eql(signer_proc)
+    end
+
+    it 'can be set with the configure block' do
+      uploader.configure do |config|
+        config.aws_signer = signer_proc
+      end
+
+      expect(uploader.aws_signer).to eql(signer_proc)
+    end
+
+    it 'can be set when passed as argument to the class getter method' do
+      uploader.aws_signer signer_proc
+
+      expect(uploader.aws_signer).to eql(signer_proc)
+    end
+  end
 end

data/spec/carrierwave/storage/aws_file_spec.rb

@@ -12,6 +12,7 @@ describe CarrierWave::Storage::AWSFile do
       aws_acl: :'public-read',
       aws_attributes: {},
       asset_host: nil,
+      aws_signer: nil,
       aws_read_options: { encryption_key: 'abc' },
       aws_write_options: { encryption_key: 'def' }
     )
@@ -62,6 +63,16 @@ describe CarrierWave::Storage::AWSFile do
       aws_file.url
     end
 
+    it 'requests an signed url if url signing is configured' do
+      signature = 'Signature=QWERTZ&Key-Pair-Id=XYZ'
+      cloudfront_signer = -> (unsigned_url, options) { [unsigned_url, signature].join('?') }
+
+      allow(uploader).to receive(:aws_signer) { cloudfront_signer }
+      expect(file).to receive(:public_url) { 'http://example.com' }
+
+      expect(aws_file.url).to eq "http://example.com?#{signature}"
+    end
+
     it 'uses the asset_host and file path if asset_host is set' do
       allow(uploader).to receive(:aws_acl) { :'public-read' }
       allow(uploader).to receive(:asset_host) { 'http://example.com' }

data/spec/features/storing_files_spec.rb

@@ -4,6 +4,10 @@ describe 'Storing Files', type: :feature do
   let(:image)    { File.open('spec/fixtures/image.png', 'r') }
   let(:instance) { FeatureUploader.new }
 
+  before do
+    instance.aws_acl = 'public-read'
+  end
+
   it 'uploads the file to the configured bucket' do
     instance.store!(image)
     instance.retrieve_from_store!('image.png')

data/spec/spec_helper.rb

@@ -5,8 +5,8 @@ def source_environment_file!
   return unless File.exists?('.env')
 
   File.readlines('.env').each do |line|
-    values = line.split('=')
-    ENV[values.first] = values.last.chomp
+    key, value = line.split('=')
+    ENV[key] = value.chomp
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-aws
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2015-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.47
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.47
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -98,12 +98,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A slimmer alternative to using Fog for S3 support in CarrierWave