s3_multipart 0.0.2

data/.gitignore

@@ -0,0 +1,6 @@
+/tmp
+.DS_Store
+
+# ignore files containing sensitive info
+config.ru
+/spec/setup_credentials.rb

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,26 @@
+source 'https://rubygems.org'
+
+
+
+group :development do
+  gem 'activerecord'
+  gem 'sqlite3'
+  gem 'actionpack' # action_controller, action_view
+  gem 'sprockets'
+  gem "rails"
+  gem "sqlite3"
+  
+  # tests
+  gem 'combustion', '~> 0.3.3'
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'capybara'
+
+  # assets
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+  gem 'compass-rails'
+
+  gemspec
+
+end

data/Gemfile.lock

@@ -0,0 +1,177 @@
+PATH
+  remote: .
+  specs:
+    s3_multipart (0.0.1)
+      uuid
+      xml-simple
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.9)
+      actionpack (= 3.2.9)
+      mail (~> 2.4.4)
+    actionpack (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+    activerecord (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.3.2)
+    arel (3.0.2)
+    builder (3.0.4)
+    capybara (2.0.1)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 1.0.0)
+    childprocess (0.3.6)
+      ffi (~> 1.0, >= 1.0.6)
+    chunky_png (1.2.6)
+    coffee-rails (3.2.2)
+      coffee-script (>= 2.2.0)
+      railties (~> 3.2.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.4.0)
+    combustion (0.3.3)
+      rails (>= 3.0.0)
+      thor (>= 0.14.6)
+    compass (0.12.2)
+      chunky_png (~> 1.2)
+      fssm (>= 0.2.7)
+      sass (~> 3.1)
+    compass-rails (1.0.3)
+      compass (>= 0.12.2, < 0.14)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    execjs (1.4.0)
+      multi_json (~> 1.0)
+    ffi (1.2.0)
+    fssm (0.2.9)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.5)
+    libwebsocket (0.1.7.1)
+      addressable
+      websocket
+    macaddr (1.6.1)
+      systemu (~> 2.5.0)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.5.0)
+    nokogiri (1.5.6)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.9)
+      actionmailer (= 3.2.9)
+      actionpack (= 3.2.9)
+      activerecord (= 3.2.9)
+      activeresource (= 3.2.9)
+      activesupport (= 3.2.9)
+      bundler (~> 1.0)
+      railties (= 3.2.9)
+    railties (3.2.9)
+      actionpack (= 3.2.9)
+      activesupport (= 3.2.9)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    rspec-rails (2.12.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rubyzip (0.9.9)
+    sass (3.2.3)
+    sass-rails (3.2.5)
+      railties (~> 3.2.0)
+      sass (>= 3.1.10)
+      tilt (~> 1.3)
+    selenium-webdriver (2.27.2)
+      childprocess (>= 0.2.5)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    systemu (2.5.2)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.35)
+    uuid (2.3.6)
+      macaddr (~> 1.0)
+    websocket (1.0.6)
+    xml-simple (1.1.2)
+    xpath (1.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack
+  activerecord
+  capybara
+  coffee-rails (~> 3.2.1)
+  combustion (~> 0.3.3)
+  compass-rails
+  rails
+  rspec
+  rspec-rails
+  s3_multipart!
+  sass-rails (~> 3.2.3)
+  sprockets
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) Max Gillett
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# S3 Multipart
+
+The S3 Multipart gem brings direct multipart uploading to S3 to Rails. Data is piped from the client straight to Amazon S3 and a callback is run when the upload is complete.
+
+Multipart uploading allows files to be split into many chunks and uploaded in parallel or succession (or both). This can result in dramatically increased upload speeds for the client and allows for the pausing and resuming of uploads. For a more complete overview of multipart uploading as it applies to S3, see the overview [here](http://docs.amazonwebservices.com/AmazonS3/latest/dev/mpuoverview.html). 
+
+## Setup
+
+Install the gem
+
+```bash
+gem install s3_multipart
+```
+
+Install the included migrations. This will create a table in your database to track initiated and completed uploads
+
+```bash
+rake s3_multipart:install:migrations
+```
+
+Add the following to your routes file:
+
+```ruby
+mount S3Multipart::Engine => "/s3_multipart"
+```
+
+If you are using sprockets, add the following to your application.js file. Make sure that the underscore and jquery libraries have been required before this line.
+
+```ruby
+//= require s3_multipart/s3_multipart
+```
+
+Also in your application.js file you will need to include the following:
+
+```javascript
+$(function() {
+  $(".submit-button").click(function() { // The button class passed into multipart_uploader_form (see "Getting Started")
+    new window.S3MP({
+      bucket: "YOUR_S3_BUCKET"
+      fileSelector: "#uploader", // The input name passed into multipart_uploader_form (see "Getting Started")
+      onComplete: function(num) {
+        console.log("File "+num+" successfully uploaded")
+      },
+      onPause: function(num) {
+        console.log("File "+num+" has been paused")
+      },
+      onCancel: function(num) {
+        console.log("File upload "+num+" was canceled")
+      },
+      onError: function(err) {
+        console.log("There was an error")
+      },
+      onProgress: function(num, size, done, percent, speed) {
+        console.log("File %d is %f percent done (%f of %f total) and uploading at %s", num, percent, done, size, speed);
+      }
+    });
+  });
+});
+```
+
+This piece of code does some configuration and provides various callbacks that you can hook into.
+
+Finally, create an initializer in config/initializers with the following, adding in your credentials.
+
+```ruby
+S3Multipart.configure do |config|
+  config.bucket_name   = '#########'
+  config.s3_access_key = '#########'
+  config.s3_secret_key = '#########'
+end
+```
+
+## Getting Started
+
+S3_Multipart comes with two helper functions required in integrating uploads into your application.
+
+The `attach_uploader` function is available in your controllers. Call it from within a routed method, and pass in a block of code to be executed when the upload has completed successfully. The completed upload object has `location`, `upload_id`, `name`, and `key` attributes that can be accessed and manipulated. 
+
+```ruby
+def your_controller_method
+  attach_uploader do |upload|
+    # your code here
+  end
+end
+```
+
+The `multipart_uploader_form` function is a view helper, and generates the necessary input elements. It takes in a hash of allowed MIME types and a string of html to be interpolated between the generated file input element and submit button. 
+
+```ruby
+<%= multipart_uploader_form(types: ['video/mpeg'],
+                            input_name: 'uploader',
+                            button_class: 'submit-button',
+                            button_text: 'Upload selected videos',
+                            html: %Q{<button class="upload-button">Select a Video</button>}) %>
+```
+
+puts out this:
+
+```html
+<input accept="video/mpeg" id="uploader" name="uploader" type="file">
+<button class="submit-button">Upload selected videos</button>
+```
+
+## Contributing
+
+S3_Multipart is very much a work in progress. If you squash a bug, make enhancemenets, or write more tests, please submit a pull request. 

data/app/controllers/s3_multipart/application_controller.rb

@@ -0,0 +1,4 @@
+module S3Multipart
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/s3_multipart/uploads_controller.rb

@@ -0,0 +1,56 @@
+module S3Multipart
+  class UploadsController < ApplicationController
+    def create
+      begin
+        response = Upload.initiate(params)
+        upload = Upload.create(key: response["key"], upload_id: response["upload_id"], name: response["name"])
+        response["id"] = upload["id"]
+      rescue
+        response = {error: 'There was an error initiating the upload'}
+      ensure
+        render :json => response
+      end
+    end
+
+    def update
+      return complete_upload if params[:parts]
+      return sign_batch if params[:content_lengths]
+      return sign_part if params[:content_length]
+    end 
+
+    private 
+
+    def sign_batch
+      begin
+        response = Upload.sign_batch(params)
+      rescue
+        response = {error: 'There was an error in processing your upload'}
+      ensure
+        render :json => response
+      end
+    end
+
+    def sign_part
+      begin
+        response = Upload.sign_part(params)
+      rescue
+        response = {error: 'There was an error in processing your upload'}
+      ensure
+        render :json => response
+      end
+    end
+
+    def complete_upload
+      begin
+        response = Upload.complete(params)
+        upload = Upload.find_by_upload_id(params[:upload_id])
+        upload.update_attributes(location: response[:location])
+        upload.on_complete
+      rescue
+        response = {error: 'There was an error completing the upload'}
+      ensure
+        render :json => response
+      end
+    end
+  end
+end

data/app/models/s3_multipart/upload.rb

@@ -0,0 +1,10 @@
+module S3Multipart
+  class Upload < ::ActiveRecord::Base
+    class << self   
+      include S3Multipart::Uploader 
+      attr_accessor :on_complete_callback
+    end
+
+    attr_accessible :key, :upload_id, :name, :location
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+S3Multipart::Engine.routes.draw do
+  resources :uploads, :only => [:create, :update]
+end

data/db/migrate/20110727184726_create_s3_multipart_uploads.rb

@@ -0,0 +1,12 @@
+class CreateS3MultipartUploads < ActiveRecord::Migration
+  def change
+    create_table :s3_multipart_uploads do |t|
+      t.string :location
+      t.string :upload_id
+      t.string :key
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/lib/s3_multipart.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'active_record'
+require 'xmlsimple'
+require 'uuid'
+
+module S3Multipart
+
+  class << self
+
+    # Syntax:
+    #
+    # S3_Multipart.configure do |config|
+    #   config.s3_access_key = ''
+    #   config.s3_secret_key = ''
+    #   config.bucket_name   = ''
+    # end
+    def configure(&block)
+      S3Multipart::Uploader::Config.configure(block)
+    end
+
+    def remove_unfinished_uploads(seconds=60*60*24*10)
+      # remove multipart uploads older than specified amt of seconds
+    end
+
+  end
+
+  module ActionControllerHelpers
+
+    #
+    # Stores a code block in the Upload class that will be executed (and passed the
+    # completed upload object) when the on_complete method is called on an 
+    # instance of the Upload class
+    #
+    def attach_uploader(&block)
+      S3Multipart::Upload.class_eval do
+        self.on_complete_callback = block
+        def on_complete
+          Upload.on_complete_callback.call(self)
+        end
+      end
+    end
+
+  end
+
+end
+
+require 's3_multipart/railtie'
+require 's3_multipart/engine'
+require 's3_multipart/http/net_http'
+require 's3_multipart/uploader'
+require 's3_multipart/uploader/config'
+
+
+ActionController::Base.send(:include, S3Multipart::ActionControllerHelpers)