rubillow 0.0.4 → 0.0.5

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 .bundle
+.rvmrc
 pkg/*
 coverage
 doc

data/.yardopts

@@ -1,4 +1,5 @@
 --no-private
 lib/**/*.rb
 -
-LICENSE
+LICENSE
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+## 0.0.5 / 2013-01-12
+
+  * Include RentZestimate if available
+  * Check if region info exists before populating
+
+## 0.0.4 / 2012-01-31
+
+  * Check if lastSoldDate exists before parsing
+
+## 0.0.3 / 2012-01-14
+
+  * Fix GetUpdatedPropertyDetails date requirement
+  * Fix typo on method name
+  * Updated documentation
+  * Added Travis CI and dependency tracking
+  * Remove unnecessary testing dependencies
+
+## 0.0.2 / 2011-09-27
+
+  * Remove unnecessary dependencies of activesupport and i18n
+
+## 0.0.1 / 2011-08-27
+
+  * Covers all Zillow API endpoints
+  * Code documentation

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubillow (0.0.3)
+    rubillow (0.0.5)
       nokogiri (~> 1.5.0)
 
 GEM
@@ -9,7 +9,7 @@ GEM
   specs:
     bluecloth (2.1.0)
     diff-lcs (1.1.2)
-    nokogiri (1.5.0)
+    nokogiri (1.5.6)
     rake (0.9.2)
     rcov (0.9.10)
     rspec (2.6.0)

data/README.md

