you_got_listed 0.2.0

data/spec/you_got_listed/accounts_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe YouGotListed::Accounts do
+  
+  before do
+    @ygl = new_ygl
+    @accounts = YouGotListed::Accounts.new(@ygl)
+  end
+  
+  context "search" do
+    before do
+      VCR.use_cassette('accounts.search') do
+        @response = @accounts.search
+      end
+    end
+    
+    it "should be a success" do
+      @response.success?.should be_true
+    end
+    
+    it "should set accounts on the response" do
+      @response.ygl_response.accounts.should be_kind_of(Hashie::Rash)
+    end
+  end
+  
+end

data/spec/you_got_listed/agent_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe YouGotListed::Agent do
+  
+  before do
+    @ygl = new_ygl
+    @agent = YouGotListed::Agent.new(@ygl)
+  end
+  
+  context "find_all" do
+    before do
+      VCR.use_cassette('agent.find_all') do
+        @response = @agent.find_all
+      end
+    end
+    
+    it "should be a success" do
+      @response.success?.should be_true
+    end
+    
+    it "should return an array of agents" do
+      @response.agents.agent.should_not be_nil
+      @response.agents.agent.should be_kind_of(Array)
+    end
+  end
+  
+  context "successful find" do
+    before do
+      VCR.use_cassette('agent.find_all') do
+        @valid_agent_id = @agent.find_all.agents.agent.first.id
+      end
+      VCR.use_cassette('agent.find') do
+        @response = @agent.find(@valid_agent_id)
+      end
+    end
+    
+    it "should be a success" do
+      @response.success?.should be_true
+    end
+    
+    it "should return an array of agents" do
+      @response.agents.agent.should_not be_nil
+      @response.agents.agent.should be_kind_of(Hashie::Rash)
+    end
+  end
+  
+  context "unsuccessful find" do
+    it "should raise an exception" do
+      lambda {
+        VCR.use_cassette('agent.find.error') do
+          @response = @agent.find('AG-001-0499957')
+        end
+      }.should raise_exception(YouGotListed::Error, "YouGotListed Error: Invalid user id. (code: 301)")
+    end
+  end
+  
+  context "successful find_by_id" do
+    before do
+      VCR.use_cassette('agent.find_all') do
+        @valid_agent_id = @agent.find_all.agents.agent.first.id
+      end
+      VCR.use_cassette('agent.find') do
+        @response = @agent.find_by_id(@valid_agent_id)
+      end
+    end
+    
+    it "should be a success" do
+      @response.success?.should be_true
+    end
+    
+    it "should return an array of agents" do
+      @response.agents.agent.should_not be_nil
+      @response.agents.agent.should be_kind_of(Hashie::Rash)
+    end
+  end
+  
+  context "unsuccessful find_by_id" do
+    it "should raise an exception" do
+      lambda {
+        VCR.use_cassette('agent.find.error') do
+          @response = @agent.find_by_id('AG-001-0499957')
+        end
+      }.should_not raise_exception
+    end
+    
+    it "should not be a success" do
+      VCR.use_cassette('agent.find.error') do
+        @response = @agent.find_by_id('AG-001-0499957')
+      end
+      @response.success?.should be_false
+    end
+  end
+  
+end

data/spec/you_got_listed/client_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe YouGotListed::Client do
+  
+  before do
+    @ygl = new_ygl
+  end
+  
+  it "should set the api_key" do
+    @ygl.class.default_params.should == {:key => YGL_API_KEY}
+  end
+  
+  it "should set the base uri" do
+    @ygl.class.base_uri.should == "https://yougotlistings.com/api"
+  end
+  
+end

data/spec/you_got_listed/complex_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe YouGotListed::Complex do
+  
+  before do
+    @ygl = new_ygl
+    @complex = YouGotListed::Complex.new(valid_complex_rash, @ygl)
+  end
+  
+  it "should return photos for pictures" do
+    @complex.pictures.should == @complex.photos.photo
+  end
+  
+  it "should create methods from all hash keys" do
+    @complex.should respond_to("id", "name", "addresses", "public_notes", "photos", "listings")
+  end
+  
+  it "should return an array of properties" do
+    @complex.properties.should be_kind_of(Array)
+    @complex.properties.each do |property|
+      property.should be_kind_of(YouGotListed::Listing)
+    end
+    @complex.properties.size.should == 2
+  end
+  
+end

