rack-large-uploads 0.0.1

data/.gemset

@@ -0,0 +1 @@
+RVM_GEMSET="ruby-1.9.3@rack-large-uploads"

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rvmrc

@@ -0,0 +1,11 @@
+source .gemset
+export USE_BUNDLER=force
+
+rvm use --create --install $RVM_GEMSET
+
+if [[ -s "./bootstrap.gems" ]]; then
+  if ! rvm gemset import bootstrap.gems > /dev/null 2>&1; then
+    echo "ERROR: Unable to bootstrap the gems" >&2
+  fi
+fi
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-large-uploads.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Corey Innis
+
+MIT License
+
+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,87 @@
+# Rack::LargeUploads
+
+Rack middleware for handling large file uploads.Integrates nicely with the
+Nginx upload module: http://www.grid.net.ru/nginx/upload.en.html
+
+Includes `Rack::LargeUploads::UploadedFile`, which matches the definition of
+`ActionDispatch::Http::UploadedFile`.  So, little-to-no change should be
+required when using, e.g., Rails.
+
+Based largely on the [`Rack::Uploads` middleware](https://github.com/mutle/rack-uploads),
+but with greater expectations regarding conventions, and specific support for
+large files (dealing with memory issues).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-large-uploads'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-large-uploads
+
+## Usage
+
+example middleware configuration:
+
+    use Rack::LargeUploads do
+      before do |files|
+        # process uploaded files *before* application handling
+      end
+
+      after do |files|
+        # process uploaded files *after* application handling
+      end
+    end
+
+example nginx configuration:
+
+    location / {
+      try_files $document_root/system/maintenance.html $uri $uri/index.html $uri.html @application;
+    }
+
+    location = /uploads {
+      # depends on the nginx upload module (http://www.grid.net.ru/nginx/upload.en.html)
+      upload_pass         @application;
+
+      # NOTE: if there is no upload file in the request, nginx generates a 405.
+      # use that to pass the request on to the endpoint, instead of try_files
+      # which fails to play nicely with upload_pass.
+      #
+      # credit:
+      # http://www.nickager.com/blog/File-upload-using-Nginx-and-Seaside---step-1
+      error_page          405 415 = @application;
+
+      upload_store        /path/to/app/tmp/uploads 1;
+      upload_store_access user:rw group:rw all:rw;
+
+      upload_pass_args       on;         # NOTE: handles URI params, not form content.
+      upload_pass_form_field "^[a-z_].*"; # ...and here is how we resolve that last.
+
+      # match the request params expected by ActionDispatch
+      upload_set_form_field "$upload_field_name[filename]"   "$upload_file_name";
+      upload_set_form_field "$upload_field_name[type]"       "$upload_content_type";
+      upload_set_form_field "$upload_field_name[tempfile]"   "$upload_tmp_path";
+
+      upload_aggregate_form_field "$upload_field_name[md5]"  "$upload_file_md5";
+      upload_aggregate_form_field "$upload_field_name[size]" "$upload_file_size";
+    }
+
+    location @application {
+      proxy_pass  http://upstream_application;
+
+      # more config...
+    }
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = '-Ispec'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rspec_opts = '-Ispec'
+  spec.rcov       = true
+end
+
+task :default => :spec

data/bootstrap.gems

@@ -0,0 +1,2 @@
+bundler -v 1.1.3
+

data/lib/rack-large-uploads.rb

@@ -0,0 +1 @@
+require 'rack/large-uploads'

data/lib/rack/large-uploads.rb

@@ -0,0 +1,103 @@
+require "rack/large-uploads/version"
+
+# TODO: remove these dependencies:
+require "action_dispatch"
+require "active_support/core_ext"
+
+module Rack
+  class LargeUploads
+    autoload :UploadedFile, 'rack/large-uploads/uploaded_file'
+
+    def initialize(app, options = {}, &block)
+      @app     = app
+      @filters = {}
+
+      if block
+        if block.arity == 1
+          block.call(self)
+        else
+          instance_eval(&block)
+        end
+      end
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+
+      if request.post? && request.form_data?
+        files = extract_files(request, request.params)
+      end
+
+      filter(:before, files) if files.present?
+      response = @app.call(env)
+      filter(:after, files) if files.present?
+
+      response
+    end
+
+    def before(&block)
+      @filters[:before] = block
+    end
+
+    def after(&block)
+      @filters[:after] = block
+    end
+
+    private
+
+      def filter(position, files)
+        @filters[position] && @filters[position].call(files)
+      end
+
+      def extract_files(request, params, files = [])
+        params.each do |key, value|
+          if file = file_from(request, key, value)
+            files << replace_param(params, key, file)
+          elsif value.is_a?(Hash)
+            files = extract_files(request, value, files)
+          end
+        end
+
+        files
+      end
+
+      def file_from(request, key, value)
+        # direct to rails...
+        # ----->
+        #   key: file,
+        #   value: {
+        #     :filename =>"file.mov",
+        #     :type     =>"video/quicktime",
+        #     :tempfile =>#<File:/var/folders/xn/x665dh2j6qx_t7w5bqcsfgcr0000gn/T/RackMultipart20120330-11052-1ysyd0c>,
+        #     :name     =>"video[file]",
+        #     :head     =>"Content-Disposition: form-data; name=\"video[file]\"; filename=\"file.mov\"\r\nContent-Type: video/quicktime\r\n"
+        #   }
+
+        # with nginx upload (configured per README)...
+        # ----->
+        #   key: file,
+        #   value: {
+        #     "filename"=>"file.mov",
+        #     "type"    =>"video/quicktime",
+        #     "tempfile"=>"/path/to/app/tmp/uploads/1/0000000001",
+        #     "md5"     =>"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+        #     "size"    =>"5242880000"
+        #   }
+        if value.is_a?(Hash)
+          attributes = HashWithIndifferentAccess.new(value)
+          tempfile   = attributes[:tempfile]
+
+          if tempfile.present?
+            tempfile = ::File.new(tempfile) if tempfile.is_a?(String)
+            return Rack::LargeUploads::UploadedFile.new(attributes.merge({ :tempfile => tempfile }))
+          end
+        end
+
+        nil
+      end
+
+      def replace_param(params, key, file)
+        params[key] = file
+      end
+  end
+end

data/lib/rack/large-uploads/uploaded_file.rb

@@ -0,0 +1,31 @@
+module Rack
+  class LargeUploads
+    class UploadedFile < ActionDispatch::Http::UploadedFile
+      def initialize(hash)
+        @uploaded_md5  = hash.delete(:md5)
+        @uploaded_size = hash.delete(:size)
+        super(hash)
+        @uploaded_path = path
+      end
+
+      def clean!(nilify = true)
+        raise "No such file or directory - #{@uploaded_path}" unless present?
+        ::File.delete(@tempfile.path)
+
+        # NOTE: it appears that an open file descriptor (or similar) remains
+        # after the file is removed on the filesystem.  in most cases, we
+        # should expect to be unable to interact with the file after cleaning,
+        # but we make it optionally allowed.
+        if nilify
+          @tempfile = nil
+        end
+
+        self
+      end
+
+      def present?
+        @tempfile != nil
+      end
+    end
+  end
+end

data/lib/rack/large-uploads/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class LargeUploads
+    VERSION = "0.0.1"
+  end
+end

data/rack-large-uploads.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rack/large-uploads/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Corey Innis"]
+  gem.email         = ["corey@coolerator.net"]
+  gem.description   = %q{Rack middleware for handling large file uploads. Integrates nicely with the Nginx upload module: http://www.grid.net.ru/nginx/upload.en.html}
+  gem.summary       = %q{Rack middleware for handling large file uploads}
+  gem.homepage      = "https://github.com/coreyti/rack-large-uploads"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rack-large-uploads"
+  gem.require_paths = ["lib"]
+  gem.version       = Rack::LargeUploads::VERSION
+
+  gem.required_ruby_version = ">= 1.9"
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rr"
+  gem.add_development_dependency "simplecov"
+
+  # TODO: remove dependencies on these:
+  gem.add_runtime_dependency "actionpack"
+  gem.add_runtime_dependency "activesupport"
+end

data/spec/rack/large-uploads_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Rack::LargeUploads do
+  it "is defined" do
+    Rack::LargeUploads.should be_a(Class)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler'
+
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rack/large-uploads'
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each do
+  |f| require f
+end
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: rack-large-uploads
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Corey Innis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70180264879460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70180264879460
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70180264895180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70180264895180
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70180264894620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70180264894620
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70180264894040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70180264894040
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70180264893460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70180264893460
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &70180264892740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70180264892740
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70180264892100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70180264892100
+description: ! 'Rack middleware for handling large file uploads. Integrates nicely
+  with the Nginx upload module: http://www.grid.net.ru/nginx/upload.en.html'
+email:
+- corey@coolerator.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemset
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bootstrap.gems
+- lib/rack-large-uploads.rb
+- lib/rack/large-uploads.rb
+- lib/rack/large-uploads/uploaded_file.rb
+- lib/rack/large-uploads/version.rb
+- rack-large-uploads.gemspec
+- spec/rack/large-uploads_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/coreyti/rack-large-uploads
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1884482723306409026
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Rack middleware for handling large file uploads
+test_files:
+- spec/rack/large-uploads_spec.rb
+- spec/spec_helper.rb