zester 0.1.0

data/.gitignore

@@ -0,0 +1,27 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+.rvmrc
+
+## PROJECT::SPECIFIC
+Gemfile.lock
+*.gem
+.bundle
+pkg/*
+spec/zillow_api_key.yml
+spec/vcr_cassettes/*.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in zester.gemspec
+gemspec
+
+group :development, :test do
+  gem "nokogiri"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Tom Cocca (http://github.com/tcocca)
+
+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/README.md

@@ -0,0 +1,142 @@
+# Zester
+
+Zester is an API wrapper written in Ruby designed to be used with multiple api keys for a system that has multiple users each with their own key.
+
+Zillow API documentation can be found here: http://www.zillow.com/howto/api/APIOverview.htm
+
+You must have a Zillow API Key (ZWSID) which you can obtain here:  https://www.zillow.com/webservice/Registration.htm
+
+## Usage
+
+Every api call can be made off of a Zester::Client so the first step is to instantiate a client:
+
+```ruby
+zester = Zester::Client.new('your_api_key')
+```
+
+You do not need to pass the 'zws-id' param to any api calls, this param will be added automatically by the client and the api key that was passed in.
+
+All other params for each api call are passed as a hash with the keys as strings in the exact same format as specified in the Zillow API docs
+
+### Home Valuation
+
+Zillow 'Home Valuation' calls are accessed off of the client#valuation method:
+
+```ruby
+zester.valuation.zestimate('zpid' => 12345)
+zester.valuation.search_results('address' => '123 Main Street', 'citystatezip' => 'Boston, MA')
+zester.valuation.chart('zpid' => 12345)
+zester.valuation.comps('zpid' => 12345)
+```
+
+The #chart call defaults to the 'unit-type' param to 'dollar', this can be overridden in the params hash.
+The #comps call defaults to the 'count' param to 10, this can be overridden in the params hash.
+
+### Property Details
+
+Zillow 'Property Details' api calls are accessed off the client#property method:
+
+```ruby
+zester.property.deep_comps('zpid' => 12345)
+zester.property.deep_search_results('address' => '123 Main Street', 'citystatezip' => 'Boston, MA')
+zester.property.updated_property_details('zpid' => 12345)
+```
+
+The #deep_comps call defaults to the 'count' param to 10, this can be overridden in the params hash.
+
+### Neighborhood Data
+
+Zillow 'Neighborhood Data' api calls are accessed off the client#neighborhood method:
+
+```ruby
+zester.neighborhood.demographics('state' => 'MA', 'city' => 'Boston')
+zester.neighborhood.region_children('regionID' => 123, 'state' => 'MA')
+zester.neighborhood.region_chart('state' => 'MA')
+```
+
+The #region_chart call defaults to the 'unit-type' param to 'dollar', this can be overridden in the params hash.
+
+### Mortgage Rates
+
+Zillow 'Mortgage Rates' api calls are accessed off the client#mortgage method:
+
+```ruby
+zester.mortgage.rate_summary('MA')
+```
+
+The #rate_summary method does not take a params hash, instead it only takes an optional state param as a string.  This is the only param that applies.
+
+#### Responses
+
+Each API call method returns a Zester::Response instance.  Zester::Response converts the XML response into a Hashie::Rash (http://github.com/tcocca/rash) object which basically takes the hash returned by MultiXml and converts that into an object so that you can use dot notation to access the keys/values as methods.  Rash converts the keys from camelCase into underscore_case to make it more ruby-esque.
+
+Zester::Response also provides a nice method missing to make getting at the values from the xml easier.  The method missing works off of the <response> node of the xml.  So in the following example:
+
+```xml
+<?xml version="1.0" encoding="utf-8" ?> 
+<Chart:chart xmlns:Chart="http://www.zillow.com/vstatic/3/static/xsd/Chart.xsd">
+  <request>
+    <zpid>48749425</zpid> 
+    <unit-type>percent</unit-type> 
+    <width>300</width> 
+    <height>150</height> 
+  </request>
+  <message>
+    <text>Request successfully processed</text> 
+    <code>0</code> 
+  </message>
+  <response>
+    <url>http://www.zillow.com/app?chartDuration=1year&chartType=partner&height=150&page=webservice%2FGetChart&service=chart&showPercent=true&width=300&zpid=48749425</url> 
+  </response>
+</Chart:chart>
+<!-- H:11  T:1ms  S:311 --> 
+``` 
+
+Which is response from a call to zester.valuation.chart (http://www.zillow.com/howto/api/GetChart.htm) you have the following:
+
+```ruby
+response = zester.valuation.chart('zpid' => '48749425')
+response.success? #=> true
+response.response_code #=> 0
+response.url #=> http://www.zillow.com/app?chartDuration=1year&chartType=partner&height=150&page=webservice%2FGetChart&service=chart&showPercent=true&width=300&zpid=48749425
+```
+
+So, anything inside the <response> node can be accessed directly by the method missing.
+
+You can still get at anything in the xml by accessing the key off of the body:
+
+```ruby
+response.body.message
+response.body.message.text
+response.body.request
+response.body.response
+response.body.response.url
+```
+
+Zester::Response also provides a fea extra helper methods:
+
+```ruby
+response.response_code #=> returns response.body.message.code.to_i
+response.success? #=> returns true if response_code == 0
+response.error_message #=> returns response.body.message.text
+response.near_limit? #=> returns true of response.body.message.limit_warning == 'true'
+```
+
+## TODO
+
+* Support the Mortgage Calculator api calls
+* Create YARD documentation
+
+## Contributing to Zester
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Tom Cocca (http://github.com/tcocca). See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/lib/zester/client.rb

@@ -0,0 +1,36 @@
+module Zester
+  class Client
+
+    include HTTParty
+    format :xml
+    base_uri "http://www.zillow.com/webservice"
+
+    attr_accessor :zws_id
+
+    def initialize(zws_id)
+      self.zws_id = zws_id
+      self.class.default_params "zws-id" => zws_id
+    end
+
+    def perform_get(endpoint, params = {})
+      self.class.get("/#{endpoint}.htm", :query => params)
+    end
+
+    def property
+      @property = Zester::Property.new(self)
+    end
+
+    def mortgage
+      @mortgage = Zester::Mortgage.new(self)
+    end
+
+    def valuation
+      @valuation = Zester::Valuation.new(self)
+    end
+
+    def neighborhood
+      @neighborhood = Zester::Neighborhood.new(self)
+    end
+
+  end
+end

data/lib/zester/mortgage.rb

@@ -0,0 +1,9 @@
+module Zester
+  class Mortgage < Resource
+
+    def rate_summary(state = nil)
+      get_results('GetRateSummary', :rate_summary, {'state' => state})
+    end
+
+  end
+end

data/lib/zester/neighborhood.rb

@@ -0,0 +1,27 @@
+module Zester
+  class Neighborhood < Resource
+
+    def demographics(params = {})
+      if params['regionid'].nil? && 
+        (params['state'].nil? || params['city'].nil?) && 
+        (params['city'].nil? || params['neighborhood'].nil?) && 
+        params['zip'].nil?
+        raise ArgumentError, "At least rid or state & city or city & neighborhood or zip is required"
+      end
+      get_results('GetDemographics', :demographics, params)
+    end
+
+    def region_children(params = {})
+      if params['regionId'].nil? && params['state'].nil?
+        raise ArgumentError, "At least region_id or state is required"
+      end
+      get_results('GetRegionChildren', :regionchildren, params)
+    end
+
+    def region_chart(params = {})
+      params['unit-type'] ||= 'dollar'
+      get_results('GetRegionChart', :regionchart, params)
+    end
+
+  end
+end

data/lib/zester/property.rb

@@ -0,0 +1,27 @@
+module Zester
+  class Property < Resource
+
+    def deep_comps(params = {})
+      if params['zpid'].nil?
+        raise ArgumentError, "zpid is required"
+      end
+      params['count'] ||= 10
+      get_results('GetDeepComps', :comps, params)
+    end
+
+    def deep_search_results(params = {})
+      if params['address'].nil? || params['citystatezip'].nil?
+        raise ArgumentError, "address and citystatezip are required"
+      end
+      get_results('GetDeepSearchResults', :searchresults, params)
+    end
+
+    def updated_property_details(params = {})
+      if params['zpid'].nil?
+        raise ArgumentError, "zpid is required"
+      end
+      get_results('GetUpdatedPropertyDetails', :updated_property_details, params)
+    end
+
+  end
+end

data/lib/zester/resource.rb

@@ -0,0 +1,15 @@
+module Zester
+  class Resource
+
+    attr_accessor :client
+
+    def initialize(client)
+      self.client = client
+    end
+
+    def get_results(endpoint, resource_type, params = {})
+      Response.new(self.client.perform_get(endpoint, params), resource_type)
+    end
+
+  end
+end

data/lib/zester/response.rb

@@ -0,0 +1,47 @@
+module Zester
+  class Response
+
+    attr_accessor :body
+
+    def initialize(response_body, response_type)
+      self.body = Hashie::Rash.new(response_body).send(response_type)
+    end
+
+    def success?
+      !self.response_code.nil? &&  self.response_code == 0
+    end
+
+    def error_message
+      self.message.text if self.message && self.message.text
+    end
+
+    def response_code
+      self.message.code.to_i if self.message && self.message.code
+    end
+
+    def near_limit?
+      self.message && self.message.limit_warning && self.message.limit_warning == "true"
+    end
+
+    def message
+      self.body.message if self.body.respond_to?(:message)
+    end
+
+    def method_missing(method_name, *args)
+      if self.body.respond_to?(:response) && self.body.response.respond_to?(method_name)
+        self.body.response.send(method_name)
+      else
+        super
+      end
+    end
+
+    def respond_to?(method_name)
+      if self.body.respond_to?(:response) && self.body.response.respond_to?(method_name)
+        true
+      else
+        super
+      end
+    end
+
+  end
+end

data/lib/zester/valuation.rb

@@ -0,0 +1,35 @@
+module Zester
+  class Valuation < Resource
+
+    def zestimate(params = {})
+      if params['zpid'].nil?
+        raise ArgumentError, "zpid is required"
+      end
+      get_results('GetZestimate', :zestimate, params)
+    end
+
+    def search_results(params = {})
+      if params['address'].nil? || params['citystatezip'].nil?
+        raise ArgumentError, "address and citystatezip are required"
+      end
+      get_results('GetSearchResults', :searchresults, params)
+    end
+
+    def chart(params = {})
+      if params['zpid'].nil?
+        raise ArgumentError, "zpid is required"
+      end
+      params['unit-type'] ||= 'dollar'
+      get_results('GetChart', :chart, params)
+    end
+
+    def comps(params = {})
+      if params['zpid'].nil?
+        raise ArgumentError, "zpid is required"
+      end
+      params['count'] ||= 10
+      get_results('GetComps', :comps, params)
+    end
+
+  end
+end

data/lib/zester/version.rb

@@ -0,0 +1,3 @@
+module Zester
+  VERSION = "0.1.0"
+end

data/lib/zester.rb

@@ -0,0 +1,9 @@
+require 'httparty'
+require 'rash'
+require 'zester/client'
+require 'zester/resource'
+require 'zester/response'
+require 'zester/mortgage'
+require 'zester/neighborhood'
+require 'zester/property'
+require 'zester/valuation'

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rspec'
+require 'zester'
+require 'webmock/rspec'
+require 'vcr'
+
+MultiXml.parser = :nokogiri
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.hook_into :webmock
+  c.default_cassette_options = { :record => :new_episodes }
+end

data/spec/support/webmock_helper.rb

@@ -0,0 +1,5 @@
+ZWS_ID = YAML.load_file(File.join(File.dirname(__FILE__), '/../zillow_api_key.yml'))["zws_id"]
+
+def new_zester
+  Zester::Client.new(ZWS_ID)
+end

data/spec/zester/client_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Zester::Client do
+  let!(:zester) {new_zester}
+
+  it "should set the zws_id" do
+    zester.zws_id.should == ZWS_ID
+    zester.class.default_params.should == {'zws-id' => ZWS_ID}
+  end
+
+  it "should set the base uri for the client" do
+    zester.class.base_uri.should == "http://www.zillow.com/webservice"
+  end
+
+  it "should return an instance of Zester::Valuation for valuation" do
+    zester.valuation.should be_kind_of(Zester::Valuation)
+    zester.valuation.client.should == zester
+  end
+
+  it "should return an instance of Zester::Valuatiion for property" do
+    zester.property.should be_kind_of(Zester::Property)
+    zester.property.client.should == zester
+  end
+
+  it "should return an instance of Zester::Valuatiion for mortgage" do
+    zester.mortgage.should be_kind_of(Zester::Mortgage)
+    zester.mortgage.client.should == zester
+  end
+
+  it "should return an instance of Zester::Valuatiion for neighborhood" do
+    zester.neighborhood.should be_kind_of(Zester::Neighborhood)
+    zester.neighborhood.client.should == zester
+  end
+end

data/spec/zester/mortgage_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Zester::Mortgage do
+  let!(:zester) {new_zester}
+  let!(:mortgage) {zester.mortgage}
+
+  context "rate_summary" do
+    it "should be a success" do
+      VCR.use_cassette('mortgage') do
+        response = mortgage.rate_summary
+        response.success?.should be_true
+        response.today.should_not be_nil
+        response.last_week.should_not be_nil
+      end
+    end
+
+    it "should be a failure" do
+      VCR.use_cassette('mortgage') do
+        response = mortgage.rate_summary('XZ')
+        response.success?.should be_false
+        response.response_code.should ==  501
+        response.error_message.should_not be_nil
+        response.should_not respond_to(:today)
+        response.should_not respond_to(:last_week)
+      end
+    end
+  end
+
+end

data/spec/zester/neighborhood_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe Zester::Neighborhood do
+  let!(:zester) {new_zester}
+  let!(:neighborhood) {zester.neighborhood}
+
+  context "demographics" do
+    it "should check for required params" do
+      VCR.use_cassette('neighborhood') do
+        expect {neighborhood.demographics}.to raise_error(ArgumentError, "At least rid or state & city or city & neighborhood or zip is required")
+        expect {neighborhood.demographics('regionid' => 'MA')}.to_not raise_error(ArgumentError)
+        expect {neighborhood.demographics('state' => 'MA')}.to raise_error(ArgumentError, "At least rid or state & city or city & neighborhood or zip is required")
+        expect {neighborhood.demographics('city' => 'Boston')}.to raise_error(ArgumentError, "At least rid or state & city or city & neighborhood or zip is required")
+        expect {neighborhood.demographics('neighborhood' => 'Back Bay')}.to raise_error(ArgumentError, "At least rid or state & city or city & neighborhood or zip is required")
+        expect {neighborhood.demographics('zip' => '02118')}.to_not raise_error(ArgumentError)
+        expect {neighborhood.demographics('state' => 'MA', 'city' => 'Boston')}.to_not raise_error(ArgumentError)
+        expect {neighborhood.demographics('city' => 'Boston', 'neighborhood' => 'Back Bay')}.to_not raise_error(ArgumentError)
+      end
+    end
+
+    it "should return a success" do
+      VCR.use_cassette('neighborhood') do
+        response = neighborhood.demographics('state' => 'MA', 'city' => 'Boston')
+        response.success?.should be_true
+        response.region.should_not be_nil
+        response.pages.should_not be_nil
+        response.market.should_not be_nil
+        response.links.should_not be_nil
+        response.charts.should_not be_nil
+      end
+    end
+
+    it "should return a failure" do
+      VCR.use_cassette('neighborhood') do
+        response = neighborhood.demographics('regionid' => 'MA')
+        response.success?.should be_false
+        response.response_code.should ==  500
+        response.error_message.should_not be_nil
+        response.should_not respond_to(:region)
+        response.should_not respond_to(:pages)
+        response.should_not respond_to(:market)
+        response.should_not respond_to(:links)
+        response.should_not respond_to(:charts)
+      end
+    end
+  end
+
+  context "region_children" do
+    it "should check for required params" do
+      VCR.use_cassette('neighborhood') do
+        expect {neighborhood.region_children}.to raise_error(ArgumentError, "At least region_id or state is required")
+        expect {neighborhood.region_children('state' => 'MA')}.to_not raise_error(ArgumentError)
+        expect {neighborhood.region_children('regionId' => 'MA')}.to_not raise_error(ArgumentError)
+      end
+    end
+
+    it "should return a success" do
+      VCR.use_cassette('neighborhood') do
+        response = neighborhood.region_children('state' => 'MA')
+        response.success?.should be_true
+        response.region.should_not be_nil
+        response.subregiontype.should_not be_nil
+        response.list.should_not be_nil
+      end
+    end
+
+    it "should return a failure" do
+      VCR.use_cassette('neighborhood') do
+        response = neighborhood.region_children('state' => 'YZ')
+        response.success?.should be_false
+        response.response_code.should ==  502
+        response.error_message.should_not be_nil
+        response.should_not respond_to(:region)
+        response.should_not respond_to(:subregiontype)
+        response.should_not respond_to(:list)
+      end
+    end
+  end
+
+  context "region_chart" do
+    it "should not require any params" do
+      VCR.use_cassette('neighborhood') do
+        expect {neighborhood.region_chart}.to_not raise_error(ArgumentError)
+        expect {neighborhood.region_chart('unit-type' => 'dollar')}.to_not raise_error(ArgumentError)
+      end
+    end
+
+    it "should return a success" do
+      VCR.use_cassette('neighborhood') do
+        response = neighborhood.region_chart('unit-type' => 'dollar')
+        response.success?.should be_true
+        response.zindex.should_not be_nil
+        response.url.should_not be_nil
+        response.links.should_not be_nil
+      end
+    end
+
+    it "should return a failure" do
+      VCR.use_cassette('neighborhood') do
+        response = neighborhood.region_chart('unit-type' => 'none')
+        response.success?.should_not be_true
+        response.response_code.should ==  502
+        response.error_message.should_not be_nil
+        response.should_not respond_to(:zindex)
+        response.should_not respond_to(:url)
+        response.should_not respond_to(:links)
+      end
+    end
+  end
+
+end

data/spec/zester/property_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Zester::Property do
+  let!(:zester) {new_zester}
+  let!(:property) {zester.property}
+
+  context "deep_comps" do
+    it "should check for required params" do
+      VCR.use_cassette('property') do
+        expect {property.deep_comps}.to raise_error(ArgumentError, "zpid is required")
+        expect {property.deep_comps('zpid' => '12345')}.to_not raise_error(ArgumentError)
+      end
+    end
+
+    it "should return a success" do
+      VCR.use_cassette('property') do
+        response = property.deep_comps('zpid' => '48749425')
+        response.success?.should be_true
+        response.properties.should_not be_nil
+      end
+    end
+
+    it "should return a failure" do
+      VCR.use_cassette('property') do
+        response = property.deep_comps('zpid' => 'xyz')
+        response.success?.should be_false
+        response.response_code.should ==  500
+        response.error_message.should_not be_nil
+        response.should_not respond_to(:properties)
+      end
+    end
+  end
+
+  context "deep_search_results" do
+    it "should check for required params" do
+      VCR.use_cassette('property') do
+        expect {property.deep_search_results}.to raise_error(ArgumentError, "address and citystatezip are required")
+        expect {property.deep_search_results('address' => '2114 Bigelow Ave', 'citystatezip' => 'Seattle, WA')}.to_not raise_error(ArgumentError)
+      end
+    end
+
+    it "should return a success" do
+      VCR.use_cassette('property') do
+        response = property.deep_search_results('address' => '2114 Bigelow Ave', 'citystatezip' => 'Seattle, WA')
+        response.success?.should be_true
+        response.results.should_not be_nil
+      end
+    end
+
+    it "should return a failure" do
+      VCR.use_cassette('property') do
+        response = property.deep_search_results('address' => '2114 Bigelow Ave', 'citystatezip' => '123')
+        response.success?.should be_false
+        response.response_code.should ==  508
+        response.error_message.should_not be_nil
+        response.should_not respond_to(:results)
+      end
+    end
+  end
+
+  context "updated_property_details" do
+    it "should check for required params" do
+      VCR.use_cassette('property') do
+        expect {property.updated_property_details}.to raise_error(ArgumentError, "zpid is required")
+        expect {property.updated_property_details('zpid' => '12345')}.to_not raise_error(ArgumentError)
+      end
+    end
+
+    it "should return a success" do
+      VCR.use_cassette('property') do
+        response = property.updated_property_details('zpid' => '48749425')
+        response.success?.should be_true
+        response.zpid.should_not be_nil
+        response.page_view_count.should_not be_nil
+        response.address.should_not be_nil
+        response.links.should_not be_nil
+        response.edited_facts.should_not be_nil
+        response.neighborhood.should_not be_nil
+        response.school_district.should_not be_nil
+        response.elementary_school.should_not be_nil
+        response.middle_school.should_not be_nil
+      end
+    end
+
+    it "should return a failure" do
+      VCR.use_cassette('property') do
+        response = property.updated_property_details('zpid' => 'xyz')
+        response.success?.should be_false
+        response.response_code.should ==  500
+        response.error_message.should_not be_nil
+        response.should_not respond_to(:address)
+        response.should_not respond_to(:links)
+        response.should_not respond_to(:edited_facts)
+        response.should_not respond_to(:neighborhood)
+        response.should_not respond_to(:school_district)
+        response.should_not respond_to(:elementary_school)
+        response.should_not respond_to(:middle_school)
+      end
+    end
+  end
+
+end

data/spec/zester/resource_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Zester::Resource do
+  let!(:zester) {new_zester}
+  let!(:resource) {Zester::Resource.new(zester)}
+
+  it "should instantiate with a client" do
+    resource.client.should_not be_nil
+  end
+
+  context "get_results" do
+    it "should return a response" do
+      VCR.use_cassette('resource') do
+        response = resource.get_results('GetRateSummary', :rate_summary)
+        response.should be_instance_of(Zester::Response)
+      end
+    end
+  end
+
+end

data/spec/zester/response_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Zester::Response do
+  let!(:zester) {new_zester}
+  let!(:resource) {Zester::Resource.new(zester)}
+
+  it "should return a success" do
+    VCR.use_cassette('response') do
+      response = resource.get_results('GetRateSummary', :rate_summary)
+      response.success?.should be_true
+      response.message.should_not be_nill
+      response.message.code.should == "0"
+      response.response_code.should == 0
+      response.should be_instance_of(Zester::Response)
+      response.body.should be_instance_of(Hashie::Rash)
+    end
+  end
+
+  it "should return a failure" do
+    VCR.use_cassette('response') do
+      response = resource.get_results('GetRateSummary', :rate_summary, {'state' => 'XZ'})
+      response.success?.should be_false
+      response.error_message.should_not be_nil
+      response.message.code.should == "501"
+      response.response_code.should == 501
+    end
+  end
+
+  context "respond_to?" do
+    it "should respond to methods called from body.response" do
+      VCR.use_cassette('response') do
+        response = resource.get_results('GetRateSummary', :rate_summary)
+        response.should respond_to(:today)
+        response.should respond_to(:last_week)
+      end
+    end
+
+    it "should not respond to methods called off body.response" do
+      VCR.use_cassette('response') do
+        response = resource.get_results('GetRateSummary', :rate_summary, {'state' => 'XZ'})
+        response.should_not respond_to(:today)
+        response.should_not respond_to(:last_week)
+      end
+    end
+  end
+
+  context "method_missing" do
+    it "should call methods off of the body.response" do
+      VCR.use_cassette('response') do
+        response = resource.get_results('GetRateSummary', :rate_summary)
+        response.today.should == response.body.response.today
+      end
+    end
+
+    it "should raise errors when the method does not exist" do
+      VCR.use_cassette('response') do
+        response = resource.get_results('GetRateSummary', :rate_summary, {'state' => 'XZ'})
+        expect {response.today}.to raise_error(NoMethodError)
+        expect {response.last_week}.to raise_error(NoMethodError)
+      end
+    end
+  end
+
+end

data/spec/zester/valuation_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe Zester::Valuation do
+  let!(:zester) {new_zester}
+  let!(:valuation) {zester.valuation}
+
+  context "zestimate" do
+    it "should check for required params" do
+      VCR.use_cassette('valuation') do
+        expect {valuation.zestimate}.to raise_error(ArgumentError, "zpid is required")
+        expect {valuation.zestimate('zpid' => '12345')}.to_not raise_error(ArgumentError)
+      end
+    end
+
+    it "should return a success" do
+      VCR.use_cassette('valuation') do
+        response = valuation.zestimate('zpid' => '48749425')
+        response.success?.should be_true
+        response.zpid.should_not be_nil
+        response.links.should_not be_nil
+        response.address.should_not be_nil
+        response.zestimate.should_not be_nil
+        response.local_real_estate.should_not be_nil
+        response.regions.should_not be_nil
+      end
+    end
+
+    it "should return a failure" do
+      VCR.use_cassette('valuation') do
+        response = valuation.zestimate('zpid' => 'xyz')
+        response.success?.should be_false
+        response.response_code.should ==  500
+        response.error_message.should_not be_nil
+        response.should_not respond_to(:zpid)
+        response.should_not respond_to(:links)
+        response.should_not respond_to(:address)
+        response.should_not respond_to(:zestimate)
+        response.should_not respond_to(:local_real_estate)
+        response.should_not respond_to(:regions)
+      end
+    end
+  end
+
+  context "search_results" do
+    it "should check for required params" do
+      VCR.use_cassette('valuation') do
+        expect {valuation.search_results}.to raise_error(ArgumentError, "address and citystatezip are required")
+        expect {valuation.search_results('address' => '2114 Bigelow Ave', 'citystatezip' => 'Seattle, WA')}.to_not raise_error(ArgumentError)
+      end
+    end
+
+    it "should return a success" do
+      VCR.use_cassette('valuation') do
+        response = valuation.search_results('address' => '2114 Bigelow Ave', 'citystatezip' => 'Seattle, WA')
+        response.success?.should be_true
+        response.results.should_not be_nil
+      end
+    end
+
+    it "should return a failure" do
+      VCR.use_cassette('valuation') do
+        response = valuation.search_results('address' => '2114 Bigelow Ave', 'citystatezip' => '123')
+        response.success?.should be_false
+        response.response_code.should ==  508
+        response.error_message.should_not be_nil
+        response.should_not respond_to(:results)
+      end
+    end
+  end
+
+  context "chart" do
+    it "should check for required params" do
+      VCR.use_cassette('valuation') do
+        expect {valuation.chart}.to raise_error(ArgumentError, "zpid is required")
+        expect {valuation.chart('zpid' => '12345')}.to_not raise_error(ArgumentError)
+      end
+    end
+
+    it "should return a success" do
+      VCR.use_cassette('valuation') do
+        response = valuation.chart('zpid' => '48749425')
+        response.success?.should be_true
+        response.url.should_not be_nil
+        response.graphsanddata.should_not be_nil
+      end
+    end
+
+    it "should return a failure" do
+      VCR.use_cassette('valuation') do
+        response = valuation.chart('zpid' => 'xyz')
+        response.success?.should be_false
+        response.response_code.should ==  500
+        response.error_message.should_not be_nil
+        response.should_not respond_to(:url)
+        response.should_not respond_to(:graphsanddata)
+      end
+    end
+  end
+
+  context "comps" do
+    it "should check for required params" do
+      VCR.use_cassette('valuation') do
+        expect {valuation.comps}.to raise_error(ArgumentError, "zpid is required")
+        expect {valuation.comps('zpid' => '12345')}.to_not raise_error(ArgumentError)
+      end
+    end
+
+    it "should return a success" do
+      VCR.use_cassette('valuation') do
+        response = valuation.comps('zpid' => '48749425')
+        response.success?.should be_true
+        response.properties.should_not be_nil
+      end
+    end
+
+    it "should return a failure" do
+      VCR.use_cassette('valuation') do
+        response = valuation.comps('zpid' => 'xyz')
+        response.success?.should be_false
+        response.response_code.should ==  500
+        response.error_message.should_not be_nil
+        response.should_not respond_to(:properties)
+      end
+    end
+  end
+
+end

data/spec/zillow_api_key.yml.example

@@ -0,0 +1 @@
+zws_id: you_zillow_api_key

data/zester.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "zester/version"
+
+Gem::Specification.new do |s|
+  s.name        = "zester"
+  s.version     = Zester::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tom Cocca"]
+  s.email       = ["tom.cocca@gmail.com"]
+  s.homepage    = "http://github.com/tcocca/zester"
+  s.summary     = %q{Ruby wrapper for the Zillow API}
+  s.description = %q{Ruby API wrapper for Zillow API built with httparty designed for multiple keys}
+
+  s.rubyforge_project = "zester"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'multi_xml', '~> 0.5.0'
+  s.add_dependency 'httparty', '~> 0.8.3'
+  s.add_dependency "rash", "~> 0.3.2"
+  s.add_development_dependency "rake", "~> 0.9.2"
+  s.add_development_dependency "rspec", "~> 2.10.0"
+  s.add_development_dependency "webmock", "~> 1.8.6"
+  s.add_development_dependency "vcr", "~> 2.1.1"
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification 
+name: zester
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tom Cocca
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  version_requirements: *id001
+  name: multi_xml
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 8
+        - 3
+        version: 0.8.3
+  version_requirements: *id002
+  name: httparty
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 3
+        - 2
+        version: 0.3.2
+  version_requirements: *id003
+  name: rash
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  version_requirements: *id004
+  name: rake
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 2
+        - 10
+        - 0
+        version: 2.10.0
+  version_requirements: *id005
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 1
+        - 8
+        - 6
+        version: 1.8.6
+  version_requirements: *id006
+  name: webmock
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  version_requirements: *id007
+  name: vcr
+description: Ruby API wrapper for Zillow API built with httparty designed for multiple keys
+email: 
+- tom.cocca@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/zester.rb
+- lib/zester/client.rb
+- lib/zester/mortgage.rb
+- lib/zester/neighborhood.rb
+- lib/zester/property.rb
+- lib/zester/resource.rb
+- lib/zester/response.rb
+- lib/zester/valuation.rb
+- lib/zester/version.rb
+- spec/spec_helper.rb
+- spec/support/webmock_helper.rb
+- spec/zester/client_spec.rb
+- spec/zester/mortgage_spec.rb
+- spec/zester/neighborhood_spec.rb
+- spec/zester/property_spec.rb
+- spec/zester/resource_spec.rb
+- spec/zester/response_spec.rb
+- spec/zester/valuation_spec.rb
+- spec/zillow_api_key.yml.example
+- zester.gemspec
+homepage: http://github.com/tcocca/zester
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: zester
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Zillow API
+test_files: 
+- spec/spec_helper.rb
+- spec/support/webmock_helper.rb
+- spec/zester/client_spec.rb
+- spec/zester/mortgage_spec.rb
+- spec/zester/neighborhood_spec.rb
+- spec/zester/property_spec.rb
+- spec/zester/resource_spec.rb
+- spec/zester/response_spec.rb
+- spec/zester/valuation_spec.rb
+- spec/zillow_api_key.yml.example