flexmls_api 0.3.2

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

@@ -0,0 +1,174 @@
+require './spec/spec_helper'
+
+describe Listing do
+  before(:each) do
+    @listing = Listing.new({
+      "ResourceUri"=>"/v1/listings/20080619000032866372000000", 
+      "StandardFields"=>{
+        "StreetNumber"=>"********", 
+        "ListingId"=>"07-32", 
+        "City"=>"Fargo", 
+        "Longitude"=>"", 
+        "StreetName"=>"********", 
+        "YearBuilt"=>nil, 
+        "BuildingAreaTotal"=>"1321.0", 
+        "PublicRemarks"=>nil, 
+        "PostalCode"=>"55320", 
+        "ListPrice"=>"100000.0", 
+        "BathsThreeQuarter"=>nil, 
+        "Latitude"=>"", 
+        "StreetDirPrefix"=>nil, 
+        "StreetAdditionalInfo"=>"********", 
+        "PropertyType"=>"A", 
+        "StateOrProvince"=>"ND", 
+        "BathsTotal"=>"0.0", 
+        "BathsFull"=>nil, 
+        "ListingKey"=>"20080619000032866372000000", 
+        "StreetDirSuffix"=>"********", 
+        "BedsTotal"=>2, 
+        "ModificationTimestamp"=>"2010-11-22T23:36:42Z", 
+        "BathsHalf"=>nil, 
+        "CountyOrParish"=>nil,
+        "Photos" => [{
+          "Uri300"=>"http=>//images.dev.fbsdata.com/fgo/20101115201631519737000000.jpg",
+          "ResourceUri"=>"/v1/listings/20080619000032866372000000/photos/20101115201631519737000000",
+          "Name"=>"Designer Entry w/14' Ceilings",
+          "Primary"=>true,
+          "Id"=>"20101115201631519737000000",
+          "Uri800"=>"http=>//devresize.flexmls.com/fgo/800x600/true/20101115201631519737000000-o.jpg",
+          "Uri1024"=>"http=>//devresize.flexmls.com/fgo/1024x768/true/20101115201631519737000000-o.jpg",
+          "UriLarge"=>"http=>//images.dev.fbsdata.com/fgo/20101115201631519737000000-o.jpg",
+          "Caption"=>"apostrophe test for CUR-10508",
+          "Uri1280"=>"http=>//devresize.flexmls.com/fgo/1280x1024/true/20101115201631519737000000-o.jpg",
+          "UriThumb"=>"http=>//images.dev.fbsdata.com/fgo/20101115201631519737000000-t.jpg",
+           "Uri640"=>"http=>//devresize.flexmls.com/fgo/640x480/true/20101115201631519737000000-o.jpg"
+        }]
+      }, 
+      "Id"=>"20080619000032866372000000"
+    })
+
+  end
+
+  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
+    end
+
+    it "should not respond to removed attributes" do
+      @listing.should_not respond_to(:Photos)
+      @listing.should_not respond_to(:Documents)
+      @listing.should_not respond_to(:VirtualTours)
+      @listing.should_not respond_to(:Videos)
+    end
+
+  end
+
+  describe "class methods" do
+    it "should respond to find" do
+      Listing.should respond_to(:find)
+    end
+
+    it "should respond to first" do
+      Listing.should respond_to(:first)
+    end
+
+    it "should respond to last" do
+      Listing.should respond_to(:last)
+    end
+
+    it "should respond to my" do
+      Listing.should respond_to(:my)
+    end
+    
+    it "should respond to find_by_cart_id" do
+      Listing.should respond_to(:find_by_cart_id)
+    end
+  end
+
+  describe "subresources" do
+    before 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'))
+      
+      l = Listing.find('1234', :ApiUser => "foobar", :_expand => "Photos")
+      l.photos.length.should == 5
+      l.documents.length.should == 0
+      l.videos.length.should == 0
+      l.virtual_tours.length.should == 0
+    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'))
+      
+      l = Listing.find('1234', :ApiUser => "foobar", :_expand => "Documents")
+      l.photos.length.should == 0
+      l.documents.length.should == 2
+      l.videos.length.should == 0
+      l.virtual_tours.length.should == 0
+    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'))
+      
+      l = Listing.find('1234', :ApiUser => "foobar", :_expand => "VirtualTours")
+      l.virtual_tours.length.should == 1
+      l.photos.length.should == 0
+      l.documents.length.should == 0
+      l.videos.length.should == 0
+    end
+
+
+    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'))
+      
+      l = Listing.find('1234', :ApiUser => "foobar", :_expand => "Videos")
+      l.videos.length.should == 2
+      l.virtual_tours.length.should == 0
+      l.photos.length.should == 0
+      l.documents.length.should == 0
+    end 
+
+
+  end
+
+  after(:each) do  
+    @listing = nil
+  end
+
+
+end

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

