popular-recipes 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63e8ed2cb2bdeb71ef54ce1da992300c6d0bb1744f0f71b5f5d60ce2dc57ff3c
+  data.tar.gz: 1f6c6c3327800c873e3c588a5b495f247a21beac78d963d433371293a1b18a32
+SHA512:
+  metadata.gz: 34c903d424e68a144b2789dee2a26fb61b351a6e3abc3c723e2f68155afe43f1a8c9ac1402005e8474bcfd4495f014dae11fdbb3c9acbfa696ac091d35c54aab
+  data.tar.gz: a5a3d2a6bd61a36166723b83a14be901364e35cb044edd7cb3464b5dc952bbf265592dbadf44b8a7842bb7e434a92c193ddbea3223772038fab5b186b424f891

data/.gitignore

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

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 'jonhong777@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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in popular_recipes.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    popular-recipes (0.1.1)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  popular-recipes!
+  pry
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 'Jonathan Hong'
+
+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,40 @@
+# PopularRecipes
+A command line interface gem that lists 25 popular recipes from Genius Kitchen. Be able to view each item in list form by name, and see all the details of an individual recipe.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'popular-recipes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install popular-recipes
+
+## Usage
+
+Run popular-recipes after installing the gem.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/hejeong/popular-recipes-cli-app. 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 PopularRecipes project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hejeong/popular-recipes-cli-app/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/environment'
+
+PopularRecipes::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/config/environment.rb

@@ -0,0 +1,6 @@
+require "nokogiri"
+require 'open-uri'
+require_relative "../lib/version"
+require_relative "../lib/cli"
+require_relative "../lib/recipe"
+require_relative "../lib/scraper"

data/lib/cli.rb

@@ -0,0 +1,98 @@
+class PopularRecipes::CLI
+  # calls all necessary methods for CLI to run
+  def call
+    create_recipes
+    welcome
+    list_input = gets.strip
+    list_recipes(list_input)
+    input = nil
+    while input != 'exit'
+      input = gets.strip
+      if input.length > 0 && input.length <= 2 && input.match("[0-9]+")
+        get_info(input)
+      else
+        list_recipes(input)
+      end
+    end
+  end
+
+  private
+
+  # create recipe instances and all necessary attributes
+  def create_recipes
+    # new scraper instance
+    scraper = PopularRecipes::RecipeScraper.new
+    # grab name and url attributes
+    new_attributes = scraper.scrape_list_page
+    # create new instances of recipes and save them
+    PopularRecipes::Recipe.create(new_attributes)
+    # use the urls of each instance and scrape all the other information and update the attributes
+    PopularRecipes::Recipe.all.each do |recipe|
+      additional_attr = scraper.scrape_recipe_page(recipe.url)
+      recipe.add_attributes(additional_attr)
+    end
+  end
+
+  # display all information about a recipe
+  def get_info(number)
+    index = number.to_i - 1
+    item = PopularRecipes::Recipe.all[index]
+    puts "-----------------------------------------------------------------------------------------------------------------------------------------------------"
+      puts "[#{item.name}] by #{item.author}"
+      puts "Servings: #{item.yield}   Total time: #{item.total_time}     Rating: #{item.rating}"
+      puts "Ingredients:"
+      item.ingredients.each do |ingredient|
+        puts "  ~ #{ingredient}"
+      end
+      puts "Directions:"
+      item.directions.each do |direct|
+        puts "~ #{direct}"
+      end
+    puts "-----------------------------------------------------------------------------------------------------------------------------------------------------"
+    puts "If you want to see another list, enter the range (1-5) (6-10) (11-15) (16-20) (21-25) To quit, type exit."
+  end
+
+  # output a numbered list of the recipe names
+  def list_recipes(list_input)
+    puts
+    puts
+    puts
+    recipes = PopularRecipes::Recipe.all
+    if list_input.length > 2 && list_input != "exit"
+      puts "----------------------Recipes #{list_input}---------------------------"
+      case list_input
+      when "1-5"
+        recipe(0,recipes)
+      when "6-10"
+        recipe(5,recipes)
+      when "11-15"
+        recipe(10,recipes)
+      when "16-20"
+        recipe(15,recipes)
+      when "21-25"
+        recipe(20,recipes)
+      end
+      puts "-------------------------------------------------------------"
+      puts "If you want to learn more about a recipe, enter the corresponding number."
+      puts "Otherwise, if you want to see another list, enter the range (1-5) (6-10) (11-15) (16-20) (21-25)"
+      puts "To quit, type exit."
+    end
+  end
+
+  # prints each recipe by name 5 at a time
+  def recipe(start_index, array)
+    5.times do
+      puts "#{start_index + 1}. #{array[start_index].name}"
+      start_index += 1
+    end
+  end
+
+  # welcome message
+  def welcome
+    puts
+    puts
+    puts "Welcome to 25 Popular Recipes!"
+    puts "The recipes will be listed 5 at a time, and you'll be given the option to learn more about the recipe."
+    puts "Which recipes would you like to see? (1-5) (6-10) (11-15) (16-20) (21-25)"
+  end
+end

