apt_finder 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cba2cb2f834bfb5d1afdcaeeb59ec77f06c19331
+  data.tar.gz: b66f057b68dc99f5c75d3ac956816d3cafe107fa
+SHA512:
+  metadata.gz: 1031cad5ccf8ffa64baacf358ff3a0eb5d2d8bbdf03afe278897829a470ce17c3863586afa17378632f813aec594ee4c6d29c4cac20169992f393c32a055ae21
+  data.tar.gz: 2f8d72ddd651c68907b408d7b6f4bc48d43c718532a3c765f90a87f49ebcdad8efc5c32c85df91775390c8e724d20e2eb54cfb35d186f42f07045adec2db7919

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

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

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 nin.yeung@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in apt_finder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 yeungn
+
+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,39 @@
+# AptFinder
+
+A simple gem used to get NYC apartment listings data from Apartmentfinder.com.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apt_finder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apt_finder
+
+## 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]/apt_finder. 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/apt_finder.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apt_finder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apt_finder"
+  spec.version       = AptFinder::VERSION
+  spec.authors       = ["yeungn"]
+  spec.email         = ["nin.yeung@gmail.com"]
+
+  spec.summary       = %q{Apartment Finder}
+  spec.description   = %q{Scraper to get current listings from Apartmentfinder}
+  spec.homepage      = "https://rubygems.org/gems/apt_finder"
+  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'] = "https://rubygems.org"
+  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 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.13"
+  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/bin/apt-finder

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require './lib/apt_finder'
+
+AptFinder::CLI.new.call

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "apt_finder"
+
+# 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

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/apt_finder/cli.rb

@@ -0,0 +1,60 @@
+class AptFinder::CLI
+  def call
+    puts "Welcome to Apt Finder"
+
+    listings
+    menu
+  end
+
+  def listings
+    AptFinder::Listings.listings
+  end
+
+  def menu
+    input = nil
+
+    while input != 'exit'
+      puts ""
+      puts "Enter the number you would like more info on"
+      puts "type 'list' to see the listing"
+      puts "type 'exit' the end the search"
+      puts ""
+      input = gets.strip.downcase
+
+      if input.to_i > 0 && input.to_i <= 10
+        doc = Nokogiri::HTML(open(listings[input.to_i - 1][2]))
+
+        puts ""
+        puts "Description"
+        puts "-----------------------------------------------"
+        puts doc.search('section.description').text.strip.gsub(/\n|\r/, '').gsub(/\s+/, ' ')
+        puts ""
+        puts "Enter the number of bedrooms:"
+        bedrooms = gets.strip
+
+        if bedrooms >= "2"
+          puts "not available"
+        elsif bedrooms == "0"
+          puts doc.css('div.name')[0].text.strip
+          puts doc.css('#lease-terms .length')[0].text.strip
+          puts doc.css('div.rent')[0].text.strip
+          puts doc.css('div.available-now')[0].text.strip
+        elsif bedrooms == "1"
+          puts doc.css('div.name')[4].text.strip
+          puts doc.css('#lease-terms .length').text.strip
+          puts doc.css('div.rent')[4].text.strip
+          puts doc.css('div.available-now')[4].text.strip
+        end
+
+      elsif input == "list"
+        listings
+      elsif input == "exit"
+        exit
+      end
+    end
+  end
+
+  def exit
+    puts "Goodbye!!!"
+  end
+end

data/lib/apt_finder/listings.rb

@@ -0,0 +1,22 @@
+class AptFinder::Listings
+
+  @@listings = []
+
+  def self.listings
+    doc = Nokogiri::HTML(open("http://www.apartmentfinder.com/New-York/New-York-Apartments"))
+
+    doc.css('div.listingContent')[1..10].each_with_index do |list, index|
+      title = list.css('div.listingTitle').text.strip
+      price = list.css('span.altRentDisplay').text.strip
+      link = list.css('div.listingTitle a').attr('href').value
+
+      puts "#{index + 1}. #{title} - price range from #{price}"
+      self.all << [title, price, link]
+    end
+    self.all
+  end
+
+  def self.all
+    @@listings
+  end
+end

data/lib/apt_finder/version.rb

@@ -0,0 +1,3 @@
+module AptFinder
+  VERSION = "0.1.1"
+end

data/lib/apt_finder.rb

@@ -0,0 +1,7 @@
+require 'open-uri'
+require 'nokogiri'
+require 'pry'
+
+require_relative "apt_finder/version"
+require_relative "apt_finder/cli"
+require_relative "apt_finder/listings"

data/spec.md

@@ -0,0 +1,7 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [X] Have a CLI for interfacing with the application
+- [X] Pull data from an external source
+- [X] Implement both list and detail views
+

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: apt_finder
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- yeungn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: Scraper to get current listings from Apartmentfinder
+email:
+- nin.yeung@gmail.com
+executables:
+- apt-finder
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apt_finder.gemspec
+- bin/apt-finder
+- bin/console
+- bin/setup
+- lib/apt_finder.rb
+- lib/apt_finder/cli.rb
+- lib/apt_finder/listings.rb
+- lib/apt_finder/version.rb
+- spec.md
+homepage: https://rubygems.org/gems/apt_finder
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: Apartment Finder
+test_files: []