openbeautyfacts 0.6.3 → 0.11.0

data/lib/openbeautyfacts/product.rb

@@ -1,197 +1,40 @@
-require 'cgi'
-require 'hashie'
-require 'net/http'
-require 'nokogiri'
-require 'open-uri'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class Product < Hashie::Mash
+  class Product < Openfoodfacts::Product
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
-    # TODO: Add more locales
+    # OpenBeautyFacts uses the same URL prefixes as OpenFoodFacts
     LOCALE_WEBURL_PREFIXES = {
       'fr' => 'produit',
       'uk' => 'product',
       'us' => 'product',
       'world' => 'product'
-    }
+    }.freeze
 
     class << self
-
-      # Get product
-      #
-      def get(code, locale: DEFAULT_LOCALE)
-        if code
-          product_url = url(code, locale: locale)
-          json = URI.open(product_url).read
-          hash = JSON.parse(json)
-
-          new(hash["product"]) if !hash["status"].nil? && hash["status"] == 1
-        end
-      end
-      alias_method :find, :get
-
-      # Return product API URL
-      #
+      # Override URL method to use openbeautyfacts domain
       def url(code, locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        if code
-          path = "api/v0/produit/#{code}.json"
-          "https://#{locale}.#{domain}/#{path}"
-        end
-      end
-
-      # Search products
-      #
-      def search(terms, locale: DEFAULT_LOCALE, page: 1, page_size: 20, sort_by: 'unique_scans_n', domain: DEFAULT_DOMAIN)
-        terms = CGI.escape(terms)
-        path = "cgi/search.pl?search_terms=#{terms}&jqm=1&page=#{page}&page_size=#{page_size}&sort_by=#{sort_by}"
-        url = "https://#{locale}.#{domain}/#{path}"
-        json = URI.open(url).read
-        hash = JSON.parse(json)
-        html = hash["jqm"]
-
-        from_jquery_mobile_list(html)
-      end
-      alias_method :where, :search
-
-      def from_html_list(html, list_css_selector, code_from_link_regex, locale: 'world')
-        dom = Nokogiri::HTML.fragment(html)
-        dom.css(list_css_selector).map do |product|
-          attributes = {}
-
-          if link = product.css('a').first
-            attributes["product_name"] = link.inner_text.strip
-
-            if code = link.attr('href')[code_from_link_regex, 1]
-              attributes["_id"] = code
-              attributes["code"] = code
-            end
-          end
-
-          if image = product.css('img').first and image_url = image.attr('src')
-            attributes["image_small_url"] = image_url
-            attributes["lc"] = Locale.locale_from_link(image_url)
-          end
-          attributes["lc"] ||= locale
-
-          new(attributes)
-        end
-
-      end
-
-      def from_jquery_mobile_list(jqm_html)
-        from_html_list(jqm_html, 'ul#search_results_list li:not(#loadmore)', /code=(\d+)\Z/i)
-      end
-
-      def from_website_list(html, locale: 'world')
-        from_html_list(html, 'ul.products li', /\/(\d+)\/?/i, locale: 'world')
+        super(code, locale: locale, domain: domain)
       end
 
-      # page -1 to fetch all pages
-      def from_website_page(page_url, page: -1, products_count: nil)
-        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
-          else
-            products = []
-
-            page = 1
-            begin
-              products_on_page = from_website_page(page_url, page: page)
-              products += products_on_page
-              page += 1
-            end while products_on_page.any?
-
-            products
-          end
-        else
-          html = URI.open("#{page_url}/#{page}").read
-          from_website_list(html, locale: Locale.locale_from_link(page_url))
-        end
+      # Override search method to use openbeautyfacts domain
+      def search(terms, locale: DEFAULT_LOCALE, page: 1, page_size: 20, sort_by: 'unique_scans_n',
+                 domain: DEFAULT_DOMAIN)
+        super(terms, locale: locale, page: page, page_size: page_size, sort_by: sort_by, domain: domain)
       end
-
-      def tags_from_page(_klass, page_url, &custom_tag_parsing)
-        html = URI.open(page_url).read
-        dom = Nokogiri::HTML.fragment(html)
-
-        dom.css('table#tagstable tbody tr').map do |tag|
-          if custom_tag_parsing
-            custom_tag_parsing.call(tag)
-          else
-            link = tag.css('a').first
-
-            name = link.text.strip
-            img_alt = link.css('img').attr('alt')
-            if (name.nil? || name == '') && img_alt
-              img_alt_text = img_alt.to_s.strip
-              name = if img_alt_text.include?(':')
-                img_alt_text.split(':').last.strip
-              else
-                img_alt_text[/\s+([^\s]+)$/, 1]
-              end
-            end
-
-            _klass.new({
-              "name" => name,
-              "url" => URI.join(page_url, link.attr('href')).to_s,
-              "products_count" => tag.css('td')[1].text.to_i
-            })
-          end
-        end
-      end
-
     end
 
-    # Fetch product
-    #
-    def fetch
-      if (self.code)
-        product = self.class.get(self.code)
-        self.merge!(product)
-      end
-
-      self
+    # Override weburl method to use openbeautyfacts domain
+    def weburl(locale: nil, domain: DEFAULT_DOMAIN)
+      super(locale: locale, domain: domain)
     end
-    alias_method :reload, :fetch
 
-    # Update product
-    # Only product_name, brands and quantity fields seems to be updatable throught app / API.
-    # User can be nil
-    # Tested not updatable fields: countries, ingredients_text, purchase_places, purchase_places_tag, purchase_places_tags
-    #
+    # Override update method to use openbeautyfacts domain
     def update(user: nil, domain: DEFAULT_DOMAIN)
-      if self.code && self.lc
-        subdomain = self.lc == 'world' ? 'world' : "world-#{self.lc}"
-        path = 'cgi/product_jqm.pl'
-        uri = URI("https://#{subdomain}.#{domain}/#{path}")
-        params = self.to_hash
-        params.merge!("user_id" => user.user_id, "password" => user.password) if user
-        response = Net::HTTP.post_form(uri, params)
-
-        data = JSON.parse(response.body)
-        data["status"] == 1
-      else
-        false
-      end
-    end
-    alias_method :save, :update
-
-    # Return Product API URL
-    #
-    def url(locale: DEFAULT_LOCALE)
-      self.class.url(self.code, locale: locale)
+      super(user: user, domain: domain)
     end
-
-    # Return Product web URL according to locale
-    #
-    def weburl(locale: nil, domain: DEFAULT_DOMAIN)
-      locale ||= self.lc || DEFAULT_LOCALE
-
-      if self.code && prefix = LOCALE_WEBURL_PREFIXES[locale]
-        path = "#{prefix}/#{self.code}"
-        "https://#{locale}.#{domain}/#{path}"
-      end
-    end
-
   end
 end

data/lib/openbeautyfacts/product_state.rb

@@ -1,33 +1,25 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class ProductState < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'etats',
-      'uk' => 'states',
-      'us' => 'states',
-      'world' => 'states'
-    }
+  class ProductState < Openfoodfacts::ProductState
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     class << self
-
-      # Get product states
-      #
-      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 state
-    #
+    # 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/purchase_place.rb

