real_page 2.3.0

data/lib/real_page/model/amenity.rb

@@ -0,0 +1,14 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # A container for an Amenity as represented by RealPage.
+    class Amenity < Base
+      string_attrs *%i[
+        id
+        pmc_id
+        site_id
+      ]
+    end
+  end
+end

data/lib/real_page/model/appointment.rb

@@ -0,0 +1,23 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # Object to encapsulate a Appointment from a RealPage response.
+    class Appointment < Base
+      integer_attrs *%w[
+        day
+        hour
+        minute
+        month
+        year
+      ]
+
+      string_attrs *%i[
+        leasing_agent_id
+        pmc_id
+        site_id
+        task_notes
+      ]
+    end
+  end
+end

data/lib/real_page/model/base.rb

@@ -0,0 +1,63 @@
+require 'real_page/attribute_parser'
+
+require_relative 'base/attribute_store'
+
+module RealPage
+  module Model
+    # Base class for models, which are the return values from Requests
+    class Base
+      class << self
+        attr_accessor :attribute_store
+      end
+
+      # Create a DSL to define the models attributes and their data types. This
+      # bit of meta-programming will create a class method for each data type
+      # to define the model's attributes of the type, e.g.
+      #
+      #   class LostAndFound < Base
+      #     date_attr :found_date, :lost_date
+      #   end
+      #
+      # When a new LostAndFound is initialized (from a RealPage response hash,
+      # that may have the keys 'founddate' and 'lostdate'), it will create
+      # attribute readers for #found_date and #lost_date that return Date
+      # instances.
+      #
+      # Boolean attributes will have the existential '?', e.g.
+      #
+      #   class LostAndFound < Base
+      #     boolean_attr :found
+      #   end
+      #
+      # lost_and_found = LostAndFound.new('foundbit' => '1')
+      # lost_and_found.found?
+      # # => true
+      %i[boolean date date_time decimal integer object string].each do |data_type|
+        define_singleton_method "#{data_type}_attrs" do |*attrs|
+          self.attribute_store ||= AttributeStore.new(self)
+          attribute_store.add(data_type, attrs).each do |attribute|
+            define_method attribute.accessor_name do
+              instance_variable_get("@#{attribute.name}")
+            end
+          end
+        end
+      end
+
+      # Initialize a new model with the response hash from RealPage. Attribute
+      # values are parsed into their configured data types.
+      #
+      # @param attrs [Hash<String, Object>] the response hash from RealPage.
+      #   Attribute keys are case insensitive.
+      def initialize(attrs = {})
+        attrs.each do |attr, value|
+          attribute = self.class.attribute_store.find(attr)
+          next unless attribute
+          parser = AttributeParser.new(value: value, type: attribute.type)
+          instance_variable_set("@#{attribute.name}", parser.parse)
+        end
+      end
+    end
+
+    private_constant :Base
+  end
+end

data/lib/real_page/model/base/attribute.rb

@@ -0,0 +1,56 @@
+module RealPage
+  module Model
+    class Base
+      # Encapsulate a model attribute
+      class Attribute
+        attr_reader :prefix, :type, :name
+
+        def initialize(prefix:, type:, name:)
+          @prefix = prefix
+          @type = type
+          @name = name.to_s
+        end
+
+        # @return [String] the name of the method on the model used to access
+        #   this attribute
+        def accessor_name
+          type == :boolean ? "#{name}?" : name
+        end
+
+        # There is some magic happening here to support more convenient
+        # attribute names. Since Model::Base.new can take parameters from a
+        # parsed XML document or from a human, we need to be able to look up
+        # the attribute based on either. The general mapping looks like:
+        #
+        #  XML node      | attribute name
+        # ---------------+--------------------
+        #  SomeThing     | some_thing
+        #  something     | some_thing
+        #  foobarid      | bar_id (if in Model::Foo)
+        #  somethingbit  | some_thing (if defined as a :boolean)
+        #  somethingflag | some_thing (if defined as a :boolean)
+        #
+        # @param attr [String|Symbol] the name of the attribute or the XML node
+        #   name from the RealPage response, e.g. :made_ready_date or
+        #   "MadeReadyDate"
+        # @return [true|false] true iff the value passed in is for this
+        #   Attribute
+        def matches?(attr)
+          possible_names.include?(attr.to_s.downcase)
+        end
+
+        private
+
+        def possible_names
+          squished_name = name.gsub(/_/, '')
+          prefixed_name = "#{prefix}#{squished_name}"
+          names = [name, squished_name, prefixed_name]
+          if type == :boolean
+            names.concat(["#{squished_name}flag", "#{squished_name}bit"])
+          end
+          names
+        end
+      end
+    end
+  end
+end

data/lib/real_page/model/base/attribute_store.rb

@@ -0,0 +1,37 @@
+require_relative 'attribute'
+
+module RealPage
+  module Model
+    class Base
+      # Hold attributes defined with the DSL in Models
+      class AttributeStore
+        def initialize(model_class)
+          @model_class = model_class
+          @attributes = []
+        end
+
+        # Add all attributes of the same type to the AttributeStore
+        def add(type, attrs)
+          attrs.map do |attr|
+            attribute = Attribute.new(prefix: prefix, type: type, name: attr)
+            @attributes << attribute
+            attribute
+          end
+        end
+
+        # Find a specific attribute with the given name
+        def find(attr)
+          attributes.detect { |attribute| attribute.matches?(attr) }
+        end
+
+        private
+
+        attr_reader :attributes, :model_class
+
+        def prefix
+          model_class.name.split('::').last.downcase
+        end
+      end
+    end
+  end
+end

