refactor: Deprecate encode without claims: label

Author: kylef

JWT.xcodeproj/project.pbxproj

@@ -18,6 +18,10 @@
 		2777940C1DF22BE400573F3E /* JOSEHeader.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2777940A1DF22BE400573F3E /* JOSEHeader.swift */; };
 		2777940D1DF22BE400573F3E /* JOSEHeader.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2777940A1DF22BE400573F3E /* JOSEHeader.swift */; };
 		2777940E1DF22BE400573F3E /* JOSEHeader.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2777940A1DF22BE400573F3E /* JOSEHeader.swift */; };
+		277794101DF22D0D00573F3E /* Encode.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2777940F1DF22D0D00573F3E /* Encode.swift */; };
+		277794111DF22D0D00573F3E /* Encode.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2777940F1DF22D0D00573F3E /* Encode.swift */; };
+		277794121DF22D0D00573F3E /* Encode.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2777940F1DF22D0D00573F3E /* Encode.swift */; };
+		277794131DF22D0D00573F3E /* Encode.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2777940F1DF22D0D00573F3E /* Encode.swift */; };
 		279D63A21AD07FFF0024E2BC /* JWT.h in Headers */ = {isa = PBXBuildFile; fileRef = 279D63A11AD07FFF0024E2BC /* JWT.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		279D63A81AD07FFF0024E2BC /* JWT.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 279D639C1AD07FFF0024E2BC /* JWT.framework */; };
 		279D63AF1AD07FFF0024E2BC /* JWTTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 279D63AE1AD07FFF0024E2BC /* JWTTests.swift */; };
@@ -77,6 +81,7 @@
 /* Begin PBXFileReference section */
 		277794041DF221F800573F3E /* ClaimSet.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ClaimSet.swift; sourceTree = "<group>"; };
 		2777940A1DF22BE400573F3E /* JOSEHeader.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = JOSEHeader.swift; sourceTree = "<group>"; };
+		2777940F1DF22D0D00573F3E /* Encode.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Encode.swift; sourceTree = "<group>"; };
 		279D639C1AD07FFF0024E2BC /* JWT.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = JWT.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		279D63A01AD07FFF0024E2BC /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		279D63A11AD07FFF0024E2BC /* JWT.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = JWT.h; sourceTree = "<group>"; };
@@ -211,6 +216,7 @@
 				520A71131C469F010005C709 /* Base64.swift */,
 				520A71141C469F010005C709 /* Claims.swift */,
 				520A71151C469F010005C709 /* Decode.swift */,
+				2777940F1DF22D0D00573F3E /* Encode.swift */,
 				520A71161C469F010005C709 /* JWT.swift */,
 			);
 			path = Sources;
@@ -472,6 +478,7 @@
 				520A71181C469F010005C709 /* Claims.swift in Sources */,
 				520A711A1C469F010005C709 /* JWT.swift in Sources */,
 				520A71191C469F010005C709 /* Decode.swift in Sources */,
+				277794101DF22D0D00573F3E /* Encode.swift in Sources */,
 				2777940B1DF22BE400573F3E /* JOSEHeader.swift in Sources */,
 				277794051DF221F800573F3E /* ClaimSet.swift in Sources */,
 				520A71171C469F010005C709 /* Base64.swift in Sources */,
@@ -493,6 +500,7 @@
 				CD9B62171C7753D8005D4844 /* Claims.swift in Sources */,
 				CD9B62181C7753D8005D4844 /* JWT.swift in Sources */,
 				CD9B62191C7753D8005D4844 /* Decode.swift in Sources */,
+				277794111DF22D0D00573F3E /* Encode.swift in Sources */,
 				2777940C1DF22BE400573F3E /* JOSEHeader.swift in Sources */,
 				277794061DF221F800573F3E /* ClaimSet.swift in Sources */,
 				CD9B621A1C7753D8005D4844 /* Base64.swift in Sources */,
@@ -506,6 +514,7 @@
 				CD9B62291C7753EC005D4844 /* Claims.swift in Sources */,
 				CD9B622A1C7753EC005D4844 /* JWT.swift in Sources */,
 				CD9B622B1C7753EC005D4844 /* Decode.swift in Sources */,
+				277794121DF22D0D00573F3E /* Encode.swift in Sources */,
 				2777940D1DF22BE400573F3E /* JOSEHeader.swift in Sources */,
 				277794071DF221F800573F3E /* ClaimSet.swift in Sources */,
 				CD9B622C1C7753EC005D4844 /* Base64.swift in Sources */,
