ruby-uploader 0.1.0 → 0.2.0beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b93b4e72c413098bf95988e6f3d5ba6ab4f89af0
-  data.tar.gz: 3ea0d6b6c6c68974fc6a82e8cc7517a43bca2032
+  metadata.gz: fd101106d2a196a4187ee88b081104e82a89fcbf
+  data.tar.gz: fa919f1520c308250e993ae9e819e74a8c0165a8
 SHA512:
-  metadata.gz: 89d5c96002f7a444ab483f36724995d37639c8c7f5e5e3b0ef77c3a691684f4fd6dcb136f286f3d0b6c12568f438a3dd7bdc1e30eee51871ff9338b3f93ba589
-  data.tar.gz: 19c0ef8fe7aefa7492d14ea980e2e9d80aec16558375914a67eda10260a726c5c5e63cf6836f40658de3a2764e0c0b780dda814702459b7bdd3b7ecf730d57d1
+  metadata.gz: 5b035118f2a4f99eb92183303e33ed4a8f2562a5ac0965829428c7f6297f34eb1884f3a6d40bb0af5e1f21168e08563a7d51f0ebb1756be357b9f3c9789e9e20
+  data.tar.gz: 9df18c686fca68a7522c3e663246b514a414091f8e7c2e06514d057b73060b9cf64608af9b192523dceae9abf90fcbdb23c499692c7988f879aad2fcd4a1eccf

data/.gitignore

@@ -2,3 +2,5 @@
 *.swp
 *.iml
 Gemfile.lock
+.bundle
+pkg

data/.rubocop.yml

@@ -1,3 +1,6 @@
+Style/FileName:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
@@ -6,3 +9,6 @@ Style/LineLength:
 
 Style/MethodLength:
   Max: 35
+
+Style/Encoding:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+install:
+  - travis_retry bundle install --without debug
+script:
+  - bundle exec rake

data/Gemfile

@@ -7,6 +7,10 @@ group :development do
   gem 'rake'
 end
 
+group :samples do
+  gem 'ruby-progressbar'
+end
+
 group :debug do
   gem 'byebug'
 end

data/README.md

@@ -1,5 +1,8 @@
 # Ruby Uploader
 
+[![Build Status](https://api.travis-ci.org/ggiamarchi/ruby-uploader.png?branch=master)](https://travis-ci.org/ggiamarchi/ruby-uploader)
+[![Gem Version](https://badge.fury.io/rb/ruby-uploader.svg)](http://badge.fury.io/rb/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.
 
@@ -15,19 +18,27 @@ gem install ruby-uploader
 Below, the most basic example do not require any configuration
 
 ```ruby
-require 'ruby-uploader/uploader'
+require 'ruby-uploader'
 
 uploader = Uploader::Upload.new(URI('https://server/path/to/upload'), 'myfile.bin')
 
 uploader.execute
 ```
 
-Optionally, headers can be set using a Hash parameter
+or with the more user friendly block syntax
 
 ```ruby
-uploader = Uploader::Upload.new(URI('https://server/path/to/upload'), 'myfile.bin', { 'custom-header' => 'value' })
+Uploader::Upload.new(URI('https://server/path/to/upload'), 'myfile.bin') do
+  execute
+end
+```
 
-uploader.execute
+Optionally, headers can be set using a Hash parameter
+
+```ruby
+Uploader::Upload.new(URI('https://server/path/to/upload'), 'myfile.bin', { 'custom-header' => 'value' }) do
+  execute
+end
 ```
 
 For more configuration capabilities, see the Handlers section
@@ -106,3 +117,50 @@ end
 
 uploader.add_handler :after, AfterRequest.new
 ```
+
+## Putting all together
+
+An uploader with one handler of each kind that just do log.
+
+```ruby
+require 'ruby-uploader'
+require 'logger'
+
+class Handler
+  def initialize
+    @logger = Logger.new(STDOUT)
+  end
+end
+
+class BeforeRequest < Handler
+  def execute(request)
+    @logger.info('start processing request')
+  end
+end
+
+class AfterResponse < Handler
+  def execute(response)
+    @logger.info('finished processing request')
+  end
+end
+
+class BeforeChunk < Handler
+  def execute(buf, count, total_count, content_length)
+    puts "start processing chunk #{count} of #{total_count}"
+  end
+end
+
+class AfterChunk < Handler
+  def execute(buf, count, total_count, content_length)
+    puts "finished processing chunk #{count} of #{total_count}"
+  end
+end
+
+Uploader::Upload.new(URI('https://server/path/to/upload'), 'myfile.bin') do
+  add_handler :before, BeforeRequest.new
+  add_handler :after,  AfterResponse.new
+  add_handler :before_chunk, BeforeChunk.new
+  add_handler :after_chunk, AfterChunk.new
+  execute
+end
+```

data/lib/ruby-uploader/put.rb

@@ -0,0 +1,56 @@
+require 'net/http'
+require 'uri'
+
+module Uploader
+  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
+  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
+
+      @sock.write("#{buf.bytesize.to_s(16)}\r\n")
+      rv = @sock.write(buf)
+      @sock.write("\r\n")
+
+      @handlers[:after_chunk].each do |handler|
+        handler.execute buf, @count, @total_count, @content_length
+      end
+
+      @count += 1
+
+      rv
+    end
+
+    def finish
+      @sock.write("0\r\n\r\n")
+    end
+  end
+end

data/lib/ruby-uploader/upload.rb

@@ -0,0 +1,57 @@
+require 'ruby-uploader/put'
+
+module Uploader
+  class Upload
+    def initialize(url, path, headers = nil, &block)
+      @url = url
+      @headers  = headers
+      @path     = path
+      @response = nil
+      @handlers = {
+        before:       [],
+        after:        [],
+        before_chunk: [],
+        after_chunk:  []
+      }
+      instance_eval(&block) if block_given?
+    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
+  end
+end

data/lib/ruby-uploader/version.rb

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

data/lib/ruby-uploader.rb

@@ -0,0 +1 @@
+require 'ruby-uploader/upload'

data/ruby-uploader.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   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.description   = 'Ruby HTTP chunked uploader with transfer progress'
+  gem.summary       = 'Ruby HTTP chunked uploader with transfer progress'
   gem.homepage      = 'https://github.com/ggiamarchi/ruby-uploader'
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.require_paths = ['lib']

data/samples/upload_progressbar.rb

@@ -0,0 +1,42 @@
+#
+# Sample upload code that shows a progressbar
+# using the library 'ruby-progressbar'
+#
+# Usage:
+#   ruby upload_progressbar.rb http://server file_to_upload
+#
+
+url  = ARGV[0]
+path = ARGV[1]
+
+require 'ruby-uploader'
+require 'logger'
+require 'ruby-progressbar'
+
+class BeforeChunk
+  def initialize(holder)
+    @holder = holder
+  end
+
+  def execute(_, count, total_count, _)
+    return unless count == 0
+    @holder[:progressbar] = ProgressBar.create(starting_at: 0, total: total_count + 1)
+  end
+end
+
+class AfterChunk
+  def initialize(holder)
+    @holder = holder
+  end
+
+  def execute(_, _, _, _)
+    @holder[:progressbar].increment
+  end
+end
+
+Uploader::Upload.new(URI(url), path) do
+  holder = {}
+  add_handler :before_chunk, BeforeChunk.new(holder)
+  add_handler :after_chunk, AfterChunk.new(holder)
+  execute
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: ruby-uploader
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0beta1
 platform: ruby
 authors:
 - Guillaume Giamarchi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-28 00:00:00.000000000 Z
+date: 2014-11-30 00:00:00.000000000 Z
 dependencies: []
-description: Ruby HTTP chunked uploader with transfert progress
+description: Ruby HTTP chunked uploader with transfer progress
 email:
 - guillaume.giamarchi@gmail.com
 executables: []
@@ -19,13 +19,17 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rubocop.yml
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/ruby-uploader/uploader.rb
+- lib/ruby-uploader.rb
+- lib/ruby-uploader/put.rb
+- lib/ruby-uploader/upload.rb
 - lib/ruby-uploader/version.rb
 - ruby-uploader.gemspec
+- samples/upload_progressbar.rb
 homepage: https://github.com/ggiamarchi/ruby-uploader
 licenses:
 - MIT
@@ -41,13 +45,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: Ruby HTTP chunked uploader with transfert progress
+summary: Ruby HTTP chunked uploader with transfer progress
 test_files: []

data/lib/ruby-uploader/uploader.rb

@@ -1,111 +0,0 @@
-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