data/spec/you_got_listed/complexes_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe YouGotListed::Complexes do
+  
+  before do
+    @ygl = new_ygl
+    @complexes = YouGotListed::Complexes.new(@ygl)
+  end
+  
+  context "search" do
+    before do
+      VCR.use_cassette('complexes.search') do
+        @response = @complexes.search
+      end
+    end
+    
+    it { @response.should be_kind_of(YouGotListed::Complexes::SearchResponse) }
+    it { @response.success?.should be_true }
+    
+    context "search response" do
+      it { @response.should be_kind_of(YouGotListed::Response) }
+      it { @response.should respond_to(:property_complexes, :paginator) }
+      
+      it "should return an array of property_complexes" do
+        @response.property_complexes.should be_kind_of(Array)
+        @response.property_complexes.each do |property|
+          property.should be_kind_of(YouGotListed::Complex)
+        end
+      end
+      
+      it "should return a will_paginate collection" do
+        @response.paginator.should be_kind_of(WillPaginate::Collection)
+        @response.paginator.collect{|p| p.id}.should == @response.property_complexes.collect{|p| p.id}
+      end
+    end
+  end
+  
+  context "find_by_id" do
+    context "valid id" do
+      before do
+        VCR.use_cassette('complexes.search') do
+          @valid_complex_id = @complexes.search.property_complexes.first.id
+        end
+        VCR.use_cassette('complexes.find_by_id') do
+          @complex = @complexes.find_by_id(@valid_complex_id)
+        end
+      end
+      
+      it { @complex.should be_kind_of(YouGotListed::Complex) }
+    end
+    
+    context "missing id" do
+      before do
+        VCR.use_cassette('complexes.find_by_id_missing') do
+          @complex = @complexes.find_by_id('CSM-111-382')
+        end
+      end
+      
+      it { @complex.should be_nil }
+    end
+    
+    context "invalid id" do
+      it "should not raise an exception" do
+        lambda {
+          VCR.use_cassette('complexes.find_by_id_invalid') do
+            @complex = @complexes.find_by_id('CAM')
+          end
+        }.should_not raise_exception
+      end
+      
+      it "should be nil" do
+        VCR.use_cassette('complexes.find_by_id_invalid') do
+          @complex = @complexes.find_by_id('CAM')
+        end
+        @complex.should be_nil
+      end
+    end
+  end
+  
+end

data/spec/you_got_listed/error_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe YouGotListed::Error do
+  
+  it "should set a message" do
+    @error = YouGotListed::Error.new(300, 'Account retrieving failed.')
+    @error.message.should == "YouGotListed Error: Account retrieving failed. (code: 300)"
+  end
+  
+end

data/spec/you_got_listed/lead_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe YouGotListed::Lead do
+  
+  before do
+    @ygl = new_ygl
+    @lead = YouGotListed::Lead.new(@ygl)
+    @success_params = {:first_name => "You", :last_name => "GotListed", :email => "ygl@gmail.com"}
+    @failed_params = {}
+  end
+  
+  context "create" do
+    context "a successful creation" do
+      it "should not raise an exception" do
+        lambda {
+          VCR.use_cassette('lead.create.error') do
+            @response = @lead.create(@success_params)
+          end
+        }.should_not raise_exception
+      end
+    end
+    
+    context "a failed creation" do
+      it "should raise an exception" do
+        lambda {
+          VCR.use_cassette('lead.create.error') do
+            @response = @lead.create(@failed_params)
+          end
+        }.should_not raise_exception
+      end
+    end
+  end
+  
+  context "create!" do
+    context "a successful creation" do
+      it "should not raise an exception" do
+        lambda {
+          VCR.use_cassette('lead.create.error') do
+            @response = @lead.create!(@success_params)
+          end
+        }.should_not raise_exception
+      end
+    end
+    
+    context "a failed creation" do
+      it "should raise an exception" do
+        lambda {
+          VCR.use_cassette('lead.create.error') do
+            @response = @lead.create!(@failed_params)
+          end
+        }.should raise_exception(YouGotListed::Error, "YouGotListed Error: Lead first name not specified. (code: 303)")
+      end
+    end
+  end
+  
+end

data/spec/you_got_listed/listing_spec.rb

