OpenFoodFacts Spring Boot Starter Maven Package SDK.

Github Page javadoc and more	Author Alper Mulayim	JavaDoc
		JavaDoc

openfoodfacts-spring-boot-starter
Package designed to simplify the integration of OpenFoodFacts REST APIs into Spring Boot applications.
Developers can easily connect to the OpenFoodFacts API without implement any complex RESTful calls.

OpenFoodFactsWebClient OpenFoodFactsApi current version provides different methods for product and search.

OpenFoodFactsResponse getProduct(String productCode, List<ProductField> fields);
OpenFoodFactsResponse getProduct(String productCode);
OpenFoodFactsResponse getProduct(ProductRequest request);
OpenFoodFactsPageResponse searchProduct(ProductSearchRequest request) throws InvocationTargetException, IllegalAccessException , OpenFoodFactsException;
OpenPriceFactsResponse findPrice(PriceRequest priceRequest);
OpenPriceFactsResponse findPrice(String productCode);
OpenPriceLocationsPagedResponse findPriceLocation(PriceLocationRequest locationRequest);
ProductSaveResponse saveProduct(ProductSaveRequest request);
Mono<ResponseEntity<String>> uploadProductImage(ProductImageUploadRequest request);
String uploadProductImageBlocked(ProductImageUploadRequest request) throws OpenFoodFactsException;
Mono<ResponseEntity<String>> uploadProductImageUnblocked(ProductImageUploadRequest request) throws OpenFoodFactsException;

Installation How To Use

Local Installation

Clone or fork the repository.

cd openfoodfacts-springboot-starter

mvn clean install

check the repositories added. cd ~/.m2

Add openfoodfacts-springboot-starter dependency to your spring boot pom.xml

<dependency>
	<groupId>org.openfoodfacts</groupId>
	<artifactId>openfoodfacts-spring-boot-starter</artifactId>
	<version>0.0.1</version>
</dependency>

Installation Online Latest Github Package

Note: Latest package is deployed to https://github.com/AlperMulayim/openfoodfacts-spring-boot-starter/packages/ Please check the latest version.

Add github repositories to pom.xml

<repositories>
  <repository>
    <id>github</id>
    <url>https://maven.pkg.github.com/AlperMulayim/openfoodfacts-spring-boot-starter</url>
  </repository>
</repositories>

Add openfoodfacts-spring-boot-starter dependecy to your pom.xml

Please check latest version on https://github.com/AlperMulayim/openfoodfacts-spring-boot-starter/packages/

<dependency>
  <groupId>com.alpermulayim</groupId>
  <artifactId>openfoodfacts-spring-boot-starter</artifactId>
  <version>0.0.2.8</version>
</dependency>

Install the dependencies

mvn clean install 
cd ~/.m2 // check the repositories downloaded.

Configuration

Create configuration file for OpenFoodFactsWebClientProperties OpenFoodFactsWebClient beans.

@Configuration
public class DemoConfig {

    OpenFoodFactsWebClientProperties properties;

    @Autowired
    public DemoConfig(OpenFoodFactsWebClientProperties properties) {
        this.properties = properties;
    }

    @Bean
    OpenFoodFactsApi openFoodFactsWebClient(){
        return new OpenFoodFactsWebClient(properties);
    }
}

Customizable endpoints and paths via application.yml or application.properties files

You are able to customize starter endpoints and base urls, if you do not customize webclient have default configuration.

openfoodfacts:
  base-url: "https://world.openfoodfacts.org"
  prices-base-url: "https://prices.openfoodfacts.org",
  search-path: "/api/v2/search"
  product-path: "/api/v2/product"
  prices-path:"/api/v1/prices"
  username: "${OPEN_FOOD_FACTS_USERNAME}"
  password: "${OPEN_FOOD_FACTS_PASSWORD}"
  

Ready to use 🎉

Sample codes and configuration please check openfoodfacts-starter-demo

Demo Application README: Demo Application Readme

@Service
public class DemoOpenFoodFactsService {
    @Autowired
    OpenFoodFactsApi webClient;

