yield_star_client 0.1.0

data/lib/yield_star_client/property_methods.rb

@@ -0,0 +1,138 @@
+require 'yield_star_client/validations'
+require 'modelish'
+
+module YieldStarClient
+  # Represents a property in the YieldStar system.
+  #
+  # A property is guaranteed to have an +external_property_id+ and +name+; all other attributes are optional.
+  #
+  # @attr [String] external_property_id the property ID
+  # @attr [String] name the name of the property
+  # @attr [String] address the street address
+  # @attr [String] city the city in which the property is located
+  # @attr [String] state the two-letter code of the state in which the property is located
+  # @attr [String] zip the zip code
+  # @attr [String] fax the fax telephone number
+  # @attr [String] phone the voice telephone number
+  # @attr [Float] latitude the latitude of the property's location
+  # @attr [Float] longitude the longitude of the property's location
+  # @attr [Integer] unit_count the number of units at this property
+  # @attr [String] website the URL of the property website
+  # @attr [Integer] year_built the year in which the property was built
+  class Property < Modelish::Base
+    property :external_property_id
+    property :name
+    property :address
+    property :city
+    property :state
+    property :zip
+    property :fax
+    property :phone
+    property :latitude, :type => Float
+    property :longitude, :type => Float
+    property :unit_count, :type => Integer
+    property :website
+    property :year_built, :type => Integer
+  end
+
+  # Represents the pricing parameters for a particular property.
+  #
+  # This object is guaranteed to have an +external_property_id+; all other attributes may be nil.
+  #
+  # @attr [String] external_property_id the ID of the property
+  # @attr [Date] post_date the post date of the latest Price Optimizer forecasting and optimization nightly run.
+  # @attr [Integer] min_new_lease_term minimum length (in months) of a new lease term
+  # @attr [Integer] max_new_lease_term maximum length (in months) of a new lease term
+  # @attr [Integer] new_lease_term_options absolute number of lease term options to offer on either side of the base lease term when creating the lease term rent matrix.
+  # @attr [Integer] max_move_in_days number of fixed move in date options to return in response to a request for lease rates.
+  # @attr [Integer] min_renewal_lease_term minimum length (in months) of a renewal lease term
+  # @attr [Integer] max_renewal_lease_term maximum length (in months) of a renewal lease term
+  class PropertyParameters < Modelish::Base
+    property :external_property_id
+    property :post_date, :type => Date
+    property :min_new_lease_term, :type => Integer
+    property :max_new_lease_term, :type => Integer
+    property :new_lease_term_options, :type => Integer
+    property :max_move_in_days, :type => Integer
+    property :min_renewal_lease_term, :type => Integer
+    property :max_renewal_lease_term, :type => Integer
+  end
+
+  module PropertyMethods
+    include YieldStarClient::Validations
+
+    # Retrieves all properties for a client.
+    #
+    # @param [String] client_name the YieldStar client name
+    # @return [Array<YieldStarClient::Property>] list of properties
+    #
+    # @raise [ArgumentError] when client_name is missing or invalid
+    # @raise [YieldStarClient::AuthenticationError] when unable to authenticate to the web service
+    # @raise [YieldStarClient::OperationError] when the service raises an OperationError fault
+    # @raise [YieldStarClient::InternalError] when the service raises an InternalError fault
+    # @raise [YieldStarClient::ServerError] when any other server-side error occurs
+    def get_properties(client_name)
+      validate_client_name!(client_name)
+
+      response = send_soap_request(:get_properties, :client_name => client_name)
+
+      props = response.to_hash[:get_properties_response][:return][:property] || []
+      props = [props].flatten
+      props.collect { |p| Property.new(p) }
+    end
+
+    # Retrieves information for a specific property.
+    #
+    # @param [String] client_name the name of the client to perform the request for
+    # @param [String] external_property_id the ID of the property to obtain information for
+    # @return [YieldStarClient::Property] the property data
+    #
+    # @raise [ArgumentError] when external_property_id or client_name are missing or invalid
+    # @raise [YieldStarClient::AuthenticationError] when unable to authenticate to the web service
+    # @raise [YieldStarClient::OperationError] when the service raises an OperationError fault
+    # @raise [YieldStarClient::InternalError] when the service raises an InternalError fault
+    # @raise [YieldStarClient::ServerError] when any other server-side error occurs
+    def get_property(client_name, external_property_id)
+      validate_client_name!(client_name)
+      validate_external_property_id!(external_property_id)
+
+      response = send_soap_request(:get_property, :client_name => client_name, :external_property_id => external_property_id)
+
+      property = response.to_hash[:get_property_response][:return][:property]
+      Property.new(property)
+    end
+
+
+    # Retrieves pricing parameters for a specific property.
+    #
+    # @param [String] client_name the name of the client to perform the request for
+    # @param [String] external_property_id the ID of the property to obtain information for
+    # @return [YieldStarClient::PropertyParameters] the pricing data
+    #
+    # @raise [ArgumentError] when external_property_id or client_name are missing or invalid
+    # @raise [YieldStarClient::AuthenticationError] when unable to authenticate to the web service
+    # @raise [YieldStarClient::OperationError] when the service raises an OperationError fault
+    # @raise [YieldStarClient::InternalError] when the service raises an InternalError fault
+    # @raise [YieldStarClient::ServerError] when any other server-side error occurs
+    def get_property_parameters(client_name, external_property_id)
+      validate_client_name!(client_name)
+      validate_external_property_id!(external_property_id)
+
+      response = send_soap_request(:get_property_parameters, :client_name => client_name, 
+                                                             :external_property_id => external_property_id)
+
+      response_hash = response.to_hash[:get_property_parameters_response][:return]
+      param_hash = { :external_property_id => response_hash[:external_property_id] }
+      params = [response_hash[:parameter]].flatten
+
+      unless params.first.nil?
+        params.each do |param|
+          name = param[:name].downcase.gsub(/(max|min)imum/, '\1').gsub(/\s+/, '_').to_sym
+          param_hash[name] = param[:value]
+        end
+      end
+
+      PropertyParameters.new(param_hash)
+    end
+  end
+end

