yield_star_client 0.1.0

data/spec/fixtures/get_unit/simple_unit.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <getUnitResponse xmlns="http://yieldstar.com/ws/AppExchange/v1">
+      <return>
+        <externalPropertyId>42</externalPropertyId>
+        <unit>
+          <externalPropertyId>42</externalPropertyId>
+          <floorPlanName>Economy</floorPlanName>
+          <name>1A</name>
+          <availabilityStatus>Occupied on Notice</availabilityStatus>
+        </unit>
+      </return>
+    </getUnitResponse>
+  </S:Body>
+</S:Envelope>

data/spec/fixtures/get_unit_amenities/multiple_amenities.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <getUnitAmenitiesResponse xmlns="http://yieldstar.com/ws/AppExchange/v1">
+      <return>
+        <externalPropertyId>42</externalPropertyId>
+        <unitName>1A</unitName>
+        <amenity>
+          <name>Rent Adjustment</name>
+          <type>Fixed</type>
+          <value>50.00</value>
+        </amenity>
+        <amenity>
+          <name>Good Credit Adjustment</name>
+          <type>Variable</type>
+        </amenity>
+      </return>
+    </getUnitAmenitiesResponse>
+  </S:Body>
+</S:Envelope>

data/spec/fixtures/get_unit_amenities/no_amenities.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <getUnitAmenitiesResponse xmlns="http://yieldstar.com/ws/AppExchange/v1">
+      <return>
+        <externalPropertyId>42</externalPropertyId>
+        <unitName>1A</unitName>
+      </return>
+    </getUnitAmenitiesResponse>
+  </S:Body>
+</S:Envelope>

data/spec/fixtures/get_unit_amenities/single_amenity.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" ?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <getUnitAmenitiesResponse xmlns="http://yieldstar.com/ws/AppExchange/v1">
+      <return>
+        <externalPropertyId>42</externalPropertyId>
+        <unitName>1A</unitName>
+        <amenity>
+          <name>2nd Floor</name>
+          <type>Fixed</type>
+        </amenity>
+      </return>
+    </getUnitAmenitiesResponse>
+  </S:Body>
+</S:Envelope>

data/spec/fixtures/get_units/multiple_units.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0"?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <getUnitsResponse xmlns="http://yieldstar.com/ws/AppExchange/v1">
+      <return>
+        <externalPropertyId>42</externalPropertyId>
+        <unit>
+          <externalPropertyId>42</externalPropertyId>
+          <floorPlanName>Economy</floorPlanName>
+          <name>Apt 313</name>
+          <bedRooms>2.0</bedRooms>
+          <bathRooms>1.1</bathRooms>
+          <squareFootage>1000</squareFootage>
+          <unitType>apartment</unitType>
+          <availabilityStatus>Pending</availabilityStatus>
+        </unit>
+        <unit>
+          <externalPropertyId>42</externalPropertyId>
+          <floorPlanName>Luxury</floorPlanName>
+          <name>The Villa</name>
+          <bedRooms>6.0</bedRooms>
+          <bathRooms>4.0</bathRooms>
+          <squareFootage>5000</squareFootage>
+          <unitType>single-family home</unitType>
+          <building>99</building>
+          <makeReadyDate>2011-04-01</makeReadyDate>
+          <availabilityStatus>Unknown</availabilityStatus>
+        </unit>
+      </return>
+    </getUnitsResponse>
+  </S:Body>
+</S:Envelope>

data/spec/fixtures/get_units/no_units.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <getUnitsResponse xmlns="http://yieldstar.com/ws/AppExchange/v1">
+      <return>
+        <externalPropertyId>42</externalPropertyId>
+      </return>
+    </getUnitsResponse>
+  </S:Body>
+</S:Envelope>

