Merge pull request #321 from meilisearch/review-improvements

Review improvements

Author: brunoocasali

.code-samples.meilisearch.yaml

@@ -183,7 +183,7 @@ get_all_tasks_1: |-
       }
   }
 get_one_key_1: |-
-  self.client.getKey(key: "d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4") { result in
+  self.client.getKey(keyOrUid: "d0552b41536279a0ad88bd595327b96f01176a60c2243e906c52ac02375f9bc4") { result in
       switch result {
       case .success(let key):
           print(key)

Sources/MeiliSearch/Client.swift

@@ -94,7 +94,7 @@ public struct MeiliSearch {
    */
   public func getIndexes(
     params: IndexesQuery? = nil,
-    _ completion: @escaping (Result<Results<Index>, Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<IndexesResults, Swift.Error>) -> Void) {
     Indexes.getAll(config: self.config, params: params, completion)
   }
 
@@ -198,8 +198,8 @@ public struct MeiliSearch {
    */
   public func getTasks(
     params: TasksQuery? = nil,
-    _ completion: @escaping (Result<Results<Task>, Swift.Error>) -> Void) {
-    self.tasks.getAll(params: params, completion)
+    _ completion: @escaping (Result<TasksResults, Swift.Error>) -> Void) {
+    self.tasks.getTasks(params: params, completion)
   }
 
   // MARK: Keys
@@ -213,22 +213,22 @@ public struct MeiliSearch {
    */
   public func getKeys(
     params: KeysQuery? = nil,
-    _ completion: @escaping (Result<Results<Key>, Swift.Error>) -> Void) {
+    _ completion: @escaping (Result<KeysResults, Swift.Error>) -> Void) {
       self.keys.getAll(params: params, completion)
   }
 
   /**
    Get one key's information using the key value.
 
-   - parameter key:  The key value.
+   - parameter keyOrUid:  The key value.
    - parameter completion: The completion closure used to notify when the server
    completes the query request, it returns a `Result` object that contains `Key` value.
    If the request was sucessful or `Error` if a failure occured.
    */
   public func getKey(
-    key: String,
+    keyOrUid: String,
     _ completion: @escaping (Result<Key, Swift.Error>) -> Void) {
-    self.keys.get(key: key, completion)
+    self.keys.get(key: keyOrUid, completion)
   }
 
   /**

Sources/MeiliSearch/Documents.swift

@@ -22,7 +22,8 @@ struct Documents {
     var query: String = "/indexes/\(uid)/documents/\(identifier)"
 
     if fields != nil {
-      query.append(fields?.joined(separator: ",") ?? "")
+      let fieldsQuery = "?fields=\(fields?.joined(separator: ",") ?? "")"
+      query.append(fieldsQuery)
     }
 
     self.request.get(api: query) { result in
@@ -45,7 +46,9 @@ struct Documents {
     params: DocumentsQuery? = nil,
     _ completion: @escaping (Result<DocumentsResults<T>, Swift.Error>) -> Void)
   where T: Codable, T: Equatable {
-    request.get(api: "/indexes/\(uid)/documents\(params?.toQuery() ?? "")") { result in
+    let queryParams = params?.toQuery() ?? ""
+
+    request.get(api: "/indexes/\(uid)/documents\(queryParams)") { result in
       switch result {
       case .success(let data):
         guard let data: Data = data else {

Sources/MeiliSearch/Indexes.swift

@@ -101,7 +101,7 @@ public struct Indexes {
    completes the query request. It returns a `Result` object that contains `[Index]`
    value if the request was successful or `Error` if a failure occurred.
    */
-  public static func getAll(config: Config, params: IndexesQuery? = nil, _ completion: @escaping (Result<Results<Index>, Swift.Error>) -> Void) {
+  public static func getAll(config: Config, params: IndexesQuery? = nil, _ completion: @escaping (Result<IndexesResults, Swift.Error>) -> Void) {
     Request(config).get(api: "/indexes", param: params?.toQuery()) { result in
       switch result {
       case .success(let result):
@@ -111,7 +111,8 @@ public struct Indexes {
         }
 
         do {
-          let indexes: Results<Index> = try Constants.customJSONDecoder.decode(Results<Index>.self, from: result)
+          let indexes = try Constants.customJSONDecoder.decode(IndexesResults.self, from: result)
+
           completion(.success(indexes))
         } catch let error {
           completion(.failure(error))
@@ -471,8 +472,8 @@ public struct Indexes {
    */
   public func getTasks(
     params: TasksQuery? = nil,
-    _ completion: @escaping (Result<Results<Task>, Swift.Error>) -> Void) {
-    self.tasks.getAll(uid: self.uid, params: params, completion)
+    _ completion: @escaping (Result<TasksResults, Swift.Error>) -> Void) {
+    self.tasks.getTasks(uid: self.uid, params: params, completion)
   }
 
    /**

Sources/MeiliSearch/Keys.swift

@@ -32,16 +32,18 @@ struct Keys {
     }
   }
 
-  func getAll(params: KeysQuery?, _ completion: @escaping (Result<Results<Key>, Swift.Error>) -> Void) {
+  func getAll(params: KeysQuery?, _ completion: @escaping (Result<KeysResults, Swift.Error>) -> Void) {
     self.request.get(api: "/keys", param: params?.toQuery()) { result in
       switch result {
       case .success(let data):
         guard let data: Data = data else {
           completion(.failure(MeiliSearch.Error.dataNotFound))
           return
         }
+
         do {
-          let keys: Results<Key> = try Constants.customJSONDecoder.decode(Results<Key>.self, from: data)
+          let keys = try Constants.customJSONDecoder.decode(KeysResults.self, from: data)
+
           completion(.success(keys))
         } catch {
           completion(.failure(error))

Sources/MeiliSearch/Model/IndexesResults.swift

@@ -4,8 +4,8 @@ import Foundation
  `IndexesResults` is a wrapper used in the indexes routes to handle the returned data.
  */
 
-public struct IndexesResults<T: Decodable & Encodable & Equatable>: Codable, Equatable {
-  public let results: [T]
+public struct IndexesResults: Codable, Equatable {
+  public let results: [Index]
   public let offset: Int
   public let limit: Int
   public let total: Int

Sources/MeiliSearch/Model/KeyParams.swift

@@ -13,14 +13,12 @@ public struct KeyParams: Codable, Equatable {
 
   public func encode(to encoder: Encoder) throws {
     var container = encoder.container(keyedBy: CodingKeys.self)
+
     if uid != nil {
       try container.encode(uid, forKey: .uid)
     }
 
-    if name != nil {
-      try container.encode(name, forKey: .name)
-    }
-
+    try container.encode(name, forKey: .name)
     try container.encode(description, forKey: .description)
     try container.encode(actions, forKey: .actions)
     try container.encode(indexes, forKey: .indexes)

Sources/MeiliSearch/Model/KeysResults.swift

@@ -0,0 +1,12 @@
+import Foundation
+
+/**
+ `KeysResults` is a wrapper used in the indexes routes to handle the returned data.
+ */
+
+public struct KeysResults: Codable, Equatable {
+  public let results: [Key]
+  public let offset: Int
+  public let limit: Int
+  public let total: Int
+}

Sources/MeiliSearch/Model/Results.swift

@@ -0,0 +1,12 @@
+import Foundation
+
+/**
+ `IndexesResults` is a wrapper used in the indexes routes to handle the returned data.
+ */
+
+public struct TasksResults: Codable, Equatable {
+  public let results: [Task]
+  public let next: Int?
+  public let from: Int?
+  public let limit: Int
+}