real_page 2.3.0

data/lib/real_page/document_parser/guest_cards/amenities.rb

@@ -0,0 +1,34 @@
+require 'real_page/utils/array_fetcher'
+
+require_relative '../guest_cards'
+
+module RealPage
+  module DocumentParser
+    class GuestCards
+      # Parse the Amenities from a GuestCards response. RealPage spells
+      # everything "amentities", so we also correct for that.
+      class Amenities < Base
+        # @param amenities_hash [Array<Hash<String, Object>>] an 'Amentities'
+        #   entry of the XML response parsed into a Hash
+        # @return [Array<RealPage::Model::Amenity>] the amenities contained
+        #   in this amenities_hash
+        # @raise [RealPage::Error::Base] if the response is invalid
+        def parse(amenities_hash)
+          amenities(amenities_hash).map do |amenity|
+            attrs = amenity.dup
+            # RealPage spells AmenityID wrong
+            attrs['AmenityID'] = attrs.delete('AmentityID')
+            Model::Amenity.new(attrs)
+          end
+        end
+
+        private
+
+        def amenities(amenities_hash)
+          #R RealPage spells the Amenity tag wrong
+          Utils::ArrayFetcher.new(hash: amenities_hash, key: 'Amentity').fetch
+        end
+      end
+    end
+  end
+end

data/lib/real_page/document_parser/guest_cards/prospects.rb

@@ -0,0 +1,45 @@
+require 'real_page/utils/array_fetcher'
+
+require_relative '../guest_cards'
+
+module RealPage
+  module DocumentParser
+    class GuestCards
+      # Parse the Prospects from a GuestCards response
+      class Prospects < Base
+        # @param prospects_hash [Array<Hash<String, Object>>] a 'Prospects'
+        #   entry of the XML response parsed into a Hash
+        # @return [Array<RealPage::Model::Prospect>] the prospects contained
+        #   in this prospects_hash
+        # @raise [RealPage::Error::Base] if the response is invalid
+        def parse(prospects_hash)
+          prospects(prospects_hash).map do |prospect|
+            attrs = prospect.merge(
+              'PhoneNumbers' => phone_numbers(prospect['Numbers'])
+            )
+            if prospect['Address']
+              attrs['Address'] = Model::Address.new(prospect['Address'])
+            end
+            # RealPage is inconsistent about Number vs PhoneNumber
+            attrs.delete('Numbers')
+            Model::Prospect.new(attrs)
+          end
+        end
+
+        private
+
+        def phone_numbers(phone_numbers_hash)
+          Utils::ArrayFetcher.new(
+            hash: phone_numbers_hash,
+            key: 'PhoneNumber',
+            model: Model::PhoneNumber
+          ).fetch
+        end
+
+        def prospects(prospects_hash)
+          Utils::ArrayFetcher.new(hash: prospects_hash, key: 'Prospect').fetch
+        end
+      end
+    end
+  end
+end

data/lib/real_page/document_parser/leases.rb

@@ -0,0 +1,37 @@
+require 'real_page/utils/array_fetcher'
+require 'real_page/validator/request_errors'
+require 'real_page/validator/move_in_report'
+
+require_relative 'base'
+
+module RealPage
+  module DocumentParser
+    # Parse the GetLeasesByTrafficSource response
+    class Leases < Base
+      private
+
+      # @param body [Hash<String, Object>] the body of the XML response parsed
+      #   into a Hash
+      # @return [Array<RealPage::Model::Lease>] the leases contained in the
+      #   response
+      # @raise [RealPage::Error::Base] if the response is invalid
+      def parse_body(body)
+        Utils::ArrayFetcher.new(
+          hash: leases(body),
+          key: 'lease',
+          model: Model::Lease
+        ).fetch
+      end
+
+      def leases(body)
+        response = body['getleasesbytrafficsourceResponse']
+        result = response['getleasesbytrafficsourceResult']
+        result['getleasesbytrafficsourceresponse']['leases']
+      end
+
+      def validator_classes
+        [Validator::RequestErrors, Validator::MoveInReport]
+      end
+    end
+  end
+end

data/lib/real_page/document_parser/picklist.rb

