real_page 2.3.0

data/lib/real_page/validator/request_fault.rb

@@ -0,0 +1,97 @@
+require 'real_page/validator'
+require 'real_page/utils/snowflake_event_tracker'
+
+module RealPage
+  module Validator
+    # Ensure there is no 'Fault' node in the response body
+    class RequestFault
+      # @param response [Hash<String, Object>] the XML response parsed into a
+      #   Hash
+      def initialize(response, request_params = nil, request_name = nil)
+        @response = response
+        @request_params = request_params
+        @request_name = request_name
+      end
+
+      # @raise [RealPage::Error::RequestFault] if the response has a fault
+      def validate!
+        return unless error?
+        send_error_to_snowflake
+        raise Error::RequestFault.new(error_message, fault_code, details)
+      end
+
+      private
+
+      attr_reader :response, :request_params, :request_name
+
+      def fault
+        response['s:Envelope']['s:Body']['s:Fault']
+      end
+
+      def details
+        return unless fault['detail']
+        app_fault = fault['detail']['RPXApplicationFault']
+        Error::RequestFault::Details.new(
+          custom_message: app_fault['CustomMessage'],
+          exception_message: app_fault['ExceptionMessage'],
+          log_id: 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
+        fault['faultstring']['__content__'] if fault
+      end
+
+      def send_error_to_snowflake
+        case request_name
+        when 'GetLeasesByTrafficSource'
+          send_move_in_report_error_to_snowflake
+        when 'ProspectSearch'
+          send_prospect_search_error_to_snowflake
+        end
+      end
+
+      def send_move_in_report_error_to_snowflake
+        Utils::SnowflakeEventTracker.track_pms_resident_event(
+          resident_type: 'PRIMARY',
+          request_params: request_params,
+          phones_count: 0,
+          error: error_message
+        )
+      end
+
+      def send_prospect_search_error_to_snowflake
+        send_roommate_error_to_snowflake
+        send_prospect_error_to_snowflake
+      end
+
+      def send_roommate_error_to_snowflake
+        Utils::SnowflakeEventTracker.track_pms_resident_event(
+          resident_type: 'ROOMMATE',
+          request_params: request_params,
+          phones_count: 0,
+          error: error_message
+        )
+      end
+
+      def send_prospect_error_to_snowflake
+        Utils::SnowflakeEventTracker.track_pms_prospect_event(
+          resident_type: 'ROOMMATE',
+          request_params: request_params,
+          error: error_message
+        )
+      end
+    end
+  end
+end

data/lib/real_page/version.rb

@@ -0,0 +1,3 @@
+module RealPage
+  VERSION = '2.3.0'
+end

data/real_page.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'real_page/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'real_page'
+  spec.version       = RealPage::VERSION
+  spec.authors       = ['Tom Collier']
+  spec.email         = ['collier@apartmentlist.com']
+
+  spec.summary       = %q{A ruby client for RealPage Exchange}
+  spec.homepage      = 'https://github.com/apartmentlist/real_page'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday', '~> 0.9'
+  spec.add_runtime_dependency 'multi_xml', '~> 0.5'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6'
+  spec.add_runtime_dependency 'ox', '~> 2.3'
+  spec.add_runtime_dependency 'tzinfo', '~> 1.2'
+  spec.add_runtime_dependency 'activesupport', '~> 5.2'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry-byebug', '~> 3.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+end

metadata

@@ -0,0 +1,291 @@
+--- !ruby/object:Gem::Specification
+name: real_page
+version: !ruby/object:Gem::Version
+  version: 2.3.0
+platform: ruby
+authors:
+- Tom Collier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: 
+email:
+- collier@apartmentlist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ci"
+- ".gitignore"
+- ".rakeTasks"
+- ".rspec"
+- CHANGELOG.txt
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/multi_xml.rb
+- lib/real_page.rb
+- lib/real_page/attribute_parser.rb
+- lib/real_page/attribute_parser/base.rb
+- lib/real_page/attribute_parser/boolean.rb
+- lib/real_page/attribute_parser/date.rb
+- lib/real_page/attribute_parser/date_time.rb
+- lib/real_page/attribute_parser/decimal.rb
+- lib/real_page/attribute_parser/integer.rb
+- lib/real_page/attribute_parser/object.rb
+- lib/real_page/attribute_parser/string.rb
+- lib/real_page/document_parser.rb
+- lib/real_page/document_parser/base.rb
+- lib/real_page/document_parser/floor_plan_object.rb
+- lib/real_page/document_parser/guest_cards.rb
+- lib/real_page/document_parser/guest_cards/amenities.rb
+- lib/real_page/document_parser/guest_cards/prospects.rb
+- lib/real_page/document_parser/leases.rb
+- lib/real_page/document_parser/picklist.rb
+- lib/real_page/document_parser/rent_matrices.rb
+- lib/real_page/document_parser/rent_matrices/options.rb
+- lib/real_page/document_parser/rent_matrices/rows.rb
+- lib/real_page/document_parser/unit_object.rb
+- lib/real_page/error/bad_request.rb
+- lib/real_page/error/base.rb
+- lib/real_page/error/invalid_configuration.rb
+- lib/real_page/error/invalid_response.rb
+- lib/real_page/error/request_fault.rb
+- lib/real_page/error/request_fault/details.rb
+- lib/real_page/model/activity.rb
+- lib/real_page/model/address.rb
+- lib/real_page/model/amenity.rb
+- lib/real_page/model/appointment.rb
+- lib/real_page/model/base.rb
+- lib/real_page/model/base/attribute.rb
+- lib/real_page/model/base/attribute_store.rb
+- lib/real_page/model/floor_plan.rb
+- lib/real_page/model/follow_up.rb
+- lib/real_page/model/guest_card.rb
+- lib/real_page/model/lease.rb
+- lib/real_page/model/lease_action.rb
+- lib/real_page/model/phone_number.rb
+- lib/real_page/model/picklist_item.rb
+- lib/real_page/model/preferences.rb
+- lib/real_page/model/prospect.rb
+- lib/real_page/model/quote.rb
+- lib/real_page/model/rent_matrix.rb
+- lib/real_page/model/rent_matrix/concessions.rb
+- lib/real_page/model/rent_matrix/option.rb
+- lib/real_page/model/rent_matrix/row.rb
+- lib/real_page/model/screening.rb
+- lib/real_page/model/unit.rb
+- lib/real_page/model/unit_shown.rb
+- lib/real_page/parameter/list_criterion.rb
+- lib/real_page/request/base.rb
+- lib/real_page/request/get_floor_plan_list.rb
+- lib/real_page/request/get_leases_by_traffic_source.rb
+- lib/real_page/request/get_marketing_sources_by_property.rb
+- lib/real_page/request/get_rent_matrix.rb
+- lib/real_page/request/get_units_by_property.rb
+- lib/real_page/request/prospect_search.rb
+- lib/real_page/request_section.rb
+- lib/real_page/request_section/auth.rb
+- lib/real_page/request_section/get_rent_matrix.rb
+- lib/real_page/request_section/list_criteria.rb
+- lib/real_page/request_section/parameter.rb
+- lib/real_page/request_section/prospect_search_criterion.rb
+- lib/real_page/utils.rb
+- lib/real_page/utils/array_fetcher.rb
+- lib/real_page/utils/configuration_validator.rb
+- lib/real_page/utils/request_fetcher.rb
+- lib/real_page/utils/request_generator.rb
+- lib/real_page/utils/snowflake_event_tracker.rb
+- lib/real_page/validator.rb
+- lib/real_page/validator/move_in_report.rb
+- lib/real_page/validator/prospects_data.rb
+- lib/real_page/validator/request_errors.rb
+- lib/real_page/validator/request_fault.rb
+- lib/real_page/version.rb
+- real_page.gemspec
+homepage: https://github.com/apartmentlist/real_page
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: A ruby client for RealPage Exchange
+test_files: []