sean-rets 0.6.0

data/lib/rets/metadata/table.rb

@@ -0,0 +1,113 @@
+module Rets
+  module Metadata
+    class TableFactory
+      def self.build(table_fragment, resource)
+        enum?(table_fragment) ? LookupTable.new(table_fragment, resource) : Table.new(table_fragment)
+      end
+
+      def self.enum?(table_fragment)
+        lookup_value   = table_fragment["LookupName"].strip
+        interpretation = table_fragment["Interpretation"].strip
+
+        interpretation =~ /Lookup/ && !lookup_value.empty?
+      end
+    end
+
+    class Table
+      attr_accessor :type
+      attr_accessor :name
+      attr_accessor :long_name
+      attr_accessor :table_fragment
+
+      def initialize(table_fragment)
+        self.table_fragment = table_fragment
+        self.type = table_fragment["DataType"]
+        self.name = table_fragment["SystemName"]
+        self.long_name = table_fragment["LongName"]
+      end
+
+      def print_tree
+        puts "    Table: #{name}"
+        puts "      ShortName: #{ table_fragment["ShortName"] }"
+        puts "      LongName: #{ table_fragment["LongName"] }"
+        puts "      StandardName: #{ table_fragment["StandardName"] }"
+        puts "      Units: #{ table_fragment["Units"] }"
+        puts "      Searchable: #{ table_fragment["Searchable"] }"
+        puts "      Required: #{table_fragment['Required']}"
+      end
+
+      def resolve(value)
+        value.to_s.strip
+      end
+    end
+
+    class LookupTable
+      attr_accessor :resource
+      attr_accessor :lookup_name
+      attr_accessor :name
+      attr_accessor :interpretation
+      attr_accessor :long_name
+      attr_accessor :table_fragment
+
+      def initialize(table_fragment, resource)
+        self.table_fragment = table_fragment
+        self.resource = resource
+        self.name = table_fragment["SystemName"]
+        self.interpretation = table_fragment["Interpretation"]
+        self.lookup_name = table_fragment["LookupName"]
+        self.long_name = table_fragment["LongName"]
+      end
+
+      def multi?
+        interpretation == "LookupMulti"
+      end
+
+      def lookup_types
+        resource.lookup_types[lookup_name]
+      end
+
+      def print_tree
+        puts "    LookupTable: #{name}"
+        puts "      Required: #{table_fragment['Required']}"
+        puts "      Searchable: #{ table_fragment["Searchable"] }"
+        puts "      Units: #{ table_fragment["Units"] }"
+        puts "      ShortName: #{ table_fragment["ShortName"] }"
+        puts "      LongName: #{ table_fragment["LongName"] }"
+        puts "      StandardName: #{ table_fragment["StandardName"] }"
+        puts "      Types:"
+
+        lookup_types.each(&:print_tree)
+      end
+
+      def lookup_type(value)
+        lookup_types.detect {|lt| lt.value == value }
+      end
+
+      def resolve(value)
+        if value.empty?
+          return [] if multi?
+          return value.to_s.strip
+        end
+
+        values = multi? ? value.split(","): [value]
+
+        values = values.map do |v|
+
+          #Remove surrounding quotes
+          clean_value  = v.scan(/^["']?(.*?)["']?$/).join
+
+
+          lookup_type = lookup_type(clean_value)
+
+          resolved_value = lookup_type ? lookup_type.long_value : nil
+
+          warn("Discarding unmappable value of #{clean_value.inspect}") if resolved_value.nil? && $VERBOSE
+
+          resolved_value
+        end
+
+        multi? ? values.map {|v| v.to_s.strip } : values.first.to_s.strip
+      end
+    end
+  end
+end

data/lib/rets/parser/compact.rb

@@ -0,0 +1,62 @@
+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
+
+        column_node = doc.at("//COLUMNS")
+        if column_node.nil?
+          columns = ''
+        else
+          columns = column_node.text
+        end
+        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
+
+      def self.get_count(xml)
+        doc = Nokogiri.parse(xml.to_s)
+        if node = doc.at("//COUNT")
+          return node.attr('Records').to_i
+        elsif node = doc.at("//RETS-STATUS")
+          # Handle <RETS-STATUS ReplyCode="20201" ReplyText="No matching records were found" />
+          return 0 if node.attr('ReplyCode') == '20201'
+        end
+      end
+
+    end
+  end
+end

data/lib/rets/parser/multipart.rb

@@ -0,0 +1,40 @@
+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}/
+
+        # WTF some RETS servers declare response body including jpeg binary is encoded in utf8
+        raw.force_encoding 'ascii-8bit' if raw.respond_to?(:force_encoding)
+
+        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| p = kv.split(/:\s?/); [p[0].downcase, p[1..-1].join(':')] }
+            headers = Hash[*headers.flatten]
+            parts << Part.new(headers, body_part)
+          else
+            next # not a valid chunk.
+          end
+        end
+        check_for_invalids_parts!(parts)
+        parts
+      end
+
+      def self.check_for_invalids_parts!(parts)
+        return unless parts.length == 1 && parts.first.headers['content-type'] == 'text/xml'
+        Client::ErrorChecker.check(parts.first)
+      end
+    end
+  end
+end

