jschairb-rets4r 1.1.18

data/test/test_client_links.rb

@@ -0,0 +1,39 @@
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "test"))
+require 'test_helper'
+require 'rets4r/client/links'
+
+class TestClientLinks < Test::Unit::TestCase
+  def setup
+    @links = RETS4R::Client::Links.from_login_url('http://example.com/login')
+    @links['Logout'] = URI.parse('http://example.com/logout')
+    @links['GetMetadata'] = URI.parse('http://example.com/metadata')
+    @links['GetObject'] = URI.parse('http://example.com/objects')
+    @links['Search'] = URI.parse('http://example.com/search')
+    @links['Action'] = URI.parse('http://example.com/action')
+  end
+  def test_should_build_from_login_url
+    assert_equal normalize_url('http://example.com/login'), @links['Login'].to_s
+  end
+  def test_should_access_login
+    assert_equal normalize_url('http://example.com/login'), @links.login.to_s
+  end
+  def test_should_access_logout
+    assert_equal normalize_url('http://example.com/logout'), @links.logout.to_s
+  end
+  def test_should_access_metadata
+    assert_equal normalize_url('http://example.com/metadata'), @links.metadata.to_s
+  end
+  def test_should_access_object
+    assert_equal normalize_url('http://example.com/objects'), @links.objects.to_s
+  end
+  def test_should_access_search
+    assert_equal normalize_url('http://example.com/search'), @links.search.to_s
+  end
+  def test_should_access_action
+    assert_equal normalize_url('http://example.com/action'), @links.action.to_s
+  end
+  def normalize_url(url)
+    URI.parse(url).to_s
+  end
+end

data/test/test_compact_nokogiri.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), "."))
+require 'test_helper'
+
+class CompactNokogiriTest < Test::Unit::TestCase
+  def test_should_do_stuff
+    file = File.expand_path(File.join('test', 'data', '1.5', 'search_compact.xml'))
+    listings = RETS4R::Client::CompactNokogiriParser.new(open(file)).to_a
+    assert_equal({"Third"=>"Datum3", "Second"=>"Datum2", "First"=>"Datum1"}, listings[0])
+    assert_equal({"Third"=>"Datum6", "Second"=>"Datum5", "First"=>"Datum4"}, listings[1])
+  end
+  def test_should_handle_big_data
+    file = File.expand_path(File.join('test', 'data', '1.5', 'bad_compact.xml'))
+    listings = RETS4R::Client::CompactNokogiriParser.new(open(file)).to_a
+    assert_equal 1, listings.length
+    assert_equal 79, listings.first.keys.length
+  end
+  def test_each_should_yield_between_results
+    file = File.expand_path(
+      File.join('test', 'data', '1.5', 'search_compact_big.xml'))
+    stat = File::Stat.new(file)
+    unless stat.size > stat.blksize
+      flunk "This test probably won't work on this machine.
+        It needs a test input file larger than the native block size."
+    end
+    stream = open(file)
+    positions = []
+    listings = RETS4R::Client::CompactNokogiriParser.new(stream).each do |row|
+      positions << stream.pos
+    end
+    assert positions.first < positions.last,
+      "data was yielded durring the reading of the stream"
+  end
+  def test_should_not_include_column_elements_in_keys
+    response = "<RETS ReplyCode=\"0\" ReplyText=\"Operation Successful\">\r\n<DELIMITER value=\"09\" />\r\n<COLUMNS>\tDISPLAYORDER\tINPUTDATE\tMEDIADESCR\tMEDIANAME\tMEDIASOURCE\tMEDIATYPE\tMODIFIED\tPICCOUNT\tPRIMARYPIC\tTABLEUID\tUID\t</COLUMNS>\r\n<DATA>\t7\t2009-09-17 07:08:19 \t\tNew 023.jpg\t3155895-11.jpg\tpic\t2009-09-17 07:09:32 \t11\tn\t3155895\t9601458\t</DATA>\r\n<MAXROWS />\r\n</RETS>\r\n"
+
+    assert RETS4R::Client::CompactNokogiriParser.new(StringIO.new(response)).map.first.keys.grep( /COLUMN/ ).empty?
+  end
+  context 'non-zero reply code' do
+    setup do
+      @response = <<-BODY
+<?xml version="1.0"?>
+<RETS ReplyCode="20203" ReplyText="User does not have access to Class named RES. Reference ID: 3fe82558-8015-4d9d-ab0c-776d9e4b5943" />
+      BODY
+      @parser = RETS4R::Client::CompactNokogiriParser.new(StringIO.new(@response))
+    end
+    should "raise the execption" do
+      assert_raise RETS4R::Client::MiscellaneousSearchErrorException do
+        @parser.to_a
+      end
+    end
+    context 'when i parse' do
+      should "contain the reply text in the exception message" do
+        message = ''
+        begin
+          @parser.to_a
+        rescue Exception => e
+          message = e.message
+        end
+        assert_equal "User does not have access to Class named RES. Reference ID: 3fe82558-8015-4d9d-ab0c-776d9e4b5943", message
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'test/unit'
+require 'rets4r'
+require 'mocha'
+require 'shoulda'
+require 'rubygems'
+
+# Configure ListingService
+listing_service_config_file = File.expand_path(File.join('test', 'data', 'listing_service.yml'))
+RETS4R::ListingService.configurations = YAML.load_file(listing_service_config_file)
+RETS4R::ListingService.env = 'test'

data/test/test_listing_mapper.rb

@@ -0,0 +1,112 @@
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__)))
+require 'test_helper'
+
+class ListingMapperTest < Test::Unit::TestCase
+  context "ListingMapper" do
+    should "access select" do
+      config = RETS4R::ListingService.connection
+      mapper = RETS4R::ListingMapper.new(config)
+      assert_equal config[:select], mapper.select
+    end
+    should "map from rets keys to record keys" do
+      original = {
+        "ListingID"=>"11322886",
+        "AgentID"=>"000533246",
+        "Status"=>"act",
+        "ListPrice"=>"239000",
+        "StreetNumber"=>"8317",
+        "StreetName"=>"Thompson",
+        "StreetDirection"=>"",
+        "Unit"=>"",
+        "ZipCode"=>"79606-6652",
+        "City"=>"Abilene",
+        "County"=>"Taylor",
+        "State"=>"TX",
+        "LotSize"=>"LTS.5-.99A",
+        "SqFt"=>"2825",
+        "LivingArea"=>"2",
+        "Bedrooms"=>"4",
+        "Garage"=>"PARATTACHE,PAROPENER,PARREAR,PARSIDE",
+        "YearBuilt"=>"2005",
+        "AgentName"=>"CD Boyd, II",
+
+        "GARAGECAP"=>"2",
+        "BATHSFULLBASEMENT"=>"",
+        "BATHSFULLLEVEL1"=>"",
+        "BATHSFULLLEVEL2"=>"",
+        "BATHSFULLLEVEL3"=>"",
+        "STORIES"=>"2",
+        "INTERIOR"=>"INFBAY-WIN,INFCABLE-A,INFDECLTNG,INFHIGHSPD,INFLOFT,INFSOUND-W,INFVAUL-CL,INFWIND-CO",
+        "ACRESCULTIVATED"=>"",
+        "CARPORTCAP"=>"0",
+        "TAXUNEXEMPT"=>"5876",
+        "STREETDIRSUFFIX"=>"",
+        "NUMSTOCKTANKS"=>"",
+        "LOTDIM"=>"87X182",
+        "ACRESPRICE"=>"662049",
+        "FIREPLACES"=>"1",
+        "SUBDIVISION"=>"Belle Vista Estates",
+        "UTILITIES"=>"STUASPHALT,UTLCITY-SE,UTLCITY-WA,STUCONCRET",
+        "LISTSTATUSFLAG"=>"",
+        "NUMDININGAREAS"=>"2",
+        "SQFTPRICE"=>"84.6",
+        "MAPPAGE"=>"9999",
+        "NUMBARNS"=>"",
+        "UIDPRP"=>"3211078",
+        "NUMRESIDENCE"=>"",
+        "LISTPRICELOW"=>"0",
+        "MAPBOOK"=>"OT",
+        "LOTNUM"=>"",
+        "OFFICELIST_OFFICENAM1"=>"McClure, REALTORS",
+        "ACRES"=>"0.361",
+        "AGENTSELL_FULLNAME"=>"",
+        "BATHSHALFLEVEL1"=>"",
+        "PROPSUBTYPE"=>"S",
+        "ROOMBEDBATHDESC"=>"BBFJET-TUB,BBFLIN-CLO,BBFSEP-SHO,BBFW+I-CLO",
+        "BATHSHALFLEVEL2"=>"",
+        "LISTPRICEORIG"=>"239000",
+        "BATHSHALFLEVEL3"=>"",
+        "UID"=>"3211078",
+        "OFFICELIST"=>"FMAB",
+        "BATHSHALFBASEMENT"=>"",
+        "STORIESBLDG"=>"",
+        "REMARKS"=>"Custom home built in 05'.  Growing neighborhood convienient to Wylie schools. Abundant living areas and and open space floor plan.Could be 5th BDRM, or upstair BDRM & Bath could be another living area.  Perfect office next to Master. Gourmet sized kitchen, granite countertops, barell ceilings, wonderful storage space!!!!",
+        "STREETNUMDISPLAY"=>"8317",
+        "PROPSUBTYPEDISPLAY"=>"RES-S",
+        "BATHSHALF"=>"0",
+        "STYLE"=>"STYRANCH",
+        "COMMONFEATURES"=>"",
+        "OFFICESELL_OFFICENAM2"=>"",
+        "BATHSFULL"=>"3",
+        "MAPCOORD"=>"none",
+        "SQFTSOURCE"=>"TAX",
+        "NUMLAKES"=>"",
+        "NUMWELLS"=>"",
+        "NUMPONDS"=>"",
+        "LOTDESC"=>"LTDSUBDIV"}
+      mapper = RETS4R::ListingMapper.new
+      actual = mapper.map(original)
+      expected = {
+        :mls => "11322886",
+        :agent_id =>"000533246",
+        :rets_updated_at => nil,
+        :status=>"act",
+        :list_price =>"239000",
+        :street_number =>"8317",
+        :street_direction => "",
+        :street_name=>"Thompson",
+        :unit_number =>"",
+        :zip_code =>"79606-6652",
+        :city => "Abilene",
+        :county =>"Taylor",
+        :square_feet =>"2825",
+        :living_area => "2",
+        :baths =>nil,
+        :beds => "4",
+        :garage => "PARATTACHE,PAROPENER,PARREAR,PARSIDE",
+        :year_built => "2005",
+      }
+      expected.merge(actual).keys.each{|k| assert_equal expected[k], actual[k], "mismatched on key #{k}"}
+    end
+  end
+end

