flexmls_api 0.4.5 → 0.6.4

data/spec/unit/flexmls_api/models/note_spec.rb

@@ -2,7 +2,6 @@ require './spec/spec_helper'
 
 describe Note do
 
-
   it "responds to instance and class methods" do
     Note.should respond_to(:get)
     Note.new.should respond_to(:save)
@@ -21,48 +20,27 @@ describe Note do
     end
 
     it "should get my notes" do
-      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}#{@note.path}").
-        with(:query => {
-          :ApiSig => '8b00f10700a479b86acd03776cfea34f',
-          :AuthToken => 'c401736bf3d3f754f07c04e460e09573',
-          :ApiUser => 'foobar'
-        }).
-        to_return(:body => fixture('agent_shared_note.json'))
+      stub_api_get("#{@note.path}", 'agent_shared_note.json')
       ret = @note.get
       ret.Note.should == "lorem ipsum dolor sit amet"
     end
 
     it "should return a nil when no shared notes exist" do
-      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}#{@note.path}").
-        with(:query => {
-          :ApiSig => '8b00f10700a479b86acd03776cfea34f',
-          :AuthToken => 'c401736bf3d3f754f07c04e460e09573',
-          :ApiUser => 'foobar'
-        }).
-        to_return(:body => fixture('agent_shared_note_empty.json'))
+      stub_api_get("#{@note.path}", 'agent_shared_note_empty.json')
       @note.get.should be_nil
     end
 
     it "should allow you to delete an existing note" do
-      stub_request(:delete, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}#{@note.path}").
-        with(:query => {
-          :ApiSig => '8b00f10700a479b86acd03776cfea34f',
-          :ApiUser => 'foobar',
-          :AuthToken => 'c401736bf3d3f754f07c04e460e09573'
-        }).
-        to_return(:body => fixture('generic_delete.json'))
+      stub_api_delete("#{@note.path}", 'generic_delete.json')
       @note.new.delete # test that no exceptions are raised
     end 
 
     it "should raise an exception when adding a note fails" do
       n = @note.new(:Note => "lorem ipsum dolor")
-      stub_request(:put, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}#{@note.path}").
-        with(:query => {
-          :ApiSig => '1e8bcca11ab7307ca99463f199a58c7d',
-          :ApiUser => 'foobar', 
-          :AuthToken => 'c401736bf3d3f754f07c04e460e09573'
-        }).
-        to_return(:status => 500, :body => fixture('generic_failure.json'))
+      
+      stub_api_put("#{@note.path}", 'note_new.json') do |request|
+        request.to_return(:status => 500, :body => fixture('generic_failure.json'))
+      end
 
       expect { n.save! }.to raise_error(FlexmlsApi::ClientError) { |e| e.status.should == 500 }
       expect { n.save }.to raise_error(FlexmlsApi::ClientError) { |e| e.status.should == 500 }
@@ -70,15 +48,7 @@ describe Note do
 
     it "should allow adding of a note" do
       n = @note.new(:Note => "lorem ipsum dolor")
-
-      stub_request(:put, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}#{@note.path}").
-        with(:query => {
-          :ApiSig => '1e8bcca11ab7307ca99463f199a58c7d',
-          :ApiUser => 'foobar', 
-          :AuthToken => 'c401736bf3d3f754f07c04e460e09573'
-        }).
-        to_return(:body => fixture('add_note.json'))
-
+      stub_api_put("#{@note.path}", 'note_new.json', 'add_note.json')
       n.save
       n.ResourceUri.should == '/v1/listings/20100909200152674436000000/shared/notes/contacts/20110407212043616271000000/'
     end

data/spec/unit/flexmls_api/models/photo_spec.rb

@@ -19,7 +19,6 @@ describe Photo do
 
   end
 
-
   it "responds to" do
     @photo.should respond_to(:primary?)
     Photo.should respond_to(:find_by_listing_key)
@@ -34,26 +33,17 @@ describe Photo do
   describe "find photos by listing id"  do
     before do
       stub_auth_request
-      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234/photos").
-                   with(:query => {
-                     :ApiSig => "d060aa12d3ef573aff7298302e0237fa", 
-                     :AuthToken => "c401736bf3d3f754f07c04e460e09573",
-                     :ApiUser => "foobar"
-                   }).
-                   to_return(:body => fixture('listing_photos_index.json'))
+      stub_api_get('/listings/1234/photos', 'listing_photos_index.json')
     end
 
     it "should get an array of photos" do
       p = Photo.find_by_listing_key('1234')
       p.should be_an(Array)
     end