data/test/fixtures.rb

@@ -0,0 +1,212 @@
+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
+
+COUNT_ONLY = <<XML
+<RETS ReplyCode="0" ReplyText="Success">
+<COUNT Records="1234" />
+</RETS>
+XML
+
+RETS_STATUS_NO_MATCHING_RECORDS = <<XML
+<?xml version="1.0"?>
+<RETS ReplyCode="0" ReplyText="Operation Successful">
+<RETS-STATUS ReplyCode="20201" ReplyText="No matching records were found" />
+</RETS>
+XML
+
+CAPABILITIES_WITH_WHITESPACE = <<XML
+<RETS ReplyCode="0" ReplyText="Operation Successful">
+<RETS-RESPONSE>
+Action = /RETS/Action
+</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
+
+
+EMPTY_COMPACT = <<-XML
+<METADATA-TABLE Resource="OpenHouse" Class="OpenHouse" Version="01.01.00000" Date="2011-07-29T12:09:16">
+</METADATA-TABLE>
+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")
+
+MULTIPART_RESPONSE_URLS = [
+  '--rets.object.content.boundary.1330546052739',
+  'Content-ID: 38845440',
+  'Object-ID: 1',
+  'Content-Type: text/xml',
+  'Location: http://foobarmls.com/RETS//MediaDisplay/98/hr2890998-1.jpg',
+  '',
+  '<RETS ReplyCode="0" ReplyText="Operation Successful" />',
+  '',
+  '--rets.object.content.boundary.1330546052739',
+  'Content-ID: 38845440',
+  'Object-ID: 2',
+  'Content-Type: text/xml',
+  'Location: http://foobarmls.com/RETS//MediaDisplay/98/hr2890998-2.jpg',
+  '',
+  '<RETS ReplyCode="0" ReplyText="Operation Successful" />',
+  '',
+  '--rets.object.content.boundary.1330546052739',
+  'Content-ID: 38845440',
+  'Object-ID: 3',
+  'Content-Type: text/xml',
+  'Location: http://foobarmls.com/RETS//MediaDisplay/98/hr2890998-3.jpg',
+  '',
+  '<RETS ReplyCode="0" ReplyText="Operation Successful" />',
+  '',
+  '--rets.object.content.boundary.1330546052739',
+  'Content-ID: 38845440',
+  'Object-ID: 4',
+  'Content-Type: text/xml',
+  'Location: http://foobarmls.com/RETS//MediaDisplay/98/hr2890998-4.jpg',
+  '',
+  '<RETS ReplyCode="0" ReplyText="Operation Successful" />',
+  '',
+  '--rets.object.content.boundary.1330546052739',
+  'Content-ID: 38845440',
+  'Object-ID: 5',
+  'Content-Type: text/xml',
+  'Location: http://foobarmls.com/RETS//MediaDisplay/98/hr2890998-5.jpg',
+  '',
+  '<RETS ReplyCode="0" ReplyText="Operation Successful" />',
+  '',
+  '--rets.object.content.boundary.1330546052739--'
+].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,14 @@
+require "minitest"
+require "mocha/setup"
+
+require_relative "../lib/rets"
+
+require_relative "fixtures"
+
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/vcr_cassettes'
+  c.hook_into :webmock
+end
+

data/test/test_client.rb

