rubillow 0.0.1

data/lib/rubillow/models/posting.rb

@@ -0,0 +1,37 @@
+module Rubillow
+  module Models
+    # A posting
+    class Posting < Base
+      include Zpidable
+      include Addressable
+      include Linkable
+      include PropertyBasics
+      include Images
+      
+      # @return [Date] last date data was refreshed.
+      attr_accessor :last_refreshed_date
+      
+      # @return [String] price
+      attr_accessor :price
+      
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        property = @parser.xpath('//property').first
+        extract_zpid(property)
+        extract_links(property)
+        extract_address(property)
+        extract_property_basics(property)
+        extract_images(property)
+        
+        @last_refreshed_date = Date.strptime(@parser.xpath('//lastRefreshedDate').text, "%Y-%m-%d")
+        @price = @parser.xpath('//price').text
+      end
+    end
+  end
+end

data/lib/rubillow/models/postings.rb

@@ -0,0 +1,64 @@
+module Rubillow
+  module Models
+    # List of postings 
+    class Postings < Base
+      include Linkable
+      
+      # @return [String] region id.
+      attr_accessor :region_id
+      
+      # @return [Array] postings with MakeMeMove status ({Models::Posting}).
+      attr_accessor :make_me_move
+      
+      # @return [Array] postings with FSBA status ({Models::Posting}).
+      attr_accessor :for_sale_by_owner
+      
+      # @return [Array] postings with FSBO status ({Models::Posting}).
+      attr_accessor :for_sale_by_agent
+      
+      # @return [Array] postings with reporting status ({Models::Posting}).
+      attr_accessor :report_for_sale
+      
+      # @return [Array] postings with for rent status ({Models::Posting}).
+      attr_accessor :for_rent
+      
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        @region_id = @parser.xpath('//regionId').text
+        
+        extract_links(@parser)
+        
+        @make_me_move = []
+        @parser.xpath('//response/makeMeMove/result').each do |elm|
+          @make_me_move << Posting.new(elm.to_xml)
+        end
+        
+        @for_sale_by_owner = []
+        @parser.xpath('//response/forSaleByOwner/result').each do |elm|
+          @for_sale_by_owner << Posting.new(elm.to_xml)
+        end
+        
+        @for_sale_by_agent = []
+        @parser.xpath('//response/forSaleByAgent/result').each do |elm|
+          @for_sale_by_agent << Posting.new(elm.to_xml)
+        end
+        
+        @report_for_sale = []
+        @parser.xpath('//response/reportForSale/result').each do |elm|
+          @report_for_sale << Posting.new(elm.to_xml)
+        end
+        
+        @for_rent = []
+        @parser.xpath('//response/forRent/result').each do |elm|
+          @for_rent << Posting.new(elm.to_xml)
+        end
+      end
+    end
+  end
+end

data/lib/rubillow/models/property_basics.rb

@@ -0,0 +1,36 @@
+module Rubillow
+  module Models
+    # Common data for responses containing property information
+    module PropertyBasics
+      # @return [String] property type
+      attr_accessor :use_code
+      
+      # @return [String] Size of lot in square feet
+      attr_accessor :lot_size_square_feet
+      
+      # @return [String] Size of property in square feet
+      attr_accessor :finished_square_feet
+      
+      # @return [String] number of bathrooms
+      attr_accessor :bathrooms
+      
+      # @return [String] number of bedrooms
+      attr_accessor :bedrooms
+      
+      # @return [String] total number of rooms
+      attr_accessor :total_rooms
+      
+      protected
+      
+      # @private
+      def extract_property_basics(xml)
+        @use_code = xml.xpath('//useCode').text
+        @lot_size_square_feet = xml.xpath('//lotSizeSqFt').text
+        @finished_square_feet = xml.xpath('//finishedSqFt').text
+        @bathrooms = xml.xpath('//bathrooms').text
+        @bedrooms = xml.xpath('//bedrooms').text
+        @total_rooms = xml.xpath('//totalRooms').text
+      end
+    end
+  end
+end

data/lib/rubillow/models/property_chart.rb

@@ -0,0 +1,26 @@
+module Rubillow
+  module Models
+    # Chart for a property
+    class PropertyChart < Chart
+      # @return [String] url for chart
+      attr_accessor :graphs_and_data
+    
+      # Returns HTML for the chart.
+      # @return [String] chart HTML.
+      def to_html
+        "<a href='#{@graphs_and_data}'>" + super + "</a>"
+      end
+    
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        @graphs_and_data = @parser.xpath('//response/graphsanddata').text
+      end
+    end
+  end
+end

