realogy 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c57f98326c067508c84f5073c33bd538a44f94608c472a1d01c9fc79ffbca2ba
-  data.tar.gz: 55981de8712110d8eb7fe6f4656ba7896543e67fe48c3d32ba428d145c35e754
+  metadata.gz: 39157bab5613f551a79942ecaa5a7a9de1efd27696f0e5b9eb015ed9025609d3
+  data.tar.gz: c83aa9931e05ebdaf1f6d4e7e9837e55bbf8441ff06cadc78cbf2c15e614b56b
 SHA512:
-  metadata.gz: 60fe61f7b9013cf023bc22619cc94fbdf381ef1e06d26d0f8ab07255f6f7ba31ce762dd377bbcdce81f59197563e0f83bae7e80f3b36de324128e78f64b67408
-  data.tar.gz: 73dce272f6726bfadd8eda74043ecdc09df97dbe72aee6b678deef54ea7cc3704277f05de4653cee5677074c5d2a8cdf15e383513523b436caf65e720ef36516
+  metadata.gz: acbf1c9e3e550a58358e43f4fd4bd9b189cd62cef6b7aca785c4a0acf518096a5415cb5f5de058df03d3de1e949784f54960ec7954a93b8da16695c455bc1941
+  data.tar.gz: 2b4a50cd19736dc716e3e365d9b8f5b2e58b54674e830540e3a6da0da605259cb6069cfd55534cecf761f1dcfaa9dcdac14e28509a2ee9f04b27e009cf58e3ca

data/README.md

