amsi 1.0.0

data/lib/amsi/request_section/add_guest_card.rb

@@ -0,0 +1,105 @@
+module Amsi
+  module RequestSection
+    # Generate the AddGuestCard elements of an Amsi request
+    class AddGuestCard
+      # Formats dates and times like "mm/dd/yyyy", "02/14/2015"
+      DATE_FORMAT = '%m/%d/%Y'
+      private_constant :DATE_FORMAT
+
+      def initialize(
+        appointment_date: nil,
+        comments: nil,
+        contact_datetime: nil,
+        contact_type:,
+        date_needed: nil,
+        initial_source_id: nil,
+        lease_term_desired: nil,
+        leasing_agent_id: nil,
+        property_id:,
+        prospect:,
+        requirements: nil,
+        qualified: nil,
+        unit_subtype: nil,
+        unit_type: nil
+      )
+        @appointment_date = appointment_date
+        @comments = comments
+        @contact_datetime = contact_datetime
+        @contact_type = contact_type
+        @date_needed = date_needed
+        @initial_source_id = initial_source_id
+        @lease_term_desired = lease_term_desired
+        @leasing_agent_id = leasing_agent_id
+        @property_id = property_id
+        @prospect = prospect
+        @requirements = requirements
+        @qualified = qualified
+        @unit_subtype = unit_subtype
+        @unit_type = unit_type
+      end
+
+      def generate(xml_builder)
+        xml_builder.XMLData do |xml_data|
+          xml_data.cdata edex.to_s
+        end
+      end
+
+      private
+
+      attr_reader :appointment_date,
+                  :comments,
+                  :contact_datetime,
+                  :contact_type,
+                  :date_needed,
+                  :initial_source_id,
+                  :lease_term_desired,
+                  :leasing_agent_id,
+                  :property_id,
+                  :prospect,
+                  :requirements,
+                  :qualified,
+                  :unit_subtype,
+                  :unit_type
+
+      def edex
+        Nokogiri::XML::Builder.new do |xml_builder|
+          xml_builder.EDEX do |edex|
+            edex.propertyid(property_id)
+            edex.contacttype(contact_type)
+            edex.contactdatetime(contact_time) if contact_datetime
+            edex.modifieddate(format_date(Date.today))
+            edex.initialsourceid(initial_source_id) if initial_source_id
+            edex.qualified(qualified ? 'Y' : 'N') unless qualified.nil?
+            edex.leasetermdesired(lease_term_desired) if lease_term_desired
+            edex.firstname(prospect.first_name) if prospect.first_name
+            edex.lastname(prospect.last_name)
+            edex.dateneeded(format_date(date_needed)) if date_needed
+            edex.daytimephone(prospect.daytime_phone) if prospect.daytime_phone
+            edex.email(prospect.email) if prospect.email
+            edex.appointmentdate(appointment) if appointment_date
+            edex.unittype(unit_type) if unit_type
+            edex.unitsubtype(unit_subtype) if unit_subtype
+            edex.leasingagentid(leasing_agent_id) if leasing_agent_id
+            edex.requirements(requirements) if requirements
+            edex.comments do |comments_xml|
+              comments_xml.comment_(comments, date: format_date(Date.today))
+            end if comments
+          end
+        end.doc.root
+      end
+
+      def contact_time
+        contact_datetime.strftime('%m/%d/%Y %0l:%M %p')
+      end
+
+      def appointment
+        format_date(appointment_date)
+      end
+
+      def format_date(date)
+        # Formats dates and times like "mm/dd/yyyy", "02/14/2015"
+        date.strftime(DATE_FORMAT)
+      end
+    end
+  end
+end

data/lib/amsi/request_section/auth.rb