    public OpenFoodFactsResponse request(){
	//we are able to create selected fields via ProductField. 
       List<ProductField> fields = new ArrayList<>();
        fields.add(ProductField.PRODUCT_NAME);
        fields.add(ProductField.CODE);
        fields.add(ProductField.NUTRISCORE_SCORE);
        fields.add(ProductField.IMAGE_URL);
        fields.add(ProductField.NUTRISCORE_DATA);
        fields.add(ProductField.NUTRITION_GRADES);
        fields.add(ProductField.BRANDS);
        fields.add(ProductField.INGREDIENTS_TEXT);
       return webClient.getProduct("5449000000996",fields);
    }

    public OpenFoodFactsResponse request(String productCode){
        return webClient.getProduct(productCode);
    }

    public OpenFoodFactsPageResponse search(ProductSearchRequest request)
            throws InvocationTargetException, IllegalAccessException {
        return webClient.searchProduct(request);
    }
    
    public OpenFoodFactsPageResponse searchCustom() throws InvocationTargetException, IllegalAccessException {
        List<ProductField> fields = new ArrayList<>();
        fields.add(ProductField.PRODUCT_NAME);
        fields.add(ProductField.CODE);
        fields.add(ProductField.IMAGE_URL);
        fields.add(ProductField.BRANDS);
        fields.add(ProductField.INGREDIENTS_TEXT);

        ProductSearchRequest request = ProductSearchRequest.builder()
                .brandsTags("nutella")
                .pageSize(3)
                .fields(fields)
                .build();
        return webClient.searchProduct(request);
    }

 public List<DemoProduct> searchDemoProducts() {
	//will request for ETI products total 5. 
	ProductSearchRequest request = searchRequest("eti",5);
	OpenFoodFactsPageResponse response = webClient.searchProduct(request);

	//convert the OpenFoodFacts product to custom product <DemoProduct> 
	return response.products().stream()
		.map(product ->new DemoProduct(product.code(), product.product_name(),product.imageUrl()))
		.collect(Collectors.toList());
    }
}

OpenPrices Demo Usecase

  public OpenPriceFactsResponse getProductPrice(String productCode){
        return webClient.findPrice(productCode);
    }

    public OpenPriceFactsResponse searchPrice(PriceRequest request){
        return webClient.findPrice(request);
    }

    public OpenPriceFactsResponse searchPriceCustom(){
        PriceRequest priceRequest = PriceRequest.builder()
                .priceGt(2.0)
                .priceLt(5.0)
                .size(3)
                .build();
        return webClient.findPrice(priceRequest);
    }

    public List<DemoPrice> myDemoSearchMyProductPrices(){
        PriceRequest priceRequest = PriceRequest.builder()
                .priceGt(2.0)
                .priceLt(5.0)
                .build();

        OpenPriceFactsResponse priceResponse = webClient.findPrice(priceRequest);

        return priceResponse.prices().stream()
                .map(productPrice -> createDemoPrice(productPrice))
                .collect(Collectors.toList());
    }
    private DemoPrice createDemoPrice(ProductPrice productPrice){
        String productName = productPrice.productName();
        String productCode = productPrice.productCode();
        String brand = productPrice.product().brands();
        String country = productPrice.location().osmAddressCountryCode();
        Double price = productPrice.price();
        String currency = productPrice.currency();
        String store = productPrice.location().osmBrand();
        String imageUrl = productPrice.product().imageUrl();

        return new DemoPrice(productCode,productName,brand,store,country,currency,price,imageUrl);
    }

Product Save Demo Usecase

 public ProductSaveResponse saveProductCustom(){
         ProductSaveRequest request = ProductSaveRequest.builder()
                    .code("484848484")
                    .brands("fakebrand-test")
                    .productName("fakeproduct-test")
                    .ingredientsText("fake,ingredients,test1,test2,test3")
                    .comment("fake,comment")
                    .build();
         return webClient.saveProduct(request);
    }

Image Upload Demo Usecase

public String uploadProductImage(String code, String lang, String facet, MultipartFile file) throws IOException {

        ProductImageUploadRequest request = ProductImageUploadRequest.builder()
                .productCode(code)
                .language(Language.fromCode(lang))
                .file(file)
                .facet(facet)
                .build();

        return  webClient.uploadProductImage(request);
    }

Author Alper Mulayim connect with me!