data/lib/yield_star_client/rent_methods.rb

@@ -0,0 +1,179 @@
+require 'yield_star_client/validations'
+require 'modelish'
+
+module YieldStarClient
+  # Represents a summary of rent information for a floor plan/unit type combination.
+  #
+  # @attr [Date] effective_date the data on which all listed prices are considered effective
+  # @attr [String] external_property_id the ID of the property associated with the floor plan
+  # @attr [String] floor_plan_name the floor plan that matches the Price Optimizer dashboard
+  # @attr [String] unit_type the unit type for this information
+  # @attr [Float] bedrooms the number of bedrooms in this unit type
+  # @attr [Float] bathrooms the number of bathrooms in this unit type
+  # @attr [Integer] avg_square_feet the average square footage in this unit type
+  # @attr [Integer] min_market_rent the minimum market rents for the currently available units
+  #                                 in this unit type
+  # @attr [Integer] max_market_rent the maximum market rents for the currently available units
+  #                                 in this unit type
+  # @attr [Object] concession_type reserved for future use by YieldStar
+  # @attr [Integer] min_concession the minimum value of any ocncessions (rent discount,
+  #                                recurrent discounts currently being offtered) for
+  #                                this particular unit type
+  # @attr [Integer] max_concession the maximum value of any concessions (rent discounts,
+  #                                recurrent discounts currently being offered) for this
+  #                                particular unit type
+  # @attr [Integer] min_final_rent the minimum **EFFECTIVE** rents for the currently available
+  #                                units in this unit type
+  # @attr [Integer] max_final_rent the maximum **EFFECTIVE** rents for the currently available
+  #                                units in this unit type.
+  # @attr [String] floor_plan_description the marketing name of the floor plan
+  class RentSummary < Modelish::Base
+    property :effective_date, :type => Date
+    property :external_property_id
+    property :floor_plan_name
+    property :unit_type
+    property :bedrooms, :type => Float, :from => :bed_rooms
+    property :bathrooms, :type => Float, :from => :bath_rooms
+    property :avg_square_feet, :type => Integer, :from => :avg_sq_ft
+    property :min_market_rent, :type => Integer
+    property :max_market_rent, :type => Integer
+    property :concession_type
+    property :min_concession, :type => Integer
+    property :max_concession, :type => Integer
+    property :min_final_rent, :type => Integer
+    property :max_final_rent, :type => Integer
+    property :floor_plan_description
+  end
+
+  # Represents a floor plan with available units.
+  #
+  # @attr [String] external_property_id the ID of the property associated with the
+  #                                     floor plan
+  # @attr [Date] effective_date the date that all listed prices are considered effective
+  # @attr [String] floor_plan_name the name of the floor plan that matches the 
+  #                                Price Optimizer dashboard
+  # @attr [Array<AvailableUnit>] units the available unit data associated with this
+  #                                    floor plan
+  # @attr [Float] bedrooms the number of bedrooms in this floor plan
+  # @attr [Float] bathrooms the number of bathrooms in this floor plan
+  # @attr [Integer] square_feet the square footage of the floor plan
+  class AvailableFloorPlan < Modelish::Base
+    property :external_property_id
+    property :effective_date, :type => Date
+    property :floor_plan_name
+    property :bedrooms, :type => Float, :from => :bed_rooms
+    property :bathrooms, :type => Float, :from => :bath_rooms
+    property :square_feet, :type => Integer, :from => :sq_ft
+    property :units, :from => :unit, :default => []
+
+    def initialize(options = {})
+      super(options)
+
+      # TODO: add support for nested types to modelish?
+      self.units = [self.units].flatten.collect { |u| AvailableUnit.new(u) }
+    end
+  end
+
+  # Represents an available unit.
+  #
+  # @attr [String] building the building for this unit
+  # @attr [String] unit_type the unit type
+  # @attr [String] unit_number the unit number from the property management system
+  # @attr [Array<String>] features the list of unit amenities/features
+  # @attr [Symbol] status the availability status of this unit. The status may be one of the
+  #                       following values:
+  #                       * +:on_notice+
+  #                       * +:vacant+
+  #                       * +:new_unit+
+  #                       * +:unknown+
+  # @attr [Date] date_available the date this unit can be occupied
+  # @attr [Integer] base_market_rent the 12-month market rent
+  # @attr [Integer] base_concession the concession amountt
+  # @attr [Integer] base_final_rent the 12-month effective rent (market rent less concessions)
+  # @attr [Integer] best_lease_term the lease term associated with the best price from 
+  #                                 the Lease Term Rent Matrix.
+  # @attr [Integer] best_market_rent the market monthly rent associated with the best price 
+  #                                  term and move-in period
+  # @attr [Integer] best_concession the concession associated with the best price term 
+  #                                 and move-in period
+  # @attr [Integer] best_final_rent the effective monthly rent associated with the best 
+  #                                 price term and move-in period
+  class AvailableUnit < Modelish::Base
+    property :building
+    property :unit_type
+    property :unit_number
+    property :features, :type => Array, :default => [], :from => :feature
+    property :status, :type => Symbol
+    property :date_available, :type => Date
+    property :base_market_rent, :type => Integer
+    property :base_concession, :type => Integer
+    property :base_final_rent, :type => Integer
+    property :best_lease_term, :type => Integer
+    property :best_market_rent, :type => Integer
+    property :best_concession, :type => Integer
+    property :best_final_rent, :type => Integer
+  end
+
+  module RentMethods
+    # Retrieves high-level rent information for all currently available floor
+    # plans within a specific property.
+    #
+    # @param [String] client_name the YieldStar client name
+    # @param [String] external_property_id the ID of the property associated
+    #                                      with the requested data
+    #
+    # @return [Array<YieldStarClient::RentSummary>]
+    #
+    # @raise [ArgumentError] when a required argument is missing or invalid
+    # @raise [YieldStarClient::AuthenticationError] when unable to authenticate to the web service
+    # @raise [YieldStarClient::OperationError] when the service raises an OperationError fault
+    # @raise [YieldStarClient::InternalError] when the service raises an InternalError fault
+    # @raise [YieldStarClient::ServerError] when any other server-side error occurs
+    def get_rent_summary(client_name, external_property_id)
+      validate_client_name!(client_name)
+      validate_external_property_id!(external_property_id)
+
+      response = send_soap_request(:get_rent_summary, :client_name => client_name,
+                                                      :external_property_id => external_property_id)
+
+      data = response.to_hash[:get_rent_summary_response][:return]
+      shared_props = {:external_property_id => data[:external_property_id],
+                      :effective_date => data[:effective_date]}
+      summaries = []
+      summaries << data[:floor_plan_unit_type] if data[:floor_plan_unit_type]
+
+      summaries.flatten.collect { |s| RentSummary.new(shared_props.merge(s)) }
+    end
+
+    # Retrieves rental information for all currently available units at a specific 
+    # property, grouped by floor plan.
+    #
+    # @param [String] client_name the YieldStar client name
+    # @param [String] external_property_id the ID of the property where the available
+    #                                      units are located
+    #
+    # @return [Array<YieldStarClient::AvailableFloorPlan>] list of floor plans with
+    #                                                      available units
+    #
+    # @raise [ArgumentError] when a required argument is missing or invalid
+    # @raise [YieldStarClient::AuthenticationError] when unable to authenticate to the web service
+    # @raise [YieldStarClient::OperationError] when the service raises an OperationError fault
+    # @raise [YieldStarClient::InternalError] when the service raises an InternalError fault
+    # @raise [YieldStarClient::ServerError] when any other server-side error occurs
+    def get_available_units(client_name, external_property_id)
+      validate_client_name!(client_name)
+      validate_external_property_id!(external_property_id)
+
+      response = send_soap_request(:get_available_units, :client_name => client_name, 
+                                                         :external_property_id => external_property_id)
+
+      data = response.to_hash[:get_available_units_response][:return]
+      base_props = data.reject { |k,v| ![:external_property_id, :effective_date].include?(k) }
+
+      floor_plans = []
+      floor_plans << data[:floor_plan] if data[:floor_plan]
+
+      floor_plans.flatten.collect { |fp| AvailableFloorPlan.new(base_props.merge(fp)) }
+    end
+  end
+end