@@ -0,0 +1,22 @@
+module Amsi
+  module RequestSection
+    # Generate the auth elements of an AMSI request
+    class Auth
+      def initialize(user_id:, password:, portfolio_name:)
+        @user_id = user_id
+        @password = password
+        @portfolio_name = portfolio_name
+      end
+
+      def generate(xml_builder)
+        xml_builder.UserID user_id
+        xml_builder.Password password
+        xml_builder.PortfolioName portfolio_name
+      end
+
+      private
+
+      attr_reader :user_id, :password, :portfolio_name
+    end
+  end
+end

data/lib/amsi/request_section/moveins_filter.rb

@@ -0,0 +1,42 @@
+module Amsi
+  module RequestSection
+    # Generate the move in filter elements of an Amsi request
+    class MoveinsFilter
+      def initialize(
+        property_id:,
+        marketing_source_code:,
+        from_date:,
+        through_date:
+      )
+        @property_id = property_id
+        @marketing_source_code = marketing_source_code
+        @from_date = from_date
+        @through_date = through_date
+      end
+
+      def generate(xml_builder)
+        xml_builder.XMLData do |xml_data|
+          xml_data.cdata edex.to_s
+        end
+      end
+
+      private
+
+      def edex
+        Nokogiri::XML::Builder.new do |xml_builder|
+          xml_builder.EDEX do |edex|
+            edex.propertyid(property_id)
+            edex.marketingsourcecode(marketing_source_code)
+            edex.fromdate(from_date.to_s)
+            edex.thrudate(through_date.to_s)
+          end
+        end.doc.root
+      end
+
+      attr_reader :from_date,
+                  :marketing_source_code,
+                  :property_id,
+                  :through_date
+    end
+  end
+end

data/lib/amsi/request_section/property_list_filter.rb

@@ -0,0 +1,45 @@
+module Amsi
+  module RequestSection
+    # Generate the property list filter elements of an AMSI request
+    class PropertyListFilter
+      def initialize(
+          include_leasing_agents: false,
+          include_marketing_sources: false,
+          include_unit_types: false,
+          property_id: nil
+        )
+        @include_leasing_agents = include_leasing_agents
+        @include_marketing_sources = include_marketing_sources
+        @include_unit_types = include_unit_types
+        @property_id = property_id
+      end
+
+      def generate(xml_builder)
+        xml_builder.XMLData do |xml_data|
+          xml_data.cdata edex.to_s
+        end
+      end
+
+      private
+
+      def edex
+        Nokogiri::XML::Builder.new do |xml_builder|
+          xml_builder.EDEX do |edex|
+            edex.propertyid(property_id)
+            edex.includeamenities('0')
+            edex.includeclasses('0')
+            edex.includeincomecodes('0')
+            edex.includeleasingagents(include_leasing_agents ? '1' : '0')
+            edex.includemarketingsources(include_marketing_sources ? '1' : '0')
+            edex.includeunittypes(include_unit_types ? '1' : '0')
+          end
+        end.doc.root
+      end
+
+      attr_reader :include_leasing_agents,
+                  :include_marketing_sources,
+                  :include_unit_types,
+                  :property_id
+    end
+  end
+end

data/lib/amsi/request_section/property_resident_filter.rb

@@ -0,0 +1,32 @@
+module Amsi
+  module RequestSection
+    # Generate the property resident filter elements of an AMSI request
+    class PropertyResidentFilter
+      def initialize(property_id:, lease_status:, include_marketing_source: false)
+        @property_id = property_id
+        @lease_status = lease_status
+        @include_marketing_source = include_marketing_source
+      end
+
+      def generate(xml_builder)
+        xml_builder.XMLData do |xml_data|
+          xml_data.cdata edex.to_s
+        end
+      end
+
+      private
+
+      def edex
+        Nokogiri::XML::Builder.new do |xml_builder|
+          xml_builder.EDEX do |edex|
+            edex.propertyid property_id
+            edex.leasestatus lease_status
+            edex.includemarketingsource include_marketing_source ? '1' : '0'
+          end
+        end.doc.root
+      end
+
+      attr_reader :property_id, :lease_status, :include_marketing_source
+    end
+  end
+end

