yardi 4.0.8 → 4.11.0

data/lib/yardi/document_parser/residents.rb

@@ -1,3 +1,4 @@
+require 'yardi/validator/resident_eventing'
 require_relative 'base'
 
 module Yardi
@@ -5,8 +6,8 @@ module Yardi
     class Residents < Base
       SOAP_ACTION = 'GetResidents'.freeze
 
-      def initialize(property_id)
-        @property_id = property_id
+      def after_initialize(params)
+        @property_id = params[:property_id]
       end
 
       private
@@ -34,8 +35,6 @@ module Yardi
         results.map { |r| create_resident(r) }
       end
 
-      private
-
       # Creates a primary Resident after first creating Resident objects
       # for roommates under `OtherOccupants`.
       def create_resident(resident)
@@ -48,12 +47,17 @@ module Yardi
       # either be a Hash or Array, so we cast it to an Array from the start.
       def create_roommates(roommates)
         return unless roommates
+
         roommates = [roommates].flatten
 
         roommates.map do |r|
           Model::Resident.new(r, type: 'roommate')
         end
       end
+
+      def validator_classes
+        [Validator::ResidentEventing]
+      end
     end
   end
 end

data/lib/yardi/error/canceled_guest.rb

@@ -0,0 +1,9 @@
+require_relative 'error_response'
+
+module Yardi
+  module Error
+    # Raised when a Yardi response contains error message about Canceled Guest
+    class CanceledGuest < ErrorResponse
+    end
+  end
+end

data/lib/yardi/model/property.rb

@@ -0,0 +1,27 @@
+module Yardi
+  module Model
+    class Property
+      attr_reader :timezone, :remote_id, :marketing_name, :address, :city,
+                  :state, :postal_code
+
+      def initialize(property)
+        @timezone = property['TimeZone']
+        @remote_id = property['Code']
+        @marketing_name = property['MarketingName']
+        @address = format_address(property['AddressLine1'], property['AddressLine2'], property['AddressLine3'])
+        @city = property['City']
+        @state = property['State']
+        @postal_code = property['PostalCode']
+      end
+
+      private
+
+      # The xml response has AddressLine1 AddressLine2 and AddressLine3 nodes
+      # We should unify it to a single address string
+      def format_address(address_line_1, address_line_2, address_line_3)
+        address = address_line_1.to_s + ' ' + address_line_2.to_s + ' ' + address_line_3.to_s
+        address.strip
+      end
+    end
+  end
+end

data/lib/yardi/model/resident.rb

@@ -7,7 +7,7 @@ module Yardi
     class Resident
       attr_reader :status, :lease_id, :lease_lead_id, :first_name, :last_name,
                   :email, :phones, :unit_name, :move_in_date, :lease_from_date,
-                  :lease_to_date, :type, :roommates
+                  :lease_to_date, :type, :roommates, :import_resident_id
 
       def initialize(resident, type:, roommates: nil)
         @status = resident['Status']
@@ -23,6 +23,7 @@ module Yardi
         @lease_to_date = parse_date(resident['LeaseToDate'])
         @type = type
         @roommates = roommates || []
+        @import_resident_id = resident['import_resident_id']
       end
 
       private

data/lib/yardi/parameter/contact_info.rb

@@ -5,7 +5,7 @@ module Yardi
 
       def initialize(email:, cell_phone: nil, home_phone: nil)
         @email = email
-        @cell_phone= cell_phone
+        @cell_phone = cell_phone
         @home_phone = home_phone
       end
     end

data/lib/yardi/parameter/prospect.rb

@@ -5,19 +5,21 @@
 module Yardi
   module Parameter
     class Prospect
-      attr_reader :first_name, :last_name, :email, :phone, :yardi_prospect_id
+      attr_reader :first_name, :last_name, :email, :phone, :phones, :yardi_prospect_id
 
       def initialize(
         first_name: nil,
         last_name: nil,
         email: nil,
         phone: nil,
+        phones: nil,
         yardi_prospect_id: nil
       )
         @first_name = first_name
         @last_name = last_name
         @email = email
         @phone = phone
+        @phones = phones
         @yardi_prospect_id = yardi_prospect_id
       end
     end

data/lib/yardi/parameter/user.rb

@@ -43,8 +43,7 @@ module Yardi
         move_in_date:,
         preference_notes:,
         preferred_floorplan_id:,
-        preferred_unit_id: nil,
-        price:
+        price:, preferred_unit_id: nil
       )
 
         @beds = beds.nil? || beds == '' ? nil : beds.to_i

