nabit 0.2.0

data/LICENSE

@@ -0,0 +1,53 @@
+Copyright (c) 2012, Jon Maken
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of Jon Maken nor the names of any contributors may be
+  used to endorse or promote products derived from this software without
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+=== MiniPortile License ===
+
+Copyright (c) 2011 Luis Lavena.
+
+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.mkd

@@ -0,0 +1,60 @@
+## What?
+
+A minimalistic, pure-Ruby HTTP/HTTPS/FTP file downloader library with a command
+line interface.
+
+## Usage
+
+    HTTP/HTTPS/FTP File Downloader, v0.2.0
+    Usage: nabit URL [FILE]
+
+      URL   http/https/ftp location of the file to download
+      FILE  local path at which to save downloaded file
+
+
+    influential environment variables:
+
+      HTTP_PROXY    url to http proxy
+      CA_CERT_FILE  full path to CA certificate file
+
+### CLI Usage Examples
+
+    cd %USERPROFILE%\Downloads
+    nabit http://pyyaml.org/download/libyaml/yaml-0.1.4.tar.gz
+
+    nabit http://sqlite.org/sqlite-autoconf-3071100.tar.gz c:\temp\sqlite-latest.tar.gz
+
+    nabit ftp://sourceware.org/pub/libffi/libffi-3.0.10.tar.gz "$HOME/downloads/libffi-3.0.10.tar.gz"
+
+    set CA_CERT_FILE=c:\tools\cacert.pem
+    nabit https://github.com/downloads/thecodeshop/ruby/w32time.7z c:/temp/w32time.7z
+
+### Library Usage Example
+
+    require 'rubygems'  # only for Ruby < 1.9
+    require 'nabit'
+
+    ENV['CA_CERT_FILE'] ||= '/etc/ssl/certs/ca-certificates.crt
+    target = File.expand_path('~/downloads/secret-codes-20120327.tar.xz')
+    source = 'https://unbreakable.area51.io/secret-codes.tar.xz'
+
+    nab = Nabit::Downloader.new
+    nab.download_file(source, target)
+
+### Local Build and Install
+
+    git clone https://github.com/jonforums/nabit.git
+    cd nabit
+    rake package
+    gem install pkg/nabit-X.Y.Z.gem [--user-install]
+
+## License
+
+3-clause BSD. Portions from MiniPortile's HTTP implementation. See project LICENSE file.
+
+## TODO
+
+* investigate low-level, cross-platform socket tweaks
+* add user/pw FTP support
+* test proxy impl
+* test with JRuby on Windows and Arch

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rubygems/package_task'
+
+GEM_SPEC = eval File.read('nabit.gemspec')
+Gem::PackageTask.new(GEM_SPEC) do |pkg|
+end

data/bin/nabit

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+require 'nabit/version'
+
+module Nabit
+
+  def self.usage
+    <<-EOU
+
+HTTP/HTTPS/FTP File Downloader, v#{Nabit::VERSION}
+Usage: nabit URL [FILE]
+
+  URL   http/https/ftp location of the file to download
+  FILE  local path at which to save downloaded file
+
+
+influential environment variables:
+
+  HTTP_PROXY    url to http proxy
+  CA_CERT_FILE  full path to CA certificate file
+
+    EOU
+  end
+
+  class Runner
+    def self.run(args, options = {})
+      # XXX dodgy `File.basename` on URI for default filename, do post `URI.parse`?
+      file_name = args[1] ? File.expand_path(args[1]) :
+                            File.expand_path(File.basename(args[0]))
+
+      Nabit::Downloader.new.download_file(args[0], file_name)
+    end
+  end
+
+end
+
+_args = ARGV.dup
+abort Nabit.usage unless (1..2).include?(_args.length)
+
+require 'nabit'
+Nabit::Runner.run(_args)

data/lib/nabit.rb

@@ -0,0 +1,2 @@
+require 'nabit/version'
+require 'nabit/downloader'

data/lib/nabit/downloader.rb