@@ -0,0 +1,238 @@
+require_relative "helper"
+
+class TestClient < MiniTest::Test
+
+  def setup
+    @client = Rets::Client.new(:login_url => "http://example.com/login")
+  end
+
+  def test_extract_capabilities
+    assert_equal(
+      {"abc" => "123", "def" => "ghi=jk"},
+      @client.extract_capabilities(Nokogiri.parse(CAPABILITIES))
+    )
+  end
+
+  def test_extract_capabilities_with_whitespace
+    assert_equal(
+      {"action" => "/RETS/Action"},
+      @client.extract_capabilities(Nokogiri.parse(CAPABILITIES_WITH_WHITESPACE))
+    )
+  end
+
+  def test_capability_url_returns_parsed_url
+    @client.capabilities = { "foo" => "/foo" }
+
+    assert_equal "http://example.com/foo", @client.capability_url("foo")
+  end
+
+  def test_capabilities_calls_login_when_nil
+    @client.expects(:login)
+    @client.capabilities
+  end
+
+  def test_tries_increments_with_each_call
+    assert_equal 1, @client.tries
+    assert_equal 2, @client.tries
+  end
+
+  def test_metadata_when_not_initialized_with_metadata
+    new_raw_metadata = stub(:new_raw_metadata)
+
+    client = Rets::Client.new(:login_url => "http://example.com")
+    client.stubs(:retrieve_metadata).returns(new_raw_metadata)
+
+    assert_same new_raw_metadata, client.metadata.marshal_dump
+  end
+
+  def test_initialize_with_old_metadata_cached_contstructs_new_metadata_from_request
+    metadata = stub(:current? => false)
+    new_raw_metadata = stub(:new_raw_metadata)
+
+    client = Rets::Client.new(:login_url => "http://example.com", :metadata => metadata)
+    client.stubs(:capabilities).returns({})
+    client.stubs(:retrieve_metadata).returns(new_raw_metadata)
+
+    assert_same new_raw_metadata, client.metadata.marshal_dump
+  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
+    logger.fatal "foo"
+    logger.error "foo"
+    logger.warn  "foo"
+    logger.info  "foo"
+    logger.debug "foo"
+  end
+
+
+  def test_find_first_calls_find_every_with_limit_one
+    @client.expects(:find_every).with({:limit => 1, :foo => :bar}, nil).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}, nil).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_raises ArgumentError do
+      @client.find(:incorrect, :foo => :bar)
+    end
+  end
+
+  def test_find_retries_on_errors
+    @client.stubs(:find_every).raises(Rets::AuthorizationFailure.new(401, 'Not Authorized')).then.raises(Rets::InvalidRequest.new(20134, 'Not Found')).then.returns([])
+    @client.find(:all, :foo => :bar)
+  end
+
+  def test_find_retries_on_errors_preserves_resolve
+    @client.stubs(:find_every).raises(Rets::AuthorizationFailure.new(401, 'Not Authorized')).then.raises(Rets::InvalidRequest.new(20134, 'Not Found')).then.with({:foo => :bar}, true).returns([])
+    @client.find(:all, {:foo => :bar, :resolve => true})
+  end
+
+  def test_find_eventually_reraises_errors
+    @client.stubs(:find_every).raises(Rets::AuthorizationFailure.new(401, 'Not Authorized'))
+    assert_raises Rets::AuthorizationFailure do
+      @client.find(:all, :foo => :bar)
+    end
+  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_raises ArgumentError do
+      @client.objects(Object.new, :foo => :bar)
+    end
+  end
+
+  def test_create_parts_from_response_returns_multiple_parts_when_multipart_response
+    response = {}
+    response.stubs(:header => { "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_parse_boundary_wo_quotes
+    response = {}
+    response.stubs(:header => { "content-type" => ['multipart; boundary=simple boundary; foo;']})
+    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 = {}
+    response.stubs(:header => { "content-type" => ['text/plain']})
+    response.stubs(:headers => { "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 "text/plain", part.headers["content-type"]
+    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_metadata_caches
+    metadata = stub(:current? => true)
+    @client.metadata = metadata
+    @client.stubs(:capabilities => {})
+
+    assert_same metadata, @client.metadata, "Should be memoized"
+  end
+
+  def test_decorate_result_handles_bad_metadata
+    result = {'foo' => 'bar'}
+    rets_class = stub
+    rets_class.expects(:find_table).with('foo').returns(nil)
+    response = @client.decorate_result(result, rets_class)
+    assert_equal response, result
+  end
+
+  def test_clean_setup_with_receive_timeout
+   HTTPClient.any_instance.expects(:receive_timeout=).with(1234)
+   @client = Rets::Client.new(
+       login_url: 'http://example.com/login',
+       receive_timeout: 1234
+   )
+  end
+
+  def test_clean_setup_with_proxy_auth
+    @login_url = 'http://example.com/login'
+    @proxy_url = 'http://example.com/proxy'
+    @proxy_username = 'username'
+    @proxy_password = 'password'
+    HTTPClient.any_instance.expects(:set_proxy_auth).with(@proxy_username, @proxy_password)
+
+    @client = Rets::Client.new(
+        login_url: @login_url,
+        http_proxy: @proxy_url,
+        proxy_username: @proxy_username,
+        proxy_password: @proxy_password
+    )
+  end
+
+end