downer 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nate Miller
+
+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.rdoc

@@ -0,0 +1,14 @@
+= Downer
+
+Downer is a simple personal tool used to download a sequential list of URLs contained in a text file.
+
+== Usage:
+Create a single text file, each line containing a url you wish to download. 
+
+=== From bash:
+$ downer myfile.txt ~/Desktop/myFolder # will donwload each file into the myFolder directory
+
+
+== Copyright
+
+Copyright (c) 2010 Nate Miller. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "downer"
+    gem.summary = "Bulk downloading utitlity"
+    gem.description = "Downer is a tool used to download a list of urls from a website thorugh HTTP."
+    gem.email = "nate@natemiller.org"
+    gem.homepage = "http://github.com/nate63179/downer"
+    gem.authors = ["Nate Miller"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "downer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/downer

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'downer'
+
+app = Downer::Application.new
+exit app.run!(*ARGV)

data/downer.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{downer}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nate Miller"]
+  s.date = %q{2010-07-16}
+  s.default_executable = %q{downer}
+  s.description = %q{Downer is a tool used to download a list of urls from a website thorugh HTTP.}
+  s.email = %q{nate@natemiller.org}
+  s.executables = ["downer"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "bin/downer",
+     "downer.gemspec",
+     "features/step_definitions/downer_steps.rb",
+     "features/support/env.rb",
+     "features/user_starts_downer_with_valid_args.feature",
+     "features/user_starts_downer_without_args.feature",
+     "lib/downer.rb",
+     "lib/downer/application.rb",
+     "lib/downer/download_item.rb",
+     "lib/downer/download_manager.rb",
+     "lib/downer/download_worker.rb",
+     "lib/downer/options.rb",
+     "spec/downer/application_spec.rb",
+     "spec/downer/download_item_spec.rb",
+     "spec/downer/download_manager_spec.rb",
+     "spec/downer/download_worker_spec.rb",
+     "spec/downer/generator_spec.rb",
+     "spec/fixtures/some_images.txt",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "version.yml"
+  ]
+  s.homepage = %q{http://github.com/nate63179/downer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Bulk downloading utitlity}
+  s.test_files = [
+    "spec/downer/application_spec.rb",
+     "spec/downer/download_item_spec.rb",
+     "spec/downer/download_manager_spec.rb",
+     "spec/downer/download_worker_spec.rb",
+     "spec/downer/generator_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/features/step_definitions/downer_steps.rb

@@ -0,0 +1,38 @@
+# Mock objec for simulating outpu
+class Output
+  def messages
+    @messages ||= []
+  end
+
+  def puts(message)
+    messages << message
+  end
+end
+
+def output
+  @output ||= Output.new
+end
+
+# Create temporary file with urls
+def fixture_directory
+  File.expand_path('../../../spec/fixtures', __FILE__)
+end
+
+Given /^I have not started application$/ do
+end
+
+When /^I start a new application without arguments$/ do
+  app = Downer::Application.new(output)
+  app.run!
+end
+
+Then /^I should see "([^"]*)"$/ do |message|
+  output.messages.should include(message)
+end
+
+
+
+When /^I start a new application with valid arguments$/ do
+  app = Downer::Application.new(output)
+  app.run!(fixture_directory + '/some_images.txt', '/tmp')
+end

data/features/support/env.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH << File.expand_path('../../../lib', __FILE__)
+require 'downer'

data/features/user_starts_downer_with_valid_args.feature

@@ -0,0 +1,10 @@
+Feature: user starts downer
+
+  As a user
+  I want to start downer
+  So that I can download a list of files
+  
+  Scenario: start downer
+    Given I have not started application
+    When I start a new application with valid arguments
+    Then I should see "Starting download on 4 files"

data/features/user_starts_downer_without_args.feature

@@ -0,0 +1,10 @@
+Feature: user starts downer
+
+  As a user
+  I want to start downer
+  So that I can download a list of files
+  
+  Scenario: start downer
+    Given I have not started application
+    When I start a new application without arguments
+    Then I should see "Usage: downer URL_SOURCE DESTINATION_DIR"

data/lib/downer/application.rb

@@ -0,0 +1,41 @@
+module Downer
+  class Application
+    
+    attr_accessor :output
+    
+    def initialize(output = nil)
+      @output = (output) ? output : $stdout
+      @options = nil
+    end
+    
+    def run!(*arguments)
+      @options = Downer::Options.new(arguments)
+      
+      if @options[:invalid_argument]
+        @output.puts @options[:invalid_argument]
+        @options[:show_help] = true
+      end
+      
+      return exit_with_help_banner if @options[:file_manifest].nil?
+      return exit_with_help_banner if @options[:target_directory].nil?
+      return exit_with_help_banner if @options[:show_help]
+      
+      begin
+        manager = Downer::DownloadManager.new(@options[:file_manifest], @options[:target_directory], @output)
+        manager.start
+        return 0
+      rescue Downer::WriteFailed
+        @output.puts %Q{Insufficient permissions to write to directory}
+        return 1
+      end
+    end
+    
+    private
+    
+    def exit_with_help_banner
+      @output.puts @options.opts.banner
+      return 1
+    end
+    
+  end
+end

data/lib/downer/download_item.rb

@@ -0,0 +1,58 @@
+module Downer
+  
+  class FailedDownload < StandardError
+    attr_accessor :http_code, :url
+  end
+  
+  class DownloadItem
+    attr_reader :url
+    attr_reader :content
+    
+    def initialize(url, destination)
+      @url, @destination = sanitize_url(url), destination
+      @uri = URI.parse(url)
+    end
+    
+    # Returns the name which this file will be saved as
+    def get_save_filename
+      file_name = @uri.to_s
+      file_name = file_name.gsub(/https?:\/\//,'').split('/').last
+      file_name = file_name.gsub('%5B', '[')
+      file_name = file_name.gsub('%5D', ']')
+      file_name
+      # TODO : refine to auto append file extentions based on content type
+    end
+    
+    def download
+      @http = Net::HTTP.new(@uri.host, @uri.port)
+      req = Net::HTTP::Get.new(@uri.request_uri)
+      response = @http.request(req)
+      
+      if response.code != '200'
+        fd = FailedDownload.new
+        fd.http_code = response.code
+        fd.url = @url
+        raise fd
+      else
+        @content = response.body
+        write_to_file
+      end
+    end
+    
+    private
+    
+      def write_to_file
+        file_out_path = @destination + "/#{get_save_filename}"
+        fout = File.new(file_out_path, 'w')
+        fout.puts @content
+      end
+      
+      def sanitize_url(unsafe_url)
+        url = unsafe_url
+        url.gsub!('[', '%5B')
+        url.gsub!(']', '%5D')
+        url.gsub!(',', '%2C')
+        url
+      end
+    end
+end

data/lib/downer/download_manager.rb

@@ -0,0 +1,39 @@
+module Downer
+  class WriteFailed < StandardError; end
+  class BadUrl < StandardError; end
+  class MalformedManifest < StandardError; end
+  class NoManifestFileGiven < StandardError; end
+  class NoTargetDirectoryGiven < StandardError; end
+  class URLSourceDoesNotExist < StandardError; end
+  
+  class DownloadManager
+    
+    attr_accessor :file_manifest, :target_directory, :output
+    attr_reader :urls
+    
+    def initialize(url_source, target_directory, output)
+      @file_manifest, @target_directory, @output = url_source, target_directory, output
+      dir_last_char_is_slash = (@target_directory[-1,1] == '/')
+      @target_directory = @target_directory + '/' unless dir_last_char_is_slash
+      @urls = []
+      raise URLSourceDoesNotExist unless File.exists?(@file_manifest) 
+      get_urls      
+    end
+    
+    def start
+      raise WriteFailed unless File.writable?(@target_directory)
+
+      @output.puts "Starting download on #{@urls.size} files"
+      worker = DownloadWorker.new(@urls, @target_directory, @output)
+      worker.start
+    end
+    
+    protected
+    
+      def get_urls
+        f = File.open(@file_manifest, 'r')
+        f.each_line { |line| @urls << line.chomp }
+      end
+    
+  end
+end

data/lib/downer/download_worker.rb

@@ -0,0 +1,32 @@
+module Downer
+  class DownloadWorker
+    
+    attr_reader :items
+    
+    def initialize(urls, target_directory, output)
+      @urls, @target_directory, @output = urls, target_directory, output
+      @items = []
+      @urls.each { |url| @items << DownloadItem.new(url, target_directory) }
+    end
+    
+    def start
+      if @urls.empty?
+        @output.puts "No URLs specified, exiting." 
+        return
+      end
+      
+      @items.each { |item| try_download_item(item) }
+    end
+    
+    private
+
+      def try_download_item(item)
+        begin
+          item.download
+          @output.puts "Downloaded #{item.url}"
+        rescue Downer::FailedDownload => e
+          @output.puts "Could not download #{e.url}, received http code #{e.http_code}"
+        end
+      end
+  end
+end

data/lib/downer/options.rb

@@ -0,0 +1,21 @@
+module Downer
+  class Options < Hash
+    attr_reader :opts, :orig_args
+    
+    def initialize(args)
+      
+      @orig_args = args.clone
+      @opts = OptionParser.new do |o|
+        o.banner = "Usage: downer URL_SOURCE DESTINATION_DIR"
+      end
+      
+      begin
+        @opts.parse!(args)
+        self[:file_manifest] = args.shift
+        self[:target_directory] = args.shift
+      rescue OptionParser::InvalidOption => e
+        self[:invalid_argument] = e.message
+      end
+    end
+  end
+end

data/lib/downer.rb

@@ -0,0 +1,8 @@
+require 'net/http'
+require 'optparse'
+
+require 'downer/application'
+require 'downer/download_manager'
+require 'downer/download_worker'
+require 'downer/download_item'
+require 'downer/options'

data/spec/downer/application_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+
+module Downer
+  describe Downer do
+    describe "#run!" do
+      it "when run without arguments displays a usage hint" do
+        output = double('output')
+        app = Application.new(output)
+        output.should_receive(:puts).with('Usage: downer URL_SOURCE DESTINATION_DIR')
+        app.run!
+      end
+      
+      it "when run with valid arguments displays the number of files to download" do
+        output = double('output').as_null_object
+        app = Application.new(output)
+        output.should_receive(:puts).with("Starting download on 4 files")
+        app.run!(fixture_directory + "/some_images.txt", '/tmp')
+      end
+    end
+  end
+end

data/spec/downer/download_item_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+
+module Downer
+  describe DownloadItem do    
+    
+    describe "#initialize" do
+      it "should escape bad url tokens" do
+        item = DownloadItem.new('http://www.urbaninfluence.com/my[place].html', '/tmp')
+        item.url.should == 'http://www.urbaninfluence.com/my%5Bplace%5D.html'
+      end
+    end
+    
+    describe "#get_save_filename" do
+      it "should generate a filename from its download url" do
+        item = DownloadItem.new('http://www.urbaninfluence.com/sites/default/files/user_uploads/images/mapsAndAtlases2.png', '/tmp')
+        item.get_save_filename.should == 'mapsAndAtlases2.png'
+      end
+      
+
+      it "should restore bad url tokens into valid ascii characters" do
+        item = DownloadItem.new('http://www.urbaninfluence.com/my[place].html', '/tmp')
+        item.get_save_filename.should == 'my[place].html'
+      end
+    end
+    
+    describe "#download" do
+      before(:each) do
+        FileUtils.rm_r(Dir.glob(tmp_directory + '/*'))
+      end
+      
+      it "should write the url to the target directory" do
+        item = DownloadItem.new('http://www.urbaninfluence.com/sites/default/files/user_uploads/images/mapsAndAtlases2.png', tmp_directory)
+        item.download
+        Dir.entries(tmp_directory).size.should > 2
+      end
+      
+      it "should raise an error when a url is unable to be downloaded" do
+        item = DownloadItem.new('http://www.urbaninfluence.com/will_never_complete', tmp_directory)
+        lambda { item.download }.should raise_error(Downer::FailedDownload)
+      end
+    end
+  end
+end

data/spec/downer/download_manager_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+
+module Downer
+  describe DownloadManager do
+    let(:output) { double('output').as_null_object }
+    let(:fixture_file_path) { fixture_directory + '/some_images.txt' }
+    let(:manager) { DownloadManager.new(fixture_file_path, 'myoutputdir', output) }
+    
+    describe "#new" do  
+      it "should add a slash as the last character of the target directory if one is not present" do
+        manager.target_directory.should == 'myoutputdir/'
+      end
+            
+      it "should retrieve all urls from the url source" do
+        manager.urls.should_not be_empty
+      end
+    end
+    
+    describe "#start" do
+      
+      it "should raise an error when the file does not exist" do
+        File.should_receive(:exists?).with(fixture_file_path)
+        lambda { manager.start }.should raise_error(Downer::URLSourceDoesNotExist)
+      end
+      it "should raise a WriteFailed exception if the target directory is not writable" do
+        File.should_receive(:writable?).with('myoutputdir/').and_return(false)
+        lambda { manager.start }.should raise_error(Downer::WriteFailed)
+      end
+
+      
+      it "should create a download worker to begin the downloading" do
+        File.should_receive(:writable?).and_return(true)
+        worker = double('worker')
+        worker.should_receive(:start)
+        DownloadWorker.should_receive(:new).and_return(worker)
+        manager.start
+      end
+    end
+      
+  end
+end

data/spec/downer/download_worker_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '../../spec_helper')
+
+module Downer
+  describe DownloadWorker do
+    let (:output) { double('output') }
+    let (:urls) { DownloadManager.new(fixture_directory + '/some_images.txt', '/tmp', output).urls }
+    
+    describe '#start' do 
+      it "should write a message to output when no urls exist to be downloaded" do
+        output.should_receive(:puts).with("No URLs specified, exiting.")
+        worker = DownloadWorker.new([], '/tmp', output)
+        worker.start
+      end
+      
+      it "should create a download object for each url to be downloaded" do
+        worker = DownloadWorker.new(urls, '/tmp', output)
+        worker.items.size.should == urls.size
+      end
+      
+      it "should write a message to output feed when a url cannot be downloaded" do
+        bad_url = "http://www.urbaninfluence.com/will_never_succeed"
+        worker = DownloadWorker.new([bad_url], '/tmp', output)
+        output.should_receive(:puts).with("Could not download #{bad_url}, received http code 404")
+        worker.start
+      end
+      
+      it "should write a message to output feed when a url is successfully downloaded" do
+        good_url = "http://www.urbaninfluence.com/sites/default/files/user_uploads/images/4th.png"
+        worker = DownloadWorker.new([good_url], '/tmp', output)
+        output.should_receive(:puts).with("Downloaded #{good_url}")
+        worker.start
+      end
+    end
+  end
+end

data/spec/downer/generator_spec.rb

@@ -0,0 +1 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')

data/spec/fixtures/some_images.txt

@@ -0,0 +1,4 @@
+http://www.urbaninfluence.com/sites/default/files/user_uploads/images/4th.png
+http://www.urbaninfluence.com/sites/default/files/user_uploads/images/mapsAndAtlases2.png
+http://www.urbaninfluence.com/sites/default/files/user_uploads/images/homerstranglesbart1.png
+http://www.urbaninfluence.com/sites/default/files/user_uploads/images/propane-smoker-large.png

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'downer'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end
+
+
+def fixture_directory
+  File.expand_path('../fixtures', __FILE__)
+end
+
+def tmp_directory
+  File.expand_path('../../tmp', __FILE__)
+end

data/version.yml

@@ -0,0 +1,5 @@
+--- 
+:minor: 1
+:build: 
+:patch: 1
+:major: 0

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: downer
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Nate Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-16 00:00:00 -07:00
+default_executable: downer
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Downer is a tool used to download a list of urls from a website thorugh HTTP.
+email: nate@natemiller.org
+executables: 
+- downer
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- bin/downer
+- downer.gemspec
+- features/step_definitions/downer_steps.rb
+- features/support/env.rb
+- features/user_starts_downer_with_valid_args.feature
+- features/user_starts_downer_without_args.feature
+- lib/downer.rb
+- lib/downer/application.rb
+- lib/downer/download_item.rb
+- lib/downer/download_manager.rb
+- lib/downer/download_worker.rb
+- lib/downer/options.rb
+- spec/downer/application_spec.rb
+- spec/downer/download_item_spec.rb
+- spec/downer/download_manager_spec.rb
+- spec/downer/download_worker_spec.rb
+- spec/downer/generator_spec.rb
+- spec/fixtures/some_images.txt
+- spec/spec.opts
+- spec/spec_helper.rb
+- version.yml
+has_rdoc: true
+homepage: http://github.com/nate63179/downer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Bulk downloading utitlity
+test_files: 
+- spec/downer/application_spec.rb
+- spec/downer/download_item_spec.rb
+- spec/downer/download_manager_spec.rb
+- spec/downer/download_worker_spec.rb
+- spec/downer/generator_spec.rb
+- spec/spec_helper.rb