data/lib/yield_star_client/unit_methods.rb

@@ -0,0 +1,95 @@
+require 'yield_star_client/validations'
+require 'modelish'
+
+module YieldStarClient
+  # Represents a unit in the YieldStar system.
+  #
+  # A unit is guaranteed to have an +external_property_id+, +floor_plan_name+, +name+, and +availablity_status+.
+  # All other attributes are optional.
+  #
+  # @attr [String] external_property_id the property ID
+  # @attr [String] floor_plan_name the name of the unit's floor plan
+  # @attr [String] name the unit name
+  # @attr [Symbol] availability_status the current availability of the unit. This may be one of the following values:
+  #   * +:occupied+ -- this unit is presently leased by a resident
+  #   * +:occupied_on_notice+ -- this unit is presently leased by a resident but a notice date has been provided
+  #   * +:vacant+ -- this unit is not presently leased
+  #   * +:pending+ -- this unit is available but a lease is pending
+  #   * +:unknown+ -- the status is unknown or unrecognized
+  # @attr [String] building the name of the building associated with the unit
+  # @attr [Float] bedrooms the number of bedrooms in the unit
+  # @attr [Float] bathrooms the number of bathrooms in the unit
+  # @attr [Integer] square_feet the square footage of the unit
+  # @attr [String] unit_type the client-defined grouping of the unit
+  # @attr [Date] make_ready_date the date on which the unit is ready for move-in
+  class Unit < Modelish::Base
+    property :external_property_id
+    property :floor_plan_name
+    property :name
+    property :availability_status, :type => Symbol
+    property :building
+    property :bedrooms, :from => :bed_rooms, :type => Float
+    property :bathrooms, :from => :bath_rooms, :type => Float
+    property :square_feet, :type => Integer, :from => :square_footage
+    property :unit_type
+    property :make_ready_date, :type => Date
+  end
+
+  module UnitMethods
+    include Validations
+    # Retrieves data about a specific unit.
+    #
+    # @param [String] client_name the YieldStar client name
+    # @param [String] external_property_id the ID of the property where the unit is located
+    # @param [String] unit_name the name of the unit to retrieve
+    # @param [optional,String] building_name the name of the building in which the unit is located
+    #
+    # @return [YieldStarClient::Unit] the unit data
+    #
+    # @raise [ArgumentError] when a required argument is missing or invalid
+    # @raise [YieldStarClient::AuthenticationError] when unable to authenticate to the web service
+    # @raise [YieldStarClient::OperationError] when the service raises an OperationError fault
+    # @raise [YieldStarClient::InternalError] when the service raises an InternalError fault
+    # @raise [YieldStarClient::ServerError] when any other server-side error occurs
+    def get_unit(client_name, external_property_id, unit_name, building_name=nil)
+      validate_client_name!(client_name)
+      validate_external_property_id!(external_property_id)
+      validate_required!(:unit_name => unit_name)
+
+      body = {:client_name => client_name, :external_property_id => external_property_id, :name => unit_name}
+      body[:building] = building_name if building_name
+
+      response = send_soap_request(:get_unit, body)
+      unit = response.to_hash[:get_unit_response][:return][:unit]
+
+      Unit.new(unit)
+    end
+
+    # Retrieves all units for a specific property, optionally filtered by floor plan.
+    #
+    # @param [String] client_name the YieldStar client name
+    # @param [String] external_property_id the ID of the property where the units are located
+    # @param [optional,String] floor_plan_name the name of the floor plan associated with the units
+    # 
+    # @return [Array<Unit>] a list of unit data
+    #
+    # @raise [ArgumentError] when a required argument is missing or invalid
+    # @raise [YieldStarClient::AuthenticationError] when unable to authenticate to the web service
+    # @raise [YieldStarClient::OperationError] when the service raises an OperationError fault
+    # @raise [YieldStarClient::InternalError] when the service raises an InternalError fault
+    # @raise [YieldStarClient::ServerError] when any other server-side error occurs
+    def get_units(client_name, external_property_id, floor_plan_name=nil)
+      validate_client_name!(client_name)
+      validate_external_property_id!(external_property_id)
+
+      body = {:client_name => client_name, :external_property_id => external_property_id}
+      body[:floor_plan_name] = floor_plan_name if floor_plan_name
+      response = send_soap_request(:get_units, body)
+
+      units = response.to_hash[:get_units_response][:return][:unit] || []
+      units = [units].flatten
+
+      units.collect { |u| Unit.new(u) }
+    end
+  end
+end

