recipe_crawler 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a52d1842b8aea415bb32cf19916579e0fd11919
+  data.tar.gz: 48074b26377e71203f77605ca499ec0168fd2cf5
+SHA512:
+  metadata.gz: fee37f55c3be5e59cd8811da8e3aecf5d531332699913251b8ba52ddb71df04081e6986d782fb71241a67d785629e8459cba6226ab82a950951ac97905925bf2
+  data.tar.gz: 8d111a95a943ce808caf9440602a1df762b51129a0210b3a52c04e85aecce04524180315908f70ec432cdf58d412ffb7528f54efecd8f112f4cc7147688f8b01

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at madeindjs@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Rousseau Alexandre
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 madeindjs
+
+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,76 @@
+# RecipeCrawler
+
+A web scrawler to get a [Marmiton](http://www.marmiton.org/) or [750g](http://www.750g.com)*(two famous french cooking recipe websites)*!  
+
+You'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/recipe_crawler`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'recipe_crawler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install recipe_crawler
+
+## Usage
+
+1. import library:
+
+~~~ruby
+require 'recipe_crawler'
+~~~
+
+2. Create a new instance of `RecipeCrawler::Recipe`
+
+~~~ruby
+marmiton_url = 'http://www.marmiton.org/recettes/recette_burger-d-avocat_345742.aspx'
+recipe = RecipeCrawler::Recipe.new marmiton_url
+~~~
+
+3. Export as `json` or as an `Array` 
+
+~~~ruby
+recipe.to_hash
+# will return
+# --------------
+# { :cooktime => 7,
+#        :image => "http://images.marmitoncdn.org/recipephotos/multiphoto/7b/7b4e95f5-37e0-4294-bebe-cde86c30817f_normal.jpg",
+#        :ingredients => ["2 beaux avocat", "2 steaks hachés de boeuf", "2 tranches de cheddar", "quelques feuilles de salade", "1/2 oignon rouge", "1 tomate", "graines de sésame", "1 filet d'huile d'olive", "1 pincée de sel", "1 pincée de poivre"],
+#        :preptime => 20,
+#        :steps => ["Laver et couper la tomate en rondelles", "Cuire les steaks à la poêle avec un filet d'huile d'olive", "Saler et poivrer", "Toaster les graines de sésames", "Ouvrir les avocats en 2, retirer le noyau et les éplucher", "Monter les burger en plaçant un demi-avocat face noyau vers le haut, déposer un steak, une tranche de cheddar sur le steak bien chaud pour qu'elle fonde, une rondelle de tomate, une rondelle d'oignon, quelques feuilles de salade et terminer par la seconde moitié d'avocat", "Parsemer quelques graines de sésames."],
+#        :title => "Burger d'avocat",
+#  }
+recipe.to_json
+# will return
+# --------------
+# "{\"title\":\"Burger d'avocat\",\"preptime\":20,\"cooktime\":7,\"ingredients\":[\"2 beaux avocat\",\"2 steaks hachés de boeuf\",\"2 tranches de cheddar\",\"quelques feuilles de salade\",\"1/2 oignon rouge\",\"1 tomate\",\"graines de sésame\",\"1 filet d'huile d'olive\",\"1 pincée de sel\",\"1 pincée de poivre\"],\"steps\":[\"Laver et couper la tomate en rondelles\",\"Cuire les steaks à la poêle avec un filet d'huile d'olive\",\"Saler et poivrer\",\"Toaster les graines de sésames\",\"Ouvrir les avocats en 2, retirer le noyau et les éplucher\",\"Monter les burger en plaçant un demi-avocat face noyau vers le haut, déposer un steak, une tranche de cheddar sur le steak bien chaud pour qu'elle fonde, une rondelle de tomate, une rondelle d'oignon, quelques feuilles de salade et terminer par la seconde moitié d'avocat\",\"Parsemer quelques graines de sésames.\"],\"image\":\"http://images.marmitoncdn.org/recipephotos/multiphoto/7b/7b4e95f5-37e0-4294-bebe-cde86c30817f_normal.jpg\"}"
+~~~
+
+## 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/madeindjs/recipe_crawler. 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](http://opensource.org/licenses/MIT).
+
+Author
+----------
+
+[Rousseau Alexandre](https://github.com/madeindjs)
+

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 "marmiton_crawler"
+
+# 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

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/lib/recipe_crawler/version.rb

@@ -0,0 +1,3 @@
+module RecipeCrawler
+  VERSION = "2.0.0"
+end

data/lib/recipe_crawler.rb

@@ -0,0 +1,160 @@
+# encoding: UTF-8
+require 'json'
+require 'open-uri'
+require 'nokogiri'
+
+require "recipe_crawler/version"
+
+
+module RecipeCrawler
+
+  # represent a recipe fetched from an Url
+  class Recipe
+
+    attr_reader :title, :preptime, :cooktime , :ingredients, :steps, :image
+
+    MARMITON_HOST = {desktop: 'http://www.marmiton.org/', mobile: 'http://m.marmiton.org/'}
+    G750_HOST = 'http://www.750g.com'
+
+
+    
+    # Instanciate a Recipe object with data crawled from an url
+    #
+    # @param url [String] representing an url from Marmiton or 750g website
+    def initialize url
+      if marmiton_host? url
+        fetch_from_marmiton url
+      elsif g750_host? url
+        fetch_from_g750 url
+      else
+        raise ArgumentError, "Instantiation cancelled (Host not supported)." 
+      end
+    end
+
+
+    # export object properties to hash
+    #
+    # @return [Hash] as object's properties
+    def to_hash
+      attrs = Hash.new
+      instance_variables.each do |var|
+        str = var.to_s.gsub /^@/, ''
+        attrs[str.to_sym] = instance_variable_get(var)
+      end
+      attrs
+    end
+
+
+    # convert object properties to json
+    #
+    # @return [String] data formated in JSON
+    def to_json
+      return self.to_hash.to_json
+    end
+
+
+    private
+
+
+    # remove `\r\n` & unwanted espaces
+    #
+    # @param text [String] a text to sanitize
+    # @return [String] as text corrected formated
+    def sanitize text
+      ['  ', '\r\n', "\r\n", "\n", "\r"].each { |text_to_remove| 
+        text.gsub!(text_to_remove,'')
+      }
+      return text
+    end
+
+    # test if url is from a valid marmiton.org host
+    #
+    # @param url [String] representing an url
+    # @return [Boolean] as true if coresponding to a valid url
+    def marmiton_host? url
+      return url.include?(MARMITON_HOST[:desktop]) || url.include?(MARMITON_HOST[:mobile])
+    end
+
+
+    # test if url is from a valid 750g.com host
+    #
+    # @param url [String] representing an url
+    # @return [Boolean] as true if coresponding to a valid url
+    def g750_host? url
+      return url.include? G750_HOST
+    end
+
+
+    # fill object properties from a Marmiton url
+    #
+    # @param url [String] representing an url
+    def fetch_from_marmiton url
+      if marmiton_host? url
+
+        url.gsub! MARMITON_HOST[:mobile], MARMITON_HOST[:desktop]
+
+        page =  Nokogiri::HTML(open(url).read)
+        @title = page.css('h1.m_title span.item span.fn').text
+
+
+        # get times
+        @preptime = page.css('p.m_content_recette_info span.preptime').text.to_i
+        @cooktime = page.css('p.m_content_recette_info span.cooktime').text.to_i
+
+        # get ingredients
+        ingredients_text = page.css('div.m_content_recette_ingredients').text
+        @ingredients = sanitize(ingredients_text).split '- '
+        @ingredients.delete_at(0) # to delete the first `Ingrédients (pour 2 personnes) :`
+
+        # get steps
+        steps_text = page.css('div.m_content_recette_todo').text
+        @steps = sanitize(steps_text).split '. '
+        @steps.delete_at(0) # to delete the first `Ingrédients (pour 2 personnes) :`
+
+        # get image
+        @image = page.css('a.m_content_recette_illu img.m_pinitimage').attr('src').to_s
+        
+
+      else
+        raise ArgumentError, "Instantiation cancelled (ulr not from #{MARMITON_HOST})." 
+      end
+    end
+
+
+    # fill object properties from a 750g url
+    #
+    # @param url [String] representing an url
+    def fetch_from_g750 url
+      if g750_host? url
+        page =  Nokogiri::HTML(open(url).read)
+        @title = page.css('h1.c-article__title').text
+
+        # get times
+        @preptime = page.css('ul.c-recipe-summary li time[itemprop=prepTime]').text.to_i
+        @cooktime = page.css('ul.c-recipe-summary li time[itemprop=cookTime]').text.to_i
+
+        @steps = []
+        css_step = "div[itemprop=recipeInstructions] p"
+        @steps = page.css(css_step).text.split /[( ),(<br>)]/
+
+        @ingredients = []
+        css_ingredient = "div.c-recipe-ingredients ul.c-recipe-ingredients__list li.ingredient"
+        page.css(css_ingredient).each { |ing_node|
+          @ingredients << sanitize(ing_node.text)
+        }
+
+        # get image
+        css_image = 'div.swiper-wrapper img.photo'
+        begin
+          @image = page.css(css_image).attr('src').to_s
+        rescue NoMethodError => e
+        end
+        
+      else
+        raise ArgumentError, "Instantiation cancelled (ulr not from #{G750_HOST})." 
+      end
+    end
+  
+  end
+
+end

data/recipe_crawler.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'recipe_crawler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "recipe_crawler"
+  spec.version       = RecipeCrawler::VERSION
+  spec.authors       = ["madeindjs"]
+  spec.email         = ["madeindjs@gmail.com"]
+
+  spec.summary       = %q{A web scrawler to get a Marmiton's or 750g recipe}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/madeindjs/recipe_crawler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "nokogiri"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: recipe_crawler
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- madeindjs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: nokogiri
+  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'
+description: 
+email:
+- madeindjs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/recipe_crawler.rb
+- lib/recipe_crawler/version.rb
+- recipe_crawler.gemspec
+homepage: https://github.com/madeindjs/recipe_crawler
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A web scrawler to get a Marmiton's or 750g recipe
+test_files: []