rets4r 0.8.5 → 1.1.18

data/CONTRIBUTORS

@@ -1,3 +1,7 @@
-<b>Scott Patterson</b> mailto:scott.patterson@digitalaun.com
+Scott Patterson <scott.patterson@digitalaun.com>
 
-<b>Fran�ois Beausoleil</b> http://blog.teksol.info/
+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/Gemfile

@@ -0,0 +1 @@
+gemspec

data/LICENSE

@@ -5,3 +5,25 @@ This program is copyrighted free software by Scott Patterson.  You can
 redistribute it and/or modify it under the same terms of Ruby's license;
 either the dual license version in 2003 (see the file RUBYS), or any later
 version.
+
+Some parts Copyright (c) 2009 bgetting
+Some parts Copyright (c) 2009 John Wulff
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/MANIFEST

@@ -0,0 +1,63 @@
+.document
+.gemtest
+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

data/NEWS

@@ -0,0 +1,203 @@
+1.1.18
+  New Features
+  * Support multiple environments in examples
+  * Use streaming XML (SAX) parser by default
+  * Support case insensitive headers in DataObjects
+  * Support location parameter in Get Object requests
+  * Add a mapper example
+  * Support rubygems-test
+  * Send a meaningful user agent of rets4r/n.n.n
+  * Raise meaningful exceptions when the service responds with an error
+
+  Bug Fixes
+  * Ignore nil keys and values when creating query strings
+  * Remove broken RETS Session ID header support
+  * Fix nokogiri dependency
+  * Remove broken multi-thread support
+
+1.1.17
+    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/{README → README.rdoc}

@@ -11,10 +11,14 @@ While this is the only "native" Ruby RETS library currently available
 bindings available from the Center for Realtor� Technology
 (http://www.crt.realtors.org/projects/rets/librets/).
 
+== Links
+
+* Source: http://github.com/josephholsten/rets4r
+* Documentation: http://rdoc.info/projects/josephholsten/rets4r
+
 == Requirements
 
-* Ruby 1.8.4 
-* XML::Parser (Optional. If not present, REXML will be used.)
+* Ruby 1.8.4
 
 == License
 
@@ -22,7 +26,7 @@ Please see the LICENSE file.
 
 == Acknowledgments
 
-This project was made possible by the Contra Costa Association of
+This project was made possible in part by the Contra Costa Association of
 Realtors� (http://www.ccartoday.com).
 
 == Getting Started
@@ -33,4 +37,7 @@ objects, rather than making real transaction calls.
 
 Due to the nature of this library, it is HIGHLY recommended that you
 have at least a basic understanding of the RETS protocol. The official
-RETS website is http://www.rets.org.
+RETS website is http://www.rets.org.
+
+Most of the time, you will be either searching for resources or getting
+objects, so begin there.

data/RUBYS

@@ -11,8 +11,8 @@ You can redistribute it and/or modify it under either the terms of the GPL
 
        a) place your modifications in the Public Domain or otherwise
           make them Freely Available, such as by posting said
-	  modifications to Usenet or an equivalent medium, or by allowing
-	  the author to include your modifications in the software.
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
 
        b) use the modified software only within your corporation or
           organization.
@@ -26,11 +26,11 @@ You can redistribute it and/or modify it under either the terms of the GPL
      provided that you do at least ONE of the following:
 
        a) distribute the binaries and library files of the software,
-	  together with instructions (in the manual page or equivalent)
-	  on where to get the original distribution.
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
 
        b) accompany the distribution with the machine-readable source of
-	  the software.
+      the software.
 
        c) give non-standard binaries non-standard names, with
           instructions on where to get the original software distribution.
@@ -44,9 +44,9 @@ You can redistribute it and/or modify it under either the terms of the GPL
      For the list of those files and their copying conditions, see the
      file LEGAL.
 
-  5. The scripts and library files supplied as input to or produced as 
+  5. The scripts and library files supplied as input to or produced as
      output from the software do not automatically fall under the
-     copyright of the software, but belong to whomever generated them, 
+     copyright of the software, but belong to whomever generated them,
      and may be sold commercially, and may be aggregated with this
      software.
 

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rake'
+require 'rake/clean'
+require 'fileutils'
+include FileUtils
+
+# impart all tasks in lib/tasks/
+Dir['lib/tasks/*.rake'].each { |task| import task }
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rets4r #{version}"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+CLEAN << 'rdoc'
+
+file 'MANIFEST.tmp' do
+  sh %{find . -type f | sed 's/\\.\\///' | grep -v '.git' | sort > MANIFEST.tmp}
+end
+CLEAN << 'MANIFEST.tmp'
+
+desc "Check the manifest against current files"
+task :check_manifest => [:clean, 'MANIFEST', 'MANIFEST.tmp'] do
+  puts `diff -du MANIFEST MANIFEST.tmp`
+end
+
+CLEAN << '.rake_tasks'
+
+Bundler::GemHelper.install_tasks
+CLEAN << 'pkg/*'

data/TODO

@@ -9,6 +9,8 @@ Add
 * More Documentation
 * Reply Codes (Readable Meaning)
 * A search convenience method that makes subsequent requests if maxrows is true.
+* Extend examples so they are useful replacements for SimpleRETS
+* Shared configuration between examples
 
 Verify
 * 1.7 Compliance and support
@@ -23,4 +25,6 @@ Possible To-do Items
 * Update Actions
 * Password Change Transaction
 * Get Transaction
-* HTTPS Support
+* HTTPS Support
+* Simple mapping to ActiveRecord
+* add metric_fu

data/examples/client_get_object.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 #
 # This is an example of how to use the RETS client to retrieve an objet.
 #
@@ -7,14 +7,11 @@
 #############################################################################################
 # Settings
 
-rets_url = 'http://server.com/my/rets/url'
-username = 'username'
-password = 'password'
-
-# GetObject Settings
-resource    = 'Property'
-object_type = 'Photo'
-resource_id = 'id:*'
+require 'yaml'
+require 'active_support/core_ext/hash'
+settings_file = File.expand_path(File.join(File.dirname(__FILE__), "settings.yml"))
+env = ENV['LISTING_ENV'] || 'development'
+settings = YAML.load_file(settings_file)[env].symbolize_keys
 
 #############################################################################################
 $:.unshift 'lib'
@@ -23,38 +20,30 @@ require 'rets4r'
 require 'logger'
 
 def handle_object(object)
-	case object.info['Content-Type']
-		when 'image/jpeg' then extension = 'jpg'
-		when 'image/gif'  then extension = 'gif'
-		when 'image/png'  then extension = 'png'
-		else extension = 'unknown'
-	end
-
-	File.open("#{object.info['Content-ID']}_#{object.info['Object-ID']}.#{extension}", 'w') do |f|
-		f.write(object.data)
-	end
+    case object.info['Content-Type']
+        when 'image/jpeg' then extension = 'jpg'
+        when 'image/gif'  then extension = 'gif'
+        when 'image/png'  then extension = 'png'
+        else extension = 'unknown'
+    end
+
+    File.open("#{object.info['Content-ID']}_#{object.info['Object-ID']}.#{extension}", 'w') do |f|
+        f.write(object.data)
+    end
 end
 
-client = RETS4R::Client.new(rets_url)
-
-client.login(username, password) do |login_result|
-	
-	if login_result.success?
-		## Method 1
-		# Get objects using a block
-		client.get_object(resource, object_type, resource_id) do |object|
-			handle_object(object)
-		end
-		
-		## Method 2
-		# Get objects using a return value
-		results = client.get_object(resource, object_type, resource_id)
-		
-		results.each do |object|
-			handle_object(object)
-		end
-	else
-		puts "We were unable to log into the RETS server."
-		puts "Please check that you have set the login variables correctly."
-	end
-end
+client = RETS4R::Client.new(settings[:url])
+
+client.login(settings[:username], settings[:password]) do |login_result|
+
+    if login_result.success?
+        ## Method 1
+        # Get objects using a block
+        client.get_object(settings[:resource], settings[:object_type], settings[:resource_id] + ':0:*') do |object|
+            handle_object(object)
+        end
+    else
+        puts "We were unable to log into the RETS server."
+        puts "Please check that you have set the login variables correctly."
+    end
+end