zester 0.1.0 → 0.2.1

data/README.md

@@ -18,6 +18,16 @@ You do not need to pass the 'zws-id' param to any api calls, this param will be
 
 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
 
+There is also an optional parameter to set the timeout in seconds, passing this will raise a Timeout::Error after that number of seconds
+
+```ruby
+zester = Zester::Client.new('your_api_key', 5)  # raises a Timeout::Error after 5 seconds with no response
+```
+
+Timeout::Errors and other Exceptions are automatically rescued in the Zester::Resource class and will return a 
+fake response telling you 'Web services are currently unavailable' in the @response.error_message method, same as any actual Zillow api error messages.
+Also, the @response.response_code will be 3.
+
 ### Home Valuation
 
 Zillow 'Home Valuation' calls are accessed off of the client#valuation method:

data/lib/zester/client.rb

@@ -5,15 +5,23 @@ module Zester
     format :xml
     base_uri "http://www.zillow.com/webservice"
 
-    attr_accessor :zws_id
+    attr_accessor :zws_id, :http_timeout
 
-    def initialize(zws_id)
+    def initialize(zws_id, http_timeout = nil)
       self.zws_id = zws_id
+      self.http_timeout = http_timeout
       self.class.default_params "zws-id" => zws_id
     end
 
     def perform_get(endpoint, params = {})
-      self.class.get("/#{endpoint}.htm", :query => params)
+      http_params = {}
+      unless params.empty?
+        http_params[:query] = params
+      end
+      unless self.http_timeout.nil?
+        http_params[:timeout] = self.http_timeout
+      end
+      self.class.get("/#{endpoint}.htm", http_params)
     end
 
     def property

data/lib/zester/resource.rb

@@ -8,7 +8,11 @@ module Zester
     end
 
     def get_results(endpoint, resource_type, params = {})
-      Response.new(self.client.perform_get(endpoint, params), resource_type)
+      begin
+        Response.new(self.client.perform_get(endpoint, params), resource_type)
+      rescue Timeout::Error, Exception
+        Response.new({resource_type => {:message => {:code => "3", :text => "Web services are currently unavailable"}}}, resource_type)
+      end
     end
 
   end

data/lib/zester/version.rb

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

data/spec/support/webmock_helper.rb

@@ -3,3 +3,7 @@ ZWS_ID = YAML.load_file(File.join(File.dirname(__FILE__), '/../zillow_api_key.ym
 def new_zester
   Zester::Client.new(ZWS_ID)
 end
+
+def new_timeout_zester
+  Zester::Client.new(ZWS_ID, 5)
+end

data/spec/zester/client_spec.rb

@@ -1,34 +1,47 @@
 require 'spec_helper'
 
 describe Zester::Client do
-  let!(:zester) {new_zester}
+  context "basic" 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 zws_id" do
+      zester.zws_id.should == ZWS_ID
+      zester.http_timeout.should be_nil
+      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 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::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 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 mortgage" do
-    zester.mortgage.should be_kind_of(Zester::Mortgage)
-    zester.mortgage.client.should == zester
+    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
 
-  it "should return an instance of Zester::Valuatiion for neighborhood" do
-    zester.neighborhood.should be_kind_of(Zester::Neighborhood)
-    zester.neighborhood.client.should == zester
+  context "timeout" do
+    let!(:zester) {new_timeout_zester}
+
+    it "should set the zws_id" do
+      zester.zws_id.should == ZWS_ID
+      zester.http_timeout.should == 5
+      zester.class.default_params.should == {'zws-id' => ZWS_ID}
+    end
   end
 end

data/spec/zester/resource_spec.rb

@@ -17,4 +17,23 @@ describe Zester::Resource do
     end
   end
 
+  context "timeout error" do
+    before(:all) do
+      VCR.turn_off!
+    end
+
+    after(:all) do
+      VCR.turn_on!
+    end
+
+    it "should rescue a timeout error" do
+      stub_request(:get, "http://www.zillow.com/webservice/GetRateSummary.htm?zws-id=#{ZWS_ID}").to_timeout
+      response = resource.get_results('GetRateSummary', :rate_summary)
+      response.success?.should be_false
+      response.message.should_not be_nil
+      response.message.code.should == "3"
+      response.response_code.should == 3
+    end
+  end
+
 end

data/spec/zester/response_spec.rb

@@ -8,7 +8,7 @@ describe Zester::Response 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.should_not be_nil
       response.message.code.should == "0"
       response.response_code.should == 0
       response.should be_instance_of(Zester::Response)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zester
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 21
   prerelease: 
   segments: 
   - 0
+  - 2
   - 1
-  - 0
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Tom Cocca
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-09 00:00:00 Z
+date: 2012-12-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime