Class: Rubillow::Models::Base

Inherits:

Object

• Object
• Rubillow::Models::Base

Includes:

XmlParsingHelper

Defined in:

lib/rubillow/models.rb

Overview

Base class for data models

Direct Known Subclasses

Chart, Comps, DeepComps, Demographics, MonthlyPayments, Posting, Postings, RateSummary, Region, RegionChildren, SearchResult, UpdatedPropertyDetails

Instance Attribute Summary

• #code ⇒ Integer

  Response code.

• #message ⇒ String

  Response message.

• #near_limit ⇒ Boolean

  Nearing API’s daily request limit.

• #xml ⇒ String

  The raw XML content from the service.

Instance Method Summary

• #success? ⇒ Boolean

  Was the request successful?.

Methods included from XmlParsingHelper

#xpath_if_present

Instance Attribute Details

#code ⇒ Integer

Returns response code.

Returns:

• (Integer) —

  response code

# File 'lib/rubillow/models.rb', line 22

def code
  @code
end

#message ⇒ String

Returns response message.

Returns:

• (String) —

  response message

# File 'lib/rubillow/models.rb', line 19

def message
  @message
end

#near_limit ⇒ Boolean

Returns nearing API’s daily request limit.

Returns:

• (Boolean) —

  nearing API’s daily request limit

# File 'lib/rubillow/models.rb', line 25

def near_limit
  @near_limit
end

#xml ⇒ String

Returns the raw XML content from the service.

Returns:

• (String) —

  the raw XML content from the service

# File 'lib/rubillow/models.rb', line 12

def xml
  @xml
end

Instance Method Details

#success? ⇒ Boolean

Was the request successful?

Returns:

• (Boolean) —

  true on successful request

# File 'lib/rubillow/models.rb', line 44

def success?
  @code.to_i == 0
end