entrata 1.1.0

data/lib/entrata/request/error.rb

@@ -0,0 +1,21 @@
+module Entrata
+  module Request
+    class Error < StandardError
+      def initialize(msg = nil, code = nil)
+        super(msg)
+        @code = code
+        @msg = msg
+      end
+
+      def to_s
+        if code
+          "message: #{msg}, code: #{code}"
+        else
+          msg
+        end
+      end
+
+      attr_reader :code, :msg
+    end
+  end
+end

data/lib/entrata/request/get_access_token.rb

@@ -0,0 +1,36 @@
+require 'entrata/request/base'
+
+module Entrata
+  module Request
+    # Acquire an access token for a PMC and API client pair
+    class GetAccessToken < Base
+      def after_initialize(auth_code:, client_id:, client_secret:)
+        @auth_code = auth_code
+        @client_id = client_id
+        @client_secret = client_secret
+      end
+
+      def resource_name
+        'getAccessToken'
+      end
+
+      def resource_path
+        '/api/oauth'
+      end
+
+      private
+
+      def resource_auth
+        {
+          type: 'oauth',
+          code: auth_code,
+          grant_type: 'authorization_code',
+          client_id: client_id,
+          client_secret: client_secret
+        }
+      end
+
+      attr_reader :auth_code, :client_id, :client_secret
+    end
+  end
+end

data/lib/entrata/request/get_client_info.rb

@@ -0,0 +1,21 @@
+require 'entrata/request/base'
+
+module Entrata
+  module Request
+    # Gets info about a PMC (called a "Client" from Entrata's perspective),
+    #   not to be confused with the API client.
+    class GetClientInfo < Base
+      private
+
+      def resource_path
+        '/api/ils/internetlisting'
+      end
+
+      def resource_name
+        'getClientInfo'
+      end
+
+      attr_reader :auth_code, :client_id, :client_secret
+    end
+  end
+end

data/lib/entrata/request/get_ils_properties_data.rb

@@ -0,0 +1,24 @@
+require 'entrata/request/base'
+
+module Entrata
+  module Request
+    # Get details for multiple properties within a PMC all at once; very slow
+    class GetIlsPropertiesData < Base
+      def after_initialize(property_ids:)
+        @property_ids = property_ids
+      end
+
+      def resource_name
+        'getIlsPropertiesData'
+      end
+
+      def resource_params
+        { propertyIds: property_ids.join(',') }
+      end
+
+      private
+
+      attr_reader :property_ids
+    end
+  end
+end

data/lib/entrata/request/get_property_info.rb

@@ -0,0 +1,24 @@
+require 'entrata/request/base'
+
+module Entrata
+  module Request
+    # Get property details for a single property within a PMC
+    class GetPropertyInfo < Base
+      def after_initialize(property_id:)
+        @property_id = property_id
+      end
+
+      def resource_name
+        'getPropertyInfo'
+      end
+
+      def resource_params
+        { propertyId: property_id }
+      end
+
+      private
+
+      attr_reader :property_id
+    end
+  end
+end

data/lib/entrata/request/process_property_activation.rb

@@ -0,0 +1,28 @@
+require 'entrata/request/base'
+
+module Entrata
+  module Request
+    # Inform Entrata that a single property has been onboarded
+    class ProcessPropertyActivation < Base
+      def after_initialize(property_id:, activation_status:)
+        @property_id = property_id
+        @activation_status = activation_status
+      end
+
+      def resource_name
+        'processPropertyActivation'
+      end
+
+      def resource_params
+        {
+          propertyId: property_id,
+          activationStatus: activation_status
+        }
+      end
+
+      private
+
+      attr_reader :property_id, :activation_status
+    end
+  end
+end

data/lib/entrata/request/send_inactive_leads.rb

