downspout 0.2.8 → 0.2.9

data/VERSION

@@ -1 +1 @@
-0.2.8
+0.2.9

data/lib/downspout/base.rb

@@ -48,22 +48,20 @@ module Downspout
   Utility method for validating a URL without initiating a download
 =end
   def self.viable_url?( url_string )
-    $logger.info("downspout | supported_protocol? |  URL : #{url_string} ")
-
-    # remove user/password prefix if provided
-    clean_url = self.extract_credentials_from_url!( url_string )
+    $logger.info("downspout | viable_url? |  URL : #{url_string} ")
 
     begin
+      # remove user/password prefix if provided
+      clean_url = self.extract_credentials_from_url!( url_string )
+  
       uri = URI.parse( clean_url )
     rescue URI::InvalidURIError
-      $logger.warn("downspout | supported_protocol? | The format of the url is not valid : #{url_string}")
+      $logger.warn("downspout | viable_url? | The format of the url is not valid : #{url_string}")
       return false
     end
 
     return false unless self.supported_protocol?( uri.scheme )
 
-    # TODO : do more in-depth checks on URL validity
-
     return true
   end
 
@@ -104,24 +102,28 @@ module Downspout
   end
   
   def self.extract_credentials_from_url!( some_url )
-    the_uri = URI.parse( some_url )
 
-    if the_uri.userinfo.nil? then
-      return some_url
+    begin
+      some_uri = URI::parse( some_url )
+    rescue NoMethodError => e
+      # convert to Invalid URI as that's the more pertinent issue
+      raise URI::InvalidURIError, e.to_s
     end
 
-    begin
-      Downspout::Config.add_credential( :scheme => the_uri.scheme,
-        :host => the_uri.host,
-        :user_name => the_uri.user,
-        :pass_word => the_uri.password
-        )
-    ensure
-      the_uri.user = nil
-      the_uri.password = nil
+    cred = Downspout::Credential.create_from_uri( some_uri )
+
+    if cred.nil? then
+      return some_url
     end
-    
-    return the_uri.to_s
+
+    Downspout::Config.add_credential( cred )
+
+    # zero out the user info
+    some_uri.user = nil
+    some_uri.password = nil
+
+    # return sanitized URL string
+    return some_uri.to_s
   end
 
 end

data/lib/downspout/config.rb

@@ -83,14 +83,21 @@ module Downspout
     end
 
     def self.add_credential( options = nil )
-      return nil unless options && options.respond_to?(:keys)
-      options = {:scheme => 'ftp'}.merge!( options )
+      return nil unless options
 
-      c = Credential.new( options )
+      if (options.class == Downspout::Credential) then
+        c = options
+      else
+        return nil unless options.respond_to?(:keys)
+
+        options = {:scheme => 'ftp'}.merge!( options ) # defaults to FTP
 
+        c = Credential.new( options )
+      end
+      
       $logger.debug("downspout | config | add_credential | #{c.host}, #{c.user_name}, #{c.scheme} ")
 
-      @@credentials << c      
+      @@credentials << c
 
       return c
     end

data/lib/downspout/credential.rb

@@ -15,6 +15,36 @@ module Downspout
       end
     end
 
+    def self.create_from_url( some_url )
+      cred_hash = {}
+
+      begin
+        some_uri = URI::parse( some_url )
+      rescue NoMethodError => e
+        # convert to Invalid URI as that's the more pertinent issue
+        raise URI::InvalidURIError, e.to_s
+      end
+
+      return Credential.create_from_uri( some_uri )
+    end
+
+    def self.create_from_uri( some_uri )
+
+      if some_uri.userinfo.nil? then
+        return nil
+      end
+
+      cred_hash = {}
+      cred_hash[:scheme] = some_uri.scheme
+      cred_hash[:host] = some_uri.host
+      cred_hash[:port] = some_uri.port
+      cred_hash[:user_name] = some_uri.user
+      cred_hash[:pass_word] = some_uri.password
+
+      cred = Credential.new( cred_hash )
+      
+      return cred
+    end
   end
 
 end

data/lib/downspout/downloader.rb

@@ -167,13 +167,23 @@ module Downspout
 
       # look up the credentials for this host
       cred = Downspout::Config.credentials.select{|c| c.scheme == 'ftp' }.select{ |c| c.host == @uri.host }.first
+
       if cred.nil? then
-        $logger.warn("downspout | downloader | net_ftp_download | No credentials found for '#{@uri.host}'.")
-        # proceed anyway - slight possibility it's an un-authorized FTP account...
+        $logger.warn("downspout | downloader | net_ftp_download | No established credentials found for '#{@uri.host}'.")
+
+        # attempt to extract credential from the URL
+        cred = Downspout::Credential.create_from_url( @url )
       else
         $logger.debug("downspout | downloader | net_ftp_download | Loaded credentials for #{cred.host} ...")
       end
       