data/lib/amsi/utils/request_fetcher.rb

@@ -0,0 +1,37 @@
+require 'faraday'
+
+module Amsi
+  module Utils
+    # Send a SOAP request to AMSI
+    class RequestFetcher
+      module Status
+        TIMEOUT = 504
+      end
+
+      # @param generator [RequestGenerator] an instance of a RequestGenerator
+      def initialize(generator:, conn: Faraday.new)
+        @generator = generator
+        @conn = conn
+      end
+
+      # @return [String] the XML response from AMSI
+      def fetch
+        response = conn.post(generator.url) do |request|
+          request.body = generator.body
+          request.headers = generator.headers
+        end
+
+        if response.status == Status::TIMEOUT
+          raise Error::RequestTimeout,
+                'The server did not respond in a reasonable timeframe'
+        end
+
+        response.body
+      end
+
+      private
+
+      attr_reader :generator, :conn
+    end
+  end
+end

data/lib/amsi/utils/request_generator.rb

@@ -0,0 +1,54 @@
+require 'nokogiri'
+
+module Amsi
+  module Utils
+    # Generate a SOAP request for a specific action and sections
+    class RequestGenerator
+      ENVELOPE_ATTRIBUTES = {
+        'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/'
+      }.freeze
+
+      ACTION_ATTRIBUTES = {
+        'xmlns' => 'http://tempuri.org/'
+      }.freeze
+
+      # @param url: [String] the URL to POST to
+      # @param soap_action: [String] the PascalCase action to request from AMSI.
+      # @param sections: [Array<RequestSection>] the setion generators that will
+      #   be used to generate the body of the XML request
+      def initialize(url:, soap_action:, sections:)
+        @url = url
+        @soap_action = soap_action
+        @sections = sections
+      end
+
+      def headers
+        {
+          'Content-Type' => 'text/xml; charset=utf-8',
+          'SOAPAction' => "http://tempuri.org/#{soap_action}"
+        }
+      end
+
+      # @return [String] the XML request for the specified action and sections
+      def body
+        Nokogiri::XML::Builder.new do |xml_builder|
+          xml_builder['soap'].Envelope(ENVELOPE_ATTRIBUTES) do
+            xml_builder['soap'].Body do
+              xml_builder.send(soap_action, ACTION_ATTRIBUTES) do
+                sections.each do |section|
+                  section.generate(xml_builder)
+                end
+              end
+            end
+          end
+        end.to_xml
+      end
+
+      attr_reader :url
+
+      private
+
+      attr_reader :soap_action, :sections
+    end
+  end
+end

data/lib/amsi/utils/snowflake_event_tracker.rb

@@ -0,0 +1,113 @@
+require 'event_tracker'
+
+module Amsi
+  module Utils
+    class SnowflakeEventTracker
+      IMPORT_PMS_RESIDENT_EVENT = 'import_pms_resident'
+      IMPORT_PMS_PROSPECT_EVENT = 'import_pms_prospect'
+
+      def self.track_pms_resident_event(
+          remote_lease_id: nil,
+          import_resident_id:,
+          resident_type:,
+          request_params:,
+          move_in_date: nil,
+          lease_to: nil,
+          lease_from: nil,
+          first_name_present: false,
+          last_name_present: false,
+          email_present: false,
+          phones_count: 0,
+          unit_name:,
+          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: 'amsi',
+                import_id: request_params[:import_id],
+                pmc_id: request_params[:pmc_id],
+                service: 'amsi'
+              ),
+              remote_lease_id: remote_lease_id,
+              import_resident_id: import_resident_id,
+              resident_type: resident_type,
+              api_name: 'GetPropertyResidents',
+              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: 'amsi_api',
+              error: error
+            )
+          )
+        end
+      end
+
+      def self.track_pms_prospect_event(
+          remote_lease_id: nil,
+          request_params:,
+          first_name_present:,
+          last_name_present:,
+          email_present:,
+          phone_present:,
+          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: 'amsi',
+                import_id: request_params[:import_id],
+                pmc_id: request_params[:pmc_id],
+                service: 'amsi'
+              ),
+              remote_lease_id: remote_lease_id,
+              import_resident_id: request_params[:import_resident_id] || '',
+              resident_type: 'PRIMARY',
+              api_name: 'GetPropertyResidents',
+              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: 'amsi_api',
+              error: error
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/amsi/validator/base.rb