@@ -0,0 +1,104 @@
+require 'entrata/request/base'
+
+module Entrata
+  module Request
+    # insert a lead that is assigned to Lea Lite and Log email communication to
+    # remove the lead from the assign agent/never contacted/contact needed queues
+    class SendInactiveLeads < Base
+      # Preferences are optional for inserting a lead into Entrata.
+      def after_initialize(customer:, lead_source_id:, leasing_agent_id:, preferences:, property_id:)
+        @customer = customer
+        @lead_source_id = lead_source_id
+        @leasing_agent_id = leasing_agent_id
+        @preferences = preferences
+        @property_id = property_id
+      end
+
+      def resource_auth
+        { type: 'basic' }
+      end
+
+      def resource_name
+        'sendLeads'
+      end
+
+      def resource_path
+        '/api/leads'
+      end
+
+      def body
+        {
+          auth: resource_auth,
+          requestId: '15', # used in all requests for Lea(SA) product
+          method: {
+            name: resource_name,
+            params: resource_params
+          }
+        }.to_json
+      end
+
+      def resource_params
+        # all dates and times used in the API are assumed to be in Mountain Time (MST or MDT)
+        five_minutes_ago = 5.minutes.ago.in_time_zone('America/Denver').strftime('%m/%d/%YT%H:%M:%S')
+        {
+          propertyId: property_id, # Entrata remote property ID
+          doNotSendConfirmationEmail: '1', # Suppress email to renter - need to validate
+          isWaitList: '0',
+          prospects: {
+            prospect: [
+              {
+                leasingAgentId: leasing_agent_id, # Lea Lite’s agent ID in the client system to be acquired during onboarding
+                leadSource: {
+                  originatingLeadSourceId: lead_source_id # ApartmentList source ID to be acquired during onboarding
+                },
+                createdDate: five_minutes_ago, # Now - 5 minutes
+                customers: { # Renter details
+                  customer: [
+                    {
+                      name: {
+                        firstName: customer.first_name,
+                        lastName: customer.last_name
+                      },
+                      phone: {
+                        cellPhoneNumber: customer.phone
+                      },
+                      email: customer.email
+                    }
+                  ]
+                },
+                customerPreferences: {
+                  desiredMoveInDate: formatted_move_in_date,
+                  comment: preferences.comments,
+                  desiredNumBedrooms: preferences.beds
+                },
+                events: {
+                  event: [
+                    {
+                      type: 'EmailToProspect', # Event necessary to remove guest card from “Contact needed” tab
+                      date: five_minutes_ago, # Now - 5 minutes
+                      emailAddresses: {
+                        from: 'interests@apartmentlist.com', # irrelevant -  not displayed or used
+                        to: customer.email # prospect email
+                      },
+                      emailBody: 'not applicable' # irrelevant - not displayed or used
+                    }
+                  ]
+                }
+              }
+            ]
+          }
+        }
+      end
+
+      private
+
+      attr_reader :customer, :preferences, :property_id, :leasing_agent_id, :lead_source_id
+
+      # Entrata needs mm/dd/yyyy format for move in dates and will respond with
+      # an error if we send them a format they don't like.
+      def formatted_move_in_date
+        preferences.move_in_date.strftime('%m/%d/%Y')
+      end
+    end
+  end
+end

data/lib/entrata/request/send_lead_details.rb

@@ -0,0 +1,64 @@
+require 'entrata/request/base'
+
+module Entrata
+  module Request
+    # Send renter information to a property
+    class SendLeadDetails < Base
+      # Preferences are optional for inserting a lead into Entrata.
+      def after_initialize(customer:, preferences:, property_id:)
+        @customer = customer
+        @preferences = preferences
+        @property_id = property_id
+      end
+
+      def resource_name
+        'sendLeadDetails'
+      end
+
+      def resource_params
+        {
+          prospects: {
+            prospect: [
+              {
+                propertyId: property_id,
+                customer: {
+                  name: {
+                    firstName: customer.first_name,
+                    lastName: customer.last_name
+                  },
+                  email: customer.email,
+                  phone: customer.phone
+                },
+                customerPreferences: {
+                  targetMoveInDate: formatted_move_in_date,
+                  comments: preferences.comments,
+                  desiredNumBedrooms: preferences.beds,
+                  desiredNumBathrooms: preferences.baths,
+                  desiredRent: {
+                    min: preferences.min_price,
+                    max: preferences.max_price,
+                  },
+                  propertyUnitId: preferences.preferred_unit_id,
+                  propertyFloorplanId: preferences.preferred_floorplan_id,
+                  desiredLeaseTerms: preferences.lease_terms,
+                  pets: preferences.number_of_pets,
+                  occupants: ''
+                }
+              }
+            ]
+          }
+        }
+      end
+
+      private
+
+      attr_reader :customer, :preferences, :property_id
+
+      # Entrata needs mm/dd/yyyy format for move in dates and will respond with
+      # an error if we send them a format they don't like.
+      def formatted_move_in_date
+        preferences.move_in_date.strftime('%m/%d/%Y')
+      end
+    end
+  end
+end

data/lib/entrata/request/send_reactivate_leads.rb

