Class: Hcn::Property

Inherits:

Object

• Object
• Hcn::Property

Defined in:

lib/hcn/property.rb

Overview

Embeds the logic of a HouseCanary property.

Instance Method Summary

• #assessment ⇒ Hash

  Details about the most recent assessment.

• #initialize(data = {}) ⇒ Property constructor

  A new instance of Property.

• #public_records ⇒ Hash

  Public Record information.

• #subject_address ⇒ Hash

  Address information.

Constructor Details

#initialize(data = {}) ⇒ Property

Returns a new instance of Property.

Parameters:

• data (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (data):

• address (String) —

  Building number, street name, and optionally unit number

• unit (String) —

  Unit number for the property

• city (String) —

  City in which the property is located

• zipcode (String) —

  5-digit US zipcode in which the property is located

# File 'lib/hcn/property.rb', line 11

def initialize(data = {})
  @data = data
end

Instance Method Details

#assessment ⇒ Hash

Returns Details about the most recent assessment.

Returns:

• (Hash) —

  Details about the most recent assessment

# File 'lib/hcn/property.rb', line 22

def assessment = details[:assessment]

#public_records ⇒ Hash

Returns Public Record information.

Returns:

• (Hash) —

  Public Record information

# File 'lib/hcn/property.rb', line 19

def public_records = details[:public_records]

#subject_address ⇒ Hash

Returns Address information.

Returns:

• (Hash) —

  Address information

# File 'lib/hcn/property.rb', line 16

def subject_address = details[:subject_address]