daily_properties 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c1fa89cd356c98fad275eb087ecef43d0b942d2
-  data.tar.gz: 426edcd72a65cb1e261a93255c6c710e12531819
+  metadata.gz: 5719d30858ce132c47deb4492eb5da903a2f22e8
+  data.tar.gz: 1d0a5becf00aa1bca03bafec8821a5a5dac44794
 SHA512:
-  metadata.gz: d0582d6ebbd7dac099645d374a9c0f1c52f1d869d32459f768857ed775a68e2061bafa97b74e7e7d287b7ad0551527f42ac857542c7f94d6b01d3562ab5082d3
-  data.tar.gz: 68422c2646b73569cf604ee198f91e342a9d1d6170e0cebdd9b2a7319d3166aed3868d4100b2179633e8ebedff4c6aeb50624caf4c3328624f6d38a188c24dd0
+  metadata.gz: a1364c54427f3cc58a31a7fe509dad2cc6af83dfb2ee291aba1d9503f2ebcb4f474caeccd636ea33eb0fdd5dbf0d60edbc83a1b5c760567a3f48a79447552d3e
+  data.tar.gz: 0e822f0ee8b3d5265ad2e38e1b8578c83f28f78184b2471e9a2af283e9eba0c0aa56b4c022fa6a92697277af65b5990f4d96b50bbc88d4d1c470f2bdf2923002

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,31 @@
+# DailyProperties
+
+Put in the zipcode you would like to look up the most recently sold properties within that zipcode area, the gem will return you a list of the most recently sold properties with addresses, sold dates, sold prices, and urls to photos and other specs on zillow.com. Follow the menu prompts and have fun! 
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install daily_properties
+
+## Usage
+
+After installing the gem, run command `daily-properties` to start. Please follow the prompts for instruction.
+
+Here is a link to a walkthough video that I made. (https://youtu.be/npKP1ylzQA0)
+
+## 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,17 @@
+#require "bundler/gem_tasks"
+#require "rspec/core/rake_task"
+
+#RSpec::Core::RakeTask.new(:spec)
+
+#task :default => :spec
+
+require_relative './config/environment'
+
+def reload!
+  load './lib/daily_properties/scraper.rb'
+end
+
+desc "A console"
+task :console do
+  Pry.start
+end

data/bin/console

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "irb"
+IRB.start(__FILE__)

data/bin/daily-properties

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

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

@@ -1,6 +1,7 @@
 require "nokogiri"
 require 'open-uri'
 require 'bundler'
+require 'pry'
 Bundler.require
 
 require_relative "../lib/daily_properties/version"

data/daily_properties.gemspec

@@ -0,0 +1,36 @@
+# 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{A CLI gem that displays a list of properties that were recently sold within a zipcode area, scrapped from zillow.com}
+  spec.description   = %q{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 the most recently sold properties in the area. Users can type respective property number to get the url to view more details of the property.}
+  spec.homepage      = "https://github.com/jingruzhang/cli_daily_properties"
+  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.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against " \
+  #    "public gem pushes."
+  #end
+  spec.files          = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths  = ['lib']
+  spec.executables   = ['daily-properties']
+
+  spec.post_install_message = "Thanks for installing! Happy researching."
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "nokogiri", "~> 1.7"
+  spec.add_development_dependency 'pry'
+end

data/lib/daily_properties/cli.rb

@@ -1,8 +1,14 @@
 # CLI Controller
 
 class DailyProperties::CLI
+
+    def welcome
+        print "Welcome! "
+        call
+    end
+
     def call
-        puts "Welcome! Please enter the zipcode, and I will list the 26 most recently sold properties in that area:"
+        puts "Please enter the zipcode, and I will list the most recently sold properties in that area for you: "
         zipcode = gets.strip.to_i
         list_properties(zipcode)
         menu
@@ -10,9 +16,9 @@ class DailyProperties::CLI
 
     def list_properties(zipcode)
         DailyProperties::Scraper.make_properties(zipcode)
-        @properties = DailyProperties::Property.property
+        @properties = DailyProperties::Property.properties
         @properties.each.with_index(1) do |property, i|
-            puts "#{i}. #{property.address}, #{property.sold_date} at #{property.price}"
+            puts "#{i}. #{property.address}, #{property.sold_date}, #{property.price}"
         end
         puts "--------------------------------------------------"
     end
@@ -20,23 +26,27 @@ class DailyProperties::CLI
     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: "
+            puts "Enter the number of the property that you'd like to know more about, or enter 'price' to view the list sorted by sold price (high-->low), or enter 'another' to look up another zipcode, 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"
+            if input == "another"
                 DailyProperties::Property.clear_all
                 puts "--------------------------------------------------"
                 call
-            elsif input == "list"
-                list_properties
+            elsif input == "price"
+                DailyProperties::Property.sort_by_price
+                @properties = DailyProperties::Property.properties
+                @properties.each.with_index(1) do |property, i|
+                    puts "#{i}. #{property.address}, #{property.sold_date}, #{property.price}"
+                end
+                puts "--------------------------------------------------"
             elsif input == "exit"
                 goodbye
                 exit
+            elsif the_property = DailyProperties::Property.find(input.to_i - 1) 
+                puts "#{the_property.address}, #{the_property.sold_date}, #{the_property.price}"
+                puts "See more at #{the_property.url}"
             else
-                puts "Not sure what you just enter. Type list or exit. "
+                puts "Not sure what you just enter."
                 puts "--------------------------------------------------"
             end
         end

data/lib/daily_properties/property.rb

@@ -19,7 +19,7 @@ class DailyProperties::Property
             )
     end
 
-    def self.property
+    def self.properties
         @@all 
     end
 
@@ -27,5 +27,21 @@ class DailyProperties::Property
         @@all.clear
     end
 
+    def self.find(index)
+        index < 0 ? nil : @@all[index]
+    end
+
+    def convert_price_to_int
+        if price.include?("M")
+            (price.split("$")[1].gsub("M", "").to_f*1000000).to_i
+        else
+            price.split("$")[1].gsub(",", "").to_i 
+        end
+    end
+
+    def self.sort_by_price
+        @@all.sort! {|a, b| b.convert_price_to_int <=> a.convert_price_to_int}
+    end
+
 end
 

data/lib/daily_properties/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: daily_properties
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Jingru Zhang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2018-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
-description: 
+- !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'
+description: 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 the most recently sold
+  properties in the area. Users can type respective property number to get the url
+  to view more details of the property.
 email:
 - zhang.jingru.93@gmail.com
 executables:
@@ -74,17 +92,31 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".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
-homepage: https://github.com/jingruzhang/cli_daily_properties.git
+- lib/daily_properties/version.rb
+homepage: https://github.com/jingruzhang/cli_daily_properties
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: Thanks for installing! Happy researching.
 rdoc_options: []
 require_paths:
 - lib
@@ -103,6 +135,6 @@ 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
+summary: A CLI gem that displays a list of properties that were recently sold within
+  a zipcode area, scrapped from zillow.com
 test_files: []