thin_upload 0.0.1.pre1

data/lib/thin_upload.rb

@@ -0,0 +1,3 @@
+require 'thin_upload/request'
+
+raise "You have to use Thin server for using thin_upload" unless defined? Thin

data/lib/thin_upload/request.rb

@@ -0,0 +1,93 @@
+#Thin module from thin server
+module Thin
+  # The Request class takes part of the Thin module which is responsible
+  # for incomming web requests for thin server.
+  # The class is opened up here for adding functionality to track 
+  # progress of file uploads.
+  
+  class Request
+    #Freeze Rack header for progress hash
+    RACK_PROGRESS = 'rack.progress'.freeze
+        
+    #Freeze some regexps
+    #regexp to identify file upload
+    POST_REQUEST_REGEXP = /uuid\"\r\n\r\n(.*)\r/i.freeze
+    #regexp to identify upload progress requests 
+    GET_REQUEST_REGEXP = /uuid=(.*) /.freeze
+    attr_reader :parser
+    attr_accessor :data_buffer
+    
+    # +new_parse+ method extends the original +parse+ method's
+    # functionality with the upload progress tracking
+    # Arguments:
+    #  data: (String) 
+    
+    def new_parse(data)
+      scan_content(data) unless uuid_found_or_limit_reached?
+      success = thin_parse(data) #execute the the original +parse+ method
+      store_progress(@upload_uuid)
+      cleanup_progress_hash(@request_uuid)
+      success #returns the result from Thin's parse method
+    end
+
+    # The +Thin+'s +parse+ method is aliased to +thin_parse+
+    # and the +new_parse+ method is aliased to +parse+
+    alias_method :thin_parse, :parse
+    alias_method :parse, :new_parse    
+
+    # Scans unparsed data for uuids, the unparsed data 
+    # is stored in a string for buffering purposes
+    # which is deleted after the uuid has been found.
+    # Arguments:
+    #  data: (String)
+
+    def scan_content(data)
+      @data_buffer = @data_buffer.to_s + data
+      @upload_uuid  ||= @data_buffer.scan(POST_REQUEST_REGEXP).flatten.first
+      @request_uuid ||= @data_buffer.scan(GET_REQUEST_REGEXP).flatten.first
+    end
+    
+    # Checking if we still have to search for uuid's
+    # Arguments:
+    #  none
+    def uuid_found_or_limit_reached?
+      if @upload_uuid || @request_uuid || (body.size > MAX_BODY)
+        @data_buffer = nil
+        true
+      else
+        false
+      end
+    end
+
+    # Calculating the progress based on +content_length+ and received body size +body.size+
+    # Arguments:
+    #  none
+    def progress
+      ((body.size/content_length.to_f)*100).to_i
+    end
+    
+    # progress can be accessed via +request.env['rack.progress']+ in the app
+    # Arguments:
+    #  uuid: (String) 
+    def store_progress(uuid)
+      Thin::Server::progress[uuid] = progress if uuid #storing the progress with the uiid
+      @env.merge!(RACK_PROGRESS=>Thin::Server::progress.clone) if finished? #merging the progress hash into the environment
+    end
+    
+    # deleting progress entry from +Thin::Server::progress+ if the upload is finished and the result was requested
+    # Arguments:
+    #  data: (String) 
+    def cleanup_progress_hash(req_uuid)
+      Thin::Server::progress.delete(req_uuid) if Thin::Server::progress[req_uuid] == 100 && finished?#delete when progress is returned and 100%
+    end
+  end
+end
+module Thin
+  # Thin's server class
+  class Server
+    #adding a hash to store all the upload progress in the server
+    def self.progress
+      @@progress||={}
+    end  
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+require 'test/unit'
+require 'thin'
+require 'thin_upload'
+
+def upload_data_string
+  "form-data; name=\"uuid\"\r\n\r\n#{uuid}\r\n-----------------------------"
+end
+
+def post_request(body)
+  "POST / HTTP/1.1\r\nHost: localhost\r\nContent-Type: text/html\r\nContent-Length: #{body.size}\r\n\r\n#{body}"
+end
+
+def big_post_request(body)
+  "POST / HTTP/1.1\r\nHost: localhost\r\nContent-Type: text/html\r\nContent-Length: #{Thin::Request::MAX_BODY+1}\r\n\r\n#{body}"
+end
+def get_request(url)
+  "GET #{url} HTTP/1.1\r\nHost: localhost:3000\r\n\r\n"
+end
+
+
+def uuid
+  "2ce89350-cb31-012e-dc4a-64b9e8c7c202"
+end
+
+# Create and parse a request
+def new_request(data)
+  request = Thin::Request.new
+  request.parse(data)
+  request
+end

