rets 0.3.0.rc.1 → 0.3.0.rc.2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.3.0.rc.1
+
+* correctly handle digest authentication
+
 ### 0.3.0.rc.0 / 2012-07-26
 
 * feature: significantly better handling of authorization failures

data/Rakefile

@@ -3,6 +3,7 @@ require 'hoe'
 
 Hoe.plugin :git, :doofus
 Hoe.plugin :travis
+Hoe.plugin :gemspec
 
 Hoe.spec 'rets' do
   developer 'Estately, Inc. Open Source', 'opensource@estately.com'

data/lib/rets/client.rb

@@ -44,7 +44,8 @@ module Rets
     # provided in initialize. Returns the capabilities that the
     # RETS server provides, per http://retsdoc.onconfluence.com/display/rets172/4.10+Capability+URL+List.
     def login
-      request(uri.path)
+      response = request(uri.path)
+      self.capabilities = extract_capabilities(Nokogiri.parse(response.body))
       raise UnknownResponse, "Cannot read rets server capabilities." unless @capabilities
       @capabilities
     end
@@ -94,7 +95,7 @@ module Rets
         end
       end
     end
-    
+
     def find_every(opts = {})
       search_uri = capability_url("Search")
 
@@ -235,9 +236,12 @@ module Rets
     def metadata
       return @metadata if @metadata
 
-      if @cached_metadata && @cached_metadata.current?(capabilities["MetadataTimestamp"], capabilities["MetadataVersion"])
+      if @cached_metadata && (@options[:skip_metadata_uptodate_check] ||
+          @cached_metadata.current?(capabilities["MetadataTimestamp"], capabilities["MetadataVersion"]))
+        logger.info "Use cached metadata"
         self.metadata = @cached_metadata
       else
+        logger.info @cached_metadata ? "Cached metadata out of date" : "Cached metadata unavailable"
         metadata_fetcher = lambda { |type| retrieve_metadata_type(type) }
         self.metadata = Metadata::Root.new(&metadata_fetcher)
       end
@@ -263,15 +267,18 @@ module Rets
     end
 
     def raw_request(path, body = nil, extra_headers = {}, &reader)
-      logger.info "posting to #{path}"
       headers = build_headers.merge(extra_headers)
 
       post = Net::HTTP::Post.new(path, headers)
       post.body = body.to_s
 
-      logger.debug ""
-      logger.debug format_headers(headers)
-      logger.debug body.to_s
+      logger.debug <<EOF
+>>>> Request
+POST #{path}
+#{format_headers(headers)}
+
+#{binary?(body.to_s) ? '<<< BINARY BODY >>>' : body.to_s}
+EOF
 
       connection_args = [Net::HTTP::Persistent === connection ? uri : nil, post].compact
 
@@ -279,27 +286,39 @@ module Rets
         res.read_body(&reader)
       end
 
-      handle_cookies(response)
+      logger.debug <<EOF
+<<<< Response
+#{response.code} #{response.message}
+#{format_headers(response.to_hash)}
 
-      logger.debug "Response: (#{response.class})"
-      logger.debug ""
-      logger.debug format_headers(response.to_hash)
-      logger.debug ""
-      logger.debug "Body:"
-      logger.debug response.body
+#{binary?(response.body.to_s) ? '<<< BINARY BODY >>>' : response.body.to_s}
+EOF
 
+      handle_cookies(response)
       return response
     end
 
-    def request(*args, &block)
-      response = handle_response(raw_request(*args, &block))
+    def digest_auth_request(path, body = nil, extra_headers = {}, &reader)
+      response = raw_request(path, body, extra_headers, &reader)
       if Net::HTTPUnauthorized === response
-        retry_response = handle_response(raw_request(*args, &block))
-        raise AuthorizationFailure if retry_response === Net::HTTPUnauthorized
-        retry_response
-      else
-        response
+        challenge = extract_digest_header(response)
+        if challenge
+          uri2 = URI.parse(uri.to_s)
+          uri2.user = uri.user
+          uri2.password = uri.password
+          uri2.path = path
+          self.authorization = build_auth(challenge, uri2, tries)
+          response = raw_request(path, body, extra_headers, &reader)
+          if Net::HTTPUnauthorized === response
+            raise AuthorizationFailure, "Authorization failed, check credentials?"
+          end
+        end
       end
+      response
+    end
+
+    def request(*args, &block)
+      handle_response(digest_auth_request(*args, &block))
     end
 
     def request_with_compact_response(path, body, headers)
@@ -310,38 +329,20 @@ module Rets
 
     def extract_digest_header(response)
       authenticate_headers = response.get_fields("www-authenticate")
-      authenticate_headers.detect {|h| h =~ /Digest/}
-    end
-
-    def handle_unauthorized_response(response)
-      if self.authorization.nil?
-        self.authorization = build_auth(extract_digest_header(response), uri, tries)
-        response = raw_request(uri.path)
-
-        if Net::HTTPUnauthorized === response
-          raise AuthorizationFailure, "Authorization failed, check credentials?"
-        else
-          ErrorChecker.check(response)
-          self.capabilities = extract_capabilities(Nokogiri.parse(response.body))
-        end
+      if authenticate_headers
+        authenticate_headers.detect {|h| h =~ /Digest/}
       else
-        clean_setup
-        login
+        nil
       end
     end
 
     def handle_response(response)
