openbeautyfacts 0.6.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 101290dad91405b7afc40eace7e6621731eaf08add56549ad55af3912c55b3c2
-  data.tar.gz: a0708f6c073740c8534e9ba872f7f742c4ffe4b5a5be63a9ee4e828345fadfa2
+  metadata.gz: ee3e3eb895b24332b15083b9e7ab0d0fe14d711792b2bf3e83c4de35e0ccada7
+  data.tar.gz: 976b0855a3e6653b90412d53cb132a69cd34e2d56e099da89b30b9724f19e75f
 SHA512:
-  metadata.gz: e4b272685be3c8099c623e76c057ee00c67f86a1bda69fd24088a41263b3b37e117f1d6341a9d71bde99d640dc4c1da55fbd7277cb5b9fa84613ad706da2cb9e
-  data.tar.gz: 604f209cca866626667ae75bc1f873f11a73fe87adfd177e70ee449c627919aa42d57c4fb1f0a6b55451f7abef758908d4001f18b8cdbc2461a30764608326a1
+  metadata.gz: 0dfbf80e11a3721d1f34e5a742bd258f3064a52cd258f663c66646320448e9366bd9c2743ead584d942e9b7c2798c13f24de90442b84b4d478f34f7083573be8
+  data.tar.gz: 5f57a30b0d77f9e9dd219cc17383f330b7f0db32a3265414e0ad169cd62705fb617f78cb845913a9fbdfdd447131ae7dd50953eb15bb47c193e020a89ad26476

data/README.md

@@ -1,4 +1,10 @@
-# Open Beauty Facts
+# Open Beauty Facts Ruby SDK
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://static.openbeautyfacts.org/images/logos/obf-logo-horizontal-dark.png?refresh_github_cache=1">
+  <source media="(prefers-color-scheme: light)" srcset="https://static.openbeautyfacts.org/images/logos/obf-logo-horizontal-light.png?refresh_github_cache=1">
+  <img height="48" src="https://static.openbeautyfacts.org/images/logos/obf-logo-horizontal-light.svg"/>
+</picture>
 
 [![Gem Version](https://badge.fury.io/rb/openbeautyfacts.svg)](https://badge.fury.io/rb/openbeautyfacts)
 [![Build Status](https://github.com/openfoodfacts/openbeautyfacts-ruby/actions/workflows/ruby.yml/badge.svg)](https://github.com/openfoodfacts/openbeautyfacts-ruby/actions/workflows/ruby.yml)
@@ -6,6 +12,9 @@
 [![Documentation](https://inch-ci.org/github/openfoodfacts/openbeautyfacts-ruby.svg?branch=master)](https://inch-ci.org/github/openfoodfacts/openbeautyfacts-ruby)
 
 API Wrapper for [Open Beauty Facts](https://openbeautyfacts.org/), the open database about beauty products.
+- We have a similar package for food: https://github.com/openfoodfacts/openfoodfacts-ruby
+- Note: This package needs updates for the newest APIs.
+- Please see on https://wiki.openfoodfacts.org/API/Ruby how to join the community to help
 
 ## Installation
 
@@ -112,3 +121,12 @@ 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
+
+## Using this SDK and Third party applications
+
+- If you use this SDK, feel free to open a PR to add your application in the list in [REUSERS.md](https://github.com/openfoodfacts/openbeautyfacts-ruby/blob/develop/REUSERS.md)
+- 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.
+- 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
+
+## 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

data/lib/openbeautyfacts/additive.rb

@@ -1,51 +1,21 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class Additive < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'additifs',
-      'uk' => 'additives',
-      'us' => 'additives',
-      'world' => 'additives'
-    }
+  class Additive < Openfoodfacts::Additive
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     class << self
-
-      # Get additives
-      #
+      # Override all method to use openbeautyfacts domain
       def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
-          page_url = "https://#{locale}.#{domain}/#{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[3].attr('class')
-            if riskiness
-              attributes["riskiness"] = riskiness[/level_(\d+)/, 1].to_i
-            end
-
-            new(attributes)
-          end
-        end
+        super(locale: locale, domain: domain)
       end
-
     end
 
-    # Get products with additive
-    #
+    # Override products method to use openbeautyfacts domain
     def products(page: -1)
-      Product.from_website_page(url, page: page, products_count: products_count) if url
+      super(page: page)
     end
-
   end
 end

data/lib/openbeautyfacts/allergen.rb

@@ -1,33 +1,25 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class Allergen < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'allergenes',
-      'uk' => 'allergens',
-      'us' => 'allergens',
-      'world' => 'allergens'
-    }
+  class Allergen < Openfoodfacts::Allergen
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     class << self
-
-      # Get allergens
-      #
-      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
-          Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
-        end
+      # Override all method to use openbeautyfacts domain if it exists
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN, **options)
+        super(locale: locale, domain: domain, **options)
+      rescue NoMethodError
+        # Method doesn't exist in parent class, skip
       end
-
     end
 
-    # Get products with allergen
-    #
+    # Override products method to use openbeautyfacts domain if it exists
     def products(page: -1)
-      Product.from_website_page(url, page: page, products_count: products_count) if url
+      super(page: page)
+    rescue NoMethodError
+      # Method doesn't exist in parent class, skip
     end
-
   end
 end

data/lib/openbeautyfacts/brand.rb

@@ -1,33 +1,25 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class Brand < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'marques',
-      'uk' => 'brands',
-      'us' => 'brands',
-      'world' => 'brands'
-    }
+  class Brand < Openfoodfacts::Brand
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     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}")
-        end
+      # Override all method to use openbeautyfacts domain if it exists
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN, **options)
+        super(locale: locale, domain: domain, **options)
+      rescue NoMethodError
+        # Method doesn't exist in parent class, skip
       end
-
     end
 
-    # Get products with brand
-    #
+    # Override products method to use openbeautyfacts domain if it exists
     def products(page: -1)
-      Product.from_website_page(url, page: page, products_count: products_count) if url
+      super(page: page)
+    rescue NoMethodError
+      # Method doesn't exist in parent class, skip
     end
-
   end
 end

data/lib/openbeautyfacts/category.rb

@@ -1,33 +1,25 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class Category < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'categories',
-      'uk' => 'categories',
-      'us' => 'categories',
-      'world' => 'categories'
-    }
+  class Category < Openfoodfacts::Category
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     class << self
-
-      # Get categories
-      #
-      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
-          Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
-        end
+      # Override all method to use openbeautyfacts domain if it exists
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN, **options)
+        super(locale: locale, domain: domain, **options)
+      rescue NoMethodError
+        # Method doesn't exist in parent class, skip
       end
-
     end
 
-    # Get products with category
-    #
+    # Override products method to use openbeautyfacts domain if it exists
     def products(page: -1)
-      Product.from_website_page(url, page: page, products_count: products_count) if url
+      super(page: page)
+    rescue NoMethodError
+      # Method doesn't exist in parent class, skip
     end
-
   end
 end

data/lib/openbeautyfacts/city.rb

@@ -1,33 +1,25 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class City < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'communes',
-      'uk' => 'cities',
-      'us' => 'cities',
-      'world' => 'cities'
-    }
+  class City < Openfoodfacts::City
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     class << self
-
-      # Get cities
-      #
-      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
-          Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
-        end
+      # Override all method to use openbeautyfacts domain if it exists
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN, **options)
+        super(locale: locale, domain: domain, **options)
+      rescue NoMethodError
+        # Method doesn't exist in parent class, skip
       end
-
     end
 
-    # Get products with city
-    #
+    # Override products method to use openbeautyfacts domain if it exists
     def products(page: -1)
-      Product.from_website_page(url, page: page, products_count: products_count) if url
+      super(page: page)
+    rescue NoMethodError
+      # Method doesn't exist in parent class, skip
     end
-
   end
 end

data/lib/openbeautyfacts/contributor.rb

@@ -1,33 +1,25 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class Contributor < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'contributeurs',
-      'uk' => 'contributors',
-      'us' => 'contributors',
-      'world' => 'contributors'
-    }
+  class Contributor < Openfoodfacts::Contributor
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     class << self
-
-      # Get contributors
-      #
-      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
-          Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
-        end
+      # Override all method to use openbeautyfacts domain if it exists
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN, **options)
+        super(locale: locale, domain: domain, **options)
+      rescue NoMethodError
+        # Method doesn't exist in parent class, skip
       end
-
     end
 
-    # Get products for contributor
-    #
+    # Override products method to use openbeautyfacts domain if it exists
     def products(page: -1)
-      Product.from_website_page(url, page: page, products_count: products_count) if url
+      super(page: page)
+    rescue NoMethodError
+      # Method doesn't exist in parent class, skip
     end
-
   end
 end

data/lib/openbeautyfacts/country.rb

@@ -1,33 +1,25 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class Country < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'pays',
-      'uk' => 'countries',
-      'us' => 'countries',
-      'world' => 'countries'
-    }
+  class Country < Openfoodfacts::Country
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     class << self
-
-      # Get countries
-      #
-      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
-          Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
-        end
+      # Override all method to use openbeautyfacts domain if it exists
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN, **options)
+        super(locale: locale, domain: domain, **options)
+      rescue NoMethodError
+        # Method doesn't exist in parent class, skip
       end
-
     end
 
-    # Get products with country
-    #
+    # Override products method to use openbeautyfacts domain if it exists
     def products(page: -1)
-      Product.from_website_page(url, page: page, products_count: products_count) if url
+      super(page: page)
+    rescue NoMethodError
+      # Method doesn't exist in parent class, skip
     end
-
   end
 end

data/lib/openbeautyfacts/entry_date.rb

@@ -1,33 +1,25 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class EntryDate < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'dates-d-ajout',
-      'uk' => 'entry-dates',
-      'us' => 'entry-dates',
-      'world' => 'entry-dates'
-    }
+  class EntryDate < Openfoodfacts::EntryDate
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     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
+      # Override all method to use openbeautyfacts domain if it exists
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN, **options)
+        super(locale: locale, domain: domain, **options)
+      rescue NoMethodError
+        # Method doesn't exist in parent class, skip
       end
-
     end
 
-    # Get products with entry date
-    #
+    # Override products method to use openbeautyfacts domain if it exists
     def products(page: -1)
-      Product.from_website_page(url, page: page, products_count: products_count) if url
+      super(page: page)
+    rescue NoMethodError
+      # Method doesn't exist in parent class, skip
     end
-
   end
-end
+end

data/lib/openbeautyfacts/faq.rb

@@ -1,50 +1,25 @@
-require 'hashie'
-require 'nokogiri'
-require 'open-uri'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class Faq < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'questions-frequentes',
-      'uk' => 'faq',
-      'us' => 'faq',
-      'world' => 'faq'
-    }
+  class Faq < Openfoodfacts::Faq
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     class << self
-      def items(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
-          html = URI.open("https://#{locale}.#{domain}/#{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
+      # Override all method to use openbeautyfacts domain if it exists
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN, **options)
+        super(locale: locale, domain: domain, **options)
+      rescue NoMethodError
+        # Method doesn't exist in parent class, skip
       end
     end
 
+    # Override products method to use openbeautyfacts domain if it exists
+    def products(page: -1)
+      super(page: page)
+    rescue NoMethodError
+      # Method doesn't exist in parent class, skip
+    end
   end
 end

data/lib/openbeautyfacts/ingredient.rb

@@ -1,33 +1,25 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class Ingredient < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'ingredients',
-      'uk' => 'ingredients',
-      'us' => 'ingredients',
-      'world' => 'ingredients'
-    }
+  class Ingredient < Openfoodfacts::Ingredient
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     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
+      # Override all method to use openbeautyfacts domain if it exists
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN, **options)
+        super(locale: locale, domain: domain, **options)
+      rescue NoMethodError
+        # Method doesn't exist in parent class, skip
       end
-
     end
 
-    # Get products with label
-    #
+    # Override products method to use openbeautyfacts domain if it exists
     def products(page: -1)
-      Product.from_website_page(url, page: page, products_count: products_count) if url
+      super(page: page)
+    rescue NoMethodError
+      # Method doesn't exist in parent class, skip
     end
-
   end
 end

data/lib/openbeautyfacts/ingredient_that_may_be_from_palm_oil.rb

@@ -1,33 +1,25 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  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 IngredientThatMayBeFromPalmOil < Openfoodfacts::IngredientThatMayBeFromPalmOil
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     class << self
-
-      # Get ingredients that may be from palm oil
-      #
-      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if path = LOCALE_PATHS[locale]
-          Product.tags_from_page(self, "https://#{locale}.#{domain}/#{path}")
-        end
+      # Override all method to use openbeautyfacts domain if it exists
+      def all(locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN, **options)
+        super(locale: locale, domain: domain, **options)
+      rescue NoMethodError
+        # Method doesn't exist in parent class, skip
       end
-
     end
 
-    # Get products with ingredient that may be from palm oil
-    #
+    # Override products method to use openbeautyfacts domain if it exists
     def products(page: -1)
-      Product.from_website_page(url, page: page, products_count: products_count) if url
+      super(page: page)
+    rescue NoMethodError
+      # Method doesn't exist in parent class, skip
     end
-
   end
 end