yardi 4.0.8

data/lib/yardi/validator/error_response.rb

@@ -0,0 +1,87 @@
+require 'yardi/validator'
+
+module Yardi
+  module Validator
+    # Ensure that the response has no Messages with messageType=Error.
+    class ErrorResponse
+      # @param parsed_response [Hash<String, Object>] XML response parsed into a
+      #   Hash
+      def initialize(action:, parsed_response:)
+        @action = action
+        @response = parsed_response
+      end
+
+      # @raise [Yardi::Error::ErrorResponse] if the response has an error
+      def validate!
+        return unless error?
+
+        guest_err_msg = "Error: No guests exist with the given search criteria."
+
+        if error_messages.include?(guest_err_msg)
+          raise Error::GuestsNotFound
+        end
+        raise Error::ErrorResponse, error_messages.join('. ')
+      end
+
+      private
+
+      attr_reader :action, :response
+
+      def error?
+        messages.any? do |message_node|
+          message_node['messageType'].downcase == 'error'
+        end
+      end
+
+      # We have seen a few different types of errors from Yardi.
+      # The content inside <Messages><Message> can be a hash, an array of
+      # hashes, or an array that has both a string and a hash.
+      # This string case is the example in missing_node_error.xml; they have
+      # two <Message> nodes, both of which have the same content, but only one
+      # of which has the 'messageType' attribute to tell us this is an error
+      # case. When XML is parsed into a hash, this becomes:
+      # [
+      #   "XSD Error:The element 'Name' has incomplete...",
+      #   {
+      #     "messageType" => "Error",
+      #     "__content__" => "XSD Error:The element 'Name' has incomplete..."
+      #   }
+      # ]
+      # We convert the string into a hash that matches the rest of the error
+      # messages so that we don't have to worry about type checks when pulling
+      # out the errors.
+      def messages
+        body = response['soap:Envelope']['soap:Body']
+        # This will be picked up by either the EmptyResponse or the
+        # FaultResponse check. Whatever it is, it's not an ErrorResponse issue.
+        return [] if body["#{action}Response"].nil?
+        result = body["#{action}Response"]["#{action}Result"]
+        # There are no Messages nodes in a successful
+        # GetYardiGuestActivity_Search response
+        return [] if result['Messages'].nil?
+        nodes = result['Messages']['Message']
+        nodes = nodes.is_a?(Array) ? nodes : [nodes]
+        # see method comment for why this normalization is needed
+        nodes.map do |node|
+          if node.is_a?(Hash)
+            node
+          elsif node.is_a?(String)
+            { 'messageType' => 'Error', '__content__' => node }
+          end
+        end
+      end
+
+      # We have seen a few types of error messages from Yardi so far.
+      #   1) there is only one Message node.
+      #   2) error response contains two message nodes that have the same
+      #     content. (this is why we need the .uniq!)
+      #   3) error response contains two (or more) nodes with different content
+      # PRECONDITION: #error? evaluates to true.
+      def error_messages
+        messages.map do |message|
+          "#{message['messageType']}: #{message['__content__']}".strip
+        end.uniq
+      end
+    end
+  end
+end

data/lib/yardi/validator/fault_response.rb

@@ -0,0 +1,40 @@
+require 'yardi/validator'
+
+module Yardi
+  module Validator
+    # Ensure that the response has no Fault nodes
+    class FaultResponse
+      # @param parsed_response [Hash<String, Object>] XML response parsed into a
+      #   Hash
+      def initialize(action:, parsed_response:)
+        @action = action
+        @response = parsed_response
+      end
+
+      # @raise [Yardi::Error::FaultResponse] if the response has a Fault node
+      def validate!
+        return unless error?
+        raise Error::FaultResponse, error_message
+      end
+
+      private
+
+      attr_reader :action, :response
+
+      def body
+        response['soap:Envelope']['soap:Body']
+      end
+
+      def error?
+        !body['soap:Fault'].nil?
+      end
+
+      def error_message
+        fault = body['soap:Fault']
+        fault_message = "#{fault['faultcode']}: #{fault['faultstring']}."
+        details = fault['detail']
+        details.nil? ? fault_message : "#{fault_message} Details: #{details}"
+      end
+    end
+  end
+end

data/lib/yardi/validator/missing_property.rb

