yardi 4.0.8 → 4.11.0

data/lib/yardi/validator/base.rb

@@ -0,0 +1,114 @@
+require 'yardi/validator'
+require 'yardi/utils/snowflake_event_tracker'
+require 'yardi/utils/phone_parser'
+require 'securerandom'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Yardi
+  module Validator
+    class Base
+      def send_pms_resident_event(lease:, resident_type:, params:, error_message: nil)
+        if lease
+          remote_lease_id = lease['tCode']
+          import_resident_id = lease['import_resident_id']
+          move_in_date = parse_date(lease['MoveInDate'])
+          lease_to = parse_date(lease['LeaseToDate'])
+          lease_from = parse_date(lease['LeaseFromDate'])
+          first_name_present = lease['FirstName'].present?
+          last_name_present = lease['LastName'].present?
+          email_present = lease['Email'].present?
+          phones_count = (Utils::PhoneParser.parse(lease['Phone']) || []).length
+          unit_name = lease['UnitCode'] || ''
+          resident_id = lease['tCode']
+        else
+          remote_lease_id, move_in_date, lease_to, lease_from = [nil] * 4
+          import_resident_id = params[:import_id]
+          first_name_present, last_name_present, email_present = [false] * 3
+          phones_count = 0
+          unit_name = ''
+          resident_id = nil
+        end
+        Utils::SnowflakeEventTracker.track_pms_resident_event(
+          remote_lease_id: remote_lease_id,
+          import_resident_id: import_resident_id,
+          resident_type: resident_type,
+          request_params: pms_resident_request_params(params),
+          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,
+          error: error_message
+        )
+      end
+
+      def pms_resident_request_params(params)
+        {
+          start_date: params[:start_date]&.to_time,
+          end_date: params[:end_date]&.to_time,
+          prospect_id: nil,
+          pmc_id: params[:pmc_id],
+          remote_id: params[:property_id],
+          traffic_source_id: nil,
+          import_id: params[:import_id],
+          billing_config_id: params[:billing_config]&.id,
+          property_id: params[:billing_config]&.property_id
+        }
+      end
+
+      def send_pms_prospect_event(params:, event: nil, error_message: nil)
+        if event
+          contact_date = event['EventDate']&.to_time
+          contact_source = event['TransactionSource']
+        else
+          contact_date, contact_source = [nil] * 2
+        end
+        Utils::SnowflakeEventTracker.track_pms_prospect_event(
+          remote_lease_id: nil,
+          request_params: pms_prospect_request_params(params),
+          first_name_present: params[:prospect]&.first_name.present?,
+          last_name_present: params[:prospect]&.last_name.present?,
+          email_present: params[:prospect]&.email.present?,
+          phone_present: params[:prospect]&.phone.present?,
+          contact_date: contact_date,
+          contact_source: contact_source,
+          remote_prospect_id: params[:prospect]&.yardi_prospect_id,
+          error: error_message
+        )
+      end
+
+      def pms_prospect_request_params(params)
+        {
+          property_id: params[:billing_config]&.property_id,
+          billing_config_id: params[:billing_config]&.id,
+          remote_id: params[:property_id],
+          import_id: params[:import_id],
+          pmc_id: params[:pmc_id],
+          import_resident_id: params[:import_resident_id],
+          prospect_id: params[:prospect]&.yardi_prospect_id
+        }
+      end
+
+      def parse_date(date)
+        (date && Date.strptime(date, '%m/%d/%Y'))&.to_time
+      end
+
+      def import_resident_id(params)
+        "#{params[:import_id]}-#{SecureRandom.alphanumeric(15)}"
+      end
+
+      def remote_id(customer, id_type)
+        desired_id_node = customer['Identification']&.detect do |id_node|
+          id_node['IDType'] == id_type
+        end
+
+        desired_id_node['IDValue']
+      end
+    end
+  end
+end

data/lib/yardi/validator/empty_response.rb

@@ -1,41 +1,58 @@
 require 'yardi/validator'
+require_relative 'base'
 
 module Yardi
   module Validator
     # Ensure that the response contains data. Sometimes Yardi will respond with
     # just the outer shell of XML. For an example, @see empty_response.xml.
     # We will also raise an error if Yardi returns a completely empty response.
-    class EmptyResponse
+    class EmptyResponse < Base
       # @param parsed_response [Hash<String, Object>] the XML response parsed
       #   into a Hash
       # @param action [String] The SOAP action this response is for. Yardi's
       #   responses have nodes whose names include the SOAP action for the
       #   request that was made.
-      def initialize(action:, parsed_response:)
+      def initialize(action:, parsed_response:, params:)
         @action = action
         @response = parsed_response
