flexmls_api 0.4.5 → 0.6.4

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

@@ -4,12 +4,6 @@ require './spec/spec_helper'
 class MyExampleModel < Base
   self.element_name = "example"
   self.prefix = "/test/"
-  def self.connection
-    @connection ||= Base.connection
-  end
-  def self.connection=(con)
-    @connection = con
-  end
 end
 
 class MyDefaultModel < Base
@@ -31,24 +25,9 @@ describe Base, "Base model" do
       MyDefaultModel.path.should eq("/resource")
     end
     describe "finders" do
-      before(:all) do
-        stubs = Faraday::Adapter::Test::Stubs.new do |stub|
-          stub.get('/v1/test/example?ApiSig=9fd7299fc210d0c3dcc24782d9cb7894&ApiUser=foobar&AuthToken=1234') { [200, {}, '{"D": {
-            "Success": true, 
-            "Results": [{
-              "Id": 1,
-              "Name": "My Example", 
-              "Test": true
-            },
-            {
-              "Id": 2, 
-              "Name": "My Example2", 
-              "Test": false
-            }]}
-            }'] 
-          }
-        end
-        MyExampleModel.connection = mock_client(stubs)
+      before(:each) do
+        stub_auth_request
+        stub_api_get("/test/example", 'base.json')
       end
       it "should get all results" do
         MyExampleModel.get.length.should == 2
@@ -58,5 +37,70 @@ describe Base, "Base model" do
       end
     end
   end
-  
+
+  describe "attribute accessors, setters, and predicates" do
+    before(:each) do
+      stub_auth_request
+      stub_api_get("/test/example", 'base.json')
+      @model = MyExampleModel.first
+    end
+
+    it "should access existing attributes" do
+      @model.Name.should == 'My Example'
+    end
+
+    it "should raise errors on access to non-existant attributes" do
+      lambda { @model.Nonsense }.should raise_error(NoMethodError)
+    end
+
+    it "should set existing attributes" do
+      new_name = 'John Jacob Jingleheimerschmidt'
+      @model.Name = new_name
+      @model.Name.should == new_name
+    end
+
+    it "should set non-existant attributes" do
+      nonsense = 'nonsense'
+      @model.Nonsense = nonsense
+      @model.Nonsense.should == nonsense
+    end
+
+    it "should return a boolean for a predicate for an existing attribute" do
+      @model.Name?.should satisfy { |p| [true, false].include?(p) }
+    end
+
+    it "should raise an Error for a predicate for a non-existant attribute" do
+      lambda { @model.Nonsense? }.should raise_error(NoMethodError)
+    end
+
+    it "should repond_to existing attributes" do
+      @model.should respond_to(:Name)
+    end
+
+    it "should not respond_to non-existant attributes" do
+      @model.should_not respond_to(:Nonsense)
+    end
+
+    it "should respond_to a setter for an existing attribute" do
+      @model.should respond_to(:Name=)
+    end
+
+    it "should respond_to a setter for a non-existant attribute" do
+      @model.should respond_to(:Nonsense=)
+    end
+
+    it "should respond_to a predicate for an existing attribute" do
+      @model.should respond_to(:Name?)
+    end
+
+    it "should not respond_to a predicate for a non-existant attribute" do
+      @model.should_not respond_to(:Nonsense?)
+    end
+
+    it "should respond_to methods inherited from parent classes" do
+      @model.should respond_to(:freeze)
+    end
+
+  end
+
 end

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

@@ -1,46 +1,51 @@
 require './spec/spec_helper'
 
 
-class Contact
-  class << self
-    # Neato trick, using the accessor function nested here acts on the class methods!
-    attr_accessor :connection
-  end
-end
-
 describe Contact do
