spark_api 1.0.0

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

@@ -0,0 +1,47 @@
+require './spec/spec_helper'
+
+
+describe Message do
+  before(:each) do
+    stub_auth_request
+  end
+
+  subject do
+    m = Message.new
+    m.attributes["Type"] = "ShowingRequest"
+    m.attributes["EventDateTime"] = "2011-09-15T14:00:00"
+    m.attributes["SenderId"] = "20110112234857732941000000"
+    m.attributes["Subject"] = "Showing Request For 123 Main St, MLS # 12-345"
+    m.attributes["Body"] = "A showing is requested for ..."
+    m.attributes["ListingId"] = "20110112234857732941000000"
+    m
+  end
+
+  context "/messages", :support do
+    on_get_it "should get all my messages"
+
+    on_post_it "should save a new message" do
+      stub_api_post("/messages", 'messages/new.json', 'messages/post.json')
+      subject.save.should be(true)
+    end
+
+    on_post_it "should save a new message with recipients" do
+      stub_api_post("/messages", 'messages/new_with_recipients.json', 'messages/post.json')
+      subject.attributes["Recipients"] =  ["20110112234857732941000000","20110092234857738467000000"]
+      subject.save.should be(true)
+    end
+
+    on_post_it "should fail saving" do
+      stub_api_post("/messages", 'messages/new_empty.json') do |request|
+        request.to_return(:status => 400, :body => fixture('errors/failure.json'))
+      end
+      m=subject.class.new
+      m.save.should be(false)
+      expect{ m.save! }.to raise_error(SparkApi::ClientError){ |e| e.status.should == 400 }
+    end
+  end
+
+  context "/messages/<message_id>", :support do
+    on_get_it "should get a single message"
+  end
+end

data/spec/unit/spark_api/models/message_spec.rb~

@@ -0,0 +1,47 @@
+require './spec/spec_helper'
+
+
+describe Message do
+  before(:each) do
+    stub_auth_request
+  end
+
+  subject do
+    m = Message.new
+    m.attributes["Type"] = "ShowingRequest"
+    m.attributes["EventDateTime"] = "2011-09-15T14:00:00"
+    m.attributes["SenderId"] = "20110112234857732941000000"
+    m.attributes["Subject"] = "Showing Request For 123 Main St, MLS # 12-345"
+    m.attributes["Body"] = "A showing is requested for ..."
+    m.attributes["ListingId"] = "20110112234857732941000000"
+    m
+  end
+
+  context "/messages", :support do
+    on_get_it "should get all my messages"
+
+    on_post_it "should save a new message" do
+      stub_api_post("/messages", 'messages/new.json', 'messages/post.json')
+      subject.save.should be(true)
+    end
+
+    on_post_it "should save a new message with recipients" do
+      stub_api_post("/messages", 'messages/new_with_recipients.json', 'messages/post.json')
+      subject.attributes["Recipients"] =  ["20110112234857732941000000","20110092234857738467000000"]
+      subject.save.should be(true)
+    end
+
+    on_post_it "should fail saving" do
+      stub_api_post("/messages", 'messages/new_empty.json') do |request|
+        request.to_return(:status => 400, :body => fixture('errors/failure.json'))
+      end
+      m=subject.class.new
+      m.save.should be(false)
+      expect{ m.save! }.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 400 }
+    end
+  end
+
+  context "/messages/<message_id>", :support do
+    on_get_it "should get a single message"
+  end
+end

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