@@ -0,0 +1,38 @@
+require 'real_page/utils/array_fetcher'
+
+require_relative 'base'
+
+module RealPage
+  module DocumentParser
+    # Parse a Picklist response
+    class Picklist < Base
+      # @param soap_action [String] the action requested
+      def initialize(soap_action)
+        @soap_action = soap_action
+      end
+
+      private
+
+      attr_reader :soap_action
+
+      # @param body [Hash<String, Object>] the body of the XML response parsed
+      #   into a Hash
+      # @return [Array<RealPage::Model::PicklistItem>] the pick list items
+      #   parsed from the response
+      # @raise [RealPage::Error::Base] if the response is invalid
+      def parse_body(body)
+        Utils::ArrayFetcher.new(
+          hash: items(body),
+          key: 'PicklistItem',
+          model: Model::PicklistItem
+        ).fetch
+      end
+
+      def items(body)
+        response_key = "#{soap_action.downcase}Response"
+        result_key = "#{soap_action.downcase}Result"
+        body[response_key][result_key][soap_action]['Contents']
+      end
+    end
+  end
+end

data/lib/real_page/document_parser/rent_matrices.rb

@@ -0,0 +1,39 @@
+require 'real_page/utils/array_fetcher'
+
+require_relative 'base'
+
+module RealPage
+  module DocumentParser
+    # Parse the GetRentMatrix response
+    class RentMatrices < Base
+      private
+
+      # @param body [Hash<String, Object>] the body of the XML response parsed
+      #   into a Hash
+      # @return [Array<RealPage::Model::RentMatrix>] the rent matrices contained
+      #   in the response
+      # @raise [RealPage::Error::Base] if the response is invalid
+      def parse_body(body)
+        row_parser = Rows.new
+        matrices(body).map do |matrix|
+          rows = row_parser.parse(matrix['Rows'])
+          attrs = matrix.merge('Rows' => rows)
+          Model::RentMatrix.new(attrs)
+        end
+      end
+
+      def matrices(body)
+        result = body['getrentmatrixResponse']['getrentmatrixResult']
+        matrices = result['GetRentMatrix']['RentMatrices']
+        Utils::ArrayFetcher.new(hash: matrices, key: 'RentMatrix').fetch
+      end
+    end
+  end
+end
+
+# This file has a circular dependency with rent_matrices/row. This file uses
+# the other to help parse the inner rows of the XML and that file's class
+# definition is nested within this class.
+#
+# Having the require at the bottom of the file keeps the class loader happy
+require_relative 'rent_matrices/rows'

data/lib/real_page/document_parser/rent_matrices/options.rb

@@ -0,0 +1,31 @@
+require_relative '../rent_matrices'
+
+module RealPage
+  module DocumentParser
+    class RentMatrices
+      # Parse the options from a GetRentMatrix response
+      class Options < Base
+        # @param options_array [Array<Hash>] a 'Options' entry of the XML
+        #   response parsed into an array
+        # @return [Array<RealPage::Model::RentMatrix::Option>] the options
+        #   contained in this row
+        # @raise [RealPage::Error::Base] if the response is invalid
+        def parse(options_array)
+          options_array.map do |option_hash|
+            options = option_hash['Option']
+            options = [options] unless options.is_a?(Array)
+            options.map do |option|
+              concessions =
+                Model::RentMatrix::Concessions.new(option['Concessions'])
+              attrs = option.merge(
+                'Concessions' => concessions,
+                'LeaseStartDate' => option_hash['LeaseStartDate']
+              )
+              Model::RentMatrix::Option.new(attrs)
+            end
+          end.flatten
+        end
+      end
+    end
+  end
+end

data/lib/real_page/document_parser/rent_matrices/rows.rb

@@ -0,0 +1,30 @@
+require 'real_page/utils/array_fetcher'
+
+require_relative '../rent_matrices'
+require_relative 'options'
+
+module RealPage
+  module DocumentParser
+    class RentMatrices
+      # Parse the rows from a GetRentMatrix response
+      class Rows < Base
+        # @param rows_hash [Hash<String, Object>] a 'Rows' entry of the XML
+        #   response parsed into a Hash
+        # @return [Array<RealPage::Model::RentMatrix::Row>] the rows contained
+        #   in this rows_hash
+        # @raise [RealPage::Error::Base] if the response is invalid
+        def parse(rows_hash)
+          rows = Utils::ArrayFetcher.new(hash: rows_hash, key: 'Row').fetch
+          options_parser = Options.new
+          rows.map do |row|
+            options_hash =
+              Utils::ArrayFetcher.new(hash: row, key: 'Options').fetch
+            options = options_parser.parse(options_hash)
+            attrs = row.merge('Options' => options)
+            Model::RentMatrix::Row.new(attrs)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/real_page/document_parser/unit_object.rb