-  before(:all) do
-    stubs = Faraday::Adapter::Test::Stubs.new do |stub|
-      stub.get('/v1/contacts?ApiSig=33e3b6d6436c85c3f9944d21f6f0cf9a&ApiUser=foobar&AuthToken=1234') { [200, {}, fixture('contacts.json')] 
-      }
-      stub.post('/v1/contacts?ApiSig=1c78fb9f798fbb739a0b8152528cd453&ApiUser=foobar&AuthToken=1234', '{"D":{"Contacts":[{"DisplayName":"Contact Four","PrimaryEmail":"contact4@fbsdata.com"}]}}') { [201, {}, '{"D": {
-        "Success": true, 
-        "Results": [
-          {
-            "ResourceUri":"/v1/contacts/20101230223226074204000000"
-          }]}
-        }'] 
-      }
-      stub.post('/v1/contacts?ApiSig=ea132fe27a8deb7d6c096b102972ce3e&ApiUser=foobar&AuthToken=1234', '{"D":{"Contacts":[{}]}}') { [400, {}, '{"D": {
-        "Success": false}
-        }'] 
-      }
-    end
-    Contact.connection = mock_client(stubs)
+  before(:each) do
+    stub_auth_request
   end
   
   it "should include the finders module" do
     Contact.should respond_to(:find)
+    Contact.should respond_to(:my)
   end
 
   it "should get all my contacts" do
+    stub_api_get("/contacts", 'contacts.json')
     contacts = Contact.get
     contacts.should be_an(Array)
     contacts.length.should eq(3)
     contacts.first.Id.should eq("20101230223226074201000000")
   end
 
+  it "should get a single contact when using #my" do
+    stub_api_get("/my/contact", 'contact_my.json')
+    contact = Contact.my
+    contact.should be_a(Contact)
+    contact.Id.should == '20090928182824338901000000'
+    contact.DisplayName.should == 'BH FOO'
+  end
+
+  it "should get all my Tags" do
+    stub_api_get("/contacts/tags", 'contact_tags.json')
+    tags = Contact.tags
+    tags.should be_an(Array)
+    tags.length.should eq(4)
+    tags.first["Tag"].should eq("Current Buyers")
+  end
+  
+  it "should get all my Tags" do
+    stub_api_get("/contacts/tags/IDX%20Lead", 'contacts.json')
+    contacts = Contact.by_tag("IDX Lead")
+    contacts.should be_an(Array)
+    contacts.length.should eq(3)
+    contacts.first.Id.should eq("20101230223226074201000000")
+    contacts.first.Tags[0].should eq("IDX Lead")
+  end
+    
   it "should save a new contact" do
+    stub_api_post("/contacts", 'contact_new.json', 'contacts_post.json')
     c=Contact.new
     c.attributes["DisplayName"] = "Contact Four"
     c.attributes["PrimaryEmail"] = "contact4@fbsdata.com"
@@ -48,23 +53,32 @@ describe Contact do
     c.Id.should eq('20101230223226074204000000')
   end
 
+  it "should save a new contact and notify" do
+    stub_api_post("/contacts", 'contact_new_notify.json', 'contacts_post.json')
+    c=Contact.new
+    c.notify=true
+    c.attributes["DisplayName"] = "Contact Four"
+    c.attributes["PrimaryEmail"] = "contact4@fbsdata.com"
+    c.save.should be(true)
+    c.Id.should eq('20101230223226074204000000')
+  end
+
   it "should fail saving" do
+    stub_api_post("/contacts", 'contact_new_empty.json') do |request|
+      request.to_return(:status => 400, :body => fixture('errors/failure.json'))
+    end
+
     c=Contact.new
     c.save.should be(false)
     expect{ c.save! }.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 400 }
   end
   
   context "on an epic fail" do
-    before(:all) do
-      stubs = Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.post('/v1/contacts?ApiSig=ea132fe27a8deb7d6c096b102972ce3e&ApiUser=foobar&AuthToken=1234', '{"D":{"Contacts":[{}]}}') { [500, {}, '{"D": {
-          "Success": false}
-          }'] 
-        }
-      end
-      Contact.connection = mock_client(stubs)
-    end
     it "should fail saving and asplode" do
+      stub_api_post("/contacts", 'contact_new_empty.json') do |request|
+        request.to_return(:status => 500, :body => fixture('errors/failure.json'))
+      end
+      
       c=Contact.new()
       expect{ c.save! }.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 500 }
       expect{ c.save }.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 500 }

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

@@ -16,13 +16,7 @@ describe Document do
 
   it "should get documents for a listing" do
     stub_auth_request
