upr 0.1.0 → 0.2.0

data/lib/upr/json.rb

@@ -0,0 +1,143 @@
+# -*- encoding: binary -*-
+begin
+  require 'json'
+rescue LoadError
+  raise LoadError, "either json or json-pure is required"
+end
+require 'rack'
+
+module Upr
+
+  # JSON protocol based on Lighttpd's mod_uploadprogress
+  # http://trac.lighttpd.net/trac/wiki/Docs:ModUploadProgress
+  class JSON < Struct.new(:frequency, :backend, :upload_id)
+
+    include Params
+
+    # We use this in case length is nil when clients send chunked uploads
+    INT_MAX = 0x7fffffff
+
+    SLEEP_CLASS = defined?(Actor) ? Actor : Kernel
+
+    # our default response headers, we need to set no-transform to
+    # prevent deflaters from compressing our already-small small input
+    # and also to prevent buffering/corking of the response inside
+    # deflater buffers.
+    RESPONSE_HEADERS = {
+      'Content-Type' => 'application/json',
+      'Cache-Control' => 'no-cache, no-transform',
+    }
+
+    def initialize(options = {})
+      super(options[:frequency] || 1, options[:backend], options[:upload_id])
+
+      # support :drb for compatibility with mongrel_upload_progress
+      if options[:drb]
+        backend and raise ArgumentError, ":backend and :drb are incompatible"
+        require 'drb'
+        DRb.start_service
+        self.backend = DRbObject.new(nil, options[:drb])
+      elsif String === backend
+        # allow people to use strings in case their backend gets
+        # lazy-loaded (like an ActiveRecord model)
+        self.backend = eval(backend)
+      elsif backend.nil?
+        raise ArgumentError, "backend MUST be specified"
+      end
+
+      # only for use with rails_proc
+      upload_id.nil? and self.upload_id = options[:env]
+    end
+
+    def rails_render_options
+      env = upload_id
+      self.upload_id = extract_upload_id(env)
+      text = if Rack::Request.new(env).GET.include?("long")
+        Proc.new { |response,output| each { |line| output.write(line) } }
+      else
+        _once
+      end
+      { :content_type => 'application/json', :text => text }
+    end
+
+    def _once
+      if status = backend.read(upload_id)
+        if status.done?
+          _json_object(:state => 'done')
+        elsif status.seen == 0
+          _json_object(:state => 'starting')
+        elsif status.error?
+          _error_msg("upload failed")
+        else
+          _update_msg(status)
+        end
+      else
+        timeout = Time.now + 2
+        until status = backend.read(upload_id)
+          SLEEP_CLASS.sleep(0.1)
+          return _error_msg("couldn't get status") if Time.now > timeout
+        end
+        _json_object(:state => 'starting')
+      end
+    end
+
+    # Rack interface reservced for future use with streaming AJAX
+    def call(env)
+      if uid = extract_upload_id(env)
+        _wrap(env, uid)
+      else
+        [ 400, RESPONSE_HEADERS.dup, [ _error_msg("upload_id not given") ] ]
+      end
+    end
+
+    # Rack interface reservced for future use with streaming AJAX
+    def each(&block)
+      sleeper = defined?(Actor) ? Actor : Kernel
+      timeout = Time.now + 2
+      eol = ";\n"
+      yield _json_object(:state => 'starting') << eol
+      begin
+        until status = backend.read(upload_id)
+          sleeper.sleep(0.1)
+          break if Time.now > timeout
+        end
+        if status
+          begin
+            yield _update_msg(status) << eol
+            break if status.done?
+            sleeper.sleep(frequency)
+          end while status = backend.read(upload_id)
+          yield _json_object(:state => 'done') << eol
+        else
+          yield _error_msg("couldn't get status") << eol
+        end
+      rescue => e
+        yield _error_msg(e.message) << eol
+      end
+    end
+
+    # Rack interface reservced for future use with streaming AJAX
+    def _wrap(env, uid)
+      _self = dup
+      _self.upload_id = uid
+      [ 200, RESPONSE_HEADERS.dup, _self ]
+    end
+
+    def _error_msg(msg)
+      _json_object(:state => 'error', :status => 400, :message => msg)
+    end
+
+    def _json_object(options)
+      # $stderr.syswrite "#{options.inspect} #{$upr.inspect}\n"
+      options.to_json
+    end
+
+    def _update_msg(status)
+      raise "client error" if status.error?
+      received = status.seen
+      size = status.length || INT_MAX
+      _json_object(:state => 'uploading', :size => size, :received => received)
+    end
+
+  end
+end

data/lib/upr/monitor.rb

