amsi 1.0.0

data/lib/amsi/model/guest_card.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module Amsi
+  module Model
+    class GuestCard < Base
+      string_attrs :email,
+                   :first_name,
+                   :guest_card_id,
+                   :initial_source_id,
+                   :last_name,
+                   :property_id
+
+      date_time_attrs :create_date
+
+      alias :id :guest_card_id
+    end
+  end
+end

data/lib/amsi/model/guest_card_result.rb

@@ -0,0 +1,26 @@
+require_relative 'base'
+
+module Amsi
+  module Model
+    class GuestCardResult < Base
+      module Status
+        FAILURE = 'FAILURE'.freeze
+        SUCCESS = 'SUCCESS'.freeze
+      end
+
+      string_attrs *%i[
+        guest_card_id
+        property_id
+        status
+      ]
+
+      integer_attrs :contact_seq_no
+
+      alias_method :contact_sequence_number, :contact_seq_no
+
+      def success?
+        status == Status::SUCCESS
+      end
+    end
+  end
+end

data/lib/amsi/model/lease.rb

@@ -0,0 +1,63 @@
+require_relative 'base'
+
+module Amsi
+  module Model
+    class Lease < Base
+      module Status
+        CURRENT = 'C'.freeze
+        APPLICANT = 'A'.freeze
+        INTENT_TO_TRANSFER = 'I'.freeze
+        LEASED = 'L'.freeze
+        NOTICE = 'N'.freeze
+        PREVIOUS = 'P'.freeze
+        TRANSFER = 'T'.freeze
+        APPROVED = 'V'.freeze
+        CANCELLED = 'X'.freeze
+      end
+
+      date_attrs *%i[
+        application_date
+        lease_begin_date
+        lease_end_date
+        lease_sign_date
+        move_in_date
+       ]
+
+      string_attrs *%i[
+        bldg_id
+        external_reference_id
+        occu_status_code
+        occu_status_code_description
+        property_id
+        resi_id
+        unit_id
+        lease_marketing_source
+        guest_card_no
+      ]
+
+      decimal_attrs :rent_amount
+
+      date_time_attrs :guest_first_contact_date
+
+      alias_method :begin_date, :lease_begin_date
+      alias_method :end_date, :lease_end_date
+      alias_method :sign_date, :lease_sign_date
+      alias_method :lead_id, :guest_card_no
+      alias_method :lead_date, :guest_first_contact_date
+      alias_method :lead_source_code, :lease_marketing_source
+      alias_method :building_id, :bldg_id
+      alias_method :resident_id, :resi_id
+      alias_method :occupant_status_code, :occu_status_code
+      alias_method :occupant_status_code_description,
+                   :occu_status_code_description
+
+      attr_accessor :occupants
+      attr_accessor :guest_card
+      attr_writer :matched_guest_cards
+
+      def matched_guest_cards
+        @matched_guest_cards ||= []
+      end
+    end
+  end
+end

data/lib/amsi/model/leasing_agent.rb

@@ -0,0 +1,21 @@
+require_relative 'base'
+
+module Amsi
+  module Model
+    class LeasingAgent < Base
+      string_attrs *%i[
+        agent_active_flag
+        agent_code
+        agent_name
+        property_id
+      ]
+
+      alias_method :code, :agent_code
+      alias_method :name, :agent_name
+
+      def active?
+        agent_active_flag == 'Y'
+      end
+    end
+  end
+end

data/lib/amsi/model/manager.rb

@@ -0,0 +1,16 @@
+require_relative 'base'
+
+module Amsi
+  module Model
+    class Manager < Base
+      string_attrs *%i[
+        fax
+        first_name
+        last_name
+        middle_name
+        phone
+        salutation
+      ]
+    end
+  end
+end

data/lib/amsi/model/marketing_source.rb

@@ -0,0 +1,21 @@
+require_relative 'base'
+
+module Amsi
+  module Model
+    class MarketingSource < Base
+      string_attrs *%i[
+        property_id
+        source_code
+        source_desc
+        source_active_flag
+      ]
+
+      alias_method :code, :source_code
+      alias_method :description, :source_desc
+
+      def active?
+        source_active_flag == 'Y'
+      end
+    end
+  end
+end

data/lib/amsi/model/occupant.rb

@@ -0,0 +1,32 @@
+require_relative 'base'
+
+module Amsi
+  module Model
+    class Occupant < Base
+      string_attrs *%i[
+        bldg_id
+        email
+        external_reference_id
+        occu_first_name
+        occu_last_name
+        occu_seq_no
+        phone_1_no
+        phone_2_no
+        property_id
+        resi_id
+        responsible_flag
+        unit_id
+      ]
+
+      decimal_attrs :rent_amount
+
+      alias_method :building_id, :bldg_id
+      alias_method :resident_id, :resi_id
+      alias_method :sequence_number, :occu_seq_no
+      alias_method :first_name, :occu_first_name
+      alias_method :last_name, :occu_last_name
+      alias_method :phone_1, :phone_1_no
+      alias_method :phone_2, :phone_2_no
+    end
+  end
+end

data/lib/amsi/model/property.rb

@@ -0,0 +1,35 @@
+require_relative 'base'
+
+module Amsi
+  module Model
+    class Property < Base
+      date_attrs :live_date
+
+      string_attrs *%i[
+        property_id
+        property_name_1
+        property_name_2
+        property_addr_email
+        live_flag
+      ]
+
+      attr_accessor *%i[
+        address
+        leasing_agents
+        manager
+        marketing_sources
+        remit_to_address
+        unit_types
+      ]
+
+      alias_method :email, :property_addr_email
+      alias_method :id, :property_id
+      alias_method :name, :property_name_1
+      alias_method :name_2, :property_name_2
+
+      def live?
+        live_flag == 'Y'
+      end
+    end
+  end
+end

data/lib/amsi/model/unit_type.rb

@@ -0,0 +1,38 @@
+require_relative 'base'
+
+module Amsi
+  module Model
+    class UnitType < Base
+      decimal_attrs *%i[
+        baths
+        market_rent
+        sec_min
+        standard_renew
+        mtm_renew
+        other_renew
+      ]
+
+      integer_attrs *%i[
+        bedrooms
+        rooms
+        sqftg
+        unit_type_count
+      ]
+
+      string_attrs *%i[
+        property_id
+        unit_subtype
+        unit_type
+        unit_type_desc
+      ]
+
+      alias_method :count, :unit_type_count
+      alias_method :description, :unit_type_desc
+      alias_method :minimum_security_deposit, :sec_min
+      alias_method :month_to_month_renew, :mtm_renew
+      alias_method :sqft, :sqftg
+      alias_method :subtype, :unit_subtype
+      alias_method :type, :unit_type
+    end
+  end
+end

data/lib/amsi/parameter/contact_type.rb

@@ -0,0 +1,10 @@
+module Amsi
+  module Parameter
+    class ContactType
+      INTERNET = 'I'.freeze
+      PHONE = 'P'.freeze
+      RETURN_VISIT = 'R'.freeze
+      VISIT = 'V'.freeze
+    end
+  end
+end

data/lib/amsi/parameter/prospect.rb

@@ -0,0 +1,19 @@
+module Amsi
+  module Parameter
+    class Prospect
+      attr_reader :daytime_phone, :email, :first_name, :last_name
+
+      def initialize(
+        daytime_phone: nil,
+        email: nil,
+        first_name: nil,
+        last_name:
+      )
+        @daytime_phone = daytime_phone
+        @email = email
+        @first_name = first_name
+        @last_name = last_name
+      end
+    end
+  end
+end

data/lib/amsi/request/add_guest_card.rb

@@ -0,0 +1,93 @@
+require_relative 'base'
+
+require 'amsi/document_parser/guest_card_result'
+require 'amsi/request_section/add_guest_card'
+
+module Amsi
+  module Request
+    # Retrieve resident leases for a given property. Returns current leases only
+    #   by default.
+    #
+    # Required initialization parameters:
+    # @property_id [String] AMSI property id
+    # @contact_type [String] values in Amsi::Paramter::ContactType
+    # @prospect [Amsi::Parameter::Prospect] the prospect to create the guest
+    #   card for
+    # @see request/base.rb for additional params required by every request.
+    class AddGuestCard < Base
+      def after_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:,
+        qualified: nil,
+        requirements: 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
+        @qualified = qualified
+        @requirements = requirements
+        @unit_subtype = unit_subtype
+        @unit_type = unit_type
+      end
+
+      private
+
+      def sections
+        [
+          RequestSection::AddGuestCard.new(
+            appointment_date: appointment_date,
+            comments: comments,
+            contact_type: contact_type,
+            contact_datetime: contact_datetime,
+            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,
+            qualified: qualified,
+            requirements: requirements,
+            unit_subtype: unit_subtype,
+            unit_type: unit_type
+          )
+        ]
+      end
+
+      def parser
+        DocumentParser::GuestCardResult.new
+      end
+
+      attr_reader :appointment_date,
+                  :comments,
+                  :contact_datetime,
+                  :contact_type,
+                  :date_needed,
+                  :initial_source_id,
+                  :lease_term_desired,
+                  :leasing_agent_id,
+                  :property_id,
+                  :prospect,
+                  :qualified,
+                  :requirements,
+                  :unit_subtype,
+                  :unit_type
+    end
+  end
+end

data/lib/amsi/request/base.rb

@@ -0,0 +1,106 @@
+require 'amsi/request_section/auth'
+require 'amsi/utils/request_fetcher'
+require 'amsi/utils/request_generator'
+
+module Amsi
+  module Request
+    # Base class for actions that fetch and parse specific AMSI 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 '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.
+    #
+    # 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
+      # Required initialization parameters:
+      #   @param user_id [String] AMSI account username
+      #   @param password [String] AMSI account password
+      #   @param portfolio_name [String] unique identifier for property in AMSI
+      #   @param web_service_url [String] AMSI Url to the leasing.asmx resource
+      def initialize(
+        user_id:,
+        password:,
+        portfolio_name:,
+        web_service_url:,
+        conn: Faraday.new,
+        **other_args
+      )
+
+        @user_id = user_id
+        @password = password
+        @portfolio_name = portfolio_name
+        @web_service_url = web_service_url
+        @conn = conn
+
+        after_initialize(other_args)
+      end
+
+      # @return [Amsi::Model|Array<Amsi::Model>] the parsed response
+      #   from AMSI
+      # @raise [Amsi::Error] an error when validating the response
+      def perform
+        parser.parse(xml)
+      end
+
+      private
+
+      attr_reader :user_id, :password, :portfolio_name, :web_service_url, :conn
+
+      # @return [String] the XMl response from Amsi
+      def xml
+        generator =
+          Utils::RequestGenerator.new(
+            sections: [auth_section, *sections],
+            soap_action: soap_action,
+            url: web_service_url
+          )
+
+        Utils::RequestFetcher.new(generator: generator, conn: conn).fetch
+      end
+
+      # 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
+
+      def parser
+        # No-op, this method is a call back for subclasses
+      end
+
+      # A hook to add additonal 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
+        []
+      end
+
+      # The CamelCased name of the SOAP action
+      def soap_action
+        self.class.name.split('::').last
+      end
+
+      def auth_section
+        RequestSection::Auth.new(
+          user_id: user_id, password: password,
+          portfolio_name: portfolio_name
+        )
+      end
+    end
+
+    private_constant :Base
+  end
+end

data/lib/amsi/request/get_moveins_by_first_marketing_source.rb

