local_real_estate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1da2e4db5010d9028cedfff2ee7c584385fb4ba4b5e389c3a3d4691632557d5
+  data.tar.gz: c46ae16452bf39e0e90de2d090aea1b81261aa472c25e5ee55900c4df98456b5
+SHA512:
+  metadata.gz: 688077939c8b68954f004b66936bf87ca8a55f1580c39244ceffbe92bb28be7ee7e2d60b46381f3f45b6b9b95ef10654c7ebfe3241aa02c294abd06ce6615b79
+  data.tar.gz: aa93871f472b16e81551dc4e2a623ee17228efe086464eacca6859ab00c588fb0c1972b56f9cc95b2beb209f0ead05d9bf1ebcb3a66136301107f51d9a785e1d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    local_real_estate (0.1.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  local_real_estate!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Connor Gallopo
+
+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,42 @@
+# LocalRealEstate
+
+This Ruby Gem will allow you to search for real estate for sale by zip code and learn about each listing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'local_real_estate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install local_real_estate
+
+## Usage
+
+Type the following and follow the on screen prompts.
+
+  NOTE: local_real_estate only accepts US 5-digit zip codes.
+
+    $ local_real_estate
+
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/<connorgallopo>/local_real_estate.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "local_real_estate"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+
+
+LocalRealEstate::CLI.new.call

data/bin/local_real_estate

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "local_real_estate"
+
+
+LocalRealEstate::CLI.new.call

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/local_real_estate.rb

@@ -0,0 +1,8 @@
+require 'nokogiri'
+
+require 'local_real_estate/version'
+require 'local_real_estate/cli'
+require 'local_real_estate/scraper'
+require 'local_real_estate/listing'
+
+# this is working as my enviornment file

data/lib/local_real_estate/cli.rb

@@ -0,0 +1,82 @@
+class LocalRealEstate::CLI
+  def call
+    greeting
+    menu
+  end
+
+  def greeting
+    system 'clear'
+    puts '-------------------------------------------'
+    puts '-------------------------------------------'
+    puts 'Welcome to the Local Real Estate Listing app'
+    puts 'This will display local real estate listings by'
+    puts 'zip code and allow you to see expanded details on each listing'
+    puts ''
+  end
+
+  def menu
+    new_search
+    detail_menu
+  end
+
+  def detail_menu
+    print_listings
+    puts 'To see more info on a listing, please select a number from the list above:'
+    detailed_view(gets.strip)
+    puts 'To go back to the previous list type "back". Or "new" to start a new search by zip. To quit, type "exit"'
+    input = gets.strip.downcase
+    case input
+    when 'back'
+      detail_menu
+    when 'new'
+      menu
+    when 'exit'
+      goodbye
+    else 
+      invalid_input
+    end
+  end
+
+  def new_search
+    LocalRealEstate::Listing.all.clear
+    puts 'Please type in the Zip code in which you would like to search'
+    zip_method
+  end
+
+  def detailed_view(selection)
+    home = LocalRealEstate::Listing.all[selection.to_i - 1]
+    puts '-------------------------------------------'
+    puts "Address: #{home.address}. #{home.city},#{home.state}."
+    puts "Price: #{home.price}"
+    puts "Bedrooms:#{home.bedrooms}"
+    puts "Bathrooms: #{home.bathrooms}"
+    unless home.sqft == '' then puts "Square Feet: #{home.sqft}" end
+    unless home.lot_size == '' then puts "Lot Size #{home.lot_size}" end
+    unless home.cars == '' then puts "Garage: #{home.cars}" end
+    puts '-------------------------------------------'
+  end
+ 
+  def zip_method
+    LocalRealEstate::Scraper.new(gets.strip).create_listings
+  end
+
+  def print_listings
+    puts "--------Listings in #{LocalRealEstate::Listing.current_city}--------"
+    LocalRealEstate::Listing.all.each_with_index do |listing, i|
+      puts "#{i + 1}. #{listing.address} - #{listing.bedrooms} #{listing.price}"
+    end
+    puts '-------------------------------------------'
+  end
+
+  def invalid_input
+    puts ' -  -  -  -  -  -  -  -  -  -  -  -  - '
+    puts 'Input not recognized, please try again:'
+    puts ' -  -  -  -  -  -  -  -  -  -  -  -  - '
+    sleep 2
+    detail_menu
+  end
+
+  def goodbye
+    puts 'See you next time!'
+  end
+end

data/lib/local_real_estate/listing.rb

@@ -0,0 +1,27 @@
+class LocalRealEstate::Listing
+
+  attr_accessor :address, :city, :state, :url, :price, :bedrooms, :bathrooms, :sqft, :cars, :lot_size
+  @@all = []
+
+  def initialize(address: nil, city: nil, state: nil, url: nil, price: nil, bedrooms: nil, bathrooms: nil, sqft: nil, cars: "none", lot_size: nil)
+    @address = address
+    @city = city
+    @state = state
+    @url = url
+    @price = price
+    @bedrooms = bedrooms
+    @bathrooms = bathrooms
+    @sqft = sqft
+    @cars = cars
+    @lot_size = lot_size
+    @@all << self
+  end
+
+  def self.all
+    @@all
+  end
+
+  def self.current_city
+    @@all[0].city
+  end
+end

data/lib/local_real_estate/scraper.rb

@@ -0,0 +1,41 @@
+require 'open-uri'
+require 'pry'
+require 'nokogiri'
+
+#Each Indoc.css('.srp-item-body')
+
+class LocalRealEstate::Scraper
+  attr_accessor :zip
+
+  def initialize(zip)
+    @zip = zip
+  end
+
+  def get_page #this needs to be fixed. If zip starts with zero its lost with .to_i
+    Nokogiri::HTML(open("https://www.realtor.com/realestateandhomes-search/#{@zip}"))
+  end
+
+  def scrape_listings
+    self.get_page.css('.srp-item-body')
+  end
+
+  def create_listings
+    scrape_listings.each_with_index do |object, index|
+      LocalRealEstate::Listing.new(
+        address: object.css('.listing-street-address').text.strip,
+        city: object.css('.listing-city').text,
+        state: object.css('.listing-region').text,
+        price: object.css('.srp-item-price').text.strip,
+        bedrooms: object.css("ul li[data-label='property-meta-beds']").text,
+        bathrooms: object.css("ul li[data-label='property-meta-baths']").text,
+        sqft: object.css("ul li[data-label='property-meta-sqft']").text,
+        cars: object.css("ul li[data-label='property-meta-garage']").text,
+        lot_size: object.css("ul li[data-label='property-meta-lotsize']").text
+      )
+    end
+  end
+
+  def expand_listing(index)
+    LocalRealEstate::Listing
+  end
+end

data/lib/local_real_estate/version.rb

@@ -0,0 +1,3 @@
+module LocalRealEstate
+  VERSION = "0.1.0"
+end

data/local_real_estate.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "local_real_estate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "local_real_estate"
+  spec.version       = LocalRealEstate::VERSION
+  spec.authors       = ["Connor Gallopo"]
+  spec.email         = ["connor.gallopo@me.com"]
+
+  spec.summary       = "Local Real Estate Listings"
+  spec.description   = "Local Real Estate Listings"
+  spec.homepage      = "https://github.com/connorgallopo/local-real-estate-cli"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency 'nokogiri'
+end

data/spec.md

@@ -0,0 +1,10 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application
+  CLI has been implimented to greet the user, ask for input and will scrape based on that input. It also will allow you to go back and start over.
+- [X] Pull data from an external source
+  Data is pulled from realtor.com. Users input is also used in the url to make each use potentially different.
+- [X] Implement both list and detail views
+  After first setting your default zip code within the Gem it will return a list view of properties. From there you have the ability to select one and view additional information about that property.
+

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: local_real_estate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Connor Gallopo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Local Real Estate Listings
+email:
+- connor.gallopo@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/local_real_estate
+- bin/setup
+- lib/local_real_estate.rb
+- lib/local_real_estate/cli.rb
+- lib/local_real_estate/listing.rb
+- lib/local_real_estate/scraper.rb
+- lib/local_real_estate/version.rb
+- local_real_estate.gemspec
+- spec.md
+homepage: https://github.com/connorgallopo/local-real-estate-cli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.2
+signing_key: 
+specification_version: 4
+summary: Local Real Estate Listings
+test_files: []