yardi 4.0.8

data/lib/yardi/document_parser/guest_card_import_response_object.rb

@@ -0,0 +1,72 @@
+require_relative 'base'
+
+module Yardi
+  module DocumentParser
+    # Parse the GetFloorPlanList response
+    class GuestCardImportResponseObject < Base
+      SOAP_ACTION = 'ImportYardiGuest_Login'.freeze
+
+      private
+
+      attr_reader :body
+
+      # @param body [Hash<String, Object>] the body of the XML response parsed
+      #   into a Hash
+      # @return [Yardi::Model::GuestcardResponse]
+      # @raise [Yardi::Error::Base] if the response is invalid
+      def parse_body(body)
+        @body = body
+        Model::GuestCardResponse.new(messages: messages, remote_id: remote_id)
+      end
+
+      # If there is only one message, we get a hash, otherwise we get an array
+      # of messages. Wrap everything to be an Array so we can use the same logic
+      # for finding and parsing out error messages.
+      # Successful agent info responses do not include a messages node, but
+      # successful guestcard responses use the messages section to include their
+      # CustomerID and to tell us that the guestcard was imported.
+      def message_nodes
+        Array(result_node['Messages']['Message'])
+      end
+
+      # Convert from this:
+      # [
+      #   {
+      #     "messageType"=>"FYI",
+      #     "__content__"=>"Xml Imported: 6/27/2016 8:12:19 PM"
+      #   },
+      #   {
+      #     "messageType"=>"FYI",
+      #     "__content__"=>"Inserted Prospect CustomerID: p0123456789"
+      #   }
+      # ]
+      # to this:
+      # [
+      #   { 'FYI' => 'Xml Imported: 6/27/2016 8:12:19 PM' },
+      #   { 'FYI' => 'Inserted Prospect CustomerID: p0123456789' }
+      # ]
+      def messages
+        message_array = []
+        message_nodes.each do |node|
+          message_array << { node['messageType'] => node['__content__'] }
+        end
+
+        message_array
+      end
+
+      def remote_id
+        id_message = message_nodes.detect do |node|
+          node['messageType'].downcase == 'fyi' &&
+            node['__content__'] =~ /(Inserted|Updated) Prospect CustomerID:/
+        end
+
+        unless id_message.nil?
+          id_regex =
+            /(Inserted|Updated) Prospect CustomerID: (?<remote_id>p\d+)/
+          id_match = id_message['__content__'].match(id_regex)
+          !id_match.nil? ? id_match[:remote_id] : nil
+        end
+      end
+    end
+  end
+end

data/lib/yardi/document_parser/prospects.rb

@@ -0,0 +1,79 @@
+require_relative 'base'
+require 'yardi/model/prospect'
+require 'yardi/utils/phone_parser'
+
+module Yardi
+  module DocumentParser
+    # Build Prospect objects from prospect search response body.
+    class Prospects < Base
+      SOAP_ACTION = 'GetYardiGuestActivity_Search'.freeze
+
+      private
+
+      attr_reader :body
+
+      # @param body [Hash<String, Object>] the body of the XML response parsed
+      #   into a Hash
+      # @return [Array<Yardi::Model::Prospect>]
+      # @raise [Yardi::Error::Base] if the response is invalid
+      def parse_body(body)
+        @body = body
+        prospects
+      end
+
+      def prospects
+        prospects = result_node['LeadManagement']['Prospects']['Prospect']
+        prospects = [prospects] unless prospects.is_a?(Array)
+
+        prospects.map { |prospect| build_prospect(prospect) }
+      end
+
+      def build_prospect(prospect)
+        customer = [prospect['Customers']['Customer']].flatten.first
+        events = prospect.dig('Events', 'Event') || []
+
+        Model::Prospect.new(
+          first_name: customer['Name']['FirstName'],
+          last_name: customer['Name']['LastName'],
+          email: customer['Email'],
+          phones: Utils::PhoneParser.parse(customer['Phone']),
+          events: build_events(events),
+          prospect_id: remote_id(customer, 'ProspectID'),
+          tenant_id: remote_id(customer, 'TenantID')
+        )
+      end
+
+      def build_events(event_nodes)
+        events_array = event_nodes.is_a?(Array) ? event_nodes : [event_nodes]
+        source = transaction_source(events_array)
+
+        events_array.map do |e|
+          Model::Event.new(
+            remote_id: e.fetch('EventID', {})['IDValue'],
+            type: e['EventType'],
+            timestamp: e['EventDate'],
+            first_contact: e['FirstContact'] == 'true',
+            transaction_source: source
+          )
+        end
+      end
+
+      def transaction_source(event_nodes)
+        transaction_node = event_nodes.detect{ |e| e['TransactionSource'].present? }
+        if transaction_node.nil?
+          'None Given From Yardi'
+        else
+          transaction_node['TransactionSource']
+        end
+      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/document_parser/residents.rb

