downspout 0.2.4 → 0.2.5

data/Rakefile

@@ -51,18 +51,3 @@ Rake::TestTask.new(:test) do |test|
 end
 
 task :default => :test
-
-namespace :basic do
-  desc "Basic Steps to take when updating this gem via GemCutter"
-  task :steps do
-    puts "rake version:bump:patch"
-    puts "rake gemspec"
-    puts ">>> write code <<<"
-    puts "rake test"
-    puts "rake build"
-    puts "gem install pkg/downspout-{version}.gem"
-    puts ">>> manual tests <<<"
-    puts "git commit"
-    puts "gem push pkg/downspout-{version}.gem"
-  end
-end

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/lib/downspout/downloader.rb

@@ -171,9 +171,7 @@ module Downspout
         ftp = Net::FTP.open( @uri.host ) do |ftp|
           ftp.login( cred.user_name, cred.pass_word ) unless cred.nil?
           ftp.passive
-          ftp.chdir( File.dirname( @uri.path ) )
-          
-          $logger.debug("downspout | downloader | net_ftp_download | Local Path : #{@path} ...")
+          ftp.chdir( File.dirname( @uri.path ) )          
           ftp.getbinaryfile( self.basename, @path )
         end
       rescue Exception => e
@@ -181,10 +179,12 @@ module Downspout
         raise e
       end
 
-      done = File.exist?( @path )
-      $logger.debug("downspout | downloader | net_ftp_download | #{basename} downloaded? : #{done}.")
+      if !(File.exist?( @path )) then
+        $logger.error("downspout | downloader | net_ftp_download | #{basename} download failed.")
+        return false
+      end
 
-      return done
+      return true
     end
 
     def net_http_download
@@ -193,12 +193,8 @@ module Downspout
       begin
         response = net_http_fetch( @url , 1)
         open( @path, "wb" ) do |file|
-        
           file.write(response.body)
         end
-
-       $logger.debug("downspout | downloader | net_http_download | Response Body : #{response.body[0..5].strip}")
-
       rescue SocketError => dns_err
         $logger.error("downspout | downloader | net_http_download | Net/HTTP DNS Error | #{@uri.host} | #{dns_err.inspect}")
         remove_file_at_target_path
@@ -212,23 +208,19 @@ module Downspout
       @response.each_header do |k,v|
         new_header_str += "#{k}: #{v}\r\n"
       end
-      @response_headers = parse_headers_from_string( new_header_str )
-
+      parse_headers_from_string!( new_header_str )
   
       if ((response.code.to_i != 200) and (response.code.to_i != 202)) then
         # missing file, failed download - delete the response body [if downloaded]
         remove_file_at_target_path
         return false
       end
-
-      $logger.debug("downspout | downloader | net_http_download | Headers : #{response.header}")
     
       if !( File.exist?( @path ) ) then
         $logger.error("downspout | downloader | net_http_download | Missing File at download path : #{@path}")
         return false
       end
       
-      $logger.debug("downspout | downloader | net_http_download | Successful.")
       return true
     end
 
@@ -244,19 +236,17 @@ module Downspout
       # TODO : implement credentials for downloads via net_http_fetch
       my_request.basic_auth 'account', 'p4ssw0rd'
 
-      $logger.debug("downspout | downloader | net_http_fetch | Firing...")
       @response = Net::HTTP.start( u.host, u.port ) do |http|
         http.request( my_request )
       end
 
-      $logger.debug("downspout | downloader | net_http_fetch | Response : #{@response}")
-      
       case @response
       when Net::HTTPSuccess
         @response
       when Net::HTTPRedirection
         net_http_fetch( @response['location'], limit - 1 )
       else
+        $logger.error("downspout | downloader | net_http_fetch | Response : #{@response}")
         @response.error!
       end
     end
@@ -278,10 +268,8 @@ module Downspout
         remove_file_at_target_path
       end
 
-      $logger.debug("downspout | downloader | curb_http_download | Headers : #{curb.header_str}")
-
       # populate the response headers from curb header string
-      @response_headers = parse_headers_from_string( curb.header_str )
+      parse_headers_from_string!( curb.header_str )
 
       # populate a 'proxy' HTTPResponse object with the Curb data...
       hr_klass = Net::HTTPResponse.send('response_class', curb.response_code.to_s)
@@ -291,19 +279,15 @@ module Downspout
         curb.response_code,
         @response_headers["HTTP"][:message] )
         
-      $logger.debug("downspout | downloader | curb_http_download | Response : #{@response.inspect}")
-
       if !( File.exist?( @path ) ) then
         $logger.error("downspout | downloader | curb_http_download | Missing File at download path : #{@path}")
         return false
       end
       
-      $logger.debug("downspout | downloader | curb_http_download | Successful.")
       return true
     end
 
-    def parse_headers_from_string( header_str )
-      $logger.debug("downspout | downloader | parse_headers_from_string | String : #{header_str}")
+    def parse_headers_from_string!( header_str )
       header_hash = {}
       http_hash = {}
       headers = header_str.split("\r\n")