@@ -0,0 +1,95 @@
+require 'amsi/validator'
+require 'amsi/utils/snowflake_event_tracker'
+require 'securerandom'
+
+module Amsi
+  module Validator
+    class Base
+      def send_pms_resident_event(lease:, params:, error_message: nil)
+        remote_lease_id, lease_to, lease_from = [ nil ] * 3
+        if lease
+          unit_name = lease.unit_id
+          move_in_date = lease.move_in_date
+        else
+          unit_name = ''
+          move_in_date = nil
+        end
+        lease.occupants.each_with_index do |occupant, index|
+          Utils::SnowflakeEventTracker.track_pms_resident_event(
+            remote_lease_id: remote_lease_id,
+            import_resident_id: import_resident_id(params),
+            resident_type: index == 0 ? 'PRIMARY': 'ROOMMATE',
+            request_params: pms_resident_request_params(params),
+            move_in_date: move_in_date&.to_time,
+            lease_to: lease_to,
+            lease_from: lease_from,
+            first_name_present: is_present?(occupant.first_name),
+            last_name_present: is_present?(occupant.last_name),
+            email_present: is_present?(occupant.email),
+            phones_count: [occupant.phone_1, occupant.phone_2].compact.count,
+            unit_name: unit_name,
+            resident_id: occupant.resident_id,
+            error: error_message
+          )
+        end
+      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[:remote_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(lease:, params:, error_message: nil)
+        lease.occupants.each do |occupant|
+          Utils::SnowflakeEventTracker.track_pms_prospect_event(
+            remote_lease_id: nil,
+            request_params: pms_prospect_request_params(params),
+            first_name_present: is_present?(occupant.first_name),
+            last_name_present: is_present?(occupant.last_name),
+            email_present: is_present?(occupant.email),
+            phone_present: is_present?(occupant.phone_1) || is_present?(occupant.phone_2),
+            contact_date: nil,
+            contact_source: lease.lead_source_code,
+            remote_prospect_id: nil,
+            error: error_message
+          )
+        end
+      end
+
+      def pms_prospect_request_params(params)
+        {
+          billing_config_id: params[:billing_config]&.id,
+          property_id: params[:billing_config]&.property_id,
+          remote_id: params[:remote_id],
+          import_id: params[:import_id],
+          pmc_id: params[:pmc_id],
+          import_resident_id: import_resident_id(params),
+          prospect_id: nil
+        }
+      end
+
+      def import_resident_id(params)
+        "#{params[:import_id] || ''}-#{SecureRandom.alphanumeric(15)}"
+      end
+
+      def is_present?(value)
+        if value.is_a?(String)
+          !value.strip.empty?
+        elsif value.is_a?(Hash) || value.is_a?(Array)
+          !(value.empty? || value.nil?)
+        else
+          !value.nil?
+        end
+      end
+    end
+  end
+end

data/lib/amsi/validator/prospect_event_validator.rb

@@ -0,0 +1,20 @@
+require 'amsi/validator'
+require_relative 'base'
+
+module Amsi
+  module Validator
+    class ProspectEventValidator < Base
+
+      def initialize(response = nil)
+      end
+
+      def validate!
+      end
+
+      # Send parased response's individual prospect data to Snowflake via event tracker
+      def send_event(lease, params)
+        send_pms_prospect_event(lease: lease, params: params || {})
+      end
+    end
+  end
+end

data/lib/amsi/validator/request_errors.rb

@@ -0,0 +1,61 @@
+require 'amsi/error/bad_request'
+
+module Amsi
+  module Validator
+    # Ensure there are no errors in the wrapped contents of the body.
+    #
+    # This validator works on responses that have the following format:
+    #
+    # <?xml version="1.0" encoding="utf-8"?>
+    # <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+    #     <soap:Body>
+    #         <GetPropertyResidentsResponse xmlns="http://tempuri.org/">
+    #             <GetPropertyResidentsResult>&lt;InternetTrafficResponse&gt;&lt;webservice&gt;Leasing&lt;/webservice&gt;&lt;webmethod&gt;GetPropertyResidents&lt;/webmethod&gt;&lt;Error&gt;&lt;ErrorCode&gt;1&lt;/ErrorCode&gt;&lt;ErrorDescription&gt;Validation of user credentials failed.&lt;/ErrorDescription&gt;&lt;/Error&gt;&lt;/InternetTrafficResponse&gt;</GetPropertyResidentsResult>
+    #         </GetPropertyResidentsResponse>
+    #     </soap:Body>
+    # </soap:Envelope>
+
+    class RequestErrors
+      # @param response [Hash<String, Object>] the XML response parsed into a
+      #   Hash
+      def initialize(response)
+        @response = response
+      end
+
+      # @raise [Amsi::Error::BadRequest] if the response has an error
+      #   node in the contents
+      def validate!
+        return unless error?
+        raise Amsi::Error::BadRequest.new([error])
+      end
+
+      private
+
+      attr_reader :response
+
+      def error_contents
+        body = response['soap:Envelope']['soap:Body']
+        response_key = body.keys.detect { |key| key !~ /^xmlns/ }
+        contents_response = body[response_key]
+        result_key = contents_response.keys.grep(/Result$/).first
+        escaped_result = contents_response[result_key]
+        parsed_result = MultiXml.parse(escaped_result)
+
+        parsed_result['InternetTrafficResponse']
+      end
+
+      def error?
+        error_contents
+      end
+
+      def error
+        error = error_contents['Error']
+
+        Struct.new(:message, :error_code).new(
+          error['ErrorDescription'],
+          error['ErrorCode']
+        )
+      end
+    end
+  end
+end

data/lib/amsi/validator/request_fault.rb

@@ -0,0 +1,57 @@
+module Amsi
+  module Validator
+    # Ensure there is no 'Fault' node in the response body
+    class RequestFault
+      FaultDetails = Struct.new(:custom_message, :exception_message, :log_id)
+      private_constant :FaultDetails
+
+      # @param response [Hash<String, Object>] the XML response parsed into a
+      #   Hash
+      def initialize(response)
+        @response = response
+      end
+
+      # @raise [Amsi::Error::RequestFault] if the response has a fault
+      def validate!
+        return unless error?
+        raise Error::RequestFault.new(error_message, fault_code, details)
+      end
+
+      private
+
+      attr_reader :response
+
+      def fault
+        response['soap:Envelope']['soap:Body']['soap:Fault']
+      end
+
+      def details
+        return unless fault['detail']
+        app_fault = fault['detail'].values.first
+        FaultDetails.new(
+          app_fault['CustomMessage'],
+          app_fault['ExceptionMessage'],
+          app_fault['LogId']
+        )
+      end
+
+      def error?
+        !fault.nil?
+      end
+
+      def fault_code
+        return unless fault
+        code = fault['faultcode']
+        code = code['__content__'] if code.is_a?(Hash)
+        code.strip
+      end
+
+      def error_message
+        return unless fault
+        fault_string = fault['faultstring']
+        fault_string = fault_string['__content__'] if fault_string.is_a?(Hash)
+        fault_string.strip
+      end
+    end
+  end
+end