net-http-uploadprogress 1.0.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dfca04e2958f5d9e546ee58349ce09b74c0e7eee
+  data.tar.gz: cfd40ef1a395ef7b083b011dbd6aaf9d244eada0
+SHA512:
+  metadata.gz: 5c70ed1e96f4785be5df32f1e35e6940c63c41e37bd0fead8907aaf4702e4c98e7518b27dd70da3d48747f3f8f7744c3e2d70b6c5b9e26470172d24b723531f8
+  data.tar.gz: a55755082262ba51b9b86fb3e47813be53eb2bd900ffcb1171086b4747e5a67b00e62c66868865846dd619fe733c22ba31c0fc3d2fd0fe0cbc68bb660e3f4b45

data/.gitignore

@@ -1,4 +1,20 @@
+.DS_Store
 *.gem
+*.rbc
 .bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
 Gemfile.lock
-pkg/*
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/README.md

@@ -0,0 +1,36 @@
+# net-http-uploadprogress.gem
+
+Get the file uploading progress.
+
+## Installation
+
+    gem install net-http-uploadprogress
+
+## Examples
+
+```ruby
+    require 'net/http/uploadprogress'
+
+    # API style upload
+    File.open('path/to.file', 'rb') do |io|
+      http = Net::HTTP.new(host, port)
+      req = Net::HTTP::Post.new('/')
+      req.content_length = io.size
+      req.body_stream = io
+      Net::HTTP::UploadProgress.new(req) do |progress|
+        puts "uploaded so far: #{ progress.upload_size }"
+      end
+      res = http.request(req)
+    end
+
+    # Form input type="file" style upload
+    File.open('path/to.file', 'rb') do |io|
+      http = Net::HTTP.new(host, port)
+      req = Net::HTTP::Post.new('/')
+      req.set_form({'file_form_field_name' => io}, 'multipart/form-data')
+      Net::HTTP::UploadProgress.new(req) do |progress|
+        puts "uploaded so far: #{ progress.upload_size }"
+      end
+      res = http.request(req)
+    end
+```

data/lib/net/http/uploadprogress.rb

@@ -1,52 +1,42 @@
 require 'net/http'
-require 'net/https'
+require 'tempfile'
+require 'securerandom'
 
-module Net
-  class HTTP
-    def begin_transport(req)
-      if @socket.closed?
-        req.reset_upload_size
-        connect
-      end
-      if not req.response_body_permitted? and @close_on_empty_response
-        req['connection'] ||= 'close'
-      end
-      req['host'] ||= addr_port()
-    end
-  end
-
-  class HTTPGenericRequest
-    def reset_upload_size
-      @upload_size = 0
-    end
+class Net::HTTP::UploadProgress
+  attr_reader :upload_size
 
-    def upload_size
-      @upload_size = 0 if @upload_size.nil?
-      @upload_size
+  def initialize(req, &block)
+    @req = req
+    @callback = block
+    @upload_size = 0
+    if req.body_stream
+      @io = req.body_stream
+      req.body_stream = self
+    elsif req.instance_variable_get(:@body_data)
+      raise NotImplementedError if req.chunked?
+      raise NotImplementedError if /\Amultipart\/form-data\z/i !~ req.content_type
+      opt = req.instance_variable_get(:@form_option).dup
+      opt[:boundary] ||= SecureRandom.urlsafe_base64(40)
+      req.set_content_type(req.content_type, boundary: opt[:boundary])
+      file = Tempfile.new('multipart')
+      file.binmode
+      req.send(:encode_multipart_form_data, file, req.instance_variable_get(:@body_data), opt)
+      file.rewind
+      req.content_length = file.size
+      @io = file
+      req.body_stream = self
+    else
+      raise NotImplementedError
     end
+  end
 
-    private
-
-    def send_request_with_body_stream(sock, ver, path, f)
-      unless content_length() or chunked?
-        raise ArgumentError,
-          "Content-Length not given and Transfer-Encoding is not `chunked'"
-      end
-      @upload_size = 0 if @upload_size.nil?
-      supply_default_content_type
-      write_header sock, ver, path
-      if chunked?
-        while s = f.read(1024)
-          @upload_size += s.length
-          sock.write(sprintf("%x\r\n", s.length) << s << "\r\n")
-        end
-        sock.write "0\r\n\r\n"
-      else
-        while s = f.read(1024)
-          @upload_size += s.length
-          sock.write s
-        end
-      end
+  def readpartial(maxlen, outbuf)
+    begin
+      str = @io.readpartial(maxlen, outbuf)
+    ensure
+      @callback.call(self) unless @upload_size.zero?
     end
+    @upload_size += str.length
+    str
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module NetHttpUploadprogress
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/net-http-uploadprogress.gemspec

@@ -5,20 +5,17 @@ require "version"
 Gem::Specification.new do |s|
   s.name        = "net-http-uploadprogress"
   s.version     = NetHttpUploadprogress::VERSION
-  s.authors     = ["SKAhack"]
-  s.email       = ["m@skahack.com"]
+  s.authors     = ["SKAhack", "Vais Salikhov"]
+  s.email       = ["m@skahack.com", "vsalikhov@gmail.com"]
   s.homepage    = "https://github.com/SKAhack/net-http-uploadprogress"
   s.summary     = %q{Get the file uploading progress.}
   s.description = %q{Get the file uploading progress.}
 
-  s.rubyforge_project = "net-http-uploadprogress"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.required_ruby_version = '~> 2.0'
+  s.add_development_dependency "minitest"
 end

data/spec/uploadprogress_spec.rb

@@ -0,0 +1,138 @@
+# To run this test execute:
+# $ bundle exec ruby spec/uploadprogress_spec.rb
+
+require 'minitest/autorun'
+require 'webrick'
+require 'stringio'
+
+require 'net/http/uploadprogress'
+
+RUBY_IO_COPY_STREAM_BUFLEN = 16 * 1024
+# See io.c
+# static VALUE copy_stream_fallback_body(VALUE arg)
+#   ...
+#   const int buflen = 16*1024;
+#   ...
+# https://github.com/ruby/ruby/blob/trunk/io.c#L10414
+
+
+server = WEBrick::HTTPServer.new({
+  :BindAddress => '127.0.0.1',
+  :Port        => 0,
+  :Logger      => WEBrick::Log.new([], WEBrick::BasicLog::WARN),
+  :AccessLog   => [],
+  :ServerType  => Thread
+})
+
+server.mount_proc('/echo') do |req, res|
+  res.body = req.body
+end
+
+server.mount_proc('/file') do |req, res|
+  res.body = req.query['file']
+end
+
+server.start
+
+describe 'Upload' do
+  [{
+    description: "smaller than buflen",
+    content_length: RUBY_IO_COPY_STREAM_BUFLEN - 1,
+    times_called: 1
+  }, {
+    description: "equal to buflen",
+    content_length: RUBY_IO_COPY_STREAM_BUFLEN,
+    times_called: 1
+  }, {
+    description: "larger than buflen",
+    content_length: RUBY_IO_COPY_STREAM_BUFLEN + 1,
+    times_called: 2
+  }, {
+    description: "exactly 2x larger than buflen",
+    content_length: RUBY_IO_COPY_STREAM_BUFLEN * 2,
+    times_called: 2
+  }, {
+    description: "more than 2x larger than buflen",
+    content_length: RUBY_IO_COPY_STREAM_BUFLEN * 2 + 1,
+    times_called: 3
+  }].each do |upload|
+
+    describe upload[:description] do
+      http = Net::HTTP.new(server[:BindAddress], server[:Port])
+      content = 'a' * upload[:content_length]
+      req = Net::HTTP::Post.new('/echo')
+      req.content_length = upload[:content_length]
+      req.body_stream = StringIO.new(content)
+
+      times_called = 0
+      upload_size = 0
+
+      Net::HTTP::UploadProgress.new(req) do |progress|
+        times_called += 1
+        upload_size += progress.upload_size - upload_size
+      end
+
+      res = http.request(req)
+
+      it 'correctly transmits data to the server' do
+        assert_equal(content, res.body)
+      end
+
+      it 'updates progress expected number of times' do
+        assert_equal(upload[:times_called], times_called)
+      end
+
+      it 'updates progress with correct upload size' do
+        assert_equal(upload[:content_length], upload_size)
+      end
+    end
+  end
+
+  describe 'file' do
+    http = Net::HTTP.new(server[:BindAddress], server[:Port])
+    req = Net::HTTP::Post.new('/file')
+
+    content = 'hello'
+
+    file = Tempfile.new('uploadprogress_spec')
+    file.binmode
+    file << content
+    file.rewind
+
+    req.set_form({'file' => file}, 'multipart/form-data', boundary: 'UfpmKZyktEWfuJidfSVW_Ss-HV5f-mbma0uQchAVbCJFxhKnYOcaTA')
+
+    multipart_content = [
+      '--UfpmKZyktEWfuJidfSVW_Ss-HV5f-mbma0uQchAVbCJFxhKnYOcaTA',
+      'Content-Disposition: form-data; name="file"; filename="<filename>"',
+      'Content-Type: application/octet-stream',
+      '',
+      'hello',
+      '--UfpmKZyktEWfuJidfSVW_Ss-HV5f-mbma0uQchAVbCJFxhKnYOcaTA--',
+      ''
+    ].join("\r\n").sub('<filename>', File.basename(file.path))
+
+    times_called = 0
+    upload_size = 0
+
+    Net::HTTP::UploadProgress.new(req) do |progress|
+      times_called += 1
+      upload_size += progress.upload_size - upload_size
+    end
+
+    res = http.request(req)
+
+    file.close!
+
+    it 'correctly transmits data to the server' do
+      assert_equal(content, res.body)
+    end
+
+    it 'updates progress expected number of times' do
+      assert_equal(1, times_called)
+    end
+
+    it 'updates progress with correct upload size' do
+      assert_equal(multipart_content.length, upload_size)
+    end
+  end
+end

metadata

@@ -1,51 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: net-http-uploadprogress
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - SKAhack
+- Vais Salikhov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-25 00:00:00.000000000Z
-dependencies: []
+date: 2015-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Get the file uploading progress.
 email:
 - m@skahack.com
+- vsalikhov@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - lib/net/http/uploadprogress.rb
 - lib/version.rb
 - net-http-uploadprogress.gemspec
+- spec/uploadprogress_spec.rb
 homepage: https://github.com/SKAhack/net-http-uploadprogress
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ~>
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: net-http-uploadprogress
-rubygems_version: 1.8.6
+rubyforge_project: 
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Get the file uploading progress.
-test_files: []
+test_files:
+- spec/uploadprogress_spec.rb