@@ -8,11 +8,11 @@ module Upr
   # Usage (in config.ru with Moneta::Memory store):
   #   require 'upr'
   #   require 'moneta/memory'
-  #   use Upr, :backend => Upr::MonetaMonitor.new(Moneta::Memory.new)
+  #   use Upr, :backend => Upr::Monitor.new(Moneta::Memory.new)
   #   run YourApplication.new
   class Monitor < Struct.new(:moneta)
-    # nuke anything not read/updated in 10 seconds
-    OPT = { :expires_in => 10 }
+    # nuke anything not read/updated in 60 seconds
+    OPT = { :expires_in => 60 }
 
     def initialize(moneta_store = nil)
       super
@@ -27,13 +27,25 @@ module Upr
     end
 
     def read(upid)
-      moneta.update_key(upid, OPT)
       moneta[upid]
     end
 
     def incr(upid, nr)
-      status = moneta[upid]
-      status.seen += nr
+      status = moneta[upid] or return
+      status.seen += nr if status.seen >= 0
+      moneta.store(upid, status, OPT)
+    end
+
+    def finish(upid)
+      status = moneta[upid] or return
+      status.length ||= status.seen
+      status.seen = status.length
+      moneta.store(upid, status, OPT)
+    end
+
+    def error!(upid)
+      status = moneta[upid] or return
+      status.seen = -1
       moneta.store(upid, status, OPT)
     end
 

data/lib/upr/params.rb

@@ -0,0 +1,24 @@
+# -*- encoding: binary -*-
+require 'rack'
+
+module Upr
+
+  module Params
+
+    # we'll add compatibility for existing upload progress modules
+    # we find here, but under no circumstances will we help
+    # proliferate new and subtly incompatible mechanisms.
+    # X-Progress-ID is used in both lighttpd and nginx (3rd party module)
+    # "upload_id" is used by mongrel_upload_progress
+    def extract_upload_id(env)
+      upid = env['HTTP_X_PROGRESS_ID'] and return upid
+
+      # can't blindly parse params here since we don't want to read
+      # the POST body if there is one, so only parse stuff in the
+      # query string...
+      params = Rack::Request.new(env).GET
+      env["upr.upload_id"] = params["X-Progress-ID"] || params["upload_id"]
+    end
+
+  end
+end

data/lib/upr/status.rb

@@ -0,0 +1,9 @@
+# -*- encoding: binary -*-
+require 'upr/status_methods'
+module Upr
+
+  # this is what we store in the Moneta-backed monitor
+  class Status < Struct.new(:seen, :length)
+    include StatusMethods
+  end
+end

data/lib/upr/status_methods.rb

@@ -0,0 +1,13 @@
+# -*- encoding: binary -*-
+module Upr
+  # mixin module for both Upr::Status and UprStatus (AR example module)
+  module StatusMethods
+    def error?
+      seen < 0
+    end
+
+    def done?
+      length && seen >= length
+    end
+  end
+end

data/test/test_monitor.rb

@@ -0,0 +1,58 @@
+require 'test/unit'
+require 'upr'
+
+class MonitorTest < Test::Unit::TestCase
+  def setup
+    @monitor = Upr::Monitor.new
+  end
+
+  def test_start_with_length
+    assert_kind_of Upr::Status, @monitor.start('abcde', 5)
+    status = @monitor.read('abcde')
+    assert_equal 5, status.length
+    assert_equal 0, status.seen
+    assert ! status.error?
+    assert ! status.done?
+  end
+
+  def test_start_without_length
+    assert_kind_of Upr::Status, @monitor.start('abcde', nil)
+    status = @monitor.read('abcde')
+    assert_nil status.length
+    assert_equal 0, status.seen
+    assert ! status.error?
+    assert ! status.done?
+  end
+
+  def test_to_incr
+    assert_kind_of Upr::Status, @monitor.start('abcde', 5)
+    status = @monitor.incr('abcde', 2)
+    assert_kind_of Upr::Status, status
+    assert_equal 2, status.seen
+    assert ! status.error?
+    assert ! status.done?
+    @monitor.incr('abcde', 3)
+    assert_equal 5, status.seen
+    assert ! status.error?
+    assert status.done?
+  end
+
+  def test_finish_with_length
+    assert_kind_of Upr::Status, status = @monitor.start('abcde', 5)
+    @monitor.finish('abcde')
+    assert ! status.error?
+    assert status.done?
+    assert_equal 5, status.seen
+    assert_equal 5, status.length
+  end
+
+  def test_finish_without_length
+    assert_kind_of Upr::Status, status = @monitor.start('abcde', nil)
+    @monitor.finish('abcde')
+    assert ! status.error?
+    assert status.done?
+    assert_equal 0, status.seen
+    assert_equal 0, status.length
+  end
+
+end

