openfoodfacts 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83043dd2a373d7a71a92f5bd91dcb5d0bd9ad41f
-  data.tar.gz: 8e593ecdbdba0f096d0bd51a4e6a34a94685f4f3
+  metadata.gz: 68fa8db761da44f61bc222db596a11b97f0b5e58
+  data.tar.gz: 44daa5950492034cc61e8eb6b9e4bc39d67d71b5
 SHA512:
-  metadata.gz: 1b824b0ac2ace0129647140cd3d5d2e1a1c241f6636d2066d290dc385343ed5f0aff411f746a3bea84d9c14dc57c195ea07975ae76250a6d51bc801f69ec32e7
-  data.tar.gz: 0442dea498913a0f52d49dcef4c19b6dac01361145bbf92907c96937e4dcac8aee001c8ebe59c4000e5cfa42e9db63819abd69e433de331a924d59fd64696706
+  metadata.gz: bde80ecfacd51c7726da778c78086625f9b5adcb118a6a47032ed8c376ebb4f62f73c5e2557e9f2e96d08d5b7512030ff62ccd0affc8f0e99b5e66510f32fd9b
+  data.tar.gz: c7ab2313f16df56770886a69cda9428d7392a33d0758e8f545e6b06b9fbbb0dd3f59321ac0e70e097cb5c1f8e9239d4e498064dc73b3c502f743c7ab92d12dcc

data/README.md

@@ -1,11 +1,11 @@
 # Open Food Facts
 
