flexmls_api 0.3.6 → 0.4.5

data/spec/unit/flexmls_api/authentication_spec.rb

@@ -1,6 +1,14 @@
 require './spec/spec_helper'
 
 describe FlexmlsApi::Authentication do
+  before(:all) do
+    FlexmlsApi.reset
+  end
+  
+  after(:all) do
+    reset_config
+  end
+
   it "should give me a session object" do
     stub_auth_request
     stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/session/c401736bf3d3f754f07c04e460e09573").
@@ -12,7 +20,7 @@ describe FlexmlsApi::Authentication do
     client = FlexmlsApi.client
     stub_auth_request
     session = client.get "/session/c401736bf3d3f754f07c04e460e09573"
-    session[0]["AuthToken"].should eq "c401736bf3d3f754f07c04e460e09573"
+    session[0]["AuthToken"].should eq("c401736bf3d3f754f07c04e460e09573")
   end
   it "should delete a session" do
     stub_auth_request
@@ -24,7 +32,7 @@ describe FlexmlsApi::Authentication do
       to_return(:body => fixture("success.json"))
     client = FlexmlsApi.client
     client.logout
-    client.session.should eq nil
+    client.session.should eq(nil)
   end
 
 end

data/spec/unit/flexmls_api/configuration_spec.rb

@@ -1,8 +1,8 @@
 require './spec/spec_helper'
 
 describe FlexmlsApi::Client, "Client config"  do
-  after(:each) do
-    FlexmlsApi.reset
+  after(:all) do
+    reset_config
   end
 
   describe "default settings" do

data/spec/unit/flexmls_api/faraday_spec.rb

@@ -27,11 +27,7 @@ describe FlexmlsApi do
           }]}
           }'] 
         }
-        stub.get('/expired') { [401, {}, '{"D": { 
-            "Success": false,
-            "Message": "Session token has expired",
-            "Code": 1020            
-          }}'] 
+        stub.get('/expired') { [401, {}, fixture('errors/expired.json')] 
         }
         stub.get('/methodnotallowed') { [405, {}, '{"D": { 
             "Success": false,
@@ -65,8 +61,8 @@ describe FlexmlsApi do
 
     it "should raised exception on error" do
       expect { @connection.get('/methodnotallowed')}.to raise_error(FlexmlsApi::NotAllowed){ |e| e.message.should == "Method Not Allowed" }
-      expect { @connection.get('/epicfail')}.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should be 500 }
-      expect { @connection.get('/unknownerror')}.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should be 499 }
+      expect { @connection.get('/epicfail')}.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should be(500) }
+      expect { @connection.get('/unknownerror')}.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should be(499) }
     end
 
     it "should raised exception on invalid responses" do

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

@@ -33,7 +33,7 @@ describe Base, "Base model" do
     describe "finders" do
       before(:all) do
         stubs = Faraday::Adapter::Test::Stubs.new do |stub|