data/lib/yield_star_client/validations.rb

@@ -0,0 +1,18 @@
+require 'modelish'
+
+module YieldStarClient
+  # @private
+  module Validations
+    include Modelish::Validations::ClassMethods
+
+    def validate_client_name!(client_name)
+      validate_required!(:client_name => client_name)
+      validate_length!(:client_name, client_name, 16)
+    end
+
+    def validate_external_property_id!(external_property_id)
+      validate_required!(:external_property_id => external_property_id)
+      validate_length!(:external_property_id, external_property_id, 50)
+    end
+  end
+end

data/lib/yield_star_client/version.rb

@@ -0,0 +1,3 @@
+module YieldStarClient
+  VERSION = "0.1.0"
+end

data/lib/yield_star_client.rb

@@ -0,0 +1,74 @@
+$:.unshift(File.expand_path('yield_star_client',File.dirname(__FILE__)))
+
+module YieldStarClient
+  autoload :Configlet, 'configlet'
+  extend Configlet
+
+  # All valid configuration options.
+  #
+  # @see YieldStarClient.configure
+  VALID_CONFIG_OPTIONS = [:endpoint, :username, :password, :namespace]
+
+  DEFAULT_ENDPOINT = 'https://rmsws.yieldstar.com/rmsws/AppExchange'
+  DEFAULT_NAMESPACE = 'http://yieldstar.com/ws/AppExchange/v1'
+
+  # Default configuration - happens whether or not .configure is called
+  config :yield_star do
+    default :endpoint => DEFAULT_ENDPOINT
+    default :namespace => DEFAULT_NAMESPACE
+  end
+
+  # Mutators and accessors for configuration options
+  class << self
+    VALID_CONFIG_OPTIONS.each do |config_opt|
+      define_method(config_opt) do
+        YieldStarClient[config_opt]
+      end
+
+      define_method("#{config_opt}=".to_sym) do |val|
+        YieldStarClient[config_opt] = val
+      end
+    end
+  end
+
+  # Configures this module through the given +block+.
+  # Default configuration options will be applied unless 
+  # they are explicitly overridden in the +block+.
+  #
+  # @yield [_self] configures service connection options
+  # @yieldparam [YieldstarClient] _self the object on which the configure method was called
+  # @example Typical case utilizing defaults
+  #   YieldStarClient.configure do |config|
+  #     config.username = 'my_user'
+  #     config.password = 'my_pass'
+  #   end
+  # @example Overriding defaults
+  #   YieldStarClient.configure do |config|
+  #     config.username = 'my_user'
+  #     config.password = 'my_pass'
+  #     config.endpoint = 'http://my.endpoint.com'
+  #     config.namespace = 'http://my.namespace.com'
+  #   end
+  # @return [YieldStarClient] _self
+  # @see VALID_CONFIG_OPTIONS
+  def self.configure
+    config :yield_star do
+      yield self
+    end
+
+    self
+  end
+
+  # Resets this module's configuration.
+  # Configuration options will be set to default values
+  # if they exist; otherwise, they will be set to nil.
+  #
+  # @see VALID_CONFIG_OPTIONS
+  # @see DEFAULT_ENDPOINT
+  # @see DEFAULT_NAMESPACE
+  def self.reset
+    VALID_CONFIG_OPTIONS.each { |opt| self.send("#{opt}=", nil) } 
+  end
+
+  require 'client'
+end

