feat: hit _geoloc field improvement (#704)

– Hit parsing don't fail if the format of Point for _geoloc is wrong
– Detailed errors in case of Point parsing failure
– Add possibility to represent _geoloc as a list of points

Author: VladislavFitz

Package.swift

@@ -11,7 +11,7 @@ let macOSVersion: SupportedPlatform.MacOSVersion = .v10_10
 
 #if os(Linux)
 let extraPackageDependencies: [Package.Dependency] = [
-  .package(url: "https://github.com/apple/swift-crypto.git", from: "1.1.2"),
+  .package(url: "https://github.com/apple/swift-crypto.git", from: "1.1.2")
 ]
 #else
 let extraPackageDependencies: [Package.Dependency] = []
@@ -39,19 +39,19 @@ let package = Package(
       targets: ["AlgoliaSearchClient"])
   ],
   dependencies: [
-    .package(url:"https://github.com/apple/swift-log.git", from: "1.4.0"),
+    .package(url:"https://github.com/apple/swift-log.git", from: "1.4.0")
   ] + extraPackageDependencies,
   targets: [
     .target(
       name: "AlgoliaSearchClient",
       dependencies: [
-        .product(name: "Logging", package: "swift-log"),
+        .product(name: "Logging", package: "swift-log")
       ] + extraTargetDependencies),
     .testTarget(
       name: "AlgoliaSearchClientTests",
       dependencies: [
         .target(name: "AlgoliaSearchClient"),
-        .product(name: "Logging", package: "swift-log"),
+        .product(name: "Logging", package: "swift-log")
       ] + extraTargetDependencies)
   ]
 )

Sources/AlgoliaSearchClient/Client/Search/SearchClient+MultiCluster.swift

