josephholsten-rets4r 1.1.17 → 1.1.18

data/README.rdoc

@@ -1,45 +0,0 @@
-= RETS4R
-
-RETS4R provides a native Ruby interface to the RETS (Real Estate
-Transaction Standard). It currently is built for the 1.5 specification,
-but support for 1.7 and 2.0 are planned. It does not currently implement
-all of the specification, but the most commonly used portions.
-Specifically, there is no support for Update transactions.
-
-While this is the only "native" Ruby RETS library currently available
-(to my knowledge), there is another client written in C++ with Ruby
-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
-* Continuous Integration: http://runcoderun.com/josephholsten/rets4r
-* Code Metrics: http://devver.net/caliper/project?repo=git%3A%2F%2Fgithub.com%2Fjosephholsten%2Frets4r.git
-
-== Requirements
-
-* Ruby 1.8.4
-
-== License
-
-Please see the LICENSE file.
-
-== Acknowledgments
-
-This project was made possible in part by the Contra Costa Association of
-Realtors� (http://www.ccartoday.com).
-
-== Getting Started
-
-Take a look at the examples directory. You'll find it more helpful than
-the unit tests because the unit tests work off of local files and mock
-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.
-
-Most of the time, you will be either searching for resources or getting
-objects, so begin there.

data/RUBYS

@@ -1,56 +0,0 @@
-Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
-You can redistribute it and/or modify it under either the terms of the GPL
-(see the file GPL), or the conditions below:
-
-  1. You may make and give away verbatim copies of the source form of the
-     software without restriction, provided that you duplicate all of the
-     original copyright notices and associated disclaimers.
-
-  2. You may modify your copy of the software in any way, provided that
-     you do at least ONE of the following:
-
-       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.
-
-       b) use the modified software only within your corporation or
-          organization.
-
-       c) give non-standard binaries non-standard names, with
-          instructions on where to get the original software distribution.
-
-       d) make other distribution arrangements with the author.
-
-  3. You may distribute the software in object code or binary form,
-     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.
-
-       b) accompany the distribution with the machine-readable source of
-      the software.
-
-       c) give non-standard binaries non-standard names, with
-          instructions on where to get the original software distribution.
-
-       d) make other distribution arrangements with the author.
-
-  4. You may modify and include the part of the software into any other
-     software (possibly commercial).  But some files in the distribution
-     are not written by the author, so that they are not under these terms.
-
-     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
-     output from the software do not automatically fall under the
-     copyright of the software, but belong to whomever generated them,
-     and may be sold commercially, and may be aggregated with this
-     software.
-
-  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
-     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-     PURPOSE.

data/Rakefile

@@ -1,57 +0,0 @@
-require 'rubygems'
-require 'rake'
-require 'rake/clean'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-require 'rake/contrib/rubyforgepublisher'
-require 'fileutils'
-include FileUtils
-
-# impart all tasks in lib/tasks/
-Dir['lib/tasks/*.rake'].each { |task| import task }
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    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']
-    gem.homepage = 'http://rets4r.rubyforge.org/'
-    gem.files =  FileList["[A-Z]*", "{examples,lib,test}/**/*"]
-    gem.rubyforge_project = 'rets4r'
-    gem.extra_rdoc_files = ['CONTRIBUTORS', 'README.rdoc', 'LICENSE', 'RUBYS', 'GPL',
-      'CHANGELOG', 'TODO' ]
-    gem.rdoc_options << '--main' << 'README.rdoc'
-    gem.test_files = FileList['test/test_*.rb']
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << "test"
-  test.pattern = ["test/test_*.rb", "test/*_test.rb"]
-  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

data/TODO

@@ -1,29 +0,0 @@
-Fix
-* Unit Tests (We need METADATA!)
-
-Add support for
-* Standard (non-compact) XML
-
-Add
-* More Examples
-* 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
-
-Check
-* GetMetadata
-
-Possible To-do Items
-* RETS 1.0
-* RETS 2.0 (May not be necessary since it is now SOAP based, but it would be nice to have a consistent API)
-* Running a RETS Server
-* Update Actions
-* Password Change Transaction
-* Get Transaction
-* HTTPS Support
-* Simple mapping to ActiveRecord

data/VERSION.yml

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

data/examples/client_get_object.rb

@@ -1,47 +0,0 @@
-#!/usr/bin/ruby
-#
-# This is an example of how to use the RETS client to retrieve an objet.
-#
-# You will need to set the necessary variables below.
-#
-#############################################################################################
-# Settings
-
-require 'yaml'
-settings_file = File.expand_path(File.join(File.dirname(__FILE__), "settings.yml"))
-settings = YAML.load_file(settings_file)['settings']
-
-#############################################################################################
-$:.unshift 'lib'
-
-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
-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]) 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

data/examples/client_login.rb

@@ -1,37 +0,0 @@
-#!/usr/bin/ruby
-#
-# This is an example of how to use the RETS client to log in and out of a server.
-#
-# You will need to set the necessary variables below.
-#
-#############################################################################################
-# Settings
-
-require 'yaml'
-settings_file = File.expand_path(File.join(File.dirname(__FILE__), "settings.yml"))
-settings = YAML.load_file(settings_file)['settings']
-
-#############################################################################################
-$:.unshift 'lib'
-
-require 'rets4r'
-require 'logger'
-
-client = RETS4R::Client.new(settings[:url])
-client.logger = Logger.new(STDOUT)
-
-login_result = client.login(settings[:username], settings[:password])
-
-if login_result.success?
-    puts "We successfully logged into the RETS server!"
-
-    # Print the action URL results (if any)
-    puts login_result.secondary_response
-
-    client.logout
-
-    puts "We just logged out of the server."
-else
-    puts "We were unable to log into the RETS server."
-    puts "Please check that you have set the login variables correctly."
-end

data/examples/client_metadata.rb

@@ -1,40 +0,0 @@
-#!/usr/bin/ruby
-#
-# This is an example of how to use the RETS client to login to a server and retrieve metadata. It
-# also makes use of passing blocks to client methods and demonstrates how to set the output format.
-#
-# You will need to set the necessary variables below.
-#
-#############################################################################################
-# Settings
-
-require 'yaml'
-settings_file = File.expand_path(File.join(File.dirname(__FILE__), "settings.yml"))
-settings = YAML.load_file(settings_file)['settings']
-
-#############################################################################################
-$:.unshift 'lib'
-
-require 'rets4r'
-
-RETS4R::Client.new(settings[:url]) do |client|
-    client.login(settings[:username], settings[:password]) do |login_result|
-        if login_result.success?
-            puts "Logged in successfully!"
-
-            metadata = ''
-
-            begin
-                metadata = client.get_metadata
-            rescue
-                puts "Unable to get metadata: '#{$!}'"
-            end
-
-            File.open('metadata.xml', 'w') do |file|
-                file.write metadata
-            end
-        else
-            puts "Unable to login: '#{login_result.reply_text}'."
-        end
-    end
-end

data/examples/client_parser.rb

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-$:.unshift 'lib'
-require 'rubygems'
-require 'rets4r'
-
-xml = ARGF
-
-parser = RETS4R::Client::ResponseParser.new
-transaction = parser.parse_results(xml, 'COMPACT')
-transaction.response.each {|row| puts row.inspect }

data/examples/client_search.rb

@@ -1,47 +0,0 @@
-#!/usr/bin/ruby
-#
-# This is an example of how to use the RETS client to perform a basic search.
-#
-# You will need to set the necessary variables below.
-#
-#############################################################################################
-# Settings
-
-require 'yaml'
-settings_file = File.expand_path(File.join(File.dirname(__FILE__), "settings.yml"))
-settings = YAML.load_file(settings_file)['settings']
-
-#############################################################################################
-$:.unshift 'lib'
-
-require 'rets4r'
-
-client = RETS4R::Client.new(settings[:url])
-
-logger = Logger.new($stdout)
-logger.level = Logger::WARN
-client.logger = logger
-
-login_result = client.login(settings[:username], settings[:password])
-
-if login_result.success?
-    puts "We successfully logged into the RETS server!"
-
-    options = {'Limit' => settings[:limit]}
-
-    client.search(settings[:resource], settings[:class], settings[:query], options) do |result|
-        result.response.each do |row|
-            puts row.inspect
-            puts
-        end
-    end
-
-    client.logout
-
-    puts "We just logged out of the server."
-else
-    puts "We were unable to log into the RETS server."
-    puts "Please check that you have set the login variables correctly."
-end
-
-logger.close

data/examples/settings.yml

@@ -1,12 +0,0 @@
-settings:
-  :url:  http://demo.crt.realtors.org:6103/rets/login
-  :username: Joe
-  :password: Schmoe
-  :resource: Property
-  :class: RES
-  :query: (MODIFIED=2009-11-14-TODAY)
-  :object_type: Photo
-  :resource_id: '11003049:*'
-  :limit: 400
-  #:query: (LISTPRICE=0+)
-  #:query: (MODIFIED=2009-11-14-TODAY)

data/lib/rets4r.rb

@@ -1,9 +0,0 @@
-# Add lib/rets4r as a default load path.
-dir = File.join File.dirname(__FILE__), 'rets4r'
-$:.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/auth.rb

@@ -1,73 +0,0 @@
-require 'digest/md5'
-
-module RETS4R
-    class Auth
-        # This is the primary method that would normally be used, and while it
-        def Auth.authenticate(response, username, password, uri, method, requestId, useragent, nc = 0)
-            if response['www-authenticate'].nil? || response['www-authenticate'].empty?
-              raise "Missing required header 'www-authenticate'. Got: #{response}"
-            end
-
-            authHeader = Auth.parse_header(response['www-authenticate'])
-
-            cnonce = cnonce(useragent, password, requestId, authHeader['nonce'])
-
-            authHash = calculate_digest(username, password, authHeader['realm'], authHeader['nonce'], method, uri, authHeader['qop'], cnonce, nc)
-
-            header = ''
-            header << "Digest username=\"#{username}\", "
-            header << "realm=\"#{authHeader['realm']}\", "
-            header << "qop=\"#{authHeader['qop']}\", "
-            header << "uri=\"#{uri}\", "
-            header << "nonce=\"#{authHeader['nonce']}\", "
-            header << "nc=#{('%08x' % nc)}, "
-            header << "cnonce=\"#{cnonce}\", "
-            header << "response=\"#{authHash}\", "
-            header << "opaque=\"#{authHeader['opaque']}\""
-
-            return header
-        end
-
-        def Auth.calculate_digest(username, password, realm, nonce, method, uri, qop = false, cnonce = false, nc = 0)
-            a1 = "#{username}:#{realm}:#{password}"
-            a2 = "#{method}:#{uri}"
-
-            response = '';
-
-            requestId = Auth.request_id unless requestId
-
-            if (qop)
-                throw ArgumentException, 'qop requires a cnonce to be provided.' unless cnonce
-
-                response = Digest::MD5.hexdigest("#{Digest::MD5.hexdigest(a1)}:#{nonce}:#{('%08x' % nc)}:#{cnonce}:#{qop}:#{Digest::MD5.hexdigest(a2)}")
-            else
-                response = Digest::MD5.hexdigest("#{Digest::MD5.hexdigest(a1)}:#{nonce}:#{Digest::MD5.hexdigest(a2)}")
-            end
-
-            return response
-        end
-
-        def Auth.parse_header(header)
-            type = header[0, header.index(' ')]
-            args = header[header.index(' '), header.length].strip.split(',')
-
-            parts = {'type' => type}
-
-            args.each do |arg|
-                name, value = arg.split('=')
-
-                parts[name.downcase.strip] = value.tr('"', '').strip
-            end
-
-            return parts
-        end
-
-        def Auth.request_id
-            Digest::MD5.hexdigest(Time.new.to_f.to_s)
-        end
-
-        def Auth.cnonce(useragent, password, requestId, nonce)
-            Digest::MD5.hexdigest("#{useragent}:#{password}:#{requestId}:#{nonce}")
-        end
-    end
-end