data/lib/rubillow/models/rate_summary.rb

@@ -0,0 +1,38 @@
+module Rubillow
+  module Models
+    # Rate summary information
+    class RateSummary < Base
+      # @return [Hash] today's rates (:thirty_year_fixed, :fifteen_year_fixed, :five_one_arm).
+      #
+      # @example
+      #   today[:thirty_year_fixed]
+      #
+      attr_accessor :today
+      
+      # @return [Hash] last week's rates (:thirty_year_fixed, :fifteen_year_fixed, :five_one_arm).
+      #
+      # @example
+      #   last_week[:thirty_year_fixed]
+      #
+      attr_accessor :last_week
+      
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        @today = {}
+        @last_week = {}
+        @today[:thiry_year_fixed] = @parser.xpath('//today/rate[@loanType="thirtyYearFixed"]').text
+        @today[:fifteen_year_fixed] = @parser.xpath('//today/rate[@loanType="fifteenYearFixed"]').text
+        @today[:five_one_arm] = @parser.xpath('//today/rate[@loanType="fiveOneARM"]').text
+        @last_week[:thiry_year_fixed] = @parser.xpath('//lastWeek/rate[@loanType="thirtyYearFixed"]').text
+        @last_week[:fifteen_year_fixed] = @parser.xpath('//lastWeek/rate[@loanType="fifteenYearFixed"]').text
+        @last_week[:five_one_arm] = @parser.xpath('//lastWeek/rate[@loanType="fiveOneARM"]').text
+      end
+    end
+  end
+end

data/lib/rubillow/models/region.rb

@@ -0,0 +1,44 @@
+module Rubillow
+  module Models
+    # Region information.
+    class Region < Base
+      # @return [String] region id.
+      attr_accessor :id
+      
+      # @return [String] state.
+      attr_accessor :state
+      
+      # @return [String] city.
+      attr_accessor :city
+      
+      # @return [String] neighborhood.
+      attr_accessor :neighborhood
+      
+      # @return [String] latitude.
+      attr_accessor :latitude
+      
+      # @return [String] longitude.
+      attr_accessor :longitude
+      
+      # @return [String] ZMM rate URL.
+      attr_accessor :zmmrateurl
+      
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        @id = @parser.xpath('//id').text
+        @state = @parser.xpath('//state').text
+        @city = @parser.xpath('//city').text
+        @neighborhood = @parser.xpath('//neighborhood').text
+        @latitude = @parser.xpath('//latitude').text
+        @longitude = @parser.xpath('//longitude').text
+        @zmmrateurl = @parser.xpath('//zmmrateurl').text
+      end
+    end
+  end
+end

data/lib/rubillow/models/region_chart.rb

@@ -0,0 +1,30 @@
+module Rubillow
+  module Models
+    #  Chart for a region
+    class RegionChart < Chart
+      include Linkable
+      
+      # @return [String] url for chart
+      attr_accessor :link
+    
+      # Returns HTML for the chart.
+      # @return [String] chart HTML.
+      def to_html
+        "<a href='#{@link}'>" + super + "</a>"
+      end
+    
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        extract_links(@parser)
+        
+        @link = @parser.xpath('//response/link').text
+      end
+    end
+  end
+end

data/lib/rubillow/models/region_children.rb

@@ -0,0 +1,30 @@
+module Rubillow
+  module Models
+    # List of sub-regions for a region
+    class RegionChildren < Base
+      # @return [Models::Region] top-level region
+      attr_accessor :region
+      
+      # @return [Array] sub-level regions ({Models::Region})
+      attr_accessor :regions
+      
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        @region = Region.new(@parser.xpath('//response/region').to_xml)
+        
+        @regions = []
+        @parser.xpath('//response/list').children.each do |region|
+          if region.name == "region"
+            @regions << Region.new(region.to_xml)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubillow/models/search_result.rb

@@ -0,0 +1,19 @@
+module Rubillow
+  module Models
+    # Property search results
+    class SearchResult < Base
+      include Zestimateable
+      
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        extract_zestimate(@parser)
+      end
+    end
+  end
+end

data/lib/rubillow/models/updated_property_details.rb