@@ -8,9 +8,9 @@
 import Foundation
 
 public extension SearchClient {
-  
+
   // MARK: - List clusters
-  
+
   /**
    List the Cluster available in a multi-clusters setup for a single ApplicationID.
 
@@ -23,7 +23,7 @@ public extension SearchClient {
     let command = Command.MultiCluster.ListClusters(requestOptions: requestOptions)
     return execute(command, completion: completion)
   }
-  
+
   /**
    List the Cluster available in a multi-clusters setup for a single ApplicationID.
 
@@ -34,9 +34,9 @@ public extension SearchClient {
     let command = Command.MultiCluster.ListClusters(requestOptions: requestOptions)
     return try execute(command)
   }
-  
+
   // MARK: - List User IDs
-  
+
   /**
    List the UserID assigned to a multi-clusters ApplicationID.
 
@@ -55,7 +55,7 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.GetList(page: page, hitsPerPage: hitsPerPage, requestOptions: requestOptions)
     return execute(command, completion: completion)
   }
-  
+
   /**
    List the UserID assigned to a multi-clusters ApplicationID.
 
@@ -72,7 +72,7 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.GetList(page: page, hitsPerPage: hitsPerPage, requestOptions: requestOptions)
     return try execute(command)
   }
-  
+
   // MARK: - Assign UserID
   /**
    Assign or Move a UserID to a cluster.
@@ -93,7 +93,7 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.Assign(userID: userID, clusterName: clusterName, requestOptions: requestOptions)
     return execute(command, completion: completion)
   }
-  
+
   /**
    Assign or Move a UserID to a cluster.
 
@@ -111,9 +111,9 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.Assign(userID: userID, clusterName: clusterName, requestOptions: requestOptions)
     return try execute(command)
   }
-  
+
   // MARK: - Assign UserIDs
-  
+
   /**
    Assign or move UserIDs to a ClusterName.
 
@@ -132,7 +132,7 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.BatchAssign(userIDs: userIDs, clusterName: clusterName, requestOptions: requestOptions)
     return execute(command, completion: completion)
   }
-  
+
   /**
    Assign or move UserIDs to a ClusterName.
 
@@ -149,9 +149,9 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.BatchAssign(userIDs: userIDs, clusterName: clusterName, requestOptions: requestOptions)
     return try execute(command)
   }
-  
+
   // MARK: - Get UserID
-  
+
   /**
    Returns the UserID data stored in the mapping.
 
@@ -168,7 +168,7 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.Get(userID: userID, requestOptions: requestOptions)
     return execute(command, completion: completion)
   }
-  
+
   /**
    Returns the UserID data stored in the mapping.
 
@@ -183,9 +183,9 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.Get(userID: userID, requestOptions: requestOptions)
     return try execute(command)
   }
-  
+
   // MARK: - Get top UserID
-  
+
   /**
    Get the top 10 ResponseUserID with the highest number of records per cluster.
    The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds to propagate to the different clusters.
@@ -199,7 +199,7 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.GetTop(requestOptions: requestOptions)
     return execute(command, completion: completion)
   }
-  
+
   /**
    Get the top 10 ResponseUserID with the highest number of records per cluster.
    The data returned will usually be a few seconds behind real-time, because userID usage may take up to a few seconds to propagate to the different clusters.
@@ -211,9 +211,9 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.GetTop(requestOptions: requestOptions)
     return try execute(command)
   }
-  
+
   // MARK: - Remove UserID
-  
+
   /**
    Remove a UserID and its associated data from the multi-clusters.
 
@@ -230,7 +230,7 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.Remove(userID: userID, requestOptions: requestOptions)
     return execute(command, completion: completion)
   }
-  
+
   /**
    Remove a UserID and its associated data from the multi-clusters.
 
@@ -245,9 +245,9 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.Remove(userID: userID, requestOptions: requestOptions)
     return try execute(command)
   }
-  
+
   // MARK: - Search UserID
-  
+
   /**
    Search for UserID.
 
@@ -264,7 +264,7 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.Search(userIDQuery: query, requestOptions: requestOptions)
     return execute(command, completion: completion)
   }
-  
+
   /**
    Search for UserID.
 
@@ -279,9 +279,9 @@ public extension SearchClient {
     let command = Command.MultiCluster.User.Search(userIDQuery: query, requestOptions: requestOptions)
     return try execute(command)
   }
-  
+
   // MARK: - Has pending mapping
-  
+
   /**
    - Parameter retrieveMappings: If set to true, retrieves HasPendingMappingResponse.clusters.
    - Parameter requestOptions: Configure request locally with RequestOptions
@@ -294,7 +294,7 @@ public extension SearchClient {
     let command = Command.MultiCluster.HasPendingMapping(retrieveMapping: retrieveMappings, requestOptions: requestOptions)
     return execute(command, completion: completion)
   }
-  
+
   /**
    - Parameter retrieveMappings: If set to true, retrieves HasPendingMappingResponse.clusters.
    - Parameter requestOptions: Configure request locally with RequestOptions
@@ -305,5 +305,5 @@ public extension SearchClient {
     let command = Command.MultiCluster.HasPendingMapping(retrieveMapping: retrieveMappings, requestOptions: requestOptions)
     return try execute(command)
   }
-  
+
 }

Sources/AlgoliaSearchClient/Helpers/Coding/Wrappers/BoolContainer.swift

@@ -12,13 +12,13 @@ import Foundation
  occasionally providing bool values in the form of String   
  */
 struct BoolContainer: RawRepresentable, Codable {
-  
+
   let rawValue: Bool
-  
+
   init(rawValue: Bool) {
     self.rawValue = rawValue
   }
-  
+
   init(from decoder: Decoder) throws {
     let container = try decoder.singleValueContainer()
     if let boolValue = try? container.decode(Bool.self) {
@@ -31,5 +31,5 @@ struct BoolContainer: RawRepresentable, Codable {
     }
     throw DecodingError.dataCorruptedError(in: container, debugDescription: "Value cannot be decoded neither to Bool nor to String representing Bool value")
   }
-  
+
 }

Sources/AlgoliaSearchClient/Helpers/Crypto/String+HMAC.swift

@@ -14,7 +14,7 @@ import CommonCrypto
 #endif
 
 extension String {
-  
+
   func hmac256(withKey key: String) -> String {
     #if os(Linux)
     let key = SymmetricKey(data: Data(key.utf8))

Sources/AlgoliaSearchClient/Helpers/String/String+Wrapping.swift

@@ -8,8 +8,8 @@
 import Foundation
 
 extension String {
-  
+
   func wrappedInQuotes() -> String { "\"\(self)\"" }
   func wrappedInBrackets() -> String { "[\(self)]" }
-  
+
 }

Sources/AlgoliaSearchClient/Index/Index+Synonym.swift

@@ -112,7 +112,7 @@ public extension Index {
     let command = Command.Synonym.SaveList(indexName: name, synonyms: synonyms, forwardToReplicas: forwardToReplicas, clearExistingSynonyms: replaceExistingSynonyms, requestOptions: requestOptions)
     return try execute(command)
   }
-  
+
   /**
    Create or update multiple synonym.
    This method enables you to create or update one or more synonym in a single call.

Sources/AlgoliaSearchClient/Models/Internal/Path/Path.swift

@@ -17,6 +17,7 @@ struct Path: PathComponent {
       return nil
     }
 
+    // swiftlint:disable unused_setter_value
     set {
     }
   }

Sources/AlgoliaSearchClient/Models/Internal/Path/PathComponent.swift

@@ -27,7 +27,7 @@ extension RootPath {
     get {
       return nil
     }
-
+    // swiftlint:disable unused_setter_value
     set { }
   }
 
@@ -43,6 +43,8 @@ extension Never: PathComponent {
     get {
       return nil
     }
+
+    // swiftlint:disable unused_setter_value
     set {
     }
   }

Sources/AlgoliaSearchClient/Models/Rule/Rule+Alternatives.swift

@@ -40,10 +40,10 @@ extension Rule.Alternatives: ExpressibleByBooleanLiteral {
 }
 
 extension Rule.Alternatives: Decodable {
-  
+
   public init(from decoder: Decoder) throws {
     let boolContainer = try BoolContainer(from: decoder)
     self = boolContainer.rawValue ? .true : .false
   }
-  
+
 }

Sources/AlgoliaSearchClient/Models/Search/Hit/Hit.swift

@@ -16,7 +16,7 @@ public struct Hit<T: Codable> {
   public let snippetResult: TreeModel<SnippetResult>?
   public let highlightResult: TreeModel<HighlightResult>?
   public let rankingInfo: RankingInfo?
-  public let geolocation: Point?
+  public let geolocation: SingleOrList<Point>?
 
 }
 
@@ -39,7 +39,7 @@ extension Hit: Codable {
     self.snippetResult = try container.decodeIfPresent(TreeModel<SnippetResult>.self, forKey: .snippetResult)
     self.highlightResult = try container.decodeIfPresent(TreeModel<HighlightResult>.self, forKey: .highlightResult)
     self.rankingInfo = try container.decodeIfPresent(RankingInfo.self, forKey: .rankingInfo)
-    self.geolocation = try container.decodeIfPresent(Point.self, forKey: .geolocation)
+    self.geolocation = try? container.decodeIfPresent(SingleOrList<Point>.self, forKey: .geolocation)
   }
 
   public func encode(to encoder: Encoder) throws {