carrierwave_direct 0.0.16 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c51cb71409e58177ac38cc749d3f596766f0ab8e
-  data.tar.gz: 98aeee5a704ec4221825bad26fe3a379c2b65049
+SHA256:
+  metadata.gz: bf462a9da6254f9a1b404f03443be9d9c21800aa378cbab7135da3ab08e2d1a5
+  data.tar.gz: 36e88bdcdc5f8e904109845546c47928eaf24dac894ba15a47820a131efd9576
 SHA512:
-  metadata.gz: 42a18d958215b315f02c644842750bef8466cfefa9410c5fd72011350e09035bc22bf86b20672c3fa5273fd6989bdbf8c090a217982b1257d60b37eed6633fdb
-  data.tar.gz: 419fb4c392fa4eb322e1105bf1c6ca815c85fb7c4b3841ef96f10b2a03760ec2322ba1df82ae565671fdba338e23062dd520b5248411afe032b74b042414212b
+  metadata.gz: 3472e79f169583c76665f9c6a18cebe4b1f8b842e94d57dc4cfadba365382124d358243c229dd5bfcde36e23f9748cf278863f2b9283897e0f8c901b69866ef7
+  data.tar.gz: 180ef968f4d13946a93108e782f029b3c2de25509e7f321933a5203b3d06599e739b999ef1254da69b7153fe02205c72ea0679a4147251f572bdd4967d5cded1

data/.travis.yml

@@ -1,14 +1,19 @@
 rvm:
- - 2.0.0
- - 2.1.0
- - 2.2.0
-install:
-  - 'travis_retry bundle install'
+ - 2.6
+ - 2.7
+
 script: 'bundle exec rspec spec'
 gemfile:
-  - Gemfile
-  - gemfiles/3.2.gemfile
-  - gemfiles/4.0.gemfile
-  - gemfiles/4.1.gemfile
+  - gemfiles/5.1.gemfile
+  - gemfiles/5.2.gemfile
+  - gemfiles/6.0.gemfile
+  - gemfiles/6.1.gemfile
+
+matrix:
+  exclude:
+  - rvm: 2.4
+    gemfile: gemfiles/6.0.gemfile
+
 # Move to containerized travis, see http://docs.travis-ci.com/user/migrating-from-legacy
 sudo: false
+cache: bundler

data/Changelog.md

