Knox_Restaurants 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f09301c49d42859170e3668ae694d27215e30c92aad4de7321a7fdd43bb460e9
+  data.tar.gz: 8ece32f8249fa6b788d3c3a669582ea09f24691bab88800fe815746b6805e68e
+SHA512:
+  metadata.gz: 2ee54bb6faf1eab191559d6ba25f2351a72ac3df692f2690205c9321abb92f30809540b4572ac70470088b095ef5ca62fc4de76b56c2499baa04c7b1e8f412a8
+  data.tar.gz: da853c974894aebf46742f3d63934059eba283cff860085d6a56d873903fd2b9428564b9b11e1567e2b033d9bdd94bf7ed74d6e27f22df0fc90458864bf27f8c

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,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.2

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 chayadeaver@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 Knox_Restaurants.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    Knox_Restaurants (0.1.0)
+      httparty
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    httparty (0.17.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    method_source (0.9.2)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    mini_portile2 (2.4.0)
+    multi_xml (0.6.0)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  Knox_Restaurants!
+  bundler (~> 2.0)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/Knox_Restaurants.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "Knox_Restaurants/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "Knox_Restaurants"
+  spec.version       = KnoxRestaurants::VERSION
+  spec.authors       = ["Chaya Deaver"]
+  spec.email         = ["chayadeaver@gmail.com"]
+# for spec.summary and description you would have to fill it in later
+  spec.summary       = %q{"Search through Yelp API to gather information about restaurants"}
+  spec.description   = %q{"Gather user input and use that to correspond to Restaurant objects"}
+  spec.homepage      = "https://rubygems.org/gems/Knox_Restaurants"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] ="https://github.com/chayadeaver/Knox_Restaurants"
+  # spec.metadata["changelog_uri"] = "http://knoxrestaurants.com"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "httparty"
+  spec.add_dependency "nokogiri"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Chaya Deaver
+
+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,41 @@
+# KnoxRestaurants
+
+This Ruby gem parses Yelp API to gather information about restaurants in Knoxville, Tennessee. It uses user input to prompt different displays of information for restaurants based on a numbered item list of cuisines. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Knox_Restaurants'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install Knox_Restaurants
+
+## Usage
+
+To start the program, run 'bin/knox_restaurants' in terminal. There will be a numbered list of cuisines to choose from. There will be a prompt to enter in a number. It will return a list of restaurants corresponding to the user's input. From here, enter a valid number to get more information for that restaurant. Enter "end" to exit the program.
+
+## 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/chayadeaver/Knox_Restaurants. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the KnoxRestaurants project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/Knox_Restaurants/blob/master/CODE_OF_CONDUCT.md).

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 "Knox_Restaurants"
+
+# 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/knox_restaurants

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+## I had to change the name of the second module because it was confusing me when reading the errors.
+require './lib/environment'
+# require "bundler/setup"
+
+KnoxRestaurants::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/Knox_Restaurants/api.rb

@@ -0,0 +1,40 @@
+
+class KnoxRestaurants::API
+    attr_accessor :cuisine
+
+    def self.fetch
+        key = ENV["API_KEY"]
+        url = "https://api.yelp.com/v3/businesses/search?term=restaurant&location=knoxville&limit=50"
+        response = HTTParty.get(url, headers: {'Authorization' => "Bearer #{key}"})
+        response.parsed_response
+        response["businesses"].each do |a| 
+            
+            restaurant_name = a["name"]
+            phone_number = a["display_phone"]
+            address = a["location"]["display_address"].join(", ")
+            cuisine = a["categories"].map{|type| type["title"]}
+            url = a["url"]
+            rating = a["rating"]
+            price = a["price"]
+            reviews = a["review_count"]
+    
+            restaurant_hash = {
+                :name => restaurant_name,
+                :phone_number => phone_number,
+                :cuisine => cuisine,
+                :address => address,
+                :url => url,
+                :rating => rating,
+                :price => price,
+                :reviews => reviews
+            }
+         
+            KnoxRestaurants::Restaurant.new(restaurant_hash)  
+        end
+    end
+
+    def self.all
+        @@all
+    end
+    
+end

data/lib/Knox_Restaurants/cli.rb

