rets 0.1.0

data/lib/rets/parser/compact.rb

@@ -0,0 +1,46 @@
+module Rets
+  module Parser
+    class Compact
+      TAB = /\t/
+
+      INCLUDE_NULL_FIELDS = -1
+
+      InvalidDelimiter = Class.new(ArgumentError)
+
+      def self.parse_document(xml)
+        doc = Nokogiri.parse(xml.to_s)
+
+        delimiter = doc.at("//DELIMITER")
+        delimiter = delimiter ? Regexp.new(Regexp.escape(delimiter.attr(:value).to_i.chr)) : TAB
+
+        if delimiter == // || delimiter == /,/
+          raise InvalidDelimiter, "Empty or invalid delimiter found, unable to parse."
+        end
+
+        columns = doc.at("//COLUMNS").text
+        rows    = doc.xpath("//DATA")
+
+        rows.map do |data|
+          self.parse(columns, data.text, delimiter)
+        end
+      end
+
+      # Parses a single row of RETS-COMPACT data.
+      #
+      # Delimiter must be a regexp because String#split behaves differently when
+      # given a string pattern. (It removes leading spaces).
+      #
+      def self.parse(columns, data, delimiter = TAB)
+        raise ArgumentError, "Delimiter must be a regular expression" unless Regexp === delimiter
+
+        column_names = columns.split(delimiter)
+        data_values = data.split(delimiter, INCLUDE_NULL_FIELDS)
+
+        zipped_key_values = column_names.zip(data_values).map { |k, v| [k, v.to_s] }
+
+        hash = Hash[*zipped_key_values.flatten]
+        hash.reject { |key, value| key.empty? && value.to_s.empty? }
+      end
+    end
+  end
+end

data/lib/rets/parser/multipart.rb