@@ -190,6 +190,266 @@ realogy.get_team_by_id(entity_id)
 
 ```
 
+## Instance methods
+
+Convenience methods to access JSON.
+
+#### Realogy::Agent
+
+- addl_emails
+- addl_languages_names
+- addl_phones
+- agent_summary
+- agent_id
+- areas_of_specialization
+- business_phone
+- business_phone_ext
+- default_photo_url
+- designations
+- display_title
+- email_address
+- first_name
+- gender
+- is_agent?
+- is_team_member?
+- languages_spoken
+- last_name
+- last_update_on
+- lead_email_address
+- license_info
+- media
+- middle_name
+- mls_information
+- mobile_phone
+- name
+- office
+- remarks
+- roles
+- specialty
+- websites
+
+#### Realogy::Company
+
+- addl_language_names
+- addl_websites
+- brand_code
+- can_do_commercial_business?
+- commercial_company_name
+- company_id
+- company_summary
+- is_nrt?
+- last_update_on
+- media
+- name
+- programs
+- rfg_id
+- website_url
+
+#### Realogy::Listing
+
+- active?
+- agents
+- agricultural_property_number
+- anchor_stores
+- annual_tax
+- available_floors
+- available_space
+- average_floor_size
+- average_occupancy_rate
+- bay_depth
+- building_area
+- building_class
+- by_appointment_only?
+- call_to_show?
+- cap_rate_percent
+- cash_flow
+- ceiling_height
+- city
+- clearance
+- column_spacing
+- common_area_factor
+- country
+- country_code
+- default_photo_url
+- development
+- district
+- dock_height
+- down_payment
+- floors
+- formatted_address
+- full_bath 
+- fully_leased_income
+- geocode_confidence_level
+- geographic_regions
+- gross_income
+- ground_level?
+- half_bath
+- has_cross_docks?
+- has_rail_access?
+- has_sprinkler?
+- hide_list_price?
+- is_for_auction?
+- is_foreclosure?
+- is_short_sale?
+- last_sold_on
+- last_update_on
+- latitude
+- lead_email
+- lease_term
+- lease_type
+- levels
+- linked_office
+- list_price
+- list_price_amount
+- list_price_currency_code
+- listed_on
+- listing_id
+- listing_type
+- listing_url
+- loan_payment
+- longitude
+- lot_dimension
+- lot_size
+- mapping_allowed?
+- max_contiguous_area
+- maximum_lease_rate
+- media
+- min_divisible_area
+- minimum_lease_rate
+- mls_information
+- mls_numbers
+- net_operating_income
+- new_construction?
+- no_of_bedrooms
+- number_of_ballrooms
+- number_of_conference_rooms
+- number_of_docks
+- occupancy_rate
+- open_house
+- parking_places
+- parking_ratio
+- partial_bath
+- pending?
+- photo_count
+- postal_code
+- power
+- price_per_area
+- price_upon_request?
+- property_address
+- property_category
+- property_features
+- property_fees
+- property_floors
+- property_name
+- property_rooms
+- property_style
+- property_type
+- property_use
+- provider_category
+- provider_key
+- provider_name
+- provider_url
+- quarter_bath
+- remarks
+- rental_frequency
+- rfg_listing_id
+- schedule_income
+- schools
+- show_address_on_internet?
+- square_footage
+- state_province
+- state_province_code
+- street_address
+- sub_lease?
+- sub_units
+- suite_apartment_name
+- suites
+- tax_id_number
+- tax_information
+- tax_roll_number
+- tax_year
+- team
+- three_quarter_bath
+- total_acres
+- total_bath
+- total_expenses
+- total_rooms
+- total_units
+- turning_radius
+- video_count
+- websites
+- year_built
+- year_renovated
+- zoning
+
+#### Realogy::Office
+
+- addl_language_names
+- addl_phone_numbers
+- addl_websites
+- area_served
+- brand_code
+- broker_name
+- city
+- company_id
+- company_name
+- country
+- country_code
+- default_photo_url
+- district
+- email_address
+- entity_preference
+- fax_number
+- formatted_address
+- geographic_regions
+- languages_spoken
+- last_update_on
+- latitude
+- lead_email_address
+- longitude
+- media
+- mls_information
+- name
+- office_address
+- office_id
+- office_manager_name
+- office_summary
+- office_type
+- phone_number
+- postal_code
+- recruiting_email_address
+- remarks
+- rfg_company_id
+- rfg_office_id
+- seasonal_close_mmdd
+- seasonal_open_mmdd
+- special_markets
+- state_province
+- state_province_code
+- street_address
+- website_url
+
+#### Realogy::Team
+
+- awards
+- addl_phone_numbers
+- addl_emails
+- addl_language_names
+- addl_websites
+- email_address
+- last_update_on
+- media
+- members 
+- name
+- office
+- phone_number
+- remarks
+- rfg_team_id
+- team_id
+- team_type 
+- team_summary
+- website_url
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/realogy/app/models/realogy/agent.rb

@@ -1,2 +1,217 @@
 class Realogy::Agent < Realogy::Entity
+
+  # addlEmails : [Hash]
+  # Additional emails of agent
+  
+  def addl_emails
+    self.dig_for_array("addlEmails")
+  end
+   
+  # addlLanguageNames : [Hash]
+  # Additional languages of agent
+   
+  def addl_languages_names
+    self.dig_for_array("addlLanguageNames")
+  end
+   
+  # addlPhones : [Hash]
+  # Additional phone numbers for agent
+   
+  def addl_phones
+    self.dig_for_array("addlPhones")
+  end
+   
+  # agentSummary : Hash
+   
+  def agent_summary
+    self.dig_for_hash("agentSummary")
+  end
+   
+  # id : String
+  # Globally unique identifier assigned to an Agent by Realogy
+  
+  def agent_id
+    self.dig_for_string("agentSummary", "id")
+  end
+   
+  # areasOfSpecialization : [String]
+  # Area of specialization for the agent
+   
+  def areas_of_specialization
+    self.dig_for_array("areasOfSpecialization")
+  end
+   
+  # businessPhone : String
+  # Business phone number of agent
+  
+  def business_phone
+    self.dig_for_string("agentSummary", "businessPhone")
+  end
+   
+  # businessPhoneExt : String
+  # Business phone extension of agent
+  
+  def business_phone_ext
+    self.dig_for_string("agentSummary", "businessPhoneExt")
+  end
+   
+  # defaultPhotoURL : String
+  # Profile photo URL for the Agent
+  
+  def default_photo_url
+    self.dig_for_string("agentSummary", "defaultPhotoURL")
+  end
+   
+  # designations : String
+  # Designation of the agent
+  
+  def designations
+    self.dig_for_string("designations")
+  end
+   
+  # displayTitle : String
+  # Title  of the agent
+  
+  def display_title
+    self.dig_for_string("agentSummary", "displayTitle")
+  end
+   
+  # emailAddress : String
+  # Email address of the agent
+  
+  def email_address
+    self.dig_for_string("agentSummary", "emailAddress")
+  end
+   
+  # firstName : String
+  # First name of the agent
+  
+  def first_name
+    self.dig_for_string("agentSummary", "firstName")
+  end
+   
+  # gender : String
+  # Gender of the agent (male/female)
+  
+  def gender
+    self.dig_for_string("agentSummary", "gender")
+  end
+   
+  # isAgent : Boolean
+  # Indicates whether the person is an agent or not
+  
+  def is_agent?
+    self.dig_for_boolean("agentSummary", "isAgent")
+  end
+   
+  # isTeamMember : Boolean
+  # Indicates whether the person is a team member or not
+  
+  def is_team_member?
+    self.dig_for_boolean("isTeamMember")
+  end
+   
+  # languagesSpoken : [Hash]
+  # The languages agent speaks
+   
+  def languages_spoken
+    self.dig_for_array("languagesSpoken")
+  end
+   
+  # lastName : String
+  # Last name of the agent
+  
+  def last_name
+    self.dig_for_string("agentSummary", "lastName")
+  end
+   
+  # lastUpdateOn : DateTime
+  # The date/time that the Agent record was last updated in the system (UTC)
+  
+  def last_update_on
+    self.dig_for_datetime("lastUpdateOn")
+  end
+   
+  # leadEmailAddress : String
+  # Email address to send leads to the agent
+  
+  def lead_email_address
+    self.dig_for_string("agentSummary", "leadEmailAddress")
+  end
+   
+  # licenseInfo : [Hash]
+  # A collection of licenses associated with the Agent
+   
+  def license_info
+    self.dig_for_array("licenseInfo")
+  end
+   
+  # media: [Hash]
+  
+  def media
+    self.dig_for_array("media")
+  end
+   
+  # middleName : String
+  # Middle name of the agent
+  
+  def middle_name
+    self.dig_for_string("agentSummary", "middleName")
+  end
+   
+  # mlsInformation : [String]
+  # MLS numbers associated with the Agent
+   
+  def mls_information
+    self.dig_for_array("mlsInformation")
+  end
+   
+  # mobilePhone : String
+  # Mobile phone number of agent
+  
+  def mobile_phone
+    self.dig_for_string("agentSummary", "mobilePhone")
+  end
+   
+  # name : String
+  # Display Name of the agent
+  
+  def name
+    self.dig_for_string("agentSummary", "name")
+  end
+   
+  # office : String
+  
+  def office
+    self.dig_for_string("agentSummary", "office")
+  end
+   
+  # remarks : [Hash]
+  # A collection of Profile descriptions associated with the Agent
+   
+  def remarks
+    self.dig_for_array("remarks")
+  end
+   
+  # roles : [Hash]
+  # Role details of the agent
+   
+  def roles
+    self.dig_for_array("roles")
+  end
+   
+  # specialty : String
+  # Specialty  of the agent
+  
+  def specialty
+    self.dig_for_string("agentSummary", "specialty")
+  end
+   
+  # webSites : [Hash]
+  # A collection of websites associated with the Agent
+   
+  def websites
+    self.dig_for_array("webSites")
+  end
+
 end

data/lib/realogy/app/models/realogy/company.rb

@@ -1,2 +1,98 @@
 class Realogy::Company < Realogy::Entity
+
+  # addlLanguageNames : [Hash]
+  # A collection of Company names in other languages (non-English)
+  
+  def addl_language_names
+    self.dig_for_array("addlLanguageNames")
+  end
+  
+  # addlWebSites : [Hash]
+  # A collection of websites associated with the Company
+  
+  def addl_websites
+    self.dig_for_array("addlWebSites")
+  end
+  
+  # brandCode : String
+  # The brand that the Company is associated with
+  
+  def brand_code
+    self.dig_for_array("companySummary", "brandCode")
+  end
+  
+  # canDoCommercialBusiness : Boolean
+  # Will be 'true' if this company can do commercial business
+  
+  def can_do_commercial_business?
+    self.dig_for_boolean("companySummary", "canDoCommercialBusiness")
+  end
+  
+  # commercialCompanyName : String
+  # commercialCompanyName of the company
+  
+  def commercial_company_name
+    self.dig_for_string("companySummary", "commercialCompanyName")
+  end
+  
+  # id : String
+  # Globally unique identifier assigned to a Company by Realogy
+  
+  def company_id
+    self.dig_for_string("companySummary", "id")
+  end
+  
+  # companySummary : Hash
+  
+  def company_summary
+    self.dig_for_hash("companySummary")
+  end
+  
+  # isNrt : Boolean
+  # This indicates whether it is Nrt Type or not
+  
+  def is_nrt?
+    self.dig_for_boolean("companySummary", "isNrt")
+  end
+  
+  # lastUpdateOn : DateTime
+  # The date/time that the Company record was last updated in the system (UTC)
+  
+  def last_update_on
+    self.dig_for_datetime("companySummary", "lastUpdateOn")
+  end
+  
+  # media : [Hash]
+  
+  def media
+    self.dig_for_array("media")
+  end
+  
+  # name : String
+  # Name of the Company
+  
+  def name
+    self.dig_for_string("companySummary", "name")
+  end
+  
+  # programs ; [Hash]
+  
+  def programs
+    self.dig_for_array("programs")
+  end
+  
+  # RFGID : String
+  # Business identifier assigned to a Company by Realogy
+  
+  def rfg_id
+    self.dig_for_string("companySummary", "RFGID")
+  end
+  
+  # websiteURL : String
+  # URL to the Company's website
+  
+  def website_url
+    self.dig_for_string("companySummary", "websiteURL")
+  end
+
 end

data/lib/realogy/app/models/realogy/entity.rb

@@ -22,4 +22,38 @@ class Realogy::Entity < ApplicationRecord
     self.save if self.changed?
   end
 
+  def dig_for_array(*path)
+    return nil unless (json = self.data).is_a?(Hash)
+    (v = json.dig(*path)).is_a?(Array) ? v : nil
+  end
+
+  def dig_for_boolean(*path)
+    return nil unless (json = self.data).is_a?(Hash)
+    (v = json.dig(*path)).to_s.upcase.eql?("TRUE") ? true : nil
+  end
+
+  def dig_for_datetime(*path)
+    self.data.dig(*path).to_datetime rescue nil
+  end
+
+  def dig_for_decimal(*path)
+    return nil unless (json = self.data).is_a?(Hash)
+    (v = json.dig(*path).to_f) != 0.0 ? v : nil
+  end
+
+  def dig_for_hash(*path)
+    return nil unless (json = self.data).is_a?(Hash)
+    (v = json.dig(*path)).is_a?(Hash) ? v : nil
+  end
+
+  def dig_for_integer(*path)
+    return nil unless (json = self.data).is_a?(Hash)
+    (v = json.dig(*path).to_i) != 0 ? v : nil
+  end
+
+  def dig_for_string(*path)
+    return nil unless (json = self.data).is_a?(Hash)
+    (v = json.dig(*path)).to_s.present? ? (v.eql?("0") ? nil : v) : nil
+  end
+
 end