yield_star_client 0.1.0

data/spec/yield_star_client/property_methods_spec.rb

@@ -0,0 +1,189 @@
+require 'spec_helper'
+
+describe "property methods" do
+  subject { test_object }
+  
+  let(:test_object) { YieldStarClient::Client.new(:endpoint => 'http://bogusendpoint') }
+
+  let(:client_name) { 'my client name' }
+  let(:external_property_id) { 'my-external-property-id' }
+
+  it { should respond_to(:get_properties) }
+  it { should respond_to(:get_property) }
+  it { should respond_to(:get_property_parameters) }
+
+  describe "#get_properties" do
+    before { savon.stubs(:get_properties).returns(nil) }
+
+    subject { properties }
+    let(:properties) { test_object.get_properties(client_name) }
+
+    it "should retrieve the property data by client_name from the service" do
+      savon.expects(:get_properties).with(:request => {:client_name => client_name}).returns(:single_property)
+      subject.should be
+    end
+
+    context "with no properties" do
+      before { savon.stubs(:get_properties).returns(:no_property) }
+
+      it { should be }
+      it { should be_empty }
+    end
+
+    context "with single property" do
+      before { savon.stubs(:get_properties).returns(:single_property) }
+
+      it { should have(1).property }
+
+      describe "first property" do
+        subject { properties.first }
+ 
+        its(:name) { should == 'Minimal' }
+        its(:external_property_id) { should == '1' }
+      end
+    end
+
+    context "with multiple properties" do
+      before { savon.stubs(:get_properties).returns(:multiple_properties) }
+
+      it { should have(2).properties }
+
+      describe "first property" do
+        subject { properties.first }
+
+        its(:external_property_id) { should == '2' }
+        its(:name) { should == 'Typical' }
+        its(:address) { should == '123 Address Ln' }
+        its(:city) { should == 'Beverly Hills' }
+        its(:state) { should == 'CA' }
+        its(:zip) { should == '90210' }
+        its(:longitude) { should == -122.605687 }
+        its(:latitude) { should == 45.544873 }
+        its(:phone) { should_not be }
+        its(:fax) { should_not be }
+        its(:year_built) { should == 2009 }
+        its(:unit_count) { should_not be }
+        its(:website) { should_not be }
+      end
+
+      describe "last property" do
+        subject { properties.last }
+
+        its(:external_property_id) { should == '3' }
+        its(:name) { should == 'Fully Loaded' }
+        its(:address) { should == '550 NW Franklin Ave #200' }
+        its(:city) { should == 'Bend' }
+        its(:state) { should == 'OR' }
+        its(:zip) { should == '97701' }
+        its(:longitude) { should == -121.313936 }
+        its(:latitude) { should == 44.057411 }
+        its(:phone) { should == '5413063374' }
+        its(:fax) { should == '1234567890' }
+        its(:website) { should == 'http://g5platform.com' }
+        its(:unit_count) { should == 100 }
+        its(:year_built) { should == 2008 }
+      end
+    end
+
+    it_should_behave_like "a client_name validator"
+
+    it_should_behave_like "a fault handler", :get_properties
+  end
+
+  describe "#get_property" do
+    before { savon.stubs(:get_property).returns(nil) }
+
+    subject { property }
+    let(:property) { test_object.get_property(client_name, external_property_id) }
+    
+    it "should retrieve the property data from the service" do
+      savon.expects(:get_property).
+        with(:request => {:client_name => client_name, :external_property_id => external_property_id}).
+        returns(:simple_property)
+      subject.should be
+    end
+
+    context "for a simple property" do
+      before { savon.stubs(:get_property).returns(:simple_property) }
+
+      its(:external_property_id) { should == '42' }
+      its(:name) { should == 'Galaxy Apartments' }
+    end
+
+    context "for a fully specified property" do
+      before { savon.stubs(:get_property).returns(:full_property) }
+
+      its(:external_property_id) { should == '99' }
+      its(:name) { should == 'Full Property' }
+      its(:address) { should == '123 My Street' }
+      its(:city) { should == 'Anywhere' }
+      its(:state) { should == 'AK' }
+      its(:zip) { should == '99999' }
+      its(:longitude) { should == -95.514257 }
+      its(:latitude) { should == 29.732654 }
+      its(:year_built) { should == 2008 }
+      its(:phone) { should == '555-555-5555' }
+      its(:fax) { should == '999-999-9999' }
+      its(:website) { should == 'http://google.com' }
+      its(:unit_count) { should == 100 }
+    end
+
+    # Validations
+    it_should_behave_like 'a client_name validator'
+    it_should_behave_like 'an external_property_id validator'
+
+    # Error handling
+    it_should_behave_like "a fault handler", :get_property 
+  end
+
+  describe "#get_property_parameters" do
+    before { savon.stubs(:get_property_parameters).returns(nil) }
+
+    subject { parameters }
+    let(:parameters) { test_object.get_property_parameters(client_name, external_property_id) }
+
+    it "should retrieve the data from the service" do
+      savon.expects(:get_property_parameters).
+        with(:request => {:client_name => client_name, :external_property_id => external_property_id}).
+        returns(:no_parameters)
+      subject.should be
+    end
+
+    context "with empty parameters" do
+      before { savon.stubs(:get_property_parameters).returns(:no_parameters) }
+
+      it { should be }
+      its(:external_property_id) { should == external_property_id }
+    end
+
+    context "with partial parameters" do
+      before { savon.stubs(:get_property_parameters).returns(:simple_parameters) }
+
+      it { should be }
+      its(:external_property_id) { should == external_property_id }
+      its(:post_date) { should == Date.new(2011, 3, 2) }
+    end
+
+    context "with full parameters" do
+      before { savon.stubs(:get_property_parameters).returns(:full_parameters) }
+
+      it { should be }
+
+      its(:external_property_id) { should == external_property_id }
+      its(:new_lease_term_options) { should == 3 }
+      its(:post_date) { should == Date.new(2011, 3, 1) }
+      its(:max_renewal_lease_term) { should == 15 }
+      its(:min_new_lease_term) { should == 1 }
+      its(:min_renewal_lease_term) { should == 1 }
+      its(:max_new_lease_term) { should == 15 }
+      its(:max_move_in_days) { should == 55 }
+    end
+
+    # Validations
+    it_should_behave_like 'a client_name validator'
+    it_should_behave_like 'an external_property_id validator'
+
+    # Error handling
+    it_should_behave_like "a fault handler", :get_property_parameters
+  end
+end