@@ -61,7 +61,7 @@ You should find the documentation for your version of Rubillow on [Rubygems](htt
 
 # Build & Dependency Status
 
-[![Build Status](http://travis-ci.org/synewaves/rubillow.png)](http://travis-ci.org/synewaves/rubillow)
+[![Build Status](https://travis-ci.org/synewaves/rubillow.png?branch=master)](https://travis-ci.org/synewaves/rubillow)
 [![Dependency Status](https://gemnasium.com/synewaves/rubillow.png?travis)](https://gemnasium.com/synewaves/rubillow)
 
 # License

data/lib/rubillow/home_valuation.rb

@@ -16,14 +16,16 @@ module Rubillow
     #   end
     #
     # @param [Hash] options The options for the API request.
-    # @option options [String] :address       The address of the property to search. (required)
-    # @option options [String] :citystatezip  The city+state combination and/or ZIP code for which to search. Note that giving both city and state is required. Using just one will not work. (required)
+    # @option options [String]  :address        The address of the property to search. (required)
+    # @option options [String]  :citystatezip   The city+state combination and/or ZIP code for which to search. Note that giving both city and state is required. Using just one will not work. (required)
+    # @option options [Boolean] :rentzestimate  Return Rent Zestimate information if available. Default: false
     # @return [Models::SearchResult] Property information.
     def self.search_results(options = {})
       options = {
         :zws_id => Rubillow.configuration.zwsid,
         :address => nil,
         :citystatezip => nil,
+        :rentzestimate => false,
       }.merge!(options)
     
       if options[:address].nil?
@@ -50,12 +52,14 @@ module Rubillow
     #   end
     #
     # @param [Hash] options The options for the API request.
-    # @option options [Integer] :zpid   The Zillow Property ID of the property. (required)
+    # @option options [Integer] :zpid           The Zillow Property ID of the property. (required)
+    # @option options [Boolean] :rentzestimate  Return Rent Zestimate information if available. Default: false
     # @return [Models::SearchResult] Property pricing information.
     def self.zestimate(options = {})
       options = {
         :zws_id => Rubillow.configuration.zwsid,
         :zpid => nil,
+        :rentzestimate => false,
       }.merge!(options)
       
       if options[:zpid].nil?
@@ -118,14 +122,16 @@ module Rubillow
     #   end
     #
     # @param [Hash] options The options for the API request.
-    # @option options [Integer] :zpid   The Zillow Property ID of the property. (required)
-    # @option options [Integer] :count  The number of comps to return, between 1 and 25 inclusive. (required)
+    # @option options [Integer] :zpid           The Zillow Property ID of the property. (required)
+    # @option options [Integer] :count          The number of comps to return, between 1 and 25 inclusive. (required)
+    # @option options [Boolean] :rentzestimate  Return Rent Zestimate information if available. Default: false
     # @return [Models::Comps] Comps Property information and comps list.
     def self.comps(options = {})
       options = {
         :zws_id => Rubillow.configuration.zwsid,
         :zpid => nil,
         :count => nil,
+        :rentzestimate => false,
       }.merge!(options)
     
       if options[:zpid].nil?

data/lib/rubillow/models/zestimateable.rb

@@ -43,6 +43,9 @@ module Rubillow
       
       # @return [String] region type
       attr_accessor :region_type
+
+      # @return [Hash] Rent Zestimate information (keys: :price, :last_updated, :value_change, :value_duration, :valuation_range => { :low, :high }, :percentile)
+      attr_accessor :rent_zestimate
       
       protected
       
@@ -59,20 +62,39 @@ module Rubillow
           :high => xml.xpath('//zestimate/valuationRange/high').text,
         }
         @change = xml.xpath('//zestimate/valueChange').text
+
+        if xml.xpath('//rentzestimate/amount').text.length > 0
+          @rent_zestimate = {
+            :price => xml.xpath('//rentzestimate/amount').text,
+            :last_updated => xml.xpath('//rentzestimate/last-updated').text,
+            :value_change => xml.xpath('//rentzestimate/valueChange').text,
+            :value_duration => xml.xpath('//rentzestimate/valueChange').attr('duration').value,
+            :valuation_range => {
+              :low => xml.xpath('//rentzestimate/valuationRange/low').text,
+              :high => xml.xpath('//rentzestimate/valuationRange/high').text
+            },
+            :percentile => xml.xpath('//rentzestimate/percentile').text
+          }
+        else
+          @rent_zestimate = {}
+        end
+
         if tmp = xml.xpath('//zestimate/valueChange').attr('duration')
           @change_duration = tmp.value
         end
         @percentile = xml.xpath('//zestimate/percentile').text
-        
-        @region = xml.xpath('//localRealEstate/region').attribute('name').value
-        @region_id = xml.xpath('//localRealEstate/region').attribute('id').value
-        @region_type = xml.xpath('//localRealEstate/region').attribute('type').value
-      
-        @local_real_estate = {
-          :overview => xml.xpath('//localRealEstate/region/links/overview').text,
-          :for_sale_by_owner => xml.xpath('//localRealEstate/region/links/forSaleByOwner').text,
-          :for_sale => xml.xpath('//localRealEstate/region/links/forSale').text,
-        }
+
+        if xml.at_xpath('//localRealEstate/region')
+          @region = xml.xpath('//localRealEstate/region').attribute('name').value
+          @region_id = xml.xpath('//localRealEstate/region').attribute('id').value
+          @region_type = xml.xpath('//localRealEstate/region').attribute('type').value
+
+          @local_real_estate = {
+            :overview => xml.xpath('//localRealEstate/region/links/overview').text,
+            :for_sale_by_owner => xml.xpath('//localRealEstate/region/links/forSaleByOwner').text,
+            :for_sale => xml.xpath('//localRealEstate/region/links/forSale').text,
+          }
+        end
       end
     end
   end

data/lib/rubillow/property_details.rb

@@ -17,14 +17,16 @@ module Rubillow
     #   end
     #
     # @param [Hash] options The options for the API request.
-    # @option options [String] :address       The address of the property to search. (required)
-    # @option options [String] :citystatezip  The city+state combination and/or ZIP code for which to search. Note that giving both city and state is required. Using just one will not work. (required)
+    # @option options [String]  :address        The address of the property to search. (required)
+    # @option options [String]  :citystatezip   The city+state combination and/or ZIP code for which to search. Note that giving both city and state is required. Using just one will not work. (required)
+    # @option options [Boolean] :rentzestimate  Return Rent Zestimate information if available. Default: false
     # @return [Models::DeepSearchResult] Extended property details.
     def self.deep_search_results(options = {})
       options = {
         :zws_id => Rubillow.configuration.zwsid,
         :address => nil,
         :citystatezip => nil,
+        :rentzestimate => false,
       }.merge!(options)
     
       if options[:address].nil?
@@ -53,14 +55,16 @@ module Rubillow
     #   end
     #
     # @param [Hash] options The options for the API request.
-    # @option options [Integer] :zpid   The Zillow Property ID of the property. (required)
-    # @option options [Integer] :count  The number of comps to return, between 1 and 25 inclusive. (required)
+    # @option options [Integer] :zpid           The Zillow Property ID of the property. (required)
+    # @option options [Integer] :count          The number of comps to return, between 1 and 25 inclusive. (required)
+    # @option options [Boolean] :rentzestimate  Return Rent Zestimate information if available. Default: false
     # @return [Models::DeepComps] Extended property and comp details.
     def self.deep_comps(options = {})
       options = {
         :zws_id => Rubillow.configuration.zwsid,
         :zpid => nil,
         :count => nil,
+        :rentzestimate => false,
       }.merge!(options)
     
       if options[:zpid].nil?

data/lib/rubillow/version.rb

@@ -1,4 +1,4 @@
 module Rubillow
   # @private
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/rubillow/models/search_result_spec.rb

@@ -64,5 +64,37 @@ describe Rubillow::Models::SearchResult do
     data.region.should == "East Queen Anne"
     data.region_type.should == "neighborhood"
     data.region_id.should == "271856"
+    data.rent_zestimate[:price].should == "3379"
+    data.rent_zestimate[:last_updated].should == "12/17/2012"
+    data.rent_zestimate[:value_change].should == "107"
+    data.rent_zestimate[:value_duration].should == "30"
+    data.rent_zestimate[:valuation_range][:low].should == "2154"
+    data.rent_zestimate[:valuation_range][:high].should == "5102"
   end
-end
+
+  it "populates the results from GetZestimate with missing region data" do
+    data = Rubillow::Models::SearchResult.new(get_xml('get_zestimate_missing_region.xml'))
+
+    data.zpid.should == '78264249'
+    data.links.count.should == 4
+    data.links[:homedetails].should == "http://www.zillow.com/homedetails/8663-Orchard-Loop-Rd-NE-Leland-NC-28451/78264249_zpid/"
+    data.links[:graphsanddata].should == "http://www.zillow.com/homedetails/8663-Orchard-Loop-Rd-NE-Leland-NC-28451/78264249_zpid/#charts-and-data"
+    data.links[:mapthishome].should == "http://www.zillow.com/homes/78264249_zpid/"
+    data.links[:comparables].should == "http://www.zillow.com/homes/comps/78264249_zpid/"
+    data.address[:street].should == "8663 Orchard Loop Rd NE"
+    data.address[:city].should == "Leland"
+    data.address[:state].should == "NC"
+    data.address[:zipcode].should == "28451"
+    data.address[:latitude].should == "34.217408"
+    data.address[:longitude].should == "-78.054412"
+    data.price.should == "136518"
+    data.percentile.should == "58"
+    data.last_updated.strftime("%m/%d/%Y").should == "12/27/2012"
+    data.valuation_range[:low].should == "23208"
+    data.valuation_range[:high].should == "203412"
+    data.change.should == "-1299"
+    data.change_duration.should == "30"
+    data.local_real_estate.should == nil
+    data.region.should == nil
+  end
+end

data/spec/support/have_configuration_matcher.rb

@@ -14,10 +14,17 @@ RSpec::Matchers.define :have_configuration_option do |option|
     @default = default
   end
 
-  failure_message do
+  failure_message_for_should do
     description  = "expected #{subject} to have"
     description << " configuration option #{option.inspect}"
     description << " with a default of #{@default.inspect}" if instance_variables.include?("@default")
     description
   end
+  
+  failure_message_for_should_not do
+    description  = "expected #{subject} to not have"
+    description << " configuration option #{option.inspect}"
+    description << " with a default of #{@default.inspect}" if instance_variables.include?("@default")
+    description
+  end
 end

data/spec/xml/get_zestimate.xml

@@ -36,6 +36,16 @@
       </valuationRange>
       <percentile>95</percentile>
     </zestimate>
+    <rentzestimate>
+      <amount currency="USD">3379</amount>
+      <last-updated>12/17/2012</last-updated>
+      <oneWeekChange deprecated="true"></oneWeekChange>
+      <valueChange duration="30" currency="USD">107</valueChange>
+      <valuationRange>
+        <low currency="USD">2154</low>
+        <high currency="USD">5102</high>
+      </valuationRange>
+    </rentzestimate>
     <localRealEstate>
       <region id="271856" type="neighborhood" name="East Queen Anne">
         <links>

data/spec/xml/get_zestimate_missing_region.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Zestimate:zestimate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:Zestimate="http://www.zillow.com/static/xsd/Zestimate.xsd" xsi:schemaLocation="http://www.zillow.com/static/xsd/Zestimate.xsd http://www.zillowstatic.com/vstatic/4f6d65a3e1e76db2baf166972ee9ef71/static/xsd/Zestimate.xsd">
+  <request>
+    <zpid>78264249</zpid>
+  </request>
+  <message>
+    <text>Request successfully processed</text>
+    <code>0</code>
+  </message>
+  <response>
+    <zpid>78264249</zpid>
+    <links>
+      <homedetails>http://www.zillow.com/homedetails/8663-Orchard-Loop-Rd-NE-Leland-NC-28451/78264249_zpid/</homedetails>
+      <graphsanddata>http://www.zillow.com/homedetails/8663-Orchard-Loop-Rd-NE-Leland-NC-28451/78264249_zpid/#charts-and-data</graphsanddata>
+      <mapthishome>http://www.zillow.com/homes/78264249_zpid/</mapthishome>
+      <comparables>http://www.zillow.com/homes/comps/78264249_zpid/</comparables>
+    </links>
+    <address>
+      <street>8663 Orchard Loop Rd NE</street>
+      <zipcode>28451</zipcode>
+      <city>Leland</city>
+      <state>NC</state>
+      <latitude>34.217408</latitude>
+      <longitude>-78.054412</longitude>
+    </address>
+    <zestimate>
+      <amount currency="USD">136518</amount>
+      <last-updated>12/27/2012</last-updated>
+      <oneWeekChange deprecated="true"></oneWeekChange>
+      <valueChange duration="30" currency="USD">-1299</valueChange>
+      <valuationRange>
+        <low currency="USD">23208</low>
+        <high currency="USD">203412</high>
+      </valuationRange>
+      <percentile>58</percentile>
+    </zestimate>
+    <localRealEstate></localRealEstate>
+    <regions>
+      <zipcode-id>69961</zipcode-id>
+      <city-id></city-id>
+      <county-id>2640</county-id>
+      <state-id>36</state-id>
+    </regions>
+  </response>
+</Zestimate:zestimate>
+<!-- H:001  T:15ms  S:790  R:Fri Dec 28 20:59:48 PST 2012  B:3.0.177752.20121228113358693comp_rel_a.177752.20121228113743311comp_rel_a -->

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubillow
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-31 00:00:00.000000000 Z
+date: 2013-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70347482059400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70347482059400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70347482058600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70347482058600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70347482057600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: 0.6.8
   type: :development
   prerelease: false
-  version_requirements: *70347482057600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.8
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &70347482056820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *70347482056820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70347482056320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +85,15 @@ dependencies:
         version: 0.9.10
   type: :development
   prerelease: false
-  version_requirements: *70347482056320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.10
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70347482055860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +101,12 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70347482055860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 description: Ruby library to access the Zillow API
 email:
 - rubillow@matthewvince.com
@@ -88,6 +118,7 @@ files:
 - .rspec
 - .travis.yml
 - .yardopts
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -164,6 +195,7 @@ files:
 - spec/xml/get_search_results.xml
 - spec/xml/get_updated_property_details.xml
 - spec/xml/get_zestimate.xml
+- spec/xml/get_zestimate_missing_region.xml
 - spec/xml/near_limit.xml
 homepage: https://github.com/synewaves/rubillow
 licenses: []
@@ -185,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rubillow
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby library to access the Zillow API
@@ -228,4 +260,6 @@ test_files:
 - spec/xml/get_search_results.xml
 - spec/xml/get_updated_property_details.xml
 - spec/xml/get_zestimate.xml
+- spec/xml/get_zestimate_missing_region.xml
 - spec/xml/near_limit.xml
+has_rdoc: