real_page 2.3.0

data/lib/real_page/model/prospect.rb

@@ -0,0 +1,35 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # A container for a Prospect as represented by RealPage.
+    class Prospect < Base
+      object_attrs *%i[
+        address
+        phone_numbers
+      ]
+
+      integer_attrs *%i[
+        customer_id
+        pmc_id
+        site_id
+      ]
+
+      string_attrs *%i[
+        email
+        first_name
+        gender
+        id_issuer
+        id_number
+        id_numberencrypted
+        id_type
+        last_name
+        middle_name
+        pref_communication_type
+        relationship_id
+        ssn
+        ssn_encrypted
+      ]
+    end
+  end
+end

data/lib/real_page/model/quote.rb

@@ -0,0 +1,56 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # Object to encapsulate a Quote from a RealPage response.
+    class Quote < Base
+      boolean_attrs *%i[
+        available
+        enable_payment_plan
+        unit_applied
+      ]
+
+      date_attrs *%i[
+        reservation_expire_date
+      ]
+
+      decimal_attrs *%i[
+        deposit
+        market_rent
+        rent
+      ]
+
+      integer_attrs *%i[
+        floor_plan_id
+        id
+        lease_term_id
+      ]
+
+      string_attrs *%i[
+        agent_name
+        bldg_unit
+        building
+        context_name
+        date_created
+        date_lease_begin
+        date_lease_end
+        date_move_in
+        date_quote_expires
+        date_range_lease
+        floor_plan_id
+        floor_plan_name
+        id
+        lease_term_id
+        site
+        site_id
+        time_created
+        type
+        type_code
+        unit
+        unit_id
+        unit_reserved
+        unit_status
+      ]
+    end
+  end
+end

data/lib/real_page/model/rent_matrix.rb

@@ -0,0 +1,16 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # Object to encapsulate a rent matrix from a RealPage response.
+    class RentMatrix < Base
+      date_attrs *%i[needed_by_date]
+
+      integer_attrs *%i[lease_term lease_term_max lease_term_min]
+
+      object_attrs *%i[rows]
+
+      string_attrs *%i[property_id]
+    end
+  end
+end

data/lib/real_page/model/rent_matrix/concessions.rb

@@ -0,0 +1,15 @@
+require_relative '../base'
+
+module RealPage
+  module Model
+    class RentMatrix
+      # Object to encapsulate a rent matrix concessions node from a RealPage
+      # response.
+      class Concessions < Base
+        decimal_attrs *%i[monthly_fixed monthly_percent months]
+
+        integer_attrs *%i[one_time_fixed total]
+      end
+    end
+  end
+end

data/lib/real_page/model/rent_matrix/option.rb

@@ -0,0 +1,19 @@
+require_relative '../base'
+
+module RealPage
+  module Model
+    class RentMatrix
+      # Object to encapsulate a rent matrix option node from a RealPage
+      # response.
+      class Option < Base
+        boolean_attrs *%i[best]
+
+        date_attrs *%i[lease_end_date lease_start_date]
+
+        integer_attrs *%i[lease_term rent]
+
+        object_attrs *%i[concessions]
+      end
+    end
+  end
+end

data/lib/real_page/model/rent_matrix/row.rb

@@ -0,0 +1,18 @@
+require_relative '../base'
+
+module RealPage
+  module Model
+    class RentMatrix
+      # Object to encapsulate a rent matrix row node from a RealPage response.
+      class Row < Base
+        date_attrs *%i[lease_end_date lease_start_date make_ready_date]
+
+        integer_attrs *%i[max_rent min_rent rent]
+
+        object_attrs *%i[options]
+
+        string_attrs *%i[building unit ys_quote_id]
+      end
+    end
+  end
+end

data/lib/real_page/model/screening.rb

@@ -0,0 +1,22 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # Object to encapsulate a Screening from a RealPage response.
+    class Screening < Base
+      integer_attrs *%i[
+        customer_id
+      ]
+
+      string_attrs *%i[
+        apg_id
+        app_id
+        customer_name
+        external_screening_service
+        result
+        result_code
+        result_date
+      ]
+    end
+  end
+end

data/lib/real_page/model/unit.rb

@@ -0,0 +1,61 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # A container for a unit as represented by RealPage.
+    class Unit < Base
+      boolean_attrs *%i[
+        available
+        fp_report_unit_occupancy
+        hearing
+        lock
+        made_ready
+        mobility
+        nonrevenue
+        reserve
+        vacant
+        vision
+      ]
+
+      date_attrs *%i[available_date made_ready_date reserved_until vacant_date]
+
+      decimal_attrs *%i[
+        base_rent_amount
+        deposit_amount
+        floor_plan_market_rent
+        market_rent
+        nonrefund_fee
+      ]
+
+      integer_attrs *%i[
+        building_id
+        floor_plan_id
+        gross_sqft_count
+        id
+        rent_sqft_count
+        property_number_id
+      ]
+
+      string_attrs *%i[
+        address_1
+        address_2
+        city_name
+        county_name
+        country_name
+        description
+        floor_number
+        last_action_code
+        last_action_desc
+        lock_owner
+        non_revenue_description
+        note_description
+        number
+        pmc_id
+        site_id
+        state
+        unavailable_code
+        zip
+      ]
+    end
+  end
+end

data/lib/real_page/model/unit_shown.rb

