daily_properties 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79508d1eeffdbd502b88fdc271ef9cbeca8666b3
+  data.tar.gz: 2c03abac6d896c3b552e6c12dbac56c772b4053b
+SHA512:
+  metadata.gz: 67253c6b591a798b54298e627b93b2cfe36e634536ccbda58dd4c7dc938271a9fb4b42a89c6da35a3a1d6daa384e8d39c1074bd458a4e48697f16c4a121c7a35
+  data.tar.gz: 4edd381c52017fe946fe180e440313b8f6148b2c36cf1a9c7f1ed6513dc3b3b45a626a3ccca61a9f63c4d03258f68e2afc48eb8ae560b93be40f122d83b05c69

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at zhang.jingru.93@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+
+# Specify your gem's dependencies in daily_properties.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 JingruZhang
+
+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/NOTE.md

@@ -0,0 +1,33 @@
+Imagine the interface
+Start with project structure
+Start with the entry point
+Discover objects
+Program
+
+bundle gem daily_properties
+
+command line interface for new properties sold in the neighborhood (& later maybe new houses listed in the neighborhood, too) zillow
+
+with users typing in zip code, it shows a list of properties recently sold within the zipcode (a list of 20)
+
+(Build from where the user is going to interact with the program!)
+CLI interface: 
+User type in: daily_properties
+60618
+A list of 26 properties
+3904 N Seeley Ave, Chicago, IL, $1.93M, sold 04/05/2017, 6 bds, 6 ba
+2631 W Belmont Ave UNIT 4, Chicago, IL, $312,000, sold 04/04/2017, 2bds, 2ba
+…
+Which one would you like to learn more about? (1-26)
+Goodbye!
+
+Step zero: basic interface and fake data(completed)
+Step one: scrape zillow with a static zipcode--60618(completed)
+Step two: scrape zillow with a zipcode given by user
+
+What is a property?
+A property has an address
+A property has a price
+A property has a sold date
+A property has a URL
+

data/README.md

@@ -0,0 +1,41 @@
+# DailyProperties
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/daily_properties`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'daily_properties'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install daily_properties
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/daily_properties. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "daily_properties"
+
+# 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"
+IRB.start(__FILE__)

data/bin/daily-properties

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "daily_properties"
+
+DailyProperties::CLI.new.call #a useful pattern

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/config/environment.rb

@@ -0,0 +1,12 @@
+require "nokogiri"
+require 'open-uri'
+require 'pry'
+require 'bundler'
+Bundler.require
+
+require_relative "../lib/daily_properties/version"
+require_relative '../lib/daily_properties/cli'
+require_relative '../lib/daily_properties/scraper'
+require_relative '../lib/daily_properties/property'
+
+# serves as a config/environment file that requires the rest of the files and is required by the main console file

data/daily_properties.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'daily_properties/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "daily_properties"
+  spec.version       = DailyProperties::VERSION
+  spec.authors       = ["Jingru Zhang"]
+  spec.email         = ["zhang.jingru.93@gmail.com"]
+
+  spec.summary       = %q{It displays a list of 26 properties recently sold within a zipcode area, scrapped from zillow.com}
+  spec.description   = <<-EOF
+  This CLI gem helps home buyers and sellers to view the most recently sold properties within a given zipcode. Use 'daily_properties' command to run.
+  It asks users for a zipcode input, and gives users a list of 26 most recently sold properties. Users can type respective property number to get the url to view more details of the property.
+  EOF
+
+  spec.homepage      = "https://github.com/jingruzhang/cli_daily_properties"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  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/lib/daily_properties/cli.rb

@@ -0,0 +1,50 @@
+# CLI Controller
+
+class DailyProperties::CLI
+    def call
+        puts "Welcome! Please enter the zipcode, and I will list the 26 most recently sold properties in that area:"
+        zipcode = gets.strip.to_i
+        list_properties(zipcode)
+        menu
+    end
+
+    def list_properties(zipcode)
+        DailyProperties::Scraper.make_properties(zipcode)
+        @properties = DailyProperties::Property.property
+        @properties.each.with_index(1) do |property, i|
+            puts "#{i}. #{property.address}, #{property.sold_date} at #{property.price}"
+        end
+        puts "--------------------------------------------------"
+    end
+
+    def menu
+        input = nil
+        while input != "exit"
+            puts "Enter the number of the property that you'd like to know more about, or enter another to look up another zipcode, or enter list to see the list, or enter exit: "
+            input = gets.strip.downcase
+            if input.to_i > 0 && input.to_i < 27
+                the_property = @properties[input.to_i - 1]
+                puts "#{the_property.address}, #{the_property.sold_date} at #{the_property.price}"
+                puts "See more at #{the_property.url}"
+            elsif input == "another"
+                DailyProperties::Property.clear_all
+                puts "--------------------------------------------------"
+                call
+            elsif input == "list"
+                list_properties
+            elsif input == "exit"
+                goodbye
+                exit
+            else
+                puts "Not sure what you just enter. Type list or exit. "
+                puts "--------------------------------------------------"
+            end
+        end
+    end
+
+    def goodbye
+        puts "Thanks for trying me out. See you soon!"
+        puts "--------------------------------------------------"
+    end
+
+end

data/lib/daily_properties/property.rb

@@ -0,0 +1,31 @@
+class DailyProperties::Property
+    attr_accessor :address, :price, :sold_date, :url
+    @@all = []
+
+    def initialize(address = nil, price = nil, sold_date = nil, url = nil)
+        @address = address 
+        @price = price
+        @sold_date = sold_date
+        @url = url
+        @@all << self unless @@all.detect{|p| p.address == address}
+    end
+
+    def self.new_from_page(property)
+        self.new(
+            property.css(".zsg-photo-card-address").text,
+            property.css("span.zsg-photo-card-status").text,
+            property.css(".zsg-photo-card-notification").text,
+            'http://www.zillow.com' + property.css("a").attr("href")
+            )
+    end
+
+    def self.property
+        @@all 
+    end
+
+    def self.clear_all
+        @@all.clear
+    end
+
+end
+

data/lib/daily_properties/scraper.rb

@@ -0,0 +1,16 @@
+class DailyProperties::Scraper
+
+    def self.get_page(zipcode)
+        index_url = "https://www.zillow.com/homes/recently_sold/#{zipcode}/"
+        doc = Nokogiri::HTML(open(index_url))
+        doc.css(".zsg-photo-card-content")
+    end
+
+    def self.make_properties(zipcode)
+        self.get_page(zipcode).each do |property|
+            DailyProperties::Property.new_from_page(property)
+        end
+    end
+
+
+end

data/lib/daily_properties/version.rb

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

data/lib/daily_properties.rb

@@ -0,0 +1,6 @@
+#serves as a module file
+
+module DailyProperties
+end
+
+require_relative '../config/environment'

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: daily_properties
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jingru Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: |2
+    This CLI gem helps home buyers and sellers to view the most recently sold properties within a given zipcode. Use 'daily_properties' command to run.
+    It asks users for a zipcode input, and gives users a list of 26 most recently sold properties. Users can type respective property number to get the url to view more details of the property.
+email:
+- zhang.jingru.93@gmail.com
+executables:
+- console
+- daily-properties
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- NOTE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/daily-properties
+- bin/setup
+- config/environment.rb
+- daily_properties.gemspec
+- lib/.DS_Store
+- lib/daily_properties.rb
+- lib/daily_properties/cli.rb
+- lib/daily_properties/property.rb
+- lib/daily_properties/scraper.rb
+- lib/daily_properties/version.rb
+homepage: https://github.com/jingruzhang/cli_daily_properties
+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.6.11
+signing_key: 
+specification_version: 4
+summary: It displays a list of 26 properties recently sold within a zipcode area,
+  scrapped from zillow.com
+test_files: []