tychus 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb7646d41e612da74f91b9fd838925f632fe1621
+  data.tar.gz: 45b6939c694f5a9221bc3be47accc4cd966eae0f
+SHA512:
+  metadata.gz: 68ed88a988f294e3880b9ed7ad4ae9813fe89da7eac26979ef3a7ffb0209345a89d98fd011d17e513ec445a8529b631e4f25f50828be5c7b96664c8f45228f64
+  data.tar.gz: 7860d9a43959274dd1aadf56a1b67335a3900f3c4d74a872c49e8063a84df2704d889064447e0c090d6b32611bf9b0c35ec219677b826c22c2f1273ee7d91a4c

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tychus.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Wayne Yang
+
+MIT License
+
+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,49 @@
+# Tychus
+
+Recipe parser supporting microformats for:
+
+  * [Schema.org/Recipe](https://support.google.com/webmasters/answer/173379?hl=en)
+
+Compatible with:
+  
+  * [Allrecipes](http://allrecipes.com)
+  * [Food Network](http://www.foodnetwork.com)
+  * [Kraft Recipes](http://www.kraftrecipes.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tychus'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tychus
+
+## Usage
+
+```
+'require tychus'   
+recipe = Tychus.parse('http://allrecipes.com/Recipe/Chicken-Pot-Pie-IX/Detail.aspx?soid=recs_recipe_2')
+
+recipe.name
+=> "Chicken Pot Pie IX"
+recipe.author
+=> "Robbie Rice"
+recipe.description
+=> "\"A delicious chicken pie made from scratch with carrots, peas and celery.\""
+recipe.ingredients
+=> ["1 pound skinless, boneless chicken breast halves - cubed", "1 cup sliced carrots", "1 cup frozen green peas", "1/2 cup sliced celery", "1/3 cup butter", "1/3 cup chopped onion", "1/3 cup all-purpose flour", "1/2 teaspoon salt", "1/4 teaspoon black pepper", "1/4 teaspoon celery seed", "1 3/4 cups chicken broth", "2/3 cup milk", "2 (9 inch) unbaked pie crusts"]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tychus/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/tychus.rb

@@ -0,0 +1,12 @@
+require "tychus/version"
+require "tychus/parsers"
+require "tychus/parser_selector"
+require "tychus/uri_resolver"
+
+module Tychus
+  def self.parse(uri)
+    host = URIResolver.new(uri).resolve_uri
+    parser = ParserSelector.resolve_parser(host)
+    parser.new(uri).parse
+  end
+end

data/lib/tychus/parser_selector.rb

@@ -0,0 +1,17 @@
+module Tychus
+  class ParserSelector
+    PARSERS = [
+      Tychus::Parsers::AllrecipesParser,
+      Tychus::Parsers::FoodNetworkParser,
+      Tychus::Parsers::KraftRecipesParser
+    ]
+
+    def self.resolve_parser(host)
+      PARSERS.detect do |parser|
+        host =~ %r[#{parser.uri_host}]
+      end
+    end
+
+  end
+end
+

data/lib/tychus/parsers.rb

@@ -0,0 +1,17 @@
+require_relative 'parsers/base'
+require_relative 'parsers/schema_org_parser'
+require_relative 'parsers/allrecipes_parser'
+require_relative 'parsers/food_network_parser'
+require_relative 'parsers/kraft_recipes_parser'
+
+module Tychus
+module Parsers
+
+  Recipe = Struct.new(*Base.recipe_attributes) do
+    alias_method :yield, :recipe_yield
+    alias_method :instructions, :recipe_instructions
+  end
+
+end
+end
+

data/lib/tychus/parsers/allrecipes_parser.rb

@@ -0,0 +1,18 @@
+module Tychus
+module Parsers
+
+  # Allrecipes uses schema.org's recipe microformat
+  class AllrecipesParser < SchemaOrgParser
+    def self.uri_host
+      "allrecipes.com"
+    end
+
+    def clean_instructions(instructions)
+      #reject last "Kitchen Friendly View" element
+      instructions[0..-2]
+    end
+  end
+
+end
+end
+

data/lib/tychus/parsers/base.rb

@@ -0,0 +1,157 @@
+require 'active_support/core_ext/object/blank.rb'
+
+module Tychus
+module Parsers
+
+  class Base
+    attr_reader :uri, :doc, :recipe_doc, :recipe
+
+    def self.recipe_attributes
+      # TODO: clear up these attributes. Are they used? Real example to
+      # verify?
+        # recipeType
+        # photo
+        # published
+        # summary
+        # review - see schema.org/Review
+      %i[
+        name
+        author
+        description
+        prep_time
+        cook_time
+        total_time
+        recipe_yield
+        ingredients
+        recipe_instructions
+        image
+      ]
+    end
+
+    def initialize(uri)
+      @uri = uri
+      @recipe = Recipe.new
+      @doc = Nokogiri::HTML(open(uri))
+      @recipe_doc = @doc.css(self.class.root_doc)
+    end
+
+    def parse
+      recipe_attributes.each do |attr|
+        property_value = __send__("parse_#{attr}")
+        recipe.__send__("#{attr}=", Value(property_value))
+      end
+      recipe
+    end
+
+    def parse_author
+      # is it always first?
+      itemprop_node_for(:author).content
+    end
+
+    def parse_description
+      # is it always first?
+      itemprop_node_for(:description).content
+    end
+
+    def parse_recipe_instructions
+      # strip empty strings, drop trailing whitespace, clean carriage returns (\r\n)
+      #
+      # Allrecipes: <li><span>lorem ipsum</span></li>
+      # FoodNetwork: <p>lorem ipsum</p>
+      # reject headers such as "Directions" and divs such as .categories for Foodnetwork recipes
+      reject_regex = /^(h.|div)$/
+
+      clean_instructions(itemprop_node_for(:recipeInstructions)
+        .element_children
+        .reject { |node| node.name =~ reject_regex }
+        .map do |node|
+          node.content
+            .squeeze(" ")
+            .rstrip
+            .split("\r\n\s\r\n\s")
+        end.flatten.reject(&:blank?))
+    end
+
+    def parse_name
+      # is it always first?
+      itemprop_node_for(:name).content
+    end
+
+    def parse_cook_time
+      # is it always first?
+      # leverage iso8601
+      parse_duration(itemprop_node_for(:cookTime))
+    end
+
+    def parse_image
+      # is it always first?
+      itemprop_node_for(:image).attr('src')
+    end
+
+    def parse_ingredients
+      # NOT FIRST
+      recipe_doc
+        .css('[itemprop="ingredients"]')
+        .map do |ingredient_node|
+          ingredient_node
+            .element_children
+            .map(&:content)
+            .join(" ")
+        end.reject(&:blank?)
+    end
+
+    def parse_prep_time
+      # is it always first?
+      # leverage iso8601
+      parse_duration(itemprop_node_for(:prepTime))
+    end
+
+    def parse_duration(node)
+      # Allrecipes - 'time' element
+      # Foodnetwork - 'meta' element (std according to
+      # Schema.org/Recipe)
+      case node.name
+      when "meta", "span"
+        node.attr('content')
+      when "time"
+        node.attr('datetime')
+      else
+        NullObject.new
+      end
+    end
+
+    def parse_recipe_yield
+      # is it always first?
+      itemprop_node_for(:recipeYield).content
+    end
+
+    def parse_total_time
+      # is it always first?
+      # leverage iso8601
+      parse_duration(itemprop_node_for(:totalTime))
+    end
+
+    def recipe_attributes
+      self.class.recipe_attributes
+    end
+
+    def clean_instructions(obj)
+      obj
+    end
+
+    def Value(obj)
+      case obj
+      when NullObject then nil
+      else obj
+      end
+    end
+  end
+
+  class NullObject
+    def method_missing(*args, &block)
+      self
+    end
+  end
+
+end
+end

data/lib/tychus/parsers/food_network_parser.rb

@@ -0,0 +1,38 @@
+module Tychus
+module Parsers
+  class FoodNetworkParser < SchemaOrgParser
+    def self.uri_host
+      "foodnetwork.com"
+    end
+
+    def parse_author
+      # in the case of an author advertising her TV show
+      itemprop_node_for(:author)
+        .css('span')
+        .first
+        .content
+    end
+
+    def parse_description
+      # Foodnetwork does not use the description in its recipe body
+      # resort to opengraph to pull out description in head
+      # TODO: pull this func out for an opengraph parser?
+      @doc.css('meta[property="og:description"]').first.attr('content')
+    end
+
+    def parse_ingredients
+      # NOT FIRST
+      recipe_doc
+        .css('[itemprop="ingredients"]')
+        .map { |node| node.content.lstrip.squeeze(" ").chomp } 
+    end
+
+    def clean_instructions(obj)
+      #TODO: what is best pattern to share this behavior?
+      obj
+    end
+
+  end
+end
+end
+

data/lib/tychus/parsers/kraft_recipes_parser.rb

@@ -0,0 +1,55 @@
+module Tychus
+module Parsers
+
+  class KraftRecipesParser < SchemaOrgParser
+
+    def self.uri_host
+      "kraftrecipes.com"
+    end
+
+    def parse_description
+      # description can be found in .recipeDesc or meta tag in header
+      # TODO: pull out meta tag parsing into own methods/class?
+      doc.css('meta[name="description"]').first.attr('content')
+    end
+
+    def parse_name
+      # "\r\n\tSweet BBQ Chicken Kabobs\r\n\t"
+      result = super
+      result.gsub(/(\r|\n|\t)/,'')
+    end
+
+    def parse_recipe_instructions
+      itemprop_node_for(:recipeInstructions)
+        .element_children
+        .map do|x|
+          x.content
+            .squeeze(" ")
+            .rstrip
+            .split("\r\n\t")
+            .map{|x|x.gsub(/\t/,'')}
+        end.flatten.reject(&:blank?)
+    end
+
+    def parse_ingredients
+      # NOT FIRST
+      # "1 lb.\r\n\t\t\t\t\t\t\t\t boneless skinless chicken breasts, cut into 1-1/2-inch pieces", "2 cups\r\n\t\t\t\t\t\t\t\t fresh pineapple chunks (1-1/2 inch)", "1 \r\n\t\t\t\t\t\t\t\t each red and green pepper, cut into 1-1/2-inch pieces", "1/2 cup\r\n\t\t\t\t\t\t\t\t KRAFT Original Barbecue Sauce", "3 Tbsp.\r\n\t\t\t\t\t\t\t\t frozen orange juice concentrate, thawed"
+      recipe_doc
+        .css('[itemprop="ingredients"]')
+        .map do|ingredient_node|
+          ingredient_node
+            .element_children
+            .map do |node| node.content
+              .lstrip
+              .rstrip
+              .squeeze(" ")
+              .gsub(/(\r|\n|\t)/,'')
+            end.join(" ")
+        end.reject(&:blank?)
+    end
+
+  end
+
+end
+end
+

data/lib/tychus/parsers/schema_org_parser.rb

@@ -0,0 +1,41 @@
+module Tychus
+module Parsers
+
+  class SchemaOrgParser < Base
+
+    def initialize(uri)
+      super
+      strip_review_microformat
+      strip_video_object_microformat
+    end
+
+    def strip_review_microformat
+      recipe_doc.css(self.class.review_doc).remove
+    end
+
+    def strip_video_object_microformat
+      recipe_doc.css(self.class.video_object_doc).remove
+    end
+
+
+    def self.root_doc
+      '[itemtype="http://schema.org/Recipe"]'
+    end
+
+    def itemprop_node_for(property)
+      recipe_doc.css("[itemprop='#{property}']").first || NullObject.new
+    end
+
+    def self.review_doc
+      '[itemtype="http://schema.org/Review"]'
+    end
+
+    def self.video_object_doc
+      '[itemtype="http://www.schema.org/VideoObject"]'
+    end
+
+  end
+
+end
+end
+