Make username parameter name explicit

trivago · Feb 17, 2015 · 42b4165 · 42b4165
1 parent 9856707
commit 42b4165
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 14 deletions.
diff --git a/Heimdall/Heimdall.swift b/Heimdall/Heimdall.swift
@@ -63,8 +63,8 @@ public class Heimdall {
     /// :param: username The resource owner's username.
     /// :param: password The resource owner's password.
     /// :param: completion A callback to invoke when the request completed.
-    public func requestAccessToken(username: String, password: String, completion: Result<Void, NSError> -> ()) {
-        requestAccessToken(.ResourceOwnerPasswordCredentials(username, password)) { result in
+    public func requestAccessToken(#username: String, password: String, completion: Result<Void, NSError> -> ()) {
+        requestAccessToken(grant: .ResourceOwnerPasswordCredentials(username, password)) { result in
             completion(result.map { _ in return })
         }
     }
@@ -77,7 +77,7 @@ public class Heimdall {
     ///
     /// :param: grant The authorization grant (e.g., refresh).
     /// :param: completion A callback to invoke when the request completed.
-    private func requestAccessToken(grant: OAuthAuthorizationGrant, completion: Result<OAuthAccessToken, NSError> -> ()) {
+    private func requestAccessToken(#grant: OAuthAuthorizationGrant, completion: Result<OAuthAccessToken, NSError> -> ()) {
         let request = NSMutableURLRequest(URL: tokenURL)
 
         var parameters = grant.parameters
@@ -153,7 +153,7 @@ public class Heimdall {
         if let accessToken = accessToken {
             if accessToken.expiresAt != nil && accessToken.expiresAt < NSDate() {
                 if let refreshToken = accessToken.refreshToken {
-                    requestAccessToken(.RefreshToken(refreshToken)) { result in
+                    requestAccessToken(grant: .RefreshToken(refreshToken)) { result in
                         completion(result.map { accessToken in
                             return self.authenticateRequest(request, accessToken: accessToken)
                         })

diff --git a/HeimdallTests/HeimdallSpec.swift b/HeimdallTests/HeimdallSpec.swift
@@ -59,7 +59,7 @@ class HeimdallSpec: QuickSpec {
                     }
 
                     waitUntil { done in
-                        heimdall.requestAccessToken("username", password: "password") { result = $0; done() }
+                        heimdall.requestAccessToken(username: "username", password: "password") { result = $0; done() }
                     }
                 }
 
@@ -87,7 +87,7 @@ class HeimdallSpec: QuickSpec {
                     }
 
                     waitUntil { done in
-                        heimdall.requestAccessToken("username", password: "password") { result = $0; done() }
+                        heimdall.requestAccessToken(username: "username", password: "password") { result = $0; done() }
                     }
                 }
 
@@ -119,7 +119,7 @@ class HeimdallSpec: QuickSpec {
                     }
 
                     waitUntil { done in
-                        heimdall.requestAccessToken("username", password: "password") { result = $0; done() }
+                        heimdall.requestAccessToken(username: "username", password: "password") { result = $0; done() }
                     }
                 }
 
@@ -151,7 +151,7 @@ class HeimdallSpec: QuickSpec {
                     }
 
                     waitUntil { done in
-                        heimdall.requestAccessToken("username", password: "password") { result = $0; done() }
+                        heimdall.requestAccessToken(username: "username", password: "password") { result = $0; done() }
                     }
                 }
 
@@ -183,7 +183,7 @@ class HeimdallSpec: QuickSpec {
                     }
 
                     waitUntil { done in
-                        heimdall.requestAccessToken("username", password: "password") { result = $0; done() }
+                        heimdall.requestAccessToken(username: "username", password: "password") { result = $0; done() }
                     }
                 }
 
@@ -244,7 +244,7 @@ class HeimdallSpec: QuickSpec {
                     }
 
                     waitUntil { done in
-                        heimdall.requestAccessToken("username", password: "password") { _ in done() }
+                        heimdall.requestAccessToken(username: "username", password: "password") { _ in done() }
                     }
 
                     waitUntil { done in
@@ -268,7 +268,7 @@ class HeimdallSpec: QuickSpec {
                     }
 
                     waitUntil { done in
-                        heimdall.requestAccessToken("username", password: "password") { _ in done() }
+                        heimdall.requestAccessToken(username: "username", password: "password") { _ in done() }
                     }
 
                     waitUntil { done in
@@ -296,7 +296,7 @@ class HeimdallSpec: QuickSpec {
                     }
 
                     waitUntil { done in
-                        heimdall.requestAccessToken("username", password: "password") { _ in done() }
+                        heimdall.requestAccessToken(username: "username", password: "password") { _ in done() }
                     }
 
                     StubsManager.stubRequestsPassingTest({ _ in true }) { request in

diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ let heimdall = Heimdall(tokenURL: tokenURL)
 On login, the resource owner's password credentials are used to request an access token:
 
 ```swift
-heimdall.requestAccessToken("johndoe", "A3ddj3w") { result in
+heimdall.requestAccessToken(username: "johndoe", password: "A3ddj3w") { result in
     switch result {
     case .Success:
         println("success")
@@ -155,7 +155,7 @@ The `authorize` method takes the resource owner's password credentials as parame
 var username: String!
 var password: String!
 
-heimdall.requestAccessToken(username, password) { result in
+heimdall.requestAccessToken(username: username, password: password) { result in
     // ...
 }
 ```