real_page 2.3.0

data/lib/real_page/request/get_leases_by_traffic_source.rb

@@ -0,0 +1,59 @@
+require 'real_page/document_parser/leases'
+require 'real_page/request_section/parameter'
+
+require_relative 'base'
+
+module RealPage
+  module Request
+    # Retrieve current resident leases for a given traffic source that begin
+    # within the specified date range.
+    #
+    # 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
+    # @param traffic_source_id [String] the identifier for the
+    #   marketing/traffic source used to query leases
+    # @param start_date [Date] the start of the date range for the query
+    # @param end_date [Date] the end of the date range for the query
+    class GetLeasesByTrafficSource < Base
+      private
+
+      attr_reader :traffic_source_id, :start_date, :end_date, :request_params
+
+      def after_initialize(params)
+        %i[traffic_source_id start_date end_date].each do |required_param|
+          unless params[required_param]
+            raise ArgumentError, "Params must include :#{required_param}"
+          end
+        end
+        @traffic_source_id = params[:traffic_source_id]
+        @start_date = params[:start_date]
+        @end_date = params[:end_date]
+        @request_params = params
+      end
+
+      def parser
+        DocumentParser::Leases.new(
+          request_params: request_params,
+          request_name: request_name
+        )
+      end
+
+      def request_name
+        self.class.name.split('::').last
+      end
+
+      def sections
+        [
+          RequestSection::Parameter.new(
+            traffic_source_id: traffic_source_id,
+            start_date: start_date,
+            end_date: end_date
+          )
+        ]
+      end
+    end
+  end
+end

data/lib/real_page/request/get_marketing_sources_by_property.rb

@@ -0,0 +1,23 @@
+require 'real_page/document_parser/picklist'
+
+require_relative 'base'
+
+module RealPage
+  module Request
+    # Retrieve marketing sources information for a specific property. Marketing
+    # sources are also referred to as traffic sources throughout RealPage.
+    #
+    # 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
+    class GetMarketingSourcesByProperty < Base
+      private
+
+      def parser
+        DocumentParser::Picklist.new(soap_action)
+      end
+    end
+  end
+end

data/lib/real_page/request/get_rent_matrix.rb

@@ -0,0 +1,57 @@
+require 'real_page/document_parser/rent_matrices'
+require 'real_page/request_section/get_rent_matrix'
+
+require_relative 'base'
+
+module RealPage
+  module Request
+    # Retrieve pricing data for units in a property.
+    #
+    # Required intializer parameters:
+    #
+    # @param least_term [Integer] Proposed lease term duration, in months
+    # @param need_by_date [Date] Proposed date when prospect would move in to
+    #   any apartment
+    # @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
+    # @param unit_ids [Array<Integer|String>] Array of integer Unit ID numbers
+    #  as acquired from GetUnitsByProperty
+    # @param viewing_quote_only [true|false] Identifies whether the user is
+    #   viewing or creating new quote
+    class GetRentMatrix < Base
+      private
+
+      attr_reader :lease_term, :need_by_date, :unit_ids, :viewing_quote_only
+
+      def after_initialize(params)
+        %i[
+          lease_term
+          need_by_date
+          unit_ids
+          viewing_quote_only
+        ].each do |required_param|
+          unless params[required_param]
+            raise ArgumentError, "Params must include :#{required_param}"
+          end
+          instance_variable_set("@#{required_param}", params[required_param])
+        end
+      end
+
+      def sections
+        [
+          RequestSection::GetRentMatrix.new(
+            lease_term: lease_term,
+            need_by_date: need_by_date,
+            unit_ids: unit_ids,
+            viewing_quote_only: viewing_quote_only
+          )
+        ]
+      end
+
+      def parser
+        DocumentParser::RentMatrices.new
+      end
+    end
+  end
+end

data/lib/real_page/request/get_units_by_property.rb

@@ -0,0 +1,39 @@
+require 'real_page/document_parser/unit_object'
+require 'real_page/request_section/list_criteria'
+
+require_relative 'base'
+
+module RealPage
+  module Request
+    # Retrieve marketing sources information for a specific property. Marketing
+    # sources are also referred to as traffic sources throughout RealPage.
+    #
+    # 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
+    class GetUnitsByProperty < Base
+      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::UnitObject.new
+      end
+    end
+  end
+end

data/lib/real_page/request/prospect_search.rb

@@ -0,0 +1,50 @@
+require 'real_page/document_parser/guest_cards'
+require 'real_page/request_section/prospect_search_criterion'
+
+require_relative 'base'
+
+module RealPage
+  module Request
+    # Retrieve information about a known Prospect
+    #
+    # Required initializer 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
+    # @guest_card_id [String] the unique identifier for the guest_card in
+    #   RealPage
+    class ProspectSearch < Base
+      private
+
+      attr_reader :guest_card_id, :request_params
+
+      def after_initialize(params)
+        @guest_card_id = params[:guest_card_id]
+        unless guest_card_id
+          raise ArgumentError, 'Params must include :guest_card_id'
+        end
+        @request_params = params
+      end
+
+      def parser
+        DocumentParser::GuestCards.new(
+          request_params: request_params,
+          request_name: request_name
+        )
+      end
+
+      def request_name
+        self.class.name.split('::').last
+      end
+
+      def sections
+        [
+          RequestSection::ProspectSearchCriterion.new(
+            guest_card_id: guest_card_id
+          )
+        ]
+      end
+    end
+  end
+end

data/lib/real_page/request_section.rb

@@ -0,0 +1,6 @@
+module RealPage
+  module RequestSection
+  end
+
+  private_constant :RequestSection
+end

data/lib/real_page/request_section/auth.rb

@@ -0,0 +1,31 @@
+require 'real_page/request_section'
+
+module RealPage
+  module RequestSection
+    # Generate the auth section of a RealPage request
+    class Auth
+      SYSTEM = 'OneSite'.freeze
+      private_constant :SYSTEM
+
+      def initialize(pmc_id:, site_id:)
+        @pmc_id = pmc_id
+        @site_id = site_id
+      end
+
+      def generate(xml_builder)
+        xml_builder.auth do
+          xml_builder.pmcid pmc_id
+          xml_builder.siteid site_id
+          xml_builder.username RealPage.config.username
+          xml_builder.password RealPage.config.password
+          xml_builder.licensekey RealPage.config.license_key
+          xml_builder.system SYSTEM
+        end
+      end
+
+      private
+
+      attr_reader :pmc_id, :site_id
+    end
+  end
+end

data/lib/real_page/request_section/get_rent_matrix.rb

@@ -0,0 +1,32 @@
+require 'real_page/request_section'
+
+module RealPage
+  module RequestSection
+    # Generate the list criteria section of a RealPage request
+    class GetRentMatrix
+      def initialize(lease_term:, need_by_date:, unit_ids:, viewing_quote_only:)
+        @lease_term = lease_term
+        @need_by_date = need_by_date
+        @unit_ids = unit_ids
+        @viewing_quote_only = viewing_quote_only
+      end
+
+      def generate(xml_builder)
+        xml_builder.getrentmatrix do
+          xml_builder.NeededByDate need_by_date
+          xml_builder.LeaseTerm lease_term
+          xml_builder.unitids do
+            unit_ids.each do |unit_id|
+              xml_builder.int unit_id
+            end
+          end
+          xml_builder.viewingQuoteOnly viewing_quote_only ? 1 : 0
+        end
+      end
+
+      private
+
+      attr_reader :lease_term, :need_by_date, :unit_ids, :viewing_quote_only
+    end
+  end
+end

data/lib/real_page/request_section/list_criteria.rb