data/test/test_loader.rb

@@ -0,0 +1,24 @@
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'rets4r'
+require 'test/unit'
+
+class LoaderTest < Test::Unit::TestCase
+  def test_should_pass_records_to_block
+    file = File.expand_path(File.join('test', 'data', '1.5', 'search_compact.xml'))
+
+    listings = []
+    RETS4R::Loader.load(open(file)) do |record|
+      listings << record
+    end
+
+    assert_equal 2, listings.length
+    assert_equal "Datum1", listings[0]['First']
+    assert_equal "Datum2", listings[0]['Second']
+    assert_equal "Datum3", listings[0]['Third']
+    assert_equal "Datum4", listings[1]['First']
+    assert_equal "Datum5", listings[1]['Second']
+    assert_equal "Datum6", listings[1]['Third']
+
+  end
+end

data/test/test_parser.rb

@@ -0,0 +1,96 @@
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'test/unit'
+require 'rets4r'
+
+module RETS4R
+    class Client
+        class TestParser < Test::Unit::TestCase
+            def setup
+                @parser = ResponseParser.new
+            end
+
+            DATA_DIR = 'test/data/1.5/'
+
+            def load_xml_from_file(file_name)
+                xml = ''
+
+                File.open(file_name) do |file|
+                    file.each do |line|
+                        xml << line
+                    end
+                end
+
+                xml
+            end
+
+            def parse_to_transaction(xml_file_name)
+                @parser.parse_key_value(load_xml_from_file(xml_file_name))
+            end
+
+            # Test Cases
+
+#           TODO: verify test_search_compact header, metadata
+            def test_search_compact
+                xml = load_xml_from_file("#{DATA_DIR}search_compact.xml")
+                transaction = @parser.parse_results(xml, 'COMPACT')
+
+                assert_equal true, transaction.success?, "transaction should be successful"
+                assert_equal '0', transaction.reply_code
+                assert_equal 'SUCCESS', transaction.reply_text
+                assert_equal [], transaction.header
+                # XXX: this used to say, why?
+#                assert_equal false, transaction.header.empty?
+
+                assert_equal nil, transaction.metadata
+
+                assert_equal ?\t, transaction.delimiter
+                assert_equal "\t", transaction.ascii_delimiter
+                assert_equal true, transaction.maxrows?
+
+                assert_equal 2, transaction.response.length, 'response length should be 2'
+                assert_equal "Datum1", transaction.response[0]['First']
+                assert_equal "Datum2", transaction.response[0]['Second']
+                assert_equal "Datum3", transaction.response[0]['Third']
+                assert_equal "Datum4", transaction.response[1]['First']
+                assert_equal "Datum5", transaction.response[1]['Second']
+                assert_equal "Datum6", transaction.response[1]['Third']
+
+                # Check for compatibility
+                assert_equal transaction.data, transaction.response
+
+                assert_equal nil, transaction.secondary_response
+            end
+
+            def test_unescaped_search_compact
+              assert_raise(REXML::ParseException) do
+                @parser.parse_key_value(load_xml_from_file("#{DATA_DIR}search_unescaped_compact.xml"))
+              end
+            end
+
+            def test_invalid_search_compact
+                assert_raise(REXML::ParseException) do
+                  @parser.parse_key_value(load_xml_from_file("#{DATA_DIR}search_unescaped_compact.xml"))
+                end
+            end
+
+            def test_login_results
+                transaction = parse_to_transaction("#{DATA_DIR}login.xml")
+
+                assert_equal(true, transaction.success?)
+                assert_equal('srealtor,1,11,11111', transaction.response['User'])
+                assert_equal('/rets/Login', transaction.response['Login'])
+            end
+
+            def test_error_results
+                xml = load_xml_from_file("#{DATA_DIR}error.xml")
+
+                exception = assert_raise(InvalidResourceException) do
+                  @parser.parse_object_response(xml)
+                end
+
+                assert_equal('20400 - Invalid Invalidness.', exception.message)
+            end
+        end
+    end
+end