@@ -0,0 +1,60 @@
+require 'yardi/validator'
+
+module Yardi
+  module Validator
+    # Make sure the property we're trying to send a guestcard for is configured
+    # in Yardi's system. For an example, @see invalid_property.xml
+    class MissingProperty
+      UNCONFIGURED_PROPERTY_REGEX = /Invalid Yardi Property Code/i
+
+      # @param parsed_response [Hash<String, Object>] the XML response parsed
+      #   into a Hash
+      def initialize(action:, parsed_response:)
+        @action = action
+        @response = parsed_response
+      end
+
+      # @raise [Yardi::Error::ErrorResponse] if the response is effectively
+      #   empty
+      def validate!
+        return if valid_property?
+        raise Error::MissingProperty, message
+      end
+
+      private
+
+      attr_reader :action, :response
+
+      def valid_property?
+        message !~ UNCONFIGURED_PROPERTY_REGEX
+      end
+
+      # This looks like:
+      # test0123:Invalid Yardi Property Code.
+      # In the example, the remote property ID that was invalid is 'test0123'.
+      #
+      # Successful guestcard insertion responses have multiple Message nodes,
+      # which become an array after parsing.
+      #
+      # Successful prospect search responses don't have any Message nodes at
+      # all.
+      #
+      # If there is only one Message node (in the case where we have an error,
+      # perhaps an invalid property), it will be a Hash. When we have an array,
+      # we know it isn't an invalid property error so we return an empty string
+      # which will fail the comparison to the regex.
+      def message
+        body = response['soap:Envelope']['soap:Body']
+        # This will be picked up by either the EmptyResponse or the
+        # FaultResponse check. Whatever it is, it's not a MissingProperty issue.
+        return '' if body["#{action}Response"].nil?
+        result = body["#{action}Response"]["#{action}Result"]
+        # There are no Messages nodes in a successful
+        # GetYardiGuestActivity_Search response
+        return '' if result['Messages'].nil?
+        messages = result['Messages']['Message']
+        messages.is_a?(Hash) ? messages['__content__'] : ''
+      end
+    end
+  end
+end

data/lib/yardi/version.rb

@@ -0,0 +1,5 @@
+# frozen-string-literal: true
+
+module Yardi
+  VERSION = '4.0.8'
+end

data/yardi.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yardi/version'
+UNWANTED = %r{^(test|spec|features)/}
+
+Gem::Specification.new do |spec|
+  spec.name = 'yardi'
+  spec.version = Yardi::VERSION
+  spec.authors = ['Heidi Galbraith']
+  spec.email = ['heidi@apartmentlist.com']
+
+  spec.summary = %(A ruby client for v4 of Yardi's API)
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(UNWANTED) }
+  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' # Parse XML responses
+  spec.add_runtime_dependency 'nokogiri', '~> 1.6' # Build XML for requests
+  spec.add_runtime_dependency 'ox', '~> 2.3' # Parser we want with MultiXML
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4'
+  spec.add_development_dependency 'rake', '~> 11.2'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.65'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+end

metadata

@@ -0,0 +1,246 @@
+--- !ruby/object:Gem::Specification
+name: yardi
+version: !ruby/object:Gem::Version
+  version: 4.0.8
+platform: ruby
+authors:
+- Heidi Galbraith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-21 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.65'
+- !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:
+- heidi@apartmentlist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODEOWNERS
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- config/multi_xml.rb
+- docs/contributing.md
+- docs/getting_started.md
+- lib/yardi.rb
+- lib/yardi/document_parser.rb
+- lib/yardi/document_parser/base.rb
+- lib/yardi/document_parser/guest_card_import_response_object.rb
+- lib/yardi/document_parser/prospects.rb
+- lib/yardi/document_parser/residents.rb
+- lib/yardi/error/base.rb
+- lib/yardi/error/connection_error.rb
+- lib/yardi/error/empty_response.rb
+- lib/yardi/error/error_response.rb
+- lib/yardi/error/fault_response.rb
+- lib/yardi/error/guests_not_found.rb
+- lib/yardi/error/invalid_configuration.rb
+- lib/yardi/error/missing_property.rb
+- lib/yardi/error/no_results.rb
+- lib/yardi/error/resource_not_found.rb
+- lib/yardi/error/service_unavailable.rb
+- lib/yardi/error/unparsable_response.rb
+- lib/yardi/model/event.rb
+- lib/yardi/model/guest_card_response.rb
+- lib/yardi/model/prospect.rb
+- lib/yardi/model/resident.rb
+- lib/yardi/parameter/agent.rb
+- lib/yardi/parameter/contact_info.rb
+- lib/yardi/parameter/credential.rb
+- lib/yardi/parameter/property.rb
+- lib/yardi/parameter/prospect.rb
+- lib/yardi/parameter/user.rb
+- lib/yardi/request/base.rb
+- lib/yardi/request/get_residents.rb
+- lib/yardi/request/get_yardi_guest_activity.rb
+- lib/yardi/request/import_yardi_guest.rb
+- lib/yardi/request_section.rb
+- lib/yardi/request_section/authentication.rb
+- lib/yardi/request_section/lead_management.rb
+- lib/yardi/request_section/prospect.rb
+- lib/yardi/request_section/residents.rb
+- lib/yardi/utils.rb
+- lib/yardi/utils/configuration_validator.rb
+- lib/yardi/utils/phone_parser.rb
+- lib/yardi/utils/request_fetcher.rb
+- lib/yardi/utils/request_generator.rb
+- lib/yardi/validator.rb
+- lib/yardi/validator/empty_response.rb
+- lib/yardi/validator/error_response.rb
+- lib/yardi/validator/fault_response.rb
+- lib/yardi/validator/missing_property.rb
+- lib/yardi/version.rb
+- yardi.gemspec
+homepage: 
+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.5.0
+signing_key: 
+specification_version: 4
+summary: A ruby client for v4 of Yardi's API
+test_files: []