rack-uploads 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mutwin Kraus
+
+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.rdoc

@@ -0,0 +1,60 @@
+= rack-uploads
+
+rack-uploads is a middleware which receives uploads and stores them in
+in the Rack env for easy access.
+
+It works with normal HTTP file uploads, as well as with the Nginx Upload
+Module.
+
+All multipart params get replaced by a Rack::Uploads::UploadedFile, while
+still retaining access to the original parameter value.
+
+== Dependencies
+
+Development dependencies:
+
+* rspec
+* rack-test
+
+== Usage
+
+=== Sinatra
+
+  use Rack::Uploads
+
+  post "/uploads" do
+    env['rack.uploads'].each do |upload|
+      upload.mv('/some/path/#{upload.filename}')
+    end
+  end
+
+=== Rails
+
+  # config/environment.rb
+  config.middleware.use "Rack::Uploads"
+
+  # app/controller/uploads_controller.rb
+  class UploadsController < ApplicationController
+    def create
+      request['rack.uploads'].each do |upload|
+        upload.mv("#{RAILS_ROOT}/public/uploads/#{upload.filename}")
+      end
+    end
+  end
+
+== Options
+
+There are a few options you can pass to rack-uploads during
+initializiation:
+
+<tt>:session_authorized => lambda { |req| req.params['secret'] == "sekrit"
+}</tt> -
+Only allow uploads with the parameter "secret" set to "sekrit"
+
+<tt>:nginx => [{ :tmp_path => "_tmp_path", :filename => "_file_name" }]</tt> - 
+Sets the suffixes of the nginx upload parameters
+
+
+== Copyright
+
+Copyright (c) 2009 Mutwin Kraus. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-uploads"
+    gem.summary = %Q{Rack Upload handler with Nginx Upload Module support}
+    gem.email = "mutle@blogage.de"
+    gem.homepage = "http://github.com/mutle/rack-uploads"
+    gem.authors = ["Mutwin Kraus"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-uploads #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require "rack/uploads"

data/lib/rack/uploads/middleware.rb

@@ -0,0 +1,56 @@
+module Rack
+  class Uploads
+
+    def initialize(app, options={})
+      @app = app
+      @session_authorized = options[:session_authorized] || true
+      @nginx = options[:nginx] || [{ :tmp_path => "_tmp_path", :filename => "_file_name" }]
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+      if req.post? && req.form_data?
+        return not_authorized unless @session_authorized == true || (@session_authorized.respond_to?(:call) && @session_authorized.call(req) == true)
+        uploads = []
+        req.params.each do |key,param|
+          if param_file = file(req, key)
+            uploads << param_file
+            req.params[key] = param_file
+          end
+        end
+        env['rack.uploads'] = uploads if uploads.size > 0
+      end
+      resp = @app.call(env)
+      if uploads && uploads.size > 0
+        uploads.each { |upload| upload.cleanup }
+      end
+      resp
+    end
+
+    def multipart?(req)
+      req.media_type == "multipart/form-data"
+    end
+
+    def file(req, key)
+      param = req.params[key]
+      return UploadedFile.new(key, param) if param.instance_of?(Hash) && param[:tempfile]
+      @nginx.each do |nginx|
+        if key =~ %r{^(.+)#{nginx[:tmp_path]}$}
+          tmp_path = param
+          filename = req.params["#{$1}#{nginx[:filename]}"]
+          return UploadedNginxFile.new($1, {:filename => filename, :temp_path => tmp_path}) if ::File.exist?(tmp_path) && filename
+        end
+      end
+      nil
+    end
+
+    def invalid_request
+      [400, {}, 'Invalid Request']
+    end
+
+    def not_authorized
+      [403, {}, 'Not Authorized']
+    end
+
+  end
+end

data/lib/rack/uploads/uploaded_file.rb

@@ -0,0 +1,58 @@
+module Rack
+  class Uploads
+
+    class UploadedFile
+      attr_reader :key, :file
+      def initialize(key, file)
+        @key = key
+        @file = file
+        @cleanup_needed = false
+      end
+
+      def temp_path
+        @file[:tempfile].path
+      end
+
+      def mv(destination)
+        FileUtils.mv(temp_path, destination)
+        @cleanup_needed = false
+      end
+
+      def cp(destination)
+        FileUtils.cp(temp_path, destination)
+      end
+
+      def rm
+        FileUtils.rm(temp_path)
+      end
+
+      def size
+        ::File.size(temp_path)
+      end
+
+      def [](key)
+        @file[key]
+      end
+
+      def method_missing(meth, *args)
+        return @file[meth.to_sym] if @file[meth.to_sym]
+        super(meth, *args)
+      end
+
+      def cleanup
+        rm if @cleanup_needed
+      end
+    end
+
+    class UploadedNginxFile < UploadedFile
+      def initialize(key, file)
+        super(key, file)
+        @cleanup_needed = true
+      end
+      def temp_path
+        @file[:temp_path]
+      end
+    end
+
+  end
+end

data/lib/rack/uploads.rb

@@ -0,0 +1 @@
+%w(middleware uploaded_file).each { |f| require File.join(File.dirname(__FILE__), "uploads", f) }

data/rack-uploads.gemspec

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-uploads}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mutwin Kraus"]
+  s.date = %q{2009-06-13}
+  s.email = %q{mutle@blogage.de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/rack/uploads.rb",
+     "lib/rack/uploads/middleware.rb",
+     "lib/rack/uploads/uploaded_file.rb",
+     "rack-uploads.gemspec",
+     "spec/fixtures/files/test_data.txt",
+     "spec/middleware_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/uploaded_file_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/mutle/rack-uploads}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Rack Upload handler with Nginx Upload Module support}
+  s.test_files = [
+    "spec/middleware_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/uploaded_file_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/fixtures/files/test_data.txt

@@ -0,0 +1,3 @@
+test test test
+test test test
+test test test

data/spec/middleware_spec.rb

@@ -0,0 +1,111 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+require 'rack/test'
+require 'rack/utils'
+require 'rack/mock'
+
+describe Rack::Uploads do
+
+  include Rack::Test::Methods
+
+  def hello_world
+    lambda { |env| 
+      req = Rack::Request.new(env)
+      if req.path_info == "/uploads" && req.post? && env['rack.uploads']
+        [200, {}, "Received #{env['rack.uploads'].size} Files"]
+      else
+        [200, {}, "Hello, World!"]
+      end
+    }
+  end
+
+
+  def user_session
+    {"rack.session" => {:user_id => 100}}
+  end
+
+  context "file uploads" do
+
+    def app
+      @backend ||= Rack::Uploads.new(hello_world)
+    end
+
+    it "should receive a file upload" do
+      post '/uploads', {:file => multipart_fixture("test_data.txt"), "foo[bar]" => multipart_fixture("test_data.txt")}
+      last_response.status.should == 200
+      last_response.body.should == "Received 2 Files"
+    end
+
+    it "should receive a flash upload" do
+      post '/uploads', {'Filedata' => multipart_fixture("test_data.txt")}
+      last_response.status.should == 200
+      last_response.body.should == "Received 1 Files"
+    end
+
+    it "should receive a nginx upload" do
+      file = multipart_fixture("test_data.txt")
+      post '/uploads', nginx_upload_request("file", "test_data.txt")
+      last_response.status.should == 200
+      last_response.body.should == "Received 1 Files"
+    end
+
+    it "should cleanup received nginx uploads" do
+      file = multipart_fixture("test_data.txt")
+      post '/uploads', nginx_upload_request("file", "test_data.txt")
+      File.exist?("/tmp/rack_upload_nginx_tmp").should be_false
+    end
+
+  end
+
+  context "authorization" do
+    def app
+      Rack::Uploads.new(hello_world, {:session_authorized => lambda {  |req| (req.env['rack.session'] && req.env['rack.session'][:user_id] && req.env['rack.session'][:user_id].to_i > 0) || (req.params['flash_token'] && req.params['flash_token'] == '123') }})
+    end
+
+    it "should not respond to non-post requests" do
+      get '/uploads'
+      last_response.status.should == 200
+      last_response.body.should == "Hello, World!"
+      put '/uploads'
+      last_response.status.should == 200
+      last_response.body.should == "Hello, World!"
+      delete '/uploads'
+      last_response.status.should == 200
+      last_response.body.should == "Hello, World!"
+    end
+
+    it "should not allow unauthorized uploads" do
+      post '/uploads'
+      last_response.status.should == 403
+    end
+
+    it "should authorize logged in users to upload" do
+      response = post '/uploads', {}, user_session
+      last_response.status.should_not == 400
+      last_response.status.should_not == 403
+    end
+
+    it "should authorize flash uploaders to upload" do
+      response = post '/uploads?flash_token=123'
+      last_response.status.should_not == 400
+      last_response.status.should_not == 403
+    end
+
+  end
+
+  private
+  def nginx_upload_request(key, name, temp_path="/tmp/rack_upload_nginx_tmp")
+    FileUtils.cp multipart_file(name), temp_path
+    {"#{key}_tmp_path" => temp_path, "#{key}_file_name" => name, "#{key}_content_type" => "text/plain", "#{key}_size" => File.size(multipart_file(name))}
+  end
+
+  def multipart_fixture(name)
+    Rack::Test::UploadedFile.new(multipart_file(name))
+  end
+
+  def multipart_file(name)
+    File.join(File.dirname(__FILE__), "fixtures/files", name)
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'spec'
+require 'rack'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack/uploads'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/uploaded_file_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+require 'rack/test'
+require 'rack/utils'
+require 'rack/mock'
+
+describe Rack::Uploads::UploadedFile do
+
+  it "should pass through file attributes" do
+    file = Rack::Uploads::UploadedFile.new("foo", {:foo => "bar"})
+    file.foo.should == "bar"
+    lambda { file.bar }.should raise_error(NoMethodError)
+  end
+
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: rack-uploads
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mutwin Kraus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-13 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mutle@blogage.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/rack/uploads.rb
+- lib/rack/uploads/middleware.rb
+- lib/rack/uploads/uploaded_file.rb
+- rack-uploads.gemspec
+- spec/fixtures/files/test_data.txt
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/uploaded_file_spec.rb
+has_rdoc: true
+homepage: http://github.com/mutle/rack-uploads
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: Rack Upload handler with Nginx Upload Module support
+test_files: 
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/uploaded_file_spec.rb