Change StudyplusError

Author: koji-1009

Lib/StudyplusSDK/Studyplus.swift

@@ -29,7 +29,7 @@ import UIKit
 /**
  The class for using Studyplus.
  For example, you can authenticate in Studyplus account, de-authentication, and post study record.
- 
+
  Studyplusの各機能を使うためのクラスです。
  Studyplusアカウントとの連携、連携解除、勉強記録の投稿ができます。
  */
@@ -151,29 +151,21 @@ final public class Studyplus {
 
     /// Studyplusに学習記録を投稿
     ///
-    /// - Parameter
-    ///   - studyRecord: 学習記録
-    ///   - success: 投稿成功時のコールバック
-    ///   - failure: 投稿失敗時のコールバック
-    public func post(_ record: StudyplusRecord,
-                     success: @escaping () -> Void,
-                     failure: @escaping (_ error: StudyplusError) -> Void) {
-        guard record.isValidDuration else {
-            // TODO: change error type
-            failure(.postRecordFailed)
+    /// - Parameters:
+    ///   - record: 学習記録
+    ///   - completion: 投稿完了後のコールバック
+    public func post(_ record: StudyplusRecord, completion: @escaping (Result<Void, StudyplusPostError>) -> Void) {
+        guard let accessToken = self.accessToken() else {
+            completion(.failure(.needLogin))
             return
         }
 
-        guard let accessToken = self.accessToken() else {
-            failure(.notConnected)
+        guard record.isValidDuration else {
+            completion(.failure(.invalidDuration))
             return
         }
 
-        StudyplusAPIRequest(accessToken: accessToken).post(record, success: {
-            success()
-        }, failure: { error in
-            failure(error)
-        })
+        StudyplusAPIRequest(accessToken: accessToken).post(record, completion: completion)
     }
 
     /// It is responsible for processing custom URL scheme
@@ -193,20 +185,19 @@ final public class Studyplus {
     ///     The valid URL has a __[studyplus-{consumerKey}]__ scheme, and right pathComponents and host.
     ///     渡されたurlがStudyplusSDKで対応すべきURLであれば true、それ以外は false を返します。
     ///     __[studyplus-{consumerKey}]__と正しいpathComponentsを持つことを確認してください。
-    public func handle(appDelegateUrl: URL) -> Bool {
-
-        guard isAcceptableURL(url: appDelegateUrl) else {
-            delegate?.studyplusDidFailToLogin(error: .unknownUrl(appDelegateUrl))
+    public func handle(_ url: URL) -> Bool {
+        guard isAcceptableURL(url: url) else {
+            delegate?.studyplusDidFailToLogin(error: .unknownUrl(url))
             return false
         }
 
-        switch appDelegateUrl.pathComponents[1] {
+        switch url.pathComponents[1] {
         case "success":
-            let accessToken: Data = appDelegateUrl
+            let accessToken: Data = url
                 .pathComponents[2]
                 .trimmingCharacters(in: .whitespacesAndNewlines)
                 .data(using: .utf8, allowLossyConversion: false)!
-            let username: Data = appDelegateUrl
+            let username: Data = url
                 .pathComponents[3]
                 .trimmingCharacters(in: .whitespacesAndNewlines)
                 .data(using: .utf8, allowLossyConversion: false)!
@@ -230,24 +221,13 @@ final public class Studyplus {
             if statusAccessToken == noErr && statusUsername == noErr {
                 delegate?.studyplusDidSuccessToLogin()
             } else {
-                delegate?.studyplusDidFailToLogin(error: .unknownReason("Could not access Keychain."))
+                delegate?.studyplusDidFailToLogin(error: .keychainError)
             }
         case "fail":
-
-            if let errorCode: Int = Int(appDelegateUrl.pathComponents[2]) {
-                delegate?.studyplusDidFailToLogin(error: StudyplusError(errorCode))
-            } else {
-                delegate?.studyplusDidFailToLogin(error: .unknownReason("ErrorCode is nil"))
-            }
-
+            delegate?.studyplusDidFailToLogin(error: .fail)
         case "cancel":
-
-            delegate?.studyplusDidCancelToLogin()
-
+            delegate?.studyplusDidFailToLogin(error: .cancel)
         default:
-            #if DEBUG
-            print("StudyplusSDK: Unknown format: \(appDelegateUrl.absoluteString)")
-            #endif
             return false
         }
 
@@ -271,7 +251,6 @@ final public class Studyplus {
     ///   - consumerKey: consumer key
     ///   - consumerSecret: consumer secret
     public func change(consumerKey: String, consumerSecret: String) {
-
         self.consumerKey = consumerKey
         self.consumerSecret = consumerSecret
     }
@@ -332,7 +311,6 @@ final public class Studyplus {
     }
 
     private func isAcceptableURL(url: URL) -> Bool {
-
         guard let host = url.host else { return false }
         guard host == "auth-result" || host == "login-result" else { return false }
 

Lib/StudyplusSDK/StudyplusAPIRequest.swift

@@ -28,9 +28,9 @@ import Foundation
 
 internal struct StudyplusAPIRequest {
 
-    private static let endPoint: String = "https://external-api.studyplus.jp"
-    private static let path: String = "/v1/study_record"
-    private let studyRecordUrl: URL = URL(string: endPoint + path)!
+    private static let base: String = "https://external-api.studyplus.jp"
+    private static let path: String = "/v1/study_records"
+    private let studyRecordUrl: URL = URL(string: base + path)!
 
     private let accessToken: String
     private var encoder: JSONEncoder {
@@ -45,41 +45,46 @@ internal struct StudyplusAPIRequest {
         self.accessToken = accessToken
     }
 
-    internal func post(_ record: StudyplusRecord,
-                       success: @escaping () -> Void,
-                       failure: @escaping (_ error: StudyplusError) -> Void) {
-        studyRecord(record, success: {
+    internal func post(_ record: StudyplusRecord, completion: @escaping (Result<Void, StudyplusPostError>) -> Void) {
+        exec(record, completion: { result in
             DispatchQueue.main.async {
-                success()
-            }
-        }, failure: { error in
-            DispatchQueue.main.async {
-                failure(error)
+                completion(result)
             }
         })
     }
 
-    private func studyRecord(_ record: StudyplusRecord,
-                             success: @escaping () -> Void,
-                             failure: @escaping (_ error: StudyplusError) -> Void) {
+    private func exec(_ record: StudyplusRecord, completion: @escaping (Result<Void, StudyplusPostError>) -> Void) {
         var request = URLRequest(url: studyRecordUrl)
         request.httpMethod = "POST"
         request.addValue("application/json; charaset=utf-8", forHTTPHeaderField: "Content-Type")
-        request.addValue("OAuth " + accessToken, forHTTPHeaderField: "Authorization")
+        request.addValue("OAuth \(accessToken)", forHTTPHeaderField: "Authorization")
         request.httpBody = try? encoder.encode(record)
 
         let task = URLSession.shared.dataTask(with: request) { data, response, error in
-            guard data != nil, error == nil, let response = response as? HTTPURLResponse else {
-                failure(.postRecordFailed)
+            if let error = error {
+                if let error = error as NSError?,
+                   error.domain == NSURLErrorDomain,
+                   error.code == NSURLErrorNotConnectedToInternet {
+                    completion(.failure(.offline))
+                    return
+                }
+
+                completion(.failure(.badRequest))
+                return
+            }
+
+            guard data != nil, let response = response as? HTTPURLResponse else {
+                completion(.failure(.badRequest))
                 return
             }
 
             guard (200...204).contains(response.statusCode) else {
-                failure(StudyplusError(response.statusCode, ""))
+                let studyplusError = StudyplusPostError.responseError(response.statusCode)
+                completion(.failure(studyplusError))
                 return
             }
 
-            success()
+            completion(.success(Void()))
         }
 
         task.resume()

Lib/StudyplusSDK/StudyplusError.swift

@@ -4,7 +4,7 @@
 //
 //  The MIT License (MIT)
 //
-//  Copyright (c) 2017 Studyplus inc.
+//  Copyright (c) 2021 Studyplus inc.
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
 //  of this software and associated documentation files (the "Software"), to deal
@@ -26,115 +26,32 @@
 
 import Foundation
 
-public enum StudyplusError {
-
-    case getAppDescription
-    case authFailed
-    case loginFailed
-    case studyplusInMaintenance
-    case invalidStudyplusSession
-    case networkUnavailable
+public enum StudyplusPostError: Error {
+    case invalidDuration
+    case needLogin
+    case offline
+    case badRequest
+    case invalidAccessToken
     case serverError
-    case postRecordFailed
-    case notConnected
-    case unknownUrl(URL)
-    case unknownReason(String)
-
-    internal init(_ code: Int) {
+    case unknown(_ message: String)
 
+    static func responseError(_ code: Int) -> StudyplusPostError {
         switch code {
-        case 1000:
-            self = .getAppDescription
-        case 2000:
-            self = .authFailed
-        case 3000:
-            self = .loginFailed
-        case 4000:
-            self = .studyplusInMaintenance
-        case 5000:
-            self = .invalidStudyplusSession
-        case 6000:
-            self = .networkUnavailable
-        case 7000:
-            self = .serverError
-        case 8000:
-            self = .postRecordFailed
-        case 9000:
-            self = .notConnected
-        default:
-            self = .unknownReason("Unexpected Error errorCode: \(code).")
-        }
-    }
-
-    internal init(_ httpStatusCode: Int, _ message: String) {
-
-        switch httpStatusCode {
         case 400:
-            self = .postRecordFailed
+            return .badRequest
         case 401:
-            self = .invalidStudyplusSession
-        case 500:
-            self = .serverError
-        case 503:
-            self = .studyplusInMaintenance
+            return .invalidAccessToken
+        case 500...599:
+            return .serverError
         default:
-            self = .unknownReason("Unexpected http status: \(httpStatusCode), message: \(message).")
+            return .unknown("Unexpected http status: \(code)")
         }
     }
+}
 
-    public func code() -> Int {
-
-        switch self {
-        case .getAppDescription:
-            return 1000
-        case .authFailed:
-            return 2000
-        case .loginFailed:
-            return 3000
-        case .studyplusInMaintenance:
-            return 4000
-        case .invalidStudyplusSession:
-            return 5000
-        case .networkUnavailable:
-            return 6000
-        case .serverError:
-            return 7000
-        case .postRecordFailed:
-            return 8000
-        case .notConnected:
-            return 9000
-        case .unknownUrl:
-            return 10000
-        case .unknownReason:
-            return 90000
-        }
-    }
-
-    public func message() -> String {
-
-        switch self {
-        case .getAppDescription:
-            return "Failed to get information about application. (400 bad request)"
-        case .authFailed:
-            return "Failed to authorize Studyplus user. (400 bad request)"
-        case .loginFailed:
-            return "Failed to login to Studyplus. (400 bad request)"
-        case .studyplusInMaintenance:
-            return "Maybe Studyplus is in temporary maintenance."
-        case .invalidStudyplusSession:
-            return "Studyplus session is invalid."
-        case .networkUnavailable:
-            return "Network is not available."
-        case .serverError:
-            return "Some error(s) occurred in Studyplus server."
-        case .postRecordFailed:
-            return "Failed to post study record. (400 bad request)"
-        case .notConnected:
-            return "Not Connected, so accessToken is nill"
-        case let .unknownUrl(url):
-            return "Unknown Url: \(url.absoluteString)."
-        case let .unknownReason(reason):
-            return "Unknown Error: \(reason)."
-        }
-    }
+public enum StudyplusLoginError: Error {
+    case unknownUrl(_ url: URL)
+    case keychainError
+    case fail
+    case cancel
 }

Lib/StudyplusSDK/StudyplusLoginDelegate.swift

@@ -4,7 +4,7 @@
 //
 //  The MIT License (MIT)
 //
-//  Copyright (c) 2017 Studyplus inc.
+//  Copyright (c) 2021 Studyplus inc.
 //
 //  Permission is hereby granted, free of charge, to any person obtaining a copy
 //  of this software and associated documentation files (the "Software"), to deal
@@ -28,7 +28,7 @@ import Foundation
 
 /**
  The delegate to receive callbacks from Studyplus.
- 
+
  Studyplusオブジェクトに対する各種操作後のコールバックを受けるdelegateです。
  */
 public protocol StudyplusLoginDelegate: class {
@@ -43,18 +43,5 @@ public protocol StudyplusLoginDelegate: class {
     /// Studyplus#login が失敗した後に呼ばれます。
     ///
     /// - Parameter error: failure reason, see StudyplusError. 失敗の理由です。詳細は StudyplusError を参照してください。
-    func studyplusDidFailToLogin(error: StudyplusError)
-
-    // MARK: - optional
-
-    /// Will be called after the Studyplus#login was cancelled.
-    ///
-    /// Studyplus#login がキャンセルされた後に呼ばれます。
-    func studyplusDidCancelToLogin()
-}
-
-public extension StudyplusLoginDelegate {
-
-    func studyplusDidCancelToLogin() {
-    }
+    func studyplusDidFailToLogin(error: StudyplusLoginError)
 }