yardi 4.0.8

data/lib/yardi/parameter/agent.rb

@@ -0,0 +1,13 @@
+module Yardi
+  module Parameter
+    # Wrapper for a Yardi agent. An agent is required for guest card insertions.
+    class Agent
+      attr_reader :first_name, :last_name
+
+      def initialize(first_name:, last_name:)
+        @first_name = first_name
+        @last_name = last_name
+      end
+    end
+  end
+end

data/lib/yardi/parameter/contact_info.rb

@@ -0,0 +1,13 @@
+module Yardi
+  module Parameter
+    class ContactInfo
+      attr_reader :email, :cell_phone, :home_phone
+
+      def initialize(email:, cell_phone: nil, home_phone: nil)
+        @email = email
+        @cell_phone= cell_phone
+        @home_phone = home_phone
+      end
+    end
+  end
+end

data/lib/yardi/parameter/credential.rb

@@ -0,0 +1,16 @@
+module Yardi
+  module Parameter
+    # Contains PMC-specific data for interfacing with Yardi's API.
+    class Credential
+      attr_reader :database, :password, :server, :username, :web_service_url
+
+      def initialize(database:, password:, server:, username:, web_service_url:)
+        @database = database
+        @password = password
+        @server = server
+        @username = username
+        @web_service_url = web_service_url
+      end
+    end
+  end
+end

data/lib/yardi/parameter/property.rb

@@ -0,0 +1,35 @@
+module Yardi
+  module Parameter
+    class Property
+      attr_reader :first_contact_time,
+                  :remote_id,
+                  :tour_notes,
+                  :tour_remote_id,
+                  :tour_time
+
+      # @param first_contact_time [Time] The time of the renter's first contact
+      #   with the property, in the property's time zone
+      # @param remote_id [String] The ID associated with the property in Yardi's
+      #   system. From Apartment List, property.remote_property_id
+      # @param tour_notes [String] The notes to be inserted to the Comments
+      #   node in the Appointment event.
+      # @param tour_remote_id [String] The ID in Yardi's system of the renter's
+      #   tour, or nil if there is no tour for the renter at the property.
+      # @param tour_time [Time] The time of the renter's tour, or nil if there
+      #   is no tour for the renter at the property.
+      def initialize(
+        remote_id:,
+        first_contact_time:,
+        tour_notes: nil,
+        tour_remote_id: nil,
+        tour_time: nil
+      )
+        @first_contact_time = first_contact_time
+        @remote_id = remote_id
+        @tour_notes = tour_notes
+        @tour_remote_id = tour_remote_id
+        @tour_time = tour_time
+      end
+    end
+  end
+end

data/lib/yardi/parameter/prospect.rb

@@ -0,0 +1,25 @@
+# This is the parameter used for prospect search in GetYardiGuestActivity. It
+# should not be confused with the Parameter::User that is used for guestcard
+# insertion in ImportYardiGuest.
+
+module Yardi
+  module Parameter
+    class Prospect
+      attr_reader :first_name, :last_name, :email, :phone, :yardi_prospect_id
+
+      def initialize(
+        first_name: nil,
+        last_name: nil,
+        email: nil,
+        phone: nil,
+        yardi_prospect_id: nil
+      )
+        @first_name = first_name
+        @last_name = last_name
+        @email = email
+        @phone = phone
+        @yardi_prospect_id = yardi_prospect_id
+      end
+    end
+  end
+end

data/lib/yardi/parameter/user.rb

