rets 0.9.0 → 0.10.0

data/test/test_caching.rb

@@ -0,0 +1,89 @@
+require_relative "helper"
+
+require "stringio"
+
+class TestCaching < MiniTest::Test
+
+  class MemoryCache
+
+    def initialize
+      reset
+    end
+
+    def save(&block)
+      reset
+      yield @io
+    end
+
+    def load(&block)
+      @io.rewind
+      yield @io
+    end
+
+    private
+
+    def reset
+      @io = StringIO.new
+    end
+
+  end
+
+  def test_make_defaults
+    caching = Rets::Metadata::Caching.make({})
+    assert_instance_of Rets::Metadata::NullCache, caching.cache
+    assert_instance_of Rets::Metadata::MarshalSerializer, caching.serializer
+  end
+
+  def test_round_trip
+    logger = Logger.new("/dev/null")
+    sources = {"foo" => "bar"}
+    metadata = Rets::Metadata::Root.new(logger, sources)
+    caching = Rets::Metadata::Caching.make(metadata_cache: MemoryCache.new)
+    caching.save(metadata)
+    loaded_metadata = caching.load(logger)
+    assert_same logger, loaded_metadata.logger
+    assert_equal sources, loaded_metadata.sources
+  end
+
+  def test_load_when_serializer_fails
+    serializer = Class.new do
+      def load(file)
+        nil
+      end
+    end.new
+    logger = Logger.new("/dev/null")
+    caching = Rets::Metadata::Caching.make(
+      metadata_cache: MemoryCache.new,
+      metadata_serializer: serializer,
+    )
+    loaded_metadata = caching.load(logger)
+    assert_nil loaded_metadata
+  end
+
+  def test_load_when_serializer_returns_wrong_type
+    serializer = Class.new do
+      def load(file)
+        Object.new
+      end
+    end.new
+    logger = Logger.new("/dev/null")
+    caching = Rets::Metadata::Caching.make(
+      metadata_cache: MemoryCache.new,
+      metadata_serializer: serializer,
+    )
+    loaded_metadata = caching.load(logger)
+    assert_nil loaded_metadata
+  end
+
+  def test_load_when_cache_fails
+    logger = Logger.new("/dev/null")
+    cache = stub
+    cache.expects(:load).returns(nil)
+    caching = Rets::Metadata::Caching.make(
+      metadata_cache: cache,
+    )
+    loaded_metadata = caching.load(logger)
+    assert_nil loaded_metadata
+  end
+
+end

data/test/test_client.rb

@@ -21,9 +21,15 @@ class TestClient < MiniTest::Test
   end
 
   def test_capability_url_returns_parsed_url
-    @client.capabilities = { "foo" => "/foo" }
+    client = Rets::Client.new(:login_url => "http://example.com", :capabilities => { "foo" => "/foo" })
 
-    assert_equal "http://example.com/foo", @client.capability_url("foo")
+    assert_equal "http://example.com/foo", client.capability_url("foo")
+  end
+
+  def test_cached_capabilities_case_insensitive
+    client = Rets::Client.new(:login_url => "http://example.com", :capabilities => { "foo" => "/foo" })
+
+    assert_equal client.capabilities.default_proc, Rets::Client::CASE_INSENSITIVE_PROC
   end
 
   def test_capabilities_calls_login_when_nil
@@ -31,6 +37,16 @@ class TestClient < MiniTest::Test
     @client.capabilities
   end
 
+  def test_capabilities_does_not_call_login_after_login
+    response = mock
+    response.stubs(:body).returns(CAPABILITIES)
+    @client.stubs(:http_get).returns(response)
+    @client.login
+
+    @client.expects(:login).never
+    @client.capabilities
+  end
+
   def test_tries_increments_with_each_call
     assert_equal 1, @client.tries
     assert_equal 2, @client.tries
@@ -81,6 +97,18 @@ class TestClient < MiniTest::Test
     logger.debug "foo"
   end
 