@@ -1,33 +1,25 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class PurchasePlace < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'lieux-de-vente',
-      'uk' => 'purchase-places',
-      'us' => 'purchase-places',
-      'world' => 'purchase-places'
-    }
+  class PurchasePlace < Openfoodfacts::PurchasePlace
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     class << self
-
-      # Get purchase places
-      #
-      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 purchase place
-    #
+    # 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/store.rb

@@ -1,33 +1,25 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class Store < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'magasins',
-      'uk' => 'stores',
-      'us' => 'stores',
-      'world' => 'stores'
-    }
+  class Store < Openfoodfacts::Store
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     class << self
-
-      # Get stores
-      #
-      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 from store
-    #
+    # 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/trace.rb

@@ -1,33 +1,25 @@
-require 'hashie'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class Trace < Hashie::Mash
-
-    # TODO: Add more locales
-    LOCALE_PATHS = {
-      'fr' => 'traces',
-      'uk' => 'traces',
-      'us' => 'traces',
-      'world' => 'traces'
-    }
+  class Trace < Openfoodfacts::Trace
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     class << self
-
-      # Get traces
-      #
-      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 trace
-    #
+    # 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/user.rb

@@ -1,40 +1,25 @@
-require 'net/http'
+# frozen_string_literal: true
 
 module Openbeautyfacts
