spark_api 1.2.1 → 1.3.0

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

@@ -10,18 +10,41 @@ class MyDefaultModel < Base
 end
 
 describe MyExampleModel, "Example model" do
+
   before(:each) do
     stub_auth_request
     stub_api_get("/test/example", 'base.json')
     @model = MyExampleModel.first
   end
+
   it "should be persisted" do
     @model.persisted?.should eq(true)
   end
+
   it "should not be persisted" do
     @new_model = MyExampleModel.new()
     @new_model.persisted?.should eq(false)
   end
+
+  it "should parse and return ResourceUri without v1" do
+    @model.resource_uri.should eq("/some/place/20101230223226074201000000")
+  end
+
+  it "should parse and return the correct path for a persisted resource" do
+    @model.path.should eq("/some/place")
+  end
+
+  it "should parse and return the correct path" do
+    @model = MyExampleModel.new
+    @model.path.should eq("/test/example")
+  end
+
+  it "should parse and return the correct path for resource with a parent" do
+    @model = MyExampleModel.new
+    @model.parent = Contact.new(Id: "20101230223226074201000000")
+    @model.path.should eq("/contacts/20101230223226074201000000/test/example")
+  end
+
 end
 
 describe Base, "Base model" do

data/spec/unit/spark_api/models/concerns/destroyable_spec.rb

@@ -19,7 +19,7 @@ describe Concerns::Destroyable, "Destroyable Concern" do
   end
 
   it "should be destroyable" do
-    stub_api_delete("/test/example/1")
+    stub_api_delete("/some/place/20101230223226074201000000")
     @model = MyExampleModel.first
     @model.destroy
     @model.destroyed?.should eq(true)

data/spec/unit/spark_api/models/concerns/savable_spec.rb

@@ -30,32 +30,36 @@ describe Concerns::Savable, "Model" do
 
   it "should be creatable" do
     @model = MyExampleModel.new({ :Name => "my name" })
-    stub_api_post("/test/example", { :MyExampleModels => [ @model.attributes ] }, "base.json")
+    s = stub_api_post("/test/example", { :MyExampleModels => [ @model.attributes ] }, "base.json")
     @model.save.should eq(true)
     @model.persisted?.should eq(true)
+    s.should have_been_requested
   end
 
   it "should be updatable" do
     stub_api_get("/test/example", 'base.json')
     @model = MyExampleModel.first
     @model.Name = "new name"
-    stub_api_put("/test/example/1", @model.dirty_attributes)
+    s = stub_api_put("/some/place/20101230223226074201000000", @model.dirty_attributes)
     @model.save.should eq(true)
     @model.persisted?.should eq(true)
+    s.should have_been_requested
   end
 
   it "should allow the pluralize method to be overriden" do
     @model = MyOtherExampleModel.new({ :Name => "my name" })
-    stub_api_post("/test/example", { :MyOtherExampleModelThatIsPluralized => [ @model.attributes ] }, "base.json")
+    s = stub_api_post("/test/example", { :MyOtherExampleModelThatIsPluralized => [ @model.attributes ] }, "base.json")
     @model.save.should eq(true)
     @model.persisted?.should eq(true)
+    s.should have_been_requested
   end
 
   it "should not pluralize the resource if it already is" do
     @model = MyPluralizedModels.new({ :Name => "my name" })
-    stub_api_post("/test/example", { :MyPluralizedModels => [ @model.attributes ] }, "base.json")
+    s = stub_api_post("/test/example", { :MyPluralizedModels => [ @model.attributes ] }, "base.json")
     @model.save.should eq(true)
     @model.persisted?.should eq(true)
+    s.should have_been_requested
   end
 
 end

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

@@ -11,6 +11,7 @@ describe Contact do
   end
 
   context "/contacts", :support do
+
     on_get_it "should get all my contacts" do
       stub_api_get("/contacts", 'contacts/contacts.json')
       contacts = Contact.get