-    stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234/documents").
-          with( :query => { 
-            :ApiSig => "82f62b685e4318a1ab6bc3fc5a031c5a", 
-            :AuthToken => "c401736bf3d3f754f07c04e460e09573",
-            :ApiUser => "foobar"
-          }).
-          to_return(:body => fixture('listing_document_index.json'))
+    stub_api_get('/listings/1234/documents','listing_document_index.json')
 
     v = Document.find_by_listing_key('1234')
     v.should be_an(Array)

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

@@ -0,0 +1,114 @@
+require './spec/spec_helper'
+
+describe ListingCart do
+
+  it "should get all listing carts" do
+    stub_api_get("/#{subject.class.element_name}", 'listing_cart.json')
+    resources = subject.class.get
+    resources.should be_an(Array)
+    resources.length.should eq(2)
+    resources.first.Id.should eq("20100912153422758914000000")
+  end
+
+  it "should get a listing cart" do
+    stub_api_get("/#{subject.class.element_name}", 'listing_cart.json')
+    resource = subject.class.get.first
+    resource.Id.should eq("20100912153422758914000000")
+    resource.Name.should eq("My Listing Cart")
+    resource.ListingCount.should eq(10)
+  end
+  
+  it "should add a listing to a cart" do
+    list_id = "20110621133454434543000000"
+    stub_api_get("/#{subject.class.element_name}", 'listing_cart.json')
+    resource = subject.class.get.first
+    resource.Id.should eq("20100912153422758914000000")
+    stub_api_post("/#{subject.class.element_name}/#{resource.Id}",'listing_cart_add_listing_post.json', 'listing_cart_add_listing.json')
+    resource.ListingCount.should eq(10)
+    resource.add_listing(list_id)
+    resource.ListingCount.should eq(11)
+  end
+  
+  it "should remove a listing from a cart" do
+    list_id = "20110621133454434543000000"
+    stub_api_get("/#{subject.class.element_name}", 'listing_cart.json')
+    resource = subject.class.get.first
+    resource.Id.should eq("20100912153422758914000000")
+    stub_api_delete("/#{subject.class.element_name}/#{resource.Id}/listings/#{list_id}", 'listing_cart_remove_listing.json')
+    resource.ListingCount.should eq(10)
+    resource.remove_listing(list_id)
+    resource.ListingCount.should eq(9)
+  end
+
+  let(:listing){ Listing.new(:Id => "20110112234857732941000000") }
+  it "should get all carts for a listing" do
+    stub_api_get("/#{subject.class.element_name}/for/#{listing.Id}", 'listing_cart.json')
+    [listing, listing.Id ].each do |l|
+        resources = subject.class.for(l)
+        resources.should be_an(Array)
+        resources.length.should eq(2)
+        resources.first.Id.should eq("20100912153422758914000000")
+    end
+  end
+
+  it "should get the carts for a user" do
+    stub_api_get("/my/#{subject.class.element_name}", 'listing_cart.json')
+    resources = subject.class.my
+    resources.should be_an(Array)
+    resources.length.should eq(2)
+    resources.first.Id.should eq("20100912153422758914000000")
+  end
+
+  it "should get the carts specific to a portal user" do
+    stub_api_get("/#{subject.class.element_name}/portal", 'listing_cart.json')
+    resources = subject.class.portal
+    resources.should be_an(Array)
+    resources.length.should eq(2)
+    resources.first.Id.should eq("20100912153422758914000000")
+  end
+  
+  it "should save a new listing cart" do
+    stub_api_post("/#{subject.class.element_name}", 'listing_cart_new.json', 'listing_cart_post.json')
+    subject.ListingIds = [
+      '20110112234857732941000000',
+      '20110302120238448431000000',
+      '20110510011212354751000000']
+    subject.Name = "My Cart's Name"
+    subject.save.should be(true)
+    subject.ResourceUri.should eq("/v1/listingcarts/20100912153422758914000000")
+  end
+
+  it "should save a listing cart" do
+    stub_api_get("/#{subject.class.element_name}", 'listing_cart.json')
+    resource = subject.class.get.first
+    stub_api_put("/#{subject.class.element_name}/#{resource.Id}", 'listing_cart_new.json', 'success.json')
+    resource.ListingIds = [
+      '20110112234857732941000000',
+      '20110302120238448431000000',
+      '20110510011212354751000000']
+    
+    resource.Name = "My Cart's Name"
+    resource.save.should be(true)
+    resource.ResourceUri.should eq("/v1/listingcarts/20100912153422758914000000")
+  end
+  
+  it "should fail saving" do
+    stub_api_post("/#{subject.class.element_name}",'listing_cart_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
+
+  it "should delete a listing cart" do
+    stub_api_get("/#{subject.class.element_name}", 'listing_cart.json')
+    resource = subject.class.get.first
+    resource.Id.should eq("20100912153422758914000000")
+    resource.Name.should eq("My Listing Cart")
+    resource.ListingCount.should eq(10)
+    stub_api_delete("/#{subject.class.element_name}/#{resource.Id}", 'success.json')
+    resource.delete.should be(nil)
+  end
+
+end

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

@@ -90,14 +90,7 @@ describe Listing do
     
     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'))
+      stub_api_get("/listings", 'count.json', { :_pagination => "count"})
       count = Listing.count()
       count.should == 2001
     end 
@@ -108,16 +101,8 @@ describe Listing do
       stub_auth_request
     end
 
-
     it "should return an array of photos" do
-      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234").
-          with(:query => {
-            :ApiSig => "3c942a2d6746299c476dd2e30d10966b",
-            :AuthToken => "c401736bf3d3f754f07c04e460e09573",
-            :ApiUser => "foobar",
-            :_expand => "Photos"
-          }).
-          to_return(:body => fixture('listing_with_photos.json'))
+      stub_api_get("/listings/1234", 'listing_with_photos.json', { :_expand => "Photos" })
       
       l = Listing.find('1234', :_expand => "Photos")
       l.photos.length.should == 5
@@ -127,14 +112,7 @@ describe Listing do
     end
 
     it "should return an array of documents" do
-      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234").
-          with(:query => {
-            :ApiSig => "554b6e2a3efec8719b782647c19d238d",
-            :AuthToken => "c401736bf3d3f754f07c04e460e09573",
-            :ApiUser => "foobar",
-            :_expand => "Documents"
-          }).
-          to_return(:body => fixture('listing_with_documents.json'))
+      stub_api_get("/listings/1234", 'listing_with_documents.json', { :_expand => "Documents" })
       
       l = Listing.find('1234', :_expand => "Documents")
       l.photos.length.should == 0
@@ -144,14 +122,7 @@ describe Listing do
     end
 
     it "should return an array of virtual tours" do
-      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234").
-          with(:query => {
-            :ApiSig => "cc966b538640dd6b37dce0067cea2e5a",
-            :AuthToken => "c401736bf3d3f754f07c04e460e09573",
-            :ApiUser => "foobar",
-            :_expand => "VirtualTours"
-          }).
-          to_return(:body => fixture('listing_with_vtour.json'))
+      stub_api_get("/listings/1234", 'listing_with_vtour.json', { :_expand => "VirtualTours" })
       
       l = Listing.find('1234', :_expand => "VirtualTours")
       l.virtual_tours.length.should == 1
@@ -162,14 +133,7 @@ describe Listing do
 
 
     it "should return an array of videos" do
-      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234").
-          with(:query => {
-            :ApiSig => "12afd7ef1d98ca35c613040f5ddb92b2",
-            :AuthToken => "c401736bf3d3f754f07c04e460e09573",
-            :ApiUser => "foobar",
-            :_expand => "Videos"
-          }).
-          to_return(:body => fixture('listing_with_videos.json'))
+      stub_api_get("/listings/1234", 'listing_with_videos.json', { :_expand => "Videos" })
       
       l = Listing.find('1234', :_expand => "Videos")
       l.videos.length.should == 2
@@ -179,21 +143,9 @@ describe Listing do
     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'))
-          
+      stub_api_get("/listings/20060725224713296297000000", 'listing_no_subresources.json')
+      stub_api_get("/listings/20060725224713296297000000/tourofhomes", 'tour_of_homes.json')
+
       l = Listing.find('20060725224713296297000000')
       l.tour_of_homes().length.should == 2
       l.videos.length.should == 0