-[![Gem Version](https://badge.fury.io/rb/openfoodfacts.svg)](http://badge.fury.io/rb/openfoodfacts)
+[![Gem Version](https://badge.fury.io/rb/openfoodfacts.svg)](https://badge.fury.io/rb/openfoodfacts)
 [![Build Status](https://travis-ci.org/openfoodfacts/openfoodfacts-ruby.svg?branch=master)](https://travis-ci.org/openfoodfacts/openfoodfacts-ruby)
 [![Dependency Status](https://gemnasium.com/openfoodfacts/openfoodfacts-ruby.svg)](https://gemnasium.com/openfoodfacts/openfoodfacts-ruby)
 [![Code Climate](https://codeclimate.com/github/openfoodfacts/openfoodfacts-ruby/badges/gpa.svg)](https://codeclimate.com/github/openfoodfacts/openfoodfacts-ruby)
 [![Coverage Status](https://coveralls.io/repos/github/openfoodfacts/openfoodfacts-ruby/badge.svg?branch=master)](https://coveralls.io/github/openfoodfacts/openfoodfacts-ruby?branch=master)
-[![Documentation](http://inch-ci.org/github/openfoodfacts/openfoodfacts-ruby.svg?branch=master)](http://inch-ci.org/github/openfoodfacts/openfoodfacts-ruby)
+[![Documentation](https://inch-ci.org/github/openfoodfacts/openfoodfacts-ruby.svg?branch=master)](https://inch-ci.org/github/openfoodfacts/openfoodfacts-ruby)
 
 API Wrapper for [Open Food Facts](https://openfoodfacts.org/), the open database about food.
 
@@ -35,11 +35,17 @@ All data is available for World, French, UK and US version for now. You should u
 - City
 - Contributor
 - Country
+- EntryDate
 - Faq
 - IngredientThatMayBeFromPalmOil
 - Label
+- LastEditDate
+- Language
 - Locale
 - ManufacturingPlace
+- Mission
+- NumberOfIngredients
+- NutritionGrade
 - Origin
 - PackagerCode
 - Packaging

data/lib/openfoodfacts.rb

@@ -4,11 +4,17 @@ require_relative 'openfoodfacts/category'
 require_relative 'openfoodfacts/city'
 require_relative 'openfoodfacts/contributor'
 require_relative 'openfoodfacts/country'
+require_relative 'openfoodfacts/entry_date'
 require_relative 'openfoodfacts/faq'
 require_relative 'openfoodfacts/ingredient_that_may_be_from_palm_oil'
 require_relative 'openfoodfacts/label'
+require_relative 'openfoodfacts/language'
+require_relative 'openfoodfacts/last_edit_date'
 require_relative 'openfoodfacts/locale'
 require_relative 'openfoodfacts/manufacturing_place'
+require_relative 'openfoodfacts/mission'
+require_relative 'openfoodfacts/number_of_ingredients'
+require_relative 'openfoodfacts/nutrition_grade'
 require_relative 'openfoodfacts/origin'
 require_relative 'openfoodfacts/packager_code'
 require_relative 'openfoodfacts/packaging'

data/lib/openfoodfacts/entry_date.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openfoodfacts
+  class EntryDate < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'dates-d-ajout',
+      'uk' => 'entry-dates',
+      'us' => 'entry-dates',
+      'world' => 'entry-dates'
+    }
+
+    class << self
+
+      # Get entry dates
+      #
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
+        end
+      end
+
+    end
+
+    # Get products with entry date
+    #
+    def products(page: -1)
+      Product.from_website_page(url, page: page, products_count: products_count) if url
+    end
+
+  end
+end

data/lib/openfoodfacts/language.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openfoodfacts
+  class Language < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'langues',
+      'uk' => 'languages',
+      'us' => 'languages',
+      'world' => 'languages'
+    }
+
+    class << self
+
+      # Get languages
+      #
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
+        end
+      end
+
+    end
+
+    # Get products with language
+    #
+    def products(page: -1)
+      Product.from_website_page(url, page: page, products_count: products_count) if url
+    end
+
+  end
+end

data/lib/openfoodfacts/last_edit_date.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openfoodfacts
+  class LastEditDate < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'dates-de-derniere-modification',
+      'uk' => 'last-edit-dates',
+      'us' => 'last-edit-dates',
+      'world' => 'last-edit-dates'
+    }
+
+    class << self
+
+      # Get last edit dates
+      #
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
+        end
+      end
+
+    end
+
+    # Get products with last edit date
+    #
+    def products(page: -1)
+      Product.from_website_page(url, page: page, products_count: products_count) if url
+    end
+
+  end
+end

data/lib/openfoodfacts/mission.rb

@@ -0,0 +1,71 @@
+require 'hashie'
+
+module Openfoodfacts
+  class Mission < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'missions',
+      'uk' => 'missions',
+      'us' => 'missions',
+      'world' => 'missions'
+    }
+
+    class << self
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
+        if path = LOCALE_PATHS[locale]
+          url = "https://#{locale}.#{domain}/#{path}"
+          html = open(url).read
+          dom = Nokogiri::HTML.fragment(html)
+
+          dom.css('#missions li').map do |mission_dom|
+            links = mission_dom.css('a')
+
+            attributes = {
+              "title" => links.first.text.strip,
+              "url" => URI.join(url, links.first.attr('href')).to_s,
+              "description" => mission_dom.css('div').first.children[2].text.gsub('→', '').strip,
+              "users_count" => links.last.text[/(\d+)/, 1].to_i
+            }
+
+            new(attributes)
+          end
+        end
+      end
+    end
+
+    # Fetch mission
+    #
+    def fetch
+      if (self.url)
+        html = open(self.url).read
+        dom = Nokogiri::HTML.fragment(html)
+
+        description = dom.css('#description').first
+
+        # Remove "All missions" link
+        users = dom.css('#main_column a')[0..-2].map do |user_link|
+          User.new(
+            "user_id" => user_link.text.strip,
+            "url" => URI.join(self.url, user_link.attr('href')).to_s,
+          )
+        end
+
+        mission = {
+          "title" => dom.css('h1').first.text.strip,
+          "description" => description.text.strip,
+          "description_long" => description.next.text.strip,
+
+          "users" => users,
+          "users_count" => users.count
+        }
+
+        self.merge!(mission)
+      end
+
+      self
+    end
+    alias_method :reload, :fetch
+
+  end
+end

data/lib/openfoodfacts/number_of_ingredients.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openfoodfacts
+  class NumberOfIngredients < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'nombres-d-ingredients',
+      'uk' => 'numbers-of-ingredients',
+      'us' => 'numbers-of-ingredients',
+      'world' => 'numbers-of-ingredients'
+    }
+
+    class << self
+
+      # Get last edit dates
+      #
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
+        end
+      end
+
+    end
+
+    # Get products with last edit date
+    #
+    def products(page: -1)
+      Product.from_website_page(url, page: page, products_count: products_count) if url
+    end
+
+  end
+end

data/lib/openfoodfacts/nutrition_grade.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openfoodfacts
+  class NutritionGrade < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'notes-nutritionnelles',
+      'uk' => 'nutrition-grades',
+      'us' => 'nutrition-grades',
+      'world' => 'nutrition-grades'
+    }
+
+    class << self
+
+      # Get nutrition grades
+      #
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
+        end
+      end
+
+    end
+
+    # Get products with nutrition grade
+    #
+    def products(page: -1)
+      Product.from_website_page(url, page: page, products_count: products_count) if url
+    end
+
+  end
+end

data/lib/openfoodfacts/product.rb

@@ -90,7 +90,7 @@ module Openfoodfacts
         if page == -1
           if products_count # Avoid one call
             pages_count = (products_count.to_f / 20).ceil
-            (1..pages_count).map { |page| from_website_page(page_url, page: page) }.flatten
+            (1..pages_count).map { |page_i| from_website_page(page_url, page: page_i) }.flatten
           else
             products = []
 

data/lib/openfoodfacts/user.rb

@@ -6,7 +6,6 @@ module Openfoodfacts
     class << self
 
       # Login
-      # WARNING SECURITY: It is not made throught HTTPS Secure so password can be read on the way.
       #
       def login(user_id, password, locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
         path = 'cgi/session.pl'

data/lib/openfoodfacts/version.rb

@@ -1,3 +1,3 @@
 module Openfoodfacts
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/test/test_openfoodfacts.rb

@@ -121,7 +121,7 @@ class TestOpenfoodfacts < Minitest::Test
   def test_it_fetches_products_with_additive
     additive = ::Openfoodfacts::Additive.new("url" => "https://world.openfoodfacts.org/additive/e452i-sodium-polyphosphate")
     VCR.use_cassette("products_with_additive") do
-      products_with_additive = additive.products(page: -1)
+      products_with_additive = additive.products(page: 1)
       refute_empty products_with_additive
     end
   end
@@ -145,11 +145,59 @@ class TestOpenfoodfacts < Minitest::Test
   def test_it_fetches_products_for_brand
     brand = ::Openfoodfacts::Brand.new("url" => "https://world.openfoodfacts.org/brand/bel")
     VCR.use_cassette("products_for_brand") do
-      products_for_brand = brand.products(page: -1)
+      products_for_brand = brand.products(page: 1)
       refute_empty products_for_brand
     end
   end
 
+  # Nutrition Grades
+
+  def test_it_fetches_nutrition_grades
+    VCR.use_cassette("nutrition_grades") do
+      nutrition_grades = ::Openfoodfacts::NutritionGrade.all
+      assert_includes nutrition_grades.map { |nutrition_grade| nutrition_grade['name'] }, "Unknown"
+    end
+  end
+
+  def test_it_fetches_nutrition_grades_for_locale
+    VCR.use_cassette("nutrition_grades_locale") do
+      nutrition_grades = ::Openfoodfacts::NutritionGrade.all(locale: 'fr')
+      assert_includes nutrition_grades.map { |nutrition_grade| nutrition_grade['name'] }, "Inconnu"
+    end
+  end
+
+  def test_it_fetches_products_for_nutrition_grade
+    nutrition_grade = ::Openfoodfacts::NutritionGrade.new("url" => "https://world.openfoodfacts.org/nutrition-grade/c")
+    VCR.use_cassette("products_for_nutrition_grade") do
+      products_for_nutrition_grade = nutrition_grade.products(page: 1)
+      refute_empty products_for_nutrition_grade
+    end
+  end
+
+  # Languages
+
+  def test_it_fetches_languages
+    VCR.use_cassette("languages") do
+      languages = ::Openfoodfacts::Language.all
+      assert_includes languages.map { |language| language['name'] }, "French"
+    end
+  end
+
+  def test_it_fetches_languages_for_locale
+    VCR.use_cassette("languages_locale") do
+      languages = ::Openfoodfacts::Language.all(locale: 'fr')
+      assert_includes languages.map { |language| language['name'] }, "Anglais"
+    end
+  end
+
+  def test_it_fetches_products_for_language
+    language = ::Openfoodfacts::Language.new("url" => "https://world.openfoodfacts.org/language/french")
+    VCR.use_cassette("products_for_language") do
+      products_for_language = language.products(page: 1)
+      refute_empty products_for_language
+    end
+  end
+
   # Product states
 
   def test_it_fetches_product_states
@@ -169,11 +217,83 @@ class TestOpenfoodfacts < Minitest::Test
   def test_it_fetches_products_for_state
     product_state = ::Openfoodfacts::ProductState.new("url" => "https://world.openfoodfacts.org/state/photos-uploaded", "products_count" => 22)
     VCR.use_cassette("products_for_state") do
-      products_for_state = product_state.products(page: -1)
+      products_for_state = product_state.products(page: 1)
       refute_empty products_for_state
     end
   end
 
+  # Entry date
+
+  def test_it_fetches_entry_dates
+    VCR.use_cassette("entry_dates") do
+      entry_dates = ::Openfoodfacts::EntryDate.all
+      assert_includes entry_dates.map { |entry_date| entry_date['name'] }, "2017-03-09"
+    end
+  end
+
+  def test_it_fetches_entry_dates_for_locale
+    VCR.use_cassette("entry_dates_locale") do
+      entry_dates = ::Openfoodfacts::EntryDate.all(locale: 'fr')
+      assert_includes entry_dates.map { |entry_date| entry_date['name'] }, "2017-03-09"
+    end
+  end
+
+  def test_it_fetches_products_for_entry_date
+    entry_date = ::Openfoodfacts::EntryDate.new("url" => "https://world.openfoodfacts.org/entry-date/2014-04-17")
+    VCR.use_cassette("products_for_entry_date") do
+      products_for_entry_date = entry_date.products(page: 1)
+      refute_empty products_for_entry_date
+    end
+  end
+
+  # Last edit date
+
+  def test_it_fetches_last_edit_dates
+    VCR.use_cassette("last_edit_dates") do
+      last_edit_dates = ::Openfoodfacts::LastEditDate.all
+      assert_includes last_edit_dates.map { |last_edit_date| last_edit_date['name'] }, "2017-03-23"
+    end
+  end
+
+  def test_it_fetches_last_edit_dates_for_locale
+    VCR.use_cassette("last_edit_dates_locale") do
+      last_edit_dates = ::Openfoodfacts::LastEditDate.all(locale: 'fr')
+      assert_includes last_edit_dates.map { |last_edit_date| last_edit_date['name'] }, "2017-03-23"
+    end
+  end
+
+  def test_it_fetches_products_for_last_edit_date
+    last_edit_date = ::Openfoodfacts::LastEditDate.new("url" => "https://world.openfoodfacts.org/last-edit-date/2013-11-11")
+    VCR.use_cassette("products_for_last_edit_date") do
+      products_for_last_edit_date = last_edit_date.products(page: 1)
+      refute_empty products_for_last_edit_date
+    end
+  end
+
+  # Number of Ingredients
+
+  def test_it_fetches_numbers_of_ingredients
+    VCR.use_cassette("numbers_of_ingredients") do
+      numbers_of_ingredients = ::Openfoodfacts::NumberOfIngredients.all
+      assert_includes numbers_of_ingredients.map { |number_of_ingredients| number_of_ingredients['name'] }, "38"
+    end
+  end
+
+  def test_it_fetches_numbers_of_ingredients_for_locale
+    VCR.use_cassette("number_of_ingredients_locale") do
+      numbers_of_ingredients = ::Openfoodfacts::NumberOfIngredients.all(locale: 'fr')
+      assert_includes numbers_of_ingredients.map { |number_of_ingredients| number_of_ingredients['name'] }, "38"
+    end
+  end
+
+  def test_it_fetches_products_for_number_of_ingredients
+    number_of_ingredients = ::Openfoodfacts::NumberOfIngredients.new("url" => "https://world.openfoodfacts.org/number-of-ingredients/38")
+    VCR.use_cassette("products_for_number_of_ingredients") do
+      products_for_number_of_ingredients = number_of_ingredients.products(page: 1)
+      refute_empty products_for_number_of_ingredients
+    end
+  end
+
   # FAQ
 
   def test_it_fetches_faq
@@ -182,6 +302,22 @@ class TestOpenfoodfacts < Minitest::Test
     end
   end
 
+  # Mission
+
+  def test_it_fetches_missions
+    VCR.use_cassette("missions") do
+      refute_empty ::Openfoodfacts::Mission.all(locale: 'fr')
+    end
+  end
+
+  def test_it_fetches_mission
+    VCR.use_cassette("mission", record: :once, match_requests_on: [:host, :path]) do
+      mission = ::Openfoodfacts::Mission.new(url: "https://fr.openfoodfacts.org/mission/informateur-100-produits")
+      mission.fetch
+      refute_empty mission.users
+    end
+  end
+
   # Press
 
   def test_it_fetches_press