data/lib/yardi/request/base.rb

@@ -23,6 +23,7 @@ module Yardi
     # 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.
@@ -45,11 +46,15 @@ module Yardi
 
       # @return [String] the XMl response from Yardi
       def xml
-        Utils::RequestFetcher.new(
-          connection: connection,
-          endpoint: credential.web_service_url,
-          generator: generator
-        ).fetch
+        if request_test_data?
+          fetch_test_data
+        else
+          Utils::RequestFetcher.new(
+            connection: connection,
+            endpoint: credential.web_service_url,
+            generator: generator
+          ).fetch
+        end
       end
 
       # This makes it easy for us to see what XML we're about to send when
@@ -92,6 +97,23 @@ module Yardi
       def interface
         raise NotImplementedError
       end
+
+      def request_test_data?
+        params[:test_data] == true
+      end
+
+      def request_name
+        self.class.name.split('::').last
+      end
+
+      def fetch_test_data
+        case request_name
+        when 'GetResidents'
+          Utils::TestDataFetcher.residents(params[:property_id])
+        when 'GetYardiGuestActivity'
+          Utils::TestDataFetcher.guest_card_activity(params[:property_id], params[:prospect])
+        end
+      end
     end
 
     private_constant :Base

data/lib/yardi/request/get_property_configurations.rb

@@ -0,0 +1,36 @@
+require 'yardi/document_parser/properties'
+
+require_relative 'base'
+
+module Yardi
+  module Request
+    # Get all property configurations for a given credential
+    class GetPropertyConfigurations < Base
+      private
+
+      attr_reader :params
+
+      def after_initialize(params)
+        @params = params
+      end
+
+      def parser
+        DocumentParser::Properties.new(params)
+      end
+
+      def soap_body_sections
+        [
+          RequestSection::Authentication.new(credential)
+        ]
+      end
+
+      def soap_action
+        'GetPropertyConfigurations'
+      end
+
+      def interface
+        'ItfILSGuestCard'
+      end
+    end
+  end
+end

data/lib/yardi/request/get_residents.rb

@@ -9,15 +9,16 @@ module Yardi
     class GetResidents < Base
       private
 
-      attr_reader :property_id
+      attr_reader :property_id, :params
 
       def after_initialize(params)
         @property_id = params[:property_id]
+        @params = params
         raise ArgumentError, ':property_id is required' unless property_id
       end
 
       def parser
-        DocumentParser::Residents.new(property_id)
+        DocumentParser::Residents.new(params)
       end
 
       def soap_body_sections

data/lib/yardi/request/get_yardi_guest_activity.rb

@@ -48,19 +48,20 @@ module Yardi
       # Private methods
       private
 
-      attr_reader :property_id, :prospect
+      attr_reader :property_id, :prospect, :params, :with_or, :send_prospect_events
 
       def after_initialize(params)
         @property_id = params[:property_id]
         @prospect = params[:prospect]
+        @params = params
+        @with_or = params[:with_or] || false
+        @send_prospect_events = params[:send_prospect_events].nil? ? true : params[:send_prospect_events]
 
-        unless property_id && prospect
-          raise ArgumentError, ':property_id and :prospect are required'
-        end
+        raise ArgumentError, ':property_id and :prospect are required' unless property_id && prospect
       end
 
       def parser
-        DocumentParser::Prospects.new
+        DocumentParser::Prospects.new(params)
       end
 
       def soap_body_sections
@@ -74,7 +75,11 @@ module Yardi
       end
 
       def soap_action
-        'GetYardiGuestActivity_Search'
+        if with_or
+          'GetYardiGuestActivity_SearchWithOR'
+        else
+          'GetYardiGuestActivity_Search'
+        end
       end
 
       def interface

data/lib/yardi/request/import_yardi_guest.rb

@@ -19,9 +19,12 @@ module Yardi
     #  'tour', 'price inquiry', etc.
     # @param user [Parameter::User] The renter
     class ImportYardiGuest < Base
+      CREATE_GUESTCARD_ACTION = 'create'.freeze
+      VALID_GUESTCARD_ACTIONS = %w[inactivate create reactivate update].freeze
+
       private
 
-      attr_reader :agent, :lead_source, :property, :reason, :user
+      attr_reader :agent, :lead_source, :property, :reason, :user, :guestcard_action, :params
 
       def after_initialize(params)
         @agent = params[:agent]