@@ -0,0 +1,59 @@
+require './spec/spec_helper'
+
+describe Photo do
+  before(:each) do
+    @photo = 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
+    @photo.should respond_to(:primary?)
+    Photo.should respond_to(:find_by_listing_key)
+  end
+
+  it "knows if it's the primary photo" do
+    @photo.primary?.should be_true
+    @photo.Primary = false
+    @photo.primary?.should be_false
+  end
+
+  describe "find photos by listing id"  do
+    before do
+      stub_auth_request
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234/photos").
+                   with(:query => {
+                     :ApiSig => "d060aa12d3ef573aff7298302e0237fa", 
+                     :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+                     :ApiUser => "foobar"
+                   }).
+                   to_return(:body => fixture('listing_photos_index.json'))
+    end
+
+    it "should get an array of photos" do
+      p = Photo.find_by_listing_key('1234', 'foobar')
+      p.should be_an Array
+    end
+
+  end
+
+
+  after(:each) do  
+    @photo = nil
+  end
+
+
+end

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

@@ -0,0 +1,20 @@
+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
+  
+
+  after(:each) do 
+    @proptypes = nil
+  end
+
+end

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

@@ -0,0 +1,42 @@
+require './spec/spec_helper'
+
+describe StandardFields do
+  before(:each) do 
+    @stdfields = StandardFields.new({
+      "StreetNumber"=>{"Searchable"=>false}, 
+      "ListingId"=>{"Searchable"=>true}, 
+      "City"=>{"Searchable"=>true}, 
+      "Longitude"=>{"Searchable"=>false}, 
+      "StreetName"=>{"Searchable"=>false}, 
+      "YearBuilt"=>{"Searchable"=>true}, 
+      "BuildingAreaTotal"=>{"Searchable"=>true}, 
+      "PublicRemarks"=>{"Searchable"=>false}, 
+      "PostalCode"=>{"Searchable"=>true}, 
+      "ListPrice"=>{"Searchable"=>true}, 
+      "BathsThreeQuarter"=>{"Searchable"=>true}, 
+      "Latitude"=>{"Searchable"=>false}, 
+      "StreetDirPrefix"=>{"Searchable"=>false}, 
+      "StreetAdditionalInfo"=>{"Searchable"=>false}, 
+      "PropertyType"=>{"Searchable"=>true}, 
+      "StateOrProvince"=>{"Searchable"=>true}, 
+      "BathsTotal"=>{"Searchable"=>true}, 
+      "BathsFull"=>{"Searchable"=>true}, 
+      "ListingKey"=>{"Searchable"=>false}, 
+      "StreetDirSuffix"=>{"Searchable"=>false}, 
+      "BedsTotal"=>{"Searchable"=>true}, 
+      "ModificationTimestamp"=>{"Searchable"=>false}, 
+      "BathsHalf"=>{"Searchable"=>true}, 
+      "CountyOrParish"=>{"Searchable"=>true}
+    })
+  end
+
+  it "should respond to get" do
+    StandardFields.should respond_to(:get)
+  end
+  
+
+  after(:each) do 
+    @stdfields = nil
+  end
+
+end

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

@@ -0,0 +1,37 @@
+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 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
+
+  after(:each) do 
+    @sysinfo = nil
+  end
+
+end

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

