s3_relay 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6f7808fa908073f00317199da6e43b9821c7d827
-  data.tar.gz: 896e7707ba3031b0a5074bf1322d8c62ffc715f0
+SHA256:
+  metadata.gz: 10af82cfd6dbeef7aa3a3aae7938a708a09c2953a5133f03980d09e993182acc
+  data.tar.gz: 1aa52906c7727233f0c41563d35c5c05efc1d12ea0f7257c43d6f0ceed512911
 SHA512:
-  metadata.gz: 65db04a3d352ff2dee8d812450eb20f2065c8cc1c727dc8c278dc914c0a08879038241d96e6371414a0211d25c0f0e4177cf227e82492b666c604a9dc5f1b57a
-  data.tar.gz: 10239435d5ca2a5df99b4bf963ced838f2fd3561b03cfa2f5ec6941809575eab7cbcdfc93a257a9a0417d52c607738294a937ad3b9336ffdbfe10e46374a9aca
+  metadata.gz: ef9f94b3ad1589fa3a9b9a4f85a19bb6ed203671e0f8f5691e286cee2c2a5388fa421ccbc473f68f2ff0517972bce9f1e79c19f60d2c08d96bcdb0e3ace609ea
+  data.tar.gz: 546127e77ed7d20d5597ba35a2c14288bafcad9f75d66935e1fea840ad8d17923537ce3231c38d81091f144cb033234a29110cce4788e944def60f7122f8f35e

data/README.md

@@ -6,10 +6,12 @@
 Enables direct file uploads to Amazon S3 and provides a flexible pattern for
 your Rails app to asynchronously ingest the files.
 
+**Note: If you are using Rails 5.2+ you should consider migrating to Active Storage as this gem will not be suppored for Rails 6+.**
+
 ## Overview
 
 This Rails engine allows you to quickly implement direct uploads to Amazon S3
-from your Rails 3.1+ / 4.x application.  It does not depend on any specific file
+from your Ruby on Rails application.  It does not depend on any specific file
 upload libraries, UI frameworks or AWS gems, like other solutions tend to.
 
 It works by utilizing Amazon S3's
@@ -41,24 +43,6 @@ write to disk.  S3 then decrypts and streams the files as they are downloaded.
 file is permitted or if multiple are.
 * Multiple files can upload concurrently to S3.
 