+        @params = params
       end
 
       # @raise [Yardi::Error::EmptyResponse] if the response is effectively
       #   empty
       def validate!
         return unless error?
-        raise Error::EmptyResponse, 'Yardi response contains no Result node.'
+
+        message = 'Yardi response contains no Result node.'
+
+        case action
+        when 'GetResidents'
+          send_pms_resident_event(lease: nil, resident_type: 'PRIMARY', params: params, error_message: message)
+        when 'GetYardiGuestActivity_Search'
+          send_pms_prospect_event(params: params, error_message: message)
+        end
+        raise Error::EmptyResponse, message
       end
 
       private
 
-      attr_reader :action, :response
+      attr_reader :action, :response, :params
 
       def error?
         return true if response.empty?
 
-        envelope = response['soap:Envelope']
+        envelope = response['soap:Envelope'] || response['Envelope']
         return true if envelope.nil?
 
-        body = envelope['soap:Body']
-        # Fault responses will be handled by the FaultResponse validator
-        return false unless body['soap:Fault'].nil?
+        if envelope['soap:Body']
+          body = envelope['soap:Body']
+          # Fault responses will be handled by the FaultResponse validator
+          return false unless body['soap:Fault'].nil?
+        else
+          body = envelope['Body']
+          # Fault responses will be handled by the FaultResponse validator
+          return false unless body['Fault'].nil?
+        end
         body["#{action}Response"]["#{action}Result"].nil?
       end
     end

data/lib/yardi/validator/error_response.rb

@@ -1,31 +1,47 @@
 require 'yardi/validator'
+require_relative 'base'
 
 module Yardi
   module Validator
     # Ensure that the response has no Messages with messageType=Error.
-    class ErrorResponse
+    class ErrorResponse < Base
       # @param parsed_response [Hash<String, Object>] XML response parsed into a
       #   Hash
-      def initialize(action:, parsed_response:)
+      def initialize(action:, parsed_response:, params:)
         @action = action
         @response = parsed_response
+        @params = params
       end
 
       # @raise [Yardi::Error::ErrorResponse] if the response has an error
       def validate!
         return unless error?
 
-        guest_err_msg = "Error: No guests exist with the given search criteria."
+        case action
+        when 'GetResidents'
+          send_pms_resident_event(lease: nil, resident_type: 'PRIMARY', params: params,
+                                  error_message: error_messages.join('. '))
+        when 'GetYardiGuestActivity_Search'
+          if params[:send_prospect_events] != false
+            send_pms_prospect_event(params: params, error_message: error_messages.join('. '))
+          end
+        end
 
-        if error_messages.include?(guest_err_msg)
-          raise Error::GuestsNotFound
+        canceled_guest_err_msg = "Status is 'Canceled Guest', Prospect must be reactivated (ReActivate event)"
+        error_messages.each do |error_message|
+          raise Error::CanceledGuest, error_messages.join('. ') if error_message.include?(canceled_guest_err_msg)
         end
+
+        guest_err_msg = 'Error: No guests exist with the given search criteria.'
+
+        raise Error::GuestsNotFound, error_messages.join('. ') if error_messages.include?(guest_err_msg)
+
         raise Error::ErrorResponse, error_messages.join('. ')
       end
 
       private
 
-      attr_reader :action, :response
+      attr_reader :action, :response, :params
 
       def error?
         messages.any? do |message_node|
@@ -51,16 +67,23 @@ module Yardi
       # messages so that we don't have to worry about type checks when pulling
       # out the errors.
       def messages
-        body = response['soap:Envelope']['soap:Body']
+        body = if response['soap:Envelope']
+                 response['soap:Envelope']['soap:Body']
+               else
+                 response['Envelope']['Body']
+               end
+
         # This will be picked up by either the EmptyResponse or the
         # FaultResponse check. Whatever it is, it's not an ErrorResponse issue.
         return [] if body["#{action}Response"].nil?
+
         result = body["#{action}Response"]["#{action}Result"]
         # There are no Messages nodes in a successful
         # GetYardiGuestActivity_Search response
         return [] if result['Messages'].nil?
+
         nodes = result['Messages']['Message']
-        nodes = nodes.is_a?(Array) ? nodes : [nodes]
+        nodes = [nodes] unless nodes.is_a?(Array)
         # see method comment for why this normalization is needed
         nodes.map do |node|
           if node.is_a?(Hash)

data/lib/yardi/validator/fault_response.rb

@@ -1,36 +1,58 @@
 require 'yardi/validator'
+require_relative 'base'
 
 module Yardi
   module Validator
     # Ensure that the response has no Fault nodes