@@ -0,0 +1,43 @@
+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 "find videos by listing id"  do
+    before do
+      stub_auth_request
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234/videos").
+                   with(:query => {
+                     :ApiSig => "c95bfef766128b91a2643fcc2fa40dfc", 
+                     :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+                     :ApiUser => "foobar"
+                   }).
+                   to_return(:body => fixture('listing_videos_index.json'))
+    end
+
+    it "should get an array of videos" do
+      p = Video.find_by_listing_key('1234', 'foobar')
+      p.should be_an Array
+      p.length.should == 2
+    end
+
+  end
+
+
+
+
+end

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

@@ -0,0 +1,46 @@
+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
+
+  it "should get virtual tours for a listing" do
+    stub_auth_request
+    stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings/1234/virtualtours").
+          with( :query => { 
+            :ApiSig => "1cb60934d68b64e5eaaab4aff4b7cd3a", 
+            :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+            :ApiUser => "foobar"
+          }).
+          to_return(:body => fixture('listing_virtual_tours_index.json'))
+
+    v = VirtualTour.find_by_listing_key('1234', "foobar")
+    v.should be_an Array
+    v.length.should == 5
+  end
+
+
+
+  after(:each) do
+    @virtualtour = nil
+  end
+
+end

data/spec/unit/flexmls_api/paginate_spec.rb

@@ -0,0 +1,221 @@
+require './spec/spec_helper'
+
+class PaginateResponseTester
+  include FlexmlsApi::PaginateResponse
+end
+
+class PaginateModelTester < FlexmlsApi::Models::Base
+  @tester = PaginateResponseTester.new
+  attr_accessor :val
+  def initialize (val)
+    @val = val
+  end
+  class << self
+    attr_accessor :options
+    def get(options)
+      @options = options
+      json = "{#{paginate_json}}"
+      hash = JSON.parse(json)
+      results = @tester.paginate_response([1,2,3,4,5,6,7,8,9,10], hash["Pagination"])
+      collect(results)
+    end
+  end
+end
+
+class PaginateModelTester50 < PaginateModelTester
+  @tester = PaginateResponseTester.new
+  def self.per_page
+      50
+  end
+end
+
+
+describe FlexmlsApi::PaginateResponse do
+
+  describe "paginate_response" do
+    subject { PaginateResponseTester.new } 
+    it "should give me the first page" do
+      json = "{#{paginate_json}}"
+      hash = JSON.parse(json)
+      results = subject.paginate_response([1,2,3,4,5,6,7,8,9,10], hash["Pagination"])
+      results.offset.should eq 0
+      results.next_page.should eq 2
+      results.previous_page.should eq nil
+      results.current_page.should eq 1
+      results.per_page.should eq 10
+      results.total_pages.should eq 4
+      results.total_entries.should eq 38
+      results[0].should eq 1
+    end
+    it "should give me the second page" do
+      json = "{#{paginate_json(2)}}"
+      hash = JSON.parse(json)
+      results = subject.paginate_response([11,12,13,14,15,16,17,18,19,20], hash["Pagination"])
+      results.offset.should eq 10
+      results.next_page.should eq 3
+      results.previous_page.should eq 1
+      results.current_page.should eq 2
+      results.per_page.should eq 10
+      results.total_pages.should eq 4
+      results.total_entries.should eq 38
+      results[0].should eq 11
+    end
+    it "should give me the third page" do
+      json = "{#{paginate_json(3)}}"
+      hash = JSON.parse(json)
+      results = subject.paginate_response([21,22,23,24,25,26,27,28,29,30], hash["Pagination"])
+      results.offset.should eq 20
+      results.next_page.should eq 4
+      results.previous_page.should eq 2
+      results.current_page.should eq 3
+      results.per_page.should eq 10
+      results.total_pages.should eq 4
+      results.total_entries.should eq 38
+      results[0].should eq 21
+    end
+    it "should give me the last page" do
+      json = "{#{paginate_json(4)}}"
+      hash = JSON.parse(json)
+      results = subject.paginate_response([31,32,33,34,35,36,37,38], hash["Pagination"])
+      results.offset.should eq 30
+      results.next_page.should eq nil
+      results.previous_page.should eq 3
+      results.current_page.should eq 4
+      results.per_page.should eq 10
+      results.total_pages.should eq 4
+      results.total_entries.should eq 38
+      results[0].should eq 31
+      results[-1].should eq 38
+    end
+  end
+end
+
+describe FlexmlsApi::Paginate do
+  describe "paginate" do
+    it "should give me a will paginate collection" do
+      results = PaginateModelTester.paginate(:page => 1)
+      results.class.should eq WillPaginate::Collection
+      results.offset.should eq 0
+      results.next_page.should eq 2
+      results.previous_page.should eq nil
+      results.current_page.should eq 1
+      results.per_page.should eq 10
+      results.total_pages.should eq 4
+      results.total_entries.should eq 38
+      
+      results[0].class.should eq PaginateModelTester
+      results[0].val.should eq 1
+      
+    end
+      
+    it "should give me pagination options" do
+      PaginateModelTester.paginate(:page => 1)
+      opts = PaginateModelTester.options
+      opts["_pagination"].should eq 1
+      opts["_limit"].should eq 25
+      opts["_page"].should eq 1
+      opts.has_key?(:page).should eq false
+    end
+  end
+
+  describe "per_page" do
+    it "should set the default model max results per page" do
+      results = PaginateModelTester50.paginate(:page => 1)
+      opts = PaginateModelTester50.options
+      opts["_limit"].should eq 50
+    end
+  end
+  
+  # non unit-y real world test of paginations with listings
+  context "paginating listings" do
+    before do
+      stub_auth_request
+    end
+
+    subject { FlexmlsApi::Models::Listing }
+    it "gives me page one of listings" do
+      json = <<-JSON 
+        {"D": {
+          "Success": true, 
+          "Results": [#{ListingJson.create_all(10)}],
+          #{paginate_json}
+        }
+      JSON
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings").
+        with(:query => {
+          :ApiSig => "538a4c5ff5d24b0bbf3ad1ef27bdd4cd",
+          :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+          :_limit => '10',
+          :_page => '1',
+          :_pagination => '1'
+        }).
+        to_return(:body => json)
+      results = subject.paginate(:page=>1, :per_page=>10)
+      results.class.should eq WillPaginate::Collection
+      results.offset.should eq 0
+      results.next_page.should eq 2
+      results.previous_page.should eq nil
+      results.current_page.should eq 1
+      results.per_page.should eq 10
+      results.total_pages.should eq 4
+      results.total_entries.should eq 38
+      results.length.should eq 10
+      
+      results[0].class.should eq subject
+      results[0].ListPrice.should eq 50000.0
+      
+    end
+    it "gives me page two of listings" do
+      json = <<-JSON 
+        {"D": {
+          "Success": true, 
+          "Results": [#{ListingJson.create_all(10)}],
+          #{paginate_json(2)}
+        }
+      JSON
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings").
+        with(:query => {
+          :ApiSig => "1f156d976097026315573af0ce112174",
+          :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+          :_limit => '10',
+          :_page => '2',
+          :_pagination => '1'
+        }).
+        to_return(:body => json)
+      results = subject.paginate(:page=>2, :per_page=>10)
+      results.next_page.should eq 3
+      results.previous_page.should eq 1
+      results.current_page.should eq 2
+    end
+    it "gives me page four of listings" do
+      json = <<-JSON 
+        {"D": {
+          "Success": true, 
+          "Results": [#{ListingJson.create_all(8)}],
+          #{paginate_json(4)}
+        }
+      JSON
+      stub_request(:get, "#{FlexmlsApi.endpoint}/#{FlexmlsApi.version}/listings").
+        with(:query => {
+          :ApiSig => "a1961de57c3129a8b68cb1aae97b168d",
+          :AuthToken => "c401736bf3d3f754f07c04e460e09573",
+          :_limit => '10',
+          :_page => '4',
+          :_pagination => '1'
+        }).
+        to_return(:body => json)
+      results = subject.paginate(:page=>4, :per_page=>10)
+      results.next_page.should eq nil
+      results.previous_page.should eq 3
+      results.current_page.should eq 4
+      results.per_page.should eq 10
+      results.total_pages.should eq 4
+      results.total_entries.should eq 38
+      
+      results.length.should eq 8
+      results[0].class.should eq subject
+      results[0].ListPrice.should eq 50000.0
+    end
+    
+  end
+end