openbeautyfacts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc1875dd0d4f35000da26600c17317afe76eb644
+  data.tar.gz: 04cf3b96a42e49e6aecab11762630c8bbe68c002
+SHA512:
+  metadata.gz: 10ea3c62fed84fc3f5a9a0d1f1676da2999342095f8b65c2e1cbf2e408473cf04af7a5b221e5dcc443b2ed618239d0b8dd960a3b220abbe8804a275251d55de3
+  data.tar.gz: b35cc9a9329c61020d69eed0a55b5b57a9af3a4241cbe5e1d886fa227c6ce77ffc920822a6dd209dd300e0f8e5a8e545a0cf2c90c4667455ae21d0669b264943

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nicolas Leger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,111 @@
+# Open Beauty Facts
+
+[![Gem Version](https://badge.fury.io/rb/openbeautyfacts.svg)](http://badge.fury.io/rb/openbeautyfacts)
+[![Build Status](https://travis-ci.org/openbeautyfacts/openbeautyfacts-ruby.svg?branch=master)](https://travis-ci.org/openbeautyfacts/openbeautyfacts-ruby)
+[![Dependency Status](https://gemnasium.com/openbeautyfacts/openbeautyfacts-ruby.svg)](https://gemnasium.com/openbeautyfacts/openbeautyfacts-ruby)
+[![Code Climate](https://codeclimate.com/github/openbeautyfacts/openbeautyfacts-ruby/badges/gpa.svg)](https://codeclimate.com/github/openbeautyfacts/openbeautyfacts-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/openfoodfacts/openbeautyfacts-ruby/badge.svg?branch=master)](https://coveralls.io/github/openbeautyfacts/openbeautyfacts-ruby?branch=master)
+[![Documentation](http://inch-ci.org/github/openbeautyfacts/openbeautyfacts-ruby.svg?branch=master)](http://inch-ci.org/github/openbeautyfacts/openbeautyfacts-ruby)
+
+API Wrapper for [Open Beauty Facts](http://openbeautyfacts.org/), the open database about beauty products.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openbeautyfacts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openbeautyfacts
+
+## 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
+require 'openbeautyfacts'
+
+# Browse a product
+
+code = "3029330003533"
+product = Openbeautyfacts::Product.get(code, locale: 'fr')
+
+product.product_name
+# => "Crousti Moelleux Complet"
+
+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 = Openbeautyfacts::User.login("USERNAME", "PASSWORD")
+if user
+    product.brands = "Jacquet"
+    product.update
+    # true
+end
+
+# Search products
+
+products = Openbeautyfacts::Product.search("Chocolate", locale: 'world', page_size: 3)
+# => [#<Openbeautyfacts::Product _id="3045140105502" code="3045140105502" id="3045140105502" image_small_url="http://en.openbeautyfacts.org/images/products/304/514/010/5502/front.7.100.jpg" lc="en" product_name="Milka au lait du Pays Alpin">, #<Openbeautyfacts::Product _id="3046920028363" code="3046920028363" id="3046920028363" image_small_url="http://en.openbeautyfacts.org/images/products/304/692/002/8363/front.5.100.jpg" lc="en" product_name="Tableta de chocolate negro \"Lindt Excellence\" 85% cacao">, #<Openbeautyfacts::Product _id="3046920029759" code="3046920029759" id="3046920029759" image_small_url="http://en.openbeautyfacts.org/images/products/304/692/002/9759/front.9.100.jpg" lc="en" product_name="Tableta de chocolate negro \"Lindt Excellence\" 90% cacao">]
+
+# You might need to fetch full product data from results
+
+products.first.fetch
+
+# By product state
+
+product_states = Openbeautyfacts::ProductState.all
+product_states.last.products
+
+# Config
+
+Openbeautyfacts::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"]
+```
+
+## Development
+
+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).
+
+## Contributing
+
+1. Fork it ( https://github.com/openbeautyfacts/openbeautyfacts-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.libs << "lib"
+  task.libs << "test"
+  task.pattern = "test/test_*.rb"
+end
+
+task default: :test
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../lib/openbeautyfacts')
+  ARGV.clear
+  IRB.start
+end

data/lib/openbeautyfacts.rb

@@ -0,0 +1,60 @@
+require_relative 'openbeautyfacts/additive'
+require_relative 'openbeautyfacts/brand'
+require_relative 'openbeautyfacts/category'
+require_relative 'openbeautyfacts/city'
+require_relative 'openbeautyfacts/contributor'
+require_relative 'openbeautyfacts/country'
+require_relative 'openbeautyfacts/faq'
+require_relative 'openbeautyfacts/ingredient_that_may_be_from_palm_oil'
+require_relative 'openbeautyfacts/label'
+require_relative 'openbeautyfacts/locale'
+require_relative 'openbeautyfacts/manufacturing_place'
+require_relative 'openbeautyfacts/origin'
+require_relative 'openbeautyfacts/packager_code'
+require_relative 'openbeautyfacts/packaging'
+require_relative 'openbeautyfacts/press'
+require_relative 'openbeautyfacts/product'
+require_relative 'openbeautyfacts/product_state'
+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)
+      Locale.locale_from_link(link)
+    end
+
+    # Get locales
+    #
+    def locales
+      Locale.all
+    end
+
+    # Get product
+    #
+    def product(barcode, locale: DEFAULT_LOCALE)
+      Product.get(barcode, locale: locale)
+    end
+
+    # Return product API URL
+    #
+    def product_url(barcode, locale: DEFAULT_LOCALE)
+      Product.url(barcode, locale: locale)
+    end
+
+  end
+end

data/lib/openbeautyfacts/additive.rb

@@ -0,0 +1,51 @@
+require 'hashie'
+
+module Openbeautyfacts
+  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: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
+        if path = LOCALE_PATHS[locale]
+          page_url = "http://#{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
+      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/openbeautyfacts/allergen.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openbeautyfacts
+  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: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "http://#{locale}.#{domain}/#{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/openbeautyfacts/brand.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openbeautyfacts
+  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: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "http://#{locale}.#{domain}/#{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/openbeautyfacts/category.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openbeautyfacts
+  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: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "http://#{locale}.#{domain}/#{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/openbeautyfacts/city.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openbeautyfacts
+  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: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "http://#{locale}.#{domain}/#{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/openbeautyfacts/contributor.rb

@@ -0,0 +1,33 @@
+require 'hashie'
+
+module Openbeautyfacts
+  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: DEFAULT_LOCALE, domain: DEFAULT_DOMAIN)
+        if path = LOCALE_PATHS[locale]
+          Product.tags_from_page(self, "http://#{locale}.#{domain}/#{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