Make PassJSON and OrderJSON Codable

Author: fpseverino

Sources/Orders/OrderJSON.swift

@@ -3,7 +3,7 @@ public enum OrderJSON {
     /// A protocol that defines the structure of a `order.json` file.
     ///
     /// > Tip: See the [`Order`](https://developer.apple.com/documentation/walletorders/order) object to understand the keys.
-    public protocol Properties: Encodable {
+    public protocol Properties: Codable {
         /// The date and time when the customer created the order, in RFC 3339 format.
         var createdAt: String { get }
 
@@ -48,7 +48,7 @@ extension OrderJSON {
     /// A protocol that represents the merchant associated with the order.
     ///
     /// > Tip: See the [`Order.Merchant`](https://developer.apple.com/documentation/walletorders/merchant) object to understand the keys.
-    public protocol Merchant: Encodable {
+    public protocol Merchant: Codable {
         /// The localized display name of the merchant.
         var displayName: String { get }
 
@@ -64,7 +64,7 @@ extension OrderJSON {
     /// A protocol that represents the details of a barcode for an order.
     ///
     /// > Tip: See the [`Order.Barcode`](https://developer.apple.com/documentation/walletorders/barcode) object to understand the keys.
-    public protocol Barcode: Encodable {
+    public protocol Barcode: Codable {
         /// The format of the barcode.
         var format: BarcodeFormat { get }
 
@@ -80,24 +80,24 @@ extension OrderJSON {
 
 extension OrderJSON {
     /// The type of order this bundle represents.
-    public enum OrderType: String, Encodable {
+    public enum OrderType: String, Codable {
         case ecommerce
     }
 
     /// A high-level status of the order, used for display purposes.
-    public enum OrderStatus: String, Encodable {
+    public enum OrderStatus: String, Codable {
         case completed
         case cancelled
         case open
     }
 
     /// The version of the schema used for the order.
-    public enum SchemaVersion: Int, Encodable {
+    public enum SchemaVersion: Int, Codable {
         case v1 = 1
     }
 
     /// The format of the barcode.
-    public enum BarcodeFormat: String, Encodable {
+    public enum BarcodeFormat: String, Codable {
         case pdf417
         case qr
         case aztec

Sources/Passes/PassJSON.swift

@@ -3,7 +3,7 @@ public enum PassJSON {
     /// A protocol that defines the structure of a `pass.json` file.
     ///
     /// > Tip: See the [`Pass`](https://developer.apple.com/documentation/walletpasses/pass) object to understand the keys.
-    public protocol Properties: Encodable {
+    public protocol Properties: Codable {
         /// A short description that iOS accessibility technologies use for a pass.
         var description: String { get }
 
@@ -34,7 +34,7 @@ extension PassJSON {
     /// A protocol that represents the information to display in a field on a pass.
     ///
     /// > Tip: See the [`PassFieldContent`](https://developer.apple.com/documentation/walletpasses/passfieldcontent) object to understand the keys.
-    public protocol PassFieldContent: Encodable {
+    public protocol PassFieldContent: Codable {
         /// A unique key that identifies a field in the pass; for example, `departure-gate`.
         var key: String { get }
 
@@ -49,7 +49,7 @@ extension PassJSON {
     /// A protocol that represents the groups of fields that display the information for a boarding pass.
     ///
     /// > Tip: See the [`Pass.BoardingPass`](https://developer.apple.com/documentation/walletpasses/pass/boardingpass) object to understand the keys.
-    public protocol BoardingPass: Encodable {
+    public protocol BoardingPass: Codable {
         /// The type of transit for a boarding pass.
         ///
         /// This key is invalid for other types of passes.
@@ -64,7 +64,7 @@ extension PassJSON {
     /// A protocol that represents a barcode on a pass.
     ///
     /// > Tip: See the [`Pass.Barcodes`](https://developer.apple.com/documentation/walletpasses/pass/barcodes) object to understand the keys.
-    public protocol Barcodes: Encodable {
+    public protocol Barcodes: Codable {
         /// The format of the barcode.
         ///
         /// The barcode format `PKBarcodeFormatCode128` isn’t supported for watchOS.
@@ -83,7 +83,7 @@ extension PassJSON {
     /// A protocol that represents a location that the system uses to show a relevant pass.
     ///
     /// > Tip: See the [`Pass.Locations`](https://developer.apple.com/documentation/walletpasses/pass/locations) object to understand the keys.
-    public protocol Locations: Encodable {
+    public protocol Locations: Codable {
         /// The latitude, in degrees, of the location.
         var latitude: Double { get }
 
@@ -96,7 +96,7 @@ extension PassJSON {
     /// An object that represents the near-field communication (NFC) payload the device passes to an Apple Pay terminal.
     ///
     /// > Tip: See the [`Pass.NFC`](https://developer.apple.com/documentation/walletpasses/pass/nfc) object to understand the keys.
-    public protocol NFC: Encodable {
+    public protocol NFC: Codable {
         /// The payload the device transmits to the Apple Pay terminal.
         ///
         /// The size must be no more than 64 bytes.
@@ -112,13 +112,13 @@ extension PassJSON {
 
 extension PassJSON {
     /// The version of the file format.
-    public enum FormatVersion: Int, Encodable {
+    public enum FormatVersion: Int, Codable {
         /// The value must be `1`.
         case v1 = 1
     }
 
     /// The type of transit for a boarding pass.
-    public enum TransitType: String, Encodable {
+    public enum TransitType: String, Codable {
         case air = "PKTransitTypeAir"
         case boat = "PKTransitTypeBoat"
         case bus = "PKTransitTypeBus"
@@ -127,7 +127,7 @@ extension PassJSON {
     }
 
     /// The format of the barcode.
-    public enum BarcodeFormat: String, Encodable {
+    public enum BarcodeFormat: String, Codable {
         case pdf417 = "PKBarcodeFormatPDF417"
         case qr = "PKBarcodeFormatQR"
         case aztec = "PKBarcodeFormatAztec"

Tests/OrdersTests/TestOrder.swift

@@ -1,41 +1,24 @@
 import Foundation
 import Orders
 
-extension OrderJSON.SchemaVersion: Decodable {}
-extension OrderJSON.OrderType: Decodable {}
-extension OrderJSON.OrderStatus: Decodable {}
+struct TestOrder: OrderJSON.Properties {
+    var schemaVersion = OrderJSON.SchemaVersion.v1
+    var orderTypeIdentifier = "order.com.example.swift-wallet"
+    var orderIdentifier = UUID().uuidString
+    var orderType = OrderJSON.OrderType.ecommerce
+    var orderNumber = "HM090772020864"
+    var createdAt = Date.now.ISO8601Format()
+    var updatedAt = Date.now.ISO8601Format()
+    var status = OrderJSON.OrderStatus.open
+    var merchant = MerchantData()
+    var orderManagementURL = "https://www.example.com/"
+    var authenticationToken = UUID().uuidString
+    var webServiceURL = "https://www.example.com/api/orders/"
 
-struct TestOrder: OrderJSON.Properties, Decodable {
-    let schemaVersion = OrderJSON.SchemaVersion.v1
-    let orderTypeIdentifier = "order.com.example.swift-wallet"
-    let orderIdentifier = UUID().uuidString
-    let orderType = OrderJSON.OrderType.ecommerce
-    let orderNumber = "HM090772020864"
-    let createdAt = Date.now.ISO8601Format()
-    let updatedAt = Date.now.ISO8601Format()
-    let status = OrderJSON.OrderStatus.open
-    let merchant = MerchantData()
-    let orderManagementURL = "https://www.example.com/"
-    let authenticationToken = UUID().uuidString
-
-    private let webServiceURL = "https://www.example.com/api/orders/"
-
-    enum CodingKeys: String, CodingKey {
-        case schemaVersion
-        case orderTypeIdentifier, orderIdentifier, orderType, orderNumber
-        case createdAt, updatedAt
-        case status, merchant
-        case orderManagementURL, authenticationToken, webServiceURL
-    }
-
-    struct MerchantData: OrderJSON.Merchant, Decodable {
-        let merchantIdentifier = "com.example.pet-store"
-        let displayName = "Pet Store"
-        let url = "https://www.example.com/"
-        let logo = "pet_store_logo.png"
-
-        enum CodingKeys: String, CodingKey {
-            case merchantIdentifier, displayName, url, logo
-        }
+    struct MerchantData: OrderJSON.Merchant {
+        var merchantIdentifier = "com.example.pet-store"
+        var displayName = "Pet Store"
+        var url = "https://www.example.com/"
+        var logo = "pet_store_logo.png"
     }
 }

Tests/PassesTests/TestPass.swift

@@ -1,46 +1,37 @@
 import Foundation
 import Passes
 
-extension PassJSON.FormatVersion: Decodable {}
-extension PassJSON.BarcodeFormat: Decodable {}
-extension PassJSON.TransitType: Decodable {}
-
-struct TestPass: PassJSON.Properties, Decodable {
-    let description = "Test Pass"
-    let formatVersion = PassJSON.FormatVersion.v1
-    let organizationName = "example"
-    let passTypeIdentifier = "pass.com.example.swift-wallet"
-    let serialNumber = UUID().uuidString
-    let teamIdentifier = "K6512ZA2S5"
-
-    private let webServiceURL = "https://www.example.com/api/passes/"
-    let authenticationToken = UUID().uuidString
-    private let logoText = "Vapor Community"
-    private let sharingProhibited = true
-    let backgroundColor = "rgb(207, 77, 243)"
-    let foregroundColor = "rgb(255, 255, 255)"
-
-    let barcodes = Barcode(message: "test")
-    struct Barcode: PassJSON.Barcodes, Decodable {
-        let format = PassJSON.BarcodeFormat.qr
-        let message: String
-        let messageEncoding = "iso-8859-1"
-
-        enum CodingKeys: String, CodingKey {
-            case format, message, messageEncoding
-        }
+struct TestPass: PassJSON.Properties {
+    var description = "Test Pass"
+    var formatVersion = PassJSON.FormatVersion.v1
+    var organizationName = "example"
+    var passTypeIdentifier = "pass.com.example.swift-wallet"
+    var serialNumber = UUID().uuidString
+    var teamIdentifier = "K6512ZA2S5"
+    var webServiceURL = "https://www.example.com/api/passes/"
+    var authenticationToken = UUID().uuidString
+    var logoText = "Vapor Community"
+    var sharingProhibited = true
+    var backgroundColor = "rgb(207, 77, 243)"
+    var foregroundColor = "rgb(255, 255, 255)"
+
+    var barcodes = Barcode(message: "test")
+    struct Barcode: PassJSON.Barcodes {
+        var format = PassJSON.BarcodeFormat.qr
+        var message: String
+        var messageEncoding = "iso-8859-1"
     }
 
-    let boardingPass = Boarding(transitType: .air)
-    struct Boarding: PassJSON.BoardingPass, Decodable {
+    var boardingPass = Boarding(transitType: .air)
+    struct Boarding: PassJSON.BoardingPass {
         let transitType: PassJSON.TransitType
         let headerFields: [PassField]
         let primaryFields: [PassField]
         let secondaryFields: [PassField]
         let auxiliaryFields: [PassField]
         let backFields: [PassField]
 
-        struct PassField: PassJSON.PassFieldContent, Decodable {
+        struct PassField: PassJSON.PassFieldContent {
             let key: String
             let label: String
             let value: String
@@ -55,13 +46,4 @@ struct TestPass: PassJSON.Properties, Decodable {
             self.transitType = transitType
         }
     }
-
-    enum CodingKeys: String, CodingKey {
-        case description
-        case formatVersion
-        case organizationName, passTypeIdentifier, serialNumber, teamIdentifier
-        case webServiceURL, authenticationToken
-        case logoText, sharingProhibited, backgroundColor, foregroundColor
-        case barcodes, boardingPass
-    }
 }