data/upr.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{rainbows}
 
   s.add_dependency(%q<moneta>)
+  s.add_dependency(%q<rack>)
 
   # Folks on intranets sharing humongous files can use Unicorn, too
   # s.add_dependency(%q<rainbows>)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: upr
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - upr hackers
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-11 00:00:00 -08:00
+date: 2009-11-14 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,11 +22,22 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: |-
   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.
+  monitoring.  It is based on (and should be client-side compatible with)
+  several upload progress modules including ones used by leading web
+  servers.  It allows any Moneta backing store in addition to DRb.  There
+  is also a packaged example for using an ActiveRecord model for Rails.
 email: upr@librelist.com
 executables: 
 - upr-drb
@@ -36,7 +47,11 @@ extra_rdoc_files:
 - ChangeLog
 - lib/upr.rb
 - lib/upr/input_wrapper.rb
+- lib/upr/json.rb
 - lib/upr/monitor.rb
+- lib/upr/params.rb
+- lib/upr/status.rb
+- lib/upr/status_methods.rb
 - LICENSE
 - NEWS
 - README
@@ -57,9 +72,12 @@ files:
 - examples/rails_app-2.3.4/Rakefile
 - examples/rails_app-2.3.4/app/controllers/application_controller.rb
 - examples/rails_app-2.3.4/app/controllers/files_controller.rb
+- examples/rails_app-2.3.4/app/controllers/progress_controller.rb
 - examples/rails_app-2.3.4/app/helpers/application_helper.rb
 - examples/rails_app-2.3.4/app/models/upr_status.rb
 - examples/rails_app-2.3.4/app/views/files/index.html.erb
+- examples/rails_app-2.3.4/app/views/files/new.html.erb
+- examples/rails_app-2.3.4/app/views/files/pull.html.erb
 - examples/rails_app-2.3.4/config.ru
 - examples/rails_app-2.3.4/config/boot.rb
 - examples/rails_app-2.3.4/config/database.yml
@@ -68,6 +86,7 @@ files:
 - examples/rails_app-2.3.4/config/environments/production.rb
 - examples/rails_app-2.3.4/config/environments/test.rb
 - examples/rails_app-2.3.4/config/initializers/new_rails_defaults.rb
+- examples/rails_app-2.3.4/config/initializers/ruby_19_compat.rb
 - examples/rails_app-2.3.4/config/routes.rb
 - examples/rails_app-2.3.4/db/.gitignore
 - examples/rails_app-2.3.4/db/migrate/19700000000000_add_upr_status.rb
@@ -78,20 +97,33 @@ files:
 - examples/rails_app-2.3.4/public/422.html
 - examples/rails_app-2.3.4/public/500.html
 - examples/rails_app-2.3.4/public/favicon.ico
+- examples/rails_app-2.3.4/public/javascripts/ajax_pull/ajax_pull.js
+- examples/rails_app-2.3.4/public/javascripts/ajax_pull/prototype-1_5_1.js
+- examples/rails_app-2.3.4/public/javascripts/ajax_pull/upload_progress.js
 - examples/rails_app-2.3.4/public/javascripts/application.js
 - examples/rails_app-2.3.4/public/javascripts/controls.js
 - examples/rails_app-2.3.4/public/javascripts/dragdrop.js
 - examples/rails_app-2.3.4/public/javascripts/effects.js
+- examples/rails_app-2.3.4/public/javascripts/jquery.js
+- examples/rails_app-2.3.4/public/javascripts/jquery.uploadProgress.js
 - examples/rails_app-2.3.4/public/javascripts/prototype.js
 - examples/rails_app-2.3.4/public/javascripts/upr.js
 - examples/rails_app-2.3.4/public/robots.txt
+- examples/rails_app-2.3.4/public/stylesheets/site.css
 - examples/rails_app-2.3.4/rainbows_config.rb
+- examples/rails_app-2.3.4/test/fixtures/upr_statuses.yml
 - examples/rails_app-2.3.4/test/test_helper.rb
+- examples/rails_app-2.3.4/test/unit/upr_status_test.rb
 - lib/upr.rb
 - lib/upr/input_wrapper.rb
+- lib/upr/json.rb
 - lib/upr/monitor.rb
+- lib/upr/params.rb
+- lib/upr/status.rb
+- lib/upr/status_methods.rb
 - local.mk.sample
 - setup.rb
+- test/test_monitor.rb
 - upr.gemspec
 has_rdoc: true
 homepage: http://upr.bogomips.org/