spark_api 1.0.0

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

@@ -0,0 +1,33 @@
+require './spec/spec_helper'
+
+describe PropertyTypes do
+  before(:each) do
+    @proptypes = PropertyTypes.new({
+      "MlsName"=>"Residential",
+      "MlsCode"=>"A"
+    })
+  end
+
+  it "should respond to get" do
+    PropertyTypes.should respond_to(:get)
+  end
+
+  describe "/propertytypes", :support do
+    before(:each) do
+      stub_auth_request
+    end
+
+    on_get_it "should return a list of property types" do
+      stub_api_get("/propertytypes", "property_types/property_types.json")
+
+      types = PropertyTypes.get
+      types.should be_an(Array)
+      types.count.should be(6)
+    end
+  end
+
+  after(:each) do
+    @proptypes = nil
+  end
+
+end

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

@@ -0,0 +1,40 @@
+require './spec/spec_helper'
+
+describe SavedSearch do
+
+  before(:each) do
+    stub_auth_request
+  end
+
+  let(:id){ "20100815220615294367000000" }
+
+  context "/savedsearches", :support do
+    on_get_it "should get all SavedSearches" do
+      stub_api_get("/#{subject.class.element_name}", 'listings/saved_search.json')
+      resources = subject.class.get
+      resources.should be_an(Array)
+      resources.length.should eq(2)
+      resources.first.Id.should eq(id)
+    end
+  end
+
+  context "/savedsearches/<search_id>", :support do
+    on_get_it "should get a SavedSearch" do
+      stub_api_get("/#{subject.class.element_name}/#{id}", 'listings/saved_search.json')
+      resource = subject.class.find(id)
+      resource.Id.should eq(id)
+      resource.Name.should eq("Search name here")
+    end
+  end
+
+  context "/provided/savedsearches", :support do
+    on_get_it "should get provided SavedSearches" do
+      stub_api_get("/provided/#{subject.class.element_name}", 'listings/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
+
+end

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

@@ -0,0 +1,45 @@
+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
+
+  context "/sharedlistings", :support do
+    on_post_it "should create shared listings" do
+      stub_api_post("/#{subject.class.element_name}", 'listings/shared_listing_new.json', 'listings/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
+
+    on_post_it "should fail creating" 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(SparkApi::ClientError){ |e| e.status.should == 400 }
+    end
+  end
+
+  context "/sharedlistings/<shared_listing_id>", :support do
+    on_get_it "should get shared listing" do
+      shared_id = '15Ar'
+      stub_api_get("/#{subject.class.element_name}/#{shared_id}",
+                   'listings/shared_listing_get.json')
+
+      shared = SharedListing.find(shared_id)
+      shared.should respond_to('SharedUri')
+      shared.Mode.should eq('Public')
+      shared.ListingIds.should be_an(Array)
+    end
+  end
+
+end

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

@@ -0,0 +1,45 @@
+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
+
+  context "/sharedlistings", :support do
+    on_post_it "should create shared listings" do
+      stub_api_post("/#{subject.class.element_name}", 'listings/shared_listing_new.json', 'listings/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
+
+    on_post_it "should fail creating" 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
+
+  context "/sharedlistings/<shared_listing_id>", :support do
+    on_get_it "should get shared listing" do
+      shared_id = '15Ar'
+      stub_api_get("/#{subject.class.element_name}/#{shared_id}",
+                   'listings/shared_listing_get.json')
+
+      shared = SharedListing.find(shared_id)
+      shared.should respond_to('SharedUri')
+      shared.Mode.should eq('Public')
+      shared.ListingIds.should be_an(Array)
+    end
+  end
+
+end

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

@@ -0,0 +1,60 @@
+require './spec/spec_helper'
+
+describe StandardFields do
+
+  before(:each) do
+    stub_auth_request
+  end
+
+  it "should respond to get" do
+    StandardFields.should respond_to(:get)
+  end
+
+  it "should find and expand all" do
+    StandardFields.should respond_to(:find_and_expand_all)
+
+    # stub request to standardFields
+    stub_api_get('/standardfields','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
+
+  context "/standardfields/nearby/<property_type>", :support do
+    on_get_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/spark_api/models/system_info_spec.rb

@@ -0,0 +1,83 @@
+require './spec/spec_helper'
+
+describe SystemInfo do
+  before(:each) do 
+    @sysinfo = SystemInfo.new({
+      "Name"=>"beh  apiuser", 
+      "OfficeId"=>"20071029204441159539000000", 
+      "Configuration"=>[{
+        "IdxDisclaimer"=>""
+      }], 
+      "Id"=>"20101206154326670813000000", 
+      "MlsId"=>"20000809145531659995000000", 
+      "Office"=>"", 
+      "Mls"=>"Fargo-Moorhead MLS"
+    })
+  end
+
+  it "should respond to get" 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)
+    end
+    @sysinfo.Configuration.should be_a(Array)
+  end
+
+  it "should have an array of config items" do
+    @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
+
+  context "/system", :support do
+    on_get_it "should return system settings and configuration"
+  end
+
+  context "/system/languages", :support do
+    on_get_it "should return a list of languages"
+  end
+
+  context "/system/accounts", :support do
+    on_get_it "should return account metadata"
+  end
+
+  after(:each) do 
+    @sysinfo = nil
+  end
+
+end

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

@@ -0,0 +1,44 @@
+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
+
+  context "/listings/<listing_id>/tourofhomes", :support do
+    on_get_it "should get home tours for a listing" do
+      stub_auth_request
+      stub_api_get('/listings/20060725224713296297000000/tourofhomes','listings/tour_of_homes.json')
+      v = subject.class.find_by_listing_key('20060725224713296297000000')
+      v.should be_an(Array)
+      v.length.should == 2
+    end
+  end
+
+  context "/listings/<listing_id>/tourofhomes/<tour_id>", :support do
+    on_get_it "should get information for a single tour of a home"
+  end
+
+end

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

@@ -0,0 +1,36 @@
+require './spec/spec_helper'
+
+describe Video do
+
+  it "responds to" do
+    Video.should respond_to(:find_by_listing_key)
+    Video.new.should respond_to(:branded?)
+    Video.new.should respond_to(:unbranded?)
+  end
+
+  it "has a type" do
+    Video.new(:Type => "branded").branded?.should == true
+    Video.new(:Type => "unbranded").branded?.should == false
+    Video.new(:Type => "unbranded").unbranded?.should == true
+    Video.new(:Type => "branded").unbranded?.should == false
+  end
+
+  describe "/listings/<listing_id>/videos", :support do
+    before do
+      stub_auth_request
+      stub_api_get('/listings/1234/videos','listings/videos_index.json')
+    end
+
+    on_get_it "should get an array of videos" do
+      p = Video.find_by_listing_key('1234')
+      p.should be_an(Array)
+      p.length.should == 2
+    end
+
+  end
+
+  context "/listings/<listing_id>/videos/<video_id>", :support do
+    on_get_it "should return information about a single video"
+  end
+
+end

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

@@ -0,0 +1,44 @@
+require './spec/spec_helper'
+
+describe VirtualTour do
+  before(:each) do
+    @virtualtour = VirtualTour.new({
+      :Uri => "http://www.flexmls.com/",
+      :ResourceUri => "/v1/listings/20060712220814669202000000/virtualtours/20110105165843978012000000",
+      :Name => "My Branded Tour",
+      :Id => "20110105165843978012000000",
+      :Type => "branded"
+    })
+  end
+
+  it "should respond to a few methods" do
+    VirtualTour.should respond_to(:find_by_listing_key)
+    @virtualtour.should respond_to(:branded?)
+    @virtualtour.should respond_to(:unbranded?)
+  end
+
+  it "should know if it's branded" do
+    @virtualtour.branded?.should == true
+    @virtualtour.unbranded?.should == false
+  end
+
+  context "/listings/<listing_id>/virtualtours", :support do
+    on_get_it "should get virtual tours for a listing" do
+      stub_auth_request
+      stub_api_get('/listings/1234/virtualtours','listings/virtual_tours_index.json')
+
+      v = VirtualTour.find_by_listing_key('1234')
+      v.should be_an(Array)
+      v.length.should == 5
+    end
+  end
+
+  context "/listings/<listing_id>/virtualtours/<tour_id>", :support do
+    on_get_it "should return information about a specific virtual tour"
+  end
+
+  after(:each) do
+    @virtualtour = nil
+  end
+
+end

data/spec/unit/spark_api/multi_client_spec.rb

@@ -0,0 +1,56 @@
+require './spec/spec_helper'
+
+# Test client implemenations for multi client switching
+module SparkApi
+  def self.test_client_a
+    Thread.current[: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 SparkApi::MultiClient do
+  it "should activate a client implemenation when activate()" do
+    SparkApi.activate(:test_client_a)
+    SparkApi.client.api_key.should eq('a')
+    SparkApi.activate(:test_client_b)
+    SparkApi.client.api_key.should eq('b')
+    SparkApi.activate(:test_client_c)
+    SparkApi.client.api_key.should eq('c')
+    SparkApi.activate(:test_client_a)
+    SparkApi.client.api_key.should eq('a')
+  end
+  it "should fail to activate symbols that do not have implementations" do
+    expect { SparkApi.activate(:test_client_d) }.to raise_error(ArgumentError)
+  end
+  
+  it "should temporarily activate a client implemenation when activate() block" do
+    SparkApi.activate(:test_client_a)
+    SparkApi.client.api_key.should eq('a')
+    SparkApi.activate(:test_client_b) do
+      SparkApi.client.api_key.should eq('b')
+    end
+    SparkApi.client.api_key.should eq('a')
+    expect do
+      SparkApi.activate(:test_client_c) do
+        SparkApi.client.api_key.should eq('c')
+        raise "OH MY GOODNESS I BLEW UP!!!"
+      end
+    end.to raise_error
+    SparkApi.client.api_key.should eq('a')
+  end
+
+  context "yaml" do
+    it "should activate a client implemenation when activate()" do
+      SparkApi::Configuration::YamlConfig.stub(:config_path) { "spec/config/spark_api" }
+      SparkApi.activate(:test_key)
+      SparkApi.client.api_key.should eq('demo_key')
+    end
+  end
+  
+end
+