openfoodfacts / openfoodfacts-laravel Goto Github PK

View Code? Open in Web Editor NEW

144.0 13.0 18.0 80 KB

Open Food Facts API wrapper for Laravel

License: MIT License

PHP 100.00%

laravel openfoodfacts nutrition food hacktoberfest php laravel-package

openfoodfacts-laravel's Introduction

Laravel Open Food Facts API

This package provides a convenient wrapper to the Open Food Facts API for Laravel applications.

Requirements

PHP 8.1+
Laravel 9.x, 10.x, 11.x

Installation

You can install the package via composer:

composer require openfoodfacts/openfoodfacts-laravel

Legacy support

PHP 8.0 (Laravel <=9.x): composer require "openfoodfacts/openfoodfacts-laravel:^0.3"
PHP 7.2-7.4.x (Laravel 5.7-8.x): composer require "openfoodfacts/openfoodfacts-laravel:^0.2"

Usage

Find product details by barcode

OpenFoodFacts::barcode('20203467');

it returns an array with product details:

Array
(
    [product_name] => Cantuccini with hazelnuts
    [image_url] => https://static.openfoodfacts.org/images/products/20203467/front_fr.4.400.jpg
    ...    
)

Find products that match a search term:

$collection = OpenFoodFacts::find('Coca Cola Zero');

// returns a Illuminate\Support\Collection of arrays with details of each product found

Contributing

You're very welcome to contribute. We coordinate on the Open Food Facts slack, on the #PHP channel : https://slack.openfoodfacts.org Please see CONTRIBUTING for details.

License

The MIT License (MIT). Please see License File for more information.

Third party applications

If you use this SDK, feel free to open a PR to add your application in this list.

Authors

openfoodfacts-laravel's People

Contributors

Stargazers

Watchers

Forkers

mohamedziada sebrave joemires warifp tatevikgalstyan carlosjordandev zakariayacine webseed-digital laravel-shift raccaricardo lkrhl d3v1anx quadrubo gavinhewitt qwertywebschool dylanbcp arekbn donatasik

openfoodfacts-laravel's Issues

Do not cache product not found responses when calling OpenFoodFacts::barcode()

Epic: #

Description

I tried to pass a product bar code number that did not existed yet, then added it by contributing through the OpenFoodFact Android App, then called the API again and still no product found.

I flushed my cache, called the method again, and this time the correct response is returned.

Acceptance criteria

Only cache results for product found, do not cache product not found results (to allow subsequent retries to hopefully find the product if a contributor add it afterward).

What would a demo look like

Setup a Laravel cache driver (file, database, ...)
Call OpenFoodFacts::barcode($code);, where $code is a bar code of a product not in the database yet
Add the product (either through the mobile app or the website)
Call OpenFoodFacts::barcode($code);, where $code is a bar code of the product just added
No exception "Product not found", the result is the product JSON response

Notes

I noticed the cache is set after the JSON response it fetched. I did not dived into it in details, but if it is possible to figure out if the product is not found at this point, maybe we should prevent caching at this level?

https://github.com/openfoodfacts/openfoodfacts-php/blob/develop/src/Api.php#L431-L435

Edit: In fact, I just tried to dd at this point, by testing with product number "3760314500074", and the response is the following:

[
  "code" => "3760314500074"
  "status" => 0
  "status_verbose" => "product not found"
]

So the fix for me (if you think it make sense), would be to update the code like this

class Api
{
  // ...

  private function fetch(string $url, bool $isJsonFile = true): array
  {
    // ...

    $jsonResult = json_decode($response->getBody(), true);

-   if (!empty($this->cache) && !empty($jsonResult)) {
+   if (!empty($this->cache) && !empty($jsonResult) && (($jsonResult["status"] ?? 0) !== 0) {
      $this->cache->set($cacheKey, $jsonResult);
    }
  }
}

Tasks

Task 1
Task 1
Task 1

Installation problem

Hi, there is one issue when installed

laravel 8.0
guzzle 7.2

./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Can only install one of: guzzlehttp/guzzle[6.5.x-dev, 7.2.0].
    - Can only install one of: guzzlehttp/guzzle[7.2.0, 6.5.x-dev].
    - Can only install one of: guzzlehttp/guzzle[6.5.x-dev, 7.2.0].
    - openfoodfacts/openfoodfacts-php 0.2.3 requires guzzlehttp/guzzle ^6.3 -> satisfiable by guzzlehttp/guzzle[6.5.x-dev].
    - openfoodfacts/openfoodfacts-laravel v0.2 requires openfoodfacts/openfoodfacts-php ^0.2.3 -> satisfiable by openfoodfacts/openfoodfacts-php[0.2.3].
    - Installation request for openfoodfacts/openfoodfacts-laravel ^0.2.0 -> satisfiable by openfoodfacts/openfoodfacts-laravel[v0.2].
    - Installation request for guzzlehttp/guzzle (locked at 7.2.0, required as ^7.0.1) -> satisfiable by guzzlehttp/guzzle[7.2.0].

Add Laravel 10 support to the Open Food Facts package

Problem

I want to upgrade to Laravel 10 and the package does not support it.

Proposed solution

Add support for Laravel 10.

Additional context

Mockups

Part of

Add Laravel 11 support to the Open Food Facts package

Problem

It is not possible to use openfoodfact with Laravel 11

Proposed solution

Make it compatible :)

composer fail : laravel 9 compatibility

Hello, when i tried to install it in my project i had this error !