@@ -0,0 +1,84 @@
+require 'entrata/request/base'
+
+module Entrata
+  module Request
+    # Schedule a manual follow up for NOW to move the guest card to the “contact needed” tab and log the handoff reason
+    class SendReactivateLeads < Base
+      # Preferences are optional for inserting a lead into Entrata.
+      def after_initialize(applicant_id:, application_id:, customer:, preferences:, property_id:)
+        @applicant_id = applicant_id
+        @application_id = application_id
+        @customer = customer
+        @preferences = preferences
+        @property_id = property_id
+      end
+
+      def resource_auth
+        { type: 'basic' }
+      end
+
+      def resource_name
+        'updateLeads'
+      end
+
+      def resource_path
+        '/api/leads'
+      end
+
+      def body
+        {
+          auth: resource_auth,
+          requestId: '15', # used in all requests for Lea(SA) product
+          method: {
+            name: resource_name,
+            version: 'r2',
+            params: resource_params
+          }
+        }.to_json
+      end
+
+      def resource_params
+        # all dates and times used in the API are assumed to be in Mountain Time (MST or MDT)
+        five_minutes_ago = 5.minutes.ago.strftime('%m/%d/%YT%H:%M:%S')
+        {
+          propertyId: property_id, # Entrata remote property ID
+          doNotSendConfirmationEmail: '1', # Suppress email to renter - need to validate
+          isWaitList: '0',
+          prospects: {
+            prospect: [
+              {
+                applicationId: application_id, # acquired in sendLeads response
+                customers: { # Renter details
+                  customer: [
+                    {
+                      applicantId: applicant_id
+                    }
+                  ]
+                },
+                events: {
+                  event: [
+                    {
+                      typeId: '8', # consistent for all PMCs & properties
+                      date: five_minutes_ago, # Now - 5 minutes
+                      comments: preferences.comments
+                    },
+                    {
+                      typeId: '15', # consistent for all PMCs & properties
+                      date: five_minutes_ago,
+                      notes: 'Contact needed',
+                      scheduleDateTime: five_minutes_ago
+                    }
+                  ]
+                }
+              }
+            ]
+          }
+        }
+      end
+
+      private
+
+      attr_reader :customer, :preferences, :property_id, :applicant_id, :application_id
+    end
+  end
+end

data/lib/entrata/test_client.rb

@@ -0,0 +1,93 @@
+require 'faraday'
+require 'uri'
+require 'json'
+require 'entrata/request/get_access_token'
+require 'entrata/request/get_client_info'
+require 'entrata/request/get_property_info'
+require 'entrata/request/process_property_activation'
+require 'entrata/request/get_ils_properties_data'
+require 'entrata/utils/static_file_fetcher'
+
+module Entrata
+  # TestClient is meant to be substituted for the real Client by consuming apps
+  #   during test.  It matches the interface of the real Client and can return
+  #   successful or failure responses by providing special input params.  See
+  #   comments below or docs for specifics.
+  class TestClient
+    def initialize(subdomain:, token:); end
+
+    class << self
+      # Fails when auth_code == 'fail'
+      def get_access_token(auth_code:, client_id:, client_secret:, conn: nil)
+        if auth_code == 'fail'
+          raise Entrata::Request::Error, 'TestClient forced error'
+        else
+          StaticFileFetcher.parsed_response_for('get_access_token')
+        end
+      end
+
+      # Fails when token == 'fail'
+      def get_client_info(token, conn: nil)
+        if token == 'fail'
+          raise Entrata::Request::Error, 'TestClient forced error'
+        else
+          StaticFileFetcher.parsed_response_for('get_client_info')
+        end
+      end
+    end
+
+    # Fails when property_id == 'fail'
+    def get_property_info(property_id)
+      raise_forced_failure! if property_id == 'fail'
+      StaticFileFetcher.parsed_response_for('get_property_info')
+    end
+
+    # Fails when property_id == 'fail'
+    def process_property_activation(property_id, activation_status: 'approve')
+      raise_forced_failure! if property_id == 'fail'
+      StaticFileFetcher.parsed_response_for('process_property_activation')
+    end
+
+    # Fails when property_ids includes at lease one value == 'fail'
+    def get_ils_properties_data(property_ids)
+      raise_forced_failure! if property_ids.include?('fail')
+      StaticFileFetcher.parsed_response_for('get_ils_properties_data')
+    end
+
+    def send_lead_details(customer:, preferences:, property_id:)
+      raise_forced_failure! if property_id == 'fail'
+      StaticFileFetcher.parsed_response_for('send_lead_details')
+    end
+
+    def send_inactive_leads(customer:, lead_source_id:, leasing_agent_id:, preferences:, property_id:)
+      raise_forced_failure! if property_id == 'fail'
+      StaticFileFetcher.parsed_response_for('send_lead_details')
+    end
+
+    def send_reactivate_leads(applicant_id:, application_id:, customer:, preferences:, property_id:)
+      raise_forced_failure! if property_id == 'fail'
+      StaticFileFetcher.parsed_response_for('send_reactivate_leads')
+    end
+
+    def inactive_lead_request_body(customer:, lead_source_id:, leasing_agent_id:, preferences:, property_id:)
+      raise_forced_failure! if property_id == 'fail'
+      StaticFileFetcher.parsed_response_for('inactive_lead_request_body')
+    end
+
+    def reactivate_lead_request_body(applicant_id:, application_id:, customer:, preferences:, property_id:)
+      raise_forced_failure! if property_id == 'fail'
+      StaticFileFetcher.parsed_response_for('reactivate_lead_request_body')
+    end
+
+    def lead_details_request_body(customer:, preferences:, property_id:)
+      raise_forced_failure! if property_id == 'fail'
+      StaticFileFetcher.parsed_response_for('lead_details_request_body')
+    end
+
+    private
+
+    def raise_forced_failure!
+      raise Entrata::Request::Error, 'TestClient forced error'
+    end
+  end
+end

