net-github-upload 0.0.7 → 0.0.8

data/README.rdoc

@@ -1,7 +1,7 @@
 = Ruby Net::GitHub::Upload
 
 * http://github.com/Constellation/ruby-net-github-upload
-* http://gemcutter.org/gems/net-github-upload
+* http://rubygems.org/gems/net-github-upload
 
 == DESCRIPTION
 
@@ -27,7 +27,8 @@ respect to http://github.com/typester/net-github-upload-perl
   direct_link = gh.upload(
     :repos => repos,
     :file  => 'test/test',
-    :description => "test file"
+    :description => "test file",
+    :upload_timeout => 600 # Allow yourself time to upload larger files.
   )
   # direct link is link to Amazon S3.
   # Because GitHub refrection for file changing is async,
@@ -41,7 +42,7 @@ respect to http://github.com/typester/net-github-upload-perl
     :data  => 'test',
     :name  => "test_#{time}.txt",
     :content_type => 'text/plain',
-    :description => "test file2"
+    :description => "test file2"    
   )
   
   # replace file or data
@@ -58,6 +59,17 @@ respect to http://github.com/typester/net-github-upload-perl
     :content_type => 'text/plain',
     :description => "test file2"
   )
+  
+  # Printing out progress (will yield to block once a second):
+  direct_link = gh.upload(
+    :repos => repos,
+    :file  => 'test/test',
+    :description => "test file",
+    :upload_timeout => 600 # Allow yourself time to upload larger files.
+  ) do
+    print "."
+  end
+  puts "."
 
 == DEPENDENCY
 
@@ -71,6 +83,11 @@ respect to http://github.com/typester/net-github-upload-perl
   gem source -a http://gemcutter.org
   sudo gem install net-github-upload
 
+== DEVELOPERS
+
+id:Constellation
+id:Spooner
+
 == LICENSE
 
 Ruby Net::Github::Upload

data/Rakefile

@@ -1,87 +1,30 @@
 # vim: fileencoding=utf-8
 require 'rubygems'
+require 'bundler/setup'
 require 'rake'
 require 'rake/clean'
 require 'rake/testtask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rake/contrib/sshpublisher'
