Updated the documentation with the Vipps integration

Author: Steffen Lund Andersen

README.md

@@ -5,7 +5,9 @@ The QuickPay SDK wraps the [QuickPay API](https://learn.quickpay.net/tech-talk/a
 
 ## Installation
 
-You can install the QuickPay SDK either by downloading it directly from our GitHub repo or by adding it as a Swift Package. If you want to use Swift Packages simply point to the git repo and check out the master branch.
+You can install the QuickPay SDK either by downloading it directly from our GitHub repo or by adding it as a Swift Package.
+
+If you want to use Swift Packages simply point to the git repo https://github.com/QuickPay/ios-sdk and check out the master branch.
 
 
 ### API key and permissions
@@ -114,7 +116,7 @@ QuickPay SDK supports MobilePay natively so you can create a great app experienc
 It is recommended that you check if the users have the MobilePay App installed and only show the payment option if it is available. The QuickPay class can help you with this.
 
 ```swift
-QuickPay.isMobilePayAvailable()
+QuickPay.isMobilePayAvailableOnDevice()
 ```
 
 
@@ -131,7 +133,7 @@ You can read more about the URL schemes on [https://developers.apple.com](https:
 
 First, you need to create a payment just like with the payment window, but after that, the flow is different since we do not have the payment window to handle a lot of tasks for us.
 
-When you have created your payment you need to start a MobilePay payment session. Create a `MobilePayParameters` object and specify the custom URL scheme that you created earlier. You can also specify the language of MobilePay and add a URL to a logo you want it to be displayed. Add this information to a `QPCreatePaymenSessionParameters` along with the amount of money you want to authorize. Finally, put everything together in a `QPCreatePaymenSessionRequest` and send the request.
+When you have created your payment you need to start a MobilePay payment session. Create a `MobilePayParameters` object and specify the custom URL scheme that you created earlier. You can also specify the language of MobilePay and add a URL to a logo you want it to be displayed. Add this information to a `QPCreatePaymentSessionParameters` along with the amount of money you want to authorize. Finally, put everything together in a `QPCreatePaymentSessionRequest` and send the request.
 
 ```swift
 let mobilePayParameters = MobilePayParameters(returnUrl: "quickpayexampleshop://", language: "dk", shopLogoUrl: "https://SomeUrl/SomeImage.png")
@@ -159,6 +161,58 @@ QuickPay.authorizeWithMobilePay(payment: payment, completion: { (payment) in {
 In the completion handler, we need to check the status of the payment. This is done in the same way as with the payment window. Create a `QPGetPaymentRequest` with the payment id and check if the updated payment is accepted.
 
 
+### Vipps
+
+QuickPay SDK supports Vipps natively so you can create a great app experience. To query the Vipps App you need to make some changes to your project settings and implement the payment as shown later in this guide.
+
+It is recommended that you check if the users have the Vipps App installed and only show the payment option if it is available. The QuickPay class can help you with this.
+
+```swift
+QuickPay.isVippsAvailableOnDevice()
+```
+
+
+#### URL Schemes for Vipps
+
+To query the MobilePay App you need to whitelist the `vipps` URL scheme to the `LSApplicationQueriesSchemes` array in your `Info.plist`. With this done your application can now query the Vipps App with the needed information for Vipps to handle the authorization of a payment.
+
+You also need to specify a custom URL scheme for the Vipps App to query back to when it is done doing its job. This is done in the `URL types` array in your `Info.plist`.
+
+You can read more about the URL schemes on [https://developers.apple.com](https://developer.apple.com/documentation/uikit/core_app/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app)
+
+
+#### Payment flow for Vipps
+
+First, you need to create a payment just like with the payment window, but after that, the flow is different since we do not have the payment window to handle a lot of tasks for us.
+
+When you have created your payment you need to start a Vipps payment session. Create a `VippsParameters` object and specify the custom URL scheme that you created earlier. Add this information to a `QPCreatePaymentSessionParameters` along with the amount of money you want to authorize and remember to set the currency to "NOK". Finally, put everything together in a `QPCreatePaymentSessionRequest` and send the request.
+
+```swift
+let vippsParams = VippsParameters(returnUrl: "quickpayexampleshop://")
+let sessionParameters = QPCreatePaymentSessionParameters(amount: Int(self.totalBasketValue() * 100), vipps: vippsParams)
+
+let request = QPCreatePaymenSessionRequest(id: payment.id, parameters: sessionParameters)
+
+request.sendRequest(success: { (payment) in
+    // Handle the payment
+}, failure: { (data, response, error) in
+    // Handle the failure
+})
+```
+
+With the payment containing a session id, we can now query Vipps to authorize the payment.
+
+```swift
+QuickPay.authorizeWithVipps(payment: payment, completion: { (payment) in {
+    // Handle the payment
+}, failure: {
+    // Handle the failure
+}
+```
+
+In the completion handler, we need to check the status of the payment. This is done in the same way as with the payment window. Create a `QPGetPaymentRequest` with the payment id and check if the updated payment is accepted.
+
+
 ### Apple Pay
 
 In order to take advantage of Apple Pay, first, you need to do some initial setup to your project and generate a signing certificate. When that is done you also need to implement a bit of code to handle the native Apple Pay flow.

Sources/QuickPaySDK/Core/QuickPay.swift

@@ -62,7 +62,7 @@ public class QuickPay: NSObject {
         let dispatchGroup = DispatchGroup();
 
         dispatchGroup.enter()
-        isMobilePayOnlineEnabled { (enabled) in
+        isMobilePayEnabled { (enabled) in
             isMobilePayEnabled = enabled
             dispatchGroup.leave()
         }
@@ -309,11 +309,8 @@ extension QuickPay {
 // MobilePay
 extension QuickPay {
 
-    static func isMobilePayOnlineEnabled(completion: @escaping (_ enabled: Bool)->Void) {
+    static func isMobilePayEnabled(completion: @escaping (_ enabled: Bool)->Void) {
         QPGetAcquireSettingsMobilePayRequest().sendRequest(success: { (settings) in
-            print("LOOK HERE: isMobilePayOnlineEnabled: \(settings.active)")
-            print("LOOK HERE: isMobilePayOnlineEnabled: \(settings)")
-            
             completion(settings.active)
         }) { (data, response, error) in
             completion(false)

Sources/QuickPaySDK/Networking/QuickPay API/QPRequest.swift

@@ -93,19 +93,6 @@ public class QPRequest {
  A model representation of the error json returned by QuickPay in case of an error
  */
 public struct QPRequestError : Codable {
-    /*
-     NOTE: This is not used at the momement, but in the future it will be a part of the request/response cycle
-     
-     Code snippet:
-     if (QuickPayHttpStatusCodes(rawValue: httpResponse.statusCode) == QuickPayHttpStatusCodes.badRequest) {
-     // On bad requests, QuickPay has their own error format, we parse it and return to ease the use
-     if let data = data, let qpRequstError = try? JSONDecoder().decode(QPRequestError.self, from: data) {
-     self.errorDelegate?.onError(request: self, qpError: qpRequstError)
-     return
-     }
-     }
-     */
-    
     public let message: String
     public let errors: Dictionary<String, Array<String>>
     public let error_code: String

Sources/QuickPaySDK/Networking/QuickPay API/QuickPay Link/Payments/QPCreatePaymentRequest.swift

@@ -64,9 +64,7 @@ public class QPCreatePaymentParameters: Codable {
         self.currency = currency
         self.order_id = order_id
 
-        self.shopSystem = QPShopSystem()
-        self.shopSystem?.name = "iOS-SDK"
-        self.shopSystem?.version = "2.0.0"
+        self.shopSystem = QPShopSystem(name: "iOS-SDK", version: "2.0.0")
     }
 
 }