data/lib/entrata/utils/static_file_fetcher.rb

@@ -0,0 +1,25 @@
+module StaticFileFetcher
+  def self.raw_response_for(method_name)
+    path = File.join(
+      File.dirname(__FILE__), '../../../', raw_response_path(method_name)
+    )
+
+    File.read(path)
+  end
+
+  def self.raw_response_path(filename)
+    "spec/support/fixtures/raw_responses/#{filename}/success.json"
+  end
+
+  def self.parsed_response_for(method_name)
+    path = File.join(
+      File.dirname(__FILE__), '../../../', parsed_response_path(method_name)
+    )
+
+    JSON.parse(File.read(path))
+  end
+
+  def self.parsed_response_path(filename)
+    "spec/support/fixtures/parsed_responses/#{filename}/success.json"
+  end
+end

data/lib/entrata/version.rb

@@ -0,0 +1,3 @@
+module Entrata
+  VERSION = '1.1.0'
+end

data/lib/entrata.rb

@@ -0,0 +1,8 @@
+require 'entrata/version'
+require 'entrata/client'
+require 'entrata/test_client'
+require 'entrata/parameter/customer'
+require 'entrata/parameter/customer_preferences'
+
+module Entrata
+end

data/lib/tasks/package.rake

@@ -0,0 +1,49 @@
+REPO_NAME = 'entrata'
+MODULE_NAME = 'entrata'
+
+def adjust_module_name(str)
+  str.sub('Entratum', 'Entrata')
+end
+
+namespace :package do
+  require 'open3'
+  require 'pathname'
+  require 'active_support'
+  require_relative "../#{MODULE_NAME}/version"
+
+  repo_version = ActiveSupport::Inflector.constantize(
+    "#{adjust_module_name(ActiveSupport::Inflector.classify(MODULE_NAME))}::VERSION"
+  )
+  root_dir = Pathname.new(File.join(__dir__, '..', '..')).expand_path
+  output_filename = "pkg/#{REPO_NAME}-#{repo_version}.gem"
+
+  desc 'Check a credential file for rubygem publishing'
+  task :check_cred do
+    path_cred = File.join(Dir.home, '.gem', 'credentials')
+    raise "Credential file not found: #{path_cred}" unless File.exists?(path_cred)
+
+    perm_cred = File.stat(path_cred).mode.to_s(8).split("")[-4..-1].join.to_s
+    raise "File permission for credential should be 0600. Get #{perm_cred}" if perm_cred != '0600'
+
+    puts 'Credential looks good'
+  end
+
+  desc 'Publish this package to github'
+  task :publish_github do
+    Rake::Task['package:check_cred'].invoke
+    Rake::Task['build'].invoke
+
+    stdout, stderr, status = Open3.capture3(
+      "gem push --key github --host https://rubygems.pkg.github.com/apartmentlist #{output_filename}",
+      { chdir: root_dir }
+    )
+    unless status.success?
+      puts "OUT: #{stdout}"
+      puts "ERR: #{stderr}"
+      raise 'Failed to publish gem'
+    end
+
+    puts stdout
+    puts "#{output_filename} is now published at GitHub. Checkout https://github.com/apartmentlist/#{REPO_NAME}/packages/"
+  end
+end