data/spec/yield_star_client/rent_methods_spec.rb

@@ -0,0 +1,271 @@
+require 'spec_helper'
+
+describe "rental/availability methods" do
+  subject { test_object }
+
+  let(:test_object) { YieldStarClient::Client.new(:endpoint => 'http://bogusendpoint') }
+
+  let(:client_name) { 'my_client_name' }
+  let(:external_property_id) { '42' }
+
+  it { should respond_to(:get_rent_summary) }
+
+  describe "#get_rent_summary" do
+    before { savon.stubs(:get_rent_summary).returns(nil) }
+
+    subject { rent_summaries }
+    let(:rent_summaries) { test_object.get_rent_summary(client_name, external_property_id) }
+
+    it "should retrieve the data from the service" do
+      savon.expects(:get_rent_summary).
+        with(:request => {:client_name => client_name, :external_property_id => external_property_id}).
+        returns(:no_summaries)
+      subject.should be
+    end
+
+    context "with no summaries" do
+      before { savon.stubs(:get_rent_summary).returns(:no_summaries) }
+
+      it { should be_empty }
+    end
+
+    context "with one summary" do
+      before { savon.stubs(:get_rent_summary).returns(:single_summary) }
+
+      it { should have(1).summary }
+
+      describe "the first summary" do
+        subject { rent_summaries.first }
+
+        its(:external_property_id) { should == external_property_id }
+        its(:effective_date) { should == Date.civil(2011, 3, 11) }
+        its(:floor_plan_name) { should == '99' }
+        its(:unit_type) { should == '1b1ba' }
+        its(:bedrooms) { should == 1.0 }
+        its(:bathrooms) { should == 1.0 }
+        its(:avg_square_feet) { should == 797 }
+        its(:min_market_rent) { should == 765 }
+        its(:max_market_rent) { should == 820 }
+        its(:min_concession) { should == 500 }
+        its(:max_concession) { should == 500 }
+        its(:min_final_rent) { should == 807 }
+        its(:max_final_rent) { should == 862 }
+      end
+    end
+
+    context "with multiple summaries" do
+      before { savon.stubs(:get_rent_summary).returns(:multiple_summaries) }
+      let(:effective_date) { Date.civil(2011, 3, 15) }
+      it { should have(2).summaries }
+
+      describe "the first summary" do
+        subject { rent_summaries.first }
+
+        its(:external_property_id) { should == external_property_id }
+        its(:effective_date) { should == effective_date }
+        its(:floor_plan_name) { should == 'Economy' }
+        its(:unit_type) { should == '2b1.5ba' }
+        its(:bedrooms) { should == 2.0 }
+        its(:bathrooms) { should == 1.1 }
+        its(:avg_square_feet) { should == 1147 }
+        its(:min_market_rent) { should == 1019 }
+        its(:max_market_rent) { should == 1054 }
+        its(:min_concession) { should == 500 }
+        its(:max_concession) { should == 500 }
+        its(:min_final_rent) { should == 1061 }
+        its(:max_final_rent) { should == 1096 }
+      end
+
+      describe "the last summary" do
+        subject { rent_summaries.last }
+
+        its(:external_property_id) { should == external_property_id }
+        its(:effective_date) { should == effective_date }
+        its(:floor_plan_name) { should == 'Luxury' }
+        its(:unit_type) { should == '3b3ba' }
+        its(:bedrooms) { should == 3.0 }
+        its(:bathrooms) { should == 3.0 }
+        its(:avg_square_feet) { should == 1564 }
+        its(:min_market_rent) { should == 1291 }
+        its(:max_market_rent) { should == 1339 }
+        its(:min_concession) { should == 250 }
+        its(:max_concession) { should == 750 }
+        its(:min_final_rent) { should == 1332 }
+        its(:max_final_rent) { should == 1381 }
+        its(:floor_plan_description) { should == 'big' }
+
+        describe "concession_type" do
+          subject { rent_summaries.last.concession_type }
+
+          it { should be }
+          it { should have_key(:my_field) }
+          its([:my_field]) { should == '99' }
+        end
+      end
+    end
+
+    # Validation
+    it_should_behave_like 'a client_name validator'
+    it_should_behave_like 'an external_property_id validator'
+
+    # Error handling
+    it_should_behave_like 'a fault handler', :get_rent_summary
+  end
+
+  it { should respond_to(:get_available_units) }
+
+  describe "#get_available_units" do
+    before { savon.stubs(:get_available_units).returns(nil) }
+
+    subject { available_floor_plans }
+    let(:available_floor_plans) { test_object.get_available_units(client_name, external_property_id) }
+
+    it "should retrieve the data from the service" do
+      savon.expects(:get_available_units).
+        with(:request => {:client_name => client_name, :external_property_id => external_property_id}).
+        returns(:no_floor_plans)
+      subject.should be
+    end
+
+    context "with no floor plans" do
+      before { savon.stubs(:get_available_units).returns(:no_floor_plans) }
+
+      it { should be_empty }
+    end
+
+    context "with one floor plan" do
+      before { savon.stubs(:get_available_units).returns(:single_floor_plan) }
+
+      describe "the first floor plan" do
+        subject { floor_plan }
+        let(:floor_plan) { available_floor_plans.first }
+
+        its(:external_property_id) { should == '42' }
+        its(:effective_date) { should == Date.civil(2011, 3, 13) }
+        its(:floor_plan_name) { should == 'my_floor_plan' }
+        its(:bedrooms) { should == 2.0 }
+        its(:bathrooms) { should == 2.0 }
+        its(:square_feet) { should == 1161 }
+
+        describe "units" do
+          subject { available_units }
+          let(:available_units) { floor_plan.units }
+
+          it { should be }
+          it { should have(1).available_unit }
+
+          describe "#first" do
+            subject { available_units.first }
+
+            its(:unit_type) { should == '2b2ba' }
+            its(:unit_number) { should == '112358' }
+            its(:status) { should == :on_notice }
+            its(:date_available) { should == Date.civil(2011, 4, 1) }
+            its(:base_final_rent) { should == 1054 }
+            its(:best_lease_term) { should == 14 }
+            its(:best_market_rent) { should == 1079 }
+            its(:best_concession) { should == 583 }
+            its(:best_final_rent) { should == 1038 }
+          end
+        end
+      end
+    end
+
+    context "with multiple floor plans" do
+      before { savon.stubs(:get_available_units).returns(:multiple_floor_plans) }
+
+      let(:external_property_id) { '42' }
+      let(:effective_date) { Date.civil(2011, 3, 15) }
+
+      describe "the first floor plan" do
+        subject { available_floor_plans.first }
+
+        its(:external_property_id) { should == external_property_id }
+        its(:effective_date) { should == effective_date }
+        its(:floor_plan_name) { should == '1B1B-D' }
+        its(:bedrooms) { should == 1.0 }
+        its(:bathrooms) { should == 1.0 }
+        its(:square_feet) { should == 874 }
+        its(:units) { should be_empty }
+      end
+
+      describe "the last floor plan" do
+        subject { floor_plan }
+        let(:floor_plan) { available_floor_plans.last }
+
+        its(:external_property_id) { should == external_property_id }
+        its(:effective_date) { should == effective_date }
+        its(:floor_plan_name) { should == '1B1B' }
+        its(:bedrooms) { should == 1.0 }
+        its(:bathrooms) { should == 1.0 }
+        its(:square_feet) { should == 666 }
+
+        describe "units" do
+          subject { available_units }
+          let(:available_units) { floor_plan.units }
+
+          it { should have(2).units }
+
+          describe "#first" do
+            subject { unit }
+            let(:unit) { available_units.first }
+
+            its(:building) { should == '99' }
+            its(:unit_type) { should == '1b1ba-r' }
+            its(:unit_number) { should == '11235' }
+
+            describe "features" do
+              subject { unit.features }
+
+              it { should have(2).features }
+              its(:first) { should == '50 Base Rent Adjustment' }
+              its(:last) { should == '2nd Floor' }
+            end
+
+            its(:status) { should == :new_unit }
+            its(:date_available) { should == Date.civil(2011, 5, 11) }
+            its(:base_market_rent) { should == 710 }
+            its(:base_concession) { should == 500 }
+            its(:base_final_rent) { should == 669 }
+            its(:best_lease_term) { should == 15 }
+            its(:best_market_rent) { should == 699 }
+            its(:best_concession) { should == 625 }
+            its(:best_final_rent) { should == 658 }
+          end
+
+          describe "#last" do
+            subject { unit }
+            let(:unit) { available_units.last }
+
+            its(:unit_type) { should == '1b1ba' }
+            its(:unit_number) { should == '81321' }
+
+            describe "features" do
+              subject { unit.features }
+
+              it { should have(1).feature }
+              its(:first) { should == '1st floor' }
+            end
+
+            its(:status) { should == :vacant }
+            its(:date_available) { should == Date.civil(2011, 3, 7) }
+            its(:base_market_rent) { should == 732 }
+            its(:base_concession) { should == 500 }
+            its(:base_final_rent) { should == 690 }
+            its(:best_lease_term) { should == 15 }
+            its(:best_market_rent) { should == 719 }
+            its(:best_concession) { should == 625 }
+            its(:best_final_rent) { should == 678 }
+          end
+        end
+      end
+    end
+
+    # Validation 
+    it_should_behave_like 'a client_name validator'
+    it_should_behave_like 'an external_property_id validator'
+
+    # Error handling
+    it_should_behave_like 'a fault handler', :get_available_units
+  end
+end