 Problem 1
    - openfoodfacts/openfoodfacts-laravel[dev-dependabot/github_actions/actions/cache-3.0.7, dev-explicit_geography, dev-master, v0.3.0] require openfoodfacts/openfoodfacts-php ^0.2.4 -> satisfiable by openfoodfacts/openfoodfacts-php[0.2.4].
    - openfoodfacts/openfoodfacts-laravel v0.1 requires illuminate/support 5.7.x|5.8.x|^6.0|^7.0 -> found illuminate/support[v5.7.0, ..., 5.8.x-dev, v6.0.0, ..., 6.x-dev, v7.0.0, ..., 7.x-dev] but these were not loaded, likely because it conflicts with another require.
    - openfoodfacts/openfoodfacts-laravel[v0.2, ..., v0.2.2] require illuminate/support 5.7.x|5.8.x|^6.0|^7.0|^8.0 -> found illuminate/support[v5.7.0, ..., 5.8.x-dev, v6.0.0, ..., 6.x-dev, v7.0.0, ..., 7.x-dev, v8.0.0, ..., 8.x-dev] but these were not loaded, likely because it conflicts with another require.
    - openfoodfacts/openfoodfacts-php 0.2.4 requires psr/log ^1.0 -> found psr/log[1.0.0, ..., 1.1.4] but the package is fixed to 3.0.0 (lock file version) by a partial update and that version does not match. Make sure you list it as an argument for the update command.
    - Root composer.json requires openfoodfacts/openfoodfacts-laravel * -> satisfiable by openfoodfacts/openfoodfacts-laravel[dev-dependabot/github_actions/actions/cache-3.0.7, dev-explicit_geography, dev-master, v0.1, ..., v0.3.0, 9999999-dev].

Use the option --with-all-dependencies (-W) to allow upgrades, downgrades and removals for packages currently locked to specific versions.

Can anyone help me in this ! Im junior developper so im not very experimented thanks !!

Tests are broken

What

Tests are broken

Part of

🎯 What can I work on ? (Laravel SDK)

What

Tasks

Beta Give feedback

Tests are broken #18

P0 tests
Options

Have a look on the base PHP Package too: here

Assign geographic variable when OpenFoodFacts class is instantiated

The geographic subdomain is assigned via the config:

parent::__construct([
  'geography' =>  $app['config']->get('openfoodfacts.geography'),
  'app' =>  $app['config']->get('app.name'),
], $app['cache.store']);

This doesn't allow for the API subdomain to be conditionally changed if the user is in another country. It would be great if this value could be assigned when the class instantiated.

Require a custom user agent to use the SDK

What

Require a custom user agent to use the SDK
Using the SDK and the API in general will remain as of today: free and accessible for everyone.
IN the same way, we don't want to implement an API key mechanism and all that kind of stuff.
However, due to misuse of the API through various SDKs, we will now force all language clients to have a valid User Agent so that we can reach out in case of problems.
For now, We will only require an app name for the user agent.

Cannot install with laravel 11.7

What

The installation via composer doesn't work on Laravel 11.7.0

Steps to reproduce the behavior:

composer require openfoodfacts/openfoodfacts-laravel on a Laravel project with version 11.7.0

Expected behavior

Installing the package with composer :)

Screenshots

Problem 1
    - openfoodfacts/openfoodfacts-laravel[v0.4.0, ..., v0.4.1] require openfoodfacts/openfoodfacts-php ^0.3.0 -> satisfiable by openfoodfacts/openfoodfacts-php[v0.3.0].
    - openfoodfacts/openfoodfacts-laravel v0.1 requires illuminate/support 5.7.x|5.8.x|^6.0|^7.0 -> found illuminate/support[v5.7.0, ..., v5.8.36, v6.0.0, ..., v6.20.44, v7.0.0, ..., v7.30.6] but these were not loaded, likely because it conflicts with another require.
    - openfoodfacts/openfoodfacts-laravel[v0.2, ..., v0.2.2] require illuminate/support 5.7.x|5.8.x|^6.0|^7.0|^8.0 -> found illuminate/support[v5.7.0, ..., v5.8.36, v6.0.0, ..., v6.20.44, v7.0.0, ..., v7.30.6, v8.0.0, ..., v8.83.27] but these were not loaded, likely because it conflicts with another require.
    - openfoodfacts/openfoodfacts-laravel v0.3.0 requires illuminate/support ^9.0 -> found illuminate/support[v9.0.0, ..., v9.52.16] but these were not loaded, likely because it conflicts with another require.
    - openfoodfacts/openfoodfacts-php v0.3.0 requires ext-gd * -> it is missing from your system. Install or enable PHP's gd extension.
    - Root composer.json requires openfoodfacts/openfoodfacts-laravel * -> satisfiable by openfoodfacts/openfoodfacts-laravel[v0.1, ..., v0.4.1].

Platform (Desktop, Mobile, Hunger Games)

OS: Debian in Docker container
Platform: WSL2 (Debian) on Windows 11, PHP 8.3.8

Thank you!

openfoodfacts / openfoodfacts-laravel Goto Github PK

openfoodfacts-laravel's Introduction

Laravel Open Food Facts API

Requirements

Installation

Legacy support

Usage

Find product details by barcode

Find products that match a search term:

Contributing

License

Third party applications

Authors

openfoodfacts-laravel's People

Contributors

Stargazers

Watchers

Forkers

openfoodfacts-laravel's Issues

Description

Acceptance criteria

What would a demo look like

Notes

Tasks

Problem

Proposed solution

Additional context

Mockups

Part of

Problem

Proposed solution

What

Part of

What

Tasks

What

What

Steps to reproduce the behavior:

Expected behavior

Screenshots

Platform (Desktop, Mobile, Hunger Games)

Recommend Projects

Recommend Topics

Recommend Org