@@ -0,0 +1,30 @@
+require 'real_page/utils/array_fetcher'
+
+require_relative 'base'
+
+module RealPage
+  module DocumentParser
+    # Parse the GetUnitsByProperty response
+    class UnitObject < Base
+      private
+
+      # @param body [Hash<String, Object>] the body of the XML response parsed
+      #   into a Hash
+      # @return [Array<RealPage::Model::Unit>] the units contained in the
+      #   response
+      # @raise [RealPage::Error::Base] if the response is invalid
+      def parse_body(body)
+        Utils::ArrayFetcher.new(
+          hash: units(body),
+          key: 'UnitObject',
+          model: Model::Unit
+        ).fetch
+      end
+
+      def units(body)
+        result = body['getunitsbypropertyResponse']['getunitsbypropertyResult']
+        result['GetUnitsByProperty']
+      end
+    end
+  end
+end

data/lib/real_page/error/bad_request.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module RealPage
+  module Error
+    # Raised when a RealPage request has an error node in the contents. This is
+    # generally the case when one of the parameters in a section other than the
+    # auth section is invalid.
+    class BadRequest < Base
+      attr_reader :errors
+
+      # @param errors [Object] object must respond to message
+      def initialize(errors)
+        super(errors.map(&:message).join('; '))
+        @errors = errors
+      end
+    end
+  end
+end

data/lib/real_page/error/base.rb

@@ -0,0 +1,9 @@
+module RealPage
+  module Error
+    # A base class for all errors that originate from this gem
+    class Base < StandardError
+    end
+
+    private_constant :Base
+  end
+end

data/lib/real_page/error/invalid_configuration.rb

@@ -0,0 +1,9 @@
+require_relative 'base'
+
+module RealPage
+  module Error
+    # Raised when RealPage is not properly configured
+    class InvalidConfiguration < Base
+    end
+  end
+end

data/lib/real_page/error/invalid_response.rb

@@ -0,0 +1,9 @@
+require_relative 'base'
+
+module RealPage
+  module Error
+    # Raised when we cannot parse the response
+    class InvalidResponse < Base
+    end
+  end
+end

data/lib/real_page/error/request_fault.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+require_relative 'request_fault/details'
+
+module RealPage
+  module Error
+    # Raised when a RealPage request has a fault node, which general appears
+    # when there is an issue with the auth section in the request (e.g.
+    # invalid password)
+    class RequestFault < Base
+      attr_reader :fault_code, :details
+
+      def initialize(message, fault_code, details = nil)
+        super(message)
+        @fault_code = fault_code
+        @details = details
+      end
+    end
+  end
+end

data/lib/real_page/error/request_fault/details.rb

@@ -0,0 +1,17 @@
+require_relative '../base'
+
+module RealPage
+  module Error
+    class RequestFault < Base
+      class Details
+        attr_reader :custom_message, :exception_message, :log_id
+
+        def initialize(custom_message:, exception_message:, log_id:)
+          @custom_message = custom_message
+          @exception_message = exception_message
+          @log_id = log_id
+        end
+      end
+    end
+  end
+end

data/lib/real_page/model/activity.rb

@@ -0,0 +1,39 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # Object to encapsulate an Activity from a RealPage response.
+    class Activity < Base
+      boolean_attrs *%i[
+        system
+      ]
+
+      date_attrs *%i[
+        create_date
+      ]
+
+      integer_attrs *%i[
+        agent_id
+        max_create_date_time
+      ]
+
+      string_attrs *%i[
+        agent_name
+        date
+        edit_type_name
+        guest_card_journal_edit_type_id
+        guest_card_journal_type_id
+        id
+        logged_by_name
+        loss_reason_cd
+        name
+        notes
+        result
+        result_cd
+        status
+        status_change_reason
+        time
+      ]
+    end
+  end
+end

data/lib/real_page/model/address.rb

@@ -0,0 +1,17 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # Object to encapsulate a Address from a RealPage response.
+    class Address < Base
+      string_attrs *%i[
+        city
+        country
+        line1
+        line2
+        state
+        zip
+      ]
+    end
+  end
+end