data/spec/yield_star_client/unit_methods_spec.rb

@@ -0,0 +1,168 @@
+require 'spec_helper'
+
+describe "unit methods" do
+  subject { test_object }
+ 
+  let(:test_object) { YieldStarClient::Client.new(:endpoint => 'http://bogusendpoint') }
+
+  let(:client_name) { 'my_client_name' }
+  let(:external_property_id) { 'my_prop_id' }
+
+  it { should respond_to(:get_unit) }
+  it { should respond_to(:get_units) }
+
+  describe "#get_unit" do
+    before { savon.stubs(:get_unit).returns(nil) }
+
+    subject { unit }
+    let(:unit) { test_object.get_unit(client_name, external_property_id, unit_name) }
+    let(:unit_name) { 'my_unit_name' }
+    let(:soap_body) { {:client_name => client_name, :external_property_id => external_property_id, :name => unit_name}}
+
+    context "without a building name" do
+      it "should retrieve the data from the service" do
+        savon.expects(:get_unit).with(:request => soap_body).returns(:simple_unit)
+        subject.should be
+      end
+    end
+
+    context "with a building name" do
+      let(:unit) { test_object.get_unit(client_name, external_property_id, unit_name, building_name) }
+      let(:building_name) { 'my_building' }
+
+      it "should retrieve the data from the service" do
+        savon.expects(:get_unit).with(:request => soap_body.merge(:building => building_name)).returns(:simple_unit)
+        subject.should be
+      end
+    end
+
+    context "for a minimal unit" do
+      before { savon.stubs(:get_unit).returns(:simple_unit) }
+
+      its(:external_property_id) { should == '42' }
+      its(:floor_plan_name) { should == 'Economy' }
+      its(:name) { should == '1A' }
+      its(:availability_status) { should == :occupied_on_notice }
+    end
+
+    context "for a fully populated unit" do
+      before { savon.stubs(:get_unit).returns(:full_unit) }
+
+      its(:external_property_id) { should == '42' }
+      its(:floor_plan_name) { should == 'Luxury' }
+      its(:name) { should == 'Unit 6' }
+      its(:availability_status) { should == :vacant }
+      its(:building) { should == '99' }
+      its(:bedrooms) { should == 6.0 }
+      its(:bathrooms) { should == 5.3 }
+      its(:square_feet) { should == 5555 }
+      its(:unit_type) { should == 'foo' }
+      its(:make_ready_date) { should == Date.new(2011,03,10) }
+    end
+
+    # Validation
+    it_should_behave_like 'a client_name validator'
+    it_should_behave_like 'an external_property_id validator'
+    it_should_behave_like 'a required string validator', :unit_name
+    it "should allow a nil building" do
+      expect { subject }.to_not raise_error(ArgumentError)
+    end
+
+    # Error handling
+    it_should_behave_like "a fault handler", :get_unit
+  end
+
+  describe "#get_units" do
+    before { savon.stubs(:get_units).returns(nil) }
+
+    subject { units }
+    let(:units) { test_object.get_units(client_name, external_property_id) }
+    let(:soap_body) { {:client_name => client_name, :external_property_id => external_property_id} }
+
+    context "without a floor_plan name" do
+      it "should retrieve the data from the service" do
+        savon.expects(:get_units).with(:request => soap_body).returns(:no_units)
+        subject.should be
+      end
+    end
+
+    context "with a floor_plan name" do
+      let(:units) { test_object.get_units(client_name, external_property_id, floor_plan_name) }
+      let(:floor_plan_name) { 'my_floor_plan' }
+
+      it "should retrieve the data from the service" do
+        savon.expects(:get_units).with(:request => soap_body.merge(:floor_plan_name => floor_plan_name)).returns(:no_units)
+        subject.should be
+      end
+    end
+
+    context "for one unit" do
+      before { savon.stubs(:get_units).returns(:single_unit) }
+
+      it { should be }
+      it { should have(1).unit }
+
+      describe "first unit" do
+        subject { units.first }
+
+        its(:external_property_id) { should == '42' }
+        its(:floor_plan_name) { should == 'FP99' }
+        its(:name) { should == 'Unit 1' }
+        its(:availability_status) { should == :occupied }
+      end
+    end
+
+    context "for multiple units" do
+      before { savon.stubs(:get_units).returns(:multiple_units) }
+
+      it { should be }
+      it { should have(2).units }
+
+      describe "first unit" do
+        subject { units.first }
+
+        its(:external_property_id) { should == '42' }
+        its(:floor_plan_name) { should == 'Economy' }
+        its(:name) { should == 'Apt 313' }
+        its(:bedrooms) { should == 2.0 }
+        its(:bathrooms) { should == 1.1 }
+        its(:square_feet) { should == 1000 }
+        its(:unit_type) { should == 'apartment' }
+        its(:availability_status) { should == :pending }
+      end
+
+      describe "last unit" do
+        subject { units.last }
+
+        its(:external_property_id) { should == '42' }
+        its(:floor_plan_name) { should == 'Luxury' }
+        its(:name) { should == 'The Villa' }
+        its(:bedrooms) { should == 6.0 }
+        its(:bathrooms) { should == 4.0 }
+        its(:square_feet) { should == 5000 }
+        its(:unit_type) { should == 'single-family home' }
+        its(:building) { should == '99' }
+        its(:make_ready_date) { should == Date.new(2011, 4, 1) }
+        its(:availability_status) { should == :unknown }
+      end
+    end
+
+    context "for no units" do
+      before { savon.stubs(:get_units).returns(:no_units) }
+
+      it { should be }
+      it { should be_empty }
+    end
+
+    # Validation
+    it_should_behave_like 'a client_name validator'
+    it_should_behave_like 'an external_property_id validator'
+
+    it "should allow a nil floor_plan_name" do
+      expect { subject }.to_not raise_error(ArgumentError)
+    end
+
+    # Error handling
+    it_should_behave_like 'a fault handler', :get_units
+  end
+end

data/spec/yield_star_client/validations_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'validations'
+
+describe "validations" do
+  subject { validator }
+  let(:validator) { Class.new { extend YieldStarClient::Validations } }
+
+  it { should respond_to(:validate_required) }
+  
+  describe "#validate_client_name!" do
+    subject { validator.validate_client_name!(client_name) }
+    it_should_behave_like "a client_name validator"
+  end
+
+  describe "#validate_external_property_id!" do
+    subject { validator.validate_external_property_id!(external_property_id) }
+    it_should_behave_like "an external_property_id validator"
+  end
+end