Renamed execute(url:) methods such that the HTTP method is the first argument in the parameter list

Motivation:

If these are intended to be general methods for building simple requests, then it makes sense to have the method be the first parameter in the list.

Modifications:

Moved the `method: HTTPMethod` parameter to the front of the list for all `execute([...] url: [...])` methods, and made it default to .GET. I also changed the url parameter to be `urlPath` for the two socketPath based execute methods.

Result:

A cleaner public interface for users of the API.

Author: dimitribouniol

README.md

@@ -162,13 +162,13 @@ httpClient.execute(request: request, delegate: delegate).futureResult.whenSucces
 Connecting to servers bound to socket paths is easy:
 ```swift
 let httpClient = HTTPClient(eventLoopGroupProvider: .createNew)
-httpClient.execute(socketPath: "/tmp/myServer.socket", url: "/path/to/resource", method: .GET).whenComplete (...)
+httpClient.execute(.GET, socketPath: "/tmp/myServer.socket", urlPath: "/path/to/resource").whenComplete (...)
 ```
 
 Connecting over TLS to a unix domain socket path is possible as well:
 ```swift
 let httpClient = HTTPClient(eventLoopGroupProvider: .createNew)
-httpClient.execute(secureSocketPath: "/tmp/myServer.socket", url: "/path/to/resource", body: .string("hello"), method: .POST).whenComplete (...)
+httpClient.execute(.POST, secureSocketPath: "/tmp/myServer.socket", urlPath: "/path/to/resource", body: .string("hello")).whenComplete (...)
 ```
 
 Direct URLs can easily be contructed to be executed in other scenarios:

Sources/AsyncHTTPClient/HTTPClient.swift