+      if cred.nil? then
+        $logger.warn("downspout | downloader | net_ftp_download | No embedded credentials found in URL.")
+        # proceed anyway - slight possibility it's an un-authorized FTP account...
+      else
+        $logger.warn("downspout | downloader | net_ftp_download | Using embedded credentials found in URL with user: #{cred.user_name}.")
+      end
+      
       begin
         ftp = Net::FTP.open( @uri.host ) do |ftp|
           ftp.login( cred.user_name, cred.pass_word ) unless cred.nil?
@@ -240,7 +250,12 @@ module Downspout
         raise Downspout::ExcessiveRedirects, 'HTTP redirect too deep'
       end
 
-      u = URI.parse( url_str )
+      begin
+        u = URI.parse( url_str )
+      rescue NoMethodError => e
+        # convert to Invalid URI as that's the more pertinent issue
+        raise URI::InvalidURIError, e.to_s
+      end
       
       http = Net::HTTP.new( u.host, u.port )
         

data/test/focused_test.rb

@@ -4,51 +4,12 @@ class FocusedTest < Test::Unit::TestCase
   context "Downspout" do
     context "Focus" do
       setup do
-        @expected_url = "https://download.github.com/rails-rails-v2.3.11-0-gb0c3d45.tar.gz"
-        @header_str = "HTTP/1.1 302 Found
-Server: nginx/0.7.67
-Date: Mon, 18 Apr 2011 01:53:16 GMT
-Content-Type: text/html; charset=utf-8
-Connection: keep-alive
-Status: 302 Found
-Location: https://nodeload.github.com/rails/rails/tarball/v2.3.11
-X-Runtime: 3ms
-Content-Length: 121
-Set-Cookie: _gh_sess=BAh7BzoRbG9jYWxlX2d1ZXNzMCIKZmxhc2hJQzonQWN0aW9uQ29udHJvbGxlcjo6Rmxhc2g6OkZsYXNoSGFzaHsABjoKQHVzZWR7AA%3D%3D--719def2ab2d99283383e374327fcdbb716c45c12; path=/; expires=Fri, 01 Jan 2021 00:00:00 GMT; secure; HttpOnly
-Cache-Control: no-cache
-Strict-Transport-Security: max-age=2592000
-
-HTTP/1.1 302 Moved Temporarily
-Server: nginx/0.7.67
-Date: Mon, 18 Apr 2011 01:53:17 GMT
-Transfer-Encoding: chunked
-Connection: keep-alive
-Location: https://download.github.com/rails-rails-v2.3.11-0-gb0c3d45.tar.gz
-
-HTTP/1.1 200 OK
-Server: nginx/0.7.67
-Date: Mon, 18 Apr 2011 01:53:17 GMT
-Content-Type: application/octet-stream
-Content-Length: 3416081
-Last-Modified: Mon, 18 Apr 2011 01:45:25 GMT
-Connection: keep-alive
-Accept-Ranges: bytes"
+        @test_string = "foo"
       end
 
-      should "grep last location header" do
-        last_location = @header_str.scan(/Location\:\s?(.*)\W/).last.first
-
-        assert_equal @expected_url, last_location
+      should "behave properly" do
+        assert_equal @test_string, "foo"
       end
-
-      should "match last_location method" do
-        @obj = Downspout::Downloader.new( :url => "http://bad.url/path" )
-        last_location = @obj.send('curb_last_location', @header_str )
-
-        assert_equal String, last_location.class
-        assert_equal @expected_url, last_location
-      end
-
     end
   end
 end

data/test/unit/base_test.rb

@@ -114,11 +114,27 @@ class DownspoutTest < Test::Unit::TestCase
         end
 
         should "be accepted with FTP protocol containing user & password" do
+          num = Downspout::Config.credentials.size
+          
           assert Downspout.viable_url?( "ftp://uzer:passw0rd@host.domain.tld/resource/file.format" )
+
+          assert_equal num + 1, Downspout::Config.credentials.size
+
+          assert_equal 'host.domain.tld', Downspout::Config.credentials.last.host
         end
 
       end
     end
 
+    should "clean URLs with user & password via extract credentials" do
+      test_url = "ftp://uzer:passw0rd@host.domain.tld/resource/file.format"
+
+      new_url = Downspout.extract_credentials_from_url!( test_url )
+
+      assert !(new_url == test_url)
+      assert_equal URI::parse( test_url ).host, URI::parse( new_url ).host
+      assert_equal URI::parse( test_url ).path, URI::parse( new_url ).path
+    end
+    
   end
 end

data/test/unit/credential_test.rb

@@ -4,28 +4,75 @@ class CredentialTest < Test::Unit::TestCase
   context "Downspout" do
     context "Credential" do
 
