reso 0.1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f40fc790012ddccc71df15ef4ded0e4e2da9c158
+  data.tar.gz: e83245209c33c892e5db60621b33409663610ca5
+SHA512:
+  metadata.gz: c9d4a8f7591292f3f68a4b1ec15fe90498250d76ea57214ec32cded2c661839910691491af8d877da43df6da7600d33bafccfcd2ca29c28e8e701c4ae22f885c
+  data.tar.gz: fdbacc52993e69b3260051e3e53bf05795ad0860f990bc17377b6ed62abc6496e6539a1aa18f4630b468c2a7e89d2823e33c6f4eaadb78fce6d4cd79dd9c5ee6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Edlund
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,149 @@
+# RESO Data Dictionary
+
+The RESO Data Dictionary gem is an ongoing effort to provide data models and data import based on the Real Estate Standardization Organization Data Dictionary syndication format for exchange of real estate listing data.
+
+Read more here:
+http://www.reso.org/schemas-for-syndication
+
+This gem has been written for MySQL. If you test it using another RDBMS, let me know the result.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+	gem 'reso'
+
+And then install:
+
+    $ bundle
+
+Run the generator to copy migrations to your app:
+
+    $ rails g reso:install
+
+Create the database:
+
+    $ rake db:create
+
+Run the migrations:
+
+    $ rake db:migrate
+
+Populate the database with necessary seed data:
+
+	$ rake reso:seed
+
+Populate the database with an example listing:
+
+	$ rake reso:import
+
+This will download and install an example listing in the RESO format, as provided by ListHub, the largest US listing syndicator. The information needed is populated by the seed task through the Import model. If you want to add your own import, you would open the console and create an import:
+
+	> Import.create(token: 'myimport', name: 'My Import', source_url: 'http://somewebsite.com/myfeed.xml')
+
+You would then import it by passing the token value to the import rake task:
+
+	$ rake reso:import[myimport]
+
+
+## Usage
+
+Fetch a listing:
+
+	@listing = Listing.first
+
+Access direct attributes:
+
+	@listing.list_price
+	@listing.list_price_low
+	@listing.listing_url
+	@listing.lead_routing_email
+	@listing.bedrooms
+	@listing.bathrooms
+	@listing.listing_key
+	@listing.permit_address_on_internet
+	@listing.vow_address_display
+	@listing.vow_automated_valuation_display
+	@listing.vow_consumer_comment
+	@listing.disclose_address
+	@listing.short_sale
+	@listing.listing_description
+	@listing.listing_service_identifier
+	@listing.living_area
+	@listing.lot_size
+	@listing.lot_size_unit
+	@listing.listing_date
+	@listing.listing_title
+	@listing.full_bathrooms
+	@listing.three_quarter_bathrooms
+	@listing.half_bathrooms
+	@listing.one_quarter_bathrooms
+	@listing.partial_bathrooms
+	@listing.latitude
+	@listing.longitude
+	@listing.directions
+	@listing.elevation
+	@listing.geocode_options
+	@listing.parcel_info
+	@listing.year_built
+	@listing.year_updated
+	@listing.building_unit_count
+	@listing.num_floors
+	@listing.condo_floor_num
+	@listing.num_parking_spaces
+	@listing.room_count
+	@listing.legal_description
+
+Access related models:
+
+	@listing.address
+	@listing.alternate_prices
+	@listing.appliances
+	@listing.architecture_style
+	@listing.brokerage
+	@listing.builders
+	@listing.community
+	@listing.cooling_systems
+	@listing.county
+	@listing.expenses
+	@listing.exterior_types
+	@listing.floor_coverings
+	@listing.foreclosure_status
+	@listing.franchises
+	@listing.heating_fuels
+	@listing.heating_systems
+	@listing.home_features
+	@listing.listing_category
+	@listing.listing_office
+	@listing.listing_provider
+	@listing.listing_service
+	@listing.listing_status
+	@listing.multiple_listing_service
+	@listing.neighborhoods
+	@listing.offices
+	@listing.open_houses
+	@listing.parking
+	@listing.participants
+	@listing.photos
+	@listing.property_sub_type
+	@listing.property_type
+	@listing.roof_types
+	@listing.rooms
+	@listing.taxes
+	@listing.videos
+	@listing.view_types
+	@listing.virtual_tours
+
+Other:
+
+	@brokerage.address
+	@builder.address
+	@franchise.address
+
+## License
+
+MIT License. Copyright 2013-2015 Michael Edlund, medlund@mac.com.
+
+  
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/controllers/syndication_controller.rb

@@ -0,0 +1,5 @@
+class SyndicationController < ApplicationController
+  def rets
+    @listings = Listing.all.order("rand()").limit(5)
+  end
+end

data/app/models/address.rb