-
   end
 
-
   after(:each) do  
     @photo = nil
   end
 
-
 end

data/spec/unit/flexmls_api/models/saved_search_spec.rb

@@ -0,0 +1,34 @@
+require './spec/spec_helper'
+
+describe SavedSearch do
+  
+  before(:each) do
+    stub_auth_request
+  end
+
+  let(:id){ "20100815220615294367000000" }
+    
+  it "should get all SavedSearches" do
+    stub_api_get("/#{subject.class.element_name}", 'saved_search.json')
+    resources = subject.class.get
+    resources.should be_an(Array)
+    resources.length.should eq(2)
+    resources.first.Id.should eq(id)
+  end
+
+  it "should get a SavedSearch" do
+    stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_search.json')
+    resource = subject.class.find(id)
+    resource.Id.should eq(id)
+    resource.Name.should eq("Search name here")
+  end
+
+  it "should get provided SavedSearches" do
+    stub_api_get("/provided/#{subject.class.element_name}", 'saved_search.json')
+    resources = subject.class.provided.get
+    resources.should be_an(Array)
+    resources.length.should eq(2)
+    resources.first.Id.should eq(id)
+  end
+
+end

data/spec/unit/flexmls_api/models/shared_listing_spec.rb

@@ -0,0 +1,30 @@
+require './spec/spec_helper'
+
+
+describe SharedListing do
+  before(:each) do
+    stub_auth_request
+  end
+
+  it "should respond to the finders" do
+    SharedListing.should respond_to(:find)
+  end
+
+  it "should save shared listings" do
+    stub_api_post("/#{subject.class.element_name}", 'shared_listing_new.json', 'shared_listing_post.json')
+    subject.ListingIds = ["20110224152431857619000000","20110125122333785431000000"]
+    subject.ViewId = "20080125122333787615000000"
+    subject.save.should be(true)
+    subject.ResourceUri.should eq("http://www.flexmls.com/share/15Ar/3544-N-Olsen-Avenue-Tucson-AZ-85719")
+  end
+
+  it "should fail saving" do
+    stub_api_post("/#{subject.class.element_name}",'empty.json') do |request|
+      request.to_return(:status => 400, :body => fixture('errors/failure.json'))
+    end
+    subject
+    subject.save.should be(false)
+    expect{ subject.save! }.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 400 }
+  end
+  
+end

data/spec/unit/flexmls_api/models/standard_fields_spec.rb

@@ -1,42 +1,62 @@
 require './spec/spec_helper'
 
 describe StandardFields do
+  
   before(:each) do 
-    @stdfields = StandardFields.new({
-      "StreetNumber"=>{"Searchable"=>false}, 
-      "ListingId"=>{"Searchable"=>true}, 
-      "City"=>{"Searchable"=>true}, 
-      "Longitude"=>{"Searchable"=>false}, 
-      "StreetName"=>{"Searchable"=>false}, 
-      "YearBuilt"=>{"Searchable"=>true}, 
-      "BuildingAreaTotal"=>{"Searchable"=>true}, 
-      "PublicRemarks"=>{"Searchable"=>false}, 
-      "PostalCode"=>{"Searchable"=>true}, 
-      "ListPrice"=>{"Searchable"=>true}, 
-      "BathsThreeQuarter"=>{"Searchable"=>true}, 
-      "Latitude"=>{"Searchable"=>false}, 
-      "StreetDirPrefix"=>{"Searchable"=>false}, 
-      "StreetAdditionalInfo"=>{"Searchable"=>false}, 
-      "PropertyType"=>{"Searchable"=>true}, 
-      "StateOrProvince"=>{"Searchable"=>true}, 
-      "BathsTotal"=>{"Searchable"=>true}, 
-      "BathsFull"=>{"Searchable"=>true}, 
-      "ListingKey"=>{"Searchable"=>false}, 
-      "StreetDirSuffix"=>{"Searchable"=>false}, 
-      "BedsTotal"=>{"Searchable"=>true}, 
-      "ModificationTimestamp"=>{"Searchable"=>false}, 
-      "BathsHalf"=>{"Searchable"=>true}, 
-      "CountyOrParish"=>{"Searchable"=>true}
-    })
+    stub_auth_request
   end
 
+
   it "should respond to get" do
     StandardFields.should respond_to(:get)
   end
-  
 
-  after(:each) do 
-    @stdfields = nil
+
+  it "should find and expand all" do
+    StandardFields.should respond_to(:find_and_expand_all)
+    
+    # stub request to standardFields
+    stub_api_get('/standardfields','standardfields.json')
+    
+    # stub request for City
+    stub_api_get('/standardfields/City','standardfields_city.json')
+    
+    # stub request for StateOrProvince
+    stub_api_get('/standardfields/StateOrProvince','standardfields_stateorprovince.json')
+    
+    # request
+    fields = StandardFields.find_and_expand_all(["City","StateOrProvince"])
+
+    # keys are present
+    fields.should have_key("City")
+    fields.should have_key("StateOrProvince")
+    fields.should_not have_key("SubdivisionName")
+
+    # FieldList
+    fields["City"]["FieldList"].length.should eq(235)
+    fields["StateOrProvince"]["FieldList"].length.should eq(5)
+    
   end
+  
+  
+  it "should find nearby fields" do
+    StandardFields.should respond_to(:find_nearby)
+    
+    # stub request
+    stub_api_get('/standardfields/nearby/A','standardfields_nearby.json',
+      :Lat => "50",
+      :Lon => "-92",
+      :_expand => "1")
+    
+    # request
+    fields = StandardFields.find_nearby(["A"], {:Lat => 50, :Lon => -92})
+    
+    # validate response
+    fields["D"]["Success"].should eq(true)
+    fields["D"]["Results"].first.should have_key("City")
+    fields["D"]["Results"].first.should have_key("PostalCode")
+    fields["D"]["Results"].first.should have_key("StateOrProvince")
 
-end
+  end
+  
+end

data/spec/unit/flexmls_api/models/tour_of_home_spec.rb

@@ -28,13 +28,7 @@ describe TourOfHome do
 
   it "should get home tours for a listing" do
     stub_auth_request
-    stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/20060725224713296297000000/tourofhomes").
-    with( :query => {
-      :ApiSig => "153446de6d1db765d541587d34ed0fcf",
-      :AuthToken => "c401736bf3d3f754f07c04e460e09573",
-      :ApiUser => "foobar"
-    }).
-    to_return(:body => fixture('tour_of_homes.json'))
+    stub_api_get('/listings/20060725224713296297000000/tourofhomes','tour_of_homes.json')
     v = subject.class.find_by_listing_key('20060725224713296297000000')
     v.should be_an(Array)
     v.length.should == 2

data/spec/unit/flexmls_api/models/video_spec.rb

@@ -18,13 +18,7 @@ describe Video do
   describe "find videos by listing id"  do
     before do
       stub_auth_request
-      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234/videos").
-                   with(:query => {
-                     :ApiSig => "c95bfef766128b91a2643fcc2fa40dfc", 
-                     :AuthToken => "c401736bf3d3f754f07c04e460e09573",
-                     :ApiUser => "foobar"
-                   }).
-                   to_return(:body => fixture('listing_videos_index.json'))
+      stub_api_get('/listings/1234/videos','listing_videos_index.json')
     end
 
     it "should get an array of videos" do
@@ -35,7 +29,4 @@ describe Video do
 
   end
 
-
-
-
 end

data/spec/unit/flexmls_api/models/virtual_tour_spec.rb

@@ -24,13 +24,7 @@ describe VirtualTour do
 
   it "should get virtual tours for a listing" do
     stub_auth_request
-    stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234/virtualtours").
-          with( :query => { 
-            :ApiSig => "1cb60934d68b64e5eaaab4aff4b7cd3a", 
-            :AuthToken => "c401736bf3d3f754f07c04e460e09573",
-            :ApiUser => "foobar"
-          }).
-          to_return(:body => fixture('listing_virtual_tours_index.json'))
+    stub_api_get('/listings/1234/virtualtours','listing_virtual_tours_index.json')
 
     v = VirtualTour.find_by_listing_key('1234')
     v.should be_an(Array)

data/spec/unit/flexmls_api/multi_client_spec.rb

