rets 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40ba28e99fa147a1f23f7cf4e7e04fcd5c9a4218
-  data.tar.gz: 8abca9ffb82c600b2f0ca9c6caf774c17eb0a4cb
+  metadata.gz: 6a9bf5e37008d7651782e347a520f24cb291931f
+  data.tar.gz: 22742e9f4a45db910f03358e45024ee25d8cb6e9
 SHA512:
-  metadata.gz: c510f13d8823562c48a2fd87421ada813c3766846082c6dd8bdad442c4fe4922de65cbd0d2d486b7fcbe8fb48c69651b61fc844812bbc2e7b307152ca327d2e1
-  data.tar.gz: 19f7bd93de8858158118108266f78d344c65c23f9f7c68ed20e19b7a77b0d42f4d187654c3a18ff817d5e35b1480b5e86741bd88acdf2a483a9510feb00777f8
+  metadata.gz: a742d37803a7c1354bb4f8d2c087b9a20b745c984286df5c243022cbb053612cb281350f589ca259494e955b7404bfd37db18ff2812441b2a560ad33485976f0
+  data.tar.gz: 250667d8536d504b41fc4192d8bb124237cd48bd663d061baccca0728b6408abd2d8776cd3ccf70ba6d7458a9a56e61f83a853510be725b264940be0e0c777b9

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.9.0 / 2015-06-11
+
+* feature: update to httpclient 2.6
+
 ### 0.8.1 / 2015-06-09
 
 * fix: actually make the httpclient version more specific this time

data/Manifest.txt

@@ -3,6 +3,9 @@ Manifest.txt
 README.md
 Rakefile
 bin/rets
+example/connect.rb
+example/get-photos.rb
+example/get-property.rb
 lib/rets.rb
 lib/rets/client.rb
 lib/rets/client_progress_reporter.rb
@@ -17,10 +20,13 @@ lib/rets/metadata/rets_class.rb
 lib/rets/metadata/root.rb
 lib/rets/metadata/table.rb
 lib/rets/parser/compact.rb
+lib/rets/parser/error_checker.rb
 lib/rets/parser/multipart.rb
 test/fixtures.rb
 test/helper.rb
 test/test_client.rb
+test/test_error_checker.rb
+test/test_http_client.rb
 test/test_locking_http_client.rb
 test/test_metadata.rb
 test/test_parser_compact.rb

data/Rakefile

@@ -9,7 +9,8 @@ Hoe.plugin :gemspec
 Hoe.spec 'rets' do
   developer 'Estately, Inc. Open Source', 'opensource@estately.com'
 
-  extra_deps << [ "httpclient", "~> 2.4.0" ]
+  extra_deps << [ "httpclient", "~> 2.6.0" ]
+  extra_deps << [ "http-cookie", "~> 1.0.0" ]
   extra_deps << [ "nokogiri",   "~> 1.5" ]
 
   extra_dev_deps << [ "mocha", "~> 0.11" ]

data/example/connect.rb

@@ -0,0 +1,19 @@
+require 'rets'
+
+# Pass the :login_url, :username, :password and :version of RETS
+client = Rets::Client.new({
+  login_url: 'login_url',
+  username: 'xxx',
+  password: 'xxx',
+  version: 'RETS/1.5'
+})
+
+begin
+  client.login
+rescue => e
+  puts 'Error: ' + e.message
+  exit!
+end
+
+puts 'We connected! Lets log out...'
+client.logout

data/example/get-photos.rb

@@ -0,0 +1,20 @@
+require 'rets'
+
+
+# Get all photos (*) for MLS ID 'mls_id'
+# Pass :object_id (ie '0', '1,2', wildcard '*')
+# The pass :resource (Property, Agent, MetaData, ...), :object_type (Photo, PhotoLarge), :rescource_id (ID of agent, MLS, ...)
+photos = client.objects '*', {
+  resource: 'Property',
+  object_type: 'Photo',
+  resource_id: 'mls_id'
+}
+
+photos.each_with_index do |data, index|
+  File.open("property-#{index.to_s}.jpg", 'w') do |file|
+    file.write data.body
+  end
+end
+
+puts photos.length.to_s + ' photos saved.'
+client.logout

data/example/get-property.rb

@@ -0,0 +1,16 @@
+require 'rets'
+
+
+# Get one property
+# Pass :first or :all
+# Then :search_type (Property, Agent, ...), :class (Condo, Commerical, ...), :query and :limit
+property = client.find :first, {
+  search_type: 'Property',
+  class: 'CLASS_NAME',
+  query: 'RETS_QUERY',
+  limit: 1
+}
+
+puts 'received property: '
+puts property.inspect
+client.logout

data/lib/rets.rb

@@ -3,7 +3,7 @@ require 'digest/md5'
 require 'nokogiri'
 
 module Rets
-  VERSION = '0.8.1'
+  VERSION = '0.9.0'
 
   MalformedResponse    = Class.new(ArgumentError)
   UnknownResponse      = Class.new(ArgumentError)

data/lib/rets/client.rb

@@ -1,3 +1,4 @@
+require 'http-cookie'
 require 'httpclient'
 require 'logger'
 
@@ -335,8 +336,8 @@ module Rets
       hash
     end
 
-    def save_cookie_store(force=nil)
-      @http_client.save_cookie_store(force)
+    def save_cookie_store
+      @http_client.save_cookie_store
     end
 
     def http_get(url, params=nil, extra_headers={})

data/lib/rets/http_client.rb

@@ -52,13 +52,10 @@ module Rets
       end
     end
 
-    def save_cookie_store(force=nil)
+    def save_cookie_store
       if options[:cookie_store]
-        if force
-          @http.cookie_manager.save_all_cookies(true, true, true)
-        else
-          @http.save_cookie_store
-        end
+        #save session cookies
+        @http.cookie_manager.save_cookies(true)
       end
     end
 
@@ -82,9 +79,12 @@ module Rets
     end
 
     def http_cookie(name)
-      http.cookies.each do |c|
-        return c.value if c.name.downcase == name.downcase && c.match?(URI.parse(login_url))
+      @http.cookie_manager.cookies(login_url).each do |c|
+        if c.name.downcase == name.downcase
+          return c.value
+        end
       end
+
       nil
     end
   end

data/lib/rets/locking_http_client.rb

@@ -19,8 +19,8 @@ module Rets
       end
     end
 
-    def save_cookie_store(force=nil)
-      @http_client.save_cookie_store(force)
+    def save_cookie_store
+      @http_client.save_cookie_store
     end
 
     def lock_around(&block)

data/lib/rets/measuring_http_client.rb

@@ -20,8 +20,8 @@ module Rets
       end
     end
 
-    def save_cookie_store(force=nil)
-      @http_client.save_cookie_store(force)
+    def save_cookie_store
+      @http_client.save_cookie_store
     end
   end
 end

data/lib/rets/parser/error_checker.rb

@@ -0,0 +1,49 @@
+module Rets
+  module Parser
+    class ErrorChecker
+      def self.check(response)
+        # some RETS servers returns HTTP code 412 when session cookie expired, yet the response body
+        # passes XML check. We need to special case for this situation.
+        # This method is also called from multipart.rb where there are headers and body but no status_code
+        if response.respond_to?(:status_code) && response.status_code == 412
+          raise HttpError, "HTTP status: #{response.status_code}, body: #{response.body}"
+        end
+
+        # some RETS servers return success code in XML body but failure code 4xx in http status
+        # If xml body is present we ignore http status
+
+        if !response.body.empty?
+          begin
+            xml = Nokogiri::XML.parse(response.body, nil, nil, Nokogiri::XML::ParseOptions::STRICT)
+
+            rets_element = xml.xpath("/RETS")
+            unless rets_element.empty?
+              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 == NoRecordsFound::ERROR_CODE
+                raise NoRecordsFound.new(reply_text)
+              elsif reply_code == NoObjectFound::ERROR_CODE
+                raise NoObjectFound.new(reply_text)
+              elsif reply_code.nonzero?
+                raise InvalidRequest.new(reply_code, reply_text)
+              else
+                return
+              end
+            end
+          rescue Nokogiri::XML::SyntaxError
+            #Not xml
+          end
+        end
+
+        if response.respond_to?(:ok?) && ! response.ok?
+          if response.status_code == 401
+            raise AuthorizationFailure.new(response.status_code, response.body)
+          else
+            raise HttpError, "HTTP status: #{response.status_code}, body: #{response.body}"
+          end
+        end
+      end
+    end
+  end
+end

data/test/test_http_client.rb

@@ -5,7 +5,6 @@ class TestHttpClient < MiniTest::Test
     @cm = WebAgent::CookieManager.new
 
     @http = HTTPClient.new
-    @http.cookie_manager = @cm
 
     @logger = Rets::Client::FakeLogger.new
     @logger.stubs(:debug?).returns(false)
@@ -13,20 +12,6 @@ class TestHttpClient < MiniTest::Test
     @http_client = Rets::HttpClient.new(@http, {}, @logger, "http://rets.rets.com/somestate/login.aspx")
   end
 
-  def test_http_cookie_with_webagent_cookie
-    cookie1 = "RETS-Session-ID=879392834723043209; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
-    @cm.parse(cookie1, URI.parse("http://www.rets.rets.com"))
-
-    cookie2 = "Foo=Bar; path=/; domain=rets.rets.com; expires=Wednesday, 31-Dec-2037 12:00:00 GMT"
-    @cm.parse(cookie2, URI.parse("http://www.rets.rets.com"))
-
-    assert_equal "879392834723043209", @http_client.http_cookie('RETS-Session-ID')
-  end
-
-  def test_http_cookie_without_webagent_cookie
-    assert_equal nil, @http_client.http_cookie('RETS-Session-ID')
-  end
-
   def test_http_get_delegates_to_client
     url = 'foo@example.com'
     response = stub(:response)
@@ -46,4 +31,66 @@ class TestHttpClient < MiniTest::Test
 
     assert_equal @http_client.http_post(url, {}), response
   end
+
+  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
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rets
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Estately, Inc. Open Source
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: http-cookie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.13'
 description: |-
   [![Build Status](https://secure.travis-ci.org/estately/rets.png?branch=master)](http://travis-ci.org/estately/rets)
   A pure-ruby library for fetching data from [RETS] servers.
@@ -129,6 +143,9 @@ files:
 - README.md
 - Rakefile
 - bin/rets
+- example/connect.rb
+- example/get-photos.rb
+- example/get-property.rb
 - lib/rets.rb
 - lib/rets/client.rb
 - lib/rets/client_progress_reporter.rb
@@ -143,6 +160,7 @@ files:
 - lib/rets/metadata/root.rb
 - lib/rets/metadata/table.rb
 - lib/rets/parser/compact.rb
+- lib/rets/parser/error_checker.rb
 - lib/rets/parser/multipart.rb
 - test/fixtures.rb
 - test/helper.rb
@@ -155,7 +173,8 @@ files:
 - test/test_parser_multipart.rb
 - test/vcr_cassettes/unauthorized_response.yml
 homepage: http://github.com/estately/rets
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
@@ -174,17 +193,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: rets
-rubygems_version: 2.2.0
+rubyforge_project: 
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: "[![Build Status](https://secure.travis-ci.org/estately/rets.png?branch=master)](http://travis-ci.org/estately/rets)
   A pure-ruby library for fetching data from [RETS] servers"
-test_files:
-- test/test_client.rb
-- test/test_error_checker.rb
-- test/test_http_client.rb
-- test/test_locking_http_client.rb
-- test/test_metadata.rb
-- test/test_parser_compact.rb
-- test/test_parser_multipart.rb
+test_files: []