@@ -0,0 +1,64 @@
+module Yardi
+  module Parameter
+    # Wraps the user-related data that we pass to Yardi.
+    class User
+      attr_reader :beds,
+                  :contact_info,
+                  :first_name,
+                  :id,
+                  :last_name,
+                  :message,
+                  :move_in_date,
+                  :preference_notes,
+                  :preferred_floorplan_id,
+                  :preferred_unit_id,
+                  :price
+
+      # @param beds [Integer] Number of beds the renter is interested in
+      # @param contact_info [Parameter::ContactInfo] Renter contact information
+      # @param first_name [String] Renter first name
+      # @param id [Integer] ID of the renter in Apartment List database, user.id
+      # @param last_name [String] Renter last name
+      # @param message [String] Message from the renter to the property
+      # @param move_in_date [Date] Renter move in date
+      # @param preference_notes [String] Notes to be inserted into Comments node
+      #   of CustomerPreferences section of guest card
+      # @param preferred_floorplan_id [String] ID of Yardi floorplan the renter
+      #   is interested in. MUST be a real floorplan on the property in Yardi's
+      #   system. The list of floorplans can be seen with a
+      #   UnitAvailability_Login request.
+      # @param preferred_unit_id [String] ID of Yardi unit the renter is
+      #   interested in. If specified, it MUST be a real unit on the property in
+      #   Yardi's system. The list of units can be seen with a
+      #   UnitAvailability_Login request. This param is only required when
+      #   inserting a tour.
+      # @param price [Integer] Renter budget
+      def initialize(
+        beds:,
+        contact_info:,
+        first_name:,
+        id:,
+        last_name:,
+        message:,
+        move_in_date:,
+        preference_notes:,
+        preferred_floorplan_id:,
+        preferred_unit_id: nil,
+        price:
+      )
+
+        @beds = beds.nil? || beds == '' ? nil : beds.to_i
+        @contact_info = contact_info
+        @first_name = first_name
+        @id = id
+        @last_name = last_name
+        @message = message
+        @move_in_date = move_in_date
+        @preference_notes = preference_notes
+        @preferred_floorplan_id = preferred_floorplan_id
+        @preferred_unit_id = preferred_unit_id
+        @price = price.to_i > 0 ? price.to_i : nil
+      end
+    end
+  end
+end

data/lib/yardi/request/base.rb

@@ -0,0 +1,99 @@
+require 'yardi/request_section/authentication'
+require 'yardi/utils/request_fetcher'
+require 'yardi/utils/request_generator'
+
+module Yardi
+  module Request
+    # Base class for actions that fetch and parse specific Yardi 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 necessary authentication
+    #     data 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
+      attr_reader :connection, :credential, :response
+      # @param credential [Parameter::Credential] contains the PMC-specific
+      # configuration information needed to make a request. We want to fail
+      # noisily if it's missing, so it is separate from the main params hash.
+      # @param params [Hash<Symbol, Object>] the parameters needed to build the
+      #   XML request.
+      def initialize(credential:, params:)
+        @credential = credential
+        @connection = params[:connection] || Faraday.new
+        after_initialize(params)
+      end
+
+      # @return [Yardi::Model|Array<Yardi::Model>] the parsed response
+      #   from Yardi
+      # @raise [Yardi::Error] if an error was encountered when validating
+      #   the response
+      def perform
+        @response = xml
+        parser.parse(@response)
+      end
+
+      # @return [String] the XMl response from Yardi
+      def xml
+        Utils::RequestFetcher.new(
+          connection: connection,
+          endpoint: credential.web_service_url,
+          generator: generator
+        ).fetch
+      end
+
+      # This makes it easy for us to see what XML we're about to send when
+      # debugging requests
+      def generator
+        Utils::RequestGenerator.new(soap_action, sections, interface)
+      end
+
+      private
+
+      # 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
+        { soap_body: soap_body_sections, xml_doc: xml_doc_sections }
+      end
+
+      def soap_body_sections
+        []
+      end
+
+      def xml_doc_sections
+        []
+      end
+
+      # Each request must specify its associated SOAP action.
+      def soap_action
+        raise NotImplementedError
+      end
+
+      # Each request must specify its associated interface.
+      def interface
+        raise NotImplementedError
+      end
+    end
+
+    private_constant :Base
+  end
+end

data/lib/yardi/request/get_residents.rb

@@ -0,0 +1,39 @@
+require 'yardi/document_parser/residents'
+require 'yardi/request_section/residents'
+
+require_relative 'base'
+
+module Yardi
+  module Request
+    # Get all residents for a given property ID.
+    class GetResidents < Base
+      private
+
+      attr_reader :property_id
+
+      def after_initialize(params)
+        @property_id = params[:property_id]
+        raise ArgumentError, ':property_id is required' unless property_id
+      end
+
+      def parser
+        DocumentParser::Residents.new(property_id)
+      end
+
+      def soap_body_sections
+        [
+          RequestSection::Authentication.new(credential),
+          RequestSection::Residents.new(property_id: property_id)
+        ]
+      end
+
+      def soap_action
+        'GetResidents'
+      end
+
+      def interface
+        'ItfResidentData'
+      end
+    end
+  end
+end