@@ -29,8 +32,11 @@ module Yardi
         @property = params[:property]
         @reason = params[:reason]
         @user = params[:user]
+        @guestcard_action = params[:guestcard_action] || CREATE_GUESTCARD_ACTION
+        @params = params
 
         check_required_params
+        validate_action
       end
 
       def check_required_params
@@ -41,8 +47,16 @@ module Yardi
         end
       end
 
+      def validate_action
+        unless VALID_GUESTCARD_ACTIONS.include? guestcard_action
+          message =
+            "a guestcard_action of 'inactivate', 'create', 'reactivate', or 'update' is required"
+          raise ArgumentError, message
+        end
+      end
+
       def parser
-        DocumentParser::GuestCardImportResponseObject.new
+        DocumentParser::GuestCardImportResponseObject.new(params)
       end
 
       def soap_body_sections
@@ -56,7 +70,8 @@ module Yardi
             lead_source: lead_source,
             property: property,
             reason: reason,
-            user: user
+            user: user,
+            guestcard_action: guestcard_action
           )
         ]
       end

data/lib/yardi/request_section/lead_management.rb

@@ -4,12 +4,13 @@ module Yardi
   module RequestSection
     # Generate the LeadManagement section of a Yardi request
     class LeadManagement
-      def initialize(agent:, lead_source:, property:, reason:, user:)
+      def initialize(agent:, lead_source:, property:, reason:, user:, guestcard_action:)
         @agent = agent
         @lead_source = lead_source
         @property = property
         @reason = reason
         @user = user
+        @guestcard_action = guestcard_action
       end
 
       def generate(xml_builder)
@@ -22,15 +23,31 @@ module Yardi
 
       private
 
-      attr_reader :agent, :lead_source, :property, :reason, :user
+      attr_reader :agent, :lead_source, :property, :reason, :user, :guestcard_action
 
+      # guestcard_action for yardi gem can be 'create', 'inactivate', 'reactivate', or 'update'.
+      # When guestcard_action is 'create' we need to generate first_contact_event_xml.
+      # When guestcard_action is 'inactivate' we need to generate both the first_contact_event_xml
+      # and the cancel_event_xml.
+      # When the guestcard_action is 'reactivate' we need to generate reactivate_event_xml
+      # When the guestcard_action is 'update' we need to generate the update_event_xml
       def prospect_xml(xml_builder)
         xml_builder.Prospect do |prospect_xml|
           customers_xml(prospect_xml)
           preferences_xml(prospect_xml)
 
           prospect_xml.Events do |events_xml|
-            first_contact_event_xml(events_xml)
+            case guestcard_action
+            when 'create'
+              first_contact_event_xml(events_xml)
+            when 'inactivate'
+              first_contact_event_xml(events_xml)
+              cancel_event_xml(events_xml)
+            when 'reactivate'
+              reactivate_event_xml(events_xml)
+            when 'update'
+              update_event_xml(events_xml)
+            end
             tour_xml(events_xml) unless property.tour_time.nil?
           end
         end
@@ -92,13 +109,9 @@ module Yardi
           # Rent and bedrooms are empty nodes with attributes for values.
           # Yardi doesn't like having an empty string for either of these
           # attributes, so we leave the node out if we don't have any data.
-          unless user.price.nil?
-            preferences_xml.DesiredRent('Exact' => user.price) {}
-          end
+          preferences_xml.DesiredRent('Exact' => user.price) {} unless user.price.nil?
 
-          unless user.beds.nil?
-            preferences_xml.DesiredNumBedrooms('Exact' => user.beds) {}
-          end
+          preferences_xml.DesiredNumBedrooms('Exact' => user.beds) {} unless user.beds.nil?
 
           preferences_xml.Comment user.preference_notes
         end
@@ -118,6 +131,56 @@ module Yardi
         end
       end
 