@@ -0,0 +1,88 @@
+class KnoxRestaurants::CLI
+    #outputs to user
+
+    def call
+      KnoxRestaurants::API.fetch #fetches from API
+        puts "Welcome to Knoxville!"
+        start
+    end
+
+    def start 
+        display_cuisine_choices
+        input_cuisine_choice
+        return_details
+        last_hurrah
+    end
+
+    def display_cuisine_choices
+      @cuisine = KnoxRestaurants::Restaurant.get_cuisines.each.with_index(1) do |cuisine, idx|
+        puts "#{idx}. #{cuisine}"
+      end
+    end
+
+    def input_cuisine_choice
+      puts "What are you in the mood for?"
+      puts "Enter a valid number"
+      puts "Enter 'end' to exit"
+      input = gets.strip.downcase
+        if  valid?(input, @cuisine)
+          display_restaurants(input.to_i)
+          puts "To find out more, enter the number for which restaurant you want"
+        else
+          puts "I don't understand. Please pick another cuisine"
+          sleep(2)
+          start
+        end
+    end
+
+    def display_restaurants(input)
+      @restaurant = KnoxRestaurants::Restaurant.get_cuisine_restaurants(input).each.with_index(1) do |r, idx|
+        puts "#{idx}. #{r.name}"
+       end
+    end
+
+    def return_details
+      puts "Please enter a valid restaurant number"
+      restaurant = gets.chomp
+        if valid?(restaurant, @restaurant)
+          display_details(restaurant.to_i)
+        else
+          return_details
+        end
+    end
+
+    def display_details(input)
+      r = @restaurant[input-1]
+      
+      puts <<~RESTAURANT
+        Address: #{r.address}
+        Phone number: #{r.phone_number}
+        Website: #{r.url}
+        Rating: #{r.rating} of 5
+        Price Range: #{r.price}
+        Reviews: #{r.reviews}
+        RESTAURANT
+      
+    end
+
+    def valid?(input,array)
+      if input == "end"
+        goodbye
+      end
+       input.to_i.between?(1, array.length)
+    end
+
+    def last_hurrah
+      puts "Would you like to pick another cuisine? Yes or No"
+        if gets.chomp.downcase == "yes"
+          start
+        else
+          goodbye
+        end
+    end
+
+    def goodbye
+      puts "Thanks for visiting Knoxville. Have a nice day."
+      exit
+    end
+end

data/lib/Knox_Restaurants/restaurant.rb

@@ -0,0 +1,36 @@
+class KnoxRestaurants::Restaurant
+    attr_accessor :name, :cuisine, :address, :phone_number, :url, :rating, :price, :reviews
+
+    @@all = []
+
+    #a restaurant has a name, a list of cuisines, an address, a phone number
+    #website, rating, price range, and reviews
+
+    def initialize(restaurant_hash) 
+        #instantiates a Restaurant object with a hash of attributes belong to each instance
+        @name = restaurant_hash[:name]
+        @phone_number = restaurant_hash[:phone_number]
+        @cuisine = restaurant_hash[:cuisine]
+        @address = restaurant_hash[:address]
+        @url = restaurant_hash[:url]
+        @rating = restaurant_hash[:rating]
+        @price = restaurant_hash[:price]
+        @reviews = restaurant_hash[:reviews]
+        @@all << self
+    end
+
+    def self.all
+        @@all
+    end
+
+    def self.get_cuisines 
+        #displays a list of cuisines with no duplicates
+        self.all.collect{|r| r.cuisine}.flatten.uniq
+    end
+
+    def self.get_cuisine_restaurants(num)
+        #compares the user input as an integer to find the cuisine that matches the Restaurant instance
+      cuisine = self.get_cuisines[num-1]
+      rest = self.all.select {|r| r.cuisine.include?(cuisine)}
+    end
+end

data/lib/Knox_Restaurants/version.rb

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

data/lib/environment.rb

@@ -0,0 +1,15 @@
+## You want to require all the files here so when you run bin/knox_restaurants you have access to everything!
+require_relative "./knox_restaurants/version"
+require_relative "./knox_restaurants/cli"
+require_relative "./knox_restaurants/restaurant"
+require_relative "./knox_restaurants/api"
+require "pry"
+require "nokogiri"
+require "open-uri"
+require "httparty"
+
+
+module KnoxRestaurants
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: Knox_Restaurants
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chaya Deaver
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: httparty
+  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'
+- !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: '"Gather user input and use that to correspond to Restaurant objects"'
+email:
+- chayadeaver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Knox_Restaurants.gemspec
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/knox_restaurants
+- bin/setup
+- lib/Knox_Restaurants/api.rb
+- lib/Knox_Restaurants/cli.rb
+- lib/Knox_Restaurants/restaurant.rb
+- lib/Knox_Restaurants/version.rb
+- lib/environment.rb
+homepage: https://rubygems.org/gems/Knox_Restaurants
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://rubygems.org/gems/Knox_Restaurants
+  source_code_uri: https://github.com/chayadeaver/Knox_Restaurants
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: '"Search through Yelp API to gather information about restaurants"'
+test_files: []