openfoodfacts 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 236ff1efe128490b9d482a5146be10fbe6907bd6
-  data.tar.gz: 24ab028750cca3d08ff539aed262c1bbb94b6f8b
+  metadata.gz: fd868f38cbc5e9fd890a62c71a25f0676e665be1
+  data.tar.gz: 0c4ff491f6376b0cd0336894925ee6abc05f6ac6
 SHA512:
-  metadata.gz: f26f4ce2748bb094cd6c162427e99bd47754e5cecd962125c94b464382f3113f38d1ecefa919d678dbfa19cbb95df394ee38d4ec97c5b2f1697b5478247ed952
-  data.tar.gz: d918fdc1c6585a50837c257f3b4b58fe5b06d0519a51a6ccda06c70c1dadd3fe3b6d5758d4a05a28bffa50f7d5b76efe6b050edffabd672d687036e6c8e00848
+  metadata.gz: d1791ac7c859f1e4c09150a726f32d79c74425da186f599dea4acc9daa6e4641b0455a5192554a7db417bb869a81374dce9bd4ee998be5020b0b58849bad0174
+  data.tar.gz: 72adbba81b6941d695b866dfdeef6f9dd8fb7a0facefc6b84c6b99f9f2fd91d314fec9cf2437d41b0b839e0dc0a86eb8b7fb9ea6a5e4fda5dbc3b394cc1194fe

data/README.md