+  def test_find_first_calls_find_every_with_limit_one
+    assert_raises ArgumentError do
+      @client.find_every({})
+    end
+    assert_raises ArgumentError do
+      @client.find_every(:search_type => "Foo")
+    end
+    assert_raises ArgumentError do
+      @client.find_every(:class => "Bar")
+    end
+  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])
 
@@ -108,7 +136,7 @@ class TestClient < MiniTest::Test
 
     Rets::Parser::Compact.expects(:parse_document).with("An ascii string")
 
-    @client.find_every({}, false)
+    @client.find_every(:search_type => "Foo", :class => "Bar")
   end
 
   def test_response_text_encoding_from_utf_8
@@ -120,7 +148,7 @@ class TestClient < MiniTest::Test
 
     Rets::Parser::Compact.expects(:parse_document).with("Some string with non-ascii characters \u0119")
 
-    @client.find_every({}, false)
+    @client.find_every(:search_type => "Foo", :class => "Bar")
   end
 
   def test_response_text_encoding_from_utf_16
@@ -132,7 +160,7 @@ class TestClient < MiniTest::Test
 
     Rets::Parser::Compact.expects(:parse_document).with("Some string with non-utf-8 characters \uFFFD")
 
-    @client.find_every({}, false)
+    @client.find_every(:search_type => "Foo", :class => "Bar")
   end
 
   def test_find_retries_when_receiving_no_records_found
@@ -155,24 +183,24 @@ class TestClient < MiniTest::Test
 
   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.stubs(:login)
     @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'))
+    @client.stubs(:login)
+
     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"))
+  def test_find_logs_in_after_auth_error
+    @client.stubs(:find_every).raises(Rets::AuthorizationFailure.new(401, 'Not Authorized')).then.returns(["foo"])
+
+    @client.expects(:login)
+    @client.find(:all, :foo => :bar)
   end
 
   def test_all_objects_calls_objects
@@ -189,10 +217,10 @@ class TestClient < MiniTest::Test
   end
 
   def test_objects_handle_array_argument
-    @client.expects(:fetch_object).with("1,2", :foo => :bar)
+    @client.expects(:fetch_object).with("1:2:3", :foo => :bar)
     @client.stubs(:create_parts_from_response)
 
-    @client.objects([1,2], :foo => :bar)
+    @client.objects([1,2,3], :foo => :bar)
   end
 
   def test_objects_raises_on_other_arguments
@@ -228,7 +256,7 @@ class TestClient < MiniTest::Test
   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(:headers => { "Content-Type" => 'text/plain'})
     response.stubs(:body => "fakebody")
 
     parts = @client.create_parts_from_response(response)
@@ -249,14 +277,6 @@ class TestClient < MiniTest::Test
     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

data/test/test_error_checker.rb

@@ -59,6 +59,16 @@ class TestErrorChecker < MiniTest::Test
     end
   end
 
+  Rets::Parser::ErrorChecker::INVALID_REQUEST_ERROR_MAPPING.each do |error_code, error_class|
+    define_method("test_#{error_class}_failure") do
+      response = mock
+      response.stubs(:body).returns(error_body_with_code(error_code))
+      assert_raises error_class do
+        Rets::Parser::ErrorChecker.check(response)
+      end
+    end
+  end
+
   def test_invalid_request_failure
     response = mock
     response.stubs(:body).returns(RETS_INVALID_REQUEST_ERROR)
@@ -66,4 +76,12 @@ class TestErrorChecker < MiniTest::Test
       Rets::Parser::ErrorChecker.check(response)
     end
   end
+
+  def error_body_with_code(code)
+    <<-XML
+<?xml version="1.0"?>
+<RETS ReplyCode="#{code}" ReplyText="Error message">
+</RETS>
+    XML
+  end
 end

data/test/test_file_cache.rb

@@ -0,0 +1,42 @@
+require_relative "helper"
+
+require "tempfile"
+
+class TestFileCache < MiniTest::Test
+
+  def with_tempfile(&block)
+    Tempfile.open(File.basename(__FILE__), &block)
+  end
+
+  def with_temp_path
+    with_tempfile do |file|
+      path = file.path
+      begin
+        file.close!
+        yield path
+      ensure
+        File.delete(path)
+      end
+    end
+  end
+
+  def test_save
+    with_temp_path do |path|
+      cache = Rets::Metadata::FileCache.new(path)
+      cache.save { |file| file.print "foo" }
+      file_contents = File.read(path)
+      assert_equal "foo", file_contents
+    end
+  end
+
+  def test_load
+    with_tempfile do |file|
+      file.print "foo"
+      file.close
+      cache = Rets::Metadata::FileCache.new(file.path)
+      file_contents = cache.load(&:read)
+      assert_equal "foo", file_contents
+    end
+  end
+
+end

data/test/test_http_client.rb

@@ -31,66 +31,102 @@ class TestHttpClient < MiniTest::Test
 
     assert_equal @http_client.http_post(url, {}), response
   end
+end
+
+class CookieManagement < MiniTest::Test
+  def setup
+    @logger = Rets::Client::FakeLogger.new
+    @logger.stubs(:debug?).returns(false)
+
+    @cm = WebAgent::CookieManager.new
+    http = HTTPClient.new
+    http.cookie_manager = @cm
+    @client = Rets::HttpClient.new(http, {}, nil, "http://rets.rets.com/somestate/login.aspx")
+  end
+
+  def teardown
+    # Empty cookie jar
+    @cm.cookies = []
+  end
+
+  def test_http_cookie_with_one_cookie_from_one_domain
+    set_cookie = "RETS-Session-ID=879392834723043209; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
+    @cm.parse(set_cookie, URI.parse("http://www.rets.rets.com"))
+    assert_equal "879392834723043209", @client.http_cookie('RETS-Session-ID')
+  end
+
+  def test_http_cookie_with_multiple_cookies_from_one_domain
+    # NOTE: Cookies are ordered alphabetically by name when retrieving
+    set_cookie_1 = "RETS-Session-ID=879392834723043209; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
+    @cm.parse(set_cookie_1, URI.parse("http://www.rets.rets.com"))
+
+    set_cookie_2 = "Zoo=Bar; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
+    @cm.parse(set_cookie_2, URI.parse("http://www.rets.rets.com"))
+
+    set_cookie_3 = "Foo=Bar; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
+    @cm.parse(set_cookie_3, URI.parse("http://www.rets.rets.com"))
+
+    assert_equal "879392834723043209", @client.http_cookie('RETS-Session-ID')
+  end
+
+  def test_http_cookie_with_no_cookies_from_domain
+    assert_equal nil, @client.http_cookie('RETS-Session-ID')
+  end
+
+  def test_save_cookie_store
+    cookie_file = Tempfile.new('cookie_file').path
+
+    #setup cookie store
+    client_a = Rets::HttpClient.from_options({ cookie_store: cookie_file, login_url: "http://rets.rets.com/somestate/login.aspx" }, @logger)
+
+    #add cookie
+    cookie = "RETS-Session-ID=879392834723043209; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
+    client_a.http.cookie_manager.parse(cookie, URI.parse("http://www.rets.rets.com"))
+
+    #save cookie
+    client_a.save_cookie_store
+
+    #create new HTTPCLient with same cookie store
+    client_b = Rets::HttpClient.from_options({ cookie_store: cookie_file, login_url: "http://rets.rets.com/somestate/login.aspx" }, @logger)
+
+    #check added cookie exists
+    assert_equal "879392834723043209", client_b.http_cookie('RETS-Session-ID')
+  end
+
+  def test_creates_cookie_store_if_missing_during_initialization
+    cookie_file = Tempfile.new('cookie_file')
+    cookie_file_path = cookie_file.path
+
+    #remove cookie store
+    cookie_file.unlink
+
+    client = Rets::HttpClient.from_options({cookie_store: cookie_file_path}, @logger)
+
+    #add cookie
+    cookie = "RETS-Session-ID=879392834723043209; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
+    client.http.cookie_manager.parse(cookie, URI.parse("http://www.rets.rets.com"))
+
+    #check added cookie exists
+    assert_equal "879392834723043209", client.http_cookie('RETS-Session-ID')
+  end
+
+  def test_creates_cookie_store_if_missing_during_save
+    cookie_file = Tempfile.new('cookie_file')
+    cookie_file_path = cookie_file.path
+
+    client = Rets::HttpClient.from_options({cookie_store: cookie_file_path}, @logger)
+
+    #remove cookie store
+    cookie_file.unlink
+
+    #add cookie
+    cookie = "RETS-Session-ID=879392834723043209; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
+    client.http.cookie_manager.parse(cookie, URI.parse("http://www.rets.rets.com"))
+
+    #save cookie
+    client.save_cookie_store
 