@@ -0,0 +1,57 @@
+require_relative 'base'
+
+require 'amsi/request_section/moveins_filter'
+require 'amsi/document_parser/get_moveins'
+
+module Amsi
+  module Request
+    # Retrieve move ins for a property between a specified data range
+    # and for a specified marketing source code.
+    #
+    # Required initializer parameters:
+    #   @param property_id [String] Max of 50 characters according to their
+    #     docs, this is AMSI's ID of the property we want to fetch move ins for.
+    #   @param marketing_source_code [String] Max of 3 characters according to
+    #     their docs, this is the code that corresponds to the marketing source
+    #     for which we want to fetch move ins. The list of marketing sources
+    #     that a given property supports can be found with a GetPropertyList
+    #     request.
+    #   @param from_date, through_date [Date] Together, these two params define
+    #     the interval from which to fetch move ins.
+    class GetMoveinsByFirstMarketingSource < Base
+      def after_initialize(
+        from_date:,
+        marketing_source_code:,
+        property_id:,
+        through_date:
+      )
+        @from_date = from_date
+        @marketing_source_code = marketing_source_code
+        @property_id = property_id
+        @through_date = through_date
+      end
+
+      private
+
+      def parser
+        DocumentParser::GetMoveins.new
+      end
+
+      def sections
+        [
+          RequestSection::MoveinsFilter.new(
+            property_id: property_id,
+            marketing_source_code: marketing_source_code,
+            from_date: from_date,
+            through_date: through_date
+          )
+        ]
+      end
+
+      attr_reader :from_date,
+                  :marketing_source_code,
+                  :property_id,
+                  :through_date
+    end
+  end
+end

data/lib/amsi/request/get_property_list.rb

@@ -0,0 +1,49 @@
+require_relative 'base'
+
+require 'amsi/request_section/property_list_filter'
+require 'amsi/document_parser/properties'
+
+module Amsi
+  module Request
+    # Retrieve resident leases for a given property. Returns current leases only
+    #   by default.
+    #
+    # No custom required initialization parameters; @see request/base.rb for
+    # params required by every request.
+    class GetPropertyList < Base
+      def after_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
+
+      private
+
+      def parser
+        DocumentParser::Properties.new
+      end
+
+      def sections
+        [
+          RequestSection::PropertyListFilter.new(
+            include_leasing_agents: include_leasing_agents,
+            include_marketing_sources: include_marketing_sources,
+            include_unit_types: include_unit_types,
+            property_id: property_id
+          )
+        ]
+      end
+
+      attr_reader :include_leasing_agents,
+                  :include_marketing_sources,
+                  :include_unit_types,
+                  :property_id
+    end
+  end
+end

data/lib/amsi/request/get_property_residents.rb

@@ -0,0 +1,45 @@
+require_relative 'base'
+
+require 'amsi/request_section/property_resident_filter'
+require 'amsi/document_parser/leases'
+
+module Amsi
+  module Request
+    # Retrieve resident leases for a given property. Returns current leases only
+    # by default.
+    #
+    # Custom required initialization parameters:
+    # @property_id [String] AMSI property id
+    # @lease_status [String] Lease status filter.
+    # @include_marketing_source [Boolean] flag to include marketing sources
+    # @params [Hash] extra configuration fields
+    #   Valid values in: Amsi::Model::Lease::Status
+    # @see request/base.rb for additional params required by every request.
+    class GetPropertyResidents < Base
+      def after_initialize(property_id:, lease_status:, include_marketing_source: false, params:)
+        @property_id = property_id
+        @lease_status = lease_status
+        @include_marketing_source = include_marketing_source
+        @params = params
+      end
+
+      private
+
+      def parser
+        DocumentParser::Leases.new(@params)
+      end
+
+      def sections
+        [
+          RequestSection::PropertyResidentFilter.new(
+            property_id: property_id,
+            lease_status: lease_status,
+            include_marketing_source: include_marketing_source
+          )
+        ]
+      end
+
+      attr_reader :property_id, :lease_status, :include_marketing_source, :params
+    end
+  end
+end