serious-eats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4349d9ea00306a3f8e8cb6a4140ab136fcfd7ccc7da92c96ee7882af24e43250
+  data.tar.gz: 3c904864aff578402cfef3f62b1fc48d6c021e379ba83faccf2e507f1fa2b4f5
+SHA512:
+  metadata.gz: 5eb3b8a52b624e36f6c33e9b6ecc3bd751eab73718a76de6c50854f12c618f84886aad23e6c3d58e38924f976011712eeffbb616ea7d36f1151e5e49bddc3e10
+  data.tar.gz: 6d0eabf4e6754bc948cc6afbc3ad20fb85f1112d696f3ae0d230c873943af35bd98d6a8c4cabdaceac1b0ded8aba6e89f2f42d0f4f6c0b54c82a4d1f135e6c9b

data/.gitignore

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

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 alisa.cookie.mccormick@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"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    serious-eats (0.1.0)
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    method_source (0.9.2)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry
+  rake (~> 10.0)
+  serious-eats!
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alisa Cookie McCormick
+
+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,43 @@
+# SeriousEats
+
+This Ruby Gem provides a CLI to view Serious Eats Recipes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'serious-eats'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serious-eats
+
+## Usage
+
+Type the below and follow the on screen prompts.
+
+    $ serious-eats
+
+## 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/cookiemccormick/serious-eats. 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 SeriousEats project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cookiemccormick/serious-eats/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,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative '../config/environment'
+
+require "irb"
+IRB.start

data/bin/serious-eats

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../config/environment'
+
+SeriousEats::CLI.new.call

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/config/environment.rb

@@ -0,0 +1,8 @@
+require 'nokogiri'
+require 'open-uri'
+require 'colorize'
+
+require_relative '../lib/serious-eats/scraper'
+require_relative '../lib/serious-eats/recipe'
+require_relative '../lib/serious-eats/cli'
+require_relative '../lib/serious-eats/version'

data/lib/serious-eats/cli.rb

@@ -0,0 +1,111 @@
+module SeriousEats
+  class CLI
+    def call
+      puts ""
+      puts "Hello there! Welcome to the Serious Eats Recipes!".colorize(:green).bold
+
+      @scraper = SeriousEats::Scraper.new
+      @scraper.fetch_recipes
+
+      start
+    end
+
+    def start
+      puts ""
+      puts "Please choose a number for the recipe you would like to view: 1-24.".bold
+      puts ""
+
+      display_recipes
+      puts ""
+
+      input = gets.strip.to_i
+
+      if input >= 1 && input <= Recipe.all.count
+        recipe = SeriousEats::Recipe.find(input)
+
+        @scraper.fetch_recipe_data(recipe)
+
+        print_recipe(recipe)
+
+        puts ""
+        puts "Would you like to see another recipe? Please enter Y or N.".bold
+        puts ""
+
+        input = gets.strip.downcase
+
+        if input == "y"
+          puts ""
+          start
+        elsif input == "n"
+          goodbye_message
+        else
+          invalid_message
+        end
+
+      else
+        invalid_message
+      end
+    end
+
+    def invalid_message
+      puts ""
+      puts "PLEASE ENTER A VALID RESPONSE.".colorize(:red).blink
+      start
+    end
+
+    def goodbye_message
+      puts ""
+      puts "Thank you! Goodbye!".bold
+      puts ""
+    end
+
+    def display_recipes
+      SeriousEats::Recipe.all.each_with_index do |recipe, index|
+        puts "#{index + 1}. #{recipe.name}"
+      end
+    end
+
+    def print_recipe(recipe)
+      puts ""
+      puts "#{recipe.name.upcase} - #{recipe.category.upcase}".colorize(:green).bold
+
+      puts ""
+      puts "Description:".bold
+      puts recipe.description.join("\n\n")
+
+      puts ""
+      puts "Portion:".bold
+      puts "#{recipe.portion}"
+      puts ""
+      puts "Active Cooking Time:".bold
+      puts "#{recipe.active_time}"
+      puts ""
+      puts "Total Time:".bold
+      puts "#{recipe.total_time}"
+      puts ""
+
+      if recipe.rating == 0
+        puts "Rating: N/A".bold
+      else
+        puts "Rating out of 5:".bold
+        puts "#{recipe.rating}"
+      end
+
+      puts ""
+      puts "Ingredients:".bold
+      recipe.ingredients.each do |ingredient|
+        puts "#{ingredient}"
+      end
+
+      puts ""
+      puts "Directions:".bold
+      recipe.directions.each_with_index do |direction, index|
+        puts "#{index + 1}. #{direction}"
+      end
+
+      puts ""
+      puts "Website:".bold
+      puts "#{recipe.url}"
+    end
+  end
+end

