Update IAuthenticator (#2)

ns-vasilev · web-flow · commit 3d055b010d00 · 2024-05-11T18:18:45.000+04:00
* Update `IAuthenticator`

* Update `CHANGELOG`

* Update docs

* Update `danger.yml`

* Update Unit Tests
diff --git a/.github/workflows/danger.yml b/.github/workflows/danger.yml
@@ -15,7 +15,7 @@ jobs:
       - name: ruby setup
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.1.4
           bundler-cache: true
       - name: Checkout code
         uses: actions/checkout@v2
@@ -28,4 +28,4 @@ jobs:
           
           DANGER_GITHUB_API_TOKEN: ${{ secrets.DANGER_GITHUB_API_TOKEN }}
           
-        run: bundle exec danger --verbose
+        run: bundle exec danger --verbose
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [Unreleased]
+
+## Fixed
+- Fix the `inout` parameter in the `IAuthenticator` protocol
+  - Fixed in Pull Request [#2](https://github.com/space-code/network-layer/pull/2).
+
 #### 1.x Releases
 - `1.0.x` Releases - [1.0.0](#100)
 
diff --git a/Sources/NetworkLayer/Classes/Core/Authentification/AuthenticationInterceptor.swift b/Sources/NetworkLayer/Classes/Core/Authentification/AuthenticationInterceptor.swift
@@ -46,7 +46,7 @@ public final class AuthenticationInterceptor<Authenticator: IAuthenticator>: IAu
         if credential.requiresRefresh {
             try await refresh(credential, for: session)
         } else {
-            try await authenticator.apply(credential, to: request)
+            try await authenticator.apply(credential, to: &request)
         }
     }
 
diff --git a/Sources/NetworkLayer/NetworkLayer.docc/Articles/Authentication.md b/Sources/NetworkLayer/NetworkLayer.docc/Articles/Authentication.md
@@ -34,8 +34,8 @@ struct Authenticator: IAuthenticator {
     /// - Parameters:
     ///   - credential: The `Credential`.
     ///   - urlRequest: The `URLRequest`.
-    func apply(_ credential: Credential, to urlRequest: URLRequest) async throws {
-        request.addValue("Bearer <token>", forHTTPHeaderField: "Authorization")
+    func apply(_ credential: Credential, to urlRequest: inout URLRequest) async throws {
+        urlRequest.addValue("Bearer <token>", forHTTPHeaderField: "Authorization")
     }
 
     /// Refreshes the `Credential`.
diff --git a/Sources/NetworkLayerInterfaces/Classes/Core/Authenticator/IAuthenticator.swift b/Sources/NetworkLayerInterfaces/Classes/Core/Authenticator/IAuthenticator.swift
@@ -14,7 +14,7 @@ public protocol IAuthenticator {
     /// - Parameters:
     ///   - credential: The `Credential`.
     ///   - urlRequest: The `URLRequest`.
-    func apply(_ credential: Credential, to urlRequest: URLRequest) async throws
+    func apply(_ credential: Credential, to urlRequest: inout URLRequest) async throws
 
     /// Refreshes the `Credential`.
     ///
diff --git a/Tests/NetworkLayerTests/Classes/Helpers/Mocks/AuthenticatorMock.swift b/Tests/NetworkLayerTests/Classes/Helpers/Mocks/AuthenticatorMock.swift
@@ -14,7 +14,7 @@ final class AuthenticatorMock: IAuthenticator {
     var invokedApplyParameters: (credential: Credential, urlRequest: URLRequest)?
     var invokedApplyParametersList = [(credential: Credential, urlRequest: URLRequest)]()
 
-    func apply(_ credential: Credential, to urlRequest: URLRequest) async throws {
+    func apply(_ credential: Credential, to urlRequest: inout URLRequest) async throws {
         invokedApply = true
         invokedApplyCount += 1
         invokedApplyParameters = (credential, urlRequest)
diff --git a/Tests/NetworkLayerTests/Classes/Tests/UnitTests/RequestParametersEncoderTests.swift b/Tests/NetworkLayerTests/Classes/Tests/UnitTests/RequestParametersEncoderTests.swift
@@ -41,7 +41,8 @@ final class RequestParametersEncoderTests: XCTestCase {
 
     func test_thatRequestParametersEncoderThrowsAnError_whenURLIsNotValid() {
         // given
-        var requestMock = URLRequest.fake(string: .wrongURL)
+        var requestMock = URLRequest.fake(string: .domainName)
+        requestMock.url = nil
 
         // when
         var receivedError: NSError?
@@ -60,7 +61,6 @@ final class RequestParametersEncoderTests: XCTestCase {
 
 private extension String {
     static let domainName = "https://google.com"
-    static let wrongURL = "http://example.com:-80"
 }
 
 private extension Dictionary where Self.Key == String, Self.Value == String {

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ public final class AuthenticationInterceptor<Authenticator: IAuthenticator>: IAu`
`46`	`46`	`if credential.requiresRefresh {`
`47`	`47`	`try await refresh(credential, for: session)`
`48`	`48`	`} else {`
`49`		`- try await authenticator.apply(credential, to: request)`
	`49`	`+ try await authenticator.apply(credential, to: &request)`
`50`	`50`	`}`
`51`	`51`	`}`
`52`	`52`