-    class FaultResponse
+    class FaultResponse < Base
       # @param parsed_response [Hash<String, Object>] XML response parsed into a
       #   Hash
-      def initialize(action:, parsed_response:)
+      def initialize(action:, parsed_response:, params:)
         @action = action
         @response = parsed_response
+        @params = params
       end
 
       # @raise [Yardi::Error::FaultResponse] if the response has a Fault node
       def validate!
         return unless error?
+
+        case action
+        when 'GetResidents'
+          send_pms_resident_event(lease: nil, resident_type: 'PRIMARY', params: params, error_message: error_message)
+        when 'GetYardiGuestActivity_Search'
+          send_pms_prospect_event(params: params, error_message: error_message)
+        end
         raise Error::FaultResponse, error_message
       end
 
       private
 
-      attr_reader :action, :response
+      attr_reader :action, :response, :params
 
       def body
-        response['soap:Envelope']['soap:Body']
+        if response['soap:Envelope']
+          response['soap:Envelope']['soap:Body']
+        else
+          response['Envelope']['Body']
+        end
       end
 
       def error?
-        !body['soap:Fault'].nil?
+        if response['soap:Envelope']
+          !body['soap:Fault'].nil?
+        else
+          !body['Fault'].nil?
+        end
       end
 
       def error_message
-        fault = body['soap:Fault']
+        fault = if response['soap:Envelope']
+                  body['soap:Fault']
+                else
+                  body['Fault']
+                end
+
         fault_message = "#{fault['faultcode']}: #{fault['faultstring']}."
         details = fault['detail']
         details.nil? ? fault_message : "#{fault_message} Details: #{details}"

data/lib/yardi/validator/missing_property.rb

@@ -1,29 +1,38 @@
 require 'yardi/validator'
+require_relative 'base'
 
 module Yardi
   module Validator
     # Make sure the property we're trying to send a guestcard for is configured
     # in Yardi's system. For an example, @see invalid_property.xml
-    class MissingProperty
+    class MissingProperty < Base
       UNCONFIGURED_PROPERTY_REGEX = /Invalid Yardi Property Code/i
 
       # @param parsed_response [Hash<String, Object>] the XML response parsed
       #   into a Hash
-      def initialize(action:, parsed_response:)
+      def initialize(action:, parsed_response:, params:)
         @action = action
         @response = parsed_response
+        @params = params
       end
 
       # @raise [Yardi::Error::ErrorResponse] if the response is effectively
       #   empty
       def validate!
         return if valid_property?
+
+        case action
+        when 'GetResidents'
+          send_pms_resident_event(lease: nil, resident_type: 'PRIMARY', params: params, error_message: message)
+        when 'GetYardiGuestActivity_Search'
+          send_pms_prospect_event(params: params, error_message: message)
+        end
         raise Error::MissingProperty, message
       end
 
       private
 
-      attr_reader :action, :response
+      attr_reader :action, :response, :params
 
       def valid_property?
         message !~ UNCONFIGURED_PROPERTY_REGEX
@@ -44,14 +53,21 @@ module Yardi
       # we know it isn't an invalid property error so we return an empty string
       # which will fail the comparison to the regex.
       def message
-        body = response['soap:Envelope']['soap:Body']
+        body = if response['soap:Envelope']
+                 response['soap:Envelope']['soap:Body']
+               else
+                 response['Envelope']['Body']
+               end
+
         # This will be picked up by either the EmptyResponse or the
         # FaultResponse check. Whatever it is, it's not a MissingProperty issue.
         return '' if body["#{action}Response"].nil?
+
         result = body["#{action}Response"]["#{action}Result"]
         # There are no Messages nodes in a successful
         # GetYardiGuestActivity_Search response
         return '' if result['Messages'].nil?
+
         messages = result['Messages']['Message']
         messages.is_a?(Hash) ? messages['__content__'] : ''
       end

data/lib/yardi/validator/prospect_eventing.rb

@@ -0,0 +1,42 @@
+require 'yardi/validator'
+require_relative 'base'
+
+module Yardi
+  module Validator
+    class ProspectEventing < Base
+      # Sends parased response's roommate and prospect data to Snowflake via event tracker
+      def initialize(action:, parsed_response:, params:)
+        @action = action
+        @response = parsed_response
+        @params = params
+      end
+
+      def validate!
+        return if response.nil?
+
+        send_prospect_events
+      end
+
+      private
+
+      attr_reader :action, :response, :params
+
+      def send_prospect_events
+        body = if response['soap:Envelope']
+                 response['soap:Envelope']['soap:Body']
+               else
+                 response['Envelope']['Body']
+               end
+
+        result_node = body["#{action}Response"]["#{action}Result"]
+        prospects = result_node['LeadManagement']['Prospects']['Prospect']
+        prospects = [prospects] unless prospects.is_a?(Array)
+        prospects.map do |prospect|
+          events = prospect.dig('Events', 'Event') || []
+          events_array = events.is_a?(Array) ? events : [events]
+          events_array.each { |event| send_pms_prospect_event(params: params, event: event) }
+        end
+      end
+    end
+  end
+end