@@ -0,0 +1,25 @@
+class Address < ActiveRecord::Base
+
+  belongs_to :address_type
+  belongs_to :addressable, polymorphic: true
+
+  before_save :validate_and_sanitize_us_address
+  
+  def address_concatenated
+    [self.full_street_address, self.city, self.state_or_province, self.postal_code].join(', ')
+  end
+  
+  def validate_and_sanitize_us_address
+    if (address = StreetAddress::US.parse(self.address_concatenated))
+      self.street_number = address.number
+      self.street_dir_prefix = address.prefix
+      self.street_name = address.street
+      self.street_suffix = address.street_type
+      self.street_dir_suffix = address.suffix
+      self.unit_number = address.unit unless address.unit.blank?
+      self.state_or_province = address.state
+      self.country = 'US'
+    end
+  end
+
+end

data/app/models/address_type.rb

@@ -0,0 +1,3 @@
+class AddressType < Enumeration
+  has_many :addresses
+end

data/app/models/alternate_price.rb

@@ -0,0 +1,2 @@
+class AlternatePrice < Price
+end

data/app/models/appliance.rb

@@ -0,0 +1,3 @@
+class Appliance < Enumeration
+  has_and_belongs_to_many :listings, foreign_key: "enumeration_id"
+end

data/app/models/architecture_style.rb

@@ -0,0 +1,5 @@
+class ArchitectureStyle < Enumeration
+
+  has_many :listings
+
+end

data/app/models/area_unit.rb

@@ -0,0 +1,2 @@
+class AreaUnit < Enumeration
+end

data/app/models/brokerage.rb

@@ -0,0 +1,4 @@
+class Brokerage < Business
+  has_many :listings
+  has_one :address, as: :addressable
+end

data/app/models/builder.rb

@@ -0,0 +1,4 @@
+class Builder < Business
+  has_many :listings
+  has_one :address, as: :addressable
+end

data/app/models/business.rb

@@ -0,0 +1,8 @@
+class Business < ActiveRecord::Base
+
+  has_and_belongs_to_many :listings, foreign_key: "business_id"
+
+  validates_presence_of :name
+  validates_presence_of :type
+
+end

data/app/models/community.rb

@@ -0,0 +1,5 @@
+class Community < Place
+
+  has_many :listings
+
+end

data/app/models/cooling_system.rb

@@ -0,0 +1,3 @@
+class CoolingSystem < Enumeration
+  has_and_belongs_to_many :listings, foreign_key: "enumeration_id"
+end

data/app/models/county.rb

@@ -0,0 +1,5 @@
+class County < Place
+
+  has_many :listings
+
+end

data/app/models/currency_period.rb

@@ -0,0 +1,3 @@
+class CurrencyPeriod < Enumeration
+  has_many :expenses
+end

data/app/models/enumeration.rb

@@ -0,0 +1,7 @@
+class Enumeration < ActiveRecord::Base
+
+  validates_presence_of :name
+  validates_presence_of :type
+  validates_uniqueness_of :name, scope: :type
+
+end

data/app/models/expense.rb

@@ -0,0 +1,6 @@
+class Expense < ActiveRecord::Base
+  belongs_to :expense_category
+  belongs_to :currency_period
+  belongs_to :listing
+  
+end

data/app/models/expense_category.rb

@@ -0,0 +1,2 @@
+class ExpenseCategory < Enumeration
+end

data/app/models/exterior_type.rb

@@ -0,0 +1,3 @@
+class ExteriorType < Enumeration
+  has_and_belongs_to_many :listings, foreign_key: "enumeration_id"
+end

data/app/models/floor_covering.rb

@@ -0,0 +1,3 @@
+class FloorCovering < Enumeration
+  has_and_belongs_to_many :listings, foreign_key: "enumeration_id"
+end

data/app/models/foreclosure_status.rb

@@ -0,0 +1,5 @@
+class ForeclosureStatus < Enumeration
+
+  has_many :listings
+
+end

data/app/models/franchise.rb

@@ -0,0 +1,4 @@
+class Franchise < Business
+  has_many :listings
+  has_one :address, as: :addressable
+end

data/app/models/gender.rb

@@ -0,0 +1,3 @@
+class Gender < Enumeration
+  has_many :people
+end

data/app/models/heating_fuel.rb

@@ -0,0 +1,3 @@
+class HeatingFuel < Enumeration
+  has_and_belongs_to_many :listings, foreign_key: "enumeration_id"
+end

data/app/models/heating_system.rb

@@ -0,0 +1,3 @@
+class HeatingSystem < Enumeration
+  has_and_belongs_to_many :listings, foreign_key: "enumeration_id"
+end

data/app/models/home_feature.rb

@@ -0,0 +1,3 @@
+class HomeFeature < Enumeration
+  has_and_belongs_to_many :listings, foreign_key: "enumeration_id"
+end

