rets4r 0.8.3 → 0.8.4

data/CHANGELOG

@@ -1,3 +1,9 @@
+0.8.4
+	Fixed auth issue with authenticate headers with spaces after commas. (Ken Wiesner, Scott Patterson)
+	When an exception is raised in the authentication parsing code, complain by raising a new exception, but also report anything of interest at the same time: request, response, response's body. (Fran�ois Beausoleil)
+	Fixed Client#request to actually respect the specified request method instead of always using GET requests. (Scott Patterson)
+	Set default request method to POST since some RETS servers seem to have trouble with GET requests. (Scott Patterson)
+	
 0.8.3
 	Added example #set_pre_request_block. (Fran�ois Beausoleil)
 	Allow a pre request block to be set for RETS4R::Client.  

data/examples/metadata.xml

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby
+#
+# This is an example of how to use the RETS client to login to a server and retrieve metadata. It
+# also makes use of passing blocks to client methods and demonstrates how to set the output format.
+#
+# You will need to set the necessary variables below.
+#
+#############################################################################################
+# Settings
+
+rets_url = 'http://server.com/my/rets/url'
+username = 'username'
+password = 'password'
+  
+#############################################################################################
+$:.unshift 'lib'
+
+require 'rets4r'
+
+RETS4R::Client.new(rets_url) do |client|
+	client.login(username, password) do |login_result|		
+		if login_result.success?
+			puts "Logged in successfully!"
+						
+			# We want the raw metadata, so we need to set the output to raw XML.
+			client.set_output RETS4R::Client::OUTPUT_RAW
+			metadata = ''
+			
+			begin
+				metadata = client.get_metadata
+			rescue
+				puts "Unable to get metadata: '#{$!}'"
+			end
+			
+			File.open('metadata.xml', 'w') do |file|
+				file.write metadata
+			end
+		else
+			puts "Unable to login: '#{login_result.reply_text}'."
+		end
+	end
+end

data/lib/rets4r/auth.rb

@@ -45,7 +45,7 @@ module RETS4R
 		
 		def Auth.parse_header(header)
 			type = header[0, header.index(' ')]
-			args = header[header.index(' '), header.length].strip.split(',')
+			args = header[header.index(' '), header.length].strip.split(',').map {|x| x.strip}
 	
 			parts = {'type' => type}
 			

data/lib/rets4r/client.rb

@@ -8,8 +8,6 @@
 # version.
 #
 #	TODO
-#		1.0 Support (Adding this support should be fairly easy)
-#		2.0 Support (Adding this support will be very difficult since it is a completely different methodology)
 #		Case-insensitive header
 
 require 'digest/md5'
@@ -32,9 +30,9 @@ module RETS4R
 		METHOD_HEAD = 'HEAD'
 		
 		DEFAULT_OUTPUT		   = OUTPUT_RUBY
-		DEFAULT_METHOD 		   = METHOD_GET
+		DEFAULT_METHOD 		   = METHOD_POST
 		DEFAULT_RETRY        = 2
-		DEFAULT_USER_AGENT 	 = 'RETS4R/0.8.2'
+		DEFAULT_USER_AGENT 	 = 'RETS4R/0.8.4'
 		DEFAULT_RETS_VERSION = '1.7'
 		SUPPORTED_RETS_VERSIONS = ['1.5', '1.7']
 		CAPABILITY_LIST   = ['Action', 'ChangePassword', 'GetObject', 'Login', 'LoginComplete', 'Logout', 'Search', 'GetMetadata', 'Update']
@@ -183,7 +181,7 @@ module RETS4R
 				@parser_class = klass
 			else
 				message = "The parser class '#{klass}' is not supported!"
-				logger.debug(message) if logger
+				debug(message)
 				
 				raise Unsupported.new(message)
 			end
@@ -200,7 +198,7 @@ module RETS4R
 				@headers[name] = value
 			end
 			
-			logger.debug("Set header '#{name}' to '#{value}'") if logger
+			debug("Set header '#{name}' to '#{value}'")
 		end
 		
 		def get_header(name)
@@ -284,7 +282,7 @@ module RETS4R
 					@urls[capability] = base
 				end
 				
-				logger.debug("Capability URL List: #{@urls.inspect}") if logger
+				debug("Capability URL List: #{@urls.inspect}")
 			else
 				raise LoginError.new(response.message + "(#{results.reply_code}: #{results.reply_text})")
 			end
@@ -376,7 +374,7 @@ module RETS4R
 					(raw_header, raw_data) = part.split("\r\n\r\n")
 					
 					next unless raw_data
-					
+															
 					data_header = process_header(raw_header)
 					data_object = DataObject.new(data_header, raw_data)
 					
@@ -496,73 +494,84 @@ module RETS4R
 		# for how to make use of this method.
 		#++
 		def request(url, data = {}, header = {}, method = @request_method, retry_auth = DEFAULT_RETRY)
-			response = ''
-			
-			@semaphore.lock
+			headers, response = nil
+			begin			
+				@semaphore.lock
 			
-			http = Net::HTTP.new(url.host, url.port)
+				http = Net::HTTP.new(url.host, url.port)
 			
-			if logger && logger.debug?
-				http.set_debug_output HTTPDebugLogger.new(logger)
-			end
+				if logger && logger.debug?
+					http.set_debug_output HTTPDebugLogger.new(logger)
+				end
 			
-			http.start do |http|
-				begin
-					uri = url.path
+				http.start do |http|
+					begin
+						uri = url.path
 					
-					if ! data.empty? && method == METHOD_GET
-						uri += "?#{create_query_string(data)}"
-					end
+						if ! data.empty? && method == METHOD_GET
+							uri += "?#{create_query_string(data)}"
+						end
 
-					headers = @headers
-					headers.merge(header) unless header.empty?
+						headers = @headers
+						headers.merge(header) unless header.empty?
 					
-					@pre_request_block.call(self, http, headers) if @pre_request_block
+						@pre_request_block.call(self, http, headers) if @pre_request_block
 					
-					logger.debug(headers.inspect) if logger
+						debug("Request headers: #{headers.inspect}")
 					
-					@semaphore.unlock
-										
-					response = http.get(uri, headers)
+						@semaphore.unlock
 										
-					@semaphore.lock
+						post_data = data.map {|k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join('&') if method == METHOD_POST
+						response  = method == METHOD_POST ? http.post(uri, post_data, headers) : 
+						                                    http.get(uri, headers)
+											
+						debug("Response headers: #{response.to_hash.inspect}")
+
+						@semaphore.lock
 					
-					if response.code == '401'
-						# Authentication is required
-						raise AuthRequired
-					elsif response.code.to_i >= 300
-						# We have a non-successful response that we cannot handle
-						@semaphore.unlock if @semaphore.locked?
-						raise HTTPError.new(response)
-					else
-						cookies = []
-						if set_cookies = response.get_fields('set-cookie') then
-							set_cookies.each do |cookie|
-								cookies << cookie.split(";").first
+						if response.code == '401'
+							# Authentication is required
+							raise AuthRequired
+						elsif response.code.to_i >= 300
+							# We have a non-successful response that we cannot handle
+							@semaphore.unlock if @semaphore.locked?
+							raise HTTPError.new(response)
+						else
+							cookies = []
+							if set_cookies = response.get_fields('set-cookie') then
+								set_cookies.each do |cookie|
+									cookies << cookie.split(";").first
+								end
 							end
+							set_header('Cookie', cookies.join("; ")) unless cookies.empty?
+							set_header('RETS-Session-ID', response['RETS-Session-ID']) if response['RETS-Session-ID']
 						end
-						set_header('Cookie', cookies.join("; ")) unless cookies.empty?
-						set_header('RETS-Session-ID', response['RETS-Session-ID']) if response['RETS-Session-ID']
-					end
-				rescue AuthRequired
-					@nc += 1
+					rescue AuthRequired
+						@nc += 1
 
-					if retry_auth > 0
-						retry_auth -= 1
-						set_header('Authorization', Auth.authenticate(response, @username, @password, url.path, method, @headers['RETS-Request-ID'], get_user_agent, @nc))
-						retry
-					else
-						@semaphore.unlock if @semaphore.locked?
-						raise LoginError.new(response.message)
-					end
-				end		
+						if retry_auth > 0
+							retry_auth -= 1
+							set_header('Authorization', Auth.authenticate(response, @username, @password, url.path, method, @headers['RETS-Request-ID'], get_user_agent, @nc))
+							retry
+						else
+							@semaphore.unlock if @semaphore.locked?
+							raise LoginError.new(response.message)
+						end
+					end		
 				
-				logger.debug(response.body) if logger
-			end
+					debug(response.body)
+				end
+			
+				@semaphore.unlock if @semaphore.locked?
 			
-			@semaphore.unlock if @semaphore.locked?
+				return response
 			
-			return response
+			#rescue
+				#data = {"request" => headers, "body" => response.body}
+				#data["response"] = response.respond_to?(:headers) ? response.headers : response
+				#data = data.respond_to?(:to_yaml) ? data.to_yaml : data.inspect
+				#raise RETSException, "#{$!.message}\nRequest/Response Details:\n#{data}"
+			end
 		end
 		
 		# If an action URL is present in the URL capability list, it calls that action URL and returns the
@@ -577,6 +586,11 @@ module RETS4R
 			end
 		end
 		
+		# Shorthand for sending debug messages to the logger if a logger is provided
+		def debug(message)
+			logger.debug(message) if logger
+		end
+		
 		# Provides a proxy class to allow for net/http to log its debug to the logger.
 		class HTTPDebugLogger
 			def initialize(logger)

data/lib/rets4r/client/parser.rb

@@ -102,7 +102,7 @@ module RETS4R
 			
 			def parse_compact_line(data, delim = "\t")
 				begin
-					return data.to_s.strip.split(delim)
+					return data.to_s.split(delim)
 				rescue
 					raise "Error while parsing compact line: #{$!} with data: #{data}"
 				end

data/test/client/tc_auth.rb

@@ -21,9 +21,20 @@ module RETS4R
 			Auth.authenticate(response, @username, @password, '/my/rets/url', 'GET', Auth.request_id, @useragent)
 		end
 		
-		def test_parse_auth_header
+		# test without spacing
+		def test_parse_auth_header_without_spacing
 			header = 'Digest qop="auth",realm="'+ @realm +'",nonce="'+ @nonce +'",opaque="",stale="false",domain="\my\test\domain"'
-			
+			check_header(header)
+		end
+		
+		# test with spacing between each item
+		def test_parse_auth_header_with_spacing
+			header = 'Digest qop="auth", realm="'+ @realm +'", nonce="'+ @nonce +'", opaque="", stale="false", domain="\my\test\domain"'
+			check_header(header)
+		end
+		
+		# used to check the that the header was processed properly.
+		def check_header(header)
 			results = Auth.parse_header(header)
 			
 			assert_equal('auth', results['qop'])

data/test/client/tc_client.rb

@@ -279,7 +279,41 @@ module RETS4R
 			assert_equal('multipart/parallel', results['content-type'])
 			assert_equal('utf-8', results['charset'])
 		end
-						
+	
+		def test_performs_get_request
+			assert_nothing_raised() {@rets.request_method = 'GET'}	
+			assert_equal('GET', @rets.request_method)
+			
+			http     = mock('http')
+			response = mock('response')
+			response.stubs(:to_hash).returns({})
+			response.stubs(:code).returns('500')
+			response.stubs(:message).returns('Move along, nothing to see here.')
+			
+			http.expects(:get).with('', {'RETS-Session-ID' => '0', 'User-Agent' => 'RETS4R/0.8.2', 'RETS-Version' => 'RETS/1.7', 'Accept' => '*/*'}).at_least_once.returns(response)
+			http.expects(:post).never
+			Net::HTTP.any_instance.expects(:start).at_least_once.yields(http)
+			
+			assert_raises(RETS4R::Client::HTTPError) {@rets.login('user', 'pass')}
+		end
+		
+		def test_performs_post_request
+			assert_nothing_raised() {@rets.request_method = 'POST'}	
+			assert_equal('POST', @rets.request_method)
+			
+			http     = mock('http')
+			response = mock('response')
+			response.stubs(:to_hash).returns({})
+			response.stubs(:code).returns('500')
+			response.stubs(:message).returns('Move along, nothing to see here.')
+			
+			http.expects(:post).with('', '', {'RETS-Session-ID' => '0', 'User-Agent' => 'RETS4R/0.8.2', 'RETS-Version' => 'RETS/1.7', 'Accept' => '*/*'}).at_least_once.returns(response)
+			http.expects(:get).never
+			Net::HTTP.any_instance.expects(:start).at_least_once.yields(http)
+			
+			assert_raises(RETS4R::Client::HTTPError) {@rets.login('user', 'pass')}
+		end
+		
 		class MockParser
 		end
 	end

metadata

@@ -1,38 +1,38 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: rets4r
 version: !ruby/object:Gem::Version 
-  version: 0.8.3
-date: 2008-01-03 00:00:00 -08:00
-summary: A native Ruby implementation of RETS (Real Estate Transaction Standard).
-require_paths: 
-- lib
-email: scott.patterson@digitalaun.com
-homepage: http://rets4r.rubyforge.org/
-rubyforge_project: rets4r
-description: 
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.8.4
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Scott Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-05 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: scott.patterson@digitalaun.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CONTRIBUTORS
+- README
+- LICENSE
+- RUBYS
+- GPL
+- CHANGELOG
+- TODO
 files: 
 - examples/client_get_object.rb
 - examples/client_login.rb
 - examples/client_metadata.rb
 - examples/client_search.rb
+- examples/metadata.xml
 - lib/rets4r
 - lib/rets4r/auth.rb
 - lib/rets4r/client
@@ -73,24 +73,32 @@ files:
 - GPL
 - CHANGELOG
 - TODO
-test_files: 
-- test/ts_all.rb
+has_rdoc: true
+homepage: http://rets4r.rubyforge.org/
+post_install_message: 
 rdoc_options: 
 - --main
 - README
-extra_rdoc_files: 
-- CONTRIBUTORS
-- README
-- LICENSE
-- RUBYS
-- GPL
-- CHANGELOG
-- TODO
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
-
+rubyforge_project: rets4r
+rubygems_version: 1.3.0
+signing_key: 
+specification_version: 2
+summary: A native Ruby implementation of RETS (Real Estate Transaction Standard).
+test_files: 
+- test/ts_all.rb