josephholsten-rets4r 1.1.16 → 1.1.17

data/CHANGELOG

@@ -1,6 +1,192 @@
+Wed Mar  3 12:43:25 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Require mocha before shoulda to fix 'uninitialized constant Test::Unit::TestResult::TestResultFailureSupport'
+    
+	* test/test_helper.rb: require mocha earlier
+
+Tue Feb 23 07:12:46 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Add ListingMapper to convert listing keys
+    
+    * lib/rets4r.rb: require listing service, mapper
+    * lib/rets4r/listing_mapper.rb: new file
+    * lib/rets4r/listing_service.rb: new file
+    * test/data/listing_service.yml: new file
+    * test/listing_mapper_test.rb: new file
+    * test/test_helper.rb: new file
+    
+    * lib/rets4r/core_ext/array/extract_options.rb: helper from rails
+    * lib/rets4r/core_ext/class/attribute_accessors.rb: likewise
+    * lib/rets4r/core_ext/hash/keys.rb: likewise
+    * lib/rets4r/core_ext/hash/slice.rb: likewise
+
+Sat Feb 20 05:39:51 2010  Brian Dunn <brianpatrickdunn@gmail.com>
+
+    Test that SAX parser yeilds durring read.
+    * test/compact_nokogiri_test.rb: modified
+    * test/data/1.5/search_compact_big.xml: new file
+
+Thu Feb 11 06:21:54 2010  Brian Dunn <brianpatrickdunn@gmail.com>
+
+    * lib/rets4r/client/parsers/compact_nokogiri.rb
+    	(CompactNokogiriParser#each): new. should yield each row as the stream is
+    								  read
+    	(CompactNokogiriParser#to_a): reads the whole stream and returns
+    								  rows in an array
+    * lib/rets4r/loader.rb: uses the each method to yield as the stream
+    					    is read
+    * test/compact_nokogiri_test.rb: uses to_a instead.
+
+Sun Feb  7 19:05:46 2010  Scott Patterson <scott.patterson@digitalaun.com>
+
+    Removed unnecessary writing of response to xml file in /tmp dir.
+
+Sun Feb  7 19:11:38 2010  Scott Patterson <scott.patterson@digitalaun.com>
+
+    Reversed aliases and accessors to use Ruby-style accessors with the get/set methods aliased.
+    
+Sun Feb  7 19:04:17 2010  Scott Patterson <scott.patterson@digitalaun.com>
+
+    Added in #data alias to #response for compatibility.
+
+Sun Feb  7 18:57:50 2010  Scott Patterson <scott.patterson@digitalaun.com>
+
+    Removed old experiment.
+
+Sun Feb  7 18:56:24 2010  Scott Patterson <scott.patterson@digitalaun.com>
+
+    Added compact response with only a count.
+
+Thu Sep 10 23:47:49 2009  Andrew Vit <andrew@avit.ca>
+
+    Support response without a delimiter or column names
+
+Mon Sep 14 22:21:35 2009  Andrew Vit <andrew@avit.ca>
+
+    requiring needed compact parser
+
+Wed Sep 16 04:06:16 2009  Andrew Vit <andrew@avit.ca>
+
+    Handle compact-decoded format using same parser
+
+Wed Sep 16 04:06:35 2009  Andrew Vit <andrew@avit.ca>
+
+    Fixed crash with missing response headers
+
+Fri Feb  5 20:37:14 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Version bump to 1.1.16
+
+Fri Feb  5 20:36:39 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Merge branch 'master' of github.com:josephholsten/rets4r
+
+Fri Feb  5 20:34:13 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Make loader accept any IO
+
+    * lib/rets4r/client/parsers/compact_nokogiri.rb
+      (RETS4R::Loader::load): parse from io, not file name. Callers
+      changed
+
+Fri Jan 22 01:39:23 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Version bump to 1.1.15
+
+Fri Jan 22 01:37:22 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Merge branch 'master' of github.com:josephholsten/rets4r
+
+Fri Jan 22 01:32:47 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Fix bug for parsing long lines
+
+    * lib/rets4r/client/parsers/compact_nokogiri.rb
+      (RETS4R::Client::CompactNokogiriParser::CompactDocument#start_element)
+      (RETS4R::Client::CompactNokogiriParser::CompactDocument#end_element)
+      (RETS4R::Client::CompactNokogiriParser::CompactDocument#characters):
+        defer string handling until the element has ended
+    * test/compact_nokogiri_test.rb
+      (CompactNokogiriTest#test_should_handle_big_data): added
+    * test/data/1.5/bad_compact.xml: new file
+
+Fri Jan 22 00:51:00 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Regenerated gemspec for version 1.1.14
+
+Fri Jan 22 00:50:32 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Version bump to 1.1.14
+
+Fri Jan 22 00:44:04 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Add sax parser
+
+    * lib/rets4r.rb: require compact_nokogiri.rb
+    * lib/rets4r/loader.rb (RETS4R::Loader::load): use sax parser
+    * lib/rets4r/client/parsers/compact_nokogiri.rb: new file
+    * test/compact_nokogiri_test.rb: new file
+
+Fri Jan 22 00:38:43 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Run tests that end in _test.rb
+
+    * Rakefile: add *_test.rb to test pattern
+
+Thu Jan 21 23:35:34 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Add a batch file loader
+
+    * lib/rets4r.rb: require loader
+    * lib/rets4r/loader.rb: new file
+    * test/loader_test.rb: new file
+
+Thu Jan 21 23:10:36 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Add parser example
+
+    * examples/client_parser.rb: added
+
+Thu Jan 21 23:02:50 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Fix reference to rcov instead of relevance-rcov
+
+    * lib/tasks/coverage.rake: say rcov, not relevance-rcov
+
+Thu Jan 21 23:02:04 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Add limit to settings
+
+    * examples/client_search.rb: pull limit from settings
+    * examples/settings.yml: set a sane default
+
+Wed Jan 20 11:58:32 2010  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    use demo rets server
+
+Thu Nov 26 01:06:06 2009  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    fix links list
+
+Thu Nov 26 01:05:26 2009  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    fix indentation
+
+Thu Nov 26 01:04:25 2009  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Link to related sites
+
+    * README.rdoc: updated docs
+
+Wed Nov 25 06:37:07 2009  Joseph Anthony Pasquale Holsten <joseph@josephholsten.com>
+
+    Use gemcutter
+
+    * Rakefile: include GemcutterTasks
+
 1.1.13
     Use gemcutter (Joseph Holsten)
-    
+
     * Rakefile: include GemcutterTasks
 
     Fix rdoc reference (Joseph Holsten)
@@ -72,10 +258,8 @@
     Client#debug: removed, all calls inlined.
     Client#RETSTransactionException: added
 
-
     client/parsers/
 
-
 0.8.5
     Parser#parse_compact_line now once again ignores beginning and ending delimiters. (Scott Patterson)
     Parser#parse_data now ignores header fields that are nil or blank when stripped. (Scott Patterson)

data/CONTRIBUTORS

@@ -3,3 +3,5 @@ Scott Patterson <scott.patterson@digitalaun.com>
 Fran�ois Beausoleil <http://blog.teksol.info/>
 John Wulff <johnw@orcasnet.com>
 Joseph Holsten <joseph@josephholsten.com>
+Andrew Vit <andrew@avit.ca>
+Brian Dunn <brianpatrickdunn@gmail.com>

data/NEWS

@@ -0,0 +1,183 @@
+    New features
+    * RETS4R::Client::ResponseParser#parse_results: works with COMPACT-DECODED
+    * RETS4R::Client::CompactDataParser#parse_results: works without a delimiter in response
+    * RETS4R::Client::CompactDataParser#parse_data: works without column names in response
+    * RETS4R::Client::CompactNokogiriParser: yields data as it is read
+    * RETS4R::ListingMapper: added
+    
+    Bug fixes
+    * RETS4R::Client#get_object: checks content-type
+    * RETS4R::Client::ResponseParser: no longer writes a temp file
+
+    Internal API changes
+    * RETS4R::Client::MetadataIndex: removed
+
+1.1.16
+    Internal API changes
+    * RETS4R::Loader::load: parse from io, not file name
+
+1.1.15
+    Bug fixes
+    * RETS4R::Client::CompactNokogiriParser: now parses long lines
+
+1.1.14
+    New features
+    * RETS4R::Loader: added
+    * RETS4R::Client::CompactNokogiriParser: added
+    
+    Other changes
+    * Examples use demo RETS server
+    * New parser example
+    
+1.1.13
+    Use gemcutter (Joseph Holsten)
+    
+    * Rakefile: include GemcutterTasks
+
+    Fix rdoc reference (Joseph Holsten)
+
+	* README: renamed to README.rdoc
+	* Rakefile: likewise
+	* rets4r.gemspec: likewise
+	* CONTRIBUTORS: added Joseph Holsten
+
+1.1.12
+    Merge example settings into a config file (Joseph Holsten)
+    Clean up testing (Joseph Holsten)
+
+1.1.11
+    Merge many rets4r forks (Joseph Holsten)
+
+1.1.10
+    ResponseParser#parse_common: should be _not_ equals (Jacob Basham)
+
+1.1.9
+    (no change)
+
+1.1.8
+   Client, ResponseParser#parse_common: Parser cleanup (Jacob Basham)
+
+1.1.7
+    Client, Client#initialize, Client#create_query_string, Client#request:
+      Cleaned up files to be 80 skinny, added CGI escaping of data (Jacob Basham)
+
+1.1.5
+    gemspec: fix date error (Jacob Basham)
+
+1.1.3
+    gemspec: update (Jacob Basham)
+
+1.1.2
+    ResponseParser#parse_key_value: Accept CARETS response (John Wulff)
+
+1.1.1
+    ResponseParser#parse_key_value: Handle nils (John Wulff)
+
+1.1.0
+    Strip key value pairs for CAPABILITY_LIST endpoints (John Wulff)
+    Add lib/rets4r to default load path (John Wulff)
+
+1.0.0
+    See changes in 9f7ff731250abc1f73b21cb01d3a6fc3a6617e73 (John Wulff)
+
+    Parser#parse_compact_line: simplify split.
+    Parser#parse_data: remove legacy support.
+    Auth::authenticate: handle missing www-authenticate header.
+    Auth::parse_header: strip keys, values.
+    Client#initialize: method signature changed, removed options, added format.
+    Client#set_parser_class, Client#get_parser_class,
+      Client#parser_class, Client#parser_class=, Client#set_output,
+      Client#get_output, Client#output, Client#output=: removed, callers changed.
+    Lay groundwork for non-compact format requests
+    Client::DEFAULT_METHOD: changed to GET
+    Client::DEFAULT_USER_AGENT: changed to Firefox
+    Client#login: handle absolute uris
+    Client#parse: Removed. Changed callers to access parser directly.
+    Client#get_metadata: method signature changed, format removed. Use format instance variable.
+    Client#download_metadata: added
+    Client#get_object: handle text/xml responses
+!!!      Client#get_object: remove quote support from multipart boundary handling
+    Client#count: added
+    Client#basic_encode: added
+!!!    Client#create_query_string: Remove escaping on request query keys, values
+    Client#debug: removed, all calls inlined.
+    Client#RETSTransactionException: added
+
+
+    client/parsers/
+
+
+0.8.5
+    Parser#parse_compact_line now once again ignores beginning and ending delimiters. (Scott Patterson)
+    Parser#parse_data now ignores header fields that are nil or blank when stripped. (Scott Patterson)
+    Updated test to use the rets client version of the client, not hardcoded for post and get tests. (Scott Patterson)
+
+0.8.4
+    Fixed auth issue with authenticate headers with spaces after commas. (Ken Wiesner, Scott Patterson)
+    When an exception is raised in the authentication parsing code, complain by raising
+        a new exception, but also report anything of interest at the same time: request,
+        response, response's body. (François Beausoleil)
+    Fixed Client#request to actually respect the specified request method instead of always using GET requests. (Scott Patterson)
+    Set default request method to POST since some RETS servers seem to have trouble with GET requests. (Scott Patterson)
+
+0.8.3
+    Added example #set_pre_request_block. (François Beausoleil)
+    Allow a pre request block to be set for RETS4R::Client.
+        This allows the caller to change the request in any meaningful way, such as adding a
+        RETS-UA-Authorization header when appropriate. (François Beausoleil)
+    Better response handling of HTTP errors. Response codes > 300 other than 401 now raise an
+        HTTPError exception that encapsulates the HTTPResponse object.
+        401 errors raise a LoginError exception. (Scott Patterson)
+    Added in RETS specification error messages to reference. (Scott Patterson)
+    New Rakefile.  Install the rake gem and do 'rake test' to run the tests. (François Beausoleil)
+
+0.8.2
+    Added missing result parameter to Client#search's yield (Scott Patterson)
+    Added 1.7 to supported list and default version (François Beausoleil)
+    No longer sends empty (nil) headers (François Beausoleil)
+    Added debugging to HTTP output. (François Beausoleil, Scott Patterson)
+    Added support for multiple set-cookie headers in the server response (François Beausoleil)
+    Added basic search example (Scott Patterson)
+    Implied default value of \t in RETS4R::Client::Transaction#delimiter (François Beausoleil)
+    #get_metadata now returns the block's value or the results. (François Beausoleil)
+    Made sure #login always calls #logout if called with a block.  #login returns the block's value
+        instead of results. (François Beausoleil)
+    New assertions that require Client to have Ruby-like accessors for attributes, instead of
+        getters and setters.  Applied 'Rename Attribute' on @parser, because #get_parser_class
+        was returning the class of the parser's class, instead of the parser's class itself. (François Beausoleil)
+    Client#set_rets_version should take care to generate the correct RETS-Version header,
+        and #get_rets_version should undo the changes that #set_rets_version did before
+        returning the value. (François Beausoleil)
+    Don't rescue an exception that's not being processed in Parser. (François Beausoleil)
+    RETS4R::Client#get_object extensions: yield or return the array of DataObject instances;
+        changed the multipart/parallel response boundary processing rules
+        (include \r\n in the boundary detection); added documentation. (François Beausoleil)
+    Added GetObject example (Scott Patterson)
+    Changed #get_object now yields each DataObject if a block is given rather
+        than an array of DataObjects (Scott Patterson)
+
+0.8.1
+    Added Action-URL support per the specification.
+    Added a secondary_response accessor to the Transaction object, which is what the Action-URL result is stored in.
+    Fixed a bug with loggers and parsers
+
+0.8.0
+    Fixed RParser support, which now means you can use REXML.
+    RParser now retries XML that produced a parser error after trying to clean it.
+    Parser support is now more open so that more parsers can be easily added in the future.
+    Reorganized parser file layout.
+    CParser will only be loaded if libxml (its dependency) is present. If it is, it is the default
+        parser.
+    Added more parser unit tests.
+    Renamed CParser to XMLParser and RPARSER to REXML, both with the hierarchy RETS4R::Client::Module.
+    Fixed a bug with the parser output not being set properly.
+    Fixed a bug with the parser not respecting the DELIMITER value and insisting on tab delimiters.
+    Added support for using a logger
+    Added more defaults to the search options (Count => '0', Format => 'COMPACT')
+    Added some Rubyisms (blocks can now be given to #new, #login, #get_metadata, #get_object, and #search)
+
+0.7.1
+    Added support for reading the results count for searches.
+
+0.7.0
+    Initial GEM Version

data/Rakefile

@@ -13,7 +13,7 @@ Dir['lib/tasks/*.rake'].each { |task| import task }
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
-    gem.name = "josephholsten-rets4r"
+    gem.name = "rets4r"
     gem.summary  = 'A native Ruby implementation of RETS (Real Estate Transaction Standard).'
     gem.authors   = ['Scott Patterson', 'John Wulff', 'bgetting', "Jacob Basham"]
     gem.email    = ['scott.patterson@digitalaun.com', 'john@johnwulff.com', 'brian@terra-firma-design.com','jacob@paperpigeons.net']

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:build: 
 :major: 1
 :minor: 1
-:patch: 16
+:patch: 17
+:build: 

data/lib/rets4r.rb

@@ -5,3 +5,5 @@ $:.unshift(dir) unless $:.include?(dir) || $:.include?(File.expand_path(dir))
 require 'client'
 require 'loader'
 require 'client/parsers/compact_nokogiri'
+require 'rets4r/listing_service'
+require 'rets4r/listing_mapper'

data/lib/rets4r/client.rb

@@ -18,6 +18,7 @@ require 'cgi'
 require 'auth'
 require 'client/dataobject'
 require 'client/parsers/response_parser'
+require 'client/parsers/compact'
 require 'thread'
 require 'logger'
 
@@ -164,15 +165,15 @@ module RETS4R
       @headers[name]
     end
 
-    def set_user_agent(name)
+    def user_agent=(name)
       set_header('User-Agent', name)
     end
 
-    def get_user_agent
+    def user_agent
       get_header('User-Agent')
     end
 
-    def set_rets_version(version)
+    def rets_version=(version)
       if (SUPPORTED_RETS_VERSIONS.include? version)
         set_header('RETS-Version', "RETS/#{version}")
       else
@@ -180,27 +181,27 @@ module RETS4R
       end
     end
 
-    def get_rets_version
+    def rets_version
       (get_header('RETS-Version') || "").gsub("RETS/", "")
     end
 
-    def set_request_method(method)
+    def request_method=(method)
       @request_method = method
     end
 
-    def get_request_method
+    def request_method
         # Basic Authentication
         #
       @request_method
     end
 
-    # Provide more Ruby-like attribute accessors instead of get/set methods
-    alias_method :user_agent=, :set_user_agent
-    alias_method :user_agent, :get_user_agent
-    alias_method :request_method=, :set_request_method
-    alias_method :request_method, :get_request_method
-    alias_method :rets_version=, :set_rets_version
-    alias_method :rets_version, :get_rets_version
+    # Provide backwards-compatible get/set methods.
+    alias_method :set_user_agent, :user_agent=
+    alias_method :get_user_agent, :user_agent
+    alias_method :set_request_method, :request_method=
+    alias_method :get_request_method, :request_method
+    alias_method :set_rets_version, :rets_version=
+    alias_method :get_rets_version, :rets_version
 
     #### RETS Transaction Methods ####
     #
@@ -327,12 +328,12 @@ module RETS4R
       response = request(@urls['GetObject'], data, header)
       results = block_given? ? 0 : []
 
-      if response['content-type'].include?('text/xml')
+      if response['content-type'] && response['content-type'].include?('text/xml')
         # This probably means that there was an error.
         # Response parser will likely raise an exception.
         rr = @response_parser.parse_object_response(response.body)
         return rr
-      elsif response['content-type'].include?('multipart/parallel')
+      elsif response['content-type'] && response['content-type'].include?('multipart/parallel')
         content_type = process_content_type(response['content-type'])
 
 #        TODO: log this