data/lib/recipe.rb

@@ -0,0 +1,42 @@
+class PopularRecipes::Recipe
+  # <-- class variable
+  @@all = []
+
+  # attribute accessors
+  attr_accessor :name, :url, :total_time, :yield, :author, :rating, :ingredients, :directions
+
+  # <-- constructors
+  def initialize(attribute_hash)
+    attribute_hash.each do |attribute, value|
+      self.send("#{attribute}=", value)
+    end
+    self.save
+  end
+
+  # attribute_hash is an array of hashes that contain the attributes + values of a recipe
+  def self.create(array_of_hashes)
+    array_of_hashes.each do |recipe|
+      PopularRecipes::Recipe.new(recipe)
+    end
+  end
+
+
+  # <--instance methods
+
+  # add any additional attributes to an existing instance
+  def add_attributes(attribute_hash)
+    attribute_hash.each do |attribute, value|
+      self.send("#{attribute}=", value)
+    end
+  end
+
+  # save to class variable
+  def save
+    @@all << self
+  end
+
+  # return array of all instances of this class
+  def self.all
+    @@all
+  end
+end

data/lib/scraper.rb

@@ -0,0 +1,56 @@
+require 'pry'
+class PopularRecipes::RecipeScraper
+
+  # returns HTML in nested nodes
+  def get_page(url)
+    Nokogiri::HTML(open(url))
+  end
+
+  # scrapes from index page
+  def scrape_list_page
+    doc = get_page("http://www.geniuskitchen.com/ideas/all-time-favorite-recipes-6365?c=24106")
+    index_card = doc.css('div.smart-info div.smart-info-wrap')
+    recipes = []
+    index_card.each do |card|
+      recipes << {
+        :name => card.css('h2.title a').text.gsub(/#[0-9]*:\s/, ""),
+        :url => card.css('h2.title a').attribute('href').value
+      }
+    end
+    recipes
+  end
+
+  # scrapes from recipe page
+  def scrape_recipe_page(url)
+    doc = get_page(url)
+
+    # fetch ingredients into proper formatting and add into array
+    ingredients = []
+    ingredient_wrapper = doc.css('ul.ingredient-list li')
+    ingredient_wrapper.each do |element|
+      quantity = element.css('span.qty').text
+      food = element.css('span.food').text
+      text = quantity.ljust(7) + food.strip
+      ingredients << text
+    end
+
+    # fetch directions and input into directions array
+    directions = []
+    directions_wrapper = doc.css('div.directions-inner.container-xs ol li')
+    directions_wrapper.each do |element|
+      directions << element.text
+    end
+    # last element is just an empty space
+    directions.pop
+
+    # apply all scraped elements into a hash=>key to be used to build a recipe object
+    {
+      :author => doc.css('div.rating-and-author h6.byline a').first.text,
+      :total_time => doc.css('table.recipe-facts.servings_unit tbody tr td.time').text.gsub(/\n/,"").gsub(/\s/,"").gsub(/READYIN:/,""),
+      :yield => doc.css('td.servings a span').text,
+      :rating => doc.css('div.five-star span.sr-only').text,
+      :ingredients => ingredients,
+      :directions => directions
+    }
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module PopularRecipes
+  VERSION = "0.1.2"
+end

data/popular-recipes.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "popular-recipes"
+  spec.version       = PopularRecipes::VERSION
+  spec.authors       = ["'Jonathan Hong'"]
+  spec.email         = ["'jonhong777@gmail.com'"]
+
+  spec.summary       = %q{List 25 popular recipes}
+  spec.description   = %q{25 Most-Saved Recipes scraped from Genius Kitchen. You can view an ordered list of recipes, with the option to read the full recipe.}
+  spec.homepage      = "https://github.com/hejeong/popular-recipes-cli-app"
+  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
+
+  # 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        = "bin"
+  spec.executables   = "popular-recipes"
+  spec.require_paths = ["lib","config"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "nokogiri", "~> 1.8"
+end

data/spec.md

@@ -0,0 +1,11 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application
+  # Welcome message, list view, recipe view, exit
+- [x] Pull data from an external source
+  # pulled out recipe names and urls from an index page and the details of the recipe from the recipe page
+  # all information scraped from Genius Kitchen
+- [x] Implement both list and detail views
+  # ordered list of recipe names
+  # individual recipe view (will need to scroll up)

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: popular-recipes
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- "'Jonathan Hong'"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-02 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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 25 Most-Saved Recipes scraped from Genius Kitchen. You can view an ordered
+  list of recipes, with the option to read the full recipe.
+email:
+- "'jonhong777@gmail.com'"
+executables:
+- popular-recipes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/popular-recipes
+- bin/setup
+- config/environment.rb
+- lib/cli.rb
+- lib/recipe.rb
+- lib/scraper.rb
+- lib/version.rb
+- popular-recipes.gemspec
+- spec.md
+homepage: https://github.com/hejeong/popular-recipes-cli-app
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- config
+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.7
+signing_key: 
+specification_version: 4
+summary: List 25 popular recipes
+test_files: []