-  class CookieManagement < MiniTest::Test
-    def setup
-      @cm = WebAgent::CookieManager.new
-      http = HTTPClient.new
-      http.cookie_manager = @cm
-      @client = Rets::HttpClient.new(http, {}, nil, "http://rets.rets.com/somestate/login.aspx")
-    end
-
-    def teardown
-      # Empty cookie jar
-      @cm.cookies = []
-    end
-
-    def test_http_cookie_with_one_cookie_from_one_domain
-      set_cookie = "RETS-Session-ID=879392834723043209; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
-      @cm.parse(set_cookie, URI.parse("http://www.rets.rets.com"))
-      assert_equal "879392834723043209", @client.http_cookie('RETS-Session-ID')
-    end
-
-    def test_http_cookie_with_multiple_cookies_from_one_domain
-      # NOTE: Cookies are ordered alphabetically by name when retrieving
-      set_cookie_1 = "RETS-Session-ID=879392834723043209; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
-      @cm.parse(set_cookie_1, URI.parse("http://www.rets.rets.com"))
-
-      set_cookie_2 = "Zoo=Bar; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
-      @cm.parse(set_cookie_2, URI.parse("http://www.rets.rets.com"))
-
-      set_cookie_3 = "Foo=Bar; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
-      @cm.parse(set_cookie_3, URI.parse("http://www.rets.rets.com"))
-
-      assert_equal "879392834723043209", @client.http_cookie('RETS-Session-ID')
-    end
-
-    def test_http_cookie_with_no_cookies_from_domain
-      assert_equal nil, @client.http_cookie('RETS-Session-ID')
-    end
-
-    def test_save_cookie_store
-      cookie_file = Tempfile.new('cookie_file').path
-
-      #setup cookie store
-      http_a = HTTPClient.new
-      http_a.set_cookie_store(cookie_file)
-      client_a = Rets::HttpClient.new(http_a, { cookie_store: cookie_file }, nil, "http://rets.rets.com/somestate/login.aspx")
-
-      #add cookie
-      cookie = "RETS-Session-ID=879392834723043209; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
-      http_a.cookie_manager.parse(cookie, URI.parse("http://www.rets.rets.com"))
-
-      #save cookie
-      client_a.save_cookie_store
-
-      #create new HTTPCLient with same cookie store
-      http_b = HTTPClient.new
-      http_b.set_cookie_store(cookie_file)
-      client_b = Rets::HttpClient.new(http_b, { cookie_store: cookie_file }, nil, "http://rets.rets.com/somestate/login.aspx")
-
-      #check added cookie exists
-      assert_equal "879392834723043209", client_b.http_cookie('RETS-Session-ID')
-    end
+    #check added cookie exists
+    assert_equal "879392834723043209", client.http_cookie('RETS-Session-ID')
   end
 end