@@ -0,0 +1,63 @@
+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
+
+    context "/listings/<listing_id>/shared/notes/contacts/<contact_id>", :support do
+      on_get_it "GET should get my notes" do
+        stub_api_get("#{@note.path}", 'notes/agent_shared.json')
+        ret = @note.get
+        ret.Note.should == "lorem ipsum dolor sit amet"
+      end
+
+      on_get_it "should return a nil when no shared notes exist" do
+        stub_api_get("#{@note.path}", 'notes/agent_shared_empty.json')
+        @note.get.should be_nil
+      end
+
+      on_delete_it "should allow you to delete an existing note" do
+        stub_api_delete("#{@note.path}", 'generic_delete.json')
+        @note.new.delete # test that no exceptions are raised
+      end
+
+      on_put_it "should raise an exception when adding a note fails" do
+        n = @note.new(:Note => "lorem ipsum dolor")
+
+        stub_api_put("#{@note.path}", 'notes/new.json') do |request|
+          request.to_return(:status => 500, :body => fixture('generic_failure.json'))
+        end
+
+        expect { n.save! }.to raise_error(SparkApi::ClientError) { |e| e.status.should == 500 }
+        expect { n.save }.to raise_error(SparkApi::ClientError) { |e| e.status.should == 500 }
+      end
+
+      on_put_it "should allow adding of a note" do
+        n = @note.new(:Note => "lorem ipsum dolor")
+        stub_api_put("#{@note.path}", 'notes/new.json', 'notes/add.json')
+        n.save
+        n.ResourceUri.should == '/v1/listings/20100909200152674436000000/shared/notes/contacts/20110407212043616271000000/'
+      end
+
+    end
+
+    after :each do
+      @note = nil
+    end
+  end
+end

data/spec/unit/spark_api/models/note_spec.rb~