data/test/test_quality.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby -w
+libdir = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "test/unit"
+
+class TestQuality < Test::Unit::TestCase
+  def test_can_still_be_built
+    Dir.chdir(root) do
+      `gem build rets4r.gemspec`
+      assert_equal 0, $?
+    end
+  end
+
+  def test_has_no_malformed_whitespace
+    error_messages = []
+    Dir.chdir(root) do
+      File.read("MANIFEST").split("\n").each do |filename|
+        next if filename =~ /data/
+        error_messages << check_for_tab_characters(filename)
+        error_messages << check_for_extra_spaces(filename)
+      end
+    end
+    assert_well_formed error_messages.compact
+  end
+
+  def assert_well_formed(actual)
+    assert actual.empty?, actual.join("\n")
+  end
+
+  def check_for_tab_characters(filename)
+    failing_lines = []
+    File.readlines(filename).each_with_index do |line,number|
+      failing_lines << number + 1 if line =~ /\t/
+    end
+
+    unless failing_lines.empty?
+      "#{filename} has tab characters on lines #{failing_lines.join(', ')}"
+    end
+  end
+
+  def check_for_extra_spaces(filename)
+    failing_lines = []
+    File.readlines(filename).each_with_index do |line,number|
+      next if line =~ /^\s+#.*\s+\n$/
+      failing_lines << number + 1 if line =~ /\s+\n$/
+    end
+
+    unless failing_lines.empty?
+      "#{filename} has spaces on the EOL on lines #{failing_lines.join(', ')}"
+    end
+  end
+
+  def root
+    File.expand_path("../..", __FILE__)
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification 
+name: jschairb-rets4r
+version: !ruby/object:Gem::Version 
+  hash: 55
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 18
+  version: 1.1.18
+platform: ruby
+authors: 
+- Scott Patterson
+- John Wulff
+- bgetting
+- Jacob Basham
+- Joseph Holsten
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-05 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: RETS4R is a native Ruby interface to the RETS (Real Estate Transaction Standard). It currently is built for the 1.5 specification, but support for 1.7 and 2.0 are planned. It does not currently implement all of the specification, but the most commonly used portions. Specifically, there is no support for Update transactions.
+email: 
+- scott.patterson@digitalaun.com
+- john@johnwulff.com
+- brian@terra-firma-design.com
+- jacob@paperpigeons.net
+- joseph@josephholsten.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- CONTRIBUTORS
+- LICENSE
+- MANIFEST
+- NEWS
+- README.rdoc
+- RUBYS
+- TODO
+files: 
+- .document
+- CHANGELOG
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- MANIFEST
+- NEWS
+- README.rdoc
+- RUBYS
+- Rakefile
+- TODO
+- examples/client_get_object.rb
+- examples/client_login.rb
+- examples/client_mapper.rb
+- examples/client_metadata.rb
+- examples/client_parser.rb
+- examples/client_search.rb
+- examples/settings.yml
+- lib/rets4r.rb
+- lib/rets4r/auth.rb
+- lib/rets4r/client.rb
+- lib/rets4r/client/data.rb
+- lib/rets4r/client/dataobject.rb
+- lib/rets4r/client/exceptions.rb
+- lib/rets4r/client/links.rb
+- lib/rets4r/client/metadata.rb
+- lib/rets4r/client/parsers/compact.rb
+- lib/rets4r/client/parsers/compact_nokogiri.rb
+- lib/rets4r/client/parsers/metadata.rb
+- lib/rets4r/client/parsers/response_parser.rb
+- lib/rets4r/client/requester.rb
+- lib/rets4r/client/transaction.rb
+- lib/rets4r/core_ext/array/extract_options.rb
+- lib/rets4r/core_ext/class/attribute_accessors.rb
+- lib/rets4r/core_ext/hash/keys.rb
+- lib/rets4r/core_ext/hash/slice.rb
+- lib/rets4r/listing_mapper.rb
+- lib/rets4r/listing_service.rb
+- lib/rets4r/loader.rb
+- lib/tasks/annotations.rake
+- lib/tasks/coverage.rake
+- rets4r.gemspec
+- spec/rets4r_compact_data_parser_spec.rb
+- test/data/1.5/bad_compact.xml
+- test/data/1.5/count_only_compact.xml
+- test/data/1.5/error.xml
+- test/data/1.5/invalid_compact.xml
+- test/data/1.5/login.xml
+- test/data/1.5/metadata.xml
+- test/data/1.5/search_compact.xml
+- test/data/1.5/search_compact_big.xml
+- test/data/1.5/search_unescaped_compact.xml
+- test/data/listing_service.yml
+- test/test_auth.rb
+- test/test_client.rb
+- test/test_client_links.rb
+- test/test_compact_nokogiri.rb
+- test/test_helper.rb
+- test/test_listing_mapper.rb
+- test/test_loader.rb
+- test/test_parser.rb
+- test/test_quality.rb
+has_rdoc: true
+homepage: http://rets4r.rubyforge.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --main
+- README.rdoc
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rets4r
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: RETS4R is a native Ruby interface to the RETS (Real Estate Transaction Standard)
+test_files: 
+- test/test_auth.rb
+- test/test_client.rb
+- test/test_client_links.rb
+- test/test_compact_nokogiri.rb
+- test/test_helper.rb
+- test/test_listing_mapper.rb
+- test/test_loader.rb
+- test/test_parser.rb
+- test/test_quality.rb