just-the-recipe 0.8.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63f604274dbc6fe5a52f6fd282504004ec38789d372eab2d9e43cb4ce241488e
-  data.tar.gz: 884670ff3ea3ada5961883b9e9244842c4babf8a85f77fee72acc46f98e3570e
+  metadata.gz: bb79f03d347799387c574b7f113c84487a15b5b60ac4ec608a8b12266d97cae1
+  data.tar.gz: 860281d233fc35e9d24fc93e3025e22654e17906a8e3d7446cd9464d126488dc
 SHA512:
-  metadata.gz: 85ed08a56d918a4517dfad4eae136f934c65799ed046412abc5c768b71c44b5591e3f41502adb1ad9b4092188eb35daac76dd4ac974233e51f2bbeb9d9eb3c2c
-  data.tar.gz: be930def30c30da9c0104e247d3389f5a241925329f4a024e1327982aa9d4e2f73d24ade2b9fa885287706cf5f37c3c2901b9f2ce372f66343588a5fb130b046
+  metadata.gz: 90b3770b96f0ef788d630594738de8713fd64e1fbc1c0c434642c7f30a3a7447c6304dd1fb5adaf18c440ba6453f26b801ec65675a115ec6d1fc2f92e12b1dd4
+  data.tar.gz: 28549e2bf2c4978b750efe1750d059c1704ee6fe96310ab5834fd542c5b590b8c31c04650ddece24d2414642e577badf3743c2e686f346e9afe4156f28deb4f1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    just-the-recipe (0.8.0)
+    just-the-recipe (0.13.0)
       dotenv
       nokogiri
       open-uri

data/README.md

@@ -1,33 +1,56 @@
-# Just::The::Recipe
+# Just The Recipe
 
-## Installation
+This app allows you to search for recipes on the web, and add them to different cookbooks that you create. The cookbooks are saved as text files so that you can return to them when you're not using the app. 
 
-Add this line to your application's Gemfile:
+The app uses a combination of the Edamam API (to search for recipes) and a URL scraper that allows you to input recipe URLs so that you can strip out "Just the Recipe".
 
-```ruby gem 'just-the-recipe'
-```
+Your cookbooks are re-instantiated when you enter the app again so you can continue adding to them over time.
 
-And then execute:
+# Installation
 
+Because we save your cookbooks as text files, its best to have this app live in its own repository. Clone down this git repository and then use bundle to install the dependencies:
+
+    $ git clone https://github.com/george-dilthey/just-the-recipe.git
     $ bundle install
 
-Or install it yourself as:
+# Usage
+
+## API Access
+
+To use this gem, you'll need to obtain a free APP ID and APP Key from https://www.edamam.com. Once you have these, create a `.env` file and add these lines at the top:
+
+    APP_ID = {YOUR APP ID}
+    APP_KEY = {YOUR APP KEY}
+
+Alternatively, you can call `JustTheRecipe.authorize({YOUR APP ID}, {YOUR APP KEY})` before making any other calls, but this will need to be done every time you re-enter the app.
+
+## Running the app
+
+Run the app by running the bin file `just-the-recipe`.
+    
+    $ bin/just-the-recipe
+
+If you get a permission denied error, run this to give the bin file run permissions:
 
-    $ gem install just-the-recipe
+    $ chmod +x bin/just-the-recipe
 
-## Usage
+Alternatively, you can call the `JustTheRecipe::CLI.new.call` method.
 
-To use this gem, you'll need to obtain a free APP ID and APP Key from https://www.edamam.com. Once you have these, create a dotenv file and add these lines at the top:
+# Supported Websites
 
-APP_ID = {{APP ID}}
-APP_KEY = {{APP KEY}}
+Both the search function and the scrape function rely on scraping a website's [recipe schema](https://schema.org/Recipe). Any website that has properly implemented this schema should be scrapable, but these sites have been tested specifically.
 
-## 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.
+* https://www.allrecipes.com
+* https://food52.com
+* https://www.seriouseats.com
+* https://www.marthastewart.com
+* https://www.chowhound.com
+* https://getmecooking.com
+* https://blog.bigoven.com
+* https://www.vegrecipesofindia.com
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
+# Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/george-dilthey/just-the-recipe.

data/bin/just-the-recipe

@@ -2,4 +2,4 @@
 require "bundler/setup"
 require './lib/just-the-recipe.rb'
 
-JustTheRecipe::CLI.new.call
+JustTheRecipe::CLI.new.call 

data/lib/just-the-recipe/cli.rb

