rets 0.3.0 → 0.4.0

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-### 0.3.0.rc.1
+### 0.4.0 / 2012-08-29
+
+* fix: update authentication header to uri matches path
+
+### 0.3.0 / 2012-07-31
 
 * correctly handle digest authentication
 

data/lib/rets.rb

@@ -8,7 +8,7 @@ require 'net/http/persistent'
 require 'nokogiri'
 
 module Rets
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 
   AuthorizationFailure = Class.new(ArgumentError)
   InvalidRequest       = Class.new(ArgumentError)

data/lib/rets/client.rb

@@ -1,12 +1,12 @@
 module Rets
-  Session = Struct.new(:authorization, :capabilities, :cookies)
+  Session = Struct.new(:auth_digest, :capabilities, :cookies)
 
   class Client
     DEFAULT_OPTIONS = { :persistent => true }
 
     include Authentication
 
-    attr_accessor :uri, :options, :authorization, :logger
+    attr_accessor :login_uri, :options, :logger, :auth_digest
     attr_writer   :capabilities, :metadata
 
     def initialize(options)
@@ -16,26 +16,26 @@ module Rets
 
     def clean_setup
 
+      @auth_digest       = nil
+      @cached_metadata   = nil
       @capabilities      = nil
+      @connection        = nil
       @cookies           = nil
       @metadata          = nil
-      @cached_metadata   = nil
       @tries             = nil
-      @connection        = nil
-      self.authorization = nil
       self.capabilities  = nil
 
-      uri          = URI.parse(@options[:login_url])
+      uri              = URI.parse(@options[:login_url])
 
-      uri.user     = @options.key?(:username) ? CGI.escape(@options[:username]) : nil
-      uri.password = @options.key?(:password) ? CGI.escape(@options[:password]) : nil
+      uri.user         = @options.key?(:username) ? CGI.escape(@options[:username]) : nil
+      uri.password     = @options.key?(:password) ? CGI.escape(@options[:password]) : nil
 
-      self.options = DEFAULT_OPTIONS.merge(@options)
-      self.uri     = uri
+      self.options     = DEFAULT_OPTIONS.merge(@options)
+      self.login_uri   = uri
 
-      self.logger = @options[:logger] || FakeLogger.new
+      self.logger      = @options[:logger] || FakeLogger.new
 
-      self.session  = @options.delete(:session)  if @options[:session]
+      self.session     = @options.delete(:session)  if @options[:session]
       @cached_metadata = @options[:metadata] || nil
     end
 
@@ -44,7 +44,7 @@ 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
-      response = request(uri.path)
+      response = request(login_uri.path)
       self.capabilities = extract_capabilities(Nokogiri.parse(response.body))
       raise UnknownResponse, "Cannot read rets server capabilities." unless @capabilities
       @capabilities
@@ -267,7 +267,7 @@ module Rets
     end
 
     def raw_request(path, body = nil, extra_headers = {}, &reader)
-      headers = build_headers.merge(extra_headers)
+      headers = build_headers(path).merge(extra_headers)
 
       post = Net::HTTP::Post.new(path, headers)
       post.body = body.to_s
@@ -280,7 +280,7 @@ POST #{path}
 #{binary?(body.to_s) ? '<<< BINARY BODY >>>' : body.to_s}
 EOF
 
-      connection_args = [Net::HTTP::Persistent === connection ? uri : nil, post].compact
+      connection_args = [Net::HTTP::Persistent === connection ? login_uri : nil, post].compact
 
       response = connection.request(*connection_args) do |res|
         res.read_body(&reader)
@@ -301,13 +301,8 @@ EOF
     def digest_auth_request(path, body = nil, extra_headers = {}, &reader)
       response = raw_request(path, body, extra_headers, &reader)
       if Net::HTTPUnauthorized === 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)
+        @auth_digest = extract_digest_header(response)
+        if @auth_digest
           response = raw_request(path, body, extra_headers, &reader)
           if Net::HTTPUnauthorized === response
             raise AuthorizationFailure, "Authorization failed, check credentials?"
@@ -317,6 +312,16 @@ EOF
       response
     end
 
+    def authorization(path)
+      return nil unless @auth_digest
+      uri2 = URI.parse(login_uri.to_s)
+      uri2.user     = login_uri.user
+      uri2.password = login_uri.password
+      uri2.path     = path
+      build_auth(@auth_digest, uri2, tries)
+    end
+
+
     def request(*args, &block)
       handle_response(digest_auth_request(*args, &block))
     end
@@ -383,13 +388,13 @@ EOF
     end
 
     def session=(session)
-      self.authorization = session.authorization
-      self.capabilities  = session.capabilities
-      self.cookies       = session.cookies
+      self.auth_digest  = session.auth_digest
+      self.capabilities = session.capabilities
+      self.cookies      = session.cookies
     end
 
     def session
-      Session.new(authorization, capabilities, cookies)
+      Session.new(auth_digest, capabilities, cookies)
     end
 
 
@@ -435,7 +440,7 @@ EOF
     def connection
       @connection ||= options[:persistent] ?
         persistent_connection :
-        Net::HTTP.new(uri.host, uri.port)
+        Net::HTTP.new(login_uri.host, login_uri.port)
     end
 
     def persistent_connection
@@ -457,15 +462,16 @@ EOF
       options[:version] || "RETS/1.7.2"
     end
 
