openfoodfacts 0.6.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5bba81d2fa5eba4c502cdd6b59ddee3b504addc298f0a0ebaf254b0c2885641
-  data.tar.gz: c9bb2c4266aaeac2c606e741f44a4d60d81d919be29f587a6abc15ef15c74fcf
+  metadata.gz: cc63c1f6cd6ee0102081119b885d7e9e14e2c7fb6b0cfc5a489f6930d564e693
+  data.tar.gz: 8f26b4e82235da0859d0d5c91832d72db1685364ac4534699d24ecd933fbad6b
 SHA512:
-  metadata.gz: 7201788f4331aacbe1406f67a91432ce0b1493ce635f5359781a0bd9d2645a3740499c2a263e60f7ecd94ceb1e81df0e54d306c92cbfd2b14010c69c9ffab83b
-  data.tar.gz: 25d08f6c5a61a7db159c7c36efbfcd31363bf7b97ca77cc910ff1f45795bc091aa3e106354fe8f9e7585f6ef05e63b825ca1f1c651a6f987aa16ea1063a36e3b
+  metadata.gz: 50d60b0512a1b70650e58a35a72efb4a7710478e051c02ea3293eee537a0bc61c6d82436fb414896707b19fe5f1f2ce8bfbea5c24951386449e723819a09c9bf
+  data.tar.gz: 04f97cf59df1b84d1105da46d155ff483c90a52fb93ca1e8ae09b117ed223a215edd5a36eddea2a24a63336822f1a4ba6818e7cd9a133d61eec5f60961a47ce1

data/README.md