@@ -1,5 +1,3 @@
-require './lib/just-the-recipe.rb'
-
 class JustTheRecipe::CLI
 
     def call
@@ -69,13 +67,13 @@ class JustTheRecipe::CLI
             puts "Here's what's in the cookbook called #{input}:" 
             puts JustTheRecipe::Cookbook.find_by_name(input).return_cookbook
             main_menu
-        elsif input == "Create a new cookbook"
+        elsif input == "Create a new cookbook."
             create_cookbook
             main_menu
         elsif input == "Delete a cookbook."
             cookbooks_delete = JustTheRecipe::Cookbook.list_cookbooks << "Exit"
-            delete = prompt.select("Which cookbook would you like to delete? WARNING: THIS CANNOT BE UNDONE!", cookbooks_create)  
-            JustTheRecipe::Cookbook.delete(delete)
+            name = prompt.select("Which cookbook would you like to delete? WARNING: THIS CANNOT BE UNDONE!", cookbooks_delete)  
+            JustTheRecipe::Cookbook.find_by_name(name).delete_cookbook
             puts "Ok, we deleted that cookbook."
             main_menu
         elsif input == "Main Menu"
@@ -140,6 +138,4 @@ class JustTheRecipe::CLI
         puts "\n\nThanks for stopping by! If you created any cookbooks, they'll be saved as text files so that you can continue using them in the future. See you soon!"
     end
 
-    
-
 end

data/lib/just-the-recipe/cookbook.rb

@@ -1,5 +1,3 @@
-require './lib/just-the-recipe.rb'
-
 class JustTheRecipe::Cookbook
 
     attr_accessor :name
@@ -41,22 +39,15 @@ class JustTheRecipe::Cookbook
     end
 
     def self.list_cookbooks
-        cookbooks = []
-        @@all.each{|i| cookbooks << i.name}
-        cookbooks
+        @@all.map{|i| i.name}
     end 
     
     def return_cookbook
-        File.read("#{self.name}.txt")
+        File.read("#{@name}.txt")
     end
 
-    def self.delete(name)
-        if find_by_name(name) 
-            @@all.delete(find_by_name(name))
-            File.delete("#{name}.txt")
-        end
+    def delete_cookbook
+        @@all.delete(self)
+        File.delete("#{@name}.txt")
     end
 end
-
-# gd_cookbook = JustTheRecipe::Cookbook.new("George's Cookbook")
-# binding.pry

data/lib/just-the-recipe/recipe.rb

@@ -1,5 +1,3 @@
-require './lib/just-the-recipe.rb'
-
 class JustTheRecipe::Recipe
 
     attr_accessor :title, :description, :ingredients, :steps, :url, :cookbook
@@ -47,25 +45,7 @@ class JustTheRecipe::Recipe
         self.cookbook.write_recipe_to_cookbook(self) 
     end
 
-    def self.display_cookbook
-        if @@all.length > 0
-            @@all.each {|r| 
-                r.display_recipe
-            }
-        else 
-            puts "You don't have anything in your cookbook!"
-        end
-    end
-
-    # def save_to_cookbook(cookbook_name)
-    #     File.write("#{cookbook_name}.txt", self.return_recipe, mode: "a")
-    # end
-
 end
 
-# new_recipe = JustTheRecipe::Recipe.new('cookies', 'delicious cookies', ['chocolate chips', 'flour'],['make cookie batter', 'cook cookies'], "www.google.com")
-# new_recipe.add_to_cookbook("George's Cookbook")
-# binding.pry
-
 
 

data/lib/just-the-recipe/scraper.rb

@@ -1,5 +1,3 @@
-require './lib/just-the-recipe.rb'
-
 class JustTheRecipe::Scraper
 
     attr_accessor :url
@@ -14,6 +12,7 @@ class JustTheRecipe::Scraper
         schema.key?("name") ? title = schema["name"] : nil
         schema.key?("description") ? description = schema["description"] : nil
         schema.key?("recipeIngredient") ? ingredients = schema["recipeIngredient"] : ingredients = []
+
         if schema.key?("recipeInstructions") 
             if schema["recipeInstructions"][0].class == Hash && schema["recipeInstructions"][0].key?("itemListElement")
                 steps = schema["recipeInstructions"].map {|section| section["itemListElement"].map {|instruction| instruction["text"].gsub("\n","")}}.flatten
@@ -27,6 +26,7 @@ class JustTheRecipe::Scraper
         else 
             steps = [] 
         end
+
         create_new_recipe(title,description,ingredients,steps, @url)
     end
 
