rets 0.2.2 → 0.3.0.rc.1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.3.0.rc.0 / 2012-07-26
+
+* feature: significantly better handling of authorization failures
+
 ### 0.2.1 / 2012-04-20
 
 * fix: better handling of malformed RETS responses

data/lib/rets.rb

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

data/lib/rets/client.rb

@@ -35,7 +35,7 @@ module Rets
 
       self.logger = @options[:logger] || FakeLogger.new
 
-      self.session  = @options[:session]  if @options[:session]
+      self.session  = @options.delete(:session)  if @options[:session]
       @cached_metadata = @options[:metadata] || nil
     end
 
@@ -108,12 +108,12 @@ module Rets
 
       body = build_key_values(query)
 
-      headers = build_headers.merge(
+      extra_headers = {
         "Content-Type"   => "application/x-www-form-urlencoded",
         "Content-Length" => body.size.to_s
-      )
+      }
 
-      results = request_with_compact_response(search_uri.path, body, headers)
+      results = request_with_compact_response(search_uri.path, body, extra_headers)
 
       if resolve
         rets_class = find_rets_class(opts[:search_type], opts[:class])
@@ -210,13 +210,13 @@ module Rets
         "Location" => opts[:location] || 0
       )
 
-      headers = build_headers.merge(
+      extra_headers = {
         "Accept"         => "image/jpeg, image/png;q=0.5, image/gif;q=0.1",
         "Content-Type"   => "application/x-www-form-urlencoded",
         "Content-Length" => body.size.to_s
-      )
+      }
 
-      request(object_uri.path, body, headers)
+      request(object_uri.path, body, extra_headers)
     end
 
     # Changes keys to be camel cased, per the RETS standard for queries.
@@ -252,18 +252,19 @@ module Rets
         "ID"     => "0"
       )
 
-      headers = build_headers.merge(
+      extra_headers = {
         "Content-Type"   => "application/x-www-form-urlencoded",
         "Content-Length" => body.size.to_s
-      )
+      }
 
-      response = request(metadata_uri.path, body, headers)
+      response = request(metadata_uri.path, body, extra_headers)
 
       response.body
     end
 
-    def raw_request(path, body = nil, headers = build_headers, &reader)
+    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
@@ -291,7 +292,14 @@ module Rets
     end
 
     def request(*args, &block)
-      handle_response(raw_request(*args, &block))
+      response = handle_response(raw_request(*args, &block))
+      if Net::HTTPUnauthorized === response
+        retry_response = handle_response(raw_request(*args, &block))
+        raise AuthorizationFailure if retry_response === Net::HTTPUnauthorized
+        retry_response
+      else
+        response
+      end
     end
 
     def request_with_compact_response(path, body, headers)
@@ -306,15 +314,19 @@ module Rets
     end
 
     def handle_unauthorized_response(response)
-      self.authorization = build_auth(extract_digest_header(response), uri, tries)
+      if self.authorization.nil?
+        self.authorization = build_auth(extract_digest_header(response), uri, tries)
+        response = raw_request(uri.path)
 
-      response = raw_request(uri.path)
-
-      if Net::HTTPUnauthorized === response
-        raise AuthorizationFailure, "Authorization failed, check credentials?"
+        if Net::HTTPUnauthorized === response
+          raise AuthorizationFailure, "Authorization failed, check credentials?"
+        else
+          ErrorChecker.check(response)
+          self.capabilities = extract_capabilities(Nokogiri.parse(response.body))
+        end
       else
-        ErrorChecker.check(response)
-        self.capabilities = extract_capabilities(Nokogiri.parse(response.body))
+        clean_setup
+        login
       end
     end
 

data/test/test_client.rb

@@ -521,15 +521,41 @@ DIGEST
     @client.objects([1,2], :foo => :bar)
   end
 