@@ -519,6 +528,7 @@
 				CD9B623B1C7753FB005D4844 /* Claims.swift in Sources */,
 				CD9B623C1C7753FB005D4844 /* JWT.swift in Sources */,
 				CD9B623D1C7753FB005D4844 /* Decode.swift in Sources */,
+				277794131DF22D0D00573F3E /* Encode.swift in Sources */,
 				2777940E1DF22BE400573F3E /* JOSEHeader.swift in Sources */,
 				277794081DF221F800573F3E /* ClaimSet.swift in Sources */,
 				CD9B623E1C7753FB005D4844 /* Base64.swift in Sources */,

Sources/Encode.swift

@@ -0,0 +1,48 @@
+/*** Encode a set of claims
+ - parameter claims: The set of claims
+ - parameter algorithm: The algorithm to sign the payload with
+ - returns: The JSON web token as a String
+ */
+public func encode(claims: ClaimSet, algorithm: Algorithm) -> String {
+  func encodeJSON(_ payload: [String: Any]) -> String? {
+    if let data = try? JSONSerialization.data(withJSONObject: payload) {
+      return base64encode(data)
+    }
+
+    return nil
+  }
+
+  let header = encodeJSON(["typ": "JWT", "alg": algorithm.description])!
+  let payload = encodeJSON(claims.claims)!
+  let signingInput = "\(header).\(payload)"
+  let signature = algorithm.sign(signingInput)
+  return "\(signingInput).\(signature)"
+}
+
+/*** Encode a dictionary of claims
+ - parameter claims: The dictionary of claims
+ - parameter algorithm: The algorithm to sign the payload with
+ - returns: The JSON web token as a String
+ */
+public func encode(claims: [String: Any], algorithm: Algorithm) -> String {
+  return encode(claims: ClaimSet(claims: claims), algorithm: algorithm)
+}
+
+
+/// Encode a set of claims using the builder pattern
+public func encode(_ algorithm: Algorithm, closure: ((ClaimSetBuilder) -> ())) -> String {
+  let builder = ClaimSetBuilder()
+  closure(builder)
+  return encode(claims: builder.claims, algorithm: algorithm)
+}
+
+
+/*** Encode a payload
+ - parameter payload: The payload to sign
+ - parameter algorithm: The algorithm to sign the payload with
+ - returns: The JSON web token as a String
+ */
+@available(*, deprecated, message: "use encode(claims: algorithm:) instead")
+public func encode(_ payload: Payload, algorithm: Algorithm) -> String {
+  return encode(claims: ClaimSet(claims: payload), algorithm: algorithm)
+}

Sources/JWT.swift

@@ -64,43 +64,3 @@ public enum Algorithm : CustomStringConvertible {
     return sign(message) == base64encode(signature)
   }
 }
-
-// MARK: Encoding
-
-/*** Encode a set of claims
- - parameter claims: The ClaiMSet to sign
- - parameter algorithm: The algorithm to sign the payload with
- - returns: The JSON web token as a String
- */
-public func encode(claims: ClaimSet, algorithm: Algorithm) -> String {
-  func encodeJSON(_ payload: [String: Any]) -> String? {
-    if let data = try? JSONSerialization.data(withJSONObject: payload) {
-      return base64encode(data)
-    }
-
-    return nil
-  }
-
-  let header = encodeJSON(["typ": "JWT", "alg": algorithm.description])!
-  let payload = encodeJSON(claims.claims)!
-  let signingInput = "\(header).\(payload)"
-  let signature = algorithm.sign(signingInput)
-  return "\(signingInput).\(signature)"
-}
-
-
-/*** Encode a payload
-  - parameter payload: The payload to sign
-  - parameter algorithm: The algorithm to sign the payload with
-  - returns: The JSON web token as a String
-*/
-public func encode(_ payload: Payload, algorithm: Algorithm) -> String {
-  return encode(claims: ClaimSet(claims: payload), algorithm: algorithm)
-}
-
-/// Encode a set of claims using the builder pattern
-public func encode(_ algorithm: Algorithm, closure: ((ClaimSetBuilder) -> ())) -> String {
-  let builder = ClaimSetBuilder()
-  closure(builder)
-  return encode(claims: builder.claims, algorithm: algorithm)
-}