Update instance name to client

Author: aviggiano

Diff for: .github/workflows/ci.yml

@@ -51,5 +51,5 @@ jobs:
 
       - name: Test
         run: |
-          forge test --ffi -vvv
+          forge test -vvv
         id: test

Diff for: README.md

@@ -22,13 +22,12 @@ Use builder functions to compose your request with headers, body, and query para
 
 ```solidity
 contract MyScript is Script {
-    using HTTP for HTTP.Builder;
-    using HTTP for HTTP.Request;
+    using HTTP for *;
 
-    HTTP.Builder http;
+    HTTP.Client http;
 
     function run() external {
-        HTTP.Response memory response = http.build().POST("https://httpbin.org/post")
+        HTTP.Response memory response = http.initialize().POST("https://httpbin.org/post")
             .withHeader("Content-Type", "application/json")
             .withHeader("Accept", "application/json")
             .withBody('{"foo": "bar"}')

Diff for: foundry.toml

@@ -2,5 +2,6 @@
 src = "src"
 out = "out"
 libs = ["lib"]
+ffi = true
 
 # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

Diff for: src/HTTP.sol

@@ -9,7 +9,7 @@ library HTTP {
 
     Vm constant vm = Vm(address(bytes20(uint160(uint256(keccak256("hevm cheat code"))))));
 
-    error HTTPBuilderInvalidArrayLengths(uint256 a, uint256 b);
+    error HTTPArrayLengthsMismatch(uint256 a, uint256 b);
 
     enum Method {
         GET,
@@ -32,17 +32,21 @@ library HTTP {
         string data;
     }
 
-    struct Builder {
+    struct Client {
         Request[] requests;
     }
 
-    function build(HTTP.Builder storage builder) internal returns (HTTP.Request storage) {
-        builder.requests.push();
-        return builder.requests[builder.requests.length - 1];
+    function initialize(HTTP.Client storage client) internal returns (HTTP.Request storage) {
+        client.requests.push();
+        return client.requests[client.requests.length - 1];
     }
 
-    function instance(HTTP.Builder storage builder) internal view returns (HTTP.Request storage) {
-        return builder.requests[builder.requests.length - 1];
+    function initialize(HTTP.Client storage client, string memory url) internal returns (HTTP.Request storage) {
+        return withUrl(initialize(client), url);
+    }
+
+    function instance(HTTP.Client storage client) internal view returns (HTTP.Request storage) {
+        return client.requests[client.requests.length - 1];
     }
 
     function withUrl(HTTP.Request storage req, string memory url) internal returns (HTTP.Request storage) {
@@ -113,7 +117,7 @@ library HTTP {
         returns (HTTP.Request storage)
     {
         if (keys.length != values.length) {
-            revert HTTPBuilderInvalidArrayLengths(keys.length, values.length);
+            revert HTTPArrayLengthsMismatch(keys.length, values.length);
         }
         for (uint256 i = 0; i < keys.length; i++) {
             req.headers.set(keys[i], values[i]);
@@ -134,7 +138,7 @@ library HTTP {
         returns (HTTP.Request storage)
     {
         if (keys.length != values.length) {
-            revert HTTPBuilderInvalidArrayLengths(keys.length, values.length);
+            revert HTTPArrayLengthsMismatch(keys.length, values.length);
         }
         for (uint256 i = 0; i < keys.length; i++) {
             req.query.set(keys[i], values[i]);
@@ -183,6 +187,7 @@ library HTTP {
         } else if (method == Method.PATCH) {
             return "PATCH";
         } else {
+            // unreachable code
             revert();
         }
     }

Diff for: test/HTTP.t.sol

@@ -7,21 +7,20 @@ import {HTTP} from "../src/HTTP.sol";
 import {strings} from "solidity-stringutils/strings.sol";
 
 contract HTTPTest is Test {
-    using HTTP for HTTP.Builder;
-    using HTTP for HTTP.Request;
+    using HTTP for *;
     using strings for *;
 
-    HTTP.Builder http;
+    HTTP.Client http;
 
     function test_HTTP_GET() public {
-        HTTP.Response memory res = http.build().GET("https://jsonplaceholder.typicode.com/todos/1").request();
+        HTTP.Response memory res = http.initialize().GET("https://jsonplaceholder.typicode.com/todos/1").request();
 
         assertEq(res.status, 200);
         assertEq(res.data, '{  "userId": 1,  "id": 1,  "title": "delectus aut autem",  "completed": false}');
     }
 
     function test_HTTP_GET_options() public {
-        HTTP.Response memory res = http.build().GET("https://httpbin.org/headers").withHeader(
+        HTTP.Response memory res = http.initialize("https://httpbin.org/headers").GET().withHeader(
             "accept", "application/json"
         ).withHeader("Authorization", "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==").request();
 
@@ -33,7 +32,7 @@ contract HTTPTest is Test {
 
     function test_HTTP_POST_form_data() public {
         HTTP.Response memory res =
-            http.build().POST("https://httpbin.org/post").withBody("[email protected]").request();
+            http.initialize().POST("https://httpbin.org/post").withBody("[email protected]").request();
 
         assertEq(res.status, 200);
 
@@ -42,35 +41,40 @@ contract HTTPTest is Test {
     }
 
     function test_HTTP_POST_json() public {
-        HTTP.Response memory res = http.build().POST("https://httpbin.org/post").withBody('{"foo": "bar"}').request();
+        HTTP.Response memory res =
+            http.initialize("https://httpbin.org/post").POST().withBody('{"foo": "bar"}').request();
 
         assertEq(res.status, 200);
         assertTrue(res.data.toSlice().contains(("foo").toSlice()));
         assertTrue(res.data.toSlice().contains(("bar").toSlice()));
     }
 
     function test_HTTP_PUT() public {
-        HTTP.Response memory res = http.build().PUT("https://httpbin.org/put").request();
+        HTTP.Response memory res = http.initialize().PUT("https://httpbin.org/put").request();
         assertEq(res.status, 200);
     }
 
     function test_HTTP_PUT_json() public {
-        HTTP.Response memory res = http.build().PUT("https://httpbin.org/put").withBody('{"foo": "bar"}').withHeader(
-            "Content-Type", "application/json"
-        ).request();
+        HTTP.Response memory res = http.initialize("https://httpbin.org/put").PUT().withBody('{"foo": "bar"}')
+            .withHeader("Content-Type", "application/json").request();
 
         assertEq(res.status, 200);
         assertTrue(res.data.toSlice().contains(('"foo"').toSlice()));
         assertTrue(res.data.toSlice().contains(('"bar"').toSlice()));
     }
 
     function test_HTTP_DELETE() public {
-        HTTP.Response memory res = http.build().DELETE("https://httpbin.org/delete").request();
+        HTTP.Response memory res = http.initialize().DELETE("https://httpbin.org/delete").request();
         assertEq(res.status, 200);
     }
 
     function test_HTTP_PATCH() public {
-        HTTP.Response memory res = http.build().PATCH("https://httpbin.org/patch").request();
+        HTTP.Response memory res = http.initialize().PATCH("https://httpbin.org/patch").request();
         assertEq(res.status, 200);
     }
+
+    function test_HTTP_instance() public {
+        HTTP.Request storage req = http.initialize("https://jsonplaceholder.typicode.com/todos/1");
+        assertEq(req.url, "https://jsonplaceholder.typicode.com/todos/1");
+    }
 }