@@ -0,0 +1,59 @@
+require_relative 'base'
+
+module Yardi
+  module DocumentParser
+    class Residents < Base
+      SOAP_ACTION = 'GetResidents'.freeze
+
+      def initialize(property_id)
+        @property_id = property_id
+      end
+
+      private
+
+      attr_reader :body, :property_id
+
+      # @param body [Hash<String, Object>] the body of the XML response parsed
+      #   into a Hash
+      # @return [Array<Yardi::Model::Resident>]
+      # @raise [Yardi::Error::Base] if the response is invalid
+      def parse_body(body)
+        @body = body
+        residents
+      end
+
+      def residents
+        path = %w[MITS_ResidentData PropertyResidents Residents Resident]
+        results = [result_node.dig(*path)].flatten.compact
+
+        if results.empty?
+          raise Error::NoResults,
+                "Failed to get residents for yardi_property_id: #{property_id}"
+        end
+
+        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)
+        roommate_nodes = resident.dig('OtherOccupants', 'OtherOccupant')
+        roommates = roommate_nodes.nil? ? [] : create_roommates(roommate_nodes)
+        Model::Resident.new(resident, type: 'primary', roommates: roommates)
+      end
+
+      # Creates roommates given `OtherOccupant` data. Note that this can
+      # 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
+    end
+  end
+end

data/lib/yardi/error/base.rb

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

data/lib/yardi/error/connection_error.rb

@@ -0,0 +1,12 @@
+require_relative 'base'
+
+module Yardi
+  module Error
+    ##
+    # An Error that is raised when we have trouble connecting to the API
+    # endpoint.
+    #
+    class ConnectionError < Base
+    end
+  end
+end

data/lib/yardi/error/empty_response.rb

@@ -0,0 +1,11 @@
+require_relative 'base'
+
+module Yardi
+  module Error
+    # Raised when a Yardi response is missing any real data. This can happen
+    # when part of the authentication section of the request is missing or
+    # invalid.
+    class EmptyResponse < Base
+    end
+  end
+end

data/lib/yardi/error/error_response.rb

@@ -0,0 +1,11 @@
+require_relative 'base'
+
+module Yardi
+  module Error
+    # Raised when a Yardi response contains error message, which can mean that
+    # we are missing a required node in the XML we send them. In this case, the
+    # response contains two message nodes, both of which have the same content.
+    class ErrorResponse < Base
+    end
+  end
+end

data/lib/yardi/error/fault_response.rb

@@ -0,0 +1,14 @@
+require_relative 'base'
+
+module Yardi
+  module Error
+    # Raised when a Yardi response contains a Fault node, which seems to happen
+    # sometimes when we leave out a required node. Sometimes there is an XSD
+    # check on their end, in which case a regular ErrorResponse will be raised,
+    # but other times the whole system seems to fall over and we see a response
+    # that looks like the example in the prospect_search/missing_node_error.xml
+    # fixture.
+    class FaultResponse < Base
+    end
+  end
+end

data/lib/yardi/error/guests_not_found.rb

@@ -0,0 +1,10 @@
+require_relative 'error_response'
+
+module Yardi
+  module Error
+    # Raised when a Yardi response contains error message about not finding
+    # any guests.
+    class GuestsNotFound < ErrorResponse
+    end
+  end
+end

data/lib/yardi/error/invalid_configuration.rb

@@ -0,0 +1,11 @@
+require_relative 'base'
+
+module Yardi
+  module Error
+    # Raised when we're missing any of the required configuration information
+    # needed to make a request. @see Yardi::CONFIG_KEYS for the list of required
+    # fields.
+    class InvalidConfiguration < Base
+    end
+  end
+end

data/lib/yardi/error/missing_property.rb

@@ -0,0 +1,10 @@
+require_relative 'base'
+
+module Yardi
+  module Error
+    # Raised when the property we're trying to insert a guest card for is not
+    # in Yardi's system.
+    class MissingProperty < Base
+    end
+  end
+end

data/lib/yardi/error/no_results.rb