data/test/thin_upload/request_test.rb

@@ -0,0 +1,91 @@
+require 'test_helper'
+
+class RequestTest < Test::Unit::TestCase
+  
+  def setup
+    @request = new_request(post_request("a"*100))
+  end
+
+  def test_scan_uuid_on_url_request
+    @request.scan_content(get_request("?uuid=#{uuid}"))
+    assert_equal @request.instance_variable_get(:@request_uuid), uuid
+  end  
+  
+  def test_scan_uuid_on_form_request
+    @request.scan_content(upload_data_string)
+    assert_equal @request.instance_variable_get(:@upload_uuid), uuid
+  end  
+  
+  def test_store_data_in_buffer
+    content  = "content"
+    content2 = "content2"
+    @request.parse(content)
+    assert @request.data_buffer.match(/#{content}$/)
+    @request.parse(content2)
+    assert @request.data_buffer.match(/#{content+content2}$/)
+  end
+  
+  def test_clear_data_from_buffer_when_url_uuid_found
+    content  = "content"
+    @request.parse(content)
+    assert @request.data_buffer.match(/#{content}$/)
+    @request.parse(get_request("?uuid=#{uuid}"))
+    assert_equal @request.instance_variable_get(:@request_uuid), uuid
+    @request.parse content
+    assert_equal @request.data_buffer, nil
+  end
+  
+  def test_clear_data_from_buffer_when_form_uuid_found
+    content  = "content"
+    @request.parse(content)
+    assert @request.data_buffer.match(/#{content}$/)
+    @request.parse post_request(upload_data_string)
+    assert_equal @request.instance_variable_get(:@upload_uuid), uuid
+    @request.parse content
+    assert_equal @request.data_buffer, nil
+  end
+
+  def test_should_stop_parsing_when_body_size_limit_reached
+    @request = new_request(post_request("a"))
+    assert !@request.uuid_found_or_limit_reached?
+    @request.body << "a" * (Thin::Request::MAX_BODY+1)
+    assert @request.uuid_found_or_limit_reached?
+    assert_equal @request.instance_variable_get(:@data_buffer), nil
+  end
+
+  def test_calculate_progress
+    @request.instance_variable_set(:@body, "a"*20)
+    assert_equal @request.progress, 20
+    @request.instance_variable_set(:@body, "a"*45)
+    assert_equal @request.progress, 45
+    @request.instance_variable_set(:@body, "a"*100)
+    assert_equal @request.progress, 100
+  end
+    
+  def test_store_progress
+    @request.instance_variable_set(:@body, "a"*50)
+    @request.store_progress(uuid)
+    assert_equal Thin::Server::progress[uuid], 50    
+  end
+  
+  def test_progress_is_returned_on_parse_finish
+    Thin::Server::progress['my_id'] = 45
+    assert @request.finished?
+    @request.store_progress(uuid)
+    assert_equal @request.env[Thin::Request::RACK_PROGRESS]['my_id'], 45
+  end
+  
+  def test_progress_is_deleted_when_it_was_finished_and_requested
+    Thin::Server::progress[uuid] = 100
+    assert @request.parse post_request("uuid=#{uuid} ")
+    assert_equal @request.env[Thin::Request::RACK_PROGRESS][uuid], 100
+  end
+  
+  def test_progress_is_returned_when_its_finished_and_not_was_requested_yet
+    Thin::Server::progress[uuid] = 100
+    @request = Thin::Request.new
+    assert @request.parse(get_request("/progress?uuid=#{uuid}"))
+    assert_equal Thin::Server::progress.has_key?(uuid), false
+  end
+     
+end

data/thin_upload.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{thin_upload}
+  s.version = "0.0.1.pre1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Dombi Attila}]
+  s.date = %q{2011-10-19}
+  s.description = %q{thin_upload provides upload progress measuring functionality for thin ruby server, progresses can be accessed via rack middleware.}
+  s.email = %q{dombesz.attila-at-gmail.com}
+  s.extra_rdoc_files = [%q{README.rdoc}, %q{lib/thin_upload.rb}, %q{lib/thin_upload/request.rb}]
+  s.files = [%q{Gemfile}, %q{Gemfile.lock}, %q{Manifest}, %q{README.rdoc}, %q{Rakefile}, %q{html/README_rdoc.html}, %q{html/Thin.html}, %q{html/Thin/Request.html}, %q{html/Thin/Server.html}, %q{html/created.rid}, %q{html/images/brick.png}, %q{html/images/brick_link.png}, %q{html/images/bug.png}, %q{html/images/bullet_black.png}, %q{html/images/bullet_toggle_minus.png}, %q{html/images/bullet_toggle_plus.png}, %q{html/images/date.png}, %q{html/images/find.png}, %q{html/images/loadingAnimation.gif}, %q{html/images/macFFBgHack.png}, %q{html/images/package.png}, %q{html/images/page_green.png}, %q{html/images/page_white_text.png}, %q{html/images/page_white_width.png}, %q{html/images/plugin.png}, %q{html/images/ruby.png}, %q{html/images/tag_green.png}, %q{html/images/wrench.png}, %q{html/images/wrench_orange.png}, %q{html/images/zoom.png}, %q{html/index.html}, %q{html/js/darkfish.js}, %q{html/js/jquery.js}, %q{html/js/quicksearch.js}, %q{html/js/thickbox-compressed.js}, %q{html/lib/thin_upload/parser_rb.html}, %q{html/lib/thin_upload/request_rb.html}, %q{html/lib/thin_upload_rb.html}, %q{html/rdoc.css}, %q{lib/thin_upload.rb}, %q{lib/thin_upload/request.rb}, %q{test/test_helper.rb}, %q{test/thin_upload/request_test.rb}, %q{thin_upload.gemspec}]
+  s.homepage = %q{https://github.com/dombesz/thin_upload}
+  s.rdoc_options = [%q{--line-numbers}, %q{--inline-source}, %q{--title}, %q{Thin_upload}, %q{--main}, %q{README.rdoc}]
+  s.require_paths = [%q{lib}]
+  s.rubyforge_project = %q{thin_upload}
+  s.rubygems_version = %q{1.8.8}
+  s.summary = %q{Upload progress meter for thin ruby server.}
+  s.test_files = [%q{test/test_helper.rb}, %q{test/thin_upload/request_test.rb}]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thin>, [">= 0"])
+    else
+      s.add_dependency(%q<thin>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thin>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: thin_upload
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre1
+  prerelease: 6
+platform: ruby
+authors:
+- Dombi Attila
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: &2162587720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2162587720
+description: thin_upload provides upload progress measuring functionality for thin
+  ruby server, progresses can be accessed via rack middleware.
+email: dombesz.attila-at-gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- lib/thin_upload.rb
+- lib/thin_upload/request.rb
+files:
+- Gemfile
+- Gemfile.lock
+- Manifest
+- README.rdoc
+- Rakefile
+- html/README_rdoc.html
+- html/Thin.html
+- html/Thin/Request.html
+- html/Thin/Server.html
+- html/created.rid
+- html/images/brick.png
+- html/images/brick_link.png
+- html/images/bug.png
+- html/images/bullet_black.png
+- html/images/bullet_toggle_minus.png
+- html/images/bullet_toggle_plus.png
+- html/images/date.png
+- html/images/find.png
+- html/images/loadingAnimation.gif
+- html/images/macFFBgHack.png
+- html/images/package.png
+- html/images/page_green.png
+- html/images/page_white_text.png
+- html/images/page_white_width.png
+- html/images/plugin.png
+- html/images/ruby.png
+- html/images/tag_green.png
+- html/images/wrench.png
+- html/images/wrench_orange.png
+- html/images/zoom.png
+- html/index.html
+- html/js/darkfish.js
+- html/js/jquery.js
+- html/js/quicksearch.js
+- html/js/thickbox-compressed.js
+- html/lib/thin_upload/parser_rb.html
+- html/lib/thin_upload/request_rb.html
+- html/lib/thin_upload_rb.html
+- html/rdoc.css
+- lib/thin_upload.rb
+- lib/thin_upload/request.rb
+- test/test_helper.rb
+- test/thin_upload/request_test.rb
+- thin_upload.gemspec
+homepage: https://github.com/dombesz/thin_upload
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Thin_upload
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
+requirements: []
+rubyforge_project: thin_upload
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Upload progress meter for thin ruby server.
+test_files:
+- test/test_helper.rb
+- test/thin_upload/request_test.rb