+      # To create a cancel event for an inactive guestcard,
+      # EventType should be 'Cancel' and FirstContact should be false
+      # cancel_time should be one second after first_contact_time
+      def cancel_event_xml(xml_builder)
+        cancel_time = property.first_contact_time + 1
+        event_attrs = {
+          'EventDate' => cancel_time.iso8601,
+          'EventType' => 'Cancel'
+        }
+        xml_builder.Event(event_attrs) do |event_xml|
+          agent_xml(event_xml)
+          event_xml.EventReasons reason
+          event_xml.FirstContact false
+          event_xml.Comments user.message
+          event_xml.TransactionSource lead_source
+        end
+      end
+
+      # To create a reactivate event for an inactive guestcard,
+      # EventType should be 'ReActivate' and FirstContact should be false
+      def reactivate_event_xml(xml_builder)
+        event_attrs = {
+          'EventDate' => property.first_contact_time.iso8601,
+          'EventType' => 'ReActivate'
+        }
+        xml_builder.Event(event_attrs) do |event_xml|
+          agent_xml(event_xml)
+          event_xml.EventReasons reason
+          event_xml.FirstContact false
+          event_xml.Comments user.message
+          event_xml.TransactionSource lead_source
+        end
+      end
+
+      # To create an update event for a guestcard,
+      # EventType should be 'Email' and FirstContact should be false.
+      def update_event_xml(xml_builder)
+        event_attrs = {
+          'EventDate' => property.first_contact_time.iso8601,
+          'EventType' => 'Email'
+        }
+        xml_builder.Event(event_attrs) do |event_xml|
+          agent_xml(event_xml)
+          event_xml.EventReasons reason
+          event_xml.FirstContact false
+          event_xml.Comments user.message
+          event_xml.TransactionSource lead_source
+        end
+      end
+
       def agent_xml(xml_builder)
         xml_builder.Agent do |agent_xml|
           agent_xml.AgentName do |agent_name_xml|

data/lib/yardi/request_section/prospect.rb

@@ -19,6 +19,7 @@ module Yardi
         xml_builder['itf'].LastName prospect.last_name
         xml_builder['itf'].EmailAddress prospect.email
         xml_builder['itf'].PhoneNumber prospect.phone
+        prospect.phones&.each { |phone| xml_builder['itf'].PhoneNumber phone }
         xml_builder['itf'].ThirdPartyId prospect.yardi_prospect_id
         xml_builder['itf'].FederalId
       end

data/lib/yardi/utils/google_cloud_storage.rb

@@ -0,0 +1,25 @@
+require 'google/cloud/storage'
+
+module Yardi
+  module Utils
+    class GoogleCloudStorage
+      GCS_BUCKET = Yardi.config.gcs_bucket
+
+      def self.read_file(file_path:, bucket: GCS_BUCKET)
+        bucket = client.bucket(bucket)
+        file = bucket.file(file_path)
+        if file
+          downloaded = file.download
+          downloaded.rewind
+          downloaded.read
+        else
+          ''
+        end
+      end
+
+      def self.client
+        @client ||= Google::Cloud::Storage.new
+      end
+    end
+  end
+end

data/lib/yardi/utils/request_fetcher.rb

@@ -23,9 +23,7 @@ module Yardi
 
         response = perform!
 
-        if response.status == 404
-          raise Yardi::Error::ResourceNotFound, response.body
-        end
+        raise Yardi::Error::ResourceNotFound, response.body if response.status == 404
 
         response.body
       end
@@ -39,8 +37,8 @@ module Yardi
           request.body = generator.body
           request.headers = generator.headers
         end
-      rescue Errno::EADDRNOTAVAIL => error
-        raise Yardi::Error::ConnectionError, error.message
+      rescue Errno::EADDRNOTAVAIL => e
+        raise Yardi::Error::ConnectionError, e.message
       end
     end
   end

data/lib/yardi/utils/request_generator.rb

@@ -44,6 +44,7 @@ module Yardi
 
       def xml_doc_body
         return nil if sections[:xml_doc].nil?
+
         body_fragment = Nokogiri::XML::DocumentFragment.parse('')
         Nokogiri::XML::Builder.with(body_fragment) do |xml_builder|
           sections[:xml_doc].each do |section|

data/lib/yardi/utils/snowflake_event_tracker.rb