data/app/models/import.rb

@@ -0,0 +1,16 @@
+class Import < ActiveRecord::Base
+
+  belongs_to :import_format
+
+  has_many :listings
+  has_many :queued_listings
+  
+  validates_uniqueness_of :token
+
+  before_save :set_import_format
+
+  def set_import_format
+    self.import_format = ImportFormat.find_by(name: 'reso') unless self.import_format.present?
+  end
+
+end

data/app/models/import_format.rb

@@ -0,0 +1,3 @@
+class ImportFormat < Enumeration
+  has_many :imports
+end

data/app/models/license_category.rb

@@ -0,0 +1,2 @@
+class LicenseCategory < Enumeration
+end

data/app/models/listing.rb

@@ -0,0 +1,64 @@
+class Listing < ActiveRecord::Base
+
+  belongs_to :architecture_style
+  belongs_to :brokerage
+  belongs_to :builder
+  belongs_to :community
+  belongs_to :county
+  belongs_to :foreclosure_status
+  belongs_to :franchise
+  belongs_to :import
+  belongs_to :listing_category
+  belongs_to :listing_provider
+  belongs_to :listing_status
+  belongs_to :multiple_listing_service
+  belongs_to :property_sub_type
+  belongs_to :property_type
+  belongs_to :office
+  belongs_to :zoning_type
+
+  has_one :address, as: :addressable, dependent: :destroy
+
+  has_many :alternate_prices, dependent: :destroy
+  has_many :expenses, dependent: :destroy
+  has_many :open_houses, dependent: :destroy
+  has_many :photos, dependent: :destroy
+  has_many :people, through: :participants
+  has_many :rooms, dependent: :destroy
+  has_many :taxes, dependent: :destroy
+  has_many :videos, dependent: :destroy
+  has_many :virtual_tours, dependent: :destroy
+  
+  has_and_belongs_to_many :appliances, association_foreign_key: "enumeration_id"
+  has_and_belongs_to_many :cooling_systems, association_foreign_key: "enumeration_id"
+  has_and_belongs_to_many :exterior_types, association_foreign_key: "enumeration_id"
+  has_and_belongs_to_many :floor_coverings, association_foreign_key: "enumeration_id"
+  has_and_belongs_to_many :heating_fuels, association_foreign_key: "enumeration_id"
+  has_and_belongs_to_many :heating_systems, association_foreign_key: "enumeration_id"
+  has_and_belongs_to_many :home_features, association_foreign_key: "enumeration_id"
+  has_and_belongs_to_many :neighborhoods, association_foreign_key: "place_id"
+  has_and_belongs_to_many :parking, association_foreign_key: "enumeration_id"
+  has_and_belongs_to_many :participants
+  has_and_belongs_to_many :roof_types, association_foreign_key: "enumeration_id"
+  has_and_belongs_to_many :view_types, association_foreign_key: "enumeration_id"
+
+  accepts_nested_attributes_for :alternate_prices, allow_destroy: true
+  accepts_nested_attributes_for :appliances
+  accepts_nested_attributes_for :cooling_systems
+  accepts_nested_attributes_for :expenses, allow_destroy: true
+  accepts_nested_attributes_for :exterior_types
+  accepts_nested_attributes_for :floor_coverings
+  accepts_nested_attributes_for :heating_fuels
+  accepts_nested_attributes_for :heating_systems
+  accepts_nested_attributes_for :home_features
+  accepts_nested_attributes_for :neighborhoods
+  accepts_nested_attributes_for :open_houses, allow_destroy: true
+  accepts_nested_attributes_for :parking
+  accepts_nested_attributes_for :participants, allow_destroy: true
+  accepts_nested_attributes_for :roof_types
+  accepts_nested_attributes_for :rooms, allow_destroy: true
+  accepts_nested_attributes_for :taxes, allow_destroy: true
+  accepts_nested_attributes_for :view_types
+
+end
+

data/app/models/listing_category.rb

@@ -0,0 +1,5 @@
+class ListingCategory < Enumeration
+
+  has_many :listings
+
+end

data/app/models/listing_media.rb

@@ -0,0 +1,6 @@
+class ListingMedia < ActiveRecord::Base
+
+#  validates_presence_of :media_url
+#  validates_presence_of :type
+
+end

data/app/models/listing_provider.rb

@@ -0,0 +1,9 @@
+class ListingProvider < ActiveRecord::Base
+  belongs_to :source_provider_category
+
+  has_many :listings
+
+#  validates_presence_of :name
+#  validates_presence_of :source_provider_category
+
+end

data/app/models/listing_status.rb

@@ -0,0 +1,5 @@
+class ListingStatus < Enumeration
+
+  has_many :listings
+
+end