@@ -67,20 +67,8 @@ class JustTheRecipe::Scraper
         rescue
             false          
         end
-    
     end
 
 end
 
-# veg = JustTheRecipe::Scraper.new('https://www.vegrecipesofindia.com/eggless-chocolate-chip-muffins-recipe/').get_recipe_by_schema.display_recipe
-# all_recipe = JustTheRecipe::Scraper.new('https://www.allrecipes.com/recipe/10813/best-chocolate-chip-cookies/').get_recipe_by_schema.display_recipe
-# serious = JustTheRecipe::Scraper.new('https://www.seriouseats.com/recipes/2021/03/orecchiette-con-le-cime-di-rapa.html').get_recipe_by_schema.display_recipe
-# get = JustTheRecipe::Scraper.new('https://getmecooking.com/recipes/gambas-al-ajillo-con-setas/').get_recipe_by_schema.display_recipe
-# big = JustTheRecipe::Scraper.new('https://blog.bigoven.com/category/bigoven-tips/page/15/').get_recipe_by_schema.display_recipe
-# martha = JustTheRecipe::Scraper.new('https://www.marthastewart.com/1511143/potato-galettes').get_recipe_by_schema.display_recipe
-# food52 = JustTheRecipe::Scraper.new('https://food52.com/recipes/2250-potatoe-chipotle-tacos').get_recipe_by_schema.display_recipe
-# chowhound = JustTheRecipe::Scraper.new('https://www.chowhound.com/recipes/tomato-pie-31670').get_recipe_by_schema.display_recipe
-# food52part2 = JustTheRecipe::Scraper.new('https://food52.com/recipes/10168-sugar-pie').get_recipe_by_schema.display_recipe
-# all_recipe.display_recipe
-
 

data/lib/just-the-recipe/searcher.rb

@@ -1,17 +1,17 @@
-require './lib/just-the-recipe.rb'
-
 class JustTheRecipe::Searcher
 
     def initialize(search_term)
         @search_term = search_term
     end
 
+
+
     def api_get
         begin    
             base = 'https://api.edamam.com/search'
             q = @search_term
-            app_id = ENV["APP_ID"]
-            app_key = ENV["APP_KEY"]
+            app_id = JustTheRecipe.app_id
+            app_key = JustTheRecipe.app_key
 
             url = "#{base}?q=#{q}&app_id=#{app_id}&app_key=#{app_key}"
             uri = URI.parse(url)
@@ -31,7 +31,7 @@ class JustTheRecipe::Searcher
             end
             scrape_recipe(good_url)
         rescue
-            puts "Sorry we couldn't find a valid recipe with that search term."
+            puts "\nSorry we couldn't find a valid recipe with that search term. Make sure you've added in your API credentials, or try a different search term."
         end
         
     end
@@ -40,7 +40,4 @@ class JustTheRecipe::Searcher
         JustTheRecipe::Scraper.new(url).get_recipe_by_schema
     end
 
-end
-
-
-# JustTheRecipe::Searcher.new('pie').api_get
+end

data/lib/just-the-recipe/version.rb

@@ -1,3 +1,19 @@
 module JustTheRecipe
-    VERSION = "0.8.0"
+    VERSION = "0.13.0"
+
+    @@app_id = ENV["APP_ID"]
+    @@app_key = ENV["APP_KEY"]
+
+    def self.authorize(app_id, app_key)
+        @@app_id = app_id
+        @@app_key = app_key
+    end
+
+    def self.app_id
+        @@app_id
+    end
+
+    def self.app_key
+        @@app_key
+    end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: just-the-recipe
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.13.0
 platform: ruby
 authors:
 - George Dilthey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open-uri
@@ -87,7 +87,6 @@ files:
 - bin/setup
 - just-the-recipe.gemspec
 - lib/just-the-recipe.rb
-- lib/just-the-recipe/authenticate.rb
 - lib/just-the-recipe/cli.rb
 - lib/just-the-recipe/cookbook.rb
 - lib/just-the-recipe/recipe.rb

data/lib/just-the-recipe/authenticate.rb

@@ -1,11 +0,0 @@
-
-class Authenticate
-    
-    def initialize(app_id, app_key)
-        @app_id, @app_key = app_id, app_key
-        File.write(".env", "APP_ID = #{app_id.to_s}\nAPP_KEY = #{app_key.to_s}")
-    end
-
-end
-
-Authenticate.new('6d8b7767', 'e1633ded1da9906633b79ec6c8525ac5')