refact: Remove addObject|s methods and refactor the UT (#600)

* refact: Deprecate addObject|s methods and refactor the UT

Author: robertmogos

Gemfile.lock

@@ -1,21 +1,62 @@
 GEM
+  remote: https://rubygems.org/
   specs:
     CFPropertyList (3.0.0)
+    activesupport (4.2.11)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     atomos (0.1.3)
     babosa (1.0.2)
     claide (1.0.2)
+    cocoapods (1.6.0.beta.2)
+      activesupport (>= 4.0.2, < 5)
+      claide (>= 1.0.2, < 2.0)
+      cocoapods-core (= 1.6.0.beta.2)
+      cocoapods-deintegrate (>= 1.0.2, < 2.0)
+      cocoapods-downloader (>= 1.2.2, < 2.0)
+      cocoapods-plugins (>= 1.0.0, < 2.0)
+      cocoapods-search (>= 1.0.0, < 2.0)
+      cocoapods-stats (>= 1.0.0, < 2.0)
+      cocoapods-trunk (>= 1.3.1, < 2.0)
+      cocoapods-try (>= 1.1.0, < 2.0)
+      colored2 (~> 3.1)
+      escape (~> 0.0.4)
+      fourflusher (~> 2.0.1)
+      gh_inspector (~> 1.0)
+      molinillo (~> 0.6.6)
+      nap (~> 1.0)
+      ruby-macho (~> 1.3, >= 1.3.1)
+      xcodeproj (>= 1.7.0, < 2.0)
+    cocoapods-core (1.6.0.beta.2)
+      activesupport (>= 4.0.2, < 6)
+      fuzzy_match (~> 2.0.4)
+      nap (~> 1.0)
+    cocoapods-deintegrate (1.0.2)
+    cocoapods-downloader (1.2.2)
+    cocoapods-plugins (1.0.0)
+      nap
+    cocoapods-search (1.0.0)
+    cocoapods-stats (1.1.0)
+    cocoapods-trunk (1.3.1)
+      nap (>= 0.8, < 2.0)
+      netrc (~> 0.11)
+    cocoapods-try (1.1.0)
     colored (1.2)
     colored2 (3.1.2)
     commander-fastlane (4.4.6)
       highline (~> 1.7.2)
+    concurrent-ruby (1.1.4)
     declarative (0.0.10)
     declarative-option (0.1.0)
     domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     dotenv (2.5.0)
     emoji_regex (0.1.1)
+    escape (0.0.4)
     excon (0.62.0)
     faraday (0.15.3)
       multipart-post (>= 1.2, < 3)
@@ -61,6 +102,8 @@ GEM
       xcodeproj (>= 1.6.0, < 2.0.0)
       xcpretty (~> 0.3.0)
       xcpretty-travis-formatter (>= 0.0.3)
+    fourflusher (2.0.1)
+    fuzzy_match (2.0.4)
     gh_inspector (1.1.3)
     google-api-client (0.23.9)
       addressable (~> 2.5, >= 2.5.1)
@@ -81,18 +124,24 @@ GEM
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     httpclient (2.8.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
     json (2.1.0)
     jwt (2.1.0)
     memoist (0.16.0)
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2018.0812)
     mini_magick (4.5.1)
+    minitest (5.11.3)
+    molinillo (0.6.6)
     multi_json (1.13.1)
     multi_xml (0.6.0)
     multipart-post (2.0.0)
     nanaimo (0.2.6)
+    nap (1.1.0)
     naturally (2.2.0)
+    netrc (0.11.0)
     os (1.0.0)
     plist (3.4.0)
     public_suffix (2.0.5)
@@ -102,6 +151,7 @@ GEM
       uber (< 0.2.0)
     retriable (3.1.2)
     rouge (2.0.7)
+    ruby-macho (1.3.1)
     rubyzip (1.2.2)
     security (0.1.3)
     signet (0.11.0)
@@ -116,10 +166,13 @@ GEM
     terminal-notifier (1.8.0)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
+    thread_safe (0.3.6)
     tty-cursor (0.6.0)
     tty-screen (0.6.5)
     tty-spinner (0.8.0)
       tty-cursor (>= 0.5.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     uber (0.1.0)
     unf (0.1.4)
       unf_ext
@@ -147,7 +200,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  cocoapods (~> 1.6.0.beta.1)
+  fastlane
   xcov
 
 BUNDLED WITH
-   1.16.6
+   1.17.2

Podfile.lock

@@ -27,4 +27,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: 6a84a4eada474315f0e394fa18031f32df0658a4
 
-COCOAPODS: 1.6.0.beta.1
+COCOAPODS: 1.6.0.beta.2

Sources/AlgoliaSearch-Client/Index.swift

@@ -61,13 +61,16 @@ import Foundation
   /// - parameter requestOptions: Request-specific options.
   /// - parameter completionHandler: Completion handler to be notified of the request's outcome.
   /// - returns: A cancellable operation.
+  /// + Warning: Deprecated, use saveObject(_:) instead.
   ///
+  @available(*, deprecated: 6.0, message: "Deprecated, use saveObject(_:) instead")
   @objc
   @discardableResult public func addObject(_ object: [String: Any], requestOptions: RequestOptions? = nil, completionHandler: CompletionHandler? = nil) -> Operation {
     let path = "1/indexes/\(urlEncodedName)"
     return client.performHTTPQuery(path: path, method: .POST, body: object, hostnames: client.writeHosts, requestOptions: requestOptions, completionHandler: completionHandler)
   }
 
+  @available(*, deprecated: 6.0, message: "Deprecated, use saveObject(_:) instead")
   @objc(addObject:completionHandler:)
   @discardableResult public func z_objc_addObject(_ object: [String: Any], completionHandler: CompletionHandler?) -> Operation {
     return addObject(object, requestOptions: nil, completionHandler: completionHandler)
@@ -81,14 +84,16 @@ import Foundation
   /// - parameter requestOptions: Request-specific options.
   /// - parameter completionHandler: Completion handler to be notified of the request's outcome.
   /// - returns: A cancellable operation.
-  /// + Warning: Deprecated, use addObject(_:) instead.
+  /// + Warning: Deprecated, use saveObject(_:) instead.
   ///
+  @available(*, deprecated: 6.0, message: "Deprecated, use saveObject(_:) instead")
   @objc
   @discardableResult public func addObject(_ object: [String: Any], withID objectID: String, requestOptions: RequestOptions? = nil, completionHandler: CompletionHandler? = nil) -> Operation {
     let path = "1/indexes/\(urlEncodedName)/\(objectID.urlEncodedPathComponent())"
     return client.performHTTPQuery(path: path, method: .PUT, body: object, hostnames: client.writeHosts, requestOptions: requestOptions, completionHandler: completionHandler)
   }
 
+  @available(*, deprecated: 6.0, message: "Deprecated, use saveObject(_:) instead")
   @objc(addObject:withID:completionHandler:)
   @discardableResult public func z_objc_addObject(_ object: [String: Any], withID objectID: String, completionHandler: CompletionHandler?) -> Operation {
     return addObject(object, withID: objectID, completionHandler: completionHandler)
@@ -100,7 +105,9 @@ import Foundation
   /// - parameter requestOptions: Request-specific options.
   /// - parameter completionHandler: Completion handler to be notified of the request's outcome.
   /// - returns: A cancellable operation.
+  /// + Warning: Deprecated, use saveObjects(_:) instead.
   ///
+  @available(*, deprecated: 6.0, message: "Deprecated, use saveObject(_:) instead")
   @objc
   @discardableResult public func addObjects(_ objects: [[String: Any]], requestOptions: RequestOptions? = nil, completionHandler: CompletionHandler? = nil) -> Operation {
     let path = "1/indexes/\(urlEncodedName)/batch"
@@ -115,6 +122,7 @@ import Foundation
     return client.performHTTPQuery(path: path, method: .POST, body: request, hostnames: client.writeHosts, requestOptions: requestOptions, completionHandler: completionHandler)
   }
 
+  @available(*, deprecated: 6.0, message: "Deprecated, use saveObject(_:) instead")
   @objc(addObjects:completionHandler:)
   @discardableResult public func z_objc_addObjects(_ objects: [[String: Any]], completionHandler: CompletionHandler?) -> Operation {
     return addObjects(objects, completionHandler: completionHandler)

Tests/Helpers/TestHelpers.swift

@@ -12,17 +12,6 @@ import PromiseKit
 import XCTest
 
 extension OnlineTestCase {
-  func addObject(_ object: [String: Any]) -> Promise<[String: Any]> {
-    return promiseWrap({ fulfill, reject in
-      self.index.addObject(object, completionHandler: completionWrap(fulfill: fulfill, reject: reject))
-    })
-  }
-
-  func addObjects(_ objects: [[String: Any]]) -> Promise<[String: Any]> {
-    return promiseWrap({ fulfill, reject in
-      self.index.addObjects(objects, completionHandler: completionWrap(fulfill: fulfill, reject: reject))
-    })
-  }
 
   func saveObject(_ object: [String: Any]) -> Promise<[String: Any]> {
     return promiseWrap({ fulfill, reject in

Tests/Integration Tests/BrowseIteratorTests.swift

@@ -34,11 +34,13 @@ class BrowseIteratorTests: OnlineTestCase {
     let expectation = self.expectation(description: "Add objects")
     var objects = [[String: Any]]()
     for i in 0 ... 1500 {
-      objects.append(["i": i])
+      objects.append(["i": i,
+                      "objectID": NSUUID().uuidString
+                      ])
     }
-    index.addObjects(objects) { (content, error) -> Void in
+    index.saveObjects(objects) { (content, error) -> Void in
       if error != nil {
-        XCTFail("Error during addObjects: \(error!)")
+        XCTFail("Error during saveObjects: \(error!)")
         expectation.fulfill()
       } else {
         self.index.waitTask(withID: content!["taskID"] as! Int) { (_, error) -> Void in

Tests/Integration Tests/ClientTests.swift

@@ -36,7 +36,7 @@ class ClientTests: OnlineTestCase {
     }
 
     let promise = firstly {
-      self.addObject(mockObject)
+      self.saveObject(mockObject)
     }.then { object in
       self.waitTask(object)
     }.then { _ in
@@ -60,7 +60,7 @@ class ClientTests: OnlineTestCase {
     let dstIndex = client.index(withName: safeIndexName("algol?à-swift2"))
 
     let promise = firstly {
-      self.addObject(object)
+      self.saveObject(object)
     }.then { object in
       self.waitTask(object)
     }
@@ -100,7 +100,7 @@ class ClientTests: OnlineTestCase {
     let dstIndex = client.index(withName: safeIndexName("algol?à-swift2"))
 
     let promise = firstly {
-      self.addObject(object)
+      self.saveObject(object)
     }.then { object in
       self.waitTask(object)
     }
@@ -141,11 +141,11 @@ class ClientTests: OnlineTestCase {
 
   func testMultipleQueries() {
     let expectation = self.expectation(description: "testMultipleQueries")
-    let object = ["city": "San Francisco"]
+    let object = ["city": "San Francisco", "objectID": NSUUID().uuidString]
     let queries = [IndexQuery(index: self.index, query: Query())]
 
     let promise = firstly {
-      self.addObject(object)
+      self.saveObject(object)
     }.then { object in
       self.waitTask(object)
     }
@@ -170,7 +170,7 @@ class ClientTests: OnlineTestCase {
 
   func testMultipleQueries_stopIfEnoughMatches() {
     let expectation = self.expectation(description: "testMultipleQueries")
-    let object = ["city": "San Francisco"]
+    let object = ["city": "San Francisco", "objectID": NSUUID().uuidString]
     let query = Query()
     query.hitsPerPage = 1
     let queries = [
@@ -179,7 +179,7 @@ class ClientTests: OnlineTestCase {
     ]
 
     let promise = firstly {
-      self.addObject(object)
+      self.saveObject(object)
     }.then { object in
       self.waitTask(object)
     }
@@ -257,12 +257,12 @@ class ClientTests: OnlineTestCase {
       [
         "indexName": index.name,
         "action": "addObject",
-        "body": ["city": "San Francisco"],
+        "body": ["city": "San Francisco", "objectID": NSUUID().uuidString],
       ],
       [
         "indexName": index.name,
         "action": "addObject",
-        "body": ["city": "Paris"],
+        "body": ["city": "Paris", "objectID": NSUUID().uuidString],
       ],
     ]