-
-      if Net::HTTPUnauthorized === response # 401
-        handle_unauthorized_response(response)
-
-      elsif Net::HTTPSuccess === response # 2xx
+      if Net::HTTPSuccess === response
         ErrorChecker.check(response)
       else
         raise UnknownResponse, "Unable to handle response #{response.class}"
       end
-
-      return response
+      response
     end
 
     def handle_cookies(response)
@@ -379,7 +380,6 @@ module Rets
       @cookies[name]
     end
 
-
     def session=(session)
       self.authorization = session.authorization
       self.capabilities  = session.capabilities
@@ -478,7 +478,9 @@ module Rets
       data.map{|k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join("&")
     end
 
-
+    def binary?(data)
+      data.slice(0, 1024).any? {|b| b >= "\x0" && b < " " && b != '-' && b != '~' && b != "\t" && b != "\r" && b != "\n"}
+    end
 
     def tries
       @tries ||= 1

data/test/test_client.rb

@@ -98,15 +98,6 @@ class TestClient < Test::Unit::TestCase
     client.request("/foo")
   end
 
-
-  def test_handle_response_instigates_login_process
-    response = Net::HTTPUnauthorized.new("","","")
-
-    @client.expects(:handle_unauthorized_response)
-
-    assert_equal response, @client.handle_response(response)
-  end
-
   def test_handle_response_handles_rets_errors
     response = Net::HTTPSuccess.new("", "", "")
     response.stubs(:body => RETS_ERROR)
@@ -116,18 +107,6 @@ class TestClient < Test::Unit::TestCase
     end
   end
 
-  def test_handle_unauthorize_response_handles_rets_errors
-    response = Net::HTTPSuccess.new("", "", "")
-    response.stubs(:body => RETS_ERROR)
-    @client.stubs(:build_auth)
-    @client.stubs(:extract_digest_header)
-    @client.stubs(:raw_request).returns(response)
-
-    assert_raise Rets::InvalidRequest do
-      @client.handle_unauthorized_response(response)
-    end
-  end
-
   def test_handle_response_handles_rets_valid_response
     response = Net::HTTPSuccess.new("", "", "")
     response.stubs(:body => RETS_REPLY)
@@ -157,35 +136,6 @@ class TestClient < Test::Unit::TestCase
     end
   end
 
-
-  def test_handle_unauthorized_response_sets_capabilities_on_success
-    response = Net::HTTPSuccess.new("","","")
-    response.stubs(:body => CAPABILITIES, :get_fields => ["xxx"])
-
-    @client.stubs(:build_auth)
-    @client.expects(:raw_request).with("/login").returns(response)
-
-    @client.handle_unauthorized_response(response)
-
-    capabilities = {"abc" => "123", "def" => "ghi=jk"}
-
-    assert_equal capabilities, @client.capabilities
-  end
-
-  def test_handle_unauthorized_response_raises_on_auth_failure
-    response = Net::HTTPUnauthorized.new("","","")
-    response.stubs(:body => "", :get_fields => ["xxx"])
-
-    @client.stubs(:build_auth)
-    @client.expects(:raw_request).with("/login").returns(response)
-
-    assert_raise Rets::AuthorizationFailure do
-      @client.handle_unauthorized_response(response)
-    end
-  end
-
-
-
   def test_extract_capabilities
     assert_equal(
       {"abc" => "123", "def" => "ghi=jk"},
@@ -220,7 +170,10 @@ class TestClient < Test::Unit::TestCase
   end
 
   def test_login_fails_if_cannot_read_capabilities
-    @client.stubs(:request)
+    response = Net::HTTPSuccess.new("", "", "")
+    response.stubs(:body => RETS_REPLY)
+    @client.stubs(:request).returns(response)
+    @client.stubs(:extract_capabilities)
     assert_raise Rets::UnknownResponse do
       @client.login
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rets
 version: !ruby/object:Gem::Version
-  version: 0.3.0.rc.1
+  version: 0.3.0.rc.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-26 00:00:00.000000000 Z
+date: 2012-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
-  requirement: &70186895334000 !ruby/object:Gem::Requirement
+  requirement: &70154418461060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.7'
   type: :runtime
   prerelease: false
-  version_requirements: *70186895334000
+  version_requirements: *70154418461060
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70186895333580 !ruby/object:Gem::Requirement
+  requirement: &70154418460640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *70186895333580
+  version_requirements: *70154418460640
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70186895333160 !ruby/object:Gem::Requirement
+  requirement: &70154418460220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.11.0
   type: :development
   prerelease: false
-  version_requirements: *70186895333160
+  version_requirements: *70154418460220
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70186895332740 !ruby/object:Gem::Requirement
+  requirement: &70154418459800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.2.2
   type: :development
   prerelease: false
-  version_requirements: *70186895332740
+  version_requirements: *70154418459800
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70186895332320 !ruby/object:Gem::Requirement
+  requirement: &70154418459380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.8.0
   type: :development
   prerelease: false
-  version_requirements: *70186895332320
+  version_requirements: *70154418459380
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70186895331900 !ruby/object:Gem::Requirement
+  requirement: &70154418458960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *70186895331900
+  version_requirements: *70154418458960
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &70186895331480 !ruby/object:Gem::Requirement
+  requirement: &70154418458540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: '2.13'
   type: :development
   prerelease: false
-  version_requirements: *70186895331480
+  version_requirements: *70154418458540
 description: ! '[![Build Status](https://secure.travis-ci.org/estately/rets.png?branch=master)](http://travis-ci.org/estately/rets)
 
   A pure-ruby library for fetching data from [RETS] servers.