@@ -0,0 +1,29 @@
+require 'real_page/request_section'
+
+module RealPage
+  module RequestSection
+    # Generate the list criteria section of a RealPage request
+    class ListCriteria
+      def initialize(list_criteria:)
+        @list_criteria = list_criteria
+      end
+
+      def generate(xml_builder)
+        xml_builder.listCriteria do
+          list_criteria.each do |criterion|
+            xml_builder.ListCriterion do
+              xml_builder.name criterion.name
+              xml_builder.singlevalue criterion.single_value
+              xml_builder.minvalue criterion.min_value if criterion.min_value
+              xml_builder.maxvalue criterion.max_value if criterion.max_value
+            end
+          end
+        end
+      end
+
+      private
+
+      attr_reader :list_criteria
+    end
+  end
+end

data/lib/real_page/request_section/parameter.rb

@@ -0,0 +1,31 @@
+require 'real_page/request_section'
+
+module RealPage
+  module RequestSection
+    # Generate the parameter section of a RealPage request
+    class Parameter
+      def initialize(start_date:, end_date:, traffic_source_id:)
+        @start_date = start_date
+        @end_date = end_date
+        @traffic_source_id = traffic_source_id
+      end
+
+      def generate(xml_builder)
+        xml_builder.parameter do
+          xml_builder.startdate format_date(start_date)
+          xml_builder.enddate format_date(end_date)
+          # As documented, this node name is a typo
+          xml_builder.trafficesourceid traffic_source_id
+        end
+      end
+
+      private
+
+      attr_reader :start_date, :end_date, :traffic_source_id
+
+      def format_date(date)
+        date.strftime('%Y-%m-%d')
+      end
+    end
+  end
+end

data/lib/real_page/request_section/prospect_search_criterion.rb

@@ -0,0 +1,24 @@
+require 'real_page/request_section'
+
+module RealPage
+  module RequestSection
+    # Generate the prospectSearchCriterion section of a RealPage request
+    class ProspectSearchCriterion
+      def initialize(guest_card_id:)
+        @guest_card_id = guest_card_id
+      end
+
+      def generate(xml_builder)
+        xml_builder.prospectSearchCriterion do
+          xml_builder.ProspectSearchCriterion do
+            xml_builder.guestcardid guest_card_id
+          end
+        end
+      end
+
+      private
+
+      attr_reader :guest_card_id
+    end
+  end
+end

data/lib/real_page/utils.rb

@@ -0,0 +1,6 @@
+module RealPage
+  module Utils
+  end
+
+  private_constant :Utils
+end

data/lib/real_page/utils/array_fetcher.rb

@@ -0,0 +1,35 @@
+require 'real_page/utils'
+
+module RealPage
+  module Utils
+    # Fetch an array from a hash that was generated by parsing XML using
+    # MultiXml. If you provide a model to instantiate, an instance will be
+    # initialized with each data element.
+    class ArrayFetcher
+      def initialize(hash:, key:, model: nil)
+        @hash  = hash
+        @key   = key
+        @model = model
+      end
+
+      # @return [Array] take the MultiXml hash and return a proper array
+      def fetch
+        return [] if empty?
+        value = hash[key]
+        value = [value] unless value.is_a?(Array)
+        return value unless model
+        value.map { |v| model.new(v) }
+      end
+
+      private
+
+      attr_reader :hash, :key, :model
+
+      def empty?
+        return true if hash.nil?
+        return true if hash.is_a?(String) && hash.strip! == ''
+        hash.empty?
+      end
+    end
+  end
+end

data/lib/real_page/utils/configuration_validator.rb

@@ -0,0 +1,20 @@
+require 'real_page/utils'
+
+module RealPage
+  module Utils
+    class ConfigurationValidator
+      REQUIRED_KEYS = %i[username password license_key web_service_url].freeze
+      private_constant :REQUIRED_KEYS
+
+      def validate!
+        missing_keys = REQUIRED_KEYS.select do |key|
+          RealPage.config.send(key).nil?
+        end
+        unless missing_keys.empty?
+          raise Error::InvalidConfiguration,
+                "Missing configuration for #{missing_keys.join(', ')}"
+        end
+      end
+    end
+  end
+end