yield_star_client 0.1.0

data/spec/yield_star_client/errors_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+require 'errors'
+
+describe YieldStarClient::ServerError do
+  subject { error }
+  let(:error) { YieldStarClient::ServerError.new(message, code) }
+  let(:code) { 'my code' }
+  let(:message) { 'my message' }
+
+  context "default initialization" do
+    let(:error) { YieldStarClient::ServerError.new }
+
+    it { should respond_to(:code) }
+    its(:code) { should_not be }
+
+    it { should respond_to(:message) }
+    its(:message) { should == error.class.name }
+  end
+
+  context "message initialization" do
+    let(:error) { YieldStarClient::ServerError.new(message) }
+
+    its(:code) { should_not be }
+    its(:message) { should == message }
+  end
+
+  context "full initialization" do
+    its(:code) { should == code }
+    its(:message) { should == message }
+  end
+
+  describe "#to_s" do
+    subject { error.to_s }
+
+    context "when there is a message" do
+      it { should match(message) }
+    end
+
+    context "when there isn't a message" do
+      let(:message) { nil }
+      it { should match(error.class.name) }
+    end
+  end
+
+  describe ".translate_fault" do
+    subject { YieldStarClient::ServerError.translate_fault(fault) }
+    let(:fault) { Savon::SOAP::Fault.new(response)}
+    
+    context "for an authentication fault" do
+      let(:response) { mock() { stubs(:body).returns(Savon::Spec::Fixture[:faults, :authentication_fault]) } }
+
+      it { should be_a YieldStarClient::AuthenticationError }
+      its(:message) { should == 'Client [foo] not found for this user [12e7e719764-21c]' }
+      its(:code) { should == '12e7e719764-21c' }
+    end
+
+    context "for an internal error fault" do
+      let(:response) { mock() { stubs(:body).returns(Savon::Spec::Fixture[:faults, :internal_error_fault]) } }
+
+      it { should be_a YieldStarClient::InternalError }
+      its(:message) { should == 'Internal error [12e7cfbb782-37a]' }
+      its(:code) { should == '12e7cfbb782-37a' }
+    end
+
+    context "for an operation fault" do
+      let(:response) { mock() { stubs(:body).returns(Savon::Spec::Fixture[:faults, :operation_fault]) } }
+
+      it { should be_a YieldStarClient::OperationError }
+      its(:message) { should == 'Invalid floor plan name null [12e7e6acc24-1b]' }
+      its(:code) { should == '12e7e6acc24-1b' }
+    end
+
+    context "for a generic fault" do
+      let(:response) { mock() { stubs(:body).returns(Savon::Spec::Fixture[:faults, :generic_fault]) } }
+
+      it { should be_a YieldStarClient::ServerError }
+      its(:message) { should == 'java.lang.NullPointerException' }
+      its(:code) { should == 'S:Server' }
+    end
+  end
+end
+
+describe YieldStarClient::AuthenticationError do
+  it { should be }
+end
+
+describe YieldStarClient::InternalError do
+  it { should be }
+end
+
+describe YieldStarClient::OperationError do
+  it { should be }
+end

