openfoodfacts 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 273c69bba5eca84c0012464a5442bde9793f36ab
-  data.tar.gz: e70b9511d2bf3ade15e7edf8dcd534d7d68bdee7
+  metadata.gz: 09d860eb4659431d4bf589f95572ab8dd0f8fc8d
+  data.tar.gz: a23608b0c33c5450db5cacb99b55e9234f1cf96c
 SHA512:
-  metadata.gz: 9db37b080d40213333cff30b49a981afa3b40a726f84c68fa45beda509e8a918909344a57538296fe9c879a724b3686047883458fd1e928128020204d2e633ce
-  data.tar.gz: b4a28ae44b9072407daf43127feb4fc9096fb5e1e7d2e8b763039e54f171c159d05f00226f29593dbc95695ae6e8eab0a363bfafa7703d639b145363f678e430
+  metadata.gz: 33fb64a4602691cd37e59d17ad1d659b54888bac32a8ec35307bb324fd61d53964d56c038ff1b748b44e7c0fc3749e8f2d265cef83cf1a74260c06eb036db5a3
+  data.tar.gz: 0c3efdae29963a8d5cb8973184bd7ad1c0a9ebdc45078f48b7a0fd0bbb43769be901dd8ee07cb635c84110f264f8077570786664fdad51d78c0b35b96aae3f6b

data/README.md