data/lib/yardi/validator/resident_eventing.rb

@@ -0,0 +1,45 @@
+require 'yardi/validator'
+require_relative 'base'
+
+module Yardi
+  module Validator
+    class ResidentEventing < Base
+      attr_reader :action, :response, :params
+
+      # Send parased response's individual resident data to Snowflake via event tracker
+      def initialize(action:, parsed_response:, params:)
+        @action = action
+        @response = parsed_response
+        @params = params
+      end
+
+      # @raise [Yardi::Error::EmptyResponse] if the response is effectively
+      #   empty
+      def validate!
+        return if response.nil?
+
+        body = if response['soap:Envelope']
+                 response['soap:Envelope']['soap:Body']
+               else
+                 response['Envelope']['Body']
+               end
+        result_node = body["#{action}Response"]["#{action}Result"]
+        path = %w[MITS_ResidentData PropertyResidents Residents Resident]
+        results = [result_node.dig(*path)].flatten.compact
+        results.map { |resident| send_all_events(resident) }
+      end
+
+      def send_all_events(resident)
+        resident['import_resident_id'] = import_resident_id(params)
+        send_pms_resident_event(lease: resident, resident_type: 'PRIMARY', params: params)
+        roommate_nodes = resident.dig('OtherOccupants', 'OtherOccupant')
+        unless roommate_nodes.nil?
+          [roommate_nodes].flatten.map do |roommate|
+            roommate['import_resident_id'] = import_resident_id(params)
+            send_pms_resident_event(lease: roommate, resident_type: 'ROOMMATE', params: params)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yardi/version.rb

@@ -1,5 +1,5 @@
 # frozen-string-literal: true
 
 module Yardi
-  VERSION = '4.0.8'
+  VERSION = '4.11.0'
 end

data/lib/yardi.rb

@@ -1,7 +1,8 @@
-require_relative '../config/multi_xml.rb'
+require_relative '../config/multi_xml'
 
 require 'yardi/error/base'
 require 'yardi/error/connection_error'
+require 'yardi/error/canceled_guest'
 require 'yardi/error/empty_response'
 require 'yardi/error/error_response'
 require 'yardi/error/fault_response'
@@ -16,6 +17,7 @@ require 'yardi/error/unparsable_response'
 require 'yardi/model/event'
 require 'yardi/model/guest_card_response'
 require 'yardi/model/resident'
+require 'yardi/model/property'
 
 require 'yardi/parameter/agent'
 require 'yardi/parameter/contact_info'
@@ -27,6 +29,7 @@ require 'yardi/parameter/user'
 require 'yardi/request/import_yardi_guest'
 require 'yardi/request/get_yardi_guest_activity'
 require 'yardi/request/get_residents'
+require 'yardi/request/get_property_configurations'
 
 require 'yardi/version'
 # The toplevel Yardi module. This includes configuration information that
@@ -37,13 +40,15 @@ module Yardi
     entity
     license_key
     platform
+    app_name
+    gcs_bucket
   ].freeze
 
   Config = Struct.new(*CONFIG_KEYS)
   private_constant :Config
 
   class << self
-    def configure(&block)
+    def configure
       yield config
     end
 

data/yardi.gemspec

@@ -21,11 +21,16 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'multi_xml', '~> 0.5' # Parse XML responses
   spec.add_runtime_dependency 'nokogiri', '~> 1.6' # Build XML for requests
   spec.add_runtime_dependency 'ox', '~> 2.3' # Parser we want with MultiXML
+  spec.add_runtime_dependency 'activesupport', '~> 5.2'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'pry-byebug', '~> 3.4'
   spec.add_development_dependency 'rake', '~> 11.2'
   spec.add_development_dependency 'rspec', '~> 3.4'
-  spec.add_development_dependency 'rubocop', '~> 0.65'
   spec.add_development_dependency 'webmock', '~> 1.21'
+
+  spec.add_development_dependency 'rubocop', '= 1.23.0'
+  spec.add_development_dependency 'rubocop-git', '= 0.1.3'
+  spec.add_development_dependency 'rubocop-rails', '= 2.12.4'
+  spec.add_development_dependency 'rubocop-rspec', '= 2.6.0'
 end