@@ -1,11 +1,20 @@
-# Open Food Facts
+# Open Food Facts Ruby SDK
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://static.openfoodfacts.org/images/logos/off-logo-horizontal-dark.png?refresh_github_cache=1">
+  <source media="(prefers-color-scheme: light)" srcset="https://static.openfoodfacts.org/images/logos/off-logo-horizontal-light.png?refresh_github_cache=1">
+  <img height="48" src="https://static.openfoodfacts.org/images/logos/off-logo-horizontal-light.svg"/>
+</picture>
 
 [![Gem Version](https://badge.fury.io/rb/openfoodfacts.svg)](https://badge.fury.io/rb/openfoodfacts)
 [![Build Status](https://github.com/openfoodfacts/openfoodfacts-ruby/actions/workflows/ruby.yml/badge.svg)](https://github.com/openfoodfacts/openfoodfacts-ruby/actions/workflows/ruby.yml)
 [![RuboCop](https://github.com/openfoodfacts/openfoodfacts-ruby/actions/workflows/rubocop-analysis.yml/badge.svg)](https://github.com/openfoodfacts/openfoodfacts-ruby/actions/workflows/rubocop-analysis.yml)
 [![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.
+- API Wrapper for [Open Food Facts](https://openfoodfacts.org/), the open database about food.
+- We [have a similar package for cosmetics](https://github.com/openfoodfacts/openbeautyfacts-ruby).
+- Note: This package needs updates for the newest APIs.
+- Please see on the wiki [how to join the community to help with the Ruby package](https://wiki.openfoodfacts.org/API/Ruby)
 
 ## Installation
 
@@ -104,7 +113,7 @@ Openfoodfacts::Locale.all
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `lib/openfoodfacts/version.rb`, and push to the main branch. Releases are automated via GitHub Actions using Trusted Publishers for secure publishing to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
@@ -113,3 +122,15 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 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
+
+
+
+### Third party applications
+
+* Feel [free to open a PR to add your application in this list](https://github.com/openfoodfacts/openfoodfacts-ruby/edit/main/REUSERS.md).
+* Please get in touch at reuse@openfoodfacts.org
+* We are very interested in learning what the Open Food Facts data is used for. It is not mandatory, but we would very much appreciate it if you tell us about your re-uses (https://forms.gle/hwaeqBfs8ywwhbTg8) so that we can share them with the Open Food Facts community. You can also fill this form to get a chance to get your app featured: https://forms.gle/hwaeqBfs8ywwhbTg8
+* Make sure you comply with the OdBL licence, mentioning the Source of your data, and ensuring to avoid combining non free data you can't release legally as open data. Another requirement is contributing back any product you add using this SDK.
+
+## Authors
+

data/Rakefile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
- 
+
 Rake::TestTask.new do |task|
-  task.libs << "lib"
-  task.libs << "test"
-  task.pattern = "test/test_*.rb"
+  task.libs << 'lib'
+  task.libs << 'test'
+  task.pattern = 'test/test_*.rb'
 end
 
 task default: :test
@@ -16,4 +18,4 @@ task :console do
   require File.join(__FILE__, '../lib/openfoodfacts')
   ARGV.clear
   IRB.start
-end
+end

data/lib/openfoodfacts/additive.rb

@@ -1,44 +1,41 @@
+# frozen_string_literal: true
+
 require 'hashie'
 
 module Openfoodfacts
   class Additive < Hashie::Mash
-
     # TODO: Add more locales
     LOCALE_PATHS = {
       'fr' => 'additifs',
       'uk' => 'additives',
       'us' => 'additives',
       'world' => 'additives'
-    }
+    }.freeze
 
     class << self
-
       # Get additives
       #
       def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
-          page_url = "https://#{locale}.#{domain}/#{path}"
+        if (path = LOCALE_PATHS[locale])
+          page_url = "https://#{locale}.#{domain}/facets/#{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
+              'name' => link.text.strip,
+              'url' => URI.join(page_url, link.attr('href')).to_s,
+              'products_count' => columns[1].text.to_i
             }
 
             riskiness = columns.last.attr('class')
-            if riskiness
-              attributes["riskiness"] = riskiness[/level_(\d+)/, 1].to_i
-            end
+            attributes['riskiness'] = riskiness[/level_(\d+)/, 1].to_i if riskiness
 
             new(attributes)
           end
         end
       end
-
     end
 
     # Get products with additive
@@ -46,6 +43,5 @@ module Openfoodfacts
     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

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 require 'hashie'
 
 module Openfoodfacts
   class Allergen < Hashie::Mash
-
     # TODO: Add more locales
     LOCALE_PATHS = {
       'fr' => 'allergenes',
       'uk' => 'allergens',
       'us' => 'allergens',
       'world' => 'allergens'
-    }
+    }.freeze
 
     class << self
-
       # Get allergens
       #
       def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
+        if (path = LOCALE_PATHS[locale])
           Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
         end
       end
-
     end
 
     # Get products with allergen
@@ -28,6 +27,5 @@ module Openfoodfacts
     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

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 require 'hashie'
 
 module Openfoodfacts
   class Brand < Hashie::Mash
-
     # TODO: Add more locales
     LOCALE_PATHS = {
       'fr' => 'marques',
       'uk' => 'brands',
       'us' => 'brands',
       'world' => 'brands'
-    }
+    }.freeze
 
     class << self
-
       # Get product brands
       #
       def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
-          Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
+        if (path = LOCALE_PATHS[locale])
+          Product.tags_from_page(self, "https://#{locale}.#{domain}/facets/#{path}")
         end
       end
-
     end
 
     # Get products with brand
@@ -28,6 +27,5 @@ module Openfoodfacts
     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

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 require 'hashie'
 
 module Openfoodfacts
   class Category < Hashie::Mash
-
     # TODO: Add more locales
     LOCALE_PATHS = {
       'fr' => 'categories',
       'uk' => 'categories',
       'us' => 'categories',
       'world' => 'categories'
-    }
+    }.freeze
 
     class << self
-
       # Get categories
       #
       def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
+        if (path = LOCALE_PATHS[locale])
           Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
         end
       end
-
     end
 
     # Get products with category
@@ -28,6 +27,5 @@ module Openfoodfacts
     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

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 require 'hashie'
 
 module Openfoodfacts
   class City < Hashie::Mash
-
     # TODO: Add more locales
     LOCALE_PATHS = {
       'fr' => 'communes',
       'uk' => 'cities',
       'us' => 'cities',
       'world' => 'cities'
-    }
+    }.freeze
 
     class << self
-
       # Get cities
       #
       def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
+        if (path = LOCALE_PATHS[locale])
           Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
         end
       end
-
     end
 
     # Get products with city
@@ -28,6 +27,5 @@ module Openfoodfacts
     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

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 require 'hashie'
 
 module Openfoodfacts
   class Contributor < Hashie::Mash
-
     # TODO: Add more locales
     LOCALE_PATHS = {
       'fr' => 'contributeurs',
       'uk' => 'contributors',
       'us' => 'contributors',
       'world' => 'contributors'
-    }
+    }.freeze
 
     class << self
-
       # Get contributors
       #
       def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
+        if (path = LOCALE_PATHS[locale])
           Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
         end
       end
-
     end
 
     # Get products for contributor
@@ -28,6 +27,5 @@ module Openfoodfacts
     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

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 require 'hashie'
 
 module Openfoodfacts
   class Country < Hashie::Mash
-
     # TODO: Add more locales
     LOCALE_PATHS = {
       'fr' => 'pays',
       'uk' => 'countries',
       'us' => 'countries',
       'world' => 'countries'
-    }
+    }.freeze
 
     class << self
-
       # Get countries
       #
       def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
+        if (path = LOCALE_PATHS[locale])
           Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
         end
       end
-
     end
 
     # Get products with country
@@ -28,6 +27,5 @@ module Openfoodfacts
     def products(page: -1)
       Product.from_website_page(url, page: page, products_count: products_count) if url
     end
-
   end
 end

data/lib/openfoodfacts/entry_date.rb

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 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'
-    }
+    }.freeze
 
     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}")
+        if (path = LOCALE_PATHS[locale])
+          Product.tags_from_page(self, "https://#{locale}.#{domain}/facets/#{path}")
         end
       end
-
     end
 
     # Get products with entry date
@@ -28,6 +27,5 @@ module Openfoodfacts
     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

@@ -1,22 +1,22 @@
+# frozen_string_literal: true
+
 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'
-    }
+    }.freeze
 
     class << self
       def items(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
-          html = URI.open("https://#{locale}.#{domain}/#{path}").read
+        if (path = LOCALE_PATHS[locale])
+          html = Openfoodfacts.http_get("https://#{locale}.#{domain}/#{path}").read
           dom = Nokogiri::HTML.fragment(html)
 
           titles = dom.css('#main_column h2')
@@ -25,26 +25,21 @@ module Openfoodfacts
 
             element = item.next_sibling
             while !element.nil? && element.node_name != 'h2'
-              if element.node_name == 'p'
-                paragraphs.push(element)
-              end
+              paragraphs.push(element) if element.node_name == 'p'
 
               element = element.next_sibling
             end
 
-            if index == titles.length - 1
-              paragraphs = paragraphs[0..-3]
-            end
+            paragraphs = paragraphs[0..-3] if index == titles.length - 1
 
             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
-            })
+                  '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.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'hashie'
+
+module Openfoodfacts
+  class Ingredient < Hashie::Mash
+    # TODO: Add more locales
+    LOCALE_PATHS = {
+      'fr' => 'ingredients',
+      'uk' => 'ingredients',
+      'us' => 'ingredients',
+      'world' => 'ingredients'
+    }.freeze
+
+    class << self
+      # Get labels
+      #
+      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 label
+    #
+    def products(page: -1)
+      Product.from_website_page(url, page: page, products_count: products_count) if url
+    end
+  end
+end