data/spec/fixtures/faults/authentication_fault.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <S:Fault xmlns:ns4="http://www.w3.org/2003/05/soap-envelope">
+      <faultcode>S:Server</faultcode>
+      <faultstring>Client [foo] not found for this user [12e7e719764-21c]</faultstring>
+      <detail>
+        <AuthenticationFault:AuthenticationFault xmlns:AuthenticationFault="http://yieldstar.com/ws/AppExchange/v1" xmlns="http://yieldstar.com/ws/AppExchange/v1">
+          <code>12e7e719764-21c</code>
+          <message>Client [foo] not found for this user [12e7e719764-21c]</message>
+        </AuthenticationFault:AuthenticationFault>
+      </detail>
+    </S:Fault>
+  </S:Body>
+</S:Envelope>

data/spec/fixtures/faults/generic_fault.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <S:Fault xmlns:ns3="http://www.w3.org/2003/05/soap-envelope">
+      <faultcode>S:Server</faultcode>
+      <faultstring>java.lang.NullPointerException</faultstring>
+    </S:Fault>
+  </S:Body>
+</S:Envelope>

data/spec/fixtures/faults/internal_error_fault.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <S:Fault xmlns:ns4="http://www.w3.org/2003/05/soap-envelope">
+      <faultcode>S:Server</faultcode>
+      <faultstring>Internal error [12e7cfbb782-37a]</faultstring>
+      <detail>
+        <InternalErrorFault:InternalErrorFault xmlns:InternalErrorFault="http://yieldstar.com/ws/AppExchange/v1" xmlns="http://yieldstar.com/ws/AppExchange/v1">
+          <code>12e7cfbb782-37a</code>
+          <message>Internal error [12e7cfbb782-37a]</message>
+        </InternalErrorFault:InternalErrorFault>
+      </detail>
+    </S:Fault>
+  </S:Body>
+</S:Envelope>