data/spec/fixtures/get_units/single_unit.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <getUnitsResponse xmlns="http://yieldstar.com/ws/AppExchange/v1">
+      <return>
+        <externalPropertyId>42</externalPropertyId>
+        <unit>
+          <externalPropertyId>42</externalPropertyId>
+          <floorPlanName>FP99</floorPlanName>
+          <name>Unit 1</name>
+          <availabilityStatus>Occupied</availabilityStatus>
+        </unit>
+      </return>
+    </getUnitsResponse>
+  </S:Body>
+</S:Envelope>

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler.require :default, :development
+
+Dir[File.join(File.dirname(__FILE__), 'support', '*.rb')].each { |f| require f }
+
+Savon::Spec::Fixture.path = File.expand_path("../fixtures", __FILE__)
+Savon.configure do |config|
+  config.log = false
+end
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Savon::Spec::Macros
+end
+
+require 'yield_star_client'

data/spec/support/fault_handler_shared_examples.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+shared_examples_for "a fault handler" do |soap_action|
+  context "when there is an authentication fault" do
+    before { savon.stubs(soap_action).raises_soap_fault.returns(Savon::Spec::Fixture[:faults, :authentication_fault]) }
+
+    it "should raise a YieldStarClient authentication error" do
+      expect { subject }.to raise_error(YieldStarClient::AuthenticationError)
+    end
+
+    it "should include the fault message in the error object" do
+      expect { subject }.to raise_error { |e| e.message.should == 'Client [foo] not found for this user [12e7e719764-21c]' }
+    end
+
+    it "should include the fault code in the error object" do
+      expect { subject }.to raise_error { |e| e.code.should == '12e7e719764-21c' }
+    end
+  end
+
+  context "when there is an internal error fault" do
+    before { savon.stubs(soap_action).raises_soap_fault.returns(Savon::Spec::Fixture[:faults, :internal_error_fault]) }
+
+    it "should raise a YieldStarClient internal error" do
+      expect { subject }.to raise_error(YieldStarClient::InternalError)
+    end
+
+    it "should include the fault message in the error object" do
+      expect { subject }.to raise_error { |e| e.message.should == 'Internal error [12e7cfbb782-37a]' }
+    end
+
+    it "should include the fault code in the error object" do
+      expect { subject }.to raise_error { |e| e.code.should == '12e7cfbb782-37a' }
+    end
+  end
+
+  context "when there is an operation fault" do
+    before { savon.stubs(soap_action).raises_soap_fault.returns(Savon::Spec::Fixture[:faults, :operation_fault]) }
+
+    it "should raise a YieldStarClient operation error" do
+      expect { subject }.to raise_error(YieldStarClient::OperationError)
+    end
+
+    it "should include the fault message in the error object" do
+      expect { subject }.to raise_error { |e| e.message.should == 'Invalid floor plan name null [12e7e6acc24-1b]' }
+    end
+
+    it "should include the fault code in the error object" do
+      expect { subject }.to raise_error { |e| e.code.should == '12e7e6acc24-1b' }
+    end
+  end
+
+  context "when there is a generic fault" do
+    before { savon.stubs(soap_action).raises_soap_fault.returns(Savon::Spec::Fixture[:faults, :generic_fault]) }
+
+    it "should raise a YieldStarClient server error" do
+      expect { subject }.to raise_error(YieldStarClient::ServerError)
+    end
+
+    it "should include the fault message in the error object" do
+      expect { subject }.to raise_error { |e| e.message.should == 'java.lang.NullPointerException' }
+    end
+
+    it "should include the fault code in the error object" do
+      expect { subject }.to raise_error { |e| e.code.should == 'S:Server' }
+    end
+  end
+end
+