data/lib/yardi/request/get_yardi_guest_activity.rb

@@ -0,0 +1,85 @@
+require 'yardi/document_parser/prospects'
+require 'yardi/request_section/prospect'
+
+require_relative 'base'
+
+module Yardi
+  module Request
+    ##
+    # Search Yardi for Prospects
+    #
+    #     prospect = Yardi::Parameter::Prospect.new(...)
+    #
+    #     request = Yardi::Request::GetYardiGuestActivity.new(
+    #       credential: credential,
+    #       params: { property_id: 'p263656', prospect: prospect }
+    #     )
+    #
+    #     request.perform
+    #     # => [#<Yardi::Model::Prospect>, #<Yardi::Model::Prospect>]
+    #
+    class GetYardiGuestActivity < Base
+      ##
+      # :method: initialize
+      #
+      # Create a new instance of GetYardiGuestActivity
+      #
+      # Required parameters:
+      # * +property_id+ String
+      # * +prospect+ Yardi::Parameter::Prospect
+      #
+      #     request = Yardi::Request::GetYardiGuestActivity.new(
+      #       credential: credential,
+      #       params: { property_id: 'p263656', prospect: prospect }
+      #     )
+
+      ##
+      # :method: perform
+      #
+      # Use #perform to send the actual HTTP request
+      #
+      #     request.perform
+      #     # => [#<Yardi::Model::Prospect>, #<Yardi::Model::Prospect>]
+      #
+      # Returns an Array of Yardi::Model::Prospect records
+      #
+
+      ##
+      # Private methods
+      private
+
+      attr_reader :property_id, :prospect
+
+      def after_initialize(params)
+        @property_id = params[:property_id]
+        @prospect = params[:prospect]
+
+        unless property_id && prospect
+          raise ArgumentError, ':property_id and :prospect are required'
+        end
+      end
+
+      def parser
+        DocumentParser::Prospects.new
+      end
+
+      def soap_body_sections
+        [
+          RequestSection::Authentication.new(credential),
+          RequestSection::Prospect.new(
+            property_id: property_id,
+            prospect: prospect
+          )
+        ]
+      end
+
+      def soap_action
+        'GetYardiGuestActivity_Search'
+      end
+
+      def interface
+        'ItfILSGuestCard'
+      end
+    end
+  end
+end

data/lib/yardi/request/import_yardi_guest.rb

@@ -0,0 +1,73 @@
+require 'yardi/document_parser/guest_card_import_response_object'
+require 'yardi/request_section/lead_management'
+
+require_relative 'base'
+
+module Yardi
+  module Request
+    # Post a GuestCard to Yardi's system
+    #
+    # Required initializer parameters:
+    #
+    # @param agent [Parameter::Agent] The agent to associate with the guestcard.
+    # @param credential [Parameter::Credential] PMC-specific information needed
+    #   to post to Yardi
+    # @param lead_source [String] The originating source of the lead
+    # @param property [Parameter::Property] The property that the renter is
+    #   expressing interest in
+    # @param reason [String] The reason the renter contacted the property, e.g.
+    #  'tour', 'price inquiry', etc.
+    # @param user [Parameter::User] The renter
+    class ImportYardiGuest < Base
+      private
+
+      attr_reader :agent, :lead_source, :property, :reason, :user
+
+      def after_initialize(params)
+        @agent = params[:agent]
+        @lead_source = params[:lead_source]
+        @property = params[:property]
+        @reason = params[:reason]
+        @user = params[:user]
+
+        check_required_params
+      end
+
+      def check_required_params
+        unless agent && lead_source && property && reason && user
+          message =
+            ':agent, :lead_source, :property, :reason, :user are all required'
+          raise ArgumentError, message
+        end
+      end
+
+      def parser
+        DocumentParser::GuestCardImportResponseObject.new
+      end
+
+      def soap_body_sections
+        [RequestSection::Authentication.new(credential)]
+      end
+
+      def xml_doc_sections
+        [
+          RequestSection::LeadManagement.new(
+            agent: agent,
+            lead_source: lead_source,
+            property: property,
+            reason: reason,
+            user: user
+          )
+        ]
+      end
+
+      def soap_action
+        'ImportYardiGuest_Login'
+      end
+
+      def interface
+        'ItfILSGuestCard'
+      end
+    end
+  end
+end