easy_downloader 0.0.1.alpha → 0.0.2.alpha

data/Gemfile

@@ -1,13 +1,16 @@
 source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
-#   gem "activesupport", ">= 2.3.5"
+gem "activesupport", "~> 3.0.3"
+gem 'net-sftp'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
+  gem 'ruby-debug'
   gem "rspec", "~> 2.1.0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.1"
   gem "rcov", ">= 0"
+  gem 'yard'
 end

data/Gemfile.lock

@@ -1,12 +1,18 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (3.0.3)
+    columnize (0.3.2)
     diff-lcs (1.1.2)
     git (1.2.5)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
+    linecache (0.43)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.0.23)
     rake (0.8.7)
     rcov (0.9.9)
     rspec (2.1.0)
@@ -17,12 +23,22 @@ GEM
     rspec-expectations (2.1.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.1.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    yard (0.6.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport (~> 3.0.3)
   bundler (~> 1.0.0)
   jeweler (~> 1.5.1)
+  net-sftp
   rcov
   rspec (~> 2.1.0)
+  ruby-debug
+  yard

data/Rakefile

@@ -15,7 +15,7 @@ Jeweler::Tasks.new do |gem|
   gem.name = "easy_downloader"
   gem.homepage = "http://github.com/btelles/easy_downloader"
   gem.license = "MIT"
-  gem.summary = %Q{One-method downloading, with error handling and friendly messages}
+  gem.summary = %Q{A dead simple, one-method downloader, with friendly error messages}
   gem.description = %Q{ EasyDownloader reduces the amount of work required to setup and check for errors when downloading from another location. This 
                       is useful when, for example, a client wants to you to pick a file up from their FTP, SFTP, or regular website on a nightly basis.
                       EasyDownloader gives you a one-method means of downloading those files, returns with a friendly error message if it fails

data/VERSION

@@ -1 +1 @@
-0.0.1.alpha
+0.0.2.alpha

data/easy_downloader.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{easy_downloader}
-  s.version = "0.0.1.alpha"
+  s.version = "0.0.2.alpha"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bernardo Telles"]
@@ -30,16 +30,21 @@ Gem::Specification.new do |s|
     "VERSION",
     "easy_downloader.gemspec",
     "lib/easy_downloader.rb",
-    "spec/easy_downloader_spec.rb",
+    "lib/easy_downloader/ftp_downloader.rb",
+    "lib/easy_downloader/http_downloader.rb",
+    "lib/easy_downloader/options.rb",
+    "lib/easy_downloader/result.rb",
+    "lib/easy_downloader/sftp_downloader.rb",
+    "spec/easy_downloader/options_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/btelles/easy_downloader}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{One-method downloading, with error handling and friendly messages}
+  s.summary = %q{A dead simple, one-method downloader, with friendly error messages}
   s.test_files = [
-    "spec/easy_downloader_spec.rb",
+    "spec/easy_downloader/options_spec.rb",
     "spec/spec_helper.rb"
   ]
 
@@ -48,21 +53,33 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.3"])
+      s.add_runtime_dependency(%q<net-sftp>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
     else
+      s.add_dependency(%q<activesupport>, ["~> 3.0.3"])
+      s.add_dependency(%q<net-sftp>, [">= 0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.1.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
       s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
     end
   else
+    s.add_dependency(%q<activesupport>, ["~> 3.0.3"])
+    s.add_dependency(%q<net-sftp>, [">= 0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.1.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
     s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
   end
 end
 

data/lib/easy_downloader.rb

@@ -0,0 +1,73 @@
+require 'easy_downloader/result'
+require 'easy_downloader/options'
+require 'easy_downloader/sftp_downloader'
+require 'easy_downloader/ftp_downloader'
+require 'easy_downloader/http_downloader'
+require 'net/sftp'
+module EasyDownloader
+
+  class InvalidRemoteDirectory < Exception; end
+  def self.download(*options)
+    Downloader.new(*options)
+  end
+
+  class Downloader
+    attr_reader :files, :result
+
+    include SftpDownloader
+    include FtpDownloader
+    include HttpDownloader
+
+
+    # Set up and immediately download files. The object has only two attributes:
+    #   1. result
+    #   2. files
+    #
+    #  @param [Hash, #options] options to use including host, password, source, and destination directories.%
+    #    The available keys are:
+    #
+    #    :type =>  (required) The protocal used to download the file. One of :sftp, :ftp or :http.
+    #    :host =>  (required) the domain of the remote server (source)
+    #    :remote_path => a relative path to "cd" into when we first access the remote server
+    #    :remote_pattern => a glob pattern that will select only the files we want to download.%
+    #       see Ruby's core API if you are not familiar with this concept.
+    #    :user =>  a username or login used for authenticating on the server
+    #    :password =>  a password that, in combination with the user, will grant access to the remote server/host
+    def initialize(*options)
+      @options= Options.new(*options)
+      download
+      @result = @options.result
+      @files  = @result.files_downloaded
+    end
+
+    private
+
+    def download
+      begin
+        case @options.type
+        when :ftp
+          ftp_download(@options)
+        when :http
+          http_download(@options)
+        when :sftp
+          sftp_download(@options)
+        end
+
+      rescue Exception => e
+        @options.result.errors= <<-ERROR_MESSAGE
+  There was a problem downloading from #{@options.host}.
+  The error we got was:
+      #{e.message}
+      #{e.backtrace.inspect}
+  We tried connecting with:
+  host: #{@options.host}
+  user: #{@options.user}
+  pass: [filtered]
+  directory_path: #{@options.remote_path}
+  file_pattern: #{@options.remote_pattern}
+  destination: #{@options.local_path}
+        ERROR_MESSAGE
+      end
+    end
+  end
+end

data/lib/easy_downloader/ftp_downloader.rb

@@ -0,0 +1,39 @@
+require 'net/ftp'
+module EasyDownloader
+  module FtpDownloader
+    def ftp_download(options)
+      download_count = options.download_count
+      result = options.result
+      result.started
+      Net::FTP.open(options.host,
+                    options.user,
+                    ftp_password_option(options.password)) do |ftp|
+
+        begin
+          ftp.chdir(options.remote_path) 
+        rescue InvalidRemoteDirectory
+        end
+
+        files = ftp.nlst.select {|file_name| options.remote_pattern == '*' || file_name =~ Regexp.new(options.remote_pattern) }
+        puts files.join("\n")
+        total = files.size
+        result.found(files.size, files)
+
+        files.each do |path|
+          result.starting_path(path)
+          ftp.get(path, "#{options.local_path}#{path}")
+          download_count += 1 
+          result.finished_path(path)
+          result.files_downloaded << "#{options.local_path}#{path}"
+        end
+      end
+
+      result.downloaded(download_count)
+      result.finished
+    end
+
+    def ftp_password_option(password)
+      password ? password : nil
+    end
+  end
+end

data/lib/easy_downloader/http_downloader.rb

@@ -0,0 +1,30 @@
+module HttpDownloader
+  def http_download(options)
+    #result = options.result
+    #result.started
+    #Net::SFTP.start(options.host,
+    #                options.user,
+    #                password_option(options.password)) do |sftp|
+
+    #  files = sftp.dir.glob(options.remote_path, options.remote_pattern)
+    #  total = files.size
+    #  result.found(files.size, files.map(&:name))
+
+    #  files.map(&:name).each do |path|
+    #    result.starting_path(path)
+    #    download_count += 1 if sftp.download!("#{options.remote_path}#{path}", "#{options.destination_dir}#{path}")
+    #    result.finished_path(path)
+    #    files_downloaded << "#{options.destination_dir}#{path}"
+    #  end
+    #end
+
+    #result.downloaded(download_count)
+    #result.finished
+  end
+
+  def password_option(password)
+    password ?
+      {:password => password} :
+      Hash.new
+  end
+end

data/lib/easy_downloader/options.rb

@@ -0,0 +1,30 @@
+require 'active_support/core_ext/array/extract_options'
+module EasyDownloader
+  class Options
+    attr_accessor :files, :successful, :result, :download_count,
+                  :type, :host, :user, :password, :local_path,
+                  :destination_dir, :remote_path, :remote_pattern
+
+    def initialize(*options)
+      @files = []
+      @successful      = false
+      @result          = Result.new
+      @download_count = 0
+      @options = options
+
+      options.extract_options!.each do |key, value|
+        send("#{key}=".to_sym, value) if respond_to?("#{key}=".to_sym)
+      end
+    end
+
+    def type
+      @type.to_sym
+    end
+
+    def local_path
+      @local_path =~ /\/$/ ?
+        @local_path :
+        @local_path + '/'
+    end
+  end
+end

data/lib/easy_downloader/result.rb

@@ -0,0 +1,71 @@
+module EasyDownloader
+  class Result
+    attr_accessor :errors, :files_downloaded
+
+    def initialize
+      @header, @started, @finished, @errors= ''
+      @files_downloaded = []
+      @progress = ["Progress:"]
+    end
+
+    def to_s 
+      [@header,
+       found_list,
+       started_string,
+       progress,
+       @errors,
+       finished_string,
+       @footer].join("\n")
+    end
+
+    def found(total_found, file_names)
+      @found = total_found
+      @header= "We found #{total_found} file(s) to download with the following names: \n"
+      @found_list = file_names
+    end
+
+    def started
+      @started= Time.now
+    end
+
+    def finished
+      @finished= Time.now
+    end
+
+    def downloaded(total)
+      @downloaded = total
+      @footer= "Downloaded #{total} file(s)"
+    end
+
+    def starting_path(path)
+      @progress << "Starting to download #{path}"
+    end
+
+    def finished_path(path)
+      @progress << "Finished downloading #{path}"
+    end
+
+    private 
+
+    def progress
+      @progress.join("\n")
+    end
+
+    def found_list
+      full_list = ''
+      @found_list.each_with_index do |file_name, index|
+        full_list += "##{(index+1).to_s}. #{file_name} "
+      end
+      full_list
+    end
+
+    def started_string
+      "Started downloading at #{@started}"
+    end
+
+    def finished_string
+      "Finished downloading at #{@finished}"
+    end
+
+  end
+end

data/lib/easy_downloader/sftp_downloader.rb

@@ -0,0 +1,33 @@
+module EasyDownloader
+  module SftpDownloader
+    def sftp_download(options)
+      result = options.result
+      result.started
+
+      Net::SFTP.start(options.host,
+                      options.user,
+                      sftp_password_option(options.password)) do |sftp|
+
+        files = sftp.dir.glob(options.remote_path, options.remote_pattern)
+        total = files.size
+        result.found(files.size, files.map(&:name))
+
+        files.map(&:name).each do |path|
+          result.starting_path(path)
+          options.download_count += 1 if sftp.download!("#{options.remote_path}#{path}", "#{options.local_path}#{path}")
+          result.finished_path(path)
+          result.files_downloaded << "#{options.local_path}#{path}"
+        end
+      end
+
+      result.downloaded(options.download_count)
+      result.finished
+    end
+
+    def sftp_password_option(password)
+      password ?
+        {:password => password} :
+        Hash.new
+    end
+  end
+end

data/spec/easy_downloader/options_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+require 'easy_downloader/options'
+
+describe EasyDownloader::Options do
+  context 'Accessors' do
+   [:files, :successful, :result, :download_count,
+    :host, :user, :password, :local_path,
+    :destination_dir, :remote_path, :remote_pattern].each do |accessor|
+     specify {subject.should respond_to(accessor)}
+    end
+  end
+
+  describe "exposes options" do
+    [:host, :user, :password, :remote_path, :remote_pattern, :local_path].each_with_index do |exposable_option, index|
+      it "exposes #{exposable_option}" do
+        option = EasyDownloader::Options.new(exposable_option => "hi there #{index}")
+        option.send(exposable_option).should == "hi there #{index}"
+      end
+    end
+    it "exposes type as a symbol" do
+      option = EasyDownloader::Options.new(:type => "hithere")
+      option.type.should == :hithere
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
+require 'ruby-debug'
 require 'easy_downloader'
 
 # Requires supporting files with custom matchers and macros, etc,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: easy_downloader
 version: !ruby/object:Gem::Version 
-  hash: 296151482
+  hash: 296151478
   prerelease: true
   segments: 
   - 0
   - 0
-  - 1
+  - 2
   - alpha
-  version: 0.0.1.alpha
+  version: 0.0.2.alpha
 platform: ruby
 authors: 
 - Bernardo Telles
@@ -21,6 +21,50 @@ default_executable:
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  requirement: *id001
+  prerelease: false
+  type: :runtime
+  name: activesupport
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  prerelease: false
+  type: :runtime
+  name: net-sftp
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  prerelease: false
+  type: :development
+  name: ruby-debug
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -31,12 +75,12 @@ dependencies:
         - 1
         - 0
         version: 2.1.0
-  requirement: *id001
+  requirement: *id004
   prerelease: false
   type: :development
   name: rspec
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,12 +91,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  requirement: *id002
+  requirement: *id005
   prerelease: false
   type: :development
   name: bundler
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -63,12 +107,12 @@ dependencies:
         - 5
         - 1
         version: 1.5.1
-  requirement: *id003
+  requirement: *id006
   prerelease: false
   type: :development
   name: jeweler
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,10 +121,24 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
+  requirement: *id007
   prerelease: false
   type: :development
   name: rcov
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id008
+  prerelease: false
+  type: :development
+  name: yard
 description: " EasyDownloader reduces the amount of work required to setup and check for errors when downloading from another location. This \n                      is useful when, for example, a client wants to you to pick a file up from their FTP, SFTP, or regular website on a nightly basis.\n                      EasyDownloader gives you a one-method means of downloading those files, returns with a friendly error message if it fails\n                      (geared at cron job notifications), or returns an array of file names it downloaded."
 email: btelles@gmail.com
 executables: []
@@ -101,7 +159,12 @@ files:
 - VERSION
 - easy_downloader.gemspec
 - lib/easy_downloader.rb
-- spec/easy_downloader_spec.rb
+- lib/easy_downloader/ftp_downloader.rb
+- lib/easy_downloader/http_downloader.rb
+- lib/easy_downloader/options.rb
+- lib/easy_downloader/result.rb
+- lib/easy_downloader/sftp_downloader.rb
+- spec/easy_downloader/options_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/btelles/easy_downloader
@@ -138,7 +201,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: One-method downloading, with error handling and friendly messages
+summary: A dead simple, one-method downloader, with friendly error messages
 test_files: 
-- spec/easy_downloader_spec.rb
+- spec/easy_downloader/options_spec.rb
 - spec/spec_helper.rb

data/spec/easy_downloader_spec.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "EasyDownloader" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
-end