data/lib/openfoodfacts/ingredient_that_may_be_from_palm_oil.rb

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 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'
-    }
+    }.freeze
 
     class << self
-
       # Get ingredients that may be from palm oil
       #
       def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
+        if (path = LOCALE_PATHS[locale])
           Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
         end
       end
-
     end
 
     # Get products with ingredient that may be from palm oil
@@ -28,6 +27,5 @@ module Openfoodfacts
     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

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 require 'hashie'
 
 module Openfoodfacts
   class Label < Hashie::Mash
-
     # TODO: Add more locales
     LOCALE_PATHS = {
       'fr' => 'labels',
       'uk' => 'labels',
       'us' => 'labels',
       'world' => 'labels'
-    }
+    }.freeze
 
     class << self
-
       # Get labels
       #
       def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
+        if (path = LOCALE_PATHS[locale])
           Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
         end
       end
-
     end
 
     # Get products with label
@@ -28,6 +27,5 @@ module Openfoodfacts
     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

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 require 'hashie'
 
 module Openfoodfacts
   class Language < Hashie::Mash
-
     # TODO: Add more locales
     LOCALE_PATHS = {
       'fr' => 'langues',
       'uk' => 'languages',
       'us' => 'languages',
       'world' => 'languages'
-    }
+    }.freeze
 
     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}")
+        if (path = LOCALE_PATHS[locale])
+          Product.tags_from_page(self, "https://#{locale}.#{domain}/facets/#{path}")
         end
       end
-
     end
 
     # Get products with language
@@ -28,6 +27,5 @@ module Openfoodfacts
     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

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 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'
-    }
+    }.freeze
 
     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}")
+        if (path = LOCALE_PATHS[locale])
+          Product.tags_from_page(self, "https://#{locale}.#{domain}/facets/#{path}")
         end
       end
-
     end
 
     # Get products with last edit date
@@ -28,6 +27,5 @@ module Openfoodfacts
     def products(page: -1)
       Product.from_website_page(url, page: page, products_count: products_count) if url
     end
-
   end
 end