@@ -0,0 +1,48 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # Object to encapsulate a UnitShown from a RealPage response.
+    class UnitShown  < Base
+      boolean_attrs *%i[
+        unit_applied
+      ]
+
+      date_attrs *%i[
+        activity_date
+        create_date
+        unit_reserved
+      ]
+
+      decimal_attrs *%i[
+        market_rent
+      ]
+
+      integer_attrs *%i[
+        agent_id
+        max_create_date_time
+        unit_id
+        unit_status
+      ]
+
+      string_attrs *%i[
+        activity_id
+        activity_name
+        activity_time
+        agent_name
+        building
+        building_unit
+        edit_type_name
+        guest_card_journal_type_edit_id
+        guest_card_journal_type_id
+        logged_by_name
+        notes
+        result
+        site
+        site_id
+        status
+        unit_number
+      ]
+    end
+  end
+end

data/lib/real_page/parameter/list_criterion.rb

@@ -0,0 +1,14 @@
+module RealPage
+  module Parameter
+    class ListCriterion
+      attr_reader :name, :single_value, :min_value, :max_value
+
+      def initialize(name:, single_value:, min_value: nil, max_value: nil)
+        @name = name
+        @single_value = single_value
+        @min_value = min_value
+        @max_value = max_value
+      end
+    end
+  end
+end

data/lib/real_page/request/base.rb

@@ -0,0 +1,89 @@
+require 'real_page/request_section/auth'
+require 'real_page/utils/request_fetcher'
+require 'real_page/utils/request_generator'
+
+module RealPage
+  module Request
+    # Base class for actions that fetch and parse specific RealPage SOAP
+    # actions.
+    #
+    # When subclassing this base class, you may override the following methods
+    # to extend functionality:
+    #
+    #   * after_initialize(params) - a hook into the initializer to give
+    #     subclasses access to the parameters passed in. If the subclass uses
+    #     any parameters that the base class is agnostic to, this is the place
+    #     the set these values to instance variables
+    #   * sections (returns Array<RequestSection>) - add additional request
+    #     sections to the request XML document. The 'auth' section will always
+    #     be inserted into the XML document by this class, so there is no need
+    #     to add it to the response of this method.
+    #
+    # Additionally, this base class provides the #soap_action method, which
+    # returns the CamelCased name of the SOAP action being requested. This
+    # method assumes that the subclass will be named the same as the action.
+    class Base
+      # @param params [Hash<Symbol, Object>] the parameters needed to build the
+      #   XML request.
+      # @option params pmc_id [String] the unique identifier for the property
+      #   management company in RealPage (required)
+      # @option params site_id [String] the unique identifier for the property
+      #   in RealPage (required)
+      def initialize(params)
+        %i[pmc_id site_id].each do |required_param|
+          unless params[required_param]
+            raise ArgumentError, "Params must include :#{required_param}"
+          end
+        end
+        @pmc_id = params[:pmc_id]
+        @site_id = params[:site_id]
+        after_initialize(params)
+      end
+
+      # @return [RealPage::Model|Array<RealPage::Model>] the parsed response
+      #   from RealPage
+      # @raise [RealPage::Error] an error when validating the response
+      def perform
+        parser.parse(xml)
+      end
+
+      # @return [String] the XMl response from RealPage
+      def xml
+        generator =
+          Utils::RequestGenerator.new(soap_action, [auth_section, *sections])
+        Utils::RequestFetcher.new(generator: generator).fetch
+      end
+
+
+      private
+
+      attr_reader :pmc_id, :site_id
+
+      # A hook into the initializer to give subclasses access to the parameters
+      # passed in. If the subclass uses any parameters that the base class is
+      # agnostic to, this is the place the set these values to instance
+      # variables
+      def after_initialize(params)
+        # No-op, this method is a call back for subclasses
+      end
+
+      # A hook to add additional request sections to the request XML document.
+      # The 'auth' section will always be inserted into the XML document by this
+      # class, so there is no need to add it to the response of this method.
+      def sections
+        []
+      end
+
+      # The CamelCased name of the SOAP action
+      def soap_action
+        self.class.name.split('::').last
+      end
+
+      def auth_section
+        RequestSection::Auth.new(pmc_id: pmc_id, site_id: site_id)
+      end
+    end
+
+    private_constant :Base
+  end
+end

data/lib/real_page/request/get_floor_plan_list.rb

@@ -0,0 +1,45 @@
+require 'real_page/document_parser/floor_plan_object'
+require 'real_page/request_section/list_criteria'
+
+require_relative 'base'
+
+module RealPage
+  module Request
+    # Retrieve floor plan information for a specific property.
+    #
+    # Required intializer parameters:
+    #
+    # @param pmc_id [String] the unique identifier for the property management
+    #   company in RealPage
+    # @param site_id [String] the unique identifier for the property in RealPage
+    #
+    # Optional initializer parameters:
+    #
+    # @param list_criteria [Array<RealPage::Parameter::ListCriterion>] the query
+    #   criteria, see GetFloorPlanList::Name for the allowed values for
+    #   ListCriterion#name
+    class GetFloorPlanList < Base
+      module Name
+        FLOOR_PLAN_CODE = 'FloorPlanCode'.freeze
+        FLOOR_PLAN_ID = 'FloorPlanID'.freeze
+        FLOOR_PLAN_NAME = 'FloorPlanName'.freeze
+      end
+
+      private
+
+      attr_reader :list_criteria
+
+      def after_initialize(params)
+        @list_criteria = params[:list_criteria] || []
+      end
+
+      def sections
+        [RequestSection::ListCriteria.new(list_criteria: list_criteria)]
+      end
+
+      def parser
+        DocumentParser::FloorPlanObject.new
+      end
+    end
+  end
+end