-  class User < Hashie::Mash
+  class User < Openfoodfacts::User
+    # Override constants for openbeautyfacts domain
+    DEFAULT_LOCALE = Locale::GLOBAL
+    DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
     class << self
-
-      # Login
-      #
-      def login(user_id, password, locale: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
-        path = 'cgi/session.pl'
-        uri = URI("https://#{locale}.#{domain}/#{path}")
-        params = {
-          "jqm" => "1",
-          "user_id" => user_id,
-          "password" => password
-        }
-
-        response = Net::HTTP.post_form(uri, params)
-        data = JSON.parse(response.body)
-
-        if data['user_id']
-          data.merge!(password: password)
-          new(data)
-        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
 
-    # Login
-    #
-    def login(locale: DEFAULT_LOCALE)
-      if user = self.class.login(self.user_id, self.password, locale: locale)
-        self.name = user.name
-        self
-      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/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Openbeautyfacts
-  VERSION = "0.6.3"
+  VERSION = '0.11.0'
 end

data/lib/openbeautyfacts.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
+require 'openfoodfacts'
+
+require_relative 'openbeautyfacts/version'
+require_relative 'openbeautyfacts/locale'
 require_relative 'openbeautyfacts/additive'
 require_relative 'openbeautyfacts/brand'
 require_relative 'openbeautyfacts/category'
@@ -10,7 +16,6 @@ require_relative 'openbeautyfacts/ingredient'
 require_relative 'openbeautyfacts/ingredient_that_may_be_from_palm_oil'
 require_relative 'openbeautyfacts/label'
 require_relative 'openbeautyfacts/last_edit_date'
-require_relative 'openbeautyfacts/locale'
 require_relative 'openbeautyfacts/manufacturing_place'
 require_relative 'openbeautyfacts/mission'
 require_relative 'openbeautyfacts/number_of_ingredients'
@@ -25,19 +30,12 @@ require_relative 'openbeautyfacts/purchase_place'
 require_relative 'openbeautyfacts/store'
 require_relative 'openbeautyfacts/trace'
 require_relative 'openbeautyfacts/user'
-require_relative 'openbeautyfacts/version'
-
-require 'json'
-require 'nokogiri'
-require 'open-uri'
 
 module Openbeautyfacts
-
   DEFAULT_LOCALE = Locale::GLOBAL
   DEFAULT_DOMAIN = 'openbeautyfacts.org'
 
   class << self
-
     # Return locale from link
     #
     def locale_from_link(link)
@@ -61,6 +59,5 @@ module Openbeautyfacts
     def product_url(barcode, locale: DEFAULT_LOCALE)
       Product.url(barcode, locale: locale)
     end
-
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: openbeautyfacts
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.11.0
 platform: ruby
 authors:
 - Nicolas Leger
-autorequire: 
+- Pierre Slamich
 bindir: exe
 cert_chain: []
-date: 2022-02-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: openfoodfacts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -36,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -59,33 +73,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.25'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -106,17 +120,17 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
 description: Open Beauty Facts API Wrapper, the open database about beauty products.
 email:
-- opensource@nleger.com
+- contact@openfoodfacts.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -154,13 +168,10 @@ files:
 - lib/openbeautyfacts/trace.rb
 - lib/openbeautyfacts/user.rb
 - lib/openbeautyfacts/version.rb
-- test/minitest_helper.rb
-- test/test_openbeautyfacts.rb
 homepage: https://github.com/openfoodfacts/openbeautyfacts-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -175,8 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Open Beauty Facts API Wrapper
 test_files: []

data/test/minitest_helper.rb

@@ -1,18 +0,0 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'openbeautyfacts'
-
-require 'minitest/autorun'
-
-require 'webmock/minitest'
-require 'vcr'
-
-# Avoid OpenSSL certificate verify failed error
-if ENV.has_key?('APPVEYOR') && Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.4')
-  require 'openssl'
-  OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
-end
-
-VCR.configure do |c|
-  c.cassette_library_dir = "test/fixtures"
-  c.hook_into :webmock
-end