@@ -0,0 +1,10 @@
+require_relative 'base'
+
+module Yardi
+  module Error
+    # Raised when we get a successful Yardi response but no results e.g.
+    # GetResidents returns no <Resident> nodes.
+    class NoResults < Base
+    end
+  end
+end

data/lib/yardi/error/resource_not_found.rb

@@ -0,0 +1,9 @@
+require_relative 'error_response'
+
+module Yardi
+  module Error
+    # Raised when Yardi responds with a 404
+    class ResourceNotFound < Base
+    end
+  end
+end

data/lib/yardi/error/service_unavailable.rb

@@ -0,0 +1,11 @@
+require_relative 'base'
+
+module Yardi
+  module Error
+    ##
+    # An Error that is raised when Yardi API is unavailable.
+    #
+    class ServiceUnavailable < Base
+    end
+  end
+end

data/lib/yardi/error/unparsable_response.rb

@@ -0,0 +1,11 @@
+require_relative 'base'
+
+module Yardi
+  module Error
+    ##
+    # An Error that is raised when Yardi response cannot be parsed.
+    #
+    class UnparsableResponse < Base
+    end
+  end
+end

data/lib/yardi/model/event.rb

@@ -0,0 +1,18 @@
+module Yardi
+  module Model
+    class Event
+      attr_reader :remote_id, :type, :timestamp, :first_contact,
+                  :transaction_source
+
+      # timestamp is a string that does not include timezone, so we leave it to
+      # the client to parse correctly.
+      def initialize(remote_id:, type:, timestamp:, first_contact:, transaction_source:)
+        @remote_id = remote_id
+        @type = type
+        @timestamp = timestamp
+        @first_contact = first_contact
+        @transaction_source = transaction_source
+      end
+    end
+  end
+end

data/lib/yardi/model/guest_card_response.rb

@@ -0,0 +1,12 @@
+module Yardi
+  module Model
+    class GuestCardResponse
+      attr_reader :messages, :remote_id
+
+      def initialize(messages:, remote_id:)
+        @messages = messages
+        @remote_id = remote_id
+      end
+    end
+  end
+end

data/lib/yardi/model/prospect.rb

@@ -0,0 +1,49 @@
+module Yardi
+  module Model
+    ##
+    # Basic data about a Prospect returned from the Yardi API
+    #
+    # Search for Prospect records using Yardi::Request::GetYardiGuestActivity
+    #
+    class Prospect
+      # The Prospect's first name according to Yardi's database
+      attr_reader :first_name
+
+      # The Prospect's last name according to Yardi's database
+      attr_reader :last_name
+
+      # The Prospect's email address according to Yardi's database
+      attr_reader :email
+
+      # An Array of the Prospect's phone numbers, or +nil+ if there are none
+      attr_reader :phones
+
+      # An Array of Yardi::Model::Event objects
+      attr_reader :events
+
+      # The Prospect id from Yardi's database e.g. "p00003693"
+      attr_reader :prospect_id
+
+      # The tenant id from Yardi's database e.g. "t000456"
+      attr_reader :tenant_id
+
+      def initialize(
+        first_name:,
+        last_name:,
+        email:,
+        phones:,
+        events:,
+        prospect_id:,
+        tenant_id:
+      )
+        @first_name = first_name
+        @last_name = last_name
+        @email = email
+        @phones = phones
+        @events = events
+        @prospect_id = prospect_id
+        @tenant_id = tenant_id
+      end
+    end
+  end
+end

data/lib/yardi/model/resident.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'yardi/utils/phone_parser'
+
+module Yardi
+  module Model
+    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
+
+      def initialize(resident, type:, roommates: nil)
+        @status = resident['Status']
+        @lease_id = resident['tCode']
+        @lease_lead_id = resident['pCode']
+        @first_name = resident['FirstName']
+        @last_name = resident['LastName']
+        @email = resident['Email']
+        @unit_name = resident['UnitCode']
+        @phones = Utils::PhoneParser.parse(resident['Phone'])
+        @move_in_date = parse_date(resident['MoveInDate'])
+        @lease_from_date = parse_date(resident['LeaseFromDate'])
+        @lease_to_date = parse_date(resident['LeaseToDate'])
+        @type = type
+        @roommates = roommates || []
+      end
+
+      private
+
+      # Residents may not have LeaseFromDate or LeaseToDate.
+      def parse_date(date)
+        date && Date.strptime(date, '%m/%d/%Y')
+      end
+    end
+  end
+end