data/spec/yield_star_client/floor_plan_methods_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+describe "floor plan 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_floor_plan) }
+
+  describe "#get_floor_plan" do
+    before { savon.stubs(:get_floor_plan).returns(nil) }
+
+    subject { floor_plan }
+    let(:floor_plan) { test_object.get_floor_plan(client_name, external_property_id, floor_plan_name) }
+    let(:floor_plan_name) { 'my_floor_plan_name' }
+
+    it "should retrieve the floor plan data from the service" do
+      savon.expects(:get_floor_plan).
+        with(:request => {:client_name => client_name, :external_property_id => external_property_id, :name => floor_plan_name}).
+        returns(:simple_floor_plan)
+      subject.should be
+    end
+
+    context "with a minimal floor plan" do
+      before { savon.stubs(:get_floor_plan).returns(:simple_floor_plan) }
+
+      its(:external_property_id) { should == '42' }
+      its(:name) { should == 'simple-plan' }
+    end
+
+    context "with a fully defined floor plan" do
+      before { savon.stubs(:get_floor_plan).returns(:full_floor_plan) }
+
+      its(:external_property_id) { should == '99' }
+      its(:name) { should == 'The Oxford' }
+      its(:description) { should == 'An apartment' }
+      its(:square_feet) { should == 797 }
+      its(:unit_count) { should == 49 }
+      its(:bedrooms) { should == 1.0 }
+      its(:bathrooms) { should == 1.1 }
+    end
+
+    # Validations
+    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', :floor_plan_name      
+    
+    # Error handling
+    it_should_behave_like 'a fault handler', :get_floor_plan
+  end
+
+  it { should respond_to(:get_floor_plans) }
+
+  describe "#get_floor_plans" do
+    before { savon.stubs(:get_floor_plans).returns(nil) }
+
+    subject { floor_plans }
+    let(:floor_plans) { test_object.get_floor_plans(client_name, external_property_id) }
+
+    it "should retrieve the floor plan data from the service" do
+      savon.expects(:get_floor_plans).
+        with(:request => {:client_name => client_name, :external_property_id => external_property_id}).
+        returns(:single_floor_plan)
+      subject.should be
+    end
+
+    context "with no floor plan" do
+      before { savon.stubs(:get_floor_plans).returns(:no_floor_plan) }
+
+      it { should be }
+      it { should be_empty }
+    end
+
+    context "with one floor plan" do
+      before { savon.stubs(:get_floor_plans).returns(:single_floor_plan) }
+
+      it { should have(1).floor_plan }
+
+      describe "first floor plan" do
+        subject { floor_plans.first }
+
+        its(:external_property_id) { should == '42' }
+        its(:name) { should == 'simple' }
+        its(:description) { should == 'A simple floor plan.' }
+      end
+    end
+
+    context "with multiple floor plans" do
+      before { savon.stubs(:get_floor_plans).returns(:multiple_floor_plans) }
+
+      describe "first floor plan" do
+        subject { floor_plans.first }
+
+        its(:external_property_id) { should == '99' }
+        its(:name) { should == 'The Economy' }
+        its(:description) { should == 'An affordable choice for the frugal resident.' }
+        its(:square_feet) { should == 450 }
+        its(:unit_count) { should == 42 }
+        its(:bedrooms) { should == 1.0 }
+        its(:bathrooms) { should == 1.0 }
+      end
+
+      describe "last floor plan" do
+        subject { floor_plans.last }
+
+        its(:external_property_id) { should == '99' }
+        its(:name) { should == 'The Luxury' }
+        its(:description) { should == 'A palatial estate for the independently wealthy.' }
+        its(:square_feet) { should == 10000 }
+        its(:unit_count) { should == 3 }
+        its(:bedrooms) { should == 7.0 }
+        its(:bathrooms) { should == 7.3 }
+      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_floor_plans
+  end
+end

data/spec/yield_star_client/lease_term_rent_methods_spec.rb

@@ -0,0 +1,391 @@
+require 'spec_helper'
+
+shared_examples_for 'a lease_term_rent service caller' do |soap_action|
+  let(:unit_number) { '112358' }
+
+  context "without options" do
+    it "should retrieve the data from the service" do
+      savon.expects(soap_action).
+        with(:request => {:client_name => client_name, 
+                          :external_property_id => external_property_id,
+                          :lease_term_rent_unit_request => {:unit_number => unit_number}}).
+        returns(:no_rates)
+      subject.should be
+    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_number
+
+    # Error handling
+    it_should_behave_like 'a fault handler', soap_action
+  end
+
+  context "with options" do
+    let(:opts) { {:building => building, 
+                  :min_lease_term => min_lease_term, 
+                  :max_lease_term => max_lease_term,
+                  :first_move_in_date => first_move_in_date,
+                  :last_move_in_date => last_move_in_date,
+                  :ready_for_move_in_date => ready_for_move_in_date,
+                  :unit_available_date => unit_available_date} }
+
+    let(:building) { '123' }
+    let(:min_lease_term) { 1 }
+    let(:max_lease_term) { '12' }
+    let(:first_move_in_date) { '2011-03-10' }
+    let(:last_move_in_date) { Date.civil(2011, 4, 1) }
+    let(:ready_for_move_in_date) { '2011-03-15' }
+    let(:unit_available_date) { DateTime.civil(2011, 3, 10) }
+
+    let(:soap_body) { {:request => {:client_name => client_name,
+                                    :external_property_id => external_property_id,
+                                    :lease_term_rent_unit_request => request_options}} }
+
+    let(:valid_request_options) { {:building => '123',
+                                   :unit_number => unit_number,
+                                   :min_lease_term => '1',
+                                   :max_lease_term => '12',
+                                   :first_move_in_date => '2011-03-10',
+                                   :last_move_in_date => '2011-04-01',
+                                   :ready_for_move_in_date => '2011-03-15',
+                                   :unit_available_date => '2011-03-10'} }
+
+    context "when all options are present and valid" do
+      let(:request_options) { valid_request_options }
+
+      it "should retrieve the data from the service" do
+        savon.expects(soap_action).with(soap_body).returns(:no_rates)
+        subject.should be
+      end
+    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_number
+
+    it_should_behave_like 'an integer validator', :min_lease_term 
+    it_should_behave_like 'an integer validator', :max_lease_term
+    it_should_behave_like 'a date validator', :first_move_in_date
+    it_should_behave_like 'a date validator', :last_move_in_date
+    it_should_behave_like 'a date validator', :ready_for_move_in_date
+    it_should_behave_like 'a date validator', :unit_available_date
+
+    # Error handling
+    it_should_behave_like 'a fault handler', soap_action
+  end
+end
+
+describe "lease term rent methods" do
+  subject { test_object } 
+  let(:test_object) { YieldStarClient::Client.new(:endpoint => 'http://bogusendpoint' ) }
+
+  let(:client_name) { 'my_client' }
+  let(:external_property_id) { '42' }
+  let(:unit_number) { '112358' }
+
+  it { should respond_to(:get_lease_term_rent) }
+
+  describe "#get_lease_term_rent" do
+    before { savon.stubs(:get_lease_term_rent).returns(nil) }
+
+    subject { unit_rates }
+    let(:unit_rates) { test_object.get_lease_term_rent(client_name, external_property_id, unit_number, opts) }
+    let(:opts) { {} }
+
+    it_should_behave_like 'a lease_term_rent service caller', :get_lease_term_rent
+
+    context "when there are no unit rates" do
+      before { savon.stubs(:get_lease_term_rent).returns(:no_rates) }
+
+      it { should be }
+      it { should be_empty }
+    end
+
+    context "when there is a single unit rate" do
+      before { savon.stubs(:get_lease_term_rent).returns(:single_rate) }
+
+      it { should have(1).unit_rate }
+
+      describe "first record" do
+        subject { unit_rates.first }
+ 
+        its(:external_property_id) { should == '42' }
+        its(:unit_number) { should == '112358' }
+        its(:building) { should_not be }
+        its(:make_ready_date) { should == Date.civil(2011, 3, 13) }
+        its(:lease_term) { should == 12 }
+        its(:end_date) { should  == Date.civil(2012, 3, 7) }
+        its(:market_rent) { should == 1096 }
+        its(:final_rent) { should == 1054 }
+        its(:best) { should be_true }
+        its(:move_in_date) { should == Date.civil(2011, 3, 13) }
+        its(:total_concession) { should == 0 }
+        its(:monthly_fixed_concession) { should == 0 }
+        its(:monthly_percent_concession) { should == 0.0 }
+        its(:months_concession) { should == 0.0 }
+        its(:one_time_fixed_concession) { should == 0 }
+      end
+    end
+
+    context "when there are multiple unit rates" do
+      before { savon.stubs(:get_lease_term_rent).returns(:multiple_rates) }
+
+      it { should have(2).unit_rates }
+
+      describe "the first record" do
+        subject { unit_rates.first }
+
+        its(:external_property_id) { should == '42' }
+        its(:unit_number) { should == '112358' }
+        its(:building) { should == '123' }
+        its(:make_ready_date) { should == Date.civil(2011, 3, 7) }
+        its(:lease_term) { should == 1 }
+        its(:end_date) { should  == Date.civil(2011, 7, 1) }
+        its(:market_rent) { should == 5277 }
+        its(:final_rent) { should == 5237 }
+        its(:best) { should be_true }
+        its(:move_in_date) { should == Date.civil(2011, 6, 1) }
+        its(:total_concession) { should == 41 }
+        its(:monthly_fixed_concession) { should == 0 }
+        its(:monthly_percent_concession) { should == 0.0 }
+        its(:months_concession) { should == 0.0 }
+        its(:one_time_fixed_concession) { should == 500 }
+      end
+
+      describe "the second record" do
+        subject { unit_rates.last }
+
+        its(:external_property_id) { should == '42' }
+        its(:unit_number) { should == '112358' }
+        its(:building) { should == '123' }
+        its(:make_ready_date) { should == Date.civil(2011, 3, 7) }
+        its(:lease_term) { should == 15 }
+        its(:end_date) { should  == Date.civil(2012, 8, 24) }
+        its(:market_rent) { should == 1272 }
+        its(:final_rent) { should == 1230 }
+        its(:best) { should be_false }
+        its(:move_in_date) { should == Date.civil(2011, 6, 1) }
+        its(:total_concession) { should == 625 }
+        its(:monthly_fixed_concession) { should == 10 }
+        its(:monthly_percent_concession) { should == 0.02 }
+        its(:months_concession) { should == 0.5 }
+        its(:one_time_fixed_concession) { should == 500 }
+      end
+    end
+  end
+
+  describe "#get_lease_term_rent_plus" do
+    before { savon.stubs(:get_lease_term_rent_plus).returns(nil) }
+
+    subject { unit_rates }
+    let(:unit_rates) { test_object.get_lease_term_rent_plus(client_name, external_property_id, unit_number, opts) }
+    let(:opts) { {} }
+
+    it_should_behave_like 'a lease_term_rent service caller', :get_lease_term_rent_plus
+
+    context "when there are no unit rates" do
+      before { savon.stubs(:get_lease_term_rent_plus).returns(:no_rates) }
+
+      it { should be_empty }
+    end
+
+    context "when there is a single unit rate" do
+      before { savon.stubs(:get_lease_term_rent_plus).returns(:single_rate) }
+
+      it { should have(1).unit_rate }
+
+      describe "the only record" do
+        subject { unit_rates.first }
+
+        its(:external_property_id) { should == '42' }
+        its(:unit_number) { should == '112358' }
+        its(:building) { should_not be }
+        its(:make_ready_date) { should == Date.civil(2011, 3, 23) }
+        its(:lease_term) { should == 12 }
+        its(:end_date) { should  == Date.civil(2012, 3, 24) }
+        its(:market_rent) { should == 1149 }
+        its(:final_rent) { should == 1108 }
+        its(:best) { should be_true }
+        its(:move_in_date) { should == Date.civil(2011, 3, 23) }
+        its(:total_concession) { should == 0 }
+        its(:monthly_fixed_concession) { should == 0 }
+        its(:monthly_percent_concession) { should == 0.0 }
+        its(:months_concession) { should == 0.0 }
+        its(:one_time_fixed_concession) { should == 0 }
+        its(:price_valid_end_date) { should == Date.civil(2011, 3, 25) }
+      end
+    end
+
+    context "when there are multiple unit rates" do
+      before { savon.stubs(:get_lease_term_rent_plus).returns(:multiple_rates) }
+
+      it { should have(2).unit_rates }
+
+      describe "the first record" do
+        subject { unit_rates.first }
+
+        its(:external_property_id) { should == '42' }
+        its(:unit_number) { should == '112358' }
+        its(:building) { should == '123' }
+        its(:make_ready_date) { should == Date.civil(2011, 3, 23) }
+        its(:lease_term) { should == 6 }
+        its(:end_date) { should  == Date.civil(2011, 9, 28) }
+        its(:market_rent) { should == 1249 }
+        its(:final_rent) { should == 1207 }
+        its(:best) { should be_true }
+        its(:move_in_date) { should == Date.civil(2011, 4, 1) }
+        its(:total_concession) { should == 250 }
+        its(:monthly_fixed_concession) { should == 0 }
+        its(:monthly_percent_concession) { should == 0.0 }
+        its(:months_concession) { should == 0.0 }
+        its(:one_time_fixed_concession) { should == 500 }
+        its(:price_valid_end_date) { should == Date.civil(2011, 4, 3) }
+      end
+
+      describe "the second record" do
+        subject { unit_rates.last }
+
+        its(:external_property_id) { should == '42' }
+        its(:unit_number) { should == '112358' }
+        its(:building) { should == '123' }
+        its(:make_ready_date) { should == Date.civil(2011, 3, 23) }
+        its(:lease_term) { should == 12 }
+        its(:end_date) { should  == Date.civil(2012, 3, 26) }
+        its(:market_rent) { should == 1176 }
+        its(:final_rent) { should == 1135 }
+        its(:best) { should be_false }
+        its(:move_in_date) { should == Date.civil(2011, 4, 1) }
+        its(:total_concession) { should == 500 }
+        its(:monthly_fixed_concession) { should == 11 }
+        its(:monthly_percent_concession) { should == 0.02 }
+        its(:months_concession) { should == 2.0 }
+        its(:one_time_fixed_concession) { should == 500 }
+        its(:price_valid_end_date) { should == Date.civil(2011, 4, 3) }
+      end
+    end
+  end
+
+  describe "#get_renewal_lease_term_rent" do
+    before { savon.stubs(:get_renewal_lease_term_rent).returns(nil) }
+
+    subject { unit_rates }
+    let(:unit_rates) { test_object.get_renewal_lease_term_rent(client_name, external_property_id, unit_number, opts) }
+
+    let(:opts) { Hash.new }
+
+    context "without options" do
+      it "should retrieve the data from the service" do
+        savon.expects(:get_renewal_lease_term_rent).
+          with(:request => {:client_name => client_name, 
+                            :external_property_id => external_property_id, 
+                            :renewal_lease_term_rent_unit_request => {:unit_number => unit_number}}).
+          returns(:no_rates)
+        subject.should be
+      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_number
+
+      # Error handling
+      it_should_behave_like 'a fault handler', :get_renewal_lease_term_rent
+    end
+
+    context "with options" do
+      let(:opts) { {:building => building,
+                    :min_lease_term => min_lease_term,
+                    :max_lease_term => max_lease_term,
+                    :start_date => start_date} }
+
+      let(:building) { '123' }
+      let(:min_lease_term) { 6 }
+      let(:max_lease_term) { 12 }
+      let(:start_date) { '2011-03-10' }
+
+      it "should retrieve the data from the service" do
+        savon.expects(:get_renewal_lease_term_rent).
+          with(:request => {:client_name => client_name,
+                            :external_property_id => external_property_id,
+                            :renewal_lease_term_rent_unit_request => {:unit_number => unit_number,
+                                                                      :building => building.to_s,
+                                                                      :min_lease_term => min_lease_term.to_s,
+                                                                      :max_lease_term => max_lease_term.to_s,
+                                                                      :start_date => start_date.to_s}}).
+          returns(:no_rates)
+        subject.should be
+      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_number
+      it_should_behave_like 'an integer validator', :min_lease_term
+      it_should_behave_like 'an integer validator', :max_lease_term
+      it_should_behave_like 'a date validator', :start_date
+
+      # Error handling
+      it_should_behave_like 'a fault handler', :get_renewal_lease_term_rent
+    end
+
+    context "when there are no rates" do
+      before { savon.stubs(:get_renewal_lease_term_rent).returns(:no_rates) }
+
+      it { should be_empty }
+    end
+
+    context "when there is a single rate" do
+      before { savon.stubs(:get_renewal_lease_term_rent).returns(:single_rate) }
+
+      it { should have(1).unit_rate }
+
+      describe "the only record" do
+        subject { unit_rates.first }
+
+        its(:external_property_id) { should == external_property_id }
+        its(:unit_number) { should == unit_number }
+        its(:building) { should == '123' }
+        its(:lease_term) { should == 12 }
+        its(:end_date) { should == Date.civil(2012, 10, 26) }
+        its(:market_rent) { should == 1086 }
+        its(:final_rent) { should == 1086 }
+        its(:best) { should be_true }
+      end
+    end
+
+    context "when there are multiple rates" do
+      before { savon.stubs(:get_renewal_lease_term_rent).returns(:multiple_rates) }
+
+      it { should have(2).unit_rates }
+
+      describe "the first record" do
+        subject { unit_rates.first }
+
+        its(:external_property_id) { should == external_property_id }
+        its(:unit_number) { should == unit_number }
+        its(:start_date) { should == Date.civil(2011, 10, 24) }
+        its(:lease_term) { should == 1 }
+        its(:end_date) { should == Date.civil(2011, 11, 24) }
+        its(:market_rent) { should == 1331 }
+        its(:final_rent) { should == 1300 }
+        its(:best) { should be_true }
+      end
+
+      describe "the second record" do
+        subject { unit_rates.last }
+
+        its(:external_property_id) { should == external_property_id }
+        its(:unit_number) { should == unit_number }
+        its(:start_date) { should == Date.civil(2011, 10, 24) }
+        its(:lease_term) { should == 12 }
+        its(:end_date) { should == Date.civil(2012, 10, 26) }
+        its(:market_rent) { should == 1086 }
+        its(:final_rent) { should == 1086 }
+        its(:best) { should be_false}
+      end
+    end
+  end
+end