@@ -194,7 +194,7 @@ public class HTTPClient {
     ///     - url: Remote URL.
     ///     - deadline: Point in time by which the request must complete.
     public func get(url: String, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
-        return self.execute(url: url, method: .GET, deadline: deadline)
+        return self.execute(.GET, url: url, deadline: deadline)
     }
 
     /// Execute `POST` request using specified URL.
@@ -204,7 +204,7 @@ public class HTTPClient {
     ///     - body: Request body.
     ///     - deadline: Point in time by which the request must complete.
     public func post(url: String, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
-        return self.execute(url: url, method: .POST, body: body, deadline: deadline)
+        return self.execute(.POST, url: url, body: body, deadline: deadline)
     }
 
     /// Execute `PATCH` request using specified URL.
@@ -214,7 +214,7 @@ public class HTTPClient {
     ///     - body: Request body.
     ///     - deadline: Point in time by which the request must complete.
     public func patch(url: String, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
-        return self.execute(url: url, method: .PATCH, body: body, deadline: deadline)
+        return self.execute(.PATCH, url: url, body: body, deadline: deadline)
     }
 
     /// Execute `PUT` request using specified URL.
@@ -224,7 +224,7 @@ public class HTTPClient {
     ///     - body: Request body.
     ///     - deadline: Point in time by which the request must complete.
     public func put(url: String, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
-        return self.execute(url: url, method: .PUT, body: body, deadline: deadline)
+        return self.execute(.PUT, url: url, body: body, deadline: deadline)
     }
 
     /// Execute `DELETE` request using specified URL.
@@ -233,17 +233,17 @@ public class HTTPClient {
     ///     - url: Remote URL.
     ///     - deadline: The time when the request must have been completed by.
     public func delete(url: String, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
-        return self.execute(url: url, method: .DELETE, deadline: deadline)
+        return self.execute(.DELETE, url: url, deadline: deadline)
     }
 
     /// Execute arbitrary HTTP request using specified URL.
     ///
     /// - parameters:
-    ///     - url: Request url.
     ///     - method: Request method.
+    ///     - url: Request url.
     ///     - body: Request body.
     ///     - deadline: Point in time by which the request must complete.
-    public func execute(url: String, method: HTTPMethod, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
+    public func execute(_ method: HTTPMethod = .GET, url: String, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
         do {
             let request = try Request(url: url, method: method, body: body)
             return self.execute(request: request, deadline: deadline)
@@ -255,14 +255,14 @@ public class HTTPClient {
     /// Execute arbitrary HTTP+UNIX request to a unix domain socket path, using the specified URL as the request to send to the server.
     ///
     /// - parameters:
-    ///     - socketPath: The path to the unix domain socket to connect to.
-    ///     - url: The URL path and query that will be sent to the server.
     ///     - method: Request method.
+    ///     - socketPath: The path to the unix domain socket to connect to.
+    ///     - urlPath: The URL path and query that will be sent to the server.
     ///     - body: Request body.
     ///     - deadline: Point in time by which the request must complete.
-    public func execute(socketPath: String, url: String, method: HTTPMethod, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
+    public func execute(_ method: HTTPMethod = .GET, socketPath: String, urlPath: String, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
         do {
-            guard let url = URL(httpURLWithSocketPath: socketPath, uri: url) else {
+            guard let url = URL(httpURLWithSocketPath: socketPath, uri: urlPath) else {
                 throw HTTPClientError.invalidURL
             }
             let request = try Request(url: url, method: method, body: body)
@@ -275,14 +275,14 @@ public class HTTPClient {
     /// Execute arbitrary HTTPS+UNIX request to a unix domain socket path over TLS, using the specified URL as the request to send to the server.
     ///
     /// - parameters:
-    ///     - secureSocketPath: The path to the unix domain socket to connect to.
-    ///     - url: The URL path and query that will be sent to the server.
     ///     - method: Request method.
+    ///     - secureSocketPath: The path to the unix domain socket to connect to.
+    ///     - urlPath: The URL path and query that will be sent to the server.
     ///     - body: Request body.
     ///     - deadline: Point in time by which the request must complete.
-    public func execute(secureSocketPath: String, url: String, method: HTTPMethod, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
+    public func execute(_ method: HTTPMethod = .GET, secureSocketPath: String, urlPath: String, body: Body? = nil, deadline: NIODeadline? = nil) -> EventLoopFuture<Response> {
         do {
-            guard let url = URL(httpsURLWithSocketPath: secureSocketPath, uri: url) else {
+            guard let url = URL(httpsURLWithSocketPath: secureSocketPath, uri: urlPath) else {
                 throw HTTPClientError.invalidURL
             }
             let request = try Request(url: url, method: method, body: body)

Tests/AsyncHTTPClientTests/HTTPClientTests.swift

@@ -211,8 +211,10 @@ class HTTPClientTests: XCTestCase {
                                         try self.defaultClient.put(url: self.defaultHTTPBinURLPrefix + "echo-method").wait().headers[canonicalForm: "X-Method-Used"]))
         XCTAssertNoThrow(XCTAssertEqual(["DELETE"[...]],
                                         try self.defaultClient.delete(url: self.defaultHTTPBinURLPrefix + "echo-method").wait().headers[canonicalForm: "X-Method-Used"]))
+        XCTAssertNoThrow(XCTAssertEqual(["GET"[...]],
+                                        try self.defaultClient.execute(url: self.defaultHTTPBinURLPrefix + "echo-method").wait().headers[canonicalForm: "X-Method-Used"]))
         XCTAssertNoThrow(XCTAssertEqual(["CHECKOUT"[...]],
-                                        try self.defaultClient.execute(url: self.defaultHTTPBinURLPrefix + "echo-method", method: .CHECKOUT).wait().headers[canonicalForm: "X-Method-Used"]))
+                                        try self.defaultClient.execute(.CHECKOUT, url: self.defaultHTTPBinURLPrefix + "echo-method").wait().headers[canonicalForm: "X-Method-Used"]))
     }
 
     func testConvenienceExecuteMethodsOverSocket() throws {
@@ -223,9 +225,11 @@ class HTTPClientTests: XCTestCase {
             }
 
             XCTAssertNoThrow(XCTAssertEqual(["GET"[...]],
-                                            try self.defaultClient.execute(socketPath: path, url: "echo-method", method: .GET).wait().headers[canonicalForm: "X-Method-Used"]))
+                                            try self.defaultClient.execute(socketPath: path, urlPath: "echo-method").wait().headers[canonicalForm: "X-Method-Used"]))
+            XCTAssertNoThrow(XCTAssertEqual(["GET"[...]],
+                                            try self.defaultClient.execute(.GET, socketPath: path, urlPath: "echo-method").wait().headers[canonicalForm: "X-Method-Used"]))
             XCTAssertNoThrow(XCTAssertEqual(["POST"[...]],
-                                            try self.defaultClient.execute(socketPath: path, url: "echo-method", method: .POST).wait().headers[canonicalForm: "X-Method-Used"]))
+                                            try self.defaultClient.execute(.POST, socketPath: path, urlPath: "echo-method").wait().headers[canonicalForm: "X-Method-Used"]))
         })
     }
 
@@ -240,9 +244,11 @@ class HTTPClientTests: XCTestCase {
             }
 
             XCTAssertNoThrow(XCTAssertEqual(["GET"[...]],
-                                            try localClient.execute(secureSocketPath: path, url: "echo-method", method: .GET).wait().headers[canonicalForm: "X-Method-Used"]))
+                                            try localClient.execute(secureSocketPath: path, urlPath: "echo-method").wait().headers[canonicalForm: "X-Method-Used"]))
+            XCTAssertNoThrow(XCTAssertEqual(["GET"[...]],
+                                            try localClient.execute(.GET, secureSocketPath: path, urlPath: "echo-method").wait().headers[canonicalForm: "X-Method-Used"]))
             XCTAssertNoThrow(XCTAssertEqual(["POST"[...]],
-                                            try localClient.execute(secureSocketPath: path, url: "echo-method", method: .POST).wait().headers[canonicalForm: "X-Method-Used"]))
+                                            try localClient.execute(.POST, secureSocketPath: path, urlPath: "echo-method").wait().headers[canonicalForm: "X-Method-Used"]))
         })
     }