rubillow 0.0.1

data/lib/rubillow/models/addressable.rb

@@ -0,0 +1,38 @@
+module Rubillow
+  module Models
+    # Common data for responses containing address information.
+    module Addressable
+      # @return [Hash] Address information (all are strings, keys are: :street, :city, :state, :zipcode, :latitude, :longitude).
+      #
+      # @example
+      #   puts address[:street]
+      #   puts address[:city]
+      #
+      attr_accessor :address
+      
+      # get the full, formatted address
+      # 
+      # @return [String] formatted address
+      def full_address
+        @address[:street] + ', ' + @address[:city] + ', ' + @address[:state] + ' ' + @address[:zipcode]
+      end
+      
+      protected
+      
+      # @private
+      def extract_address(xml)
+        address = xml.xpath('//address')
+        if !address.empty?
+          @address = {
+            :street    => address.xpath('//street').text,
+            :city      => address.xpath('//city').text,
+            :state     => address.xpath('//state').text,
+            :zipcode   => address.xpath('//zipcode').text,
+            :latitude  => address.xpath('//latitude').text,
+            :longitude => address.xpath('//longitude').text,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/rubillow/models/chart.rb

@@ -0,0 +1,34 @@
+module Rubillow
+  module Models
+    # Base chart class.
+    class Chart < Base
+      # @return [String] image height.
+      attr_accessor :height
+      
+      # @return [String] image width.
+      attr_accessor :width
+      
+      # @return [String] URL to image.
+      attr_accessor :url
+      
+      # Returns HTML for the chart.
+      # @return [String] chart HTML.
+      def to_html
+        "<img src='#{@url}' height='#{@height}' width='#{width}' />"
+      end
+      
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        @height = @parser.xpath('//request/height').text.to_i
+        @width = @parser.xpath('//request/width').text.to_i
+        @url = @parser.xpath('//response/url').text
+      end
+    end
+  end
+end

data/lib/rubillow/models/comps.rb

@@ -0,0 +1,35 @@
+module Rubillow
+  module Models
+    # List of comps for a property.
+    class Comps < Base
+      # @return [Models::SearchResult] principal property.
+      attr_accessor :principal
+      
+      # @return [Hash] comparables list (key => comparable's score, value => {Models::SearchResult}).
+      #
+      # @example
+      #  comparables.each do |score, comp|
+      #    puts score
+      #    puts comp.price
+      #  end
+      attr_accessor :comparables
+      
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        @principal = SearchResult.new(@parser.xpath('//principal').to_xml)
+        
+        @comparables = {}
+        @parser.xpath('//comparables/comp').each do |elm|
+          key = elm.attribute('score').value
+          @comparables[key] = SearchResult.new(elm.to_xml)
+        end
+      end
+    end
+  end
+end

data/lib/rubillow/models/deep_comps.rb

@@ -0,0 +1,35 @@
+module Rubillow
+  module Models
+    # List of comps for a given property with deep data.
+    class DeepComps < Base
+      # @return [Models::DeepSearchResult] principal property.
+      attr_accessor :principal
+      
+      # @return [Hash] comparables list (key => comparable's score, value => {Models::DeepSearchResult}).
+      #
+      # @example
+      #  comparables.each do |score, comp|
+      #    puts score
+      #    puts comp.price
+      #  end
+      attr_accessor :comparables
+      
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        @principal = DeepSearchResult.new(@parser.xpath('//principal').to_xml)
+        
+        @comparables = {}
+        @parser.xpath('//comparables/comp').each do |elm|
+          key = elm.attribute('score').value
+          @comparables[key] = DeepSearchResult.new(elm.to_xml)
+        end
+      end
+    end
+  end
+end

data/lib/rubillow/models/deep_search_result.rb

@@ -0,0 +1,44 @@
+module Rubillow
+  module Models
+    # Get a property's information with deeper data.
+    class DeepSearchResult < SearchResult    
+      include PropertyBasics
+      
+      # @return [String] FIPS county code. See {http://www.itl.nist.gov/fipspubs/fip6-4.htm}.
+      attr_accessor :fips_county
+      
+      # @return [String] year of the last tax assessment
+      attr_accessor :tax_assessment_year
+      
+      # @return [String] value of the last tax assessment
+      attr_accessor :tax_assessment
+      
+      # @return [String] year home was built
+      attr_accessor :year_built
+      
+      # @return [Date] last date property was sold
+      attr_accessor :last_sold_date
+      
+      # @return [String] price property was last sold for
+      attr_accessor :last_sold_price
+      
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        extract_property_basics(@parser)
+        
+        @fips_county = @parser.xpath('//FIPScounty').text
+        @tax_assessment_year = @parser.xpath('//taxAssessmentYear').text
+        @tax_assessment = @parser.xpath('//taxAssessment').text
+        @year_built = @parser.xpath('//yearBuilt').text
+        @last_sold_date = Date.strptime(@parser.xpath('//lastSoldDate').text, "%m/%d/%Y")
+        @last_sold_price = @parser.xpath('//lastSoldPrice').text
+      end
+    end
+  end
+end

data/lib/rubillow/models/demographic_value.rb

@@ -0,0 +1,28 @@
+module Rubillow
+  module Models
+    # Demographic data point.
+    class DemographicValue
+      # @return [String] data point value.
+      attr_accessor :value
+      
+      # @return [String] data point type.
+      attr_accessor :type
+      
+      # create a new data point.
+      # @param [String] xml for point.
+      def initialize(xml)
+        if !xml.empty?
+          @value = xml.text
+          @type = xml.attribute('type').value if !xml.attribute('type').nil?
+        end
+      end
+      
+      # Prints value
+      #
+      # @return [String] attribute value
+      def to_s
+        @value
+      end
+    end
+  end
+end

data/lib/rubillow/models/demographics.rb

@@ -0,0 +1,149 @@
+module Rubillow
+  module Models
+    # Demographics data
+    class Demographics < Base
+      include Linkable
+      
+      # @return [Models::Region] region data.
+      attr_accessor :region
+      
+      # @return [Hash] Charts (key: name, value: url).
+      #
+      # @example
+      #   charts.each do |name, value|
+      #   end
+      #
+      attr_accessor :charts
+      
+      # @return [Hash] Metrics ([high level point][low level point]).
+      # 
+      # @example
+      #   puts metrics['BuiltYear']['<1900']
+      #
+      attr_accessor :metrics
+      
+      # @return [Hash] Affordability metrics (key: name, value: value).
+      #
+      # @example
+      #   puts affordability_data['Zillow Home Value Index'][:neighborhood]
+      #
+      attr_accessor :affordability_data
+      
+      # @return [Hash] US Census metrics ([high level point][low level point]).
+      #
+      # @example
+      #   puts census_data['Household']['NoKids']
+      attr_accessor :census_data
+      
+      # @return [Hash] Segmentation metrics (key: name, value: [:name, :description])
+      #
+      # @example
+      #   puts segmentation["Makin' It Singles"][:name]
+      #   puts segmentation["Makin' It Singles"][:description]
+      # 
+      attr_accessor :segmentation
+      
+      # @return [Hash] Characteristics metrics ([high level point] -> hash)
+      #
+      # @example
+      #   characteristics['Education']
+      attr_accessor :characteristics
+      
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        extract_links(@parser)
+        
+        @region = Region.new(@parser.xpath('//region').to_xml)
+        
+        @charts = {}
+        @parser.xpath('//charts').children.each do |elm|
+          if elm.xpath('name').attribute('deprecated').nil?
+            @charts[elm.xpath('name').text] = elm.xpath('url').text
+          end
+        end
+        
+        @metrics = {}
+        @affordability_data = {}
+        @census_data = {}
+        @segmentation = {}
+        @characteristics = {}
+        
+        @parser.xpath('//pages').children.each do |page|
+          page.xpath('tables').children.each do |table|
+            table_name = table.xpath('name').text
+            
+            if table_name == "Affordability Data" && table.parent.parent.xpath('name').text == "Affordability"
+              extract_affordability_data(table)
+            elsif table_name[0,14] == "Census Summary"
+              extract_census_data(table, table_name[15, table_name.length])
+            else
+              extract_data(table, table_name)
+            end
+          end
+        end
+        
+        @parser.xpath('//segmentation').children.each do |segment|
+          @segmentation[segment.xpath('title').text] = {
+            :name => segment.xpath('name').text,
+            :description => segment.xpath('description').text,
+          }
+        end
+        
+        @parser.xpath('//uniqueness').children.each do |category|
+          key = category.attribute('type').text
+          @characteristics[key] = []
+          category.xpath('characteristic').each do |c|
+            @characteristics[key] << c.text
+          end
+        end
+      end
+      
+      # @private
+      def extract_affordability_data(xml)
+        xml.xpath('data').children.each do |data|
+          @affordability_data[data.xpath('name').text] = extract_metrics(data)
+        end
+      end
+      
+      # @private
+      def extract_census_data(xml, type)
+        @census_data[type] = {}
+        
+        xml.xpath('data').children.each do |data|
+          @census_data[type][data.xpath('name').text] = extract_metrics(data)
+        end
+      end
+      
+      # @private
+      def extract_data(xml, type)
+        if @metrics[type].nil?
+          @metrics[type] = {}
+        end
+        
+        xml.xpath('data').children.each do |data|
+          @metrics[type][data.xpath('name').text] = extract_metrics(data)
+        end
+      end
+      
+      # @private
+      def extract_metrics(xml)
+        if xml.xpath('values').empty?
+          DemographicValue.new(xml.xpath('value'))
+        else
+          {
+            :neighborhood => DemographicValue.new(xml.xpath('values/neighborhood/value')),
+            :city => DemographicValue.new(xml.xpath('values/city/value')),
+            :nation => DemographicValue.new(xml.xpath('values/nation/value')),
+            :zip => DemographicValue.new(xml.xpath('values/zip/value')),
+          }
+        end
+      end
+    end
+  end
+end

data/lib/rubillow/models/images.rb

@@ -0,0 +1,24 @@
+module Rubillow
+  module Models
+    # Common data for responses containing images
+    module Images
+      # @return [Array] List of image urls
+      attr_accessor :images
+      
+      # @return [Integer] number of images available (doesn't always match @images.count)
+      attr_accessor :images_count
+      
+      protected
+      
+      # @private
+      def extract_images(xml)
+        @images_count = xml.xpath('//images/count').text
+        
+        @images = []
+        xml.xpath('//images/image').children.each do |elm|
+          @images << elm.text
+        end
+      end
+    end
+  end
+end

data/lib/rubillow/models/linkable.rb

@@ -0,0 +1,39 @@
+module Rubillow
+  module Models
+    # Common data for responses containing links
+    module Linkable
+      # @return [Hash] Links (format: :name => 'url')
+      #
+      # @example
+      #   links.each do |name, url
+      #   end
+      # 
+      attr_accessor :links
+      
+      protected
+      
+      # @private
+      def extract_links(xml)
+        @links = {}
+        
+        # TODO: clean up this logic
+        if !xml.xpath('//result/links').empty?
+          selector = '//result/links'
+        elsif !xml.xpath('//response/links').empty?
+          selector = '//response/links'
+        elsif !xml.xpath('//principal/links').empty?
+          selector = '//principal/links'
+        elsif !xml.xpath('//comp/links').empty?
+          selector = '//comp/links'
+        else
+          selector = '//links'
+        end
+        
+        xml.xpath(selector).children.each do |link|
+          next if link.name == "myzestimator" # deprecated
+          @links[link.name.to_sym] = link.text
+        end
+      end
+    end
+  end
+end

data/lib/rubillow/models/monthly_payments.rb

@@ -0,0 +1,64 @@
+module Rubillow
+  module Models
+    # Monthly payment information
+    class MonthlyPayments < Base
+      # @return [Hash] 30 year fixed rate data (:rate, :principal_and_interest, :mortgage_insurance).
+      #
+      # @example
+      #   puts thirty_year_fixed[:rate]
+      #
+      attr_accessor :thirty_year_fixed
+      
+      # @return [Hash] 15 year fixed rate data (:rate, :principal_and_interest, :mortgage_insurance).
+      #
+      # @example
+      #   puts fifteen_year_fixed[:rate]
+      #
+      attr_accessor :fifteen_year_fixed
+      
+      # @return [Hash] 5/1 fixed rate data (:rate, :principal_and_interest, :mortgage_insurance).
+      #
+      # @example
+      #   puts five_one_arm[:rate]
+      #
+      attr_accessor :five_one_arm
+      
+      # @return [String] down payment amount.
+      attr_accessor :down_payment
+      
+      # @return [String] monthly property taxes (estimated).
+      attr_accessor :monthly_property_taxes
+      
+      # @return [String] monthyly hazard insurance (estimated).
+      attr_accessor :monthly_hazard_insurance
+      
+      protected
+      
+      # @private
+      def parse
+        super
+        
+        return if !success?
+        
+        @thirty_year_fixed = {
+          :rate => @parser.xpath('//payment[@loanType="thirtyYearFixed"]/rate').text,
+          :principal_and_interest => @parser.xpath('//payment[@loanType="thirtyYearFixed"]/monthlyPrincipalAndInterest').text,
+          :mortgage_insurance => @parser.xpath('//payment[@loanType="thirtyYearFixed"]/monthlyMortgageInsurance').text,
+        }
+        @fifteen_year_fixed = {
+          :rate => @parser.xpath('//payment[@loanType="fifteenYearFixed"]/rate').text,
+          :principal_and_interest => @parser.xpath('//payment[@loanType="fifteenYearFixed"]/monthlyPrincipalAndInterest').text,
+          :mortgage_insurance => @parser.xpath('//payment[@loanType="fifteenYearFixed"]/monthlyMortgageInsurance').text,
+        }
+        @five_one_arm = {
+          :rate => @parser.xpath('//payment[@loanType="fiveOneARM"]/rate').text,
+          :principal_and_interest => @parser.xpath('//payment[@loanType="fiveOneARM"]/monthlyPrincipalAndInterest').text,
+          :mortgage_insurance => @parser.xpath('//payment[@loanType="fiveOneARM"]/monthlyMortgageInsurance').text,
+        }
+        @down_payment = @parser.xpath('//downPayment').text
+        @monthly_property_taxes = @parser.xpath('//monthlyPropertyTaxes').text
+        @monthly_hazard_insurance = @parser.xpath('//monthlyHazardInsurance').text
+      end
+    end
+  end
+end