@@ -0,0 +1,107 @@
+require 'securerandom'
+require 'event_tracker'
+require 'yardi/utils'
+require 'yardi'
+
+module Yardi
+  module Utils
+    class SnowflakeEventTracker
+      IMPORT_PMS_RESIDENT_EVENT = 'import_pms_resident'
+      IMPORT_PMS_PROSPECT_EVENT = 'import_pms_prospect'
+
+      def self.track_pms_resident_event(
+        import_resident_id:, resident_type:, request_params:, unit_name:, remote_lease_id: nil,
+        move_in_date: nil,
+        lease_to: nil,
+        lease_from: nil,
+        first_name_present: false,
+        last_name_present: false,
+        email_present: false,
+        phones_count: 0,
+        resident_id: nil,
+        error: nil
+      )
+        EventTracker.track_process_events(name: IMPORT_PMS_RESIDENT_EVENT) do |events|
+          events.add_imported_event(
+            EventTracker::ResourceFactory.build_pms_resident(
+              billing_import: EventTracker::BillingImportFactory.build_billing_import(
+                property_id: request_params[:property_id],
+                billing_config_id: request_params[:billing_config_id],
+                remote_id: request_params[:remote_id],
+                pms_type: 'yardi',
+                import_id: request_params[:import_id],
+                pmc_id: request_params[:pmc_id],
+                service: Yardi.config.app_name
+              ),
+              remote_lease_id: remote_lease_id,
+              import_resident_id: import_resident_id,
+              resident_type: resident_type,
+              api_name: 'GetResidents',
+              request_params: EventTracker::ResourceFactory::PmsResident.build_request_params(
+                start_date: request_params[:start_date].nil? ? nil : request_params[:start_date].to_time,
+                end_date: request_params[:end_date].nil? ? nil : request_params[:end_date].to_time,
+                prospect_id: nil,
+                pmc_id: request_params[:pmc_id],
+                remote_id: request_params[:remote_id],
+                traffic_source_id: nil
+              ),
+              move_in_date: move_in_date,
+              lease_to: lease_to,
+              lease_from: lease_from,
+              first_name_present: first_name_present,
+              last_name_present: last_name_present,
+              email_present: email_present,
+              phones_count: phones_count,
+              unit_name: unit_name,
+              resident_id: resident_id,
+              move_in_report_type: 'yardi_api',
+              error: error
+            )
+          )
+        end
+      end
+
+      def self.track_pms_prospect_event(
+        request_params:, first_name_present:, last_name_present:, email_present:, phone_present:, remote_lease_id: nil,
+        contact_date: nil,
+        contact_source: nil,
+        remote_prospect_id: nil,
+        error: nil
+      )
+        EventTracker.track_process_events(name: IMPORT_PMS_PROSPECT_EVENT) do |events|
+          events.add_imported_event(
+            EventTracker::ResourceFactory.build_pms_prospect(
+              billing_import: EventTracker::BillingImportFactory.build_billing_import(
+                property_id: request_params[:property_id],
+                billing_config_id: request_params[:billing_config_id],
+                remote_id: request_params[:remote_id],
+                pms_type: 'yardi',
+                import_id: request_params[:import_id],
+                pmc_id: request_params[:pmc_id],
+                service: Yardi.config.app_name
+              ),
+              remote_lease_id: remote_lease_id,
+              import_resident_id: request_params[:import_resident_id] || '',
+              resident_type: 'PRIMARY',
+              api_name: 'GetYardiGuestActivity_Search',
+              request_params: EventTracker::ResourceFactory::PmsProspect.build_request_params(
+                pmc_id: request_params[:pmc_id],
+                remote_id: request_params[:remote_id],
+                prospect_id: request_params[:prospect_id],
+                first_name_present: first_name_present,
+                last_name_present: last_name_present,
+                email_present: email_present,
+                phone_present: phone_present
+              ),
+              contact_date: contact_date,
+              contact_source: contact_source,
+              remote_prospect_id: remote_prospect_id,
+              move_in_report_type: 'yardi_api',
+              error: error
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/yardi/utils/test_data_fetcher.rb

@@ -0,0 +1,27 @@
+module Yardi
+  module Utils
+    class TestDataFetcher
+      RESIDENTS_PATH = 'test-data/residents/'
+      GUESTCARD_ACTIVITY_PATH = 'test-data/yardi_prospects/'
+      def self.residents(property_id)
+        GoogleCloudStorage.read_file(file_path: RESIDENTS_PATH + "#{property_id}.xml")
+      end
+
+      def self.guest_card_activity(property_id, prospect)
+        search_by = case prospect
+                    when -> (p) { p.yardi_prospect_id }
+                      { '/prospect_id/' => prospect.yardi_prospect_id }
+                    when -> (p) { p.email }
+                      { '/email/' => prospect.email.gsub(/\./,'') }
+                    when -> (p) { p.first_name } && -> (p) { p.last_name }
+                      { '/name/' => prospect.first_name + ' ' + prospect.last_name }
+                    when -> (p) { p.phone }
+                      { '/phone/' => prospect.phone }
+                    end 
+
+        file_path = GUESTCARD_ACTIVITY_PATH + property_id.to_s + search_by.keys.first + search_by[search_by.keys.first] + '.xml'
+        GoogleCloudStorage.read_file(file_path: file_path)
+      end
+    end
+  end
+end