@@ -0,0 +1,87 @@
+module Rubillow
+  module Models
+    # List of updated attributes for a property.
+    class UpdatedPropertyDetails < Base
+      include Zpidable
+      include Addressable
+      include Linkable
+      include Images
+      
+      # @return [Hash] number of page views (:current_month, :total).
+      #
+      # @example
+      #   puts page_views[:current_month]
+      #
+      attr_accessor :page_views
+      
+      # @return [String] price.
+      attr_accessor :price
+      
+      # @return [String] neighborhood.
+      attr_accessor :neighborhood
+      
+      # @return [String] elementary school's name.
+      attr_accessor :elementary_school
+      
+      # @return [String] middle school's name.
+      attr_accessor :middle_school
+      
+      # @return [String] school district's name.
+      attr_accessor :school_district
+      
+      # @return [String] Realtor provided home description
+      attr_accessor :home_description
+      
+      # @return [Hash] posting information 
+      #
+      # @example
+      #   posting.each do |key, value|
+      #   end
+      # 
+      attr_accessor :posting
+      
+      # @return [Hash] list of edited facts
+      #
+      # @example
+      #   edited_facts.each do |key, value|
+      #   end
+      #
+      attr_accessor :edited_facts
+      
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        extract_zpid(@parser)
+        extract_links(@parser)
+        extract_address(@parser)
+        extract_images(@parser)
+        
+        @page_views = {
+          :current_month => @parser.xpath('//pageViewCount/currentMonth').text,
+          :total => @parser.xpath('//pageViewCount/total').text
+        }
+        @price = @parser.xpath('//price').text
+        @neighborhood = @parser.xpath('//neighborhood').text
+        @school_district = @parser.xpath('//schoolDistrict').text
+        @elementary_school = @parser.xpath('//elementarySchool').text
+        @middle_school = @parser.xpath('//middleSchool').text
+        @home_description = @parser.xpath('//homeDescription').text
+        
+        @posting = {}
+        @parser.xpath('//posting').children.each do |elm|
+          @posting[elm.name.underscore.to_sym] = elm.text
+        end
+        
+        @edited_facts = {}
+        @parser.xpath('//editedFacts').children.each do |elm|
+          @edited_facts[elm.name.underscore.to_sym] = elm.text
+        end
+      end
+    end
+  end
+end

data/lib/rubillow/models/zestimateable.rb

@@ -0,0 +1,77 @@
+module Rubillow
+  module Models
+    # Common data for responses containing Zestimate information
+    module Zestimateable
+      include Zpidable
+      include Addressable
+      include Linkable
+      
+      # @return [String] price
+      attr_accessor :price
+      
+      # @return [Date] last updated date
+      attr_accessor :last_updated
+      
+      # @return [Hash] valuation range (values: Strings, keys: :low, :high)
+      #
+      # @example
+      #   puts valuation_range[:low]
+      #
+      attr_accessor :valuation_range
+      
+      # @return [String] change value
+      attr_accessor :change
+      
+      # @return [String] duration of change value
+      attr_accessor :change_duration
+      
+      # @return [String] percentile
+      attr_accessor :percentile
+      
+      # @return [Hash] local real estate links (values: URL strings, keys: :overview, :for_sale_by_owner, :for_sale)
+      #
+      # @example
+      #    puts local_real_estate[:overview]
+      #
+      attr_accessor :local_real_estate
+      
+      # @return [String] region name
+      attr_accessor :region
+      
+      # @return [String] region id
+      attr_accessor :region_id
+      
+      # @return [String] region type
+      attr_accessor :region_type
+      
+      protected
+      
+      # @private
+      def extract_zestimate(xml)
+        extract_zpid(xml)
+        extract_links(xml)
+        extract_address(xml)
+        
+        @price = xml.xpath('//zestimate/amount').text
+        @last_updated = Date.strptime(xml.xpath('//zestimate/last-updated').text, "%m/%d/%Y")
+        @valuation_range = {
+          :low  => xml.xpath('//zestimate/valuationRange/low').text,
+          :high => xml.xpath('//zestimate/valuationRange/high').text,
+        }
+        @change = xml.xpath('//zestimate/valueChange').text
+        @change_duration = xml.xpath('//zestimate/valueChange').attr('duration').value
+        @percentile = xml.xpath('//zestimate/percentile').text
+        
+        @region = xml.xpath('//localRealEstate/region').attribute('name').value
+        @region_id = xml.xpath('//localRealEstate/region').attribute('id').value
+        @region_type = xml.xpath('//localRealEstate/region').attribute('type').value
+      
+        @local_real_estate = {
+          :overview => xml.xpath('//localRealEstate/region/links/overview').text,
+          :for_sale_by_owner => xml.xpath('//localRealEstate/region/links/forSaleByOwner').text,
+          :for_sale => xml.xpath('//localRealEstate/region/links/forSale').text,
+        }
+      end
+    end
+  end
+end