@@ -0,0 +1,63 @@
+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
+
+    context "/listings/<listing_id>/shared/notes/contacts/<contact_id>", :support do
+      on_get_it "GET should get my notes" do
+        stub_api_get("#{@note.path}", 'notes/agent_shared.json')
+        ret = @note.get
+        ret.Note.should == "lorem ipsum dolor sit amet"
+      end
+
+      on_get_it "should return a nil when no shared notes exist" do
+        stub_api_get("#{@note.path}", 'notes/agent_shared_empty.json')
+        @note.get.should be_nil
+      end
+
+      on_delete_it "should allow you to delete an existing note" do
+        stub_api_delete("#{@note.path}", 'generic_delete.json')
+        @note.new.delete # test that no exceptions are raised
+      end
+
+      on_put_it "should raise an exception when adding a note fails" do
+        n = @note.new(:Note => "lorem ipsum dolor")
+
+        stub_api_put("#{@note.path}", 'notes/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 }
+      end
+
+      on_put_it "should allow adding of a note" do
+        n = @note.new(:Note => "lorem ipsum dolor")
+        stub_api_put("#{@note.path}", 'notes/new.json', 'notes/add.json')
+        n.save
+        n.ResourceUri.should == '/v1/listings/20100909200152674436000000/shared/notes/contacts/20110407212043616271000000/'
+      end
+
+    end
+
+    after :each do
+      @note = nil
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require './spec/spec_helper'
+
+describe Notification do
+  before(:each) do
+    stub_auth_request
+  end
+
+  subject do
+    m = Notification.new
+    m.attributes['Type'] = 'OperationComplete'
+    m.attributes['Message'] = 'Your PDF generation has completed!'
+    m.attributes['BrowserUri'] = 'http://myapplication.com/cmas/19581825.pdf'
+    m.attributes['ResourceUri'] = 'http://myapplication.com/cmas/19581825.json'
+    m
+  end
+
+  context "/notifications", :support do
+    on_get_it "should get my notifications" do
+      stub_api_get('/notifications', 'notifications/notifications.json')
+
+      notifications = Notification.get
+      notifications.should be_an(Array)
+      notifications.count.should equal(3)
+    end
+
+    on_post_it "should create a new notification" do
+      stub_api_post("/notifications", 'notifications/new.json', 'notifications/post.json')
+      subject.save.should be(true)
+    end
+
+    on_post_it "should fail saving" do
+      stub_api_post("/notifications", 'notifications/new_empty.json') do |request|
+        request.to_return(:status => 400, :body => fixture('errors/failure.json'))
+      end
+      m = subject.class.new
+      m.attributes['Message'] = 'Your PDF generation has completed!'
+      m.attributes['BrowserUri'] = 'http://myapplication.com/cmas/19581825.pdf'
+      m.attributes['ResourceUri'] = 'http://myapplication.com/cmas/19581825.json'
+      m.save.should be(false)
+      expect{ m.save! }.to raise_error(SparkApi::ClientError){ |e| e.status.should == 400 }
+    end
+  end
+
+  context "/notifications/<notification_id1>,<notification_id2>,...<notification_idN>", :support do
+    on_put_it "should mark notifications as read" do
+      to_mark = [12345678901234567890000001,12345678901234567890000002]
+      stub_api_put("/notifications/#{to_mark.join(',')}",
+                   'notifications/mark_read.json', 'success.json')
+
+      Notification.mark_read(to_mark)
+    end
+  end
+
+  context "/notifications/unread", :support do
+    on_get_it "should get a count of unread notifications" do
+      stub_api_get('/notifications/unread', 'notifications/unread.json', {:_pagination => 'count'})
+
+      notification_count = Notification.unread
+      notification_count.should equal(30)
+    end
+  end
+end

data/spec/unit/spark_api/models/notification_spec.rb~

@@ -0,0 +1,62 @@
+require './spec/spec_helper'
+
+describe Notification do
+  before(:each) do
+    stub_auth_request
+  end
+
+  subject do
+    m = Notification.new
+    m.attributes['Type'] = 'OperationComplete'
+    m.attributes['Message'] = 'Your PDF generation has completed!'
+    m.attributes['BrowserUri'] = 'http://myapplication.com/cmas/19581825.pdf'
+    m.attributes['ResourceUri'] = 'http://myapplication.com/cmas/19581825.json'
+    m
+  end
+
+  context "/notifications", :support do
+    on_get_it "should get my notifications" do
+      stub_api_get('/notifications', 'notifications/notifications.json')
+
+      notifications = Notification.get
+      notifications.should be_an(Array)
+      notifications.count.should equal(3)
+    end
+
+    on_post_it "should create a new notification" do
+      stub_api_post("/notifications", 'notifications/new.json', 'notifications/post.json')
+      subject.save.should be(true)
+    end
+
+    on_post_it "should fail saving" do
+      stub_api_post("/notifications", 'notifications/new_empty.json') do |request|
+        request.to_return(:status => 400, :body => fixture('errors/failure.json'))
+      end
+      m = subject.class.new
+      m.attributes['Message'] = 'Your PDF generation has completed!'
+      m.attributes['BrowserUri'] = 'http://myapplication.com/cmas/19581825.pdf'
+      m.attributes['ResourceUri'] = 'http://myapplication.com/cmas/19581825.json'
+      m.save.should be(false)
+      expect{ m.save! }.to raise_error(FlexmlsApi::ClientError){ |e| e.status.should == 400 }
+    end
+  end
+
+  context "/notifications/<notification_id1>,<notification_id2>,...<notification_idN>", :support do
+    on_put_it "should mark notifications as read" do
+      to_mark = [12345678901234567890000001,12345678901234567890000002]
+      stub_api_put("/notifications/#{to_mark.join(',')}",
+                   'notifications/mark_read.json', 'success.json')
+
+      Notification.mark_read(to_mark)
+    end
+  end
+
+  context "/notifications/unread", :support do
+    on_get_it "should get a count of unread notifications" do
+      stub_api_get('/notifications/unread', 'notifications/unread.json', {:_pagination => 'count'})
+
+      notification_count = Notification.unread
+      notification_count.should equal(30)
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require './spec/spec_helper'
+
+require 'time'
+
+describe OpenHouse do
+  subject do
+    OpenHouse.new(
+      'ResourceUri'=>"/v1/listings/20060412165917817933000000/openhouses/20101127153422574618000000",
+      'Id'=>"20060412165917817933000000",
+      'Date'=>"10/01/2010",
+      'StartTime'=>"09:00:00-07:00",
+      'EndTime'=>"12:00:00-07:00"
+    )
+  end
+
+  it "should respond to a few methods" do
+    subject.class.should respond_to(:find_by_listing_key)
+  end
+
+  it "should return date and times" do
+    start_time = DateTime.new(2010,10,1,9,0,0, "-0700")
+    end_time = DateTime.new(2010,10,1,12,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
+
+  context "/listings/<listing_id>/openhouses", :support do
+    on_get_it "should get open house for a listing" do
+      stub_auth_request
+      stub_api_get('/listings/20060412165917817933000000/openhouses','listings/open_houses.json')
+      houses = subject.class.find_by_listing_key('20060412165917817933000000')
+      houses.should be_an(Array)
+      houses.length.should eq(2)
+      houses.first.Id.should eq("20101127153422574618000000")
+    end
+  end
+
+end

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

@@ -0,0 +1,92 @@
+require './spec/spec_helper'
+
+describe Photo do
+  describe "find" do
+    subject do
+      Photo.new({
+        "ResourceUri" => "/listings/20100815153524571646000000/photos/20101124153422574618000000",
+        "Id"          => "20101124153422574618000000",
+        "Name"        => "Photo 1 name",
+        "Caption"     => "caption here",
+        "UriThumb"    => "http://photos.cdn.flexmls.com/xyz-t.jpg",
+        "Uri300"      => "http://photos.cdn.flexmls.com/xyz.jpg",
+        "Uri640"      => "http://cdn.resize.flexmls.com/az/640x480/true/20101124153422574618000000-o.jpg",
+        "Uri800"      => "http://cdn.resize.flexmls.com/az/800x600/true/20101124153422574618000000-o.jpg",
+        "Uri1024"     => "http://cdn.resize.flexmls.com/az/1024x768/true/20101124153422574618000000-o.jpg",
+        "Uri1280"     => "http://cdn.resize.flexmls.com/az/1280x1024/true/20101124153422574618000000-o.jpg",
+        "UriLarge"    => "http://photos.cdn.flexmls.com/xyz-o.jpg",
+        "Primary"     => true
+      })
+    end
+
+    it "responds to" do
+      subject.should respond_to(:primary?)
+      Photo.should respond_to(:find_by_listing_key)
+    end
+
+    it "knows if it's the primary photo" do
+      subject.primary?.should be_true
+      subject.Primary = false
+      subject.primary?.should be_false
+    end
+  end
+
+  describe "URIs" do
+    subject do
+      p = Photo.build_subclass.tap do |photo|
+        photo.prefix = "/listings/1234"
+        photo.element_name ="/photos"
+      end.new
+      p.update_path = "/listings/1234/photos"
+      p
+    end
+
+    it "should be scoped to a listing" do
+      subject.class.path.should eq("/listings/1234/photos")
+    end
+
+    describe "/listings/<listing_id>/photos", :support  do
+      before(:each) do
+        stub_auth_request
+        stub_api_get('/listings/1234/photos', 'listings/photos/index.json')
+      end
+
+      on_get_it "should get an array of photos" do
+        p = Photo.find_by_listing_key('1234')
+        p.should be_an(Array)
+      end
+
+      on_post_it "should upload a new photo" do
+        stub_api_post('/listings/1234/photos', 'listings/photos/new.json', 'listings/photos/post.json')
+        subject.Name  = "FBS Logo"
+        subject.Caption = "Creators of flexMLS!"
+        subject.load_picture("spec/fixtures/logo_fbs.png")
+        subject.save!
+        subject.Id.should eq("20110826220032167405000000")
+      end
+    end
+
+    describe "/listings/<listing_id>/photos/<photo_id>", :support do
+      before(:each) do
+        stub_auth_request
+      end
+
+      on_put_it "should upload a modified photo" do
+        stub_api_put('/listings/1234/photos/20110826220032167405000000', 'listings/photos/new.json', 'listings/photos/post.json')
+        subject.Id = "20110826220032167405000000"
+        subject.Name  = "FBS Logo"
+        subject.Caption = "Creators of flexMLS!"
+        subject.load_picture("spec/fixtures/logo_fbs.png")
+        subject.save!
+        subject.Id.should eq("20110826220032167405000000")
+      end
+
+      on_delete_it "should delete a photo" do
+        stub_api_delete('/listings/1234/photos/20110826220032167405000000','success.json')
+        subject.Id = "20110826220032167405000000"
+        subject.delete
+      end
+    end
+  end
+
+end