@@ -72,6 +73,149 @@ describe Contact do
         expect{ c.save }.to raise_error(SparkApi::ClientError){ |e| e.status.should == 500 }
       end
     end
+
+    context "/tags", :support do
+      on_get_it "should get all my Tags" do
+        stub_api_get("/contacts/tags", 'contacts/tags.json')
+        tags = Contact.tags
+        tags.should be_an(Array)
+        tags.length.should eq(4)
+        tags.first["Tag"].should eq("Current Buyers")
+      end
+    end
+
+    context "/tags/<tag_name>", :support do
+      on_get_it "should get all contacts with Tag <tag_name>" do
+        stub_api_get("/contacts/tags/IDX%20Lead", 'contacts/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
+    end
+
+    context "/export", :support do
+      on_get_it "should get all contacts belonging to the current user" do
+        stub_api_get("/contacts/export", 'contacts/contacts.json')
+        Contact.should respond_to(:export)
+        contacts = Contact.export
+        contacts.should be_an(Array)
+        contacts.length.should eq(3)
+      end
+    end
+
+    context "/export/all", :support do
+      on_get_it "should get all contacts belonging to the current user" do
+        stub_api_get("/contacts/export/all", 'contacts/contacts.json')
+        Contact.should respond_to(:export_all)
+        contacts = Contact.export_all
+        contacts.should be_an(Array)
+        contacts.length.should eq(3)
+      end
+    end
+
+  end
+
+  context "/contacts/<contact_id>" do
+
+    let(:contact_id) { "20090928182824338901000000" }
+
+    context "/savedsearches", :support do
+
+      subject(:contact) do
+        stub_api_get("/my/contact", 'contacts/my.json')
+        contact = Contact.my
+      end
+
+      on_get_it "should get all the saved searches belonging to the customer" do
+        stub_api_get("/contacts/#{contact.Id}/savedsearches", 'saved_searches/get.json')
+        saved_searches = contact.saved_searches
+        saved_searches.should be_an(Array)
+        saved_searches.length.should eq(2)
+      end
+
+      it "should pass any arguments as parameters" do
+        stub_api_get("/contacts/#{contact.Id}/savedsearches", 'saved_searches/get.json', :_pagination => 1)
+        saved_searches = contact.saved_searches(:_pagination => 1)
+      end
+
+    end
+
+    context "/listingcarts", :support do
+
+      subject(:contact) do
+        stub_api_get("/my/contact", 'contacts/my.json')
+        Contact.my
+      end
+
+      on_get_it "should get all the listing carts belonging to the customer" do
+        stub_api_get("/contacts/#{contact.Id}/listingcarts", 'listing_carts/listing_cart.json')
+        saved_searches = contact.listing_carts
+        saved_searches.should be_an(Array)
+        saved_searches.length.should eq(2)
+      end
+
+      it "should pass any arguments as parameters" do
+        stub_api_get("/contacts/#{contact.Id}/listingcarts", 'listing_carts/listing_cart.json', :test_argument => "yay")
+        saved_searches = contact.listing_carts(:test_argument => "yay")
+      end
+
+    end
+
+    context "/portal", :support do
+      on_get_it "should return account information for the current user/contact?" do
+        stub_api_get("/my/contact", 'contacts/my.json')
+        contact = Contact.my
+        stub_api_get("/contacts/#{contact.Id}/portal", 'contacts/vow_accounts/get.json')
+        vow_account = contact.vow_account
+        vow_account.persisted?.should be_true
+      end
+    end
+
+    context "/comments" do
+
+      it "should get all of a contact's comments" do
+        s = stub_api_get("/contacts/#{contact_id}/comments", "comments/get.json")
+        comments = Contact.new(:Id => contact_id).comments
+        comments.size.should eq(2)
+        s.should have_been_requested
+      end
+
+      it "should create a new contact comment" do
+        s = stub_api_post("/contacts/#{contact_id}/comments", "comments/new.json", "comments/post.json")
+        comment = Comment.new(:Comment => "This is a comment.")
+        comment.parent = Contact.new(:Id => contact_id)
+        comment.save.should be(true)
+        comment.Id.should eq("20121114100201798092000005")
+        s.should have_been_requested
+      end
+
+      it "should create a new contact comment using helper method" do
+        stub_api_get("/my/contact", 'contacts/my.json')
+        s = stub_api_post("/contacts/#{contact_id}/comments", "comments/new.json", "comments/post.json")
+        contact = Contact.my
+        comment = contact.comment "This is a comment."
+        comment.should be_a(Comment)
+        s.should have_been_requested
+      end
+
+    end
+
+    context "/comments/<id>" do
+
+      let(:id) { "20121128133936712557000097" }
+
+      on_delete_it "should remove a comment" do
+        stub_api_get("/contacts/#{contact_id}/comments", "comments/get.json")
+        s = stub_api_delete("/activities/20121128132106172132000004/comments/#{id}", "success.json")
+        comment = Contact.new(:Id => contact_id).comments.first
+        comment.destroy.should eq(true)
+        s.should have_been_requested
+      end
+
+    end
+
   end
 
   context "/my/contact", :support do
@@ -84,25 +228,4 @@ describe Contact do
     end
   end
 
-  context "/contact/tags", :support do
-    on_get_it "should get all my Tags" do
-      stub_api_get("/contacts/tags", 'contacts/tags.json')
-      tags = Contact.tags
-      tags.should be_an(Array)
-      tags.length.should eq(4)
-      tags.first["Tag"].should eq("Current Buyers")
-    end
-  end
-
-  context "/contact/tags/<tag_name>", :support do
-    on_get_it "should get all contacts with Tag <tag_name>" do
-      stub_api_get("/contacts/tags/IDX%20Lead", 'contacts/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
-  end
-
 end

data/spec/unit/spark_api/models/fields_spec.rb

@@ -0,0 +1,56 @@
+require './spec/spec_helper'
+
+describe Fields do
+  before(:each) do
+    stub_auth_request
+  end
+
+  context "/fields/order", :support do
+    on_get_it "should find field orders for all property types" do
+      Fields.should respond_to(:order)
+
+      # stub request
+      stub_api_get('/fields/order','fields/order.json')
+
+      # request
+      resources = subject.class.order
+
+      # a standard array of results
+      resources.should be_an(Array)
+      resources.length.should eq(1)
+
+      # make sure multiple property types are present
+      resources.first.should have_key("A")
+      resources.first.should have_key("B")
+
+      resources.first["A"].should be_an(Array)
+    end
+  end
+
+  context "/fields/order/<property_type>", :support do
+    on_get_it "should find field order for a single property type" do
+      Fields.should respond_to(:order)
+
+      # stub request
+      stub_api_get('/fields/order/A','fields/order_a.json')
+
+      # request
+      resources = subject.class.order("A")
+
+      # a standard array of results
+      resources.should be_an(Array)
+      resources.length.should eq(2)
+
+      # validate a single entity
+      group = resources.first[resources.first.keys.first]
+      group.should be_an(Array)
+      group.length.should eq(2)
+      group.each do |field|
+        field.should have_key("Field")
+      end
+
+    end
+  end
+
+
+end

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

@@ -73,7 +73,7 @@ describe ListingCart do
       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.empty?.should be(true)
+      resource.delete.should be(true)
     end
   end
 

data/spec/unit/spark_api/models/portal_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Portal do
+
+  before :each do
+    stub_auth_request
+  end
+
+  context "/portal" do
+
+    it "should return a new portal if the current user doesn't have one yet" do
+      stub_api_get("/portal", "portal/my_non_existant.json")
+      portal = Portal.my
+      portal.persisted?.should eq(false)
+    end
+
+    it "should get the current user's portal" do
+      stub_api_get("/portal", "portal/my.json")
+      portal = Portal.my
+      portal.persisted?.should eq(true)
+    end
+
+    it "should create a portal for the current user" do
+      stub_api_post("/portal", "portal/new.json", "portal/post.json")
+      portal = Portal.new({
+        :DisplayName => "GreatPortal",
+        :Enabled => true,
+        :RequiredFields => [ "Address", "Phone" ]
+      })
+      portal.save
+    end
+
+    it "should enable the current user's portal" do
+      stub_api_get("/portal", "portal/my.json")
+      s = stub_api_put("/portal/20100912153422758914000000", "portal/enable.json", "portal/post.json")
+      portal = Portal.my
+      portal.enable
+      s.should have_been_requested
+    end
+
+    it "should disable the current user's portal" do
+      stub_api_get("/portal", "portal/my.json")
+      s = stub_api_put("/portal/20100912153422758914000000", "portal/disable.json", "portal/post.json")
+      portal = Portal.my
+      portal.disable
+      s.should have_been_requested
+    end
+
+  end
+end

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

@@ -56,6 +56,49 @@ describe SavedSearch do
       resource.delete
     end
 
+    it "should attach a contact by id" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
+      stub_api_put("/#{subject.class.element_name}/#{id}/contacts/20101230223226074306000000", nil, "success.json")
+      resource = subject.class.find(id)
+      resource.attach("20101230223226074306000000")
+      resource.ContactIds.size.should eq(2)
+      resource.ContactIds.any? { |c| c == "20101230223226074306000000" }.should eq(true)
+    end
+
+    it "should detach a contact by id" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
+      stub_api_delete("/#{subject.class.element_name}/#{id}/contacts/20100815220615294367000000", "generic_delete.json")
+      resource = subject.class.find(id)
+      resource.detach("20100815220615294367000000")
+      resource.ContactIds.size.should eq(0)
+    end
+
+    it "should attach a contact by Contact object" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
+      stub_api_put("/#{subject.class.element_name}/#{id}/contacts/20101230223226074306000000", nil, "success.json")
+      resource = subject.class.find(id)
+      resource.attach(Contact.new({ :Id => "20101230223226074306000000" }))
+      resource.ContactIds.size.should eq(2)
+      resource.ContactIds.any? { |c| c == "20101230223226074306000000" }.should eq(true)
+    end
+
+    it "should detach a contact by Contact object" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
+      stub_api_delete("/#{subject.class.element_name}/#{id}/contacts/20100815220615294367000000", "generic_delete.json")
+      resource = subject.class.find(id)
+      resource.detach(Contact.new({:Id => "20100815220615294367000000" }))
+      resource.ContactIds.size.should eq(0)
+    end
+    
+    it "should initialize ContactIds as an array if nil" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'saved_searches/get.json')
+      stub_api_delete("/#{subject.class.element_name}/#{id}/contacts/20100815220615294367000000", "generic_delete.json")
+      resource = subject.class.find(id)
+      resource.ContactIds = nil
+      resource.detach(Contact.new({:Id => "20100815220615294367000000" }))
+      resource.ContactIds.size.should eq(0)
+    end
+
   end
 
   context "/provided/savedsearches", :support do
@@ -68,4 +111,21 @@ describe SavedSearch do
     end
   end
 
+  context "/savedsearches/<id>/contacts" do
+
+    on_get_it "should return a list of contacts" do
+      stub_api_get("/savedsearches/#{id}", "saved_searches/get.json")
+      stub_api_get("/savedsearches/20101230223226074204000000", "saved_searches/get.json")
+
+      resource = subject.class.find(id)
+      contacts = resource.contacts
+      contacts.should be_an(Array)
+    end
+
+    it "should return an empty array if model isn't persisted" do
+      resource = SavedSearch.new
+      resource.contacts.should be_an(Array)
+    end
+  end
+
 end