@@ -0,0 +1,36 @@
+module Rets
+  module Parser
+
+    # Inspired by Mail.
+    class Multipart
+      CRLF = "\r\n"
+      WSP  = "\s"
+
+      HEADER_LINE = /^([!-9;-~]+:\s*.+)$/
+
+      Part = Struct.new(:headers, :body)
+
+      def self.parse(raw, boundary)
+        parts = []
+
+        boundary_regexp = /--#{Regexp.quote(boundary)}(--)?#{CRLF}/
+
+          raw.split(boundary_regexp).each do |chunk|
+
+            header_part, body_part = chunk.split(/#{CRLF}#{WSP}*#{CRLF}/m, 2)
+
+            if header_part =~ HEADER_LINE
+              headers = header_part.split(/\r\n/).map { |kv| k,v = kv.split(/:\s?/); [k.downcase, v] }
+              headers = Hash[*headers.flatten]
+
+              parts << Part.new(headers, body_part)
+            else
+              next # not a valid chunk.
+            end
+          end
+
+        parts
+      end
+    end
+  end
+end

data/test/fixtures.rb

@@ -0,0 +1,142 @@
+RETS_ERROR = <<-XML
+<?xml version="1.0"?>
+<RETS ReplyCode="123" ReplyText="Error message">
+</RETS>
+XML
+
+RETS_REPLY = <<-XML
+<?xml version="1.0"?>
+<RETS ReplyCode="0" ReplyText="OK">
+</RETS>
+XML
+
+CAPABILITIES = <<-XML
+<RETS ReplyCode="0" ReplyText="OK">
+  <RETS-RESPONSE>
+
+    Abc=123
+    Def=ghi=jk
+
+  </RETS-RESPONSE>
+</RETS>
+XML
+
+# 44 is the ASCII code for comma; an invalid delimiter.
+INVALID_DELIMETER = <<-XML
+<?xml version="1.0"?>
+<METADATA-RESOURCE Version="01.72.10306" Date="2011-03-15T19:51:22">
+  <DELIMITER value="44" />
+  <COLUMNS>A\tB</COLUMNS>
+  <DATA>1\t2</DATA>
+  <DATA>4\t5</DATA>
+</METADATA>
+XML
+
+COMPACT = <<-XML
+<?xml version="1.0"?>
+<METADATA-RESOURCE Version="01.72.10306" Date="2011-03-15T19:51:22">
+  <COLUMNS>A\tB</COLUMNS>
+  <DATA>1\t2</DATA>
+  <DATA>4\t5</DATA>
+</METADATA>
+XML
+
+METADATA_UNKNOWN = <<-XML
+<?xml version="1.0"?>
+<RETS ReplyCode="0" ReplyText="Operation successful.">
+<METADATA-FOO Version="01.72.10306" Date="2011-03-15T19:51:22">
+<UNKNOWN />
+</METADATA-FOO>
+XML
+
+METADATA_SYSTEM = <<-XML
+<?xml version="1.0"?>
+<RETS ReplyCode="0" ReplyText="Operation successful.">
+<METADATA-SYSTEM Version="01.72.10306" Date="2011-03-15T19:51:22">
+<SYSTEM />
+<COMMENTS />
+</METADATA-SYSTEM>
+XML
+
+METADATA_RESOURCE = <<-XML
+<?xml version="1.0"?>
+<RETS ReplyCode="0" ReplyText="Operation successful.">
+<METADATA-RESOURCE Version="01.72.10306" Date="2011-03-15T19:51:22">
+<COLUMNS>	ResourceID	StandardName	VisibleName	Description	KeyField	ClassCount	ClassVersion	ClassDate	ObjectVersion	ObjectDate	SearchHelpVersion	SearchHelpDate	EditMaskVersion	EditMaskDate	LookupVersion	LookupDate	UpdateHelpVersion	UpdateHelpDate	ValidationExpressionVersion	ValidationExpressionDate	ValidationLookupVersionValidationLookupDate	ValidationExternalVersion	ValidationExternalDate	</COLUMNS>
+<DATA>	ActiveAgent	ActiveAgent	Active Agent Search	Contains information about active agents.	MemberNumber	1	01.72.10304	2011-03-03T00:29:23	01.72.10000	2010-08-16T15:08:20	01.72.10305	2011-03-09T21:33:41			01.72.10284	2011-02-24T06:56:43		</DATA>
+<DATA>	Agent	Agent	Agent Search	Contains information about all agents.	MemberNumber	1	01.72.10303	2011-03-03T00:29:23	01.72.10000	2010-08-16T15:08:20	01.72.10305	2011-03-09T21:33:41			01.72.10284	2011-02-24T06:56:43						</DATA>
+<DATA>	History	History	History Search	Contains information about accumulated changes to each listing.	TransactionRid	1	01.72.10185	2010-12-02T02:02:58	01.72.10000	2010-08-16T15:08:20	01.72.10000	2010-08-16T22:08:30			01.72.10000	2010-08-16T15:08:20			</DATA>
+<DATA>	MemberAssociation		Member Association	Contains MLS member Association information.	MemberAssociationKey	1	01.72.10277	2011-02-23T19:11:10			01.72.10214	2011-01-06T16:41:05	01.72.10220	2011-01-06T16:41:06						</DATA>
+<DATA>	Office	Office	Office Search	Contains information about broker offices.	OfficeNumber	1	01.72.10302	2011-03-03T00:29:23	01.72.10000	2010-08-16T15:08:20	01.72.10305	2011-03-09T21:33:41		01.72.10284	2011-02-24T06:56:43						</DATA>
+<DATA>	OfficeAssociation		Office Association	Contains MLS office Association information.	OfficeAssociationKey	1	01.72.10306	2011-03-15T19:51:22			01.72.10245	2011-01-06T16:41:08	01.72.10251	2011-01-06T16:41:08						</DATA>
+<DATA>	OpenHouse	OpenHouse	Open House Search	Contains information about public open house activities.	OpenHouseRid	1	01.72.10185	2010-12-02T02:02:58	01.72.10000	2010-08-16T15:08:20	01.72.10134	2010-11-12T13:57:32			01.72.10000	2010-08-16T15:08:20									</DATA>
+<DATA>	Property	Property	Property Search	Contains information about listed properties.	ListingRid	8	01.72.10288	2011-02-24T06:59:11	01.72.10000	2010-08-16T15:08:20	01.72.10289	2011-02-24T06:59:19			01.72.10290	2011-03-01T11:06:31			</DATA>
+<DATA>	PropertyDeleted		Deleted Property Search	Contains information about deleted properties.	ListingRid	1	01.72.10185	2010-12-02T02:02:58	01.72.10000	2010-08-16T15:08:20	01.72.10000	2010-08-16T22:08:30			01.72.10000	2010-08-16T22:08:34			</DATA>
+<DATA>	PropertyWithheld		Withheld Property Search	Contains information about withheld properties.	ListingRid	8	01.72.10201	2011-01-05T19:34:36	01.72.10000	2010-08-16T15:08:20	01.72.10200	2011-01-05T19:34:34			01.72.10000	2010-08-16T22:08:34	</DATA>
+<DATA>	Prospect	Prospect	Prospect Search	Contains information about sales or listing propects.	ProspectRid	1	01.72.10185	2010-12-02T02:02:58	01.72.10000	2010-08-16T15:08:20	01.72.10000	2010-08-16T15:08:20			01.72.10000	2010-08-16T15:08:20		</DATA>
+<DATA>	Tour	Tour	Tour Search	Contains information about private tour activities.	TourRid	1	01.72.10185	2010-12-02T02:02:58	01.72.10000	2010-08-16T15:08:20	01.72.10000	2010-08-16T22:08:30		01.72.10000	2010-08-16T15:08:20						</DATA>
+<DATA>	VirtualMedia		Virtual Media	Contains information about virtual media for MLS listings.	VirtualMediaRid	1	01.72.10126	2010-11-12T13:47:41			01.72.10127	2010-11-12T13:47:41		01.72.10086	2010-11-10T09:59:11						</DATA>
+</METADATA-RESOURCE>
+</RETS>
+XML
+
+METADATA_OBJECT = "<RETS ReplyCode=\"0\" ReplyText=\"V2.6.0 728: Success\">\r\n<METADATA-OBJECT Resource=\"Property\" Version=\"1.12.24\" Date=\"Wed, 1 Dec 2010 00:00:00 GMT\">\r\n<COLUMNS>\tMetadataEntryID\tObjectType\tStandardName\tMimeType\tVisibleName\tDescription\tObjectTimeStamp\tObjectCount\t</COLUMNS>\r\n<DATA>\t50045650619\tMedium\tMedium\timage/jpeg\tMedium\tA 320 x 240 Size Photo\tLastPhotoDate\tTotalPhotoCount\t</DATA>\r\n<DATA>\t20101753230\tDocumentPDF\tDocumentPDF\tapplication/pdf\tDocumentPDF\tDocumentPDF\t\t\t</DATA>\r\n<DATA>\t50045650620\tPhoto\tPhoto\timage/jpeg\tPhoto\tA 640 x 480 Size Photo\tLastPhotoDate\tTotalPhotoCount\t</DATA>\r\n<DATA>\t50045650621\tThumbnail\tThumbnail\timage/jpeg\tThumbnail\tA 128 x 96 Size Photo\tLastPhotoDate\tTotalPhotoCount\t</DATA>\r\n</METADATA-OBJECT>\r\n</RETS>\r\n"
+
+MULITPART_RESPONSE = [
+  "--simple boundary",
+  "Content-Type: image/jpeg",
+  "Content-Length: 10",
+  "Content-ID: 90020062739",
+  "Object-ID: 1",
+  "",
+  "xxxxxxxx",
+  "--simple boundary",
+  "Content-Type: image/jpeg",
+  "Content-Length: 10",
+  "Content-ID: 90020062739",
+  "Object-ID: 2",
+  "",
+  "yyyyyyyy",
+  "--simple boundary",
+  ""
+].join("\r\n")
+
+
+SAMPLE_COMPACT = <<XML
+<RETS ReplyCode="0" ReplyText="Operation successful.">
+<METADATA-TABLE Resource="ActiveAgent" Class="MEMB" Version="01.72.10236" Date="2011-03-03T00:29:23">
+<COLUMNS>	MetadataEntryID	SystemName	StandardName	LongName	DBName	ShortName	MaximumLength	DataType	Precision	Searchable	Interpretation	Alignment	UseSeparator	EditMaskID	LookupName	MaxSelect	Units	Index	Minimum	Maximum	Default	Required	SearchHelpID	Unique	ModTimeStamp	ForeignKeyName	ForeignField	InKeyindex	</COLUMNS>
+<DATA>	7	City		City	City	City	11	Character	0	1		Left	0			0		0	0	0	0	0	City	0	0	1	MemberNumber	0	</DATA>
+<DATA>	9	ContactAddlPhoneType1		Contact Additional Phone Type 1	AddlPhTyp1	Contact Addl Ph Type 1	1	Character	0	1	Lookup	Left	0		ContactAddlPhoneType	0		0	0	0	0	0	ContactAddlPhoneType	0	0	1	MemberNumber	0	</DATA>
+<DATA>	11	ContactAddlPhoneType2		Contact Additional Phone Type 2	AddlPhTyp2	Contact Addl Ph Type 2	1	Character	0	1	Lookup	Left	0		ContactAddlPhoneType	0		0	0	0	0	0	ContactAddlPhoneType	0	0	1	MemberNumber	0	</DATA>
+<DATA>	13	ContactAddlPhoneType3		Contact Additional Phone Type 3	AddlPhTyp3	Contact Addl Ph Type 3	1	Character	0	1	Lookup	Left	0		ContactAddlPhoneType	0		0	0	0	0	0	ContactAddlPhoneType	0	0	1	MemberNumber	0	</DATA>
+<DATA>	15	ContactPhoneAreaCode1		Contact Phone Area Code 1	ContPhAC1	Contact Phone AC 1	3	Character	0	1		Left	0			0		0	0	0	0	0	ContactPhoneAreaCode	0	0	1	MemberNumber	0	</DATA>
+<DATA>	17	ContactPhoneAreaCode2		Contact Phone Area Code 2	ContPhAC2	Contact Phone AC 2	3	Character	0	1		Left	0			0		0	0	0	0	0	ContactPhoneAreaCode	0	0	1	MemberNumber	0	</DATA>
+<DATA>	19	ContactPhoneAreaCode3		Contact Phone Area Code 3	ContPhAC3	Contact Phone AC 3	3	Character	0	1		Left	0			0		0	0	0	0	0	ContactPhoneAreaCode	0	0	1	MemberNumber	0	</DATA>
+</METADATA-TABLE>
+</RETS>
+XML
+
+SAMPLE_COMPACT_2 = <<XML
+<?xml version="1.0" encoding="utf-8"?>
+<RETS ReplyCode="0" ReplyText="Success">
+  <METADATA-TABLE Class="15" Date="2010-10-28T05:41:31Z" Resource="Office" Version="26.27.62891">
+    <COLUMNS>	ModTimeStamp	MetadataEntryID	SystemName	StandardName	LongName	DBName	ShortName	MaximumLength	DataType	Precision	Searchable	Interpretation	Alignment	UseSeparator	EditMaskID	LookupName	MaxSelect	Units	Index	Minimum	Maximum	Default	Required	SearchHelpID	Unique	ForeignKeyName	ForeignField	InKeyIndex	</COLUMNS>
+    <DATA>		sysid15	sysid		sysid	sysid	sysid	10	Int	0	1			0			0		1			0	0		1			1	</DATA>
+    <DATA>		15n1155	OfficePhone_f1155	OfficePhone	Phone	Offic_1155	Phone	50	Character	0	1			0			0		0			0	0		0			0	</DATA>
+    <DATA>		15n1158	AccessFlag_f1158		Office Status	Acces_1158	Status	50	Character	0	1			0			0		0			0	0		0			0	</DATA>
+    <DATA>		15n1163	MODIFIED_f1163		Modified	MODIF_1163	Modified	20	DateTime	0	1			0			0		0			0	0		0			0	</DATA>
+    <DATA>		15n1165	DESREALTOR_f1165		DesRealtor	DESRE_1165	DesRealtor	75	Character	0	1			0			0		0			0	0		0			0	</DATA>
+    <DATA>		15n1166	DESREALTORUID_f1166		Designated Realtor Uid	DESRE_1166	RealtorUid	20	Character	0	1			0			0		0			0	0		0			0	</DATA>
+    <DATA>		15n1167	INT_NO_f1167		Internet Syndication (Y/N)	INT_N_1167	Int.Syn.	1	Character	0	1	Lookup		0		YESNO	1		0			0	0		0			0	</DATA>
+    <DATA>		15n1168	STATE_f1168		State	STATE_1168	State	50	Character	0	1	Lookup		0		1_523	1		0			0	0		0			0	</DATA>
+    <DATA>		15n1169	CITY_f1169		City	CITY_1169	City	50	Character	0	1			0			0		0			0	0		0			0	</DATA>
+    <DATA>		15n1170	IDX_NO_f1170		IDX (Y/N)	IDX_N_1170	IDX	1	Character	0	1			0			0		0			0	0		0			0	</DATA>
+    <DATA>		15n1172	ZipCode_f1172		Zip	ZipCo_1172	Zip	50	Character	0	1			0			0		0			0	0		0			0	</DATA>
+    <DATA>		15n1177	ADDRESS1_f1177		Address Line 1	ADDRE_1177	Address1	50	Character	0	1			0			0		0			0	0		0			0	</DATA>
+    <DATA>		15n1182	MLSYN_f1182		MLS Y/N	MLSYN_1182	MLSYN	1	Character	0	1			0			0		0			0	0		0			0	</DATA>
+    <DATA>		15n1184	OFFICENAME_f1184	Name	Office Name	OFFIC_1184	Office Name	50	Character	0	1			0			0		0			0	0		0			0	</DATA>
+    <DATA>		15n1193	OfficeCode_f1193	OfficeID	Office Code	Offic_1193	Office Code	12	Character	0	1			0			0		0			0	0		0			1	</DATA>
+  </METADATA-TABLE>
+</RETS>
+XML

data/test/helper.rb

@@ -0,0 +1,6 @@
+require "test/unit"
+require "mocha"
+
+require "rets"
+
+require "fixtures"

data/test/test_client.rb

@@ -0,0 +1,571 @@
+require "helper"
+
+class TestClient < Test::Unit::TestCase
+
+  def setup
+    @client = Rets::Client.new(:login_url => "http://example.com/login")
+  end
+
+  def test_initialize_adds_escaped_username_to_uri
+    client = Rets::Client.new(
+      :login_url => "http://example.com",
+      :username => "bob@example.com")
+
+    assert_equal CGI.escape("bob@example.com"), client.uri.user
+    assert_nil client.uri.password
+  end
+
+  def test_initialize_adds_escaped_password_to_uri
+    client = Rets::Client.new(
+      :login_url => "http://example.com",
+      :username => "bob",
+      :password => "secret@2!")
+
+    assert_equal CGI.escape("secret@2!"), client.uri.password
+  end
+
+  def test_initialize_merges_default_options
+    client = Rets::Client.new(:login_url => "http://example.com", :foo => true)
+
+    assert client.options.include?(:foo)
+  end
+
+  def test_initialize_allows_default_options_to_be_overridden
+    assert Rets::Client::DEFAULT_OPTIONS.include?(:persistent)
+
+    client = Rets::Client.new(:login_url => "http://example.com")
+    assert_equal true, client.options[:persistent]
+
+    client = Rets::Client.new(:login_url => "http://example.com", :persistent => false)
+    assert_equal false, client.options[:persistent]
+  end
+
+
+  def test_connection_uses_persistent
+    assert_kind_of Net::HTTP::Persistent, @client.connection
+  end
+
+  def test_connection_uses_net_http
+    client = Rets::Client.new(:login_url => "http://example.com", :persistent => false)
+
+    assert_kind_of Net::HTTP, client.connection
+    assert_equal "example.com", client.connection.address
+    assert_equal 80, client.connection.port
+  end
+
+
+  def test_request
+    post = mock()
+    post.expects(:body=).with("fake body")
+
+    headers = @client.build_headers
+
+    Net::HTTP::Post.expects(:new).with("/foo", headers).returns(post)
+
+    @client.connection.expects(:request).with(@client.uri, post).returns(stub_everything)
+
+    @client.expects(:handle_cookies)
+    @client.expects(:handle_response)
+
+    @client.stubs(:format_headers)
+
+    @client.request("/foo", "fake body")
+  end
+
+  def test_request_with_block
+    # TODO
+  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.stubs(:handle_cookies)
+    @client.stubs(:handle_response)
+    @client.stubs(:format_headers)
+
+    @client.request("/foo")
+  end
+
+  def test_request_passes_correct_arguments_to_net_http_connection
+    client = Rets::Client.new(:login_url => "http://example.com", :persistent => false)
+
+    client.connection.expects(:request).with(instance_of(Net::HTTP::Post)).returns(stub_everything)
+
+    client.stubs(:handle_cookies)
+    client.stubs(:handle_response)
+    client.stubs(:format_headers)
+
+    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)
+
+    assert_raise Rets::InvalidRequest do
+      @client.handle_response(response)
+    end
+  end
+
+  def test_handle_response_handles_rets_valid_response
+    response = Net::HTTPSuccess.new("", "", "")
+    response.stubs(:body => RETS_REPLY)
+
+    assert_equal response, @client.handle_response(response)
+  end
+
+  def test_handle_response_handles_empty_responses
+    response = Net::HTTPSuccess.new("", "", "")
+    response.stubs(:body => "")
+
+    assert_equal response, @client.handle_response(response)
+  end
+
+  def test_handle_response_handles_non_xml_responses
+    response = Net::HTTPSuccess.new("", "", "")
+    response.stubs(:body => "<notxml")
+
+    assert_equal response, @client.handle_response(response)
+  end
+
+  def test_handle_response_raises_on_unknown_response_code
+    response = Net::HTTPServerError.new("", "", "")
+
+    assert_raise Rets::UnknownResponse do
+      assert_equal response, @client.handle_response(response)
+    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"},
+      @client.extract_capabilities(Nokogiri.parse(CAPABILITIES))
+    )
+  end
+
+  def test_capability_url_returns_parsed_url
+    @client.capabilities = { "foo" => "http://example.com" }
+
+    assert_equal URI.parse("http://example.com"), @client.capability_url("foo")
+  end
+
+  def test_capability_url_raises_on_malformed_url
+    @client.capabilities = { "foo" => "http://e$^&#$&xample.com" }
+
+    assert_raise Rets::MalformedResponse do
+      @client.capability_url("foo")
+    end
+  end
+
+  def test_capabilities_calls_login_when_nil
+    @client.expects(:login)
+    @client.capabilities
+  end
+
+
+  def test_cookies?
+    assert @client.cookies?({"set-cookie" => "FavoriteFruit=Plum;"})
+    assert !@client.cookies?({})
+  end
+
+  def test_cookies=
+    @client.cookies = ["abc=123; path=/; HttpOnly", "def=456;", "ghi=789"]
+
+    assert_equal(
+      {"abc" => "123", "def" => "456", "ghi" => "789"},
+      @client.instance_variable_get("@cookies")
+    )
+
+    @client.cookies = ["abc=111; blah", "zzz=123"]
+
+    assert_equal(
+      {"abc" => "111", "def" => "456", "ghi" => "789", "zzz" => "123"},
+      @client.instance_variable_get("@cookies")
+    )
+  end
+
+  def test_cookies
+    # Set an array instead of hash for predictable iteration and string construction
+    @client.instance_variable_set("@cookies", [%w(abc 123), %w(def 456)])
+
+    assert_equal "abc=123; def=456", @client.cookies
+  end
+
+
+  def test_build_headers_provides_basic_headers
+    assert_equal({
+      "User-Agent"    => "Client/1.0",
+      "Host"          => "example.com:80",
+      "RETS-Version"  => "RETS/1.7.2"},
+      @client.build_headers)
+  end
+
+  def test_build_headers_provides_authorization
+    @client.authorization = "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)
+  end
+
+  def test_build_headers_provides_cookies
+    @client.cookies = ["Allowed=totally"]
+
+    assert_equal({
+      "Cookie"        => "Allowed=totally",
+      "User-Agent"    => "Client/1.0",
+      "Host"          => "example.com:80",
+      "RETS-Version"  => "RETS/1.7.2"},
+      @client.build_headers)
+  end
+
+
+  def test_tries_increments_with_each_call
+    assert_equal 1, @client.tries
+    assert_equal 2, @client.tries
+  end
+
+  def test_build_auth
+    www_authenticate =
+      %q(Digest realm="EXAMPLE", nonce="aec306b318feef4c360bc986e06d0a71", opaque="4211001cd29d5a65b3ed99f766a896b0", qop="auth")
+
+    uri = URI.parse("http://bob:secret@example.com/login")
+
+    Digest::MD5.stubs(:hexdigest => "heeheehee")
+
+    expected = <<-DIGEST.gsub(/\n/, "")
+Digest username="bob", realm="EXAMPLE", qop="auth", uri="/login", nonce="aec306b318feef4c360bc986e06d0a71", 
+nc=00000000, cnonce="heeheehee", response="heeheehee", opaque="4211001cd29d5a65b3ed99f766a896b0"
+DIGEST
+
+    assert_equal expected, @client.build_auth(www_authenticate, uri)
+  end
+
+  def test_calculate_digest_with_qop
+    Digest::MD5.expects(:hexdigest).with("bob:example:secret").returns("a1")
+    Digest::MD5.expects(:hexdigest).with("POST:/login").returns("a2")
+
+    Digest::MD5.expects(:hexdigest).with("a1:nonce:00000001:cnonce:qop:a2")
+
+    @client.calculate_digest("bob", "secret", "example", "nonce", "POST", URI.parse("/login"), "qop", "cnonce", 1)
+  end
+
+  def test_calculate_digest_without_qop
+    Digest::MD5.expects(:hexdigest).with("bob:example:secret").returns("a1")
+    Digest::MD5.expects(:hexdigest).with("POST:/login").returns("a2")
+
+    Digest::MD5.expects(:hexdigest).with("a1:nonce:a2").returns("hash")
+
+    assert_equal "hash",
+      @client.calculate_digest("bob", "secret", "example", "nonce", "POST", URI.parse("/login"), nil, "cnonce", 1)
+  end
+
+  def test_calculate_user_agent_digest
+    Digest::MD5.expects(:hexdigest).with("agent:secret").returns("a1")
+    Digest::MD5.expects(:hexdigest).with("a1::session:version").returns("hash")
+
+    assert_equal "hash",
+      @client.calculate_user_agent_digest("agent", "secret", "session", "version")
+  end
+
+
+  def test_session_restores_state
+    session = Rets::Session.new("Digest auth", {"Foo" => "/foo"}, "sessionid=123")
+
+    @client.session = session
+
+    assert_equal("Digest auth",     @client.authorization)
+    assert_equal({"Foo" => "/foo"}, @client.capabilities)
+    assert_equal("sessionid=123",   @client.cookies)
+  end
+
+  def test_session_dumps_state
+    @client.authorization = "Digest auth"
+    @client.capabilities  = {"Foo" => "/foo"}
+    @client.cookies       = "session-id=123"
+
+    session = @client.session
+
+    assert_equal("Digest auth",     session.authorization)
+    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")
+
+    client = Rets::Client.new(:login_url => "http://example.com", :session => session)
+
+    assert_equal("Digest auth",     client.authorization)
+    assert_equal({"Foo" => "/foo"}, client.capabilities)
+    assert_equal("sessionid=123",   client.cookies)
+  end
+
+  def test_metadata_when_not_initialized_with_metadata
+    client = Rets::Client.new(:login_url => "http://example.com")
+    Rets::Metadata::Root.expects(:new)
+    client.metadata
+  end
+
+  def test_initialize_with_old_metadata_cached_gets_new_metadata
+    metadata = stub(:current? => false)
+    new_metadata = stub(:current? => false)
+    client = Rets::Client.new(:login_url => "http://example.com", :metadata => metadata)
+    client.stubs(:capabilities => {})
+    Rets::Metadata::Root.expects(:new => new_metadata).once
+
+    assert_same new_metadata, client.metadata
+    # This second call ensures the expectations on Root are met
+    client.metadata
+  end
+
+  def test_initialize_with_current_metadata_cached_return_cached_metadata
+    metadata = stub(:current? => true)
+    client = Rets::Client.new(:login_url => "http://example.com", :metadata => metadata)
+    client.stubs(:capabilities => {})
+
+    assert_same metadata, client.metadata
+  end
+
+  def test_initialize_takes_logger
+    logger = Object.new
+
+    client = Rets::Client.new(:login_url => "http://example.com", :logger => logger)
+
+    assert_equal logger, client.logger
+  end
+
+  def test_default_logger_returns_api_compatible_silent_logger
+    logger = @client.logger
+
+    assert_nothing_raised do
+      logger.fatal "foo"
+      logger.error "foo"
+      logger.warn  "foo"
+      logger.info  "foo"
+      logger.debug "foo"
+    end
+  end
+
+
+  def test_find_first_calls_find_every_with_limit_one
+    @client.expects(:find_every).with(:limit => 1, :foo => :bar).returns([1,2,3])
+
+    assert_equal 1, @client.find(:first, :foo => :bar, :limit => 5), "User-specified limit should be ignored"
+  end
+
+  def test_find_all_calls_find_every
+    @client.expects(:find_every).with(:limit => 5, :foo => :bar).returns([1,2,3])
+
+    assert_equal [1,2,3], @client.find(:all, :limit => 5, :foo => :bar)
+  end
+
+  def test_find_raises_on_unknown_quantity
+    assert_raise ArgumentError do
+      @client.find(:incorrect, :foo => :bar)
+    end
+  end
+
+  def test_find_provides_default_values
+    @client.expects(:build_key_values).
+      with("QueryType" => "DMQL2", "Format" => "COMPACT", "Query" => "x", "Foo" => "bar").
+      returns("xxx")
+
+    @client.stubs(:capability_url => URI.parse("/example"))
+    @client.stubs(:request_with_compact_response)
+
+    @client.find(:all, :query => "x", :foo => "bar")
+  end
+
+  def test_find_allows_defaults_to_be_overridden
+    @client.expects(:build_key_values).
+      with("QueryType" => "DMQL3000", "Format" => "COMPACT", "Query" => "x", "Foo" => "bar").
+      returns("xxx")
+
+    @client.stubs(:capability_url => URI.parse("/example"))
+    @client.stubs(:request_with_compact_response)
+
+    @client.find(:all, :query => "x", :foo => "bar", :query_type => "DMQL3000")
+  end
+
+  def test_find_returns_undecorated_results
+    @client.stubs(:capability_url => URI.parse("/example"))
+
+    @client.expects(:request_with_compact_response).
+      with("/example", instance_of(String), instance_of(Hash)).
+      returns([["foo", "bar"]])
+
+    results = @client.find(:all, :search_type => "Property", :class => "Res", :query => "x", :foo => "bar")
+
+    assert_equal [["foo", "bar"]], results
+  end
+
+  def test_find_returns_decorated_results
+    @client.stubs(:capability_url => URI.parse("/example"))
+
+    @client.expects(:request_with_compact_response).
+      with("/example", instance_of(String), instance_of(Hash)).
+      returns([["foo", "bar"]])
+
+    fake_rets_class = stub(:rets_class)
+    fake_result = stub(:result)
+
+    @client.expects(:find_rets_class).with("Property", "Res").returns(fake_rets_class)
+    @client.expects(:decorate_results).with([["foo", "bar"]], fake_rets_class).returns(fake_result)
+
+    results = @client.find(:all, :search_type => "Property", :class => "Res", :query => "x", :foo => "bar", :resolve => true)
+
+    assert_equal fake_result, results
+  end
+
+  def test_fixup_keys
+    assert_equal({ "Foo" => "bar" },    @client.fixup_keys(:foo => "bar"))
+    assert_equal({ "FooFoo" => "bar" }, @client.fixup_keys(:foo_foo => "bar"))
+  end
+
+  def test_all_objects_calls_objects
+    @client.expects(:objects).with("*", :foo => :bar)
+
+    @client.all_objects(:foo => :bar)
+  end
+
+  def test_objects_handles_string_argument
+    @client.expects(:fetch_object).with("*", :foo => :bar)
+    @client.stubs(:create_parts_from_response)
+
+    @client.objects("*", :foo => :bar)
+  end
+
+  def test_objects_handle_array_argument
+    @client.expects(:fetch_object).with("1,2", :foo => :bar)
+    @client.stubs(:create_parts_from_response)
+
+    @client.objects([1,2], :foo => :bar)
+  end
+
+  def test_objects_raises_on_other_arguments
+    assert_raise ArgumentError do
+      @client.objects(Object.new, :foo => :bar)
+    end
+  end
+
+  def test_create_parts_from_response_returns_multiple_parts_when_multipart_response
+    response = {"content-type" => 'multipart; boundary="simple boundary"'}
+    response.stubs(:body => MULITPART_RESPONSE)
+
+    Rets::Parser::Multipart.expects(:parse).
+      with(MULITPART_RESPONSE, "simple boundary").
+      returns([])
+
+    @client.create_parts_from_response(response)
+  end
+
+  def test_create_parts_from_response_returns_a_single_part_when_not_multipart_response
+    response = {"content-type" => "text/plain"}
+    response.stubs(:body => "fakebody")
+
+    parts = @client.create_parts_from_response(response)
+
+    assert_equal 1, parts.size
+
+    part = parts.first
+
+    assert_equal response,   part.headers
+    assert_equal "fakebody", part.body
+  end
+
+  def test_object_calls_fetch_object
+    response = stub(:body => "foo")
+
+    @client.expects(:fetch_object).with("1", :foo => :bar).returns(response)
+
+    assert_equal "foo", @client.object("1", :foo => :bar)
+  end
+
+  def test_fetch_object
+    @client.expects(:capability_url).with("GetObject").returns(URI.parse("/obj"))
+
+    @client.expects(:build_key_values => "fakebody").with(
+      "Resource" => "Property",
+      "Type"     => "Image",
+      "ID"       => "123:*",
+      "Location" => 0
+    )
+
+    @client.expects(:request).with("/obj", "fakebody",
+      has_entries(
+        "Accept"         => "image/jpeg, image/png;q=0.5, image/gif;q=0.1",
+        "Content-Type"   => "application/x-www-form-urlencoded",
+        "Content-Length" => "8")
+      )
+
+    @client.fetch_object("*", :resource => "Property", :object_type => "Image", :resource_id => "123")
+  end
+
+  def test_metadata_caches
+    metadata = stub(:current? => true)
+    @client.metadata = metadata
+    @client.stubs(:capabilities => {})
+
+    assert_same metadata, @client.metadata, "Should be memoized"
+  end
+
+  def test_retrieve_metadata_type
+    @client.expects(:capability_url).with("GetMetadata").returns(URI.parse("/meta"))
+
+    @client.expects(:build_key_values => "fakebody").with(
+      "Format" => "COMPACT",
+      "Type"   => "METADATA-FOO",
+      "ID"     => "0"
+    )
+
+    @client.expects(:request => stub(:body => "response")).with("/meta", "fakebody", has_entries(
+      "Content-Type"   => "application/x-www-form-urlencoded",
+      "Content-Length" => "8"
+    ))
+
+    assert_equal "response", @client.retrieve_metadata_type("FOO")
+  end
+
+end