rets 0.1.1 → 0.1.2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.1.2 / 2012-02-17
+
+* bugfix - check ReplyCode in login, retry on errors
+
 ### 0.1.1 / 2012-01-11
 
 * bugfix - prevent infinite loop in login

data/lib/rets.rb

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

data/lib/rets/client.rb

@@ -10,22 +10,32 @@ module Rets
     attr_writer   :capabilities, :metadata
 
     def initialize(options)
+      @options = options
+      clean_setup
+    end
+    
+    def clean_setup
+      
       @capabilities = nil
       @cookies      = nil
       @metadata     = nil
+      @cached_metadata = 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.options = DEFAULT_OPTIONS.merge(@options)
       self.uri     = uri
 
-      self.logger = options[:logger] || FakeLogger.new
+      self.logger = @options[:logger] || FakeLogger.new
 
-      self.session  = options[:session]  if options[:session]
-      @cached_metadata = options[:metadata] || nil
+      self.session  = @options[:session]  if @options[:session]
+      @cached_metadata = @options[:metadata] || nil
     end
 
 
@@ -59,14 +69,29 @@ module Rets
     #
     def find(quantity, opts = {})
       case quantity
-        when :first  then find_every(opts.merge(:limit => 1)).first
-        when :all    then find_every(opts)
+        when :first  then find_with_retries(opts.merge(:limit => 1)).first
+        when :all    then find_with_retries(opts)
         else raise ArgumentError, "First argument must be :first or :all"
       end
     end
 
     alias search find
 
+    def find_with_retries(opts = {})
+      retries = 0
+      begin
+        find_every(opts)
+      rescue AuthorizationFailure, InvalidRequest => e
+        if retries < 3
+          retries += 1
+          self.logger.warn "Failed with message: #{e.message}"
+          self.logger.info "Retry #{retries}/3"
+          clean_setup
+          retry
+        end
+      end
+    end
+    
     def find_every(opts = {})
       search_uri = capability_url("Search")
 
@@ -275,6 +300,7 @@ module Rets
       if Net::HTTPUnauthorized === response
         raise AuthorizationFailure, "Authorization failed, check credentials?"
       else
+        check_errors(response)
         self.capabilities = extract_capabilities(Nokogiri.parse(response.body))
       end
     end
@@ -285,31 +311,32 @@ module Rets
         handle_unauthorized_response(response)
 
       elsif Net::HTTPSuccess === response # 2xx
-        begin
-          if !response.body.empty?
-            xml = Nokogiri::XML.parse(response.body, nil, nil, Nokogiri::XML::ParseOptions::STRICT)
+        check_errors(response)
+      else
+        raise UnknownResponse, "Unable to handle response #{response.class}"
+      end
 
-            reply_text = xml.xpath("/RETS").attr("ReplyText").value
-            reply_code = xml.xpath("/RETS").attr("ReplyCode").value.to_i
+      return response
+    end
 
-            if reply_code.nonzero?
-              raise InvalidRequest, "Got error code #{reply_code} (#{reply_text})."
-            end
-          end
+    def check_errors(response)
+      begin
+        if !response.body.empty?
+          xml = Nokogiri::XML.parse(response.body, nil, nil, Nokogiri::XML::ParseOptions::STRICT)
 
-        rescue Nokogiri::XML::SyntaxError => e
-          logger.debug "Not xml"
+          reply_text = xml.xpath("/RETS").attr("ReplyText").value
+          reply_code = xml.xpath("/RETS").attr("ReplyCode").value.to_i
 
+          if reply_code.nonzero?
+            raise InvalidRequest, "Got error code #{reply_code} (#{reply_text})."
+          end
         end
 
-      else
-        raise UnknownResponse, "Unable to handle response #{response.class}"
+      rescue Nokogiri::XML::SyntaxError => e
+        logger.debug "Not xml"
       end
-
-      return response
     end
 
-
     def handle_cookies(response)
       if cookies?(response)
         self.cookies = response.get_fields('set-cookie')

data/test/test_client.rb

@@ -116,6 +116,18 @@ 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)
@@ -420,6 +432,11 @@ DIGEST
     end
   end
 
+  def test_find_retries_on_errors
+    @client.stubs(:find_every).raises(Rets::AuthorizationFailure).then.raises(Rets::InvalidRequest).then.returns([])
+    @client.find(:all, :foo => :bar)
+  end
+
   def test_find_provides_default_values
     @client.expects(:build_key_values).
       with("QueryType" => "DMQL2", "Format" => "COMPACT", "Query" => "x", "Foo" => "bar").

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rets
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Estately, Inc. Open Source
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-11 00:00:00 Z
+date: 2012-02-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net-http-persistent
@@ -88,11 +88,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 25
         segments: 
         - 2
-        - 12
-        version: "2.12"
+        - 13
+        version: "2.13"
   type: :development
   version_requirements: *id005
 description: |-
@@ -163,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rets
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A pure-ruby library for fetching data from [RETS] servers