@@ -2,8 +2,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/openfoodfacts.svg)](http://badge.fury.io/rb/openfoodfacts)
 [![Build Status](https://travis-ci.org/openfoodfacts/openfoodfacts-ruby.svg?branch=master)](https://travis-ci.org/openfoodfacts/openfoodfacts-ruby.svg?branch=master)
-[![Dependency Status](https://gemnasium.com/nicolasleger/openfoodfacts-ruby.svg)](https://gemnasium.com/nicolasleger/openfoodfacts-ruby)
-[![Code Climate](https://codeclimate.com/github/nicolasleger/openfoodfacts-ruby/badges/gpa.svg)](https://codeclimate.com/github/nicolasleger/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/nicolasleger/openfoodfacts-ruby/badge.svg)](https://coveralls.io/r/nicolasleger/openfoodfacts-ruby)
 
 API Wrapper for [OpenFoodFacts](https://openfoodfacts.org/), the open database about food.
@@ -24,6 +24,32 @@ Or install it yourself as:
 
     $ gem install openfoodfacts
 
+## Models
+
+All data is available for World, French, UK and US version for now. You should update the gem page URLs mapping for others.
+
+- Additive
+- Brand
+- Category
+- City
+- Contributor
+- Country
+- Faq
+- IngredientThatMayBeFromPalmOil
+- Label
+- Locale
+- ManufacturingPlace
+- Origin
+- PackagerCode
+- Packaging
+- Press
+- Product
+- ProductState
+- PurchasePlace
+- Store
+- Trace
+- User
+
 ## Usage
 
 ```ruby

data/lib/openfoodfacts.rb

@@ -1,6 +1,23 @@
+require_relative 'openfoodfacts/additive'
+require_relative 'openfoodfacts/brand'
+require_relative 'openfoodfacts/category'
+require_relative 'openfoodfacts/city'
+require_relative 'openfoodfacts/contributor'
+require_relative 'openfoodfacts/country'
+require_relative 'openfoodfacts/faq'
+require_relative 'openfoodfacts/ingredient_that_may_be_from_palm_oil'
+require_relative 'openfoodfacts/label'
 require_relative 'openfoodfacts/locale'
+require_relative 'openfoodfacts/manufacturing_place'
+require_relative 'openfoodfacts/origin'
+require_relative 'openfoodfacts/packager_code'
+require_relative 'openfoodfacts/packaging'
+require_relative 'openfoodfacts/press'
 require_relative 'openfoodfacts/product'
 require_relative 'openfoodfacts/product_state'
+require_relative 'openfoodfacts/purchase_place'
+require_relative 'openfoodfacts/store'
+require_relative 'openfoodfacts/trace'
 require_relative 'openfoodfacts/user'
 require_relative 'openfoodfacts/version'
 

data/lib/openfoodfacts/additive.rb

@@ -0,0 +1,51 @@
+require 'hashie'
+
+module Openfoodfacts
+  class Additive < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'additifs',
+      'uk' => 'additives',
+      'us' => 'additives',
+      'world' => 'additives'
+    }
+
+    class << self
+
+      # Get additives
+      #
+      def all(locale: Openfoodfacts::DEFAULT_LOCALE)
+        if path = LOCALE_PATHS[locale]
+          page_url = "http://#{locale}.openfoodfacts.org/#{path}"
+
+          Product.tags_from_page(self, page_url) do |tag|
+            columns = tag.css('td')
+
+            link = tag.css('a').first
+            attributes = {
+              "name" => link.text.strip,
+              "url" => URI.join(page_url, link.attr('href')).to_s,
+              "products_count" => columns[1].text.to_i,
+            }
+            
+            riskiness = columns[2].attr('class')
+            if riskiness
+              attributes["riskiness"] = riskiness[/level_(\d+)/, 1].to_i
+            end
+
+            new(attributes)
+          end
+        end
+      end
+
+    end
+
+    # Get products with additive
+    #
+    def products(page: -1)
+      Product.from_website_page(url, page: page, products_count: products_count) if url
+    end
+
+  end
+end

data/lib/openfoodfacts/allergen.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openfoodfacts
+  class Allergen < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'allergenes',
+      'uk' => 'allergens',
+      'us' => 'allergens',
+      'world' => 'allergens'
+    }
+
+    class << self
+
+      # Get allergens
+      #
+      def all(locale: Openfoodfacts::DEFAULT_LOCALE)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "http://#{locale}.openfoodfacts.org/#{path}")
+        end
+      end
+
+    end
+
+    # Get products with allergen
+    #
+    def products(page: -1)
+      Product.from_website_page(url, page: page, products_count: products_count) if url
+    end
+
+  end
+end

data/lib/openfoodfacts/brand.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openfoodfacts
+  class Brand < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'marques',
+      'uk' => 'brands',
+      'us' => 'brands',
+      'world' => 'brands'
+    }
+
+    class << self
+
+      # Get product brands
+      #
+      def all(locale: Openfoodfacts::DEFAULT_LOCALE)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "http://#{locale}.openfoodfacts.org/#{path}")
+        end
+      end
+
+    end
+
+    # Get products with brand
+    #
+    def products(page: -1)
+      Product.from_website_page(url, page: page, products_count: products_count) if url
+    end
+
+  end
+end

data/lib/openfoodfacts/category.rb

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

data/lib/openfoodfacts/city.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openfoodfacts
+  class City < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'communes',
+      'uk' => 'cities',
+      'us' => 'cities',
+      'world' => 'cities'
+    }
+
+    class << self
+
+      # Get cities
+      #
+      def all(locale: Openfoodfacts::DEFAULT_LOCALE)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "http://#{locale}.openfoodfacts.org/#{path}")
+        end
+      end
+
+    end
+
+    # Get products with city
+    #
+    def products(page: -1)
+      Product.from_website_page(url, page: page, products_count: products_count) if url
+    end
+
+  end
+end

data/lib/openfoodfacts/contributor.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openfoodfacts
+  class Contributor < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'contributeurs',
+      'uk' => 'contributors',
+      'us' => 'contributors',
+      'world' => 'contributors'
+    }
+
+    class << self
+
+      # Get contributors
+      #
+      def all(locale: Openfoodfacts::DEFAULT_LOCALE)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "http://#{locale}.openfoodfacts.org/#{path}")
+        end
+      end
+
+    end
+
+    # Get products for contributor
+    #
+    def products(page: -1)
+      Product.from_website_page(url, page: page, products_count: products_count) if url
+    end
+
+  end
+end

data/lib/openfoodfacts/country.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openfoodfacts
+  class Country < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'pays',
+      'uk' => 'countries',
+      'us' => 'countries',
+      'world' => 'countries'
+    }
+
+    class << self
+
+      # Get countries
+      #
+      def all(locale: Openfoodfacts::DEFAULT_LOCALE)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "http://#{locale}.openfoodfacts.org/#{path}")
+        end
+      end
+
+    end
+
+    # Get products with country
+    #
+    def products(page: -1)
+      Product.from_website_page(url, page: page, products_count: products_count) if url
+    end
+
+  end
+end

data/lib/openfoodfacts/faq.rb

@@ -0,0 +1,50 @@
+require 'hashie'
+require 'nokogiri'
+require 'open-uri'
+
+module Openfoodfacts
+  class Faq < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'questions-frequentes',
+      'uk' => 'faq',
+      'us' => 'faq',
+      'world' => 'faq'
+    }
+
+    class << self
+      def items(locale: Openfoodfacts::DEFAULT_LOCALE)
+        if path = LOCALE_PATHS[locale]
+          html = open("http://#{locale}.openfoodfacts.org/#{path}").read
+          dom = Nokogiri::HTML.fragment(html)
+          
+          titles = dom.css('#main_column h2')
+          titles.each_with_index.map do |item, index|
+            paragraphs = []
+          
+            element = item.next_sibling
+            while !element.nil? && element.node_name != 'h2'
+              if element.node_name == 'p'
+                paragraphs.push(element)
+              end
+
+              element = element.next_sibling
+            end
+
+            if index == titles.length - 1
+              paragraphs = paragraphs[0..-3]
+            end
+
+            new({
+              "question" => item.text.strip,
+              "answer" => paragraphs.map { |paragraph| paragraph.text.strip.gsub(/\r?\n/, ' ') }.join("\n\n"),
+              "answer_html" => paragraphs.map(&:to_html).join
+            })
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/openfoodfacts/ingredient_that_may_be_from_palm_oil.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openfoodfacts
+  class IngredientThatMayBeFromPalmOil < Hashie::Mash
+
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'ingredients-pouvant-etre-issus-de-l-huile-de-palme',
+      'uk' => 'ingredients-that-may-be-from-palm-oil',
+      'us' => 'ingredients-that-may-be-from-palm-oil',
+      'world' => 'ingredients-that-may-be-from-palm-oil'
+    }
+
+    class << self
+
+      # Get ingredients that may be from palm oil
+      #
+      def all(locale: Openfoodfacts::DEFAULT_LOCALE)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "http://#{locale}.openfoodfacts.org/#{path}")
+        end
+      end
+
+    end
+
+    # Get products with ingredient that may be from palm oil
+    #
+    def products(page: -1)
+      Product.from_website_page(url, page: page, products_count: products_count) if url
+    end
+
+  end
+end

data/lib/openfoodfacts/label.rb

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