data/app/models/multiple_listing_service.rb

@@ -0,0 +1,5 @@
+class MultipleListingService < ActiveRecord::Base
+
+  has_many :listings
+
+end

data/app/models/neighborhood.rb

@@ -0,0 +1,3 @@
+class Neighborhood < Place
+  has_and_belongs_to_many :listings, foreign_key: "place_id"
+end

data/app/models/office.rb

@@ -0,0 +1,6 @@
+class Office < ActiveRecord::Base
+
+  has_many :listings
+  has_one :address, as: :addressable
+
+end

data/app/models/open_house.rb

@@ -0,0 +1,4 @@
+class OpenHouse < ActiveRecord::Base
+  belongs_to :listing
+
+end

data/app/models/parking.rb

@@ -0,0 +1,3 @@
+class Parking < Enumeration
+  has_and_belongs_to_many :listings, foreign_key: "enumeration_id"
+end

data/app/models/participant.rb

@@ -0,0 +1,5 @@
+class Participant < ActiveRecord::Base
+  belongs_to :participant_role
+  has_many :participant_licenses
+  has_and_belongs_to_many :listings
+end

data/app/models/participant_license.rb

@@ -0,0 +1,8 @@
+class ParticipantLicense < ActiveRecord::Base
+  belongs_to :license_category
+  belongs_to :participant
+  
+#  validates_presence_of :license_category
+#  validates_presence_of :participant
+  
+end

data/app/models/participant_role.rb

@@ -0,0 +1,3 @@
+class ParticipantRole < Enumeration
+  has_many :participants
+end

data/app/models/person.rb

@@ -0,0 +1,18 @@
+class Person < ActiveRecord::Base
+  belongs_to :gender
+  
+  def complete_name
+    # Dr. Edwin E. 'Buzz' Aldrin Jr.
+
+    self.nick_name.blank? ? nick_name = nil : nick_name = "'#{self.nick_name}'"
+    self.middle_name.blank? ? middle_name = nil : middle_name = "#{self.middle_name.first.upcase}."
+    [
+      self.personal_title,
+      self.first_name,
+      middle_name,
+      nick_name,
+      self.last_name,
+      self.suffix
+    ].delete_if{|i| i.blank? }.join(' ')
+  end
+end

data/app/models/photo.rb

@@ -0,0 +1,3 @@
+class Photo < ListingMedia
+  belongs_to :listing
+end

data/app/models/place.rb

@@ -0,0 +1,3 @@
+class Place < ActiveRecord::Base
+  has_and_belongs_to_many :schools, foreign_key: "place_id"
+end

data/app/models/price.rb

@@ -0,0 +1,4 @@
+class Price < ActiveRecord::Base
+  belongs_to :currency_period
+  belongs_to :listing
+end

data/app/models/property_sub_type.rb

@@ -0,0 +1,5 @@
+class PropertySubType < Enumeration
+
+  has_many :listings
+
+end

data/app/models/property_type.rb

@@ -0,0 +1,5 @@
+class PropertyType < Enumeration
+
+  has_many :listings
+
+end

data/app/models/queued_listing.rb

@@ -0,0 +1,26 @@
+class QueuedListing < ActiveRecord::Base
+  belongs_to :import
+  serialize :listing_data
+  after_save :create_listing_and_remove_myself
+
+  def mapper
+    "Mapper::#{self.import.import_format.name.downcase.capitalize}".constantize
+  end
+
+  def create_or_update_listing
+    listing = self.import.listings.eager_load(:address).eager_load(:photos).find_or_initialize_by(
+      listing_key: mapper.unique_identifier(self)
+    )
+    if (listing.modification_timestamp != mapper.modification_timestamp(self, listing))
+      Mapper::RESO_LISTING_ATTRIBUTES.each do |attribute|
+        listing.send("#{attribute}=", mapper.send(attribute, self, listing))
+      end
+      listing.save
+    end
+  end
+
+  def create_listing_and_remove_myself
+    create_or_update_listing ? self.destroy : false 
+  end
+  
+end

data/app/models/roof_type.rb

@@ -0,0 +1,3 @@
+class RoofType < Enumeration
+  has_and_belongs_to_many :listings, foreign_key: "enumeration_id"
+end

data/app/models/room.rb

@@ -0,0 +1,4 @@
+class Room < ActiveRecord::Base
+  belongs_to :room_category
+  belongs_to :listing
+end

data/app/models/room_category.rb

@@ -0,0 +1,2 @@
+class RoomCategory < Enumeration
+end

data/app/models/school.rb

@@ -0,0 +1,3 @@
+class School < ActiveRecord::Base
+  belongs_to :school_category
+end

data/app/models/school_category.rb

@@ -0,0 +1,2 @@
+class SchoolCategory < Enumeration
+end