-          stub.get('/v1/test/example?ApiSig=0637dccf93be3774c9c7c554bb0b1d9a&AuthToken=1234') { [200, {}, '{"D": {
+          stub.get('/v1/test/example?ApiSig=9fd7299fc210d0c3dcc24782d9cb7894&ApiUser=foobar&AuthToken=1234') { [200, {}, '{"D": {
             "Success": true, 
             "Results": [{
               "Id": 1,

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

@@ -11,9 +11,9 @@ end
 describe Contact do
   before(:all) do
     stubs = Faraday::Adapter::Test::Stubs.new do |stub|
-      stub.get('/v1/contacts?ApiSig=735774295be070a27f7cf859fde90740&AuthToken=1234') { [200, {}, fixture('contacts.json')] 
+      stub.get('/v1/contacts?ApiSig=33e3b6d6436c85c3f9944d21f6f0cf9a&ApiUser=foobar&AuthToken=1234') { [200, {}, fixture('contacts.json')] 
       }
-      stub.post('/v1/contacts?ApiSig=7f0a7b0f648f87aabd4d4393913a10ba&AuthToken=1234', '{"D":{"Contacts":[{"DisplayName":"Contact Four","PrimaryEmail":"contact4@fbsdata.com"}]}}') { [201, {}, '{"D": {
+      stub.post('/v1/contacts?ApiSig=1c78fb9f798fbb739a0b8152528cd453&ApiUser=foobar&AuthToken=1234', '{"D":{"Contacts":[{"DisplayName":"Contact Four","PrimaryEmail":"contact4@fbsdata.com"}]}}') { [201, {}, '{"D": {
         "Success": true, 
         "Results": [
           {
@@ -21,7 +21,7 @@ describe Contact do
           }]}
         }'] 
       }
-      stub.post('/v1/contacts?ApiSig=76f6ee7032f7038d737f9b73457f06e2&AuthToken=1234', '{"D":{"Contacts":[{}]}}') { [400, {}, '{"D": {
+      stub.post('/v1/contacts?ApiSig=ea132fe27a8deb7d6c096b102972ce3e&ApiUser=foobar&AuthToken=1234', '{"D":{"Contacts":[{}]}}') { [400, {}, '{"D": {
         "Success": false}
         }'] 
       }
@@ -29,6 +29,10 @@ describe Contact do
     Contact.connection = mock_client(stubs)
   end
   
+  it "should include the finders module" do
+    Contact.should respond_to(:find)
+  end
+
   it "should get all my contacts" do
     contacts = Contact.get
     contacts.should be_an(Array)
@@ -53,7 +57,7 @@ describe Contact do
   context "on an epic fail" do
     before(:all) do
       stubs = Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.post('/v1/contacts?ApiSig=76f6ee7032f7038d737f9b73457f06e2&AuthToken=1234', '{"D":{"Contacts":[{}]}}') { [500, {}, '{"D": {
+        stub.post('/v1/contacts?ApiSig=ea132fe27a8deb7d6c096b102972ce3e&ApiUser=foobar&AuthToken=1234', '{"D":{"Contacts":[{}]}}') { [500, {}, '{"D": {
           "Success": false}
           }'] 
         }

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

@@ -14,7 +14,6 @@ describe Document do
     Document.should respond_to(:find_by_listing_key)
   end
 
-
   it "should get documents for a listing" do
     stub_auth_request
     stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234/documents").
@@ -25,13 +24,11 @@ describe Document do
           }).
           to_return(:body => fixture('listing_document_index.json'))
 
-    v = Document.find_by_listing_key('1234', "foobar")
-    v.should be_an Array
+    v = Document.find_by_listing_key('1234')
+    v.should be_an(Array)
     v.length.should == 2
   end
 
-
-
   after(:each) do
     @document = nil
   end

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

@@ -2,6 +2,7 @@ require './spec/spec_helper'
 
 describe Listing do
   before(:each) do
+
     @listing = Listing.new({
       "ResourceUri"=>"/v1/listings/20080619000032866372000000", 
       "StandardFields"=>{
@@ -51,10 +52,10 @@ describe Listing do
 
   describe "attributes" do
     it "should allow access to fields" do
-      @listing.StandardFields.should be_a Hash
-      @listing.StandardFields['ListingId'].should be_a String
-      @listing.StandardFields['ListPrice'].should match @listing.ListPrice
-      @listing.photos.should be_a Array
+      @listing.StandardFields.should be_a(Hash)
+      @listing.StandardFields['ListingId'].should be_a(String)
+      @listing.StandardFields['ListPrice'].should match(@listing.ListPrice)
+      @listing.photos.should be_a(Array)
     end
 
     it "should not respond to removed attributes" do
@@ -86,6 +87,20 @@ describe Listing do
     it "should respond to find_by_cart_id" do
       Listing.should respond_to(:find_by_cart_id)
     end
+    
+    it "should return the count" do
+      stub_auth_request
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings").
+        with(:query => {
+          :_pagination => "count",
+          :ApiSig => "9028191e427eee6774527e7d19f489cb",
+          :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+          :ApiUser => "foobar"
+        }).
+        to_return(:body => fixture('count.json'))
+      count = Listing.count()
+      count.should == 2001
+    end 
   end
 
   describe "subresources" do
@@ -104,7 +119,7 @@ describe Listing do
           }).
           to_return(:body => fixture('listing_with_photos.json'))
       
-      l = Listing.find('1234', :ApiUser => "foobar", :_expand => "Photos")
+      l = Listing.find('1234', :_expand => "Photos")
       l.photos.length.should == 5
       l.documents.length.should == 0
       l.videos.length.should == 0
@@ -121,7 +136,7 @@ describe Listing do
           }).
           to_return(:body => fixture('listing_with_documents.json'))
       
-      l = Listing.find('1234', :ApiUser => "foobar", :_expand => "Documents")
+      l = Listing.find('1234', :_expand => "Documents")
       l.photos.length.should == 0
       l.documents.length.should == 2
       l.videos.length.should == 0
@@ -138,7 +153,7 @@ describe Listing do
           }).
           to_return(:body => fixture('listing_with_vtour.json'))
       
-      l = Listing.find('1234', :ApiUser => "foobar", :_expand => "VirtualTours")
+      l = Listing.find('1234', :_expand => "VirtualTours")
       l.virtual_tours.length.should == 1
       l.photos.length.should == 0
       l.documents.length.should == 0
@@ -156,14 +171,36 @@ describe Listing do
           }).
           to_return(:body => fixture('listing_with_videos.json'))
       
-      l = Listing.find('1234', :ApiUser => "foobar", :_expand => "Videos")
+      l = Listing.find('1234', :_expand => "Videos")
       l.videos.length.should == 2
       l.virtual_tours.length.should == 0
       l.photos.length.should == 0
       l.documents.length.should == 0
     end 
 
-
+    it "should return tour of homes" do
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/20060725224713296297000000").
+        with(:query => {
+          :ApiSig => "b3ae2bec3500ba4620bf8224dee28d20",
+          :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+          :ApiUser => "foobar"
+        }).
+        to_return(:body => fixture('listing_no_subresources.json'))
+      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'))
+          
+      l = Listing.find('20060725224713296297000000')
+      l.tour_of_homes().length.should == 2
+      l.videos.length.should == 0
+      l.photos.length.should == 0
+      l.documents.length.should == 0
+    end 
+    
   end
 
   after(:each) do  

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

@@ -0,0 +1,90 @@
+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)
+    Note.new.should respond_to(:save!)
+    Note.new.should respond_to(:delete)
+  end
+
+  context "when shared with a contact" do
+    before :each do
+      @note = Listing.new(:ListingKey => "1234").shared_notes("5678")
+      stub_auth_request
+    end
+
+    it "should have the correct path" do
+      @note.path.should == "/listings/1234/shared/notes/contacts/5678"
+    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'))
+      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'))
+      @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'))
+      @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'))
+
+      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 }
+    end
+
+    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'))
+
+      n.save
+      n.ResourceUri.should == '/v1/listings/20100909200152674436000000/shared/notes/contacts/20110407212043616271000000/'
+    end
+
+    after :each do
+      @note = nil
+    end
+  end
+end

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

@@ -44,8 +44,8 @@ describe Photo do
     end
 
     it "should get an array of photos" do
-      p = Photo.find_by_listing_key('1234', 'foobar')
-      p.should be_an Array
+      p = Photo.find_by_listing_key('1234')
+      p.should be_an(Array)
     end
 
   end

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

@@ -19,15 +19,49 @@ describe SystemInfo do
     SystemInfo.should respond_to(:get)
   end
   
+  it "should have a primary_logo instance method" do
+    @sysinfo.should respond_to(:primary_logo)
+  end
+
   it "should respond to attributes" do
     ['Name','OfficeId','Id','MlsId','Office','Mls'].each do |k|
-      (@sysinfo.send k.to_sym).should be_a String
+      (@sysinfo.send k.to_sym).should be_a(String)
     end
-    @sysinfo.Configuration.should be_a Array
+    @sysinfo.Configuration.should be_a(Array)
   end
 
   it "should have an array of config items" do
-    @sysinfo.Configuration.should be_a Array
+    @sysinfo.Configuration.should be_a(Array)
+  end
+
+  describe "#primary_logo" do
+    before(:each) do
+      @sysinfo_with_logos = SystemInfo.new({
+        "Name"=>"Brandon  Reg1", 
+        "OfficeId"=>"20080904154102121828000000", 
+        "Configuration"=>[{
+          "MlsLogos"=>[
+            {"Uri"=>"http://images.dev.fbsdata.com/eup/20110406184939446866000000.jpg", "Name:"=>"logo and stuff"}, 
+            {"Uri"=>"http://images.dev.fbsdata.com/eup/20110406191929838053000000.jpg", "Name:"=>"tried it"}
+          ], 
+          "IdxDisclaimer"=>"", 
+          "IdxLogoSmall"=>"", 
+          "IdxLogo"=>"http://images.dev.fbsdata.com/eup/20110406184939446866000000.jpg"
+        }], 
+        "Id"=>"20080904155327755059000000", 
+        "MlsId"=>"20041217205818829687000000", 
+        "Office"=>"Brandon Office1", 
+        "Mls"=>"Eastern Upper Peninsula"
+      })
+    end 
+
+    it "should return nil when no logo is present" do
+      @sysinfo.primary_logo.should == nil
+    end
+
+    it "should return the first logo when several are present" do
+      @sysinfo_with_logos.primary_logo.should be_a(Hash)
+    end 
   end
 
   after(:each) do 

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

@@ -0,0 +1,43 @@
+require './spec/spec_helper'
+
+require 'time'
+
+describe TourOfHome do
+  subject do
+    TourOfHome.new(
+      'ResourceUri'=>"/listings/20060725224713296297000000/tourofhomes/20101127153422574618000000",
+      'Id'=>"20101127153422574618000000",
+      'Date'=>"10/01/2010",
+      'StartTime'=>"09:00:00-07:00",
+      'EndTime'=>"23:00:00-07:00",
+      'Comments'=>"Wonderful home; must see!",
+      'AdditionalInfo'=> [{"Hosted By"=>"Joe Smith"}, {"Host Phone"=>"123-456-7890"}, {"Tour Area"=>"North-Central"}]
+    )
+  end
+
+  it "should respond to a few methods" do
+    subject.class.should respond_to(:find_by_listing_key)
+  end
+  it "should return tour date and times" do
+    start_time = DateTime.new(2010,10,1,9,0,0, "-0700")
+    end_time = DateTime.new(2010,10,1,23,0,0, "-0700")
+    subject.Date.should eq(Date.new(2010,10,1))
+    subject.StartTime.should eq(Time.parse(start_time.to_s))
+    subject.EndTime.should eq(Time.parse(end_time.to_s))
+  end
+
+  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'))
+    v = subject.class.find_by_listing_key('20060725224713296297000000')
+    v.should be_an(Array)
+    v.length.should == 2
+  end
+
+end