@@ -0,0 +1,48 @@
+require './spec/spec_helper'
+
+# Test client implemenations for multi client switching
+module FlexmlsApi
+  def self.test_client_a
+    Client.new(:api_key => "a")
+  end
+  def self.test_client_b
+    Client.new(:api_key => "b")
+  end
+  def self.test_client_c
+    Client.new(:api_key => "c")
+  end
+end
+
+describe FlexmlsApi::MultiClient do
+  it "should activate a client implemenation when activate()" do
+    FlexmlsApi.activate(:test_client_a)
+    FlexmlsApi.client.api_key.should eq('a')
+    FlexmlsApi.activate(:test_client_b)
+    FlexmlsApi.client.api_key.should eq('b')
+    FlexmlsApi.activate(:test_client_c)
+    FlexmlsApi.client.api_key.should eq('c')
+    FlexmlsApi.activate(:test_client_a)
+    FlexmlsApi.client.api_key.should eq('a')
+  end
+  it "should fail to activate symbols that do not have implementations" do
+    expect { FlexmlsApi.activate(:test_client_d) }.to raise_error(ArgumentError)
+  end
+  
+  it "should temporarily activate a client implemenation when activate() block" do
+    FlexmlsApi.activate(:test_client_a)
+    FlexmlsApi.client.api_key.should eq('a')
+    FlexmlsApi.activate(:test_client_b) do
+      FlexmlsApi.client.api_key.should eq('b')
+    end
+    FlexmlsApi.client.api_key.should eq('a')
+    expect do
+      FlexmlsApi.activate(:test_client_c) do
+        FlexmlsApi.client.api_key.should eq('c')
+        raise "OH MY GOODNESS I BLEW UP!!!"
+      end
+    end.to raise_error
+    FlexmlsApi.client.api_key.should eq('a')
+  end
+  
+end
+

data/spec/unit/flexmls_api/request_spec.rb

@@ -2,15 +2,38 @@ require './spec/spec_helper'
 
 describe FlexmlsApi do
   describe FlexmlsApi::ClientError do
-    subject { FlexmlsApi::ClientError.new("1234", 200) }
+    subject { FlexmlsApi::ClientError.new({:message=>"OMG FAIL", :code=>1234, :status=>500}) }
+    it "should print a helpful to_s" do
+      subject.to_s.should == "OMG FAIL"
+      subject.message.should == "OMG FAIL"
+    end
     it "should have an api code" do
-      subject.code.should == "1234"
+      subject.code.should == 1234
     end
     it "should have an http status" do
-      subject.status.should == 200
+      subject.status.should == 500
     end
     it "should raise and exception with attached message" do
-      expect { raise subject, "My Message" }.to raise_error(FlexmlsApi::ClientError){ |e| e.message.should == "My Message" }
+      expect { raise subject.class, {:message=>"My Message", :code=>1000, :status=>404}}.to raise_error(FlexmlsApi::ClientError)  do |e| 
+        e.message.should == "My Message" 
+        e.code.should == 1000
+        e.status.should == 404
+      end
+      expect { raise subject.class.new({:message=>"My Message", :code=>1000, :status=>404}) }.to raise_error(FlexmlsApi::ClientError)  do |e| 
+        e.message.should == "My Message" 
+        e.code.should == 1000
+        e.status.should == 404
+      end
+      expect { raise subject.class.new({:code=>1000, :status=>404}), "My Message"}.to raise_error(FlexmlsApi::ClientError)  do |e| 
+        e.message.should == "My Message" 
+        e.code.should == 1000
+        e.status.should == 404
+      end
+      expect { raise subject.class, "My Message"}.to raise_error(FlexmlsApi::ClientError)  do |e| 
+        e.message.should == "My Message" 
+        e.code.should be == nil
+        e.status.should be == nil
+      end
     end
   end
 
@@ -92,6 +115,14 @@ describe FlexmlsApi do
           }]}
           }'] 
         }
+        # TEST escaped paths
+        stub.get('/v1/test%20path%20with%20spaces?ApiSig=SignedToken&AuthToken=1234') { [200, {}, '{"D": {
+          "Success": true,
+          "Results": []
+          }
+          }'] 
+        }
+
       end
       @connection = test_connection(stubs)
     end  
@@ -144,6 +175,12 @@ describe FlexmlsApi do
         subject.delete('/contacts/1000').should be(nil)
         # No validation here, if no error is raised, everything is hunky dory
       end
+      
+      it "should escape a path correctly" do
+        subject.get('/test path with spaces').length.should == 0
+        # now try this with an already escaped path.  Kaboom!
+        expect { subject.get('/test%20path%20with%20spaces') }.to raise_error()
+      end
 
       it "should give me BigDecimal results for large floating point numbers" do
         MultiJson.default_engine.should eq(:yajl)
@@ -303,5 +340,5 @@ describe FlexmlsApi do
     end
     
   end
-
+  
 end