data/spec/support/validator_shared_examples.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+shared_examples_for "a client_name validator" do
+  it_should_behave_like "a required string validator", :client_name
+  it_should_behave_like "a string length validator", :client_name, 16
+end
+
+shared_examples_for "an external_property_id validator" do
+  it_should_behave_like "a required string validator", :external_property_id
+  it_should_behave_like "a string length validator", :external_property_id, 50
+end
+
+shared_examples_for 'a required string validator' do |param_name|
+  context "when #{param_name} is nil" do
+    let(param_name) { nil }
+
+    it "should raise an ArgumentError" do
+      expect { subject }.to raise_error(ArgumentError)
+    end
+
+    it "should indicate the error is related to the #{param_name}" do
+      expect { subject }.to raise_error { |e| e.message.should match(/#{param_name}/i) }
+    end
+  end
+
+  context "when #{param_name} is blank" do
+    let(param_name) { '        ' }
+
+    it "should raise an ArgumentError" do
+      expect { subject }.to raise_error(ArgumentError)
+    end
+
+    it "should indicate the error is related to the #{param_name}" do
+      expect { subject }.to raise_error { |e| e.message.should match(/#{param_name}/i) }
+    end
+  end
+end
+
+shared_examples_for 'a string length validator' do |param_name, max_length|
+  context "when #{param_name} is too long" do
+    let(param_name) { "foo" * max_length }
+
+    it "should raise an ArgumentError" do
+      expect { subject }.to raise_error(ArgumentError)
+    end
+
+    it "should indicate the error is related to the #{param_name}" do
+      expect { subject }.to raise_error { |e| e.message.should match(/#{param_name}/i) }
+    end
+  end
+end
+
+shared_examples_for 'an integer validator' do |param_name|
+  context "when #{param_name} cannot be cast to an int" do
+    let(param_name) { 'forty-two' }
+
+    it "should raise an ArgumentError" do
+      expect { subject }.to raise_error(ArgumentError)
+    end
+
+    it "should indicate the error is related to the #{param_name}" do
+      expect { subject }.to raise_error { |e| e.message.should match(/#{param_name}/i) }
+    end
+  end
+end
+
+shared_examples_for 'a date validator' do |param_name|
+  context "when #{param_name} cannot be converted to a date" do
+    let(param_name) { 'foo' }
+
+    it "should raise an ArgumentError" do
+      expect { subject }.to raise_error(ArgumentError)
+    end
+
+    it "should indicate the error is related to the #{param_name}" do
+      expect { subject }.to raise_error { |e| e.message.should match(/#{param_name}/i) }
+    end
+  end
+end

data/spec/yield_star_client/amenity_methods_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+describe "amenity 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_floor_plan_amenities) }
+  it { should respond_to(:get_unit_amenities) }
+
+  describe "#get_floor_plan_amenities" do
+    before { savon.stubs(:get_floor_plan_amenities).returns(nil) }
+
+    subject { amenities }
+    let(:amenities) { test_object.get_floor_plan_amenities(client_name, external_property_id, floor_plan_name) }
+    let(:floor_plan_name) { 'my_floor_plan' }
+
+    it "should retrieve the amenity data from the service" do
+      soap_body = {:client_name => client_name, 
+                   :external_property_id => external_property_id, 
+                   :floor_plan_name => floor_plan_name}
+      savon.expects(:get_floor_plan_amenities).with(:request => soap_body).returns(:no_amenities)
+      subject.should be
+    end
+
+    context "with no amenities" do
+      before { savon.stubs(:get_floor_plan_amenities).returns(:no_amenities) }
+
+      it { should be }
+      it { should be_empty }
+    end
+
+    context "with a single amenity" do
+      before { savon.stubs(:get_floor_plan_amenities).returns(:single_amenity) }
+
+      it { should have(1).amenity }
+
+      describe "first amenity" do
+        subject { amenities.first }
+
+        its(:name) { should == 'Garage Spot' }
+        its(:type) { should == 'Parking' }
+      end
+    end
+
+    context "with multiple amenities" do
+      before { savon.stubs(:get_floor_plan_amenities).returns(:multiple_amenities) }
+
+      it { should have(2).amenities }
+
+      describe "first amenity" do
+        subject { amenities.first }
+      end
+
+      describe "last amenity" do
+        subject { amenities.last }
+      end
+    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_amenities
+  end
+
+  describe "#get_unit_amenities" do
+    before { savon.stubs(:get_unit_amenities).returns(nil) }
+
+    subject { amenities }
+
+    let(:amenities) { test_object.get_unit_amenities(client_name, external_property_id, unit_name, building) }
+    let(:unit_name) { 'my_unit_name' }
+    let(:building) { 'my_building' }
+
+    context "without a building" do
+      let(:amenities) { test_object.get_unit_amenities(client_name, external_property_id, unit_name) }
+      let(:soap_body) do 
+        {:client_name => client_name, 
+         :external_property_id => external_property_id, 
+         :unit_name => unit_name}
+      end
+
+      it "should retrieve the data from the service" do
+        savon.expects(:get_unit_amenities).with(:request => soap_body).returns(:no_amenities)
+        subject.should be
+      end
+    end
+
+    context "with a building" do
+      let(:soap_body) do 
+        {:client_name => client_name, 
+         :external_property_id => external_property_id, 
+         :unit_name => unit_name, 
+         :building => building}
+      end
+
+      it "should retrieve the data from the service" do
+        savon.expects(:get_unit_amenities).with(:request => soap_body).returns(:no_amenities)
+        subject.should be
+      end
+    end
+
+    context "when there are no amenities" do
+      before { savon.stubs(:get_unit_amenities).returns(:no_amenities) }
+
+      it { should be }
+      it { should be_empty }
+    end
+
+    context "when there is one amenity" do
+      before { savon.stubs(:get_unit_amenities).returns(:single_amenity) }
+
+      it { should have(1).amenity }
+
+      describe "first amenity" do
+        subject { amenities.first }
+
+        its(:name) { should == '2nd Floor' }
+        its(:type) { should == 'Fixed' }
+      end
+    end
+
+    context "when there are multiple amenities" do
+      before { savon.stubs(:get_unit_amenities).returns(:multiple_amenities) }
+
+      describe "first amenity" do
+        subject { amenities.first }
+
+        its(:name) { should == 'Rent Adjustment' }
+        its(:type) { should == 'Fixed' }
+        its(:value) { should == 50.0 }
+      end
+
+      describe "last amenity" do
+        subject { amenities.last }
+
+        its(:name) { should == 'Good Credit Adjustment' }
+        its(:type) { should == 'Variable' }
+        its(:value) { should be_nil }
+      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_name
+
+    context "when there is no building" do
+      before { savon.stubs(:get_unit_amenities).returns(:no_amenities) }
+      let(:amenities) { test_object.get_unit_amenities(client_name, external_property_id, unit_name) }
+
+      it "should not raise an error" do
+        expect { subject }.to_not raise_error
+      end
+    end
+
+    # Error handling
+    it_should_behave_like 'a fault handler', :get_unit_amenities
+  end
+end

data/spec/yield_star_client/client_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+describe YieldStarClient::Client do
+  subject { client }
+
+  after { YieldStarClient.reset }
+
+  let(:client) do
+    YieldStarClient::Client.new({:endpoint => endpoint, 
+                                 :username => username, 
+                                 :password => password,
+                                 :namespace => namespace})
+  end
+
+  let(:endpoint) { 'https://foo.com?wsdl' }
+  let(:default_endpoint) { YieldStarClient::DEFAULT_ENDPOINT }
+  let(:username) { 'test_user' }
+  let(:password) { 'secret' }
+  let(:namespace) { 'http://foo.com/namespace' }
+
+  its(:endpoint) { should == endpoint }
+  its(:username) { should == username }
+  its(:password) { should == password }
+  its(:namespace) { should == namespace }
+
+  # Methods from the PropertyMethods mixin
+  # The actual tests for these are in property_methods_spec
+  # TODO: test mixins using shared example groups?
+  # see: http://blog.davidchelimsky.net/2010/11/07/specifying-mixins-with-shared-example-groups-in-rspec-2/
+  it { should respond_to(:get_properties) }
+  it { should respond_to(:get_property) }
+  it { should respond_to(:get_property_parameters) }
+
+  # Methods from the FloorPlanMethods mixin
+  it { should respond_to(:get_floor_plan) }
+  it { should respond_to(:get_floor_plans) }
+
+  # Methods from UnitMethods
+  it { should respond_to(:get_unit) }
+  it { should respond_to(:get_units) }
+
+  # Methods from AmenityMethods
+  it { should respond_to(:get_floor_plan_amenities) }
+  it { should respond_to(:get_unit_amenities) }
+
+  # Methods from RentMethods
+  it { should respond_to(:get_rent_summary) }
+  it { should respond_to(:get_available_units) }
+
+  # Methods from LeaseTermRentMethods
+  it { should respond_to(:get_lease_term_rent) }
+  it { should respond_to(:get_lease_term_rent_plus) }
+  it { should respond_to(:get_renewal_lease_term_rent) }
+
+  context "with default configuration" do
+    let(:client) { YieldStarClient::Client.new }
+
+    its(:endpoint) { should == default_endpoint }
+    its(:username) { should_not be }
+    its(:password) { should_not be }
+    its(:namespace) { should == YieldStarClient::DEFAULT_NAMESPACE }
+  end
+
+  describe "#endpoint=" do
+    subject { client.endpoint = new_endpoint }
+
+    context "with a new endpoint" do
+      let(:new_endpoint) { 'http://new-foo.com/service/' }
+
+      it "should change the endpoint" do
+        expect { subject }.to change{client.endpoint}.from(endpoint).to(new_endpoint) 
+      end
+    end
+
+    context "with a nil endpoint" do
+      let(:new_endpoint) { nil }
+
+      context "when there is no configured endpoint" do
+        it "should change to the default endpoint" do
+          expect { subject }.to change{client.endpoint}.from(endpoint).to(default_endpoint)
+        end
+      end
+
+      context "when there is a configured endpoint" do
+        let(:configured_endpoint) { 'http://configured.endpoint.com' }
+        before { YieldStarClient.configure { |config| config.endpoint = configured_endpoint } }
+
+        it "should change to the configured endpoint" do
+          expect { subject }.to change{client.endpoint}.from(endpoint).to(configured_endpoint)
+        end
+      end
+    end
+  end
+
+  describe "#username=" do
+    subject { client.username = new_username }
+    let(:new_username) { 'new username' }
+
+    it "should change the username" do
+      expect { subject }.to change{client.username}.from(username).to(new_username)
+    end
+
+    context "with a nil username" do
+      let(:new_username) { nil }
+
+      context "when there is no configured username" do
+        it "should change the username to nil" do
+          expect { subject }.to change{client.username}.from(username).to(nil)
+        end
+      end
+
+      context "when there is a configured username" do
+        let(:configured_username) { 'configured user' }
+        before { YieldStarClient.configure { |config| config.username = configured_username } }
+
+        it "should change the username to the configured username" do
+          expect { subject }.to change{client.username}.from(username).to(configured_username)
+        end
+      end 
+    end
+  end
+
+  describe "#password=" do
+    subject { client.password = new_password }
+    let(:new_password) { 'new secret' }
+
+    it "should change the password" do
+      expect { subject }.to change{client.password}.from(password).to(new_password)
+    end
+
+    context "with a nil password" do
+      let(:new_password) { nil }
+
+      context "when there is no configured password" do
+        it "should change the password to nil" do
+          expect { subject }.to change{client.password}.from(password).to(nil)
+        end
+      end
+
+      context "when there is a configured password" do
+        let(:configured_password) { 'configured password' }
+        before { YieldStarClient.configure { |config| config.password = configured_password } }
+
+        it "should change the password to the configured value" do
+          expect { subject }.to change{client.password}.from(password).to(configured_password)
+        end
+      end
+    end
+  end
+end