@@ -0,0 +1,176 @@
+require 'net/http'
+require 'net/https' if RUBY_VERSION < '1.9'
+require 'net/ftp'
+require 'fileutils'
+require 'tempfile'
+
+module Nabit
+
+  class Downloader
+
+    attr_accessor :logger, :max_ca_verify_depth, :ftp_data_chunk_size
+
+    def initialize
+      @logger = STDOUT.binmode
+      @max_ca_verify_depth = 5
+      @ftp_data_chunk_size = 32768
+    end
+
+    def download_file(url, full_path, count = 3)
+      return if File.exists?(full_path)
+
+      uri = URI.parse(url)
+      case uri.scheme.downcase
+      when /ftp/
+        ftp_download(uri, full_path)
+      when /http|https/
+        http_download(url, full_path, count)
+      else
+        raise "\nERROR: Unknown URI scheme '#{uri.scheme}'"
+      end
+    end
+
+
+  private
+    def message(text)
+      @logger.print text
+      @logger.flush
+    end
+
+    def output(text = '')
+      @logger.puts text
+      @logger.flush
+    end
+
+    def http_download(url, full_path, count)
+
+      begin
+        uri = URI.parse(url)
+        filename = File.basename(uri.path)
+
+        if ENV['HTTP_PROXY']
+          protocol, userinfo, proxy_host, proxy_port  = URI::split(ENV['HTTP_PROXY'])
+          proxy_user, proxy_pass = userinfo.split(/:/) if userinfo
+          http = Net::HTTP.new(uri.host, uri.port, proxy_host, proxy_port, proxy_user, proxy_pass)
+        else
+          http = Net::HTTP.new(uri.host, uri.port)
+        end
+
+        if uri.scheme.downcase == 'https'
+          http.use_ssl = true
+          if ENV['CA_CERT_FILE']
+            cert_file = ENV['CA_CERT_FILE'].dup
+            cert_file.gsub!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
+          end
+          if cert_file && File.exists?(cert_file)
+            http.ca_file = cert_file
+            http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+            http.verify_depth = @max_ca_verify_depth
+          else
+            raise <<-EOT
+To download using HTTPS you must first set the CA_CERT_FILE
+environment variable to the path of a valid CA certificate file.
+A file of bundled public CA certs may be downloaded from:
+
+   http://curl.haxx.se/ca/cacert.pem
+
+            EOT
+          end
+        end
+
+        http.request_get(uri.path) do |response|
+          case response
+          when Net::HTTPNotFound
+            output "404 - Not Found"
+            return false
+
+          when Net::HTTPClientError
+            output "Error: Client Error: #{response.inspect}"
+            return false
+
+          when Net::HTTPRedirection
+            raise "Too many redirections for the original URL, halting." if count <= 0
+            url = response["location"]
+            return http_download(url, full_path, count - 1)
+
+          when Net::HTTPOK
+            temp_file = Tempfile.new("download-#{filename}")
+            temp_file.binmode
+
+            size = 0
+            progress = 0
+            total = response.header["Content-Length"].to_i
+
+            response.read_body do |chunk|
+              temp_file << chunk
+              size += chunk.size
+              new_progress = (size * 100) / total
+              unless new_progress == progress
+                message "\rDownloading %s (%3d%%) " % [filename, new_progress]
+              end
+              progress = new_progress
+            end
+
+            output
+
+            temp_file.close
+            File.unlink full_path if File.exists?(full_path)
+            FileUtils.mkdir_p File.dirname(full_path)
+            FileUtils.mv temp_file.path, full_path, :force => true
+          end
+        end
+
+      rescue Exception => e
+        File.unlink full_path if File.exists?(full_path)
+        output "ERROR: #{e.message}"
+        raise "Failed to download file"
+      end
+    end
+
+    def ftp_download(parsed_uri, full_path)
+      filename = File.basename(parsed_uri.path)
+
+      begin
+        temp_file = Tempfile.new("download-#{filename}")
+        temp_file.binmode
+
+        size = 0
+        progress = 0
+
+        # TODO add user/pw support
+        Net::FTP.open(parsed_uri.host) do |ftp|
+          ftp.passive = true
+          ftp.login
+          remote_dir = File.dirname(parsed_uri.path)
+          ftp.chdir(remote_dir) unless remote_dir == '.'
+
+          total = ftp.size(filename)
+
+          ftp.getbinaryfile(filename, nil, @ftp_data_chunk_size) do |chunk|
+            temp_file << chunk
+            size += chunk.size
+            new_progress = (size * 100) / total
+            unless new_progress == progress
+              message "\rDownloading %s (%3d%%) " % [filename, new_progress]
+            end
+            progress = new_progress
+          end
+        end
+
+        output
+
+        temp_file.close
+        File.unlink full_path if File.exists?(full_path)
+        FileUtils.mkdir_p File.dirname(full_path)
+        FileUtils.mv temp_file.path, full_path, :force => true
+
+      rescue Exception => e
+        File.unlink full_path if File.exists?(full_path)
+        output "ERROR: #{e.message}"
+        raise "Failed to download file"
+      end
+    end
+
+  end
+
+end

data/lib/nabit/version.rb

@@ -0,0 +1,3 @@
+module Nabit
+  VERSION = '0.2.0'
+end

data/nabit.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path('../lib/nabit/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'nabit'
+  s.version = Nabit::VERSION
+  s.platform = Gem::Platform::RUBY
+
+  s.summary = 'A pure-Ruby HTTP/HTTPS/FTP file downloader'
+  s.description = <<-EOT
+A pure-Ruby, minimal dependency HTTP/HTTPS/FTP file downloading library
+with a sparse CLI.
+  EOT
+  s.license = '3-clause BSD'
+  s.homepage = 'http://github.com/jonforums/nabit.git'
+
+  s.author = 'Jon Maken'
+  s.email = 'jon.forums@gmail.com'
+
+  s.files = FileList["lib/**/*.rb", "Rakefile", "nabit.gemspec", "LICENSE", "README.mkd"]
+  s.executable = 'nabit'
+
+  s.required_ruby_version = ">= 1.8.7"
+  s.required_rubygems_version = ">= 1.7.2"
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: nabit
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Jon Maken
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-19 00:00:00.000000000 Z
+dependencies: []
+description: ! 'A pure-Ruby, minimal dependency HTTP/HTTPS/FTP file downloading library
+
+  with a sparse CLI.
+
+'
+email: jon.forums@gmail.com
+executables:
+- nabit
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/nabit/downloader.rb
+- lib/nabit/version.rb
+- lib/nabit.rb
+- Rakefile
+- nabit.gemspec
+- LICENSE
+- README.mkd
+- bin/nabit
+homepage: http://github.com/jonforums/nabit.git
+licenses:
+- 3-clause BSD
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.7.2
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.22
+signing_key: 
+specification_version: 3
+summary: A pure-Ruby HTTP/HTTPS/FTP file downloader
+test_files: []