@@ -1,4 +1,46 @@
-### Unreleased changes
+### Unreleased
+
+### 3.0.0
+  * Fixed Ruby 3 deprecation warnings
+  * [BREAKING CHANGE] Drop support for Carrierwave < 2.2.1 which renamed
+    extension_whitelist to extension_allowlist.
+
+### 2.1.0
+
+Features:
+  * Refactor policies to seperate classes and add back the old policy for
+    backwards compatibility.
+  * Added `direct_fog_hash` method that can be used for returning json
+
+Misc:
+  * Removed deprecated `key` methods.
+  * Removed deprecated `:with_path` option for `direct_fog_url`
+
+### 2.0.0
+
+Features:
+  * [BREAKING CHANGE] Add support for Carrierwave 1.x. Drops support for Carrierwave < 1.0 (Kevin Reintjes @kreintjes).
+
+Misc:
+  * Dropped support for ruby 2.0 and 2.1, they have [reached their end of life](https://www.ruby-lang.org/en/news/2017/04/01/support-of-ruby-2-1-has-ended/)
+  * Update Ruby and Rails versions for Travis so builds succeed once again (Kevin Reintjes @kreintjes)
+
+### 1.1.0
+
+Deprecations:
+  * Calling `direct_fog_url` with `:with_path` is deprecated, please use `url` instead.
+
+### 1.0.0
+
+Features:
+  * Upgraded signing algorithm to use [AWS V4 POST authentication](http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-authentication-HTTPPOST.html). This is a breaking change if you are constructing your own upload forms or submitting your own POST requests. See the Sinatra section of the README for a summary of the new fields required in your V4 POST request. (Fran Worley @fran-worley)
+
+### 0.0.17
+
+Misc:
+  * Pin carrierwave to 0.11
+
+### 0.0.16
 
 Bug Fixes:
   * Allow uploader columns to be named `file` (Diego Plentz @plentz and Moisés Viloria @mois3x)
@@ -7,6 +49,8 @@ Bug Fixes:
 Misc:
   * Dropped support for ruby 1.9, it has [reached its end of life](https://www.ruby-lang.org/en/news/2014/01/10/ruby-1-9-3-will-end-on-2015/) 
   * Add 2.2.0 support to travis. 
+  * Compatible with Capybara 2.7
+  * Replaced fog dependency with fog-aws; significantly reduces gem footprint
 
 ### 0.0.15
 

data/README.md

@@ -20,7 +20,9 @@ Please be aware that this gem (and S3 in general) only support single file uploa
 
 Install the latest release:
 
-    gem install carrierwave_direct
+```bash
+gem install carrierwave_direct
+```
 
 In Rails, add it to your Gemfile:
 
@@ -52,11 +54,15 @@ end
 
 If you haven't already done so generate an uploader
 
-    rails generate uploader Avatar
+```bash
+rails generate uploader Avatar
+```
 
 this should give you a file in:
 
-    app/uploaders/avatar_uploader.rb
+```bash
+app/uploaders/avatar_uploader.rb
+```
 
 Check out this file for some hints on how you can customize your uploader. It should look something like this:
 
@@ -111,17 +117,17 @@ class UploaderTest < Sinatra::Base
   end
 end
 ```
+
 ```haml
 # index.haml
+# Now using AWS POST authentication V4
+# See http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-authentication-HTTPPOST.html for more information
 
 %form{:action => @uploader.direct_fog_url, :method => "post", :enctype => "multipart/form-data"}
-  %input{:name => "utf8", :type => "hidden"}
-  %input{:type => "hidden", :name => "key", :value => @uploader.key}
-  %input{:type => "hidden", :name => "AWSAccessKeyId", :value => @uploader.aws_access_key_id}
-  %input{:type => "hidden", :name => "acl", :value => @uploader.acl}
+  - @uploader.direct_fog_hash.each do |key, value|
+    - if key != :uri
+      %input{:type => "hidden", :name => key, :value => value}
   %input{:type => "hidden", :name => "success_action_redirect", :value => @uploader.success_action_redirect}
-  %input{:type => "hidden", :name => "policy", :value => @uploader.policy}
-  %input{:type => "hidden", :name => "signature", :value => @uploader.signature}
   %input{:name => "file", :type => "file"}
   %input{:type => "submit", :value => "Upload to S3"}
 ```
@@ -276,7 +282,7 @@ If your upload was successful then you will be redirected to the `success_action
 
 The `key` is the most important piece of information as we can use it for validating the file extension, downloading the file from S3, processing it and re-uploading it.
 
-If you're using ActiveRecord, CarrierWaveDirect will by default validate the file extension based off your `extension_white_list` in your uploader. See the [CarrierWave readme](https://github.com/jnicklas/carrierwave) for more info. You can then use the helper `filename_valid?` to check if the filename is valid. e.g.
+If you're using ActiveRecord, CarrierWaveDirect will by default validate the file extension based off your `extension_allowlist` in your uploader. See the [CarrierWave readme](https://github.com/jnicklas/carrierwave) for more info. You can then use the helper `filename_valid?` to check if the filename is valid. e.g.
 
 ```ruby
 class UsersController < ApplicationController
@@ -300,6 +306,7 @@ CarrierWaveDirect automatically gives you an accessible `key` attribute in your
   <%= f.submit %>
 <% end %>
 ```
+
 then in your controller you can do something like this:
 
 ```ruby
@@ -322,7 +329,7 @@ Now that the basic building blocks are in place you can process and save your av
 class User < ActiveRecord::Base
   def save_and_process_avatar(options = {})
     if options[:now]
-      self.remote_avatar_url = avatar.direct_fog_url(:with_path => true)
+      self.remote_avatar_url = avatar.url
       save
     else
       Resque.enqueue(AvatarProcessor, attributes)
@@ -355,11 +362,12 @@ Your users may find it convenient to upload a file from a location on the Intern
   <%= f.submit %>
 <% end %>
 ```
+
 ```ruby
 class User < ActiveRecord::Base
   def save_and_process_avatar(options = {})
     if options[:now]
-      self.remote_avatar_url = has_remote_avatar_net_url? ? remote_avatar_net_url : avatar.direct_fog_url(:with_path => true)
+      self.remote_avatar_url = has_remote_avatar_net_url? ? remote_avatar_net_url : avatar.url
       save
     else
       Resque.enqueue(AvatarProcessor, attributes)
@@ -367,6 +375,7 @@ class User < ActiveRecord::Base
   end
 end
 ```
+
 The methods `has_avatar_upload?`, `remote_avatar_net_url` and `has_remote_avatar_net_url?` are automatically added to your mounted model
 
 ## Validations
@@ -395,13 +404,13 @@ Validates that the filename in the database is unique. Turned *on* by default
 validates :avatar, :filename_format => true
 ```
 
-Validates that the uploaded filename is valid. As well as validating the extension against the `extension_white_list` it also validates that the `upload_dir` is correct. Turned *on* by default
+Validates that the uploaded filename is valid. As well as validating the extension against the `extension_allowlist` it also validates that the `upload_dir` is correct. Turned *on* by default
 
 ```ruby
 validates :avatar, :remote_net_url_format => true
 ```
 
-Validates that the remote net url is valid. As well as validating the extension against the `extension_white_list` it also validates that url is valid and has only the schemes specified in the `url_scheme_whitelist`. Turned *on* by default
+Validates that the remote net url is valid. As well as validating the extension against the `extension_allowlist` it also validates that url is valid and has only the schemes specified in the `url_scheme_whitelist`. Turned *on* by default
 
 ## Configuration
 
@@ -422,10 +431,11 @@ CarrierWave.configure do |config|
                                                   # on s3, but you must include an input field named
                                                   # Content-Type on every direct upload form
 
-  config.use_action_status = true                 # defaults to false; if true you must set in your uploader
-                                                  # 'uploader.success_action_status = 201' and set
-                                                  # 'f.file_field :avatar, use_action_status: true' to works
-                                                  # properly
+  config.use_action_status = true                 # defaults to false; if true, you must set
+                                                  # success_action_status in your uploader:
+                                                  #   uploader.success_action_status = "201"
+                                                  # and add use_action_status to the file field:
+                                                  #   f.file_field :avatar, use_action_status: true'
 end
 ```
 
@@ -517,7 +527,7 @@ Factory.define :user |f|
 end
 ```
 
-This will return a valid key based off your `upload_dir` and your `extension_white_list`
+This will return a valid key based off your `upload_dir` and your `extension_allowlist`
 
 ### Faking a background download
 
@@ -530,7 +540,7 @@ upload_path = find_upload_path
 redirect_key = sample_key(:base => find_key, :filename => File.basename(upload_path))
 
 uploader.key = redirect_key
-download_url = uploader.direct_fog_url(:with_path => true)
+download_url = uploader.url
 
 # Register the download url and return the uploaded file in the body
 FakeWeb.register_uri(:get, download_url, :body => File.open(upload_path))
@@ -560,12 +570,16 @@ If you're Rails app was newly generated *after* version 3.2.3 and your testing t
 
 Pull requests are very welcome. Before submitting a pull request, please make sure that your changes are well tested. Pull requests without tests *will not* be accepted.
 
-    gem install bundler
-    bundle install
+```bash
+gem install bundler
+bundle install
+```
 
 You should now be able to run the tests
 
-    bundle exec rake
+```bash
+bundle exec rake
+```
 
 ### Using the Sample Application
 

data/carrierwave_direct.gemspec

@@ -14,14 +14,15 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "carrierwave_direct"
 
-  s.add_dependency "carrierwave"
+  s.add_dependency "carrierwave", '>= 2.2.0'
   s.add_dependency "fog-aws"
 
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec", '~> 3.0'
   s.add_development_dependency "timecop"
-  s.add_development_dependency "rails", ">= 3.2.12"
+  s.add_development_dependency "rails", ">= 5.1.0"
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "capybara"
+  s.add_development_dependency "byebug"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/gemfiles/{3.2.gemfile → 5.1.gemfile}

@@ -1,12 +1,12 @@
 source "https://rubygems.org"
 
 gem "carrierwave"
-gem "fog"
+gem "fog-aws"
 
 group :test do
-  gem "rspec", '3.0.0'
+  gem "rspec", '~> 3.0'
   gem "timecop"
-  gem "rails", "~>3.2.12"
+  gem "rails", "~>5.1.0"
   gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
   gem "capybara"
   # gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby

data/gemfiles/{4.0.gemfile → 5.2.gemfile}

@@ -1,12 +1,12 @@
 source "https://rubygems.org"
 
 gem "carrierwave"
-gem "fog"
+gem "fog-aws"
 
 group :test do
-  gem "rspec", '3.0.0'
+  gem "rspec", '~> 3.0'
   gem "timecop"
-  gem "rails", "~>4.0.0"
+  gem "rails", "~>5.2.0"
   gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
   gem "capybara"
   # gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby

data/gemfiles/{4.1.gemfile → 6.0.gemfile}

@@ -1,12 +1,12 @@
 source "https://rubygems.org"
 
 gem "carrierwave"
-gem "fog"
+gem "fog-aws"
 
 group :test do
-  gem "rspec", '3.0.0'
+  gem "rspec", '~> 3.0'
   gem "timecop"
-  gem "rails", "~>4.1.0"
+  gem "rails", "~>6.0.0"
   gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
   gem "capybara"
   # gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby

data/gemfiles/6.1.gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+gem "carrierwave"
+gem "fog-aws"
+
+group :test do
+  gem "rspec", '~> 3.0'
+  gem "timecop"
+  gem "rails", "~>6.1.0"
+  gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
+  gem "capybara"
+  # gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+end

data/lib/carrierwave_direct/action_view_extensions/form_helper.rb

@@ -18,7 +18,7 @@ module CarrierWaveDirect
         options = args.extract_options!
 
         html_options = {
-          :multipart => true 
+          :multipart => true
         }.update(options[:html] || {})
 
         form_for(

data/lib/carrierwave_direct/form_builder.rb

@@ -5,19 +5,21 @@ module CarrierWaveDirect
     def file_field(method, options = {})
       @object.policy(enforce_utf8: true)
 
-      options.merge!(:name => "file")
-
-      fields = required_base_fields
-
-      fields << content_type_field(options)
-
-      fields << success_action_field(options)
+      fields = hidden_fields(options)
 
       # The file field must be the last element in the form.
       # Any element after this will be ignored by Amazon.
+      options.merge!(:name => "file")
+
       fields << super
     end
 
+    def fields_except_file_field(options = {})
+      @object.policy(enforce_utf8: true)
+
+      hidden_fields(options)
+    end
+
     def content_type_label(content=nil)
       content ||= 'Content Type'
       @template.label_tag('Content-Type', content)
@@ -29,12 +31,28 @@ module CarrierWaveDirect
 
     private
 
+    def hidden_fields(options)
+      fields = required_base_fields
+      fields << content_type_field(options)
+      fields << success_action_field(options)
+      fields
+    end
+
     def required_base_fields
-      hidden_field(:key,                     :name => "key") <<
-      hidden_field(:aws_access_key_id,       :name => "AWSAccessKeyId") <<
-      hidden_field(:acl,                     :name => "acl") <<
-      hidden_field(:policy,                  :name => "policy") <<
-      hidden_field(:signature,               :name => "signature")
+      fields = ''.html_safe
+      @object.direct_fog_hash(enforce_utf8: true).each do |key, value|
+        normalized_keys = {
+          'X-Amz-Signature':  'signature',
+          'X-Amz-Credential': 'credential',
+          'X-Amz-Algorithm':  'algorithm',
+          'X-Amz-Date': 'date'
+        }
+        id = "#{@template.dom_class(@object)}_#{normalized_keys[key] || key}"
+        if key != :uri
+          fields << @template.hidden_field_tag(key, value, id: id, required: false)
+        end
+      end
+      fields
     end
 
     def content_type_field(options)

data/lib/carrierwave_direct/mount.rb

@@ -14,7 +14,7 @@ module CarrierWaveDirect
            def #{column}; self; end
         RUBY
       end
- 
+
       self.instance_eval <<-RUBY, __FILE__, __LINE__+1
         attr_accessor :remote_#{column}_net_url
       RUBY
@@ -23,16 +23,6 @@ module CarrierWaveDirect
       include mod
       mod.class_eval <<-RUBY, __FILE__, __LINE__+1
 
-        def key
-          warn "key method is deprecated, please use column_key method instead."
-          send(:#{column}).key
-        end
-
-        def key=(k)
-          warn "key= method is deprecated, please use column_key= method instead."
-          send(:#{column}).key = k
-        end
-
         def #{column}_key
           send(:#{column}).key
         end