data/lib/serious-eats/recipe.rb

@@ -0,0 +1,29 @@
+module SeriousEats
+  class Recipe
+    attr_accessor :name
+    attr_accessor :url
+    attr_accessor :category
+
+    attr_accessor :description
+    attr_accessor :portion
+    attr_accessor :active_time
+    attr_accessor :total_time
+    attr_accessor :rating
+    attr_accessor :ingredients
+    attr_accessor :directions
+
+    @@all = []
+
+    def initialize
+      @@all << self
+    end
+
+    def self.all
+      @@all
+    end
+
+    def self.find(id)
+      self.all[id - 1]
+    end
+  end
+end

data/lib/serious-eats/scraper.rb

@@ -0,0 +1,57 @@
+module SeriousEats
+  class Scraper
+    INDEX_URL = "https://www.seriouseats.com/the-food-lab/recipes"
+
+    def parse_url(url)
+      Nokogiri::HTML(open(url))
+    end
+
+    def get_recipes
+      parse_url(INDEX_URL).css("#recipes .module")
+    end
+
+    def get_recipe_data(recipe)
+      parse_url(recipe.url).css("div.recipe-body")
+    end
+
+    def fetch_recipes
+      get_recipes.map do |block|
+        recipe = Recipe.new
+        recipe.name = block.css("h4.title").text.strip
+        recipe.category = block.css("a.category-link").text.strip
+        recipe.url = block.css("a.module__link").attribute("href").value
+        recipe
+      end
+    end
+
+    def fetch_recipe_data(recipe)
+      get_recipe_data(recipe).map do |block|
+        recipe.description = block.css(".recipe-introduction-body p:not(.caption)").map do |description|
+          description.text.strip
+        end.select do |description|
+          # some recipes have some empty <p> tags that need to be filtered out
+          description.length > 0
+        end
+
+        recipe.portion = block.css("span.info.yield").text.strip
+        recipe.active_time = block.css("ul.recipe-about li:nth-child(2) span.info").text.strip
+        recipe.total_time = block.css("ul.recipe-about li:nth-child(3) span.info").text.strip
+        recipe.rating = block.css("span.info.rating-value").text.strip.to_f.round(1)
+
+        recipe.ingredients = block.css("li.ingredient").map do |ingredient|
+          text = ingredient.text.strip
+
+          if ingredient.css("strong").any?
+            text = "\n#{text.underline}"
+          end
+
+          text
+        end
+
+        recipe.directions = block.css(".recipe-procedure-text").map do |direction|
+          direction.text.strip
+        end
+      end
+    end
+  end
+end

data/lib/serious-eats/version.rb

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

data/serious-eats.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "serious-eats/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "serious-eats"
+  spec.version       = SeriousEats::VERSION
+  spec.authors       = ["Alisa Cookie McCormick"]
+  spec.email         = ["alisa.cookie.mccormick@gmail.com"]
+
+  spec.summary       = %q{Serious Eats Recipe Scraper}
+  spec.homepage      = "https://github.com/cookiemccormick/serious-eats"
+  spec.license       = "MIT"
+
+  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         = 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   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "nokogiri"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: serious-eats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alisa Cookie McCormick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-06 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: 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: 
+email:
+- alisa.cookie.mccormick@gmail.com
+executables:
+- console
+- serious-eats
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/serious-eats
+- bin/setup
+- config/environment.rb
+- lib/serious-eats/cli.rb
+- lib/serious-eats/recipe.rb
+- lib/serious-eats/scraper.rb
+- lib/serious-eats/version.rb
+- serious-eats.gemspec
+homepage: https://github.com/cookiemccormick/serious-eats
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Serious Eats Recipe Scraper
+test_files: []