-  def test_object_handles_empty_bodies
-    @client = Rets::Client.new(:password=>"fake", :agent=>"agent", :login_url=>"http://www.example.com:6103/", :username=>"fake_user")
-    assert_raise Rets::MalformedResponse do
-      VCR.use_cassette('empty_body') do
-        @client.objects([1], :resource => 'Property', :object_type => 'Photo', :resource_id => '480346')
-      end
+  def test_unauthorized_session
+    session = Rets::Session.new(
+      "Digest username=\"login\", realm=\"fake_realm\", qop=\"auth\", uri=\"/Login.asmx/Login\", nonce=\"a8f4bc805062602c8ba7a87b2109f808\", nc=00000001, cnonce=\"6e2dd038eea6cbacf0b956fd11f914b6\", response=\"fake_digest\", opaque=\"96eda461-41d0-4624-b7fe-b59e966035f3\"",
+      {
+        "GetObject"=>"/GetObject.asmx/GetObject",
+        "GetMetadata"=>"/GetMetadata.asmx/GetMetadata",
+        "Login"=>"/Login.asmx/Login",
+        "metadatatimestamp"=>"2012-07-17T16:34:22Z",
+        "user"=>"23756,60,RH,login",
+        "Search"=>"/Search.asmx/Search",
+        "timeoutseconds"=>"7200"
+      },
+      "ASP.NET_SessionId=mapij045k3bphj3gqqgpmmrx; RETS-Session-ID=mapij045k3bphj3gqqgpmmrx"
+    )
+    opts = {
+      :username  => 'login',
+      :password  => 'Bn1X@y4L',
+      :login_url => 'http://rets.example.com/Login.asmx/Login',
+      :agent     => 'Estately/1.0',
+      :persistent => false,
+      :session    => session
+    }
+    client = Rets::Client.new(opts)
+    response = nil
+    VCR.use_cassette('unauthorized_response') do
+      response = client.objects("1",
+                                :resource    => 'Property',
+                                :object_type => 'Photo',
+                                :resource_id => '2661580'
+                               )
     end
+    assert_equal 'image/jpeg', response.first.headers['content-type']
   end
 
+
   def test_objects_raises_on_other_arguments
     assert_raise ArgumentError do
       @client.objects(Object.new, :foo => :bar)

metadata

@@ -1,130 +1,107 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rets
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 0.3.0.rc.1
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 2
-  version: 0.2.2
 platform: ruby
-authors: 
+authors:
 - Estately, Inc. Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-01 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: net-http-persistent
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70186895334000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 7
-        version: "1.7"
+      - !ruby/object:Gem::Version
+        version: '1.7'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: nokogiri
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70186895334000
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70186895333580 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 5
-        - 2
+      - !ruby/object:Gem::Version
         version: 1.5.2
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70186895333580
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70186895333160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 51
-        segments: 
-        - 0
-        - 11
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.11.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: vcr
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70186895333160
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70186895332740 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 2
-        - 2
+      - !ruby/object:Gem::Version
         version: 2.2.2
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70186895332740
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70186895332320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 55
-        segments: 
-        - 1
-        - 8
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.8.0
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70186895332320
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70186895331900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 12
-        version: "2.12"
+      - !ruby/object:Gem::Version
+        version: '3.10'
   type: :development
-  version_requirements: *id006
-description: |-
-  [![Build Status](https://secure.travis-ci.org/estately/rets.png?branch=master)](http://travis-ci.org/estately/rets)
+  prerelease: false
+  version_requirements: *70186895331900
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &70186895331480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: *70186895331480
+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.
-  
-  [RETS]: http://www.rets.org
-email: 
+
+
+  [RETS]: http://www.rets.org'
+email:
 - opensource@estately.com
-executables: 
+executables:
 - rets
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - Manifest.txt
-files: 
+files:
 - CHANGELOG.md
 - Manifest.txt
 - README.md
@@ -151,39 +128,32 @@ files:
 - .gemtest
 homepage: http://github.com/estately/rets
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.md
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: rets
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: "[![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"
-test_files: 
+summary: ! '[![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'
+test_files:
 - test/test_client.rb
 - test/test_metadata.rb
 - test/test_parser_compact.rb