@@ -1,7 +1,7 @@
 # OpenFoodFacts
 
 [![Gem Version](https://badge.fury.io/rb/openfoodfacts.svg)](http://badge.fury.io/rb/openfoodfacts)
-[![Build Status](https://travis-ci.org/nicolasleger/openfoodfacts-ruby.svg)](https://travis-ci.org/nicolasleger/openfoodfacts-ruby)
+[![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)
 [![Coverage Status](https://coveralls.io/repos/nicolasleger/openfoodfacts-ruby/badge.svg)](https://coveralls.io/r/nicolasleger/openfoodfacts-ruby)
@@ -31,8 +31,8 @@ require 'openfoodfacts'
 
 # Browse a product
 
-barcode = "3029330003533"
-product = Openfoodfacts.product(barcode, locale: 'fr') # or Openfoodfacts::Product.get
+code = "3029330003533"
+product = Openfoodfacts::Product.get(code, locale: 'fr')
 
 product.product_name
 # => "Crousti Moelleux Complet"
@@ -40,6 +40,15 @@ product.product_name
 product.nutriments.to_hash
 # => {"sodium"=>"0.44", "sugars"=>6.5, "fat_unit"=>"g", "carbohydrates_unit"=>"g", "proteins_unit"=>"g", "nutrition-score-fr_100g"=>-2, "fat"=>2.5, "proteins_serving"=>12.8, "sodium_serving"=>0.535, "salt"=>1.1176, "proteins"=>10.5, "nutrition-score-uk_serving"=>-2, "nutrition-score-fr"=>-2, "fat_serving"=>3.04, "sugars_unit"=>"g", "sugars_100g"=>"6.5", "sodium_unit"=>"g", "saturated-fat_unit"=>"g", "saturated-fat_serving"=>0.608, "sodium_100g"=>0.44, "fiber_unit"=>"g", "energy"=>1067, "energy_unit"=>"kJ", "sugars_serving"=>7.9, "carbohydrates_100g"=>44, "nutrition-score-uk"=>-2, "proteins_100g"=>10.5, "fiber_serving"=>7.29, "carbohydrates_serving"=>53.5, "nutrition-score-fr_serving"=>-2, "energy_serving"=>1300, "fat_100g"=>"2.5", "saturated-fat_100g"=>"0.5", "nutrition-score-uk_100g"=>-2, "fiber"=>6, "salt_serving"=>1.36, "salt_100g"=>"1.1176", "carbohydrates"=>44, "fiber_100g"=>6, "energy_100g"=>1067, "saturated-fat"=>0.5}
 
+# Update product
+
+user = Openfoodfacts::User.login("USERNAME", "PASSWORD")
+if user
+    product.brands = "Jacquet"
+    product.update
+    # true
+end
+
 # Search products
 
 Openfoodfacts::Product.search("Chocolate", locale: 'world', page_size: 3)
@@ -47,7 +56,7 @@ Openfoodfacts::Product.search("Chocolate", locale: 'world', page_size: 3)
 
 # Config
 
-Openfoodfacts.locales
+Openfoodfacts:Locale.all
 # => ["ad", "ad-es", "ad-fr", "ad-pt", "ae", "al", "am", "ar", "at", "au", "ax", "az", "bd", "be", "be-de", "be-fr", "bf", "bg", "bi", "bi-rn", "bn", "br", "by", "by-be", "bz", "ca", "ca-fr", "cg", "ch", "ch-fr", "ch-it", "ci", "cl", "cn", "co", "cr", "cu", "cy", "cy-tr", "cz", "de", "dk", "do", "dz", "dz-fr", "ec", "eg", "es", "es-ca", "es-eu", "es-gl", "fi", "fi-sv", "fr", "ga", "gf", "gn", "gp", "gr", "hk", "hr", "hu", "id", "ie", "ie-ga", "il", "il-ar", "il-ru", "in", "iq", "iq-ku", "ir", "is", "it", "jp", "ke", "ke-sw", "kh", "kr", "kw", "kz", "kz-kk", "lb", "lk", "lk-ta", "lu", "lu-de", "lu-lb", "lv", "ma", "ma-es", "ma-fr", "mc", "md", "mf", "ml", "mn", "mo", "mo-zh", "mq", "mr", "mt", "mt-mt", "mu", "mx", "my", "nc", "nl", "no", "nz", "nz-mi", "pa", "pe", "pf", "ph", "ph-tl", "pl", "pm", "pt", "qa", "re", "ro", "rs", "ru", "sa", "se", "sg", "sg-ms", "sg-ta", "sg-zh", "si", "sk", "sn", "sy", "th", "tn", "tr", "tw", "tz", "tz-sw", "ua", "uk", "us", "ve", "vn", "vu", "vu-bi", "world", "ye", "yt", "za", "za-af", "za-nr", "za-ss", "za-st", "za-tn", "za-ts", "za-ve", "za-xh", "za-zu"]
 ```
 

data/lib/openfoodfacts.rb

@@ -1,4 +1,6 @@
+require_relative 'openfoodfacts/locale'
 require_relative 'openfoodfacts/product'
+require_relative 'openfoodfacts/user'
 require_relative 'openfoodfacts/version'
 
 require 'json'
@@ -6,26 +8,21 @@ require 'nokogiri'
 require 'open-uri'
 
 module Openfoodfacts
-  DEFAULT_LOCALE = 'world'
+
+  DEFAULT_LOCALE = Locale::GLOBAL
 
   class << self
 
     # Return locale from link
     #
     def locale_from_link(link)
-      link[/^https?:\/\/([^.]+)\./i, 1]
+      Locale.locale_from_link(link)
     end
 
     # Get locales
     #
     def locales
-      url = "http://openfoodfacts.org/"
-      body = open(url).read
-      dom = Nokogiri.parse(body)
-
-      dom.css('ul li a').map { |locale_link|
-        locale_from_link(locale_link.attr('href'))
-      }.uniq.sort
+      Locale.all
     end
 
     # Get product

data/lib/openfoodfacts/locale.rb

@@ -0,0 +1,29 @@
+module Openfoodfacts
+  class Locale < String
+
+    GLOBAL = 'world'
+
+    class << self
+
+      # Get locales
+      #
+      def all
+        url = "http://openfoodfacts.org/"
+        body = open(url).read
+        dom = Nokogiri.parse(body)
+
+        dom.css('ul li a').map { |locale_link|
+          locale_from_link(locale_link.attr('href'))
+        }.uniq.sort
+      end
+
+      # Return locale from link
+      #
+      def locale_from_link(link)
+        link[/^https?:\/\/([^.]+)\./i, 1]
+      end
+
+    end
+
+  end
+end

data/lib/openfoodfacts/product.rb

@@ -1,25 +1,29 @@
 require 'hashie'
-require 'json'
 require 'nokogiri'
 require 'open-uri'
 
 module Openfoodfacts
   class Product < Hashie::Mash
+
     class << self
+
       # Get product
       #
-      def get(barcode, locale: Openfoodfacts::DEFAULT_LOCALE)
-        product_url = url(barcode, locale: locale)
-        json = open(product_url).read
-        hash = JSON.parse(json)
+      def get(code, locale: Openfoodfacts::DEFAULT_LOCALE)
+        if code
+          product_url = url(code, locale: locale)
+          json = open(product_url).read
+          hash = JSON.parse(json)
 
-        new(hash["product"]) if !hash["status"].nil? && hash["status"] == 1
+          new(hash["product"]) if !hash["status"].nil? && hash["status"] == 1
+        end
       end
+      alias_method :find, :get
 
       # Return product API URL
       #
-      def url(barcode, locale: Openfoodfacts::DEFAULT_LOCALE)
-        "http://#{locale}.openfoodfacts.org/api/v0/produit/#{barcode}.json"
+      def url(code, locale: Openfoodfacts::DEFAULT_LOCALE)
+        "http://#{locale}.openfoodfacts.org/api/v0/produit/#{code}.json"
       end
 
       # Search products 
@@ -52,6 +56,47 @@ module Openfoodfacts
           new(attributes)
         end
       end
+      alias_method :where, :search
+
+    end
+
+    # Fetch product
+    #
+    def fetch
+      if (self.code)
+        product = self.class.get(self.code)
+        self.merge!(product)
+      end
+
+      self
+    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
+    #
+    def update(user: nil)
+      if self.code && self.lc
+        uri = URI("http://#{self.lc}.openfoodfacts.org/cgi/product_jqm.pl")
+        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: Openfoodfacts::DEFAULT_LOCALE)
+      self.class.url(self.code, locale: locale)
     end
+
   end
 end

data/lib/openfoodfacts/user.rb

@@ -0,0 +1,38 @@
+module Openfoodfacts
+  class User < Hashie::Mash
+
+    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: Openfoodfacts::DEFAULT_LOCALE)
+        uri = URI("http://#{locale}.openfoodfacts.org/cgi/session.pl")
+        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
+      end
+
+    end
+
+    # Login
+    #
+    def login(locale: Openfoodfacts::DEFAULT_LOCALE)
+      if user = self.class.login(self.user_id, self.password, locale: locale)
+        self.name = user.name
+        self
+      end
+    end
+
+  end
+end

data/lib/openfoodfacts/version.rb

@@ -1,3 +1,3 @@
 module Openfoodfacts
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/test/test_openfoodfacts.rb

@@ -1,28 +1,56 @@
 require_relative 'minitest_helper'
 
 class TestOpenfoodfacts < Minitest::Test
+
+  # Gem
+
   def test_that_it_has_a_version_number
     refute_nil ::Openfoodfacts::VERSION
   end
 
+  # Locale
+
   def test_it_fetches_locales
     VCR.use_cassette("index") do
-      locales = ::Openfoodfacts::locales
+      locales = ::Openfoodfacts::Locale.all
       assert_includes locales, "world"
       assert_includes locales, "fr"
       assert_includes locales, "be-fr"
     end
   end
 
+  # User
+
+  def test_it_login_user
+    VCR.use_cassette("login_user", record: :once, match_requests_on: [:host, :path]) do
+      user = ::Openfoodfacts::User.login("wrong", "absolutely")
+      assert_nil user
+    end
+  end
+
+  # Product
+
+  def test_it_returns_product_url
+    product = ::Openfoodfacts::Product.new(code: "3029330003533")
+    assert_equal ::Openfoodfacts::Product.url(product.code, locale: 'ca'), product.url(locale: 'ca')
+  end
+
   def test_it_fetches_product
     product_code = "3029330003533"
+
+    VCR.use_cassette("fetch_product_#{product_code}", record: :once, match_requests_on: [:host, :path]) do
+      product = ::Openfoodfacts::Product.new(code: product_code)
+      product.fetch
+      refute_empty product.brands_tags
+    end
+  end
+
+  def test_it_get_product
+    product_code = "3029330003533"
     
     VCR.use_cassette("product_#{product_code}", record: :once, match_requests_on: [:host, :path]) do
       assert_equal ::Openfoodfacts::Product.get(product_code).code, product_code
     end
-    VCR.use_cassette("product_#{product_code}", record: :once, match_requests_on: [:host, :path]) do
-      #assert_equal ::Openfoodfacts.product(product_code).code, product_code # Backward compatibility
-    end
   end
 
   def test_that_it_search
@@ -42,4 +70,26 @@ class TestOpenfoodfacts < Minitest::Test
       refute_equal ::Openfoodfacts::Product.search(term, page: 2).first.code, first_product.code
     end
   end
+
+  def test_it_updates_product
+    product_code = "3029330003533"
+    product = ::Openfoodfacts::Product.new(code: product_code)
+    product_last_modified_t = nil
+
+    VCR.use_cassette("fetch_product_#{product_code}", record: :all, match_requests_on: [:host, :path]) do
+      product.fetch
+      product_last_modified_t = product.last_modified_t
+    end
+
+    VCR.use_cassette("update_product_#{product_code}", record: :all, match_requests_on: [:host, :path]) do
+      product.update # Empty update are accepted, allow testing without altering data.
+    end
+
+    VCR.use_cassette("refetch_product_#{product_code}", record: :all, match_requests_on: [:host, :path]) do
+      product.fetch
+    end
+
+    refute_equal product_last_modified_t, product.last_modified_t
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openfoodfacts
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nicolas Leger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -119,7 +119,9 @@ files:
 - README.md
 - Rakefile
 - lib/openfoodfacts.rb
+- lib/openfoodfacts/locale.rb
 - lib/openfoodfacts/product.rb
+- lib/openfoodfacts/user.rb
 - lib/openfoodfacts/version.rb
 - test/fixtures/index.yml
 - test/fixtures/product_3029330003533.yml