Merge branch '0.9.6'

hrabkin · hrabkin · commit af0722d3f797 · 2025-01-03T21:02:10.000+01:00
diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/OpenFoodFactsSDK.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/OpenFoodFactsSDK.xcscheme
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1540"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES"
+      buildArchitectures = "Automatic">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "OpenFoodFactsSDK"
+               BuildableName = "OpenFoodFactsSDK"
+               BlueprintName = "OpenFoodFactsSDK"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldAutocreateTestPlan = "YES">
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "OpenFoodFactsSDK-iosTests"
+               BuildableName = "OpenFoodFactsSDK-iosTests"
+               BlueprintName = "OpenFoodFactsSDK-iosTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "OpenFoodFactsSDK"
+            BuildableName = "OpenFoodFactsSDK"
+            BlueprintName = "OpenFoodFactsSDK"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </MacroExpansion>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>
diff --git a/Sources/Model/OFF/OpenFoodFactsLanguage.swift b/Sources/Model/OFF/OpenFoodFactsLanguage.swift
@@ -195,7 +195,7 @@ public enum OpenFoodFactsLanguage: String, CaseIterable, Identifiable, Equatable
     case ZULU
     case UNDEFINED
     
-    var info: (code: String, description: String) {
+    public var info: (code: String, description: String) {
         switch self {
         case .ENGLISH:
             return ("en", "English")
diff --git a/Sources/Model/OFF/Product.swift b/Sources/Model/OFF/Product.swift
@@ -46,34 +46,42 @@ public struct Product: Codable, Equatable, Sendable {
     public let brands: String?
     public let lang: OpenFoodFactsLanguage?
     public let quantity: String?
-    public let packagingQuantity: Double?
+    public let packagingQuantity: Double
+    public let packagingQuantityUnit: String
     public let servingSize: String?
-    public let servingQuantity: Double?
+    public let servingQuantity: Double
+    public let servingQuantityUnit: String
     public let dataPer: String?
     public let categories: String?
     public var nutriments: [String: Any]?
     public let imageFront: String?
     public let imageIngredients: String?
     public let imageNutrition: String?
     public let keywords: [String]?
+    public let novaGroup: Double?
+    public let nutriScore: String?
     
     enum CodingKeys: String, CodingKey {
         case code
         case lang
         case brands
         case quantity
         case packagingQuantity = "product_quantity"
+        case packagingQuantityUnit = "product_quantity_unit"
         case categories
         case images
         case productName = "product_name"
         case productNameEn = "product_name_en"
         case servingSize = "serving_size"
         case servingQuantity = "serving_quantity"
+        case servingQuantityUnit = "serving_quantity_unit"
         case dataPer = "nutrition_data_per"
         case nutriments = "nutriments"
         case imageFront = "image_front_url"
         case imageIngredients = "image_ingredients_url"
         case imageNutrition = "image_nutrition_url"
+        case novaGroup = "nova_group"
+        case nutriScore = "nutriscore_grade"
         case keywords = "_keywords"
     }
     
@@ -91,23 +99,28 @@ public struct Product: Codable, Equatable, Sendable {
         imageIngredients = try container.decodeIfPresent(String.self, forKey: .imageIngredients)
         imageNutrition = try container.decodeIfPresent(String.self, forKey: .imageNutrition)
         keywords = try container.decodeIfPresent([String].self, forKey: .keywords)
+        nutriScore = try container.decodeIfPresent(String.self, forKey: .nutriScore)
+        novaGroup = try container.decodeIfPresent(Double.self, forKey: .novaGroup)
+        servingQuantityUnit = try container.decodeIfPresent(String.self, forKey: .servingQuantityUnit) ?? "g"
+        packagingQuantityUnit = try container.decodeIfPresent(String.self, forKey: .packagingQuantityUnit) ?? "g"
         
         if let packagingQuantityValue = try? container.decode(Double.self, forKey: .packagingQuantity) {
             packagingQuantity = packagingQuantityValue
-        } else if let packagingQuantityString = try? container.decode(String.self, forKey: .packagingQuantity),
-                  let packagingQuantityValue = Double(packagingQuantityString) {
-            packagingQuantity = packagingQuantityValue
+        } else if let packagingQuantityString = try? container.decode(String.self, forKey: .packagingQuantity) {
+            let cleanedString = packagingQuantityString.filter { $0.isNumber || $0 == "." || $0 == "," }
+            packagingQuantity = Double(cleanedString) ?? 0.0
+            
         } else {
-            packagingQuantity = nil
+            packagingQuantity = 100
         }
-
+        
         if let servingQuantityValue = try? container.decode(Double.self, forKey: .servingQuantity) {
             servingQuantity = servingQuantityValue
-        } else if let servingQuantityString = try? container.decode(String.self, forKey: .servingQuantity),
-                  let servingQuantityValue = Double(servingQuantityString) {
-            servingQuantity = servingQuantityValue
+        } else if let servingQuantityString = try? container.decode(String.self, forKey: .servingQuantity) {
+            let cleanedString = servingQuantityString.filter { $0.isNumber || $0 == "." || $0 == "," }
+            servingQuantity = Double(cleanedString) ?? 0.0
         } else {
-            servingQuantity = nil
+            servingQuantity = 100
         }
         
         if let nutrimentsContainer = try? container.nestedContainer(keyedBy: AnyCodingKey.self, forKey: .nutriments) {
@@ -136,15 +149,19 @@ public struct Product: Codable, Equatable, Sendable {
         try container.encodeIfPresent(productNameEn, forKey: .productNameEn)
         try container.encodeIfPresent(quantity, forKey: .quantity)
         try container.encodeIfPresent(packagingQuantity, forKey: .packagingQuantity)
+        try container.encodeIfPresent(packagingQuantityUnit, forKey: .packagingQuantityUnit)
         try container.encodeIfPresent(servingSize, forKey: .servingSize)
         try container.encodeIfPresent(servingQuantity, forKey: .servingQuantity)
+        try container.encodeIfPresent(servingQuantityUnit, forKey: .servingQuantityUnit)
         try container.encodeIfPresent(dataPer, forKey: .dataPer)
         try container.encodeIfPresent(categories, forKey: .categories)
         try container.encodeIfPresent(imageFront, forKey: .imageFront)
         try container.encodeIfPresent(imageIngredients, forKey: .imageIngredients)
         try container.encodeIfPresent(imageNutrition, forKey: .imageNutrition)
         try container.encodeIfPresent(keywords, forKey: .keywords)
-        try container.encodeIfPresent(self.lang?.rawValue, forKey: .lang)
+        try container.encodeIfPresent(lang?.rawValue, forKey: .lang)
+        try container.encodeIfPresent(nutriScore, forKey: .nutriScore)
+        try container.encodeIfPresent(novaGroup, forKey: .novaGroup)
         
         if let nutriments = self.nutriments {
             var nutrimentsContainer = container.nestedContainer(keyedBy: AnyCodingKey.self, forKey: .nutriments)
diff --git a/Sources/Model/OFF/ProductConfiguration.swift b/Sources/Model/OFF/ProductConfiguration.swift
@@ -12,7 +12,7 @@ public struct ProductQueryConfiguration {
     var languages: [OpenFoodFactsLanguage]
     var fields: [ProductField]?
     
-    init(barcode: String,
+    public init(barcode: String,
          languages: [OpenFoodFactsLanguage] = [],
          country: OpenFoodFactsCountry? = nil,
          fields: [ProductField]? = nil) {
diff --git a/Sources/Model/OFF/ProductField.swift b/Sources/Model/OFF/ProductField.swift
@@ -7,7 +7,7 @@
 
 import Foundation
 
-enum ProductField: String {
+public enum ProductField: String {
     case barcode = "code"
     case name = "product_name"
     case nameInLanguages = "product_name_"
diff --git a/Sources/Model/OFF/ProductResponse.swift b/Sources/Model/OFF/ProductResponse.swift
@@ -10,31 +10,66 @@ import Foundation
 public struct ProductResponse: Decodable {
     
     /// Possible value for [status]: the operation failed.
-    static let statusFailure = "failure"
+    public static let statusFailure = "failure"
 
     /// Possible value for [status]: the operation succeeded with warnings.
-    static let statusWarning = "success_with_warnings"
+    public static let statusWarning = "success_with_warnings"
 
     /// Possible value for [status]: the operation succeeded.
-    static let statusSuccess = "success"
+    public static let statusSuccess = "success"
 
     /// Possible value for [result.id]: product found
-    static let resultProductFound = "product_found"
+    public static let resultProductFound = "product_found"
 
     /// Possible value for [result.id]: product not found
-    static let resultProductNotFound = "product_not_found"
+    public static let resultProductNotFound = "product_not_found"
     
-    let barcode: String?
-    let status: String?
-    let product: Product?
+    public let barcode: String?
+    public let status: Int?
+    public let statusVerbose: String?
+    public let product: Product?
     
-    enum CodingKeys: String, CodingKey {
+    public enum CodingKeys: String, CodingKey {
         case barcode = "code"
         case status
         case product
+        case statusVerbose = "status_verbose"
     }
     
-    func hasProduct() -> Bool {
+    public func hasProduct() -> Bool {
+        guard let status = self.statusVerbose else { return false }
+        return status == ProductResponse.resultProductFound || status == ProductResponse.statusSuccess || status == ProductResponse.statusWarning
+    }
+}
+
+public struct ProductResponseV3: Decodable {
+    
+    /// Possible value for [status]: the operation failed.
+    public static let statusFailure = "failure"
+
+    /// Possible value for [status]: the operation succeeded with warnings.
+    public static let statusWarning = "success_with_warnings"
+
+    /// Possible value for [status]: the operation succeeded.
+    public static let statusSuccess = "success"
+
+    /// Possible value for [result.id]: product found
+    public static let resultProductFound = "product_found"
+
+    /// Possible value for [result.id]: product not found
+    public static let resultProductNotFound = "product_not_found"
+    
+    public let barcode: String?
+    public let status: String?
+    public let product: Product?
+    
+    public enum CodingKeys: String, CodingKey {
+        case barcode = "code"
+        case status
+        case product
+    }
+    
+    public func hasProduct() -> Bool {
         guard let status = self.status else { return false }
         return status == ProductResponse.resultProductFound || status == ProductResponse.statusSuccess || status == ProductResponse.statusWarning
     }
diff --git a/Sources/Model/OFF/UserAgent.swift b/Sources/Model/OFF/UserAgent.swift
@@ -36,9 +36,12 @@ public struct UserAgent: Codable {
         var result = ""
         
         let mirror = Mirror(reflecting: self)
-        for child in mirror.children {
+        for (index, child) in mirror.children.enumerated() {
             if let value = child.value as? String {
-                result += " - \(value)"
+                result += "\(value)"
+                if index < mirror.children.count - 1 {
+                    result += "-"
+                }
             }
         }
         
diff --git a/Sources/Networking/OpenFoodAPIClient.swift b/Sources/Networking/OpenFoodAPIClient.swift
@@ -53,7 +53,7 @@ final public actor OpenFoodAPIClient {
         
         let queryParameters = config.getParametersMap()
         
-        guard let uriPath = UriHelper.getUri(path: "/api/v3/product/\(config.barcode)", queryParameters: queryParameters) else {
+        guard let uriPath = UriHelper.getUri(path: "/api/v2/product/\(config.barcode)", queryParameters: queryParameters) else {
             throw NSError(domain: "Couldn't compose uri for \(#function) call", code: 400)
         }
         do {
@@ -94,7 +94,7 @@ final public actor OpenFoodAPIClient {
             "limit": "\(limit)",
         ]
         
-        guard let uri = UriHelper.getUri(path: "/api/v3/taxonomy_suggestions", queryParameters: queryParameters) else {
+        guard let uri = UriHelper.getUri(path: "/api/v2/taxonomy_suggestions", queryParameters: queryParameters) else {
             throw NSError(domain: "Couldn't compose uri for \(#function) call", code: 400)
         }
         
diff --git a/Sources/OFFConfig.swift b/Sources/OFFConfig.swift
@@ -53,10 +53,10 @@ final public class OFFConfig {
                            withSystem: Bool = true, system: String = "",
                            withId: Bool = true, id: String = "") -> String {
         var appInfo = ""
-        let infoDelimiter = " - "
+        let infoDelimiter = "-"
         
         if withName {
-            appInfo += infoDelimiter + name
+            appInfo += name
         }
         if withVersion {
             appInfo += infoDelimiter + version
@@ -79,9 +79,9 @@ final public class OFFConfig {
         let appVersion = Bundle.main.infoDictionary?["CFBundleShortVersionString"] as? String ?? ""
         let buildNumber = Bundle.main.infoDictionary?["CFBundleVersion"] as? String ?? ""
         
-        let version = "\(appVersion)+\(buildNumber)"
-        let system = "\(UIDevice.current.systemName)+\(UIDevice.current.systemVersion)"
-        let comment = getAppInfoComment(name: appName, version: version, system: system, id: uuid)
+        let version = "\(appVersion)_\(buildNumber)"
+        let system = "\(UIDevice.current.systemName)_\(UIDevice.current.systemVersion)"
+        let comment = getAppInfoComment(name: appName, version: version, system: system, id: uuid.replacingOccurrences(of: "-", with: ""))
         
         self.userAgent = UserAgent(
             name: appName,

Original file line number	Diff line number	Diff line change
`@@ -36,9 +36,12 @@ public struct UserAgent: Codable {`
`36`	`36`	`var result = ""`
`37`	`37`
`38`	`38`	`let mirror = Mirror(reflecting: self)`
`39`		`- for child in mirror.children {`
	`39`	`+ for (index, child) in mirror.children.enumerated() {`
`40`	`40`	`if let value = child.value as? String {`
`41`		`- result += " - \(value)"`
	`41`	`+ result += "\(value)"`
	`42`	`+ if index < mirror.children.count - 1 {`
	`43`	`+ result += "-"`
	`44`	`+ }`
`42`	`45`	`}`
`43`	`46`	`}`
`44`	`47`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ final public actor OpenFoodAPIClient {`
`53`	`53`
`54`	`54`	`let queryParameters = config.getParametersMap()`
`55`	`55`
`56`		`- guard let uriPath = UriHelper.getUri(path: "/api/v3/product/\(config.barcode)", queryParameters: queryParameters) else {`
	`56`	`+ guard let uriPath = UriHelper.getUri(path: "/api/v2/product/\(config.barcode)", queryParameters: queryParameters) else {`
`57`	`57`	`throw NSError(domain: "Couldn't compose uri for \(#function) call", code: 400)`
`58`	`58`	`}`
`59`	`59`	`do {`
`@@ -94,7 +94,7 @@ final public actor OpenFoodAPIClient {`
`94`	`94`	`"limit": "\(limit)",`
`95`	`95`	`]`
`96`	`96`
`97`		`- guard let uri = UriHelper.getUri(path: "/api/v3/taxonomy_suggestions", queryParameters: queryParameters) else {`
	`97`	`+ guard let uri = UriHelper.getUri(path: "/api/v2/taxonomy_suggestions", queryParameters: queryParameters) else {`
`98`	`98`	`throw NSError(domain: "Couldn't compose uri for \(#function) call", code: 400)`
`99`	`99`	`}`
`100`	`100`