-## Technology & Requirements
-
-Uploads are made possible by use of the `FormData` object, defined in
-[XMLHttpRequest Level 2](http://dev.w3.org/2006/webapi/XMLHttpRequest-2/).
-Many people are broadly referring to this as being provided by HTML5, but
-technically it's part of the aforementioned spec that browsers have been
-adhering to for a couple of major versions now.  Even IE, wuh?
-
-The latest versions of all of the following are ideal, but here are the gem's
-minimum requirements:
-
-* Ruby 1.9.3+
-* Rails 3.1+
-* Modern versions of Chrome, Safari, FireFox or IE 10+
-  * Note: Progress bars are currently disabled in IE
-  * Note: IE <= 9 users will be instructed to upgrade their browser upon
-  selecting a file
-
 ## Demo
 
 See a demo application using `s3_relay` [here](https://github.com/kjohnston/s3_relay-demo).

data/app/assets/javascripts/s3_relay.coffee

@@ -46,13 +46,13 @@ uploadFiles = (container) ->
 uploadFile = (container, file) ->
   fileName = file.name
 
-  # Assign unique id to each file to pass as get parameter so Safari doesn't
-  # consolidate the requests
-  $(file).uniqueId()
+  # Assign unique value to each request so Safari doesn't consolidate them
+  @s3r_upload_index ||= 0
+  @s3r_upload_index += 1
 
   $.ajax
     type: "GET"
-    url: "/s3_relay/uploads/new?unique_id=#{file.id}"
+    url: "/s3_relay/uploads/new?s3r_upload_index=#{s3r_upload_index}"
     success: (data, status, xhr) ->
       formData = new FormData()
       xhr = new XMLHttpRequest()

data/app/controllers/s3_relay/uploads_controller.rb

@@ -11,7 +11,13 @@ class S3Relay::UploadsController < ApplicationController
     @upload = S3Relay::Upload.new(upload_attrs)
 
     if @upload.save
-      render json: { private_url: @upload.private_url }, status: 201
+      data = {
+        private_url: @upload.private_url,
+        parent_type: @upload.parent_type,
+        parent_id: @upload.parent_id,
+        user_id: user_attrs[:user_id]
+      }
+      render json: data, status: 201
     else
       render json: { errors: @upload.errors }, status: 422
     end
@@ -55,7 +61,7 @@ class S3Relay::UploadsController < ApplicationController
   end
 
   def user_attrs
-    if respond_to?(:current_user) && (id = current_user.try(:id))
+    if respond_to?(:current_user) && (id = current_user&.id)
       { user_id: id }
     else
       {}

data/app/models/s3_relay/upload.rb

@@ -1,7 +1,7 @@
 module S3Relay
   class Upload < ActiveRecord::Base
 
-    belongs_to :parent, polymorphic: true
+    belongs_to :parent, polymorphic: true, optional: true
 
     validates :uuid,         presence: true, uniqueness: true
     validates :upload_type,  presence: true

data/db/migrate/20141009000804_create_s3_relay_uploads.rb

@@ -1,4 +1,4 @@
-class CreateS3RelayUploads < ActiveRecord::Migration
+class CreateS3RelayUploads < ActiveRecord::Migration[5.0]
   def change
     create_table :s3_relay_uploads do |t|
       t.binary :uuid, length: 16

data/lib/s3_relay/base.rb

@@ -24,7 +24,7 @@ module S3Relay
     end
 
     def endpoint
-      "https://#{bucket}.s3-#{region}.amazonaws.com"
+      "https://s3.#{region}.amazonaws.com/#{bucket}"
     end
 
     def digest

data/lib/s3_relay/engine.rb

@@ -4,7 +4,7 @@ module S3Relay
 
     initializer "s3_relay.action_controller" do |app|
       ActiveSupport.on_load :action_controller do
-        helper S3Relay::UploadsHelper
+        helper S3Relay::UploadsHelper if respond_to?(:helper)
       end
     end
   end

data/lib/s3_relay/private_url.rb

@@ -4,7 +4,7 @@ module S3Relay
     attr_reader :expires, :path
 
     def initialize(uuid, file, options={})
-      filename = URI.encode(file).gsub("+", "%2B")
+      filename = Addressable::URI.escape(file).gsub("+", "%2B")
       @path    = [uuid, filename].join("/")
       @expires = (options[:expires] || 10.minutes.from_now).to_i
     end

data/lib/s3_relay/version.rb

@@ -1,3 +1,3 @@
 module S3Relay
-  VERSION = "0.5.0"
+  VERSION = "0.7.0"
 end

data/test/controllers/s3_relay/uploads_controller_test.rb

@@ -22,20 +22,20 @@ module S3Relay
         S3Relay::UploadPresigner.any_instance.stubs(:uuid).returns(uuid)
         S3Relay::UploadPresigner.any_instance.stubs(:expires).returns(time)
 
-        get :new
+        get new_s3_relay_upload_url
         assert_response 200
 
         data = JSON.parse(response.body)
 
-        data["awsaccesskeyid"].must_equal "access-key-id"
-        data["x_amz_server_side_encryption"].must_equal "AES256"
-        data["key"].must_equal "#{uuid}/${filename}"
-        data["success_action_status"].must_equal "201"
-        data["acl"].must_equal "acl"
-        data["endpoint"].must_equal "https://bucket.s3-region.amazonaws.com"
-        data["policy"].length.must_equal 380  # TODO: Improve this
-        data["signature"].length.must_equal 28  # TODO: Improve this
-        data["uuid"].must_equal uuid
+        _(data["awsaccesskeyid"]).must_equal "access-key-id"
+        _(data["x_amz_server_side_encryption"]).must_equal "AES256"
+        _(data["key"]).must_equal "#{uuid}/${filename}"
+        _(data["success_action_status"]).must_equal "201"
+        _(data["acl"]).must_equal "acl"
+        _(data["endpoint"]).must_equal "https://s3.region.amazonaws.com/bucket"
+        _(data["policy"].length).must_equal 380  # TODO: Improve this
+        _(data["signature"].length).must_equal 28  # TODO: Improve this
+        _(data["uuid"]).must_equal uuid
       end
     end
 
@@ -44,11 +44,12 @@ module S3Relay
       describe "success" do
         it do
           assert_difference "S3Relay::Upload.count", 1 do
-            post :create,
+            post s3_relay_uploads_url, params: {
               association:  "photo_uploads",
               uuid:         SecureRandom.uuid,
               filename:     "cat.png",
               content_type: "image/png"
+            }
           end
 
           assert_response 201
@@ -56,17 +57,18 @@ module S3Relay
 
         describe "with parent attributes" do
           describe "matching an object" do
-            before { @product = FactoryGirl.create(:product) }
+            before { @product = FactoryBot.create(:product) }
 
             it do
               assert_difference "@product.photo_uploads.count", 1 do
-                post :create,
+                post s3_relay_uploads_url, params: {
                   association:  "photo_uploads",
                   uuid:         SecureRandom.uuid,
                   filename:     "cat.png",
                   content_type: "image/png",
                   parent_type:  @product.class.to_s,
                   parent_id:    @product.id.to_s
+                }
               end
 
               assert_response 201
@@ -76,40 +78,43 @@ module S3Relay
           describe "not matching an object" do
             it do
               assert_difference "S3Relay::Upload.count" do
-                post :create,
+                post s3_relay_uploads_url, params: {
                   association:  "photo_uploads",
                   uuid:         SecureRandom.uuid,
                   filename:     "cat.png",
                   content_type: "image/png",
                   parent_type:  "Product",
                   parent_id:    "10000000"
+                }
               end
 
               assert_response 201
+              body = JSON.parse(response.body)
 
-              assigns[:upload].parent_type.must_equal nil
-              assigns[:upload].parent_id.must_equal nil
+              assert body["parent_type"] == nil
+              assert body["parent_id"] == nil
             end
           end
 
           describe "with a current_user" do
             before do
               @user = OpenStruct.new(id: 123)
-              @controller.stubs(:current_user).returns(@user)
+              UploadsController.any_instance.stubs(:current_user).returns(@user)
             end
 
             it "associates the upload with the user" do
               assert_difference "S3Relay::Upload.count", 1 do
-                post :create,
+                post s3_relay_uploads_url, params: {
                   association:  "photo_uploads",
                   uuid:         SecureRandom.uuid,
                   filename:     "cat.png",
                   content_type: "image/png"
+                }
               end
 
               assert_response 201
-
-              assigns[:upload].user_id.must_equal @user.id
+              body = JSON.parse(response.body)
+              _(body["user_id"]).must_equal @user.id
             end
           end
 
@@ -119,15 +124,16 @@ module S3Relay
       describe "error" do
         it do
           assert_no_difference "S3Relay::Upload.count" do
-            post :create,
+            post s3_relay_uploads_url, params: {
               uuid:         SecureRandom.uuid,
               filename:     "cat.png",
               content_type: "image/png"
+            }
           end
 
           assert_response 422
 
-          JSON.parse(response.body)["errors"]["upload_type"]
+          _(JSON.parse(response.body)["errors"]["upload_type"])
             .must_include "can't be blank"
         end
       end

data/test/dummy/{README.rdoc → README.md}

@@ -1,4 +1,4 @@
-== README
+# README
 
 This README would normally document whatever steps are necessary to get the
 application up and running.
@@ -22,7 +22,3 @@ Things you may want to cover:
 * Deployment instructions
 
 * ...
-
-
-Please feel free to use a different markup language if you do not plan to run
-<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -1,6 +1,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require_relative 'config/application'
 
 Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/javascripts/application.js

@@ -1,13 +1,15 @@
 // This is a manifest file that'll be compiled into application.js, which will include all the files
 // listed below.
 //
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, or any plugin's
+// vendor/assets/javascripts directory can be referenced here using a relative path.
 //
 // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
 //
-// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
+//= require rails-ujs
+//= require turbolinks
 //= require_tree .

data/test/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/test/dummy/app/assets/stylesheets/application.css

@@ -2,13 +2,13 @@
  * This is a manifest file that'll be compiled into application.css, which will include all the files
  * listed below.
  *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
  *
  * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
  *
  *= require_tree .
  *= require_self

data/test/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/test/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -1,5 +1,3 @@
 class ApplicationController < ActionController::Base
-  # Prevent CSRF attacks by raising an exception.
-  # For APIs, you may want to use :null_session instead.
   protect_from_forgery with: :exception
 end

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/test/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/test/dummy/app/models/product.rb

@@ -1,4 +1,4 @@
-class Product < ActiveRecord::Base
+class Product < ApplicationRecord
 
   s3_relay :icon_upload
   s3_relay :photo_uploads, has_many: true

data/test/dummy/app/views/layouts/application.html.erb

@@ -1,14 +1,14 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
-  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
 
-<%= yield %>
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
 
-</body>
+  <body>
+    <%= yield %>
+  </body>
 </html>

data/test/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>