-require './lib/net/github-upload'
-
-$version = Net::GitHub::Upload::VERSION
-$readme = 'README.rdoc'
-$rdoc_opts = %W(--main #{$readme} --charset utf-8 --line-numbers --inline-source)
-$name = 'net-github-upload'
-$github_name = 'ruby-net-github-upload'
-$summary = 'ruby porting of Net::GitHub::Upload'
-$description = <<-EOS
-Ruby Net::GitHub::Upload is upload user agent for GitHub Downloads
-EOS
-$author = 'Constellation'
-$email = 'utatane.tea@gmail.com'
-$page = 'http://github.com/Constellation/ruby-net-github-upload'
-$rubyforge_project = 'ruby-net-github-upload'
-
+require 'rdoc/task'
 
 task :default => [:test]
 task :package => [:clean]
 
+Bundler::GemHelper.install_tasks
+
 Rake::TestTask.new("test") do |t|
   t.libs << "test"
   t.pattern = "test/**/*_test.rb"
   t.verbose = true
 end
 
-spec = Gem::Specification.new do |s|
-  s.name = $name
-  s.version = $version
-  s.platform = Gem::Platform::RUBY
-  s.has_rdoc = true
-  s.extra_rdoc_files = [$readme]
-  s.rdoc_options += $rdoc_opts
-  s.summary = $summary
-  s.description = $description
-  s.author = $author
-  s.email = $email
-  s.homepage = $page
-  s.executables = $exec
-  s.rubyforge_project = $rubyforge_project
-  s.require_path = 'lib'
-  s.test_files = Dir["test/*_test.rb"]
-  s.add_dependency('nokogiri', '>=1.4.0')
-  s.add_dependency('faster_xml_simple')
-  s.add_dependency('json')
-  s.add_dependency('httpclient')
-  s.files = %w(README.rdoc Rakefile) + Dir["{bin,test,lib}/**/*"]
-end
-
-Rake::GemPackageTask.new(spec) do |p|
-  p.need_tar = true
-  p.gem_spec = spec
-end
-
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'doc'
-  rdoc.options += $rdoc_opts
   rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb", "ext/**/*.c")
 end
 
-desc "gem spec"
-task :gemspec do
-  File.open("#{$github_name}.gemspec", "wb") do |f|
-    f << spec.to_ruby
-  end
-end
-
-desc "gem install"
-task :install => [:package] do
-  sh "gem install pkg/#{$name}-#{$version}.gem --local"
-end
-
 desc "gem uninstall"
 task :uninstall do
-  sh "gem uninstall #{$name}"
+  sh "gem uninstall net-github-upload"
 end
 
 # vim: syntax=ruby

data/lib/net/github-upload.rb

@@ -8,7 +8,7 @@ require 'faster_xml_simple'
 module Net
   module GitHub
     class Upload
-      VERSION = '0.0.7'
+      VERSION = '0.0.8'
       def initialize params=nil
         @login = params[:login]
         @token = params[:token]
@@ -18,6 +18,20 @@ module Net
         end
       end
 
+      # Upload a file to github. Will fail if the file already exists.
+      # To upload, either supply :data and :name or :file.
+      #
+      # @param [Hash] info
+      # @option info [String] :content_type ('application/octet-stream') Type of data to send 
+      # @option info [String] :data Data to upload as a file. Requires that the :name option is set.
+      # @option info [String] :description ('') Description of file on Github download page.
+      # @option info [String] :file Path to file to upload.
+      # @option info [String] :name (filename of info[:file] if uploading a file) Name the file will have (not including path) when uploaded.
+      # @option info [Boolean] :replace (false) True to force overwriting of an existing file.
+      # @option info [String] :repos Name of Github project, such as "my_project", which is the repository.
+      # @option info [Float] :upload_timeout (120) Maximum time, in seconds, before abandoning a file upload.
+      # @option info [Float] :yield_interval (1) Interval, in seconds, between yields if block is given.     
+      # @yield [] Optional block will yield every info[:yield_interval] seconds (This can be used, for example, to print "#" every second so users see that the upload is continuing).
       def upload info
         unless info[:repos]
           raise "required repository name"
@@ -70,30 +84,47 @@ module Net
           f << info[:data]
           f.flush
         end
-        stat = HTTPClient.post("http://github.s3.amazonaws.com/", [
-          ['Filename', info[:name]],
-          ['policy', upload_info['policy']],
-          ['success_action_status', 201],
-          ['key', upload_info['path']],
-          ['AWSAccessKeyId', upload_info['accesskeyid']],
-          ['Content-Type', upload_info['content_type'] || 'application/octet-stream'],
-          ['signature', upload_info['signature']],
-          ['acl', upload_info['acl']],
-          ['file', f]
-        ])
-        f.close
-
-        if stat.code == 201
-          return FasterXmlSimple.xml_in(stat.content)['PostResponse']['Location']
+        client = HTTPClient.new
+        client.send_timeout = info[:upload_timeout] if info[:upload_timeout]
+
+        res = begin
+          connection = client.post_async("http://github.s3.amazonaws.com/", [
+              ['Filename', info[:name]],
+              ['policy', upload_info['policy']],
+              ['success_action_status', 201],
+              ['key', upload_info['path']],
+              ['AWSAccessKeyId', upload_info['accesskeyid']],
+              ['Content-Type', upload_info['content_type'] || 'application/octet-stream'],
+              ['signature', upload_info['signature']],
+              ['acl', upload_info['acl']],
+              ['file', f]
+          ])
+
+          until connection.finished?
+            yield if block_given?
+            sleep info[:yield_interval] || 1
+          end
+
+          connection.pop
+        ensure
+          f.close
+        end
+
+        if res.status == 201
+          return FasterXmlSimple.xml_in(res.body.read)['PostResponse']['Location']
         else
-          raise 'Failed to upload' + extract_error_message(stat)
+          raise 'Failed to upload' + extract_error_message(res.body)
         end
       end
 
-      def replace info
-         upload info.merge( :replace => true )
+      # Upload a file and replace it if it already exists on the server.
+      #
+      # @see #upload
+      def replace info = {}, &block
+         upload info.merge( :replace => true ), &block
       end
 
+      # Delete all uploaded files.
       def delete_all repos
         unless repos
           raise "required repository name"
@@ -104,6 +135,7 @@ module Net
         }
       end
 
+      # Delete an individual file (used by #replace when replacing existing files).
       def delete repos, id
         HTTPClient.post("https://github.com/#{repos}/downloads/#{id.gsub( "download_", '')}", {
           "_method"      => "delete",
@@ -112,6 +144,7 @@ module Net
         })
       end
 
+      # List all the files uploaded to a repository.
       def list_files repos
         raise "required repository name" unless repos
         res = HTTPClient.get_content("https://github.com/#{repos}/downloads", {
@@ -144,4 +177,3 @@ module Net
     end
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-github-upload
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-22 00:00:00.000000000Z
+date: 2012-01-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70245485988420 !ruby/object:Gem::Requirement
+  requirement: &70186498494780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70245485988420
+  version_requirements: *70186498494780
 - !ruby/object:Gem::Dependency
   name: faster_xml_simple
-  requirement: &70245485988000 !ruby/object:Gem::Requirement
+  requirement: &70186498494180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70245485988000
+  version_requirements: *70186498494180
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70245485987540 !ruby/object:Gem::Requirement
+  requirement: &70186498493420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70245485987540
+  version_requirements: *70186498493420
 - !ruby/object:Gem::Dependency
   name: httpclient
-  requirement: &70245485987120 !ruby/object:Gem::Requirement
+  requirement: &70186498492880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70245485987120
+  version_requirements: *70186498492880
 description: ! 'Ruby Net::GitHub::Upload is upload user agent for GitHub Downloads
 
 '
@@ -78,7 +78,6 @@ rdoc_options:
 - --charset
 - utf-8
 - --line-numbers
-- --inline-source
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -87,15 +86,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 651643364530444235
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 651643364530444235
 requirements: []
 rubyforge_project: ruby-net-github-upload
-rubygems_version: 1.8.6
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: ruby porting of Net::GitHub::Upload