ruby-uploader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b93b4e72c413098bf95988e6f3d5ba6ab4f89af0
+  data.tar.gz: 3ea0d6b6c6c68974fc6a82e8cc7517a43bca2032
+SHA512:
+  metadata.gz: 89d5c96002f7a444ab483f36724995d37639c8c7f5e5e3b0ef77c3a691684f4fd6dcb136f286f3d0b6c12568f438a3dd7bdc1e30eee51871ff9338b3f93ba589
+  data.tar.gz: 19c0ef8fe7aefa7492d14ea980e2e9d80aec16558375914a67eda10260a726c5c5e63cf6836f40658de3a2764e0c0b780dda814702459b7bdd3b7ecf730d57d1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+*.swp
+*.iml
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Style/Documentation:
+  Enabled: false
+
+Style/LineLength:
+  Max: 120
+
+Style/MethodLength:
+  Max: 35

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rubocop', '0.23.0', require: false
+  gem 'rake'
+end
+
+group :debug do
+  gem 'byebug'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Guillaume Giamarchi
+
+MIT License
+
+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.md

@@ -0,0 +1,108 @@
+# Ruby Uploader
+
+This library provides a simple HTTP uploader based on chunks transfer. It supports handlers,
+useful to make custom request configuration and to read the progression of the file transfer.
+
+## Quickstart
+
+First, install `ruby-uploader`
+
+```
+gem install ruby-uploader
+```
+
+`ruby-uploader` set the necessary headers and configure the request to enable chunk transfer.
+Below, the most basic example do not require any configuration
+
+```ruby
+require 'ruby-uploader/uploader'
+
+uploader = Uploader::Upload.new(URI('https://server/path/to/upload'), 'myfile.bin')
+
+uploader.execute
+```
+
+Optionally, headers can be set using a Hash parameter
+
+```ruby
+uploader = Uploader::Upload.new(URI('https://server/path/to/upload'), 'myfile.bin', { 'custom-header' => 'value' })
+
+uploader.execute
+```
+
+For more configuration capabilities, see the Handlers section
+
+## Handlers
+
+`ruby-uploader` support handlers at four different steps of the upload request process
+* Before the request is fired
+* Before each chunk is sent
+* After each chunk has been sent
+* After the HTTP response is received
+
+Set a handler is done usine the method `add_handler` on the `Upload` object. several handlers
+can be add on the uploader, even several of the same type.
+
+### Add a `:before` handler
+
+This handler is triggered before the request is fired. It give access to the request object
+which is an instance of type `Net::HTTPRequest` from the `net/http` standard API.
+
+```ruby
+class BeforeRequest
+  def execute(request)
+    ...
+  end
+end
+
+uploader.add_handler :before, BeforeRequest.new
+```
+
+### Add a `:before_chunk` handler
+
+This handler is triggered for each chunk, before it is sent to the server. It give access to the
+following information :
+* `chunk` - the chunk of data 
+* `count` - the number of the chunk (first chunk is `0`)
+* `total_count` - total number of chunks to transfer 
+* `content_length` - the value of the corresponding HTTP header
+
+```ruby
+class BeforeChunk
+  def execute(chunk, count, total_count, content_length)
+    ...
+  end
+end
+
+uploader.add_handler :before_chunk, BeforeChunk.new
+```
+
+### Add a `:after_chunk` handler
+
+This handler is triggered for each chunk, after it has been sent to the server. Its structure is
+identical to the one of the `before_chunk` handler
+
+```ruby
+class AfterChunk
+  def execute(chunk, count, total_count, content_length)
+    ...
+  end
+end
+
+uploader.add_handler :after_chunk, AfterChunk.new
+```
+
+### Add a `:after` handler
+
+This handler is triggered after the response is received for the server. It give access to the
+response object which is an instance of type `Net::HTTPResponse` from the `net/http` standard API.
+
+```ruby
+class AfterRequest
+  def execute(response)
+    ...
+  end
+end
+
+uploader.add_handler :after, AfterRequest.new
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rubocop/rake_task'
+
+Bundler::GemHelper.install_tasks
+RuboCop::RakeTask.new
+
+task default: %w(rubocop)

data/lib/ruby-uploader/uploader.rb

@@ -0,0 +1,111 @@
+require 'net/http'
+require 'uri'
+
+module Uploader
+  class Upload
+    def initialize(url, path, headers = nil)
+      @url = url
+      @headers  = headers
+      @path     = path
+      @response = nil
+      @handlers = {
+        before:       [],
+        after:        [],
+        before_chunk: [],
+        after_chunk:  []
+      }
+    end
+
+    def execute
+      Net::HTTP.start(@url.host, @url.port, use_ssl: @url.scheme == 'https') do |http|
+
+        headers = @headers ? default_headers.merge(@headers) : default_headers
+
+        request = Put.new(@url, headers, @handlers).tap do |r|
+          r.body_stream = File.open(@path)
+        end
+
+        @handlers[:before].each do |handler|
+          handler.execute request
+        end
+
+        @response = http.request(request)
+
+        @handlers[:after].each do |handler|
+          handler.execute @response
+        end
+
+        @response
+      end
+    end
+
+    def add_handler(phase, handler)
+      fail "Handler phase #{phase} does not exists" unless @handlers.key? phase
+      @handlers[phase] << handler
+    end
+
+    private
+
+    def default_headers
+      {
+        'Content-Type'      => 'application/octet-stream',
+        'Content-Length'    => File.stat(@path).size.to_s,
+        'Transfer-Encoding' => 'chunked'
+      }
+    end
+
+    class Put < Net::HTTP::Put
+      def initialize(path, headers, handlers)
+        @handlers = handlers
+        super path, headers
+      end
+
+      private
+
+      def send_request_with_body_stream(sock, ver, path, f)
+        write_header sock, ver, path
+        wait_for_continue sock, ver if sock.continue_timeout
+        chunker = Chunker.new(sock, self['Content-Length'], @handlers)
+        IO.copy_stream(f, chunker)
+        chunker.finish
+      end
+
+      class Chunker
+        def initialize(sock, content_length, handlers)
+          @sock = sock
+          @prev = nil
+          @count = 0
+          @total_count = nil
+          @content_length = content_length.to_i
+          @handlers = handlers
+        end
+
+        def write(buf)
+          @total_count = @content_length / buf.bytesize.to_i if @total_count.nil?
+
+          @handlers[:before_chunk].each do |handler|
+            handler.execute buf, @count, @total_count, @content_length
+          end
+
+          puts "#{@count} / #{@total_count}"
+
+          @sock.write("#{buf.bytesize.to_s(16)}\r\n")
+          rv = @sock.write(buf)
+          @sock.write("\r\n")
+
+          @count += 1
+
+          @handlers[:after_chunk].each do |handler|
+            handler.execute buf, @count, @total_count, @content_length
+          end
+
+          rv
+        end
+
+        def finish
+          @sock.write("0\r\n\r\n")
+        end
+      end
+    end
+  end
+end

data/lib/ruby-uploader/version.rb

@@ -0,0 +1,3 @@
+module Uploader
+  VERSION = '0.1.0'
+end

data/ruby-uploader.gemspec

@@ -0,0 +1,16 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby-uploader/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'ruby-uploader'
+  gem.version       = Uploader::VERSION
+  gem.authors       = ['Guillaume Giamarchi']
+  gem.email         = ['guillaume.giamarchi@gmail.com']
+  gem.licenses      = ['MIT']
+  gem.description   = 'Ruby HTTP chunked uploader with transfert progress'
+  gem.summary       = 'Ruby HTTP chunked uploader with transfert progress'
+  gem.homepage      = 'https://github.com/ggiamarchi/ruby-uploader'
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: ruby-uploader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guillaume Giamarchi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-28 00:00:00.000000000 Z
+dependencies: []
+description: Ruby HTTP chunked uploader with transfert progress
+email:
+- guillaume.giamarchi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rubocop.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby-uploader/uploader.rb
+- lib/ruby-uploader/version.rb
+- ruby-uploader.gemspec
+homepage: https://github.com/ggiamarchi/ruby-uploader
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Ruby HTTP chunked uploader with transfert progress
+test_files: []