Lowercase the PasswordlessType enum cases (#580)

auth0 · Dec 9, 2021 · 8116b8e · 8116b8e
1 parent 2ec8aa8
commit 8116b8e
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 25 deletions.
diff --git a/Auth0/Auth0Authentication.swift b/Auth0/Auth0Authentication.swift
@@ -228,7 +228,7 @@ struct Auth0Authentication: Authentication {
             "send": type.rawValue,
             "client_id": self.clientId
         ]
-        if case .WebLink = type, !parameters.isEmpty {
+        if case .webLink = type, !parameters.isEmpty {
             payload["authParams"] = parameters
         }
 

diff --git a/Auth0/Authentication.swift b/Auth0/Authentication.swift
@@ -7,6 +7,21 @@ import Foundation
  */
 public typealias DatabaseUser = (email: String, username: String?, verified: Bool)
 
+/**
+ Types of passwordless authentication.
+
+ - code:        Simple OTP code sent by email or sms.
+ - webLink:     Regular Web HTTP link (Web only, uses redirect).
+ - iOSLink:     Universal Link.
+ - androidLink: Android App Link.
+ */
+public enum PasswordlessType: String {
+    case code = "code"
+    case webLink = "link"
+    case iOSLink = "link_ios"
+    case androidLink = "link_android"
+}
+
 /**
  Auth endpoints of Auth0.
 
@@ -435,7 +450,7 @@ public protocol Authentication: Trackable, Loggable {
 
      - Parameters:
        - email:      Email where to send the code or link.
-       - type:       Type of passwordless authentication. By default is 'code'.
+       - type:       Type of passwordless authentication. By default is `code`.
        - connection: Name of the passwordless connection. By default is 'email'.
      - Returns: A request.
      - Requires: Passwordless OTP Grant `http://auth0.com/oauth/grant-type/passwordless/otp`. Check [our documentation](https://auth0.com/docs/configure/applications/application-grant-types) for more info and how to enable it.
@@ -463,7 +478,7 @@ public protocol Authentication: Trackable, Loggable {
 
      - Parameters:
        - phoneNumber: Phone number where to send the sms with code or link.
-       - type:        Type of passwordless authentication. By default is 'code'.
+       - type:        Type of passwordless authentication. By default is `code`.
        - connection:  Name of the passwordless connection. By default is 'sms'.
      - Returns: A request.
      - Requires: Passwordless OTP Grant `http://auth0.com/oauth/grant-type/passwordless/otp`. Check [our documentation](https://auth0.com/docs/configure/applications/application-grant-types) for more info and how to enable it.
@@ -591,21 +606,6 @@ public protocol Authentication: Trackable, Loggable {
 
 }
 
-/**
- Types of passwordless authentication
-
- - Code:        Simple OTP code sent by email or sms
- - WebLink:     Regular Web HTTP link (Web only, uses redirect)
- - iOSLink:     Universal Link
- - AndroidLink: Android App Link
- */
-public enum PasswordlessType: String {
-    case Code = "code"
-    case WebLink = "link"
-    case iOSLink = "link_ios"
-    case AndroidLink = "link_android"
-}
-
 public extension Authentication {
 
     /**
@@ -954,12 +954,12 @@ public extension Authentication {
 
      - Parameters:
        - email:      Email where to send the code or link.
-       - type:       Type of passwordless authentication. By default is 'code'.
+       - type:       Type of passwordless authentication. By default is `code`.
        - connection: Name of the passwordless connection. By default is 'email'.
      - Returns: A request.
      - Requires: Passwordless OTP Grant `http://auth0.com/oauth/grant-type/passwordless/otp`. Check [our documentation](https://auth0.com/docs/configure/applications/application-grant-types) for more info and how to enable it.
      */
-    func startPasswordless(email: String, type: PasswordlessType = .Code, connection: String = "email", parameters: [String: Any] = [:]) -> Request<Void, AuthenticationError> {
+    func startPasswordless(email: String, type: PasswordlessType = .code, connection: String = "email", parameters: [String: Any] = [:]) -> Request<Void, AuthenticationError> {
         return self.startPasswordless(email: email, type: type, connection: connection, parameters: parameters)
     }
 
@@ -984,12 +984,12 @@ public extension Authentication {
 
      - Parameters:
        - phoneNumber: Phone number where to send the sms with code or link.
-       - type:        Type of passwordless authentication. By default is 'code'.
+       - type:        Type of passwordless authentication. By default is `code`.
        - connection:  Name of the passwordless connection. By default is 'sms'.
      - Returns: A request.
      - Requires: Passwordless OTP Grant `http://auth0.com/oauth/grant-type/passwordless/otp`. Check [our documentation](https://auth0.com/docs/configure/applications/application-grant-types) for more info and how to enable it.
      */
-    func startPasswordless(phoneNumber: String, type: PasswordlessType = .Code, connection: String = "sms") -> Request<Void, AuthenticationError> {
+    func startPasswordless(phoneNumber: String, type: PasswordlessType = .code, connection: String = "sms") -> Request<Void, AuthenticationError> {
         return self.startPasswordless(phoneNumber: phoneNumber, type: type, connection: connection)
     }
 

diff --git a/Auth0Tests/AuthenticationSpec.swift b/Auth0Tests/AuthenticationSpec.swift
@@ -784,7 +784,7 @@ class AuthenticationSpec: QuickSpec {
                 let params = ["scope": "openid"]
                 stub(condition: isPasswordless(Domain) && hasAtLeast(["email": SupportAtAuth0]) && hasObjectAttribute("authParams", value: params)) { _ in return passwordless(SupportAtAuth0, verified: true) }.name = "email passwordless web link with parameters"
                 waitUntil(timeout: Timeout) { done in
-                    auth.startPasswordless(email: SupportAtAuth0, type: .WebLink, parameters: params).start { result in
+                    auth.startPasswordless(email: SupportAtAuth0, type: .webLink, parameters: params).start { result in
                         expect(result).to(beSuccessful())
                         done()
                     }
@@ -795,7 +795,7 @@ class AuthenticationSpec: QuickSpec {
                 let params = ["scope": "openid"]
                 stub(condition: isPasswordless(Domain) && hasAllOf(["email": SupportAtAuth0, "connection": "email", "client_id": ClientId, "send": "code"])) { _ in return passwordless(SupportAtAuth0, verified: true) }.name = "email passwordless without parameters"
                 waitUntil(timeout: Timeout) { done in
-                    auth.startPasswordless(email: SupportAtAuth0, type: .Code, parameters: params).start { result in
+                    auth.startPasswordless(email: SupportAtAuth0, type: .code, parameters: params).start { result in
                         expect(result).to(beSuccessful())
                         done()
                     }
@@ -805,7 +805,7 @@ class AuthenticationSpec: QuickSpec {
             it("should not add params attr if they are empty") {
                 stub(condition: isPasswordless(Domain) && hasAllOf(["email": SupportAtAuth0, "connection": "email", "client_id": ClientId, "send": "code"])) { _ in return passwordless(SupportAtAuth0, verified: true) }.name = "email passwordless without parameters"
                 waitUntil(timeout: Timeout) { done in
-                    auth.startPasswordless(email: SupportAtAuth0, type: .Code, parameters: [:]).start { result in
+                    auth.startPasswordless(email: SupportAtAuth0, type: .code, parameters: [:]).start { result in
                         expect(result).to(beSuccessful())
                         done()
                     }

diff --git a/V2_MIGRATION_GUIDE.md b/V2_MIGRATION_GUIDE.md
@@ -31,6 +31,7 @@ As expected with a major release, Auth0.swift v2 contains breaking changes. Plea
     * [Extensions](#extensions)
 - [Types changed](#types-changed)
 - [Type properties changed](#type-properties-changed)
+    * [`PasswordlessType` enum](#passwordlesstype-enum)
     * [`AuthenticationError` struct](#authenticationerror-struct)
     * [`ManagementError` struct](#managementerror-struct)
     * [`WebAuthError` struct](#webautherror-struct)
@@ -214,6 +215,16 @@ The `a0_url(_:)` method is no longer public.
 
 ## Type properties changed
 
+### `PasswordlessType` enum
+
+#### Cases renamed
+
+The following cases were lowercased, as per the naming convention of Swift 3+:
+
+- `Code` -> `code`
+- `WebLink` -> `webLink`
+- `AndroidLink` -> `androidLink`
+
 ### `AuthenticationError` struct
 
 #### Properties removed