rillow 0.1.0 → 0.2.0

data/README

@@ -1,6 +1,16 @@
 # This api is created by Leo Chan on 10/29/2007.
 # There is no license requirement.  Use it or copy any part of the code that you want to use.
+# Use it at your own risk.  I am not liable for anything.  Just want to share it and hope it is useful for you
 # Rillow is a simple ruby wrapper to zillow webservice api: http://www.zillow.com/howto/api/APIOverview.htm
 # It does the web service call and gets the result back for you.  You don't have to know about the url request formate, url encoding or 
 # parsing the result.  The result object is in hash/array format.  So no need to parse xml.
 # You will need to register with zillow to get the Zillow Web Service Identifier first.
+# Go to http://rubyforge.org/projects/rillow/ for project details or to download the latest release
+# Installation:
+# gem install rillow
+# Example code:
+# require 'rubygems'
+# require 'rillow'
+# rillow = Rillow.new('your-zillow-key')
+# result = rillow.get_search_results('2114 Bigelow Ave','Seattle, WA')
+# result.to_hash 

data/lib/rillow.rb

@@ -3,9 +3,11 @@ require 'net/http'
 require 'uri'
 require 'rubygems'
 require 'xmlsimple'
+require 'rillow_helper'
 
 # This api is created by Leo Chan on 10/29/2007.
 # There is no license requirement.  Use it or copy any part of the code that you want to use.
+# Use it at your own risk.  I am not liable for anything.  Just want to share what I wrote.  Hopefully you will find it useful.
 # Rillow is a simple ruby wrapper to zillow webservice api: http://www.zillow.com/howto/api/APIOverview.htm
 # It does the web service call and gets the result back for you.  You don't have to know about the url request, url encoding or 
 # parsing the result.  The result object is in hash/array format.  So no need to parsse xml.
@@ -16,6 +18,8 @@ require 'xmlsimple'
 # Example:
 # rillow = Rillow.new('your-zillow-service identifier')
 # result = rillow.get_search_results('2114 Bigelow Ave','Seattle, WA')
+# result.to_hash
+# result.find_attribute 'valudationRange'
 class Rillow
    @@zillow_webservice_url='http://www.zillow.com/webservice/'
    
@@ -259,12 +263,6 @@ class Rillow
    #and Zestimate for the comparable properties and the principal property for which the comparables are being retrieved. 
    #This API call also returns rich property data for the comparables.
    #see: http://www.zillow.com/howto/api/GetDeepComps.htm
-   
-   def get_deep_comps(zpid,count)
-     url_s=@@zillow_webservice_url+'GetDeepComps.htm?zws-id='+@zwsid+'&zpid='+zpid.to_s+'&count='+count.to_s
-     fetch_result(url_s)
-   end
-
    #parameters:
    #zpid The Zillow Property ID for the property for which to obtain information; the parameter type is an integer
    #count The number of comparable recent sales to obtain
@@ -272,10 +270,19 @@ class Rillow
    # rillow = Rillow.new('your-zillow-service identifier')
    # result = rillow.get_deep_comps('48749425',5)
    # result.to_hash
+   def get_deep_comps(zpid,count)
+     url_s=@@zillow_webservice_url+'GetDeepComps.htm?zws-id='+@zwsid+'&zpid='+zpid.to_s+'&count='+count.to_s
+     fetch_result(url_s)
+   end
+
    private
    def fetch_result(url_s)
       url = URI.parse(URI.escape(url_s))
       res = Net::HTTP.get_response(url)
       doc = XmlSimple.xml_in res.body
+      class<<doc
+       include RillowHelper
+      end
+      return doc
    end
 end

data/lib/rillow_helper.rb

@@ -0,0 +1,32 @@
+module RillowHelper
+ # The find_attribute helper method is to provide a easy eay to  find a attribute within the hash and array
+ # Examples: 
+ # rillow = Rillow.new ('your-zillow-service identifier')
+ # result = rillow.get_search_results('2114 Bigelow Ave','Seattle, WA')
+ # valuationRange = result.find_attribute 'valuationRange'
+ def find_attribute(key,obj=nil)
+   if obj==nil then 
+     obj=self
+   end
+   if obj.is_a? Hash then
+      obj.each { |k,v|
+        if k==key then
+          return v
+        else
+          result = find_attribute(key,v)
+          if result != nil then
+             return result
+          end
+        end
+     }
+   elsif obj.is_a? Array then
+      obj.each {|o| 
+        result  = find_attribute(key,o)
+        if result !=  nil then
+          return result       
+        end 
+      }
+   end
+   return nil
+ end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: rillow
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-10-30 00:00:00 -04:00
+  version: 0.2.0
+date: 2007-12-31 00:00:00 -05:00
 summary: Ruby wrapper api to the Zillow webservice api
 require_paths: 
 - lib
@@ -30,6 +30,7 @@ authors:
 - Leo Chan
 files: 
 - lib/rillow.rb
+- lib/rillow_helper.rb
 - README
 test_files: []