data/lib/real_page/model/floor_plan.rb

@@ -0,0 +1,33 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # A container for a floor plan as represented by RealPage.
+    class FloorPlan < Base
+      boolean_attrs *%i[excluded_from_occupancy]
+
+      decimal_attrs *%i[
+        bathrooms
+        rent_max
+        rent_min
+      ]
+
+      integer_attrs *%i[
+        bedrooms
+        gross_square_footage
+        id
+        maximum_occupants
+        rentable_square_footage
+      ]
+
+      string_attrs *%i[
+        code
+        description
+        group_id
+        group_name
+        name
+        name_marketing
+      ]
+    end
+  end
+end

data/lib/real_page/model/follow_up.rb

@@ -0,0 +1,34 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # Object to encapsulate a FollowUp from a RealPage response.
+    class FollowUp < Base
+      boolean_attrs *%i[
+        past_due_task
+      ]
+
+      date_attrs *%i[
+        task_contact_date_time
+      ]
+
+      integer_attrs *%i[
+        agent_id
+        task_id
+      ]
+
+      string_attrs *%i[
+        agent_name
+        notes
+        priority_cd
+        task
+        task_appt_date_time
+        task_category_cd
+        task_confirmed
+        task_contact_type_cd
+        task_duration_end
+        task_duration_start
+      ]
+    end
+  end
+end

data/lib/real_page/model/guest_card.rb

@@ -0,0 +1,49 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # A container for a guest_card as represented by RealPage.
+    class GuestCard < Base
+      boolean_attrs *%i[
+        status_is_active
+        status_is_leased
+        status_is_lost
+      ]
+
+      date_attrs *%i[desired_lease_end_date]
+
+      date_time_attrs *%i[create_date]
+
+      object_attrs *%i[
+        activities
+        amenities
+        appointment
+        follow_ups
+        lease_actions
+        preferences
+        prospects
+        quotes
+        screenings
+        units_shown
+      ]
+
+      string_attrs *%i[
+        contact_type
+        customer_id
+        date_contact
+        date_followup
+        id
+        leasing_agent_id
+        move_in_reason
+        pet_weight_range
+        pmc_id
+        primary_lead_source
+        primary_traffic_source_minor
+        property_status
+        prospect_comment
+        secondary_lead_source
+        site_id
+      ]
+    end
+  end
+end

data/lib/real_page/model/lease.rb

@@ -0,0 +1,36 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # A container for a lease as represented by RealPage.
+    class Lease < Base
+      date_attrs *%i[begin_date end_date move_in_date]
+
+      string_attrs *%i[
+        email
+        first_name
+        guest_card_id
+        id
+        last_name
+        middle_name
+        resident_household_id
+        resident_member_id
+        phone_1
+        phone_2
+        phone_ext_1
+        phone_ext_2
+        term_id
+        type
+        unit_id
+        unit_number
+      ]
+
+      # Possible values for leasetype, provided as a convenience
+      module Type
+        FIRST_LEASE = 'First Lease'.freeze
+        RENEWAL = 'Renewal'.freeze
+        TRANSFER = 'Transfer'.freeze
+      end
+    end
+  end
+end

data/lib/real_page/model/lease_action.rb

@@ -0,0 +1,32 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # Object to encapsulate a LeaseAction from a RealPage response.
+    class LeaseAction < Base
+      boolean_attrs *%i[
+        editable
+        rentable_item_reserved
+      ]
+
+      date_attrs *%i[
+        note_date
+        sort_date
+      ]
+
+      integer_attrs *%i[
+        lal_org_lea_id
+        note_comment_length
+        note_id
+      ]
+
+      string_attrs *%i[
+        for_correct_date_sort
+        note_comment
+        note_source
+        note_type
+        note_user
+      ]
+    end
+  end
+end

data/lib/real_page/model/phone_number.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # Object to encapsulate a PhoneNumber from a RealPage response.
+    class PhoneNumber < Base
+      string_attrs *%i[
+        type
+        number
+      ]
+    end
+  end
+end

data/lib/real_page/model/picklist_item.rb

@@ -0,0 +1,10 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # Object to encapsulate a PicklistItem from a RealPage response.
+    class PicklistItem < Base
+      string_attrs *%i[value text]
+    end
+  end
+end

data/lib/real_page/model/preferences.rb

@@ -0,0 +1,25 @@
+require_relative 'base'
+
+module RealPage
+  module Model
+    # Object to encapsulate a Preferences from a RealPage response.
+    class Preferences < Base
+      date_attrs *%i[
+        date_needed
+      ]
+
+      integer_attrs *%i[
+        desired_rent
+        floorplan_id
+        lease_term_months
+      ]
+
+      string_attrs *%i[
+        floorplan_group_id
+        occupants
+        price_range_id
+        site_id
+      ]
+    end
+  end
+end