upr 0.1.0

data/LICENSE

@@ -0,0 +1,55 @@
+Upload Progress for Rack (upr) is copyrighted Free Software by all
+contributors, see the logs in revision control for all of them.  You can
+redistribute it and/or modify it under either the terms of the
+{GPL2}[http://www.gnu.org/licenses/gpl-2.0.txt] (see link:COPYING) or
+the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise make them
+       Freely Available, such as by posting said modifications to Usenet or an
+       equivalent medium, or by allowing the author to include your
+       modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict with
+       standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+       together with instructions (in the manual page or equivalent) on where
+       to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of the
+       software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+  5. The scripts and library files supplied as input to or produced as
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them,
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README

@@ -0,0 +1,108 @@
+= upr - Upload Progress for Rack
+
+upr is Rack middleware that allows browser-side upload progress
+monitoring.  It is based on the "mongrel_upload_progress" module, but
+allows any Moneta-backing store in additon to DRb.  There is also a
+packaged example for using an ActiveRecord model for Rails.
+
+== Demo
+
+You can see upr it in action at http://upr-demo.bogomips.org/
+It will report the size and SHA1 of the file you've uploaded.
+Much of the demo was stolen from mongrel_upload_progress.
+
+== Web Server Compatibility
+
+While upr is completely Rack::Lint-compatible, upr is only compatible
+with Rack web servers that support a streaming "rack.input".  Currently
+this is limited to {Rainbows!}[http://rainbows.rubyforge.org/] with a
+handful of concurrency models:
+
+* ThreadSpawn
+* ThreadPool
+* Revactor*
+
+For use with Revactor, the use of network-based Moneta stores or DRb is
+only advised if those stores are using Revactor-aware sockets.
+
+== JavaScript/HTML Compatibility
+
+The current developer does not react well with GUIs.  Thus all (R)HTML
+and Prototype JavaScript code was stolen from mongrel_upload_progress.
+
+Contributions to add compatibility for more modern things like JQuery
+and HTML5 are very welcome.
+
+
+== Backend Compatibility
+
+We depend on {Moneta}[http://github.com/wycats/moneta], which allows the
+use of a multitude of key-value stores.  We also provide a
+DRb+Moneta::Memory server to ease transitions from
+mongrel_upload_progress.
+
+Additionally, there is an example for using Rails ActiveRecord as a
+backend storage mechanism.  Cookie-based upload tracking may eventually
+be used, too (contributions very welcome).
+
+== Proxy Compatibility
+
+No proxy is required when used with Rainbows!
+
+The only incompatible HTTP proxy we know of is nginx.  nginx will buffer
+large requests to the filesystem before sending them to the backend.
+nginx has its own 3rd-party module for
+{upload progress}[http://wiki.nginx.org/NginxHttpUploadProgressModule]
+and may be used instead of upr.
+
+Most other HTTP-aware and all TCP-only proxies should be compatible.
+Disabling Nagle's algorithm in both the Rack web server and proxy is
+advised for lower latency, especially with stunnel.
+
+== Unicorn Compatibility
+
+While {Unicorn}[http://unicorn.bogomips.org/] provides the streaming
+"rack.input" for Rainbows!, using Unicorn with upr is generally NOT
+recommended.  Unicorn only supports fast clients and progress reporting
+is unnecessary unless clients are uploading files that are hundreds of
+megabyte in size or larger.
+
+== Getting Started
+
+  gem install upr
+
+For Rails, look at the Rails application
+{example}[http://git.bogomips.org/cgit/upr.git/tree/examples/rails_app-2.3.4]
+and RDoc.  More documentation is on the way.
+
+== Disclaimer
+
+There is NO WARRANTY whatsoever if anything goes wrong, but let us know
+and we'll try our best to fix it.
+
+== License
+
+upr is copyright 2009 by all contributors (see logs in git).  It is
+based on mongrel_upload_progress and carries the same license (Ruby +
+GPL2).  See the included LICENSE file for details.
+
+upr is 100% Free Software.  We will never support the proliferation of
+non-Free browsers or plugins.
+
+== Contact
+
+All feedback (bug reports, user/development dicussion, patches, pull
+requests) go to the mailing list/newsgroup.  Patches must be sent inline
+(git format-patch -M + git send-email).  No top posting.
+
+To subscribe or post to the mailing list, just send an email to
+upr@librelist.com and follow the instructions in the automated reply.
+
+* email: mailto:upr@librelist.com
+* git: git://git.bogomips.org/upr.git
+* cgit: http://git.bogomips.org/cgit/upr.git
+
+We will adhere to mostly the same conventions for patch submissions as
+git itself.  See the Documentation/SubmittingPatches document
+distributed with git on on patch submission guidelines to follow.  Just
+don't email the git mailing list with upr patches :)

data/Rakefile

@@ -0,0 +1,119 @@
+# -*- encoding: binary -*-
+
+# most tasks are in the GNUmakefile which offers better parallelism
+
+def tags
+  timefmt = '%Y-%m-%dT%H:%M:%SZ'
+  @tags ||= `git tag -l`.split(/\n/).map do |tag|
+    if %r{\Av[\d\.]+\z} =~ tag
+      header, subject, body = `git cat-file tag #{tag}`.split(/\n\n/, 3)
+      header = header.split(/\n/)
+      tagger = header.grep(/\Atagger /).first
+      body ||= "initial"
+      {
+        :time => Time.at(tagger.split(/ /)[-2].to_i).utc.strftime(timefmt),
+        :tagger_name => %r{^tagger ([^<]+)}.match(tagger)[1].strip,
+        :tagger_email => %r{<([^>]+)>}.match(tagger)[1].strip,
+        :id => `git rev-parse refs/tags/#{tag}`.chomp!,
+        :tag => tag,
+        :subject => subject,
+        :body => body,
+      }
+    end
+  end.compact.sort { |a,b| b[:time] <=> a[:time] }
+end
+
+cgit_url = "http://git.bogomips.org/cgit/upr.git"
+
+desc 'prints news as an Atom feed'
+task :news_atom do
+  require 'nokogiri'
+  new_tags = tags[0,10]
+  puts(Nokogiri::XML::Builder.new do
+    feed :xmlns => "http://www.w3.org/2005/Atom" do
+      id! "http://upr.bogomips.org/NEWS.atom.xml"
+      title "upr news"
+      subtitle "Upload Progress for Rack"
+      link! :rel => 'alternate', :type => 'text/html',
+            :href => 'http://upr.bogomips.org/NEWS.html'
+      updated(new_tags.empty? ? "1970-01-01T00:00:00Z" : new_tags.first[:time])
+      new_tags.each do |tag|
+        entry do
+          title tag[:subject]
+          updated tag[:time]
+          published tag[:time]
+          author {
+            name tag[:tagger_name]
+            email tag[:tagger_email]
+          }
+          url = "#{cgit_url}/tag/?id=#{tag[:tag]}"
+          link! :rel => "alternate", :type => "text/html", :href =>url
+          id! url
+          content({:type => 'text'}, tag[:body])
+        end
+      end
+    end
+  end.to_xml)
+end
+
+desc 'prints RDoc-formatted news'
+task :news_rdoc do
+  tags.each do |tag|
+    time = tag[:time].tr!('T', ' ').gsub!(/:\d\dZ/, ' UTC')
+    puts "=== #{tag[:tag].sub(/^v/, '')} / #{time}"
+    puts ""
+
+    body = tag[:body]
+    puts tag[:body].gsub(/^/sm, "  ").gsub(/[ \t]+$/sm, "")
+    puts ""
+  end
+end
+
+desc "print release changelog for Rubyforge"
+task :release_changes do
+  version = ENV['VERSION'] or abort "VERSION= needed"
+  version = "v#{version}"
+  vtags = tags.map { |tag| tag[:tag] =~ /\Av/ and tag[:tag] }.sort
+  prev = vtags[vtags.index(version) - 1]
+  if prev
+    system('git', 'diff', '--stat', prev, version) or abort $?
+    puts ""
+    system('git', 'log', "#{prev}..#{version}") or abort $?
+  else
+    system('git', 'log', version) or abort $?
+  end
+end
+
+desc "print release notes for Rubyforge"
+task :release_notes do
+  require 'rubygems'
+
+  git_url = ENV['GIT_URL'] || 'git://git.bogomips.org/upr.git'
+
+  spec = Gem::Specification.load('upr.gemspec')
+  puts spec.description.strip
+  puts ""
+  puts "* #{spec.homepage}"
+  puts "* #{spec.email}"
+  puts "* #{git_url}"
+
+  _, _, body = `git cat-file tag v#{spec.version}`.split(/\n\n/, 3)
+  print "\nChanges:\n\n"
+  puts body
+end
+
+desc "read news article from STDIN and post to rubyforge"
+task :publish_news do
+  require 'rubyforge'
+  IO.select([STDIN], nil, nil, 1) or abort "E: news must be read from stdin"
+  msg = STDIN.readlines
+  subject = msg.shift
+  blank = msg.shift
+  blank == "\n" or abort "no newline after subject!"
+  subject.strip!
+  body = msg.join("").strip!
+
+  rf = RubyForge.new.configure
+  rf.login
+  rf.post_news('rainbows', subject, body)
+end

data/bin/upr-drb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'drb'
+require 'upr'
+url = ARGV.shift or abort "#$0 URL\n  e.g.: #$0 druby://0.0.0.0:2999"
+DRb.start_service(url, Upr::Monitor.new)
+DRb.thread.join

data/examples/rails_app-2.3.4/Rakefile

@@ -0,0 +1,10 @@
+# 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.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/examples/rails_app-2.3.4/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+end

data/examples/rails_app-2.3.4/app/controllers/files_controller.rb

@@ -0,0 +1,41 @@
+require 'digest/sha1'
+
+class FilesController < ApplicationController
+  defined?($upr) or before_filter do
+    # grab the backend in case we forget to set it (or if we're using DRb)
+    defined?($upr) or ObjectSpace.each_object(Upr::InputWrapper) do |x|
+      $upr ||= x.backend
+    end
+  end
+
+  def index
+  end
+
+  def status
+    tmp = $upr.read(params[:upload_id]).inspect
+    render :text => "#{Rack::Utils.escape_html(tmp)}\n"
+  end
+
+  def progress
+    render :update do |page|
+      status = $upr.read(params[:upload_id]) and
+         page.upload_progress.update(status.length, status.seen)
+    end
+  end
+
+  def upload
+    file = params[:data]
+    digest = Digest::SHA1.new
+    if buf = file.read(16384)
+      begin
+        digest.update(buf)
+      end while file.read(16384, buf)
+    end
+    size = file.stat.size
+    File.unlink(file.path)
+    render :text => "sha1: #{digest.hexdigest}<br />" \
+                    "size: #{size}<br />" \
+                    '<script type="text/javascript">' \
+                    'window.parent.UploadProgress.finish();</script>'
+  end
+end

data/examples/rails_app-2.3.4/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/examples/rails_app-2.3.4/app/models/upr_status.rb

@@ -0,0 +1,35 @@
+class UprStatus < ActiveRecord::Base
+  cattr_accessor :gc_cutoff
+  @@gc_cutoff = 10
+
+  class << self
+    def read(upid)
+      if rv = find_by_upid(upid)
+        rv.time = Time.now.to_i
+        rv.save
+        rv
+      end
+    end
+
+    def start(upid, length)
+      # this must be a find_or_create_by since some users have twitchy
+      # fingers and hit the upload button prematurely
+      find_or_create_by_upid(upid) do |x|
+        x.length = length
+        x.time = Time.now.to_i
+        x.seen = 0
+      end
+    end
+
+    def incr(upid, nr)
+      update_all("seen = seen + #{nr.to_i}, time = #{Time.now.to_i}",
+                 { :upid => upid })
+    end
+
+    def gc
+      cutoff = Time.now.to_i - @@gc_cutoff
+      delete_all "time < #{cutoff}"
+    end
+  end
+
+end

data/examples/rails_app-2.3.4/app/views/files/index.html.erb

@@ -0,0 +1,66 @@
+<html>
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+    <title>upr test, http://upr.bogomips.org/</title>
+    <%= javascript_include_tag :all %>
+<style type="text/css">
+#progress-bar {
+  width:500px;
+  height:25px;
+  margin:15px;
+  border:solid 1px #000;
+  position:relative;
+}
+
+#progress-bar #status-bar {
+  display:block;
+  height:25px;
+  width:0;
+  background-color:#00f;
+  border-right:solid 1px #000;
+  position:absolute;
+  top:0; left:0;
+}
+
+#progress-bar #status-text {
+  display:block;
+  padding: 0 15px;
+  line-height:25px;
+  position:absolute;
+  top:0; left:0;
+}
+</style>
+  </head>
+  <body>
+<%
+upid = "#{Time.now.to_i}.#{rand}"
+act = { :action => 'upload', :upload_id => upid }
+opt = {
+  :multipart => true,
+  :target => 'upload',
+  :onsubmit => "UploadProgress.monitor('#{escape_javascript(upid)}')"
+}
+-%>
+<p>
+This is a demo of <a href="http://upr.bogomips.org/">upr</a> in action.
+Much of this (including all JS) was stolen from the mongrel_upload_progress
+examples.
+</p>
+<p><%= link_to upid, :action => 'status', :upload_id => upid %></p>
+<% form_tag(act, opt) do %>
+  <div id="file-fields">
+    <p><%= file_field_tag :data %></p>
+  </div>
+  <p><%= link_to_function 'Add File Field', 'UploadProgress.FileField.add()' %>
+  </p>
+  <p><%= submit_tag :Upload %></p>
+<% end %>
+
+<div id="results"></div>
+<div id="progress-bar"></div>
+
+<p>The size and SHA1 of the file you uploaded should appear here</p>
+<iframe id="upload" name="upload" src="about:blank"></iframe>
+
+  </body>
+</html>