s3_multipart 0.0.10.4 → 0.0.10.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d98ae2406219c5a736d33bf323dfb675f2649e18
+  data.tar.gz: 790a0d7b0d2d42765c05474851eaffd773845a10
+SHA512:
+  metadata.gz: c5aec821b693decc4f4d86a4ef4a7fa000dfe3e3a051dc7567c42de585da0a97d466d7193b9b68cfec34e88f40ef62149959f9cacd7ea3b594bf39ad9b093c13
+  data.tar.gz: 3885d74fa41187e425cd4273d73bad593221937368efa238592efa5a31c24b2f781e479db623af403f4c97c940fed06335a2060151bf3a0e72f09a987bfcacfc

data/README.md

@@ -6,6 +6,8 @@ Multipart uploading allows files to be split into many chunks and uploaded in pa
 
 ## What's New
 
+**0.0.10.5** - See pull request [16](https://github.com/maxgillett/s3_multipart/pull/16) and [18](https://github.com/maxgillett/s3_multipart/pull/18) for detailed changes. 
+
 **0.0.10.4** - Fixed a race condition that led to incorrect upload progress feedback.
 
 **0.0.10.3** - Fixed a bug that prevented 5-10mb files from being uploaded correctly.

data/app/controllers/s3_multipart/uploads_controller.rb

@@ -8,8 +8,9 @@ module S3Multipart
         response = upload.to_json
       rescue FileTypeError, FileSizeError => e
         response = {error: e.message}
-      rescue 
-        response = {error: 'There was an error initiating the upload'}
+      rescue => e
+        logger.error "EXC: #{e.message}"
+        response = { error: t("s3_multipart.errors.create") }
       ensure
         render :json => response
       end
@@ -26,8 +27,9 @@ module S3Multipart
       def sign_batch
         begin
           response = Upload.sign_batch(params)
-        rescue
-          response = {error: 'There was an error in processing your upload'}
+        rescue => e
+          logger.error "EXC: #{e.message}"
+          response = {error: t("s3_multipart.errors.update")}
         ensure
           render :json => response
         end
@@ -36,8 +38,9 @@ module S3Multipart
       def sign_part
         begin
           response = Upload.sign_part(params)
-        rescue
-          response = {error: 'There was an error in processing your upload'}
+        rescue => e
+          logger.error "EXC: #{e.message}"
+          response = {error: t("s3_multipart.errors.update")}
         ensure
           render :json => response
         end
@@ -49,8 +52,9 @@ module S3Multipart
           upload = Upload.find_by_upload_id(params[:upload_id])
           upload.update_attributes(location: response[:location])
           upload.execute_callback(:complete, session)
-        rescue
-          response = {error: 'There was an error completing the upload'}
+        rescue => e
+          logger.error "EXC: #{e.message}"
+          response = {error: t("s3_multipart.errors.complete")}
         ensure
           render :json => response
         end

data/app/models/s3_multipart/upload.rb

@@ -1,8 +1,8 @@
 module S3Multipart
   class Upload < ::ActiveRecord::Base
     extend S3Multipart::TransferHelpers
+    include ActionView::Helpers::NumberHelper
 
-    attr_accessible :key, :upload_id, :name, :location, :uploader, :size
     before_create :validate_file_type, :validate_file_size
 
     def self.create(params)
@@ -17,7 +17,7 @@ module S3Multipart
       when :begin
         controller.on_begin_callback.call(self, session) if controller.on_begin_callback
       when :complete
-        controller.on_complete_callback.call(self, session) if controller.on_begin_callback
+        controller.on_complete_callback.call(self, session) if controller.on_complete_callback
       end
     end
 
@@ -26,16 +26,24 @@ module S3Multipart
       def validate_file_size
         size = self.size
         limits = deserialize(self.uploader).size_limits
-        raise FileSizeError, "File size is too small" if limits[:min] > size
-        raise FileSizeError, "File size is too large" if limits[:max] < size 
+
+        if limits.present?
+          if limits.key?(:min) && limits[:min] > size
+            raise FileSizeError, I18n.t("s3_multipart.errors.limits.min", min: number_to_human_size(limits[:min]))
+          end
+
+          if limits.key?(:max) && limits[:max] < size
+            raise FileSizeError, I18n.t("s3_multipart.errors.limits.max", max: number_to_human_size(limits[:max]))
+          end
+        end
       end
 
       def validate_file_type
         ext = self.name.match(/\.([a-zA-Z0-9]+)$/)[1]
-        controller = deserialize(self.uploader)
+        types = deserialize(self.uploader).file_types
 
-        if !controller.file_types.include?(ext)
-          raise FileTypeError, "File type not supported"
+        unless types.blank? || types.include?(ext)
+          raise FileTypeError, I18n.t("s3_multipart.errors.types", types: upload.deserialize(upload.uploader).file_types.join(", "))
         end
       end
 

data/config/locales/s3_multipart.en.yml

@@ -0,0 +1,10 @@
+en:
+  s3_multipart:
+    errors:
+      limits:
+        min: "Please choose a larger file (min %{min})"
+        max: "Please choose a smaller file (max %{max})"
+      types: "Please choose a different format (allowed types: %{types})"
+      create: "There was an error initiating the upload"
+      update: "There was an error processing the upload"
+      complete: "There was an error completing the upload"

data/lib/s3_multipart/transfer_helpers.rb

@@ -5,43 +5,45 @@ module S3Multipart
   module TransferHelpers
 
     def initiate(options)
-      real_name = options[:object_name]
-      unique_name = UUID.generate + real_name.match(/.[A-Za-z0-9]+$/)[0] # clean this up later
-      url = "/#{unique_name}?uploads"
+      url = "/#{unique_name(options)}?uploads"
 
       headers = {content_type: options[:content_type]}
-      headers[:authorization], headers[:date] = sign_request verb: 'POST', url: url, content_type: options[:content_type]
+      headers.merge!(options[:headers]) if options.key?(:headers)
+      headers[:authorization], headers[:date] = sign_request verb: 'POST',
+                                                             url: url,
+                                                             content_type: options[:content_type],
+                                                             headers: options[:headers]
 
-      response = Http.post url, {headers: headers}
+      response = Http.post url, headers: headers
       parsed_response_body = XmlSimple.xml_in(response.body)  
 
-      return { "key"  => parsed_response_body["Key"][0],
-               "upload_id"   => parsed_response_body["UploadId"][0],
-               "name" => real_name }
+      { "key"  => parsed_response_body["Key"][0],
+        "upload_id"   => parsed_response_body["UploadId"][0],
+        "name" => options[:object_name] }
     end
 
     def sign_batch(options)
-      parts = options[:content_lengths].split('-').each_with_index.map do |len, i|
+      parts = options[:content_lengths].to_s.split('-').each_with_index.map do |len, i|
         sign_part(options.merge!({content_length: len, part_number: i+1}))
       end
     end
 
     def sign_part(options)
       url = "/#{options[:object_name]}?partNumber=#{options[:part_number]}&uploadId=#{options[:upload_id]}"
-      authorization, date = sign_request verb: 'PUT', url: url, content_length: options[:content_length]
+      authorization, date = sign_request verb: 'PUT', url: URI.escape(url), content_length: options[:content_length]
       
-      return {authorization: authorization, date: date}
+      { authorization: authorization, date: date }
     end
 
     def complete(options)
       options[:content_type] = "application/xml"
 
-      url = "/#{options[:object_name]}?uploadId=#{options[:upload_id]}"
+      url = URI.escape("/#{options[:object_name]}?uploadId=#{options[:upload_id]}")
       
       body = format_part_list_in_xml(options)
       headers = { content_type: options[:content_type],
                   content_length: options[:content_length] }
-                
+
       headers[:authorization], headers[:date] = sign_request verb: 'POST', url: url, content_type: options[:content_type]
 
       response = Http.post url, {headers: headers, body: body}
@@ -55,19 +57,49 @@ module S3Multipart
     end
 
     def sign_request(options)
-      #options.default = ""
-      time = Time.now.strftime("%a, %d %b %Y %T %Z")
+      time = Time.now.utc.strftime("%a, %d %b %Y %T %Z")
+      [calculate_authorization_hash(time, options), time]
+    end
+
+    def unique_name(options)
+      url = [UUID.generate, options[:object_name]].join("/")
+      controller = S3Multipart::Uploader.deserialize(options[:uploader])
 
-      return [calculate_authorization_hash(time, options), time]
+      if controller.mount_point && defined?(CarrierWaveDirect)
+        uploader = controller.model.to_s.classify.constantize.new.send(controller.mount_point)
+
+        if uploader.class.ancestors.include?(CarrierWaveDirect::Uploader)
+          url = uploader.key.sub(/#{Regexp.escape(CarrierWaveDirect::Uploader::FILENAME_WILDCARD)}\z/, options[:object_name])
+        end
+      end
+
+      URI.escape(url)
     end
 
     private
 
       def calculate_authorization_hash(time, options)
         date = String.new(time)
-        date.insert(0, "\nx-amz-date:") if from_upload_part?(options) && options[:parts].nil?
+        request_parts = [ options[:verb],
+                       "", # optional content md5
+                       options[:content_type]]
+
+        headers = options[:headers] || {}
+
+        if from_upload_part?(options) && options[:parts].nil?
+          request_parts << "" # skip date as it's present as an x-amz- header
+          headers["x-amz-date"] = date
+        else
+          request_parts << date
+        end
+
+        if headers.present?
+          canonicalized_headers = headers.keys.sort.inject([]) {|array,k| array.push "#{k}:#{headers[k]}"}.join("\n")
+          request_parts << canonicalized_headers
+        end
 
-        unsigned_request = "#{options[:verb]}\n\n#{options[:content_type]}\n#{date}\n/#{Config.instance.bucket_name}#{options[:url]}" 
+        request_parts << "/#{Config.instance.bucket_name}#{options[:url]}"
+        unsigned_request = request_parts.join("\n")
         signature = Base64.strict_encode64(OpenSSL::HMAC.digest('sha1', Config.instance.s3_secret_key, unsigned_request))
         
         authorization = "AWS" + " " + Config.instance.s3_access_key + ":" + signature

data/lib/s3_multipart/uploader.rb

@@ -27,13 +27,18 @@ module S3Multipart
       include S3Multipart::Uploader::Callbacks
       include S3Multipart::Uploader::Validations
 
+      attr_accessor :mount_point, :model
+
       def self.extended(klass)
         Uploader.controllers[klass.to_s.to_sym] = Digest::SHA1.hexdigest(klass.to_s)
       end
 
-      def attach(model)
+      def attach(model, options = {})
+        self.mount_point = options.delete(:using)
+        self.model = model
+
         S3Multipart::Upload.class_eval do
-          has_one(model)
+          has_one(model, options)
         end
       end
 

data/lib/s3_multipart/version.rb

@@ -1,5 +1,5 @@
 module S3Multipart
-  VERSION = "0.0.10.4"
+  VERSION = "0.0.10.5"
   BREAKING_CHANGES = {
     :"0.0.10.2" => 'Modifications made to the database table used by the gem are now handled by migrations. If you are upgrading versions, run `rails g s3_multipart:install_new_migrations` followed by `rake db:migrate`. Fresh installs do not require subsequent migrations. The current version must now also be passed in to the gem\'s configuration function to alert you of breaking changes. This is done by setting a revision yml variable. See the section regarding the aws.yml file in the readme section below (just before "Getting Started").'
   }

data/vendor/assets/javascripts/s3_multipart/lib.js

@@ -19,6 +19,7 @@ function S3MP(options) {
     , S3MP = this;
 
   _.extend(this, options);
+  this.headers = _.object(_.map(options.headers, function(v,k) { return ["x-amz-" + k.toLowerCase(), v] }));
 
   this.uploadList = [];
 
@@ -32,7 +33,7 @@ function S3MP(options) {
       var i = [];
       function beginUpload(pipes, uploadObj) {
         var key = uploadObj.key
-          , num_parts = uploadObj.parts.length
+          , num_parts = uploadObj.parts.length;
 
         if (typeof i[key] === "undefined") {
           i[key] = 0;
@@ -61,6 +62,7 @@ function S3MP(options) {
       var parts, i, ETag;
 
       parts = uploadObj.parts;
+      finished_part.status = "complete";
 
       // Append the ETag (in the response header) to the ETags array
       ETag = finished_part.xhr.getResponseHeader("ETag");
@@ -155,12 +157,6 @@ function S3MP(options) {
   }
 
   _.each(files, function(file, key) {
-    if (file.size < 5000000) {
-      return S3MP.onError({name: "FileSizeError", message: "File size is too small"})
-      // This should still work. The multipart API just can't be used b/c Amazon doesn't allow 
-      // multipart file uploads that are less than 5 mb in size.
-    }
-
     var upload = new Upload(file, S3MP, key);
     S3MP.uploadList.push(upload);
     upload.init();
@@ -175,6 +171,7 @@ S3MP.prototype.initiateMultipart = function(upload, cb) {
   body = JSON.stringify({ object_name  : upload.name,
                           content_type : upload.type,
                           content_size : upload.size,
+                          headers      : this.headers,
                           uploader     : $(this.fileInputElement).data("uploader")
                         });
 
@@ -190,7 +187,7 @@ S3MP.prototype.signPartRequests = function(id, object_name, upload_id, parts, cb
     return memo + "-" + part.size;
   }, parts[0].size);
 
-  url = "s3_multipart/uploads/"+id;
+  url = "/s3_multipart/uploads/"+id;
   body = JSON.stringify({ object_name     : object_name,
                           upload_id       : upload_id,
                           content_lengths : content_lengths
@@ -203,7 +200,7 @@ S3MP.prototype.signPartRequests = function(id, object_name, upload_id, parts, cb
 S3MP.prototype.completeMultipart = function(uploadObj, cb) {
   var url, body, xhr;
 
-  url = 's3_multipart/uploads/'+uploadObj.id;
+  url = '/s3_multipart/uploads/'+uploadObj.id;
   body = JSON.stringify({ object_name    : uploadObj.object_name,
                           upload_id      : uploadObj.upload_id,
                           content_length : uploadObj.size,
@@ -224,7 +221,7 @@ S3MP.prototype.deliverRequest = function(xhr, body, cb) {
     if (response.error) { 
       return self.onError({
         name: "ServerResponse",
-        message: "The server responded with an error"
+        message: response.error
       });  
     }
     cb(response);
@@ -406,12 +403,8 @@ function Upload(file, o, key) {
 
         upload.signPartRequests(id, object_name, upload_id, parts, function(response) {
           _.each(parts, function(part, key) {
-            var xhr = part.xhr;
-
-            xhr.open('PUT', 'http://'+upload.bucket+'.s3.amazonaws.com/'+object_name+'?partNumber='+part.num+'&uploadId='+upload_id, true);
-            xhr.setRequestHeader('x-amz-date', response[key].date);
-            xhr.setRequestHeader('Authorization', response[key].authorization);
-
+            part.date = response[key].date;
+            part.auth = response[key].authorization;
             // Notify handler that an xhr request has been opened
             upload.handler.beginUpload(pipes, upload);
           });
@@ -433,6 +426,7 @@ function UploadPart(blob, key, upload) {
   this.size = blob.size;
   this.blob = blob;
   this.num = key;
+  this.upload = upload;
 
   this.xhr = xhr = upload.createXhrRequest();
   xhr.onload = function() {
@@ -442,7 +436,7 @@ function UploadPart(blob, key, upload) {
     upload.handler.onError(upload, part);
   };
   xhr.upload.onprogress = _.throttle(function(e) {
-    if (upload.inprogress[key] != 0) {
+    if (e.lengthComputable) {
       upload.inprogress[key] = e.loaded;
     }
   }, 1000);
@@ -450,6 +444,10 @@ function UploadPart(blob, key, upload) {
 };
 
 UploadPart.prototype.activate = function() { 
+  this.xhr.open('PUT', 'http://'+this.upload.bucket+'.s3.amazonaws.com/'+this.upload.object_name+'?partNumber='+this.num+'&uploadId='+this.upload.upload_id, true);
+  this.xhr.setRequestHeader('x-amz-date', this.date);
+  this.xhr.setRequestHeader('Authorization', this.auth);
+
   this.xhr.send(this.blob);
   this.status = "active";
 };
@@ -463,4 +461,4 @@ return S3MP;
 
   }());
 
-}(this));
+}(this));

metadata

@@ -1,52 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: s3_multipart
 version: !ruby/object:Gem::Version
-  version: 0.0.10.4
-  prerelease: 
+  version: 0.0.10.5
 platform: ruby
 authors:
 - Max Gillett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-07 00:00:00.000000000 Z
+date: 2014-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.6
 - !ruby/object:Gem::Dependency
   name: xml-simple
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,84 +55,74 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'See github for installation and configuration '
+description: 'See github for installation and configuration '
 email:
 - max.gillett@gmail.com
 executables: []
@@ -156,6 +139,7 @@ files:
 - app/controllers/s3_multipart/application_controller.rb
 - app/controllers/s3_multipart/uploads_controller.rb
 - app/models/s3_multipart/upload.rb
+- config/locales/s3_multipart.en.yml
 - config/routes.rb
 - grunt.js
 - javascripts/footer.js
@@ -281,26 +265,25 @@ files:
 - vendor/assets/javascripts/s3_multipart/lib.min.js
 homepage: https://github.com/maxgillett/s3_multipart
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Upload directly to S3 using multipart uploading
 test_files: []