-      should "respond to scheme" do
-        assert Downspout::Credential.new.respond_to?(:scheme)
+      context "object" do
+  
+        should "respond to scheme" do
+          assert Downspout::Credential.new.respond_to?(:scheme)
+        end
+  
+        should "respond to host" do
+          assert Downspout::Credential.new.respond_to?(:host)
+        end
+  
+        should "respond to port" do
+          assert Downspout::Credential.new.respond_to?(:port)
+        end
+  
+        should "respond to user_name" do
+          assert Downspout::Credential.new.respond_to?(:user_name)
+        end
+  
+        should "respond to pass_word" do
+          assert Downspout::Credential.new.respond_to?(:pass_word)
+        end
+  
       end
 
-      should "respond to host" do
-        assert Downspout::Credential.new.respond_to?(:host)
-      end
-
-      should "respond to port" do
-        assert Downspout::Credential.new.respond_to?(:port)
-      end
 
-      should "respond to user_name" do
-        assert Downspout::Credential.new.respond_to?(:user_name)
+      context "created from URL" do
+  
+        should "return nil if no credential extractable from otherwise valid URL" do
+          @my_url = "ftp://ftp-test.domain.tld/path/2011-04-01_13-42-52/file.ext"
+  
+          @no_cred = Downspout::Credential.create_from_url( @my_url )
+  
+          assert_nil @no_cred
+        end
+  
+        should "create credential from URL with embedded info" do
+          @my_url = "ftp://test-name:test-secret@ftp-test.domain.tld/path/2011-04-01_13-42-52/file.ext"
+  
+          @my_cred = Downspout::Credential.create_from_url( @my_url )
+  
+          assert_not_nil @my_cred
+  
+          assert_equal Downspout::Credential, @my_cred.class
+  
+          assert_equal 'ftp', @my_cred.scheme
+          assert_equal 'ftp-test.domain.tld', @my_cred.host
+          assert_equal 21, @my_cred.port
+          assert_equal 'test-name', @my_cred.user_name
+          assert_equal 'test-secret', @my_cred.pass_word
+        end
+  
+        should "raise error when parsing invalid URL [partially encoded]" do
+          @bad_url = "ftp:%20%20test-name:test-secret@ftp-test.domain.tld/path/2011-04-01_13-42-52/file.ext"
+  
+          assert_raise URI::InvalidURIError do
+            @bad_cred = Downspout::Credential.create_from_url( @bad_url )
+          end        
+        end
+  
+        should "raise error when parsing invalid URL [inserted space]" do
+          @bad_url = "ft p://test-name:test-secret@ftp-test.domain.tld/path/2011-04-01_13-42-52/file.ext"
+  
+          assert_raise URI::InvalidURIError do
+            @bad_cred = Downspout::Credential.create_from_url( @bad_url )
+          end        
+        end
+        
       end
-
-      should "respond to pass_word" do
-        assert Downspout::Credential.new.respond_to?(:pass_word)
-      end
-
     end
-
   end
 
 end

data/test/unit/downloader_test.rb

@@ -243,4 +243,51 @@ class DownloaderTest < Test::Unit::TestCase
 
   end
 
+  context "last location for curb redirects" do
+    setup do
+      @expected_url = "https://download.github.com/rails-rails-v2.3.11-0-gb0c3d45.tar.gz"
+      @header_str = "HTTP/1.1 302 Found
+Server: nginx/0.7.67
+Date: Mon, 18 Apr 2011 01:53:16 GMT
+Content-Type: text/html; charset=utf-8
+Connection: keep-alive
+Status: 302 Found
+Location: https://nodeload.github.com/rails/rails/tarball/v2.3.11
+X-Runtime: 3ms
+Content-Length: 121
+Cache-Control: no-cache
+Strict-Transport-Security: max-age=2592000
+
+HTTP/1.1 302 Moved Temporarily
+Server: nginx/0.7.67
+Date: Mon, 18 Apr 2011 01:53:17 GMT
+Transfer-Encoding: chunked
+Connection: keep-alive
+Location: https://download.github.com/rails-rails-v2.3.11-0-gb0c3d45.tar.gz
+
+HTTP/1.1 200 OK
+Server: nginx/0.7.67
+Date: Mon, 18 Apr 2011 01:53:17 GMT
+Content-Type: application/octet-stream
+Content-Length: 3416081
+Last-Modified: Mon, 18 Apr 2011 01:45:25 GMT
+Connection: keep-alive
+Accept-Ranges: bytes"
+    end
+
+    should "grep last location header" do
+      last_location = @header_str.scan(/Location\:\s?(.*)\W/).last.first
+
+      assert_equal @expected_url, last_location
+    end
+
+    should "match last_location method" do
+      @obj = Downspout::Downloader.new( :url => "http://bad.url/path" )
+      last_location = @obj.send('curb_last_location', @header_str )
+
+      assert_equal String, last_location.class
+      assert_equal @expected_url, last_location
+    end
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: downspout
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 2
-  - 8
-  version: 0.2.8
+  - 9
+  version: 0.2.9
 platform: ruby
 authors: 
 - Phi.Sanders
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-17 00:00:00 -04:00
+date: 2011-04-27 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency