jschairb-rets4r 1.1.18

data/TODO

@@ -0,0 +1,35 @@
+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
+
+
+* remove devver link from readme
+* add metric_fu
+* remove runcoderun link
+* set up integrety on heroku

data/examples/client_get_object.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env 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'
+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'
+
+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] + ':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

data/examples/client_login.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env 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'
+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'
+
+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_mapper.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+$:.unshift 'lib'
+require 'rets4r'
+require 'yaml'
+
+listing_service_config_file = File.expand_path(File.join(File.dirname(__FILE__), "settings.yml"))
+RETS4R::ListingService.configurations = YAML.load_file(listing_service_config_file)
+RETS4R::ListingService.env = ENV['RETS4RENV'] || 'development'
+
+xml = ARGF
+
+mapper = RETS4R::ListingMapper.new
+RETS4R::Loader.load(xml) do |record|
+  attributes = mapper.map(record)
+  puts attributes.inspect
+end

data/examples/client_metadata.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env 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'
+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'
+
+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(*ARGV)
+            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

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+$:.unshift 'lib'
+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

@@ -0,0 +1,49 @@
+#!/usr/bin/env 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'
+require 'active_support/core_ext/hash'
+settings_file = File.expand_path(File.join(File.dirname(__FILE__), "settings.yml"))
+ENV['LISTING_ENV'] ||= 'development'
+settings = YAML.load_file(settings_file)[ENV['LISTING_ENV']].symbolize_keys
+
+#############################################################################################
+$:.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

@@ -0,0 +1,114 @@
+# This file specifies the access information for the listing service
+# To access the standard RETS demo server, use:
+#
+#test:
+#  url: http://demo.crt.realtors.org:6103/rets/login
+#  username: Joe
+#  password: Schmoe
+#  version: 1.7.2
+#  resource: Property
+#  class: RES
+#  select:
+#    ListingID: :rets_id
+#    AgentID: :agent_id
+#    ModificationTimestamp: :modification_timestamp
+#    Status: :status
+#    ListDate: :list_date
+#    ListPrice: :list_price
+#    ClosePrice: :close_price
+#    ContractDate: :contract_date
+#    StreetNumber: :street_number
+#    ZipCode: :zip_code
+#    City: :city
+#    County: :county
+#    Unit: :unit_number
+#    StreetName: :street_name
+#    StreetDirection: :street_direction
+#    Rooms: :rooms
+#    State: :state
+#    Board: :board
+#    LivingArea: :living_area
+#    Baths: :baths
+#    Bedrooms: :beds
+#    Garage: :garage
+#    SqFt: :square_footage
+#    YearBuilt: :year_built
+#    AssociationFee: :assoc_fee
+#    BathsFull: :baths_full
+#    BathHalf: :baths_half
+#    Directions: :directions
+#    OriginalListPrice: :original_list_price
+#    LotSizeDim: :lot_size_dim
+#    ListOfficeBrokerID: :office_list
+#    OfficeName: :office_name
+#    Pool: :pool
+#    Remarks: :remarks
+#    Stories: :stories
+#    TaxID: :taxid
+#    ConstructionMaterial: :construction
+#    ExteriorFeatures: :exterior
+#    Fireplaces: :fireplaces
+#    Heating: :heating
+#    InteriorFeatures: :interior
+#    LotSizeArea: :lot_size
+#    MapCoordinate: :mapbook
+#    PresentUse: :present_use
+#    Style: :style
+
+common: &COMMON
+  url: http://demo.crt.realtors.org:6103/rets/login
+  username: Joe
+  password: Schmoe
+  version: 1.5
+  resource: Property
+  class: RES
+  limit: 10
+  resource_id: "10202512"
+  object_type: Photo
+  query: "(*)"
+  select:
+    MLSNUM: :mls
+    AGENTLIST: :agent_id
+    AGENTLIST_FULLNAME: :agent_full_name
+    OFFICELIST_OFFICENAM1: :office_name
+    MODIFIED: :rets_updated_at
+    LISTSTATUS: :status
+    PHOTOCOUNT: :photo_count
+    LISTPRICE: :list_price
+    STREETNUMDISPLAY: :street_number
+    STREETDIR: :street_direction
+    STREETDIRSUFFIX: :street_dir_suffix
+    STREETNAME: :street_name
+    STREETTYPE: :street_type
+    UNITNUM: :unit_number
+    ZIPCODE: :zip_code
+    CITY: :city
+    COUNTY: :county
+    AREA: :area
+    LOTSIZE: :lot_size
+    SQFTTOTAL: :square_feet
+    NUMLIVINGAREAS: :living_area
+    BATHSTOTAL: :baths
+    BEDS: :beds
+    GARAGECAP: :garage
+    YEARBUILT: :year_built
+    UID: :uid
+    INTERNETDISPLAYYN: :allow_internet_display
+    INTERNETLIST_ALL: :internet_list_all
+    INTERNETADDRYN: :allow_address_display
+    SCHOOLDISTRICT: :school_district
+
+development:
+  <<: *COMMON
+
+test: &TEST
+  <<: *COMMON
+
+production:
+  <<: *COMMON
+
+cucumber:
+  <<: *TEST
+
+staging:
+  <<: *TEST

data/lib/rets4r.rb

@@ -0,0 +1,14 @@
+# 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))
+
+module RETS4R # :nodoc:
+  VERSION = '1.1.18'
+end
+
+require 'client'
+require 'loader'
+require 'rubygems'
+require 'client/parsers/compact_nokogiri'
+require 'rets4r/listing_service'
+require 'rets4r/listing_mapper'

data/lib/rets4r/auth.rb

@@ -0,0 +1,73 @@
+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