data/spec/fixtures/faults/operation_fault.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <S:Fault xmlns:ns4="http://www.w3.org/2003/05/soap-envelope">
+      <faultcode>S:Server</faultcode>
+      <faultstring>Invalid floor plan name null [12e7e6acc24-1b]</faultstring>
+      <detail>
+        <OperationFault:OperationFault xmlns:OperationFault="http://yieldstar.com/ws/AppExchange/v1" xmlns="http://yieldstar.com/ws/AppExchange/v1">
+          <code>12e7e6acc24-1b</code>
+          <message>Invalid floor plan name null [12e7e6acc24-1b]</message>
+        </OperationFault:OperationFault>
+      </detail>
+    </S:Fault>
+  </S:Body>
+</S:Envelope>

data/spec/fixtures/get_available_units/multiple_floor_plans.xml

@@ -0,0 +1,53 @@
+<?xml version="1.0"?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <getAvailableUnitsResponse xmlns="http://yieldstar.com/ws/AppExchange/v1">
+      <return>
+        <externalPropertyId>42</externalPropertyId>
+        <effectiveDate>2011-03-15</effectiveDate>
+        <floorPlan>
+          <floorPlanName>1B1B-D</floorPlanName>
+          <bedRooms>1.0</bedRooms>
+          <bathRooms>1.0</bathRooms>
+          <sqFt>874</sqFt>
+        </floorPlan>
+        <floorPlan>
+          <floorPlanName>1B1B</floorPlanName>
+          <unit>
+            <building>99</building>
+            <unitType>1b1ba-r</unitType>
+            <unitNumber>11235</unitNumber>
+            <feature>50 Base Rent Adjustment</feature>
+            <feature>2nd Floor</feature>
+            <status>NewUnit</status>
+            <dateAvailable>2011-05-11</dateAvailable>
+            <baseMarketRent>710</baseMarketRent>
+            <baseConcession>500</baseConcession>
+            <baseFinalRent>669</baseFinalRent>
+            <bestLeaseTerm>15</bestLeaseTerm>
+            <bestMarketRent>699</bestMarketRent>
+            <bestConcession>625</bestConcession>
+            <bestFinalRent>658</bestFinalRent>
+          </unit>
+          <unit>
+            <unitType>1b1ba</unitType>
+            <unitNumber>81321</unitNumber>
+            <feature>1st floor</feature>
+            <status>Vacant</status>
+            <dateAvailable>2011-03-07</dateAvailable>
+            <baseMarketRent>732</baseMarketRent>
+            <baseConcession>500</baseConcession>
+            <baseFinalRent>690</baseFinalRent>
+            <bestLeaseTerm>15</bestLeaseTerm>
+            <bestMarketRent>719</bestMarketRent>
+            <bestConcession>625</bestConcession>
+            <bestFinalRent>678</bestFinalRent>
+          </unit>
+          <bedRooms>1.0</bedRooms>
+          <bathRooms>1.0</bathRooms>
+          <sqFt>666</sqFt>
+        </floorPlan>
+      </return>
+    </getAvailableUnitsResponse>
+  </S:Body>
+</S:Envelope>