-    def build_headers
+    def build_headers(path)
       headers = {
         "User-Agent"   => user_agent,
-        "Host"         => "#{uri.host}:#{uri.port}",
+        "Host"         => "#{login_uri.host}:#{login_uri.port}",
         "RETS-Version" => rets_version
       }
 
-      headers.merge!("Authorization" => authorization) if authorization
-      headers.merge!("Cookie" => cookies)              if cookies
+      auth = authorization(path)
+      headers.merge!("Authorization" => auth) if auth
+      headers.merge!("Cookie" => cookies)     if cookies
 
       if options[:ua_password]
         headers.merge!(

data/test/test_client.rb

@@ -11,8 +11,8 @@ class TestClient < Test::Unit::TestCase
       :login_url => "http://example.com",
       :username => "bob@example.com")
 
-    assert_equal CGI.escape("bob@example.com"), client.uri.user
-    assert_nil client.uri.password
+    assert_equal CGI.escape("bob@example.com"), client.login_uri.user
+    assert_nil client.login_uri.password
   end
 
   def test_initialize_adds_escaped_password_to_uri
@@ -21,7 +21,7 @@ class TestClient < Test::Unit::TestCase
       :username => "bob",
       :password => "secret@2!")
 
-    assert_equal CGI.escape("secret@2!"), client.uri.password
+    assert_equal CGI.escape("secret@2!"), client.login_uri.password
   end
 
   def test_initialize_merges_default_options
@@ -58,11 +58,11 @@ class TestClient < Test::Unit::TestCase
     post = mock()
     post.expects(:body=).with("fake body")
 
-    headers = @client.build_headers
+    headers = @client.build_headers('path')
 
     Net::HTTP::Post.expects(:new).with("/foo", headers).returns(post)
 
-    @client.connection.expects(:request).with(@client.uri, post).returns(stub_everything)
+    @client.connection.expects(:request).with(@client.login_uri, post).returns(stub_everything)
 
     @client.expects(:handle_cookies)
     @client.expects(:handle_response)
@@ -77,7 +77,7 @@ class TestClient < Test::Unit::TestCase
   end
 
   def test_request_passes_correct_arguments_to_persistent_connection
-    @client.connection.expects(:request).with(@client.uri, instance_of(Net::HTTP::Post)).returns(stub_everything)
+    @client.connection.expects(:request).with(@client.login_uri, instance_of(Net::HTTP::Post)).returns(stub_everything)
 
     @client.stubs(:handle_cookies)
     @client.stubs(:handle_response)
@@ -213,18 +213,18 @@ class TestClient < Test::Unit::TestCase
       "User-Agent"    => "Client/1.0",
       "Host"          => "example.com:80",
       "RETS-Version"  => "RETS/1.7.2"},
-      @client.build_headers)
+      @client.build_headers('path'))
   end
 
   def test_build_headers_provides_authorization
-    @client.authorization = "Just trust me"
+    @client.expects(:authorization).returns("Just trust me")
 
     assert_equal({
       "Authorization" => "Just trust me",
       "User-Agent"    => "Client/1.0",
       "Host"          => "example.com:80",
       "RETS-Version"  => "RETS/1.7.2"},
-      @client.build_headers)
+      @client.build_headers('path'))
   end
 
   def test_build_headers_provides_cookies
@@ -235,7 +235,7 @@ class TestClient < Test::Unit::TestCase
       "User-Agent"    => "Client/1.0",
       "Host"          => "example.com:80",
       "RETS-Version"  => "RETS/1.7.2"},
-      @client.build_headers)
+      @client.build_headers('path'))
   end
 
 
@@ -289,33 +289,33 @@ DIGEST
 
 
   def test_session_restores_state
-    session = Rets::Session.new("Digest auth", {"Foo" => "/foo"}, "sessionid=123")
+    session = Rets::Session.new({:digest => 'true'}, {"Foo" => "/foo"}, "sessionid=123")
 
     @client.session = session
 
-    assert_equal("Digest auth",     @client.authorization)
+    assert_equal({:digest => 'true'},     @client.auth_digest)
     assert_equal({"Foo" => "/foo"}, @client.capabilities)
     assert_equal("sessionid=123",   @client.cookies)
   end
 
   def test_session_dumps_state
-    @client.authorization = "Digest auth"
+    @client.auth_digest = {:digest => 'true'}
     @client.capabilities  = {"Foo" => "/foo"}
     @client.cookies       = "session-id=123"
 
     session = @client.session
 
-    assert_equal("Digest auth",     session.authorization)
+    assert_equal({:digest => 'true'},     session.auth_digest)
     assert_equal({"Foo" => "/foo"}, session.capabilities)
     assert_equal("session-id=123",  session.cookies)
   end
 
   def test_initialize_with_session_restores_state
-    session = Rets::Session.new("Digest auth", {"Foo" => "/foo"}, "sessionid=123")
+    session = Rets::Session.new({:digest => true}, {"Foo" => "/foo"}, "sessionid=123")
 
     client = Rets::Client.new(:login_url => "http://example.com", :session => session)
 
-    assert_equal("Digest auth",     client.authorization)
+    assert_equal({:digest => true},     client.auth_digest)
     assert_equal({"Foo" => "/foo"}, client.capabilities)
     assert_equal("sessionid=123",   client.cookies)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rets
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-22 00:00:00.000000000 Z
+date: 2012-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
@@ -44,13 +44,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.5.2
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,15 +58,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 0.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,15 +74,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 2.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,15 +90,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: 1.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,7 +106,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +114,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,7 +122,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '3.0'
 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.