@@ -314,40 +298,54 @@ module Downspout
       http_hash[:code] = (http_info.split("\r\n")[0].split(" ")[1]).to_i
       http_hash[:message] = http_info.split("\r\n")[0].split(" ")[2]
       
-      $logger.debug("downspout | downloader | parse_headers_from_string | Response : #{http_hash[:version]}, #{http_hash[:code]}, #{http_hash[:message]}")
       header_hash["HTTP"] = http_hash
       
       headers[1..-1].each do |line|
         header_name, header_value = line.match(/([\w\-\s]+)\:\s?(.*)/)[1..2]
         header_hash[header_name] = header_value
       end
-  
-      return header_hash
+
+      @response_headers = header_hash
     end
 
     def generate_file_name
+      result = nil
+
+      result = file_name_from_content_disposition
+      result = file_name_from_content_type if result.nil?
+
+      return result
+    end
+
+    def file_name_from_content_disposition
+      file_name = nil
 
       cd_key = response_headers.keys.select{|k| k =~ /content-disposition/i }.first
-      # example : Content-Disposition: attachment; filename="iPad_User_Guide.pdf"
+
       if cd_key then
         disposition = @response_headers[cd_key]
         if disposition then
-          file_name = disposition.match("filename=\"(.+)\"")[1]
-          return file_name unless (file_name.nil? || file_name.empty?)
+          # example : Content-Disposition: attachment; filename="iPad_User_Guide.pdf"
+          file_name = disposition.match("filename=\"?(.+)\"?")[1]
         end
       end
 
+      $logger.debug("downspout | downloader | file_name_from_content_disposition | #{file_name}")
+      return file_name      
+    end
+
+    def file_name_from_content_type
       ct_key = response_headers.keys.select{|k| k =~ /content-type/i }.first
       return nil unless ct_key
 
       file_type = @response_headers[ct_key]
       return nil unless file_type
 
-      # TODO : smarter file name generation
-      return "#{@basename || 'default'}.html" if file_type =~ /html/
-      return "#{@basename || 'default'}.pdf" if file_type =~ /pdf/
+      file_name = "#{@basename || 'default'}.html" if (file_type =~ /html/)
+      file_name = "#{@basename || 'default'}.pdf" if (file_type =~ /pdf/) && file_name.nil?
 
-      return nil
+      $logger.debug("downspout | downloader | file_name_from_content_type | #{file_name}")
+      return file_name
     end
     
   end

data/test/fixtures/faux_headers.txt

@@ -0,0 +1,10 @@
+HTTP/1.1 200 OK
+Date: Wed, 30 Mar 2011 19:40:11 GMT
+Server: Apache/2.2.11 (Unix) DAV/2 PHP/5.3.1
+Content-Length: 1181801
+Content-Disposition: attachement; filename=0123456789_X.pdf
+X-HP-CAM-COLOR: V=1;ServerAddr=wbO8IqKJzqoYjXdW+68u4A==;GUID=1|0-iccMJzdDzi5kYvyeH1L5A_QSAtcJxSoyASpOXx9kY.|L3ByaW1pczY0L2Rvd25sb2FkL2N1c3RvbWJvb2s.
+X-Powered-By: Servlet/2.5 JSP/2.1
+Vary: Accept-Encoding,User-Agent
+Content-Type: application/pdf
+Connection: close

data/test/unit/downloader_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class DownloaderTest < Test::Unit::TestCase
 
-  context "Downspout" do
+ context "Downspout" do
     context "Downloader" do
 
       should "respond to URL" do
@@ -208,4 +208,28 @@ class DownloaderTest < Test::Unit::TestCase
     assert g.response_headers.keys.include?('content-type') # Note case difference for Net/HTTP vs Curb
   end
 
+  context "with content disposition header defining file name" do
+    setup do
+      @dlx = Downspout::Downloader.new()
+      @faux_headers = File.read( File.join( Test::App.root, "test", "fixtures", "faux_headers.txt" ) )
+
+      @dlx.send("parse_headers_from_string!", @faux_headers )
+    end
+
+    should "have expected keys parsed from headers" do
+      all_keys = @dlx.response_headers.keys
+      assert_equal 10, all_keys.size
+    end
+
+    should "have a key for the content dispositon header" do
+      all_keys = @dlx.response_headers.keys
+      the_key = all_keys.select{|k| k =~ /content-disposition/i }.first
+      assert the_key
+    end
+    
+    should "extract the appropriate file name" do
+      assert_equal "0123456789_X.pdf", @dlx.send("generate_file_name")
+    end
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: downspout
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 2
-  - 4
-  version: 0.2.4
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - Phi.Sanders
@@ -120,6 +120,7 @@ files:
 - lib/downspout/logger.rb
 - lib/downspout/tmp_file.rb
 - test/downspout_test.rb
+- test/fixtures/faux_headers.txt
 - test/fixtures/ruby.png
 - test/servlet.rb
 - test/test_helper.rb