data/spec/fixtures/get_available_units/no_floor_plans.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <getAvailableUnitsResponse xmlns="http://yieldstar.com/ws/AppExchange/v1">
+      <return>
+        <externalPropertyId>1509</externalPropertyId>
+        <effectiveDate>2011-03-13</effectiveDate>
+      </return>
+    </getAvailableUnitsResponse>
+  </S:Body>
+</S:Envelope>

data/spec/fixtures/get_available_units/single_floor_plan.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
+  <S:Body>
+    <getAvailableUnitsResponse xmlns="http://yieldstar.com/ws/AppExchange/v1">
+      <return>
+        <externalPropertyId>42</externalPropertyId>
+        <effectiveDate>2011-03-13</effectiveDate>
+        <floorPlan>
+          <floorPlanName>my_floor_plan</floorPlanName>
+          <unit>
+            <unitType>2b2ba</unitType>
+            <unitNumber>112358</unitNumber>
+            <status>OnNotice</status>
+            <dateAvailable>2011-04-01</dateAvailable>
+            <baseFinalRent>1054</baseFinalRent>
+            <bestLeaseTerm>14</bestLeaseTerm>
+            <bestMarketRent>1079</bestMarketRent>
+            <bestConcession>583</bestConcession>
+            <bestFinalRent>1038</bestFinalRent>
+          </unit>
+          <bedRooms>2.0</bedRooms>
+          <bathRooms>2.0</bathRooms>
+          <sqFt>1161</sqFt>
+        </floorPlan>
+      </return>
+    </getAvailableUnitsResponse>
+  </S:Body>
+</S:Envelope>