@@ -0,0 +1,110 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe YouGotListed::Listing do
+  
+  before do
+    @ygl = new_ygl
+    @listing = YouGotListed::Listing.new(valid_listing_rash, @ygl)
+  end
+  
+  it "should create methods from all hash keys" do
+    @listing.should respond_to(
+      "unit_level", "pet", "include_hot_water", "square_footage", "external_id", "zip", "student_policy", 
+      "building_id", "parking", "split", "city", "neighborhood", "fee", "heat_source", "street_name", 
+      "price", "building_type", "include_heat", "beds", "id", "agency_id", "status", "source", 
+      "longitude", "available_date", "include_electricity", "latitude", "street_number", "unit", 
+      "include_gas", "state", "baths", "photos"
+    )
+  end
+  
+  it "should return ygl id for id" do
+    @listing.id.should == "BOS-182-933"
+  end
+  
+  it "should return the city - neighborhood for town_neighborhood" do
+    @listing.town_neighborhood.should == 'Boston - Fenway'
+  end
+  
+  it "should return the city_neighborhood search param for city_neighborhood" do
+    @listing.city_neighborhood.should == 'Boston:Fenway'
+  end
+  
+  it "should return photos for pictures" do
+    @listing.pictures.should == @listing.photos.photo
+  end
+  
+  context "default similar listings" do
+    before do
+      VCR.use_cassette('listing.similar_listings') do
+        @similar_props = @listing.similar_listings
+      end
+    end
+    
+    it "should return an array of listings" do
+      @similar_props.should be_kind_of(Array)
+      @similar_props.should have_at_most(6).listings
+      @similar_props.collect{|x| x.id}.should_not include(@listing.id)
+    end
+  end
+  
+  context "similar listings with custom limit" do
+    before do
+      VCR.use_cassette('listing.similar_listings') do
+        @similar_props = @listing.similar_listings(4)
+      end
+    end
+    
+    it "should return an array of listings" do
+      @similar_props.should be_kind_of(Array)
+      @similar_props.should have_at_most(4).listings
+      @similar_props.collect{|x| x.id}.should_not include(@listing.id)
+    end
+  end
+  
+  context "mls_listing" do
+    before do
+      @listing = YouGotListed::Listing.new(valid_listing_rash.merge(:source => 'MLS'), @ygl)
+    end
+    
+    it "should be a mls_listing" do
+      @listing.mls_listing?.should be_true
+    end
+  end
+  
+  context "main_picture" do
+    it "should return the first photo" do
+      @listing.main_picture.should == @listing.pictures.first
+      @listing.main_picture.should == "http://yougotlistings.com/photos/AC-000-103/500141.jpg"
+    end
+    
+    it "should return nil if no pictures" do
+      @listing.stub!(:pictures).and_return(nil)
+      @listing.main_picture.should be_nil
+    end
+  end
+  
+  context "latitude" do
+    it "should return a float" do
+      @listing.latitude.should be_kind_of(Float)
+      @listing.latitude.should == 42.346182
+    end
+    
+    it "should return nil if blank" do
+      @listing = YouGotListed::Listing.new(valid_listing_rash.merge(:latitude => ''), @ygl)
+      @listing.latitude.should be_nil
+    end
+  end
+  
+  context "longitude" do
+    it "should return a float" do
+      @listing.longitude.should be_kind_of(Float)
+      @listing.longitude.should == -71.104427
+    end
+    
+    it "should return nil if blank" do
+      @listing = YouGotListed::Listing.new(valid_listing_rash.merge(:longitude => ''), @ygl)
+      @listing.longitude.should be_nil
+    end
+  end
+  
+end

data/spec/you_got_listed/listings_spec.rb

@@ -0,0 +1,229 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe YouGotListed::Listings do
+  
+  before do
+    @ygl = new_ygl
+    @listings = YouGotListed::Listings.new(@ygl)
+  end
+  
+  context "search" do
+    before do
+      VCR.use_cassette('listings.search') do
+        @response = @listings.search
+      end
+    end
+    
+    it { @response.should be_kind_of(YouGotListed::Listings::SearchResponse) }
+    it { @response.success?.should be_true }
+    
+    context "search response" do
+      it { @response.should be_kind_of(YouGotListed::Response) }
+      it { @response.should respond_to(:properties, :paginator) }
+      
+      it "should return an array of properties" do
+        @response.properties.should be_kind_of(Array)
+        @response.properties.each do |property|
+          property.should be_kind_of(YouGotListed::Listing)
+        end
+      end
+      
+      it "should return a will_paginate collection" do
+        @response.paginator.should be_kind_of(WillPaginate::Collection)
+        @response.paginator.collect{|p| p.id}.should == @response.properties.collect{|p| p.id}
+      end
+    end
+  end
+  
+  context "mls_search" do
+    before do
+      VCR.use_cassette('listings.mls_search') do
+        @response = @listings.search(:include_mls => "1")
+        @response.properties.first.stub!(:source).and_return('MLS')
+      end
+    end
+    
+    context "search response" do
+      it { @response.mls_results?.should be_true }
+    end
+  end
+  
+  context "featured" do
+    before do 
+      VCR.use_cassette('listings.featured') do
+        @response = @listings.featured
+      end
+    end
+    
+    it "should only return featured properties" do
+      @response.properties.find_all{|p| p.tags && p.tags.tag.include?('Featured Rentals')}.size.should == @response.properties.size
+    end
+  end
+  
+  context "find_by_id" do
+    context "valid id" do
+      before do
+        VCR.use_cassette('listings.search') do
+          @valid_listing_id = @listings.search.properties.first.id
+        end
+        VCR.use_cassette('listings.find_by_id') do
+          @listing = @listings.find_by_id(@valid_listing_id)
+        end
+      end
+      
+      it { @listing.should be_kind_of(YouGotListed::Listing) }
+    end
+    
+    context "missing id" do
+      before do
+        VCR.use_cassette('listings.find_by_id_missing') do
+          @listing = @listings.find_by_id('CAM-111-3823475')
+        end
+      end
+      
+      it { @listing.should be_nil }
+    end
+    
+    context "invalid id" do
+      it "should not raise an exception" do
+        lambda {
+          VCR.use_cassette('listings.find_by_id_invalid') do
+            @listing = @listings.find_by_id('CAM')
+          end
+        }.should_not raise_exception
+      end
+      
+      it "should be nil" do
+        VCR.use_cassette('listings.find_by_id_invalid') do
+          @listing = @listings.find_by_id('CAM')
+        end
+        @listing.should be_nil
+      end
+    end
+  end
+  
+  context "find_all" do
+    before do
+      search_params = {:max_rent => "2000"}
+      VCR.use_cassette('listings.find_all') do
+        @properties = @listings.find_all(search_params)
+      end
+    end
+    
+    it { @properties.should be_kind_of(Array)}
+    
+    it "should only return properties" do
+      @properties.each do |p|
+        p.should be_kind_of(YouGotListed::Listing)
+      end
+    end
+  end
+  
+  context "find_all_by_ids" do
+    before do
+      VCR.use_cassette('listings.search') do
+        @find_ids = @listings.search.properties.collect{|p| p.id}
+      end
+      VCR.use_cassette("listings.search_with_off_market") do
+        @response = @listings.search(:include_off_market => "1")
+        @total_pages = @response.paginator.total_pages
+      end
+      (1..@total_pages).each do |page_num|
+        if property_id = find_off_market_property(@listings, page_num)
+          @off_market_id = property_id
+          break
+        end
+      end
+      @find_ids_with_off_market = @find_ids.clone
+      @find_ids_with_off_market << @off_market_id if @off_market_id
+    end
+    
+    context "passing an array of ids" do
+      before do
+        VCR.use_cassette('listings.find_all_by_ids.array') do
+          @properties = @listings.find_all_by_ids(@find_ids)
+        end
+      end
+      
+      it { @properties.should be_kind_of(Array) }
+      
+      it "should only return properties for requested ids" do
+        @properties.each do |p|
+          @find_ids.should include(p.id)
+        end
+      end
+    end
+    
+    context "passing an string of ids" do
+      before do
+        VCR.use_cassette('listings.find_all_by_ids.string') do
+          @properties = @listings.find_all_by_ids(@find_ids.join(','))
+        end
+      end
+      
+      it { @properties.should be_kind_of(Array) }
+    end
+    
+    context "should not return off market properties if directed not to" do
+      before do
+        VCR.use_cassette('listings.find_all_by_ids.no_off_market') do
+          @properties = @listings.find_all_by_ids(@find_ids_with_off_market, false)
+        end
+      end
+      
+      it { @properties.size.should_not == @find_ids_with_off_market.size }
+      it { @properties.collect{|p| p.id}.should_not include(@off_market_id) }
+    end
+    
+    context "should find all properties including the mls properties" do
+      before do
+        VCR.use_cassette("listings.search_with_mls") do
+          @response = @listings.search(:include_mls => "1")
+          @total_pages = @response.paginator.total_pages
+        end
+        (1..@total_pages).each do |page_num|
+          if property_id = find_mls_property(@listings, page_num)
+            @mls_id = property_id
+            break
+          end
+        end
+        @find_ids_with_mls = @find_ids.clone
+        @find_ids_with_mls << @mls_id if @mls_id
+        VCR.use_cassette('listings.find_all_by_ids.include_mls') do
+          @properties = @listings.find_all_by_ids(@find_ids_with_mls)
+        end
+      end
+      
+      it { @properties.size.should == @find_ids_with_mls.size }
+      
+      it "should only return properties for requested ids" do
+        @properties.each do |p|
+          @find_ids_with_mls.should include(p.id)
+        end
+      end
+    end
+  end
+  
+  def find_off_market_property(listings, page_id = 1)
+    VCR.use_cassette("listings.search_with_off_market.#{page_id}") do
+      response = listings.search(:include_off_market => "1", :page_index => page_id)
+      if property = response.properties.find{|p| p.status == "OFFMARKET"}
+        return property.id
+      else
+        return nil
+      end
+    end
+  end
+  
+  def find_mls_property(listings, page_id = 1)
+    VCR.use_cassette("listings.search_with_mls.#{page_id}") do
+      response = listings.search(:include_mls => "1", :page_index => page_id)
+      if property = response.properties.find{|p| p.source == "MLS"}
+        return property.id
+      else
+        return nil
+      end
+    end
+  end
+  
+end