todays_top_desserts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7a622167bd9b5451488b4e33d4c72a668f27bfd8370fe06723eef908aeabbba
+  data.tar.gz: 79493fffc756620934ab0adbba32aeccebafbde52832f8184b275a71eb89192d
+SHA512:
+  metadata.gz: 18512ccfeb3d2e0026e0ae91e277a603979cb3755f8d4b8df3e03dc254a745762a78a1a45cf2e97ee92d0d7ebe8567062374b5685ac6aef32802578246e6c6d9
+  data.tar.gz: 20d92d9452681b5dba405230ed3e9d47261dc79ab7e4848b661089e2e85750c7060a0099448b9b46ee0d714fbf3fe253bb64493626f5a725192bd0dcb9931e23

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.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 <github email address>. 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 todays_top_desserts.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    todays_top_desserts (0.1.0)
+      nokogiri (~> 1.8.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.4.2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  colorize
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  todays_top_desserts!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 <github username>
+
+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/NOTES.md

@@ -0,0 +1,37 @@
+Here are today's most made desserts from Allrecipes:
+1. Dessert name 1
+2. Dessert name 2
+3. Dessert name 3
+4. Dessert name 4
+5. Dessert name 5
+6. Dessert name 6
+7. Dessert name 7
+8. Dessert name 8
+9. Dessert name 9
+10. Dessert name 10
+
+Which recipe would you like to see? (Enter the corresponding number 1 through 10.)
+
+Here is the recipe:
+ 
+Name
+
+Ingredients:
+#list of ingredients
+
+Instructions:
+#recipe instructions
+
+
+What is a recipe?
+a recipe has a name
+a recipe has an author
+a recipe has a description
+a recipe has a serving size
+a recipe has a prep time
+a recipe has a cook time
+a recipe has a ready in time
+a recipe has a calorie count
+a recipe has ingredients
+a recipe has instructions
+a recipe has a URL

data/README.md

@@ -0,0 +1,43 @@
+# TodaysTopDesserts
+
+This Ruby gem installs a CLI that gives you the recipes for the top ten desserts being made today according to Allrecipes.com.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'todays_top_desserts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install todays_top_desserts
+
+## Usage
+
+Run the CLI by entering in the following line:
+
+    $ todays-top-desserts
+
+## 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/<github username>/todays_top_desserts. 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 TodaysTopDesserts project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/<github username>/todays_top_desserts/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 "todays_top_desserts"
+
+# 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/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/bin/todays-top-desserts

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "todays_top_desserts"
+
+TodaysTopDesserts::CLI.new.call

data/lib/todays_top_desserts/cli.rb

@@ -0,0 +1,82 @@
+class TodaysTopDesserts::CLI
+
+  def call
+    create_recipes
+    add_attributes_to_recipes
+    list_desserts
+    menu
+    goodbye
+  end
+
+  def create_recipes
+    #scrapes name and url of recipes
+    recipes_array = TodaysTopDesserts::Scraper.scrape_desserts
+
+    #creates recipes using the array from the scrape_desserts method
+    TodaysTopDesserts::Recipe.create_from_collection(recipes_array)
+  end
+
+  def add_attributes_to_recipes
+    #scrapes additional attributes from the individual recipe's page and adds the attributes to the Recipe
+    TodaysTopDesserts::Recipe.today.each do |recipe|
+      attributes = TodaysTopDesserts::Scraper.scrape_recipe(recipe.url)
+      recipe.add_recipe_attributes(attributes)
+    end
+  end
+
+  def list_desserts
+    puts ""
+    puts "Here are today's most made desserts:"
+    puts ""
+    @recipes = TodaysTopDesserts::Recipe.today
+    @recipes.each.with_index(1) do |recipe, i|
+      puts "#{i}.".colorize(:light_black) + " #{recipe.name}"
+    end
+
+  end
+
+  def menu
+    input = nil
+    while input != "exit"
+      puts ""
+      puts "Please enter either the number of the recipe you'd like to view, 'list' to see the list of recipes again, or 'exit' to close the program:"
+      input = gets.strip.downcase
+      if input.to_i > 0 && input.to_i < 11
+        the_recipe = @recipes[input.to_i-1]
+        puts ""
+        puts "#{the_recipe.name}".colorize(:cyan).bold
+        puts "by #{the_recipe.author}" if the_recipe.author != ""
+        puts ""
+        puts "#{the_recipe.description}".italic if the_recipe.description != ""
+        puts ""
+        puts "Ready in: ".colorize(:light_black) + "#{the_recipe.ready_time}" if the_recipe.ready_time != ""
+        puts "Prep time: ".colorize(:light_black) + "#{the_recipe.prep_time}" if the_recipe.prep_time != ""
+        puts "Cook time: ".colorize(:light_black) + "#{the_recipe.cook_time}" if the_recipe.cook_time != ""
+        puts "Serving size: ".colorize(:light_black) + "#{the_recipe.serving_size}" if the_recipe.serving_size != ""
+        puts "Calorie count: ".colorize(:light_black) + "#{the_recipe.calorie_count}" if the_recipe.calorie_count != ""
+        puts ""
+        puts "INGREDIENTS:".colorize(:light_red).underline
+        the_recipe.ingredients.each do |ingredient|
+          puts "#{ingredient}"
+        end
+        puts ""
+        puts "INSTRUCTIONS:".colorize(:light_red).underline
+        the_recipe.instructions.each.with_index(1) do |instruction, i|
+          puts "#{i}.".colorize(:light_black) + " #{instruction}"
+        end
+      elsif input == "list"
+        list_desserts
+      elsif input == "exit"
+      else
+        puts ""
+        puts "Not sure what you meant by that."
+      end
+    end
+  end
+
+  def goodbye
+    puts ""
+    puts "Hope you bake something delicious today! See you later!"
+  end
+
+end

data/lib/todays_top_desserts/recipe.rb

@@ -0,0 +1,29 @@
+class TodaysTopDesserts::Recipe
+  attr_accessor :name, :author, :description, :serving_size, :prep_time, :cook_time, :ready_time, :calorie_count, :ingredients, :instructions, :url
+
+  @@all = []
+
+  def initialize(recipe_hash)
+    #initializes new recipe with a hash of attributes
+    recipe_hash.each {|key, value| self.send(("#{key}="), value)}
+    @@all << self
+  end
+
+  def self.create_from_collection(recipes_array)
+    #creates new recipes from an array of hashes that include recipe attributes
+    recipes_array.each do |hash|
+      recipe = TodaysTopDesserts::Recipe.new(hash)
+    end
+  end
+
+  def add_recipe_attributes(attributes_hash)
+    #adds attributes to existing recipes
+    attributes_hash.each {|key, value| self.send(("#{key}="), value)}
+    self
+  end
+
+  def self.today
+    #returns all instances of TodaysTopDesserts::Recipe
+    @@all
+  end
+end

data/lib/todays_top_desserts/scraper.rb

@@ -0,0 +1,48 @@
+class TodaysTopDesserts::Scraper
+
+  def self.scrape_desserts
+    #returns an array of recipes with a name and url.
+    page = Nokogiri::HTML(open("https://www.allrecipes.com/recipes/79/desserts/"))
+
+    desserts = []
+
+    page.css("article.list-recipes")[0].css("li")[0..9].each do |dessert|
+        desserts << {
+          :name => dessert.css("img").attr("title").text,
+          :url => dessert.css("a").attr("href").value
+        }
+    end
+
+    desserts
+
+  end
+
+  def self.scrape_recipe(recipe_url)
+    #returns a hash of recipe attributes
+    page = Nokogiri::HTML(open(recipe_url))
+
+    recipe = {}
+
+    recipe[:author] = page.css(".submitter__name").text.strip
+    recipe[:description] = page.css(".submitter__description").text.strip
+    recipe[:serving_size] = page.css("#metaRecipeServings").attr("content").value
+    recipe[:prep_time] = page.css("time[itemprop='prepTime']").text.strip
+    recipe[:cook_time] = page.css("time[itemprop='cookTime']").text.strip
+    recipe[:ready_time] = page.css("time[itemprop='totalTime']").text.strip
+    recipe[:calorie_count] = page.css(".calorie-count").text.strip
+
+    recipe[:ingredients] = []
+    page.css("span[itemprop='ingredients']").each do |ingredient|
+      recipe[:ingredients] << ingredient.text.strip
+    end
+
+    recipe[:instructions] = []
+    page.css("ol[itemprop='recipeInstructions'] span.recipe-directions__list--item").each do |instruction|
+      recipe[:instructions] << instruction.text.strip
+    end
+
+    recipe
+
+  end
+
+end

data/lib/todays_top_desserts/version.rb

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

data/lib/todays_top_desserts.rb

@@ -0,0 +1,9 @@
+require 'open-uri'
+require 'nokogiri'
+require 'colorize'
+require 'pry'
+
+require_relative "todays_top_desserts/version"
+require_relative "todays_top_desserts/recipe"
+require_relative "todays_top_desserts/cli"
+require_relative "todays_top_desserts/scraper"

data/spec.md

@@ -0,0 +1,9 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application
+      - CLI class allows for user to talk to the application and obtain recipes from a top ten list.
+- [x] Pull data from an external source
+      - Pulls data from allrecipes.com.
+- [x] Implement both list and detail views
+      - Provides a list of the top ten desserts from Allrecipes, then allows the user to select a dessert to view the full recipe. 

data/todays_top_desserts.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "todays_top_desserts/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "todays_top_desserts"
+  spec.version       = TodaysTopDesserts::VERSION
+  spec.authors       = ["krystlebarnes"]
+  spec.email         = ["krystlecbarnes@gmail.com"]
+
+  spec.summary       = %q{Find the recipes for today's top desserts.}
+  spec.description   = %q{This Ruby gem installs a CLI that gives you the recipes for the top ten desserts being made today according to Allrecipes.com.}
+  spec.homepage      = "https://github.com/krystlebarnes/todays-top-desserts-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"] = '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 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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "colorize"
+
+  spec.add_dependency "nokogiri", "~> 1.8.2"
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: todays_top_desserts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- krystlebarnes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-03 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: 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: colorize
+  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: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+description: This Ruby gem installs a CLI that gives you the recipes for the top ten
+  desserts being made today according to Allrecipes.com.
+email:
+- krystlecbarnes@gmail.com
+executables:
+- console
+- setup
+- todays-top-desserts
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- NOTES.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/todays-top-desserts
+- lib/todays_top_desserts.rb
+- lib/todays_top_desserts/cli.rb
+- lib/todays_top_desserts/recipe.rb
+- lib/todays_top_desserts/scraper.rb
+- lib/todays_top_desserts/version.rb
+- spec.md
+- todays_top_desserts.gemspec
+homepage: https://github.com/krystlebarnes/todays-top-desserts-cli-app
+licenses:
+- MIT
+metadata: {}
+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.3
+signing_key: 
+specification_version: 4
+summary: Find the recipes for today's top desserts.
+test_files: []