allrecipes 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a76845bcdebb9e51e1311fb837910787b0c01311
-  data.tar.gz: e5637481662634979738a7feb2ea3f8c76dc5aa5
+  metadata.gz: 6b3dd5160de805230ec4b7ed3d05d35f68adf0ce
+  data.tar.gz: 8846d5ca90ed3cd8eb82e8d69ac337c2ab27628f
 SHA512:
-  metadata.gz: a7c0db453b9dab2927dd40147c4c3cc8dc2dd57a037400c8dfa63aa6e2a388bcb0496b0c9fa2708d435bd9c4b23cc81f113e5a91f46ff467b367abf365926c93
-  data.tar.gz: ec9fa16ffc9c391ff1facb8b130537431ad993793ede0e1b745eb4220ba0e57fce154fdef9997acd976f96da4a7b46d56b89476600c75538acc2417d5cc7af90
+  metadata.gz: f79cccc2b8d550037f829d2ef516294bbd3271bdf95a7c811399402c53c9bc37ed70692c2cf9c339d0e4f02e923ff598f9f5b901c3041417dda52cb7051e228a
+  data.tar.gz: 12710f1ac3e0bf48d292a1870cf7b02d3b2ac3ce20444894b4b72cbc370339c63c5068eae02a41ab9eba06ca2456f544df386c3bc71ece36d096edb291aeea05

data/README.md

@@ -172,9 +172,9 @@ recipes.page_url("http://allrecipes.com/recipes?Page=7")
       :ingredients =>
         [
           {
-            "quantity" => 1.0,
-            "unit" => "pound", 
-            "name" => "ground beef"
+            :quantity => 1.0,
+            :unit     => "pound", 
+            :name     => "ground beef"
           }
         ],
      :directions => 
@@ -195,9 +195,8 @@ recipes.page_url("http://allrecipes.com/recipes?Page=7")
 1. Option for selecting what keys to return.
 2. Complex search with queries such as multiple ingredients, course, time etc.
 3. Faster test suite
-4. Move ingredients parsing into its own class.
-5. Add nutrional info to results.
-6. Add user photos for recipe to results
-7. Able to get popular recipes of the day. 
+4. Add nutrional info to results.
+5. Add user photos for recipe to results
+6. Able to get popular recipes of the day. 
 
 

data/lib/allrecipes/main.rb

@@ -40,18 +40,18 @@ class Allrecipes
     end
   end
 
-  def recipe_url(url)
+  def recipe_url(url, keys=nil)
     begin
-      RecipeParser.new(url).recipe
+      RecipeParser.new(url, keys).recipe
     rescue Exception
       raise "This page does not contain a recipe"
     end
   end
 
-  def page_url(url)
+  def page_url(url, keys=nil)
     begin
       page = @agent.get(url)
-      PageParser.new(page).recipes
+      PageParser.new(page, { keys: keys }).recipes
     rescue Exception
       raise "This page does not contain recipes"
     end

data/lib/allrecipes/page_parser.rb

@@ -43,7 +43,7 @@ class PageParser
   def get_recipes
     filtered_recipes.each do |info|
       recipe_link = recipe_link(info)
-      @recipes <<  RecipeParser.new(recipe_link).recipe
+      @recipes <<  RecipeParser.new(recipe_link, @options[:keys]).recipe
     end
   end
 

data/lib/allrecipes/recipe_parser.rb

@@ -1,10 +1,13 @@
 class RecipeParser
+  attr_accessor :directions, :recipe
 
-  def initialize(page)
+  def initialize(page, keys=nil)
     @page = request_page(page)
+    @keys = keys
     @directions = []
-    get_ingredients
+    @recipe = {}
     get_directions
+    populate_recipe
   end
 
   def agent
@@ -71,11 +74,11 @@ class RecipeParser
     @page.search("##{type}HoursSpan em")
   end
 
-  def preparation_time
+  def prep_time
     time("prep")
   end
 
-  def cooking_time
+  def cook_time
     time("cook")
   end
 
@@ -93,22 +96,25 @@ class RecipeParser
     end
   end
 
-  def get_ingredients
-    @ingredients = IngredientsParser.new(@page).ingredients
+  def ingredients
+    @ingredients ||= IngredientsParser.new(@page).ingredients
   end
 
-  def recipe
+  def default_keys
+    %w{name image servings ingredients directions rating prep_time cook_time}
+  end
+
+  def sanitized_keys
+    if @keys && @keys.count > 0
+      @keys.select{ |key| default_keys.include?(key) }
+    else
+      default_keys
+    end
+  end
+
+  def populate_recipe
     begin
-      {
-        name: name,
-        image: image,
-        servings: servings,
-        ingredients: @ingredients,
-        directions: @directions,
-        rating: rating,
-        prep_time: preparation_time,
-        cook_time: cooking_time
-      }
+      sanitized_keys.each{ |key| @recipe[key.to_sym] = send(key) }
     rescue
       raise "Error getting recipe"
     end

data/lib/allrecipes/version.rb

@@ -1,3 +1,3 @@
 class Allrecipes
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/spec/allrecipes_spec.rb

@@ -108,7 +108,7 @@ describe Allrecipes do
       end
 
       it "should include a recipe with specified ingredient" do
-        expect(@recipes.first[:ingredients].select{ |ingredient| ingredient["name"].include?("apples") }.count).to eq 1
+        expect(@recipes.first[:ingredients].select{ |ingredient| ingredient[:name].include?("apples") }.count).to eq 1
       end
 
     end
@@ -159,6 +159,22 @@ describe Allrecipes do
         expect(invalid_url).to raise_error("This page does not contain a recipe")
       end
     end
+
+    context "with return keys" do
+      before do
+        VCR.use_cassette "recipe_url_with_keys" do
+          @recipe = subject.recipe_url("http://allrecipes.com/Recipe/Mushrooms-with-a-Soy-Sauce-Glaze", ["name", "servings"])
+        end
+      end
+      it "should return a formatted recipe" do
+        expected_output = {
+          name: @recipe[:name],
+          servings: @recipe[:servings],
+        }
+        expect(@recipe).to eq expected_output
+      end
+    end
+
   end
 
   describe "#page_url" do
@@ -188,5 +204,19 @@ describe Allrecipes do
         expect(invalid_url).to raise_error("This page does not contain recipes")
       end
     end
+    context "with return keys" do
+      before do
+        VCR.use_cassette "page_url_with_keys" do
+          @recipes = subject.page_url("http://allrecipes.com/recipes?st=n&Page=7", ["name", "image"])
+        end
+      end
+      it "should return a formatted recipe" do
+        expected_output = {
+          name: @recipes[0][:name],
+          image: @recipes[0][:image],
+        }
+        expect(@recipes[0]).to eq expected_output
+      end
+    end
   end
 end

data/spec/recipe_parser_spec.rb

@@ -1,55 +1,97 @@
 require 'spec_helper'
 describe RecipeParser do
-  before do
-    VCR.use_cassette "recipe" do
-      url = "http://allrecipes.com/Recipe/Worlds-Best-Lasagna/"
-      @recipe = RecipeParser.new(url).recipe
+  context "without options" do
+    before do
+      VCR.use_cassette "recipe" do
+        url = "http://allrecipes.com/Recipe/Worlds-Best-Lasagna/"
+        @recipe = RecipeParser.new(url).recipe
+      end
     end
-  end
 
-  it "should have the right name" do
-    expect(@recipe[:name]).to eq "World's Best Lasagna"
-  end
+    it "should have the right name" do
+      expect(@recipe[:name]).to eq "World's Best Lasagna"
+    end
 
-  it "should have the right image url" do
-    expect(@recipe[:image]).to eq "http://images.media-allrecipes.com/userphotos/250x250/00/03/24/32427.jpg"
-  end
+    it "should have the right image url" do
+      expect(@recipe[:image]).to eq "http://images.media-allrecipes.com/userphotos/250x250/00/03/24/32427.jpg"
+    end
 
-  it "should have the right amount of servings" do
-    expect(@recipe[:servings]).to eq 12
-  end
+    it "should have the right amount of servings" do
+      expect(@recipe[:servings]).to eq 12
+    end
 
-  it "should have the right rating" do
-    expect(@recipe[:rating]).to eq 5
-  end
+    it "should have the right rating" do
+      expect(@recipe[:rating]).to eq 5
+    end
 
-  it "should have the right prep time" do
-    expect(@recipe[:prep_time]).to eq 30
-  end
+    it "should have the right prep time" do
+      expect(@recipe[:prep_time]).to eq 30
+    end
 
-  it "should have the right cook time" do
-    expect(@recipe[:cook_time]).to eq 150
-  end
+    it "should have the right cook time" do
+      expect(@recipe[:cook_time]).to eq 150
+    end
 
-  it "should have the right amount of ingredients" do
-    expect(@recipe[:ingredients].count).to eq 21
+    it "should have the right amount of ingredients" do
+      expect(@recipe[:ingredients].count).to eq 21
+    end
+
+    it "should have the right amount of directions" do
+      expect(@recipe[:directions].count).to eq 5
+    end
+
+    it "should return a formatted recipe" do
+      expected_output = {
+        name: @recipe[:name],
+        image: @recipe[:image],
+        servings: @recipe[:servings],
+        ingredients: @recipe[:ingredients],
+        directions: @recipe[:directions],
+        rating: @recipe[:rating],
+        prep_time: @recipe[:prep_time],
+        cook_time: @recipe[:cook_time]
+      }
+      expect(@recipe).to eq expected_output
+    end
   end
+  context "with return options" do
+    before do
+      VCR.use_cassette "recipe_with_specific_return" do
+        url = "http://allrecipes.com/Recipe/Worlds-Best-Lasagna/"
+        @recipe = RecipeParser.new(url, ["name", "image", "servings"]).recipe
+      end
+    end
 
-  it "should have the right amount of directions" do
-    expect(@recipe[:directions].count).to eq 5
+    it "should have the return number of keys" do
+      expect(@recipe.keys.count).to eq 3
+    end
+
+    it "should return the correct format" do
+      expected_output = {
+        name: @recipe[:name],
+        image: @recipe[:image],
+        servings: @recipe[:servings],
+      }
+      expect(@recipe).to eq expected_output
+    end
   end
+  context "with invalid return options" do
+    before do
+      VCR.use_cassette "invalid_return" do
+        url = "http://allrecipes.com/Recipe/Worlds-Best-Lasagna/"
+        @recipe = RecipeParser.new(url, ["title", "doesn't exist", "servings"]).recipe
+      end
+    end
 
-  it "should return a formatted recipe" do
-    expected_output = {
-      name: @recipe[:name],
-      image: @recipe[:image],
-      servings: @recipe[:servings],
-      ingredients: @recipe[:ingredients],
-      directions: @recipe[:directions],
-      rating: @recipe[:rating],
-      prep_time: @recipe[:prep_time],
-      cook_time: @recipe[:cook_time]
-    }
-    expect(@recipe).to eq expected_output
+    it "should have the return number of keys" do
+      expect(@recipe.keys.count).to eq 1
+    end
+
+    it "should return the correct format" do
+      expected_output = {
+        servings: @recipe[:servings]
+      }
+      expect(@recipe).to eq expected_output
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allrecipes
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - shivamd