rets 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ed1e7653c004159b6f9042dc917f9c8a30be926
-  data.tar.gz: 4b2275a656b7240b5d94a4d0f9c0ad5a62a18eeb
+  metadata.gz: 4f011e9a58934f4b5152a5f01428b58275602342
+  data.tar.gz: 188cdccdacaeb7b8c64df570208f073bfb00d9fb
 SHA512:
-  metadata.gz: 3853c2929ab43105aba05ceebe185e4c3b86271bdc99b8ec42e9578921ee9d2740c98cfea2b31a13e22de6e3d5e4fa608f61399133593c43dae14f3c63ffc772
-  data.tar.gz: 7d177e112e61b54dc347811bdfa6a44aa2dd472ce45b061dbf180e636b4e5f2c4318e6d8ea08dc5c1013615118eefc4da401fa4b7bd3da629317d7022221f30b
+  metadata.gz: 9ce589fca7e82987db2bdf0eb3432e9482bf1344b9d79a69d56b00f29219dd1495680c903bab456e8759e319ec6952245bb3bb88d69cbd1dcf4124a3abf8957e
+  data.tar.gz: 80dbdc930daa3eedb1f9566b7decbb4b69964396f16300522d481c226b442ff71d5bbbcf4d0c8049ee6a3e0df88fd0f490e6b69d11041265ca9ec94d069de964

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-### 0.6.0 / 2013-10-30
+### 0.7.0 / 2015-01-16
+
+* feature: optionally treat No Records Found as not an error
+* fix: update httpclient version, patches SSL vulnerabilities
+* feature: work around bogus http status codes that don't agree with XML body
+
+### 0.6.0 / 2014-11-26
 
 * fix: fix spelling error that created misleading exceptions
 * feature: track stats for http requests sent

data/README.md

@@ -11,12 +11,20 @@ A pure-ruby library for fetching data from [RETS] servers.
 
 ## REQUIREMENTS:
 
-* [net-http-persistent]
+* [httpclient]
 * [nokogiri]
 
-[net-http-persistent]: http://seattlerb.rubyforge.org/net-http-persistent/
+[httpclient]: https://github.com/nahi/httpclient
 [nokogiri]: http://nokogiri.org
 
+## INSTALLATION:
+```
+gem install rets
+
+# or add it to your Gemfile if using Bundler then run bundle install
+gem 'rets'
+```
+
 ## EXAMPLE USAGE:
 
 We need work in this area! There are currently a few guideline examples in the `example` folder on connecting, fetching a property's data, and fetching a property's photos.

data/Rakefile

@@ -9,12 +9,12 @@ Hoe.plugin :gemspec
 Hoe.spec 'rets' do
   developer 'Estately, Inc. Open Source', 'opensource@estately.com'
 
-  extra_deps << [ "httpclient", "~> 2.3.0" ]
-  extra_deps << [ "nokogiri",            "~> 1.5.2" ]
+  extra_deps << [ "httpclient", "~> 2.4" ]
+  extra_deps << [ "nokogiri",   "~> 1.5" ]
 
-  extra_dev_deps << [ "mocha", "~> 0.11.0" ]
-  extra_dev_deps << [ "vcr", "~> 2.2.2" ]
-  extra_dev_deps << [ "webmock", "~> 1.8.0" ]
+  extra_dev_deps << [ "mocha", "~> 0.11" ]
+  extra_dev_deps << [ "vcr", "~> 2.2" ]
+  extra_dev_deps << [ "webmock", "~> 1.8" ]
 
   ### Use markdown for changelog and readme
   self.history_file = 'CHANGELOG.md'

data/lib/rets.rb

@@ -3,7 +3,7 @@ require 'digest/md5'
 require 'nokogiri'
 
 module Rets
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 
   MalformedResponse    = Class.new(ArgumentError)
   UnknownResponse      = Class.new(ArgumentError)
@@ -18,6 +18,16 @@ module Rets
     end
   end
 
+  class NoRecordsFound < ArgumentError
+    ERROR_CODE = 20201
+    attr_reader :reply_text
+
+    def initialize(reply_text)
+      @reply_text = reply_text
+      super("Got error code #{ERROR_CODE} (#{reply_text})")
+    end
+  end
+
   class InvalidRequest < ArgumentError
     attr_reader :error_code, :reply_text
     def initialize(error_code, reply_text)
@@ -28,10 +38,11 @@ module Rets
   end
 
   class UnknownCapability < ArgumentError
-    attr_reader :capability_name
-    def initialize(capability_name)
+    attr_reader :capability_name, :capabilities
+    def initialize(capability_name, capabilities=[])
       @capability_name = capability_name
-      super("unknown capability #{capability_name}")
+      @capabilities = capabilities
+      super("unknown capability #{capability_name}, available capabilities #{capabilities}")
     end
   end
 end

data/lib/rets/client.rb

@@ -56,14 +56,13 @@ module Rets
       end
     end
 
-    # Attempts to login by making an empty request to the URL
-    # provided in initialize. Returns the capabilities that the
-    # RETS server provides, per http://retsdoc.onconfluence.com/display/rets172/4.10+Capability+URL+List.
+    # Attempts to login by making an empty request to the URL provided in
+    # initialize. Returns the capabilities that the RETS server provides, per
+    # page 34 of http://www.realtor.org/retsorg.nsf/retsproto1.7d6.pdf#page=34
     def login
       res = http_get(login_url)
-      unless res.status_code == 200
-        raise UnknownResponse, "bad response to login, expected a 200, but got #{res.status_code}. Body was #{res.body}."
-      end
+      Client::ErrorChecker.check(res)
+
       self.capabilities = extract_capabilities(Nokogiri.parse(res.body))
       raise UnknownResponse, "Cannot read rets server capabilities." unless @capabilities
       @capabilities
@@ -112,18 +111,33 @@ module Rets
     def find_with_retries(opts = {})
       retries = 0
       resolve = opts.delete(:resolve)
+      find_with_given_retry(retries, resolve, opts)
+    end
+
+    def find_with_given_retry(retries, resolve, opts)
       begin
         find_every(opts, resolve)
-      rescue AuthorizationFailure, InvalidRequest => e
-        if retries < opts.fetch(:max_retries, 3)
-          retries += 1
-          @client_progress.find_with_retries_failed_a_retry(e, retries)
-          clean_setup
-          retry
+      rescue NoRecordsFound => e
+        if opts.fetch(:no_records_not_an_error, false)
+          @client_progress.no_records_found
+          opts[:count] == COUNT.only ? 0 : []
         else
-          @client_progress.find_with_retries_exceeded_retry_count(e)
-          raise e
+          handle_find_failure(retries, resolve, opts, e)
         end
+      rescue AuthorizationFailure, InvalidRequest => e
+        handle_find_failure(retries, resolve, opts, e)
+      end
+    end
+
+    def handle_find_failure(retries, resolve, opts, e)
+      if retries < opts.fetch(:max_retries, 3)
+        retries += 1
+        @client_progress.find_with_retries_failed_a_retry(e, retries)
+        clean_setup
+        find_with_given_retry(retries, resolve, opts)
+      else
+        @client_progress.find_with_retries_exceeded_retry_count(e)
+        raise e
       end
     end
 
@@ -291,7 +305,7 @@ module Rets
     def capability_url(name)
       val = capabilities[name] || capabilities[name.downcase]
 
-      raise UnknownCapability.new(name) unless val
+      raise UnknownCapability.new(name, capabilities.keys) unless val
 
       begin
         if val.downcase.match(/^https?:\/\//)
@@ -340,7 +354,7 @@ module Rets
 
     class FakeLogger < Logger
       def initialize
-        super("/dev/null")
+        super(IO::NULL)
       end
     end
 
@@ -367,7 +381,9 @@ module Rets
             reply_text = (rets_element.attr("ReplyText") || rets_element.attr("replyText")).value
             reply_code = (rets_element.attr("ReplyCode") || rets_element.attr("replyCode")).value.to_i
 
-            if reply_code.nonzero?
+            if reply_code == NoRecordsFound::ERROR_CODE
+              raise NoRecordsFound.new(reply_text)
+            elsif reply_code.nonzero?
               raise InvalidRequest.new(reply_code, reply_text)
             else
               return

data/lib/rets/client_progress_reporter.rb

@@ -28,6 +28,10 @@ module Rets
       @stats.count("#{@stats_prefix}find_with_retries_exceeded_retry_count")
     end
 
+    def no_records_found
+      @logger.info("Rets::Client: No Records Found")
+    end
+
     def could_not_resolve_find_metadata(key)
       @stats.count("#{@stats_prefix}could_not_resolve_find_metadata")
       @logger.warn "Rets::Client: Can't resolve find metadata for #{key.inspect}"

data/lib/rets/http_client.rb

@@ -14,7 +14,7 @@ module Rets
       http.set_auth(url, options[:username], options[:password])
       headers = extra_headers.merge(rets_extra_headers)
       res = nil
-      log_http_traffic("POST", url, params, headers) do
+      log_http_traffic("GET", url, params, headers) do
         res = http.get(url, params, headers)
       end
       Client::ErrorChecker.check(res)

data/lib/rets/metadata/table.rb

@@ -2,7 +2,7 @@ module Rets
   module Metadata
     class TableFactory
       def self.build(table_fragment, resource)
-        enum?(table_fragment) ? LookupTable.new(table_fragment, resource) : Table.new(table_fragment)
+        enum?(table_fragment) ? LookupTable.new(table_fragment, resource) : Table.new(table_fragment, resource)
       end
 
       def self.enum?(table_fragment)
@@ -18,9 +18,11 @@ module Rets
       attr_accessor :name
       attr_accessor :long_name
       attr_accessor :table_fragment
+      attr_accessor :resource
 
-      def initialize(table_fragment)
+      def initialize(table_fragment, resource)
         self.table_fragment = table_fragment
+        self.resource = resource
         self.type = table_fragment["DataType"]
         self.name = table_fragment["SystemName"]
         self.long_name = table_fragment["LongName"]
@@ -28,6 +30,7 @@ module Rets
 
       def print_tree
         puts "    Table: #{name}"
+        puts "      Resource: #{resource.id}"
         puts "      ShortName: #{ table_fragment["ShortName"] }"
         puts "      LongName: #{ table_fragment["LongName"] }"
         puts "      StandardName: #{ table_fragment["StandardName"] }"
@@ -68,6 +71,7 @@ module Rets
 
       def print_tree
         puts "    LookupTable: #{name}"
+        puts "      Resource: #{resource.id}"
         puts "      Required: #{table_fragment['Required']}"
         puts "      Searchable: #{ table_fragment["Searchable"] }"
         puts "      Units: #{ table_fragment["Units"] }"

data/test/test_client.rb

@@ -81,7 +81,6 @@ class TestClient < MiniTest::Test
     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])
 
@@ -100,6 +99,25 @@ class TestClient < MiniTest::Test
     end
   end
 
+
+  def test_find_retries_when_receiving_no_records_found
+    @client.stubs(:find_every).raises(Rets::NoRecordsFound.new('')).then.returns([1])
+
+    assert_equal [1], @client.find(:all)
+  end
+
+  def test_find_does_not_retry_when_receiving_no_records_found_with_option
+    @client.stubs(:find_every).raises(Rets::NoRecordsFound.new(''))
+
+    assert_equal [], @client.find(:all, no_records_not_an_error: true)
+  end
+
+  def test_find_does_not_retry_and_returns_zero_on_count_request_when_receiving_no_records_found_with_option
+    @client.stubs(:find_every).raises(Rets::NoRecordsFound.new(''))
+
+    assert_equal 0, @client.find(:all, count: 2, no_records_not_an_error: true)
+  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)

data/test/test_metadata.rb

@@ -418,25 +418,25 @@ class TestMetadata < MiniTest::Test
   def test_table_initialize
     fragment = { "DataType" => "A", "SystemName" => "B" }
 
-    table = Rets::Metadata::Table.new(fragment)
+    table = Rets::Metadata::Table.new(fragment, nil)
     assert_equal("A", table.type)
     assert_equal("B", table.name)
   end
 
   def test_table_resolve_returns_empty_string_when_value_nil
-    table = Rets::Metadata::Table.new({})
+    table = Rets::Metadata::Table.new({}, nil)
 
     assert_equal "", table.resolve(nil)
   end
 
   def test_table_resolve_passes_values_straight_through
-    table = Rets::Metadata::Table.new({})
+    table = Rets::Metadata::Table.new({}, nil)
 
     assert_equal "Foo", table.resolve("Foo")
   end
 
   def test_table_resolve_passes_values_strips_extra_whitspace
-    table = Rets::Metadata::Table.new({})
+    table = Rets::Metadata::Table.new({}, nil)
 
     assert_equal "Foo", table.resolve(" Foo ")
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rets
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Estately, Inc. Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-26 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement