ZaimAPIでOAuthSwiftによる認証・コールバックがうまくいかない

Question

前提・実現したいこと

ZaimAPIを使って音声で出費登録できるiOSアプリを作っています。

まずOAuth認証をしてアクセスキーを入手したく下記を参考にしているのですが、「ログインして許可する」を押して「認証が完了」と表示されるもののアプリに戻ってくれず、アクセスキーが入手できません。
http://qs.nndo.jp/oauth-swift-zaim
https://qiita.com/fromage-blanc/items/739622dee826806c12d5

発生している問題・エラーメッセージ

予定では認証完了後にAppDelegateのメソッドが呼ばれて、コールバック時のクロージャー内でアクセスキー（credential.oauthTokenとcredential.oauthTokenSecret）がprint出力されるはずなのですが、まずAppDelegateのメソッドが呼ばれません。

Xcodeのコンソールにも特にエラーメッセージはでていないです。

該当のソースコード

※一度Zaim Developers Center側でアプリを削除して作り直そうとしたら、同じ名称だと重複と言われたので名称を変えています。

// ViewController.swift
import UIKit
import OAuthSwift

class ViewController: UIViewController {
    
    var oauthswift: OAuthSwift? = nil
    
    @IBAction func onTappedSyncButton(_ sender: UIButton) {
        
        let oauthswift = OAuth1Swift(
            consumerKey:    "**********",
            consumerSecret: "**********",
            requestTokenUrl: "https://api.zaim.net/v2/auth/request",
            authorizeUrl:    "https://auth.zaim.net/users/auth",
            accessTokenUrl:  "https://api.zaim.net/v2/auth/access"
        )
        
        self.oauthswift = oauthswift
        oauthswift.authorizeURLHandler = getURLHandler()
        
        let _ = oauthswift.authorize(
            withCallbackURL: URL(string: "KoeDeZaim://oauth-callback")!,
            success: { credential, response, parameters in
                self.showTokenAlert(name: "Service", credential: credential)
        },
            failure: { error in
                print(error.description)
        }
        )
    }
    
    func getURLHandler() -> OAuthSwiftURLHandlerType {
        if #available(iOS 9.0, *) {
            let handler = SafariURLHandler(viewController: self, oauthSwift: self.oauthswift!)
            handler.presentCompletion = {
                print("Safari presented")
            }
            handler.dismissCompletion = {
                print("Safari dismissed")
            }
            return handler
        }
        return OAuthSwiftOpenURLExternally.sharedInstance
    }
    
    func showTokenAlert(name: String?, credential: OAuthSwiftCredential) {
        var message = "oauth_token:(credential.oauthToken)"
        if !credential.oauthTokenSecret.isEmpty {
            message += "\n\noauth_token_secret:(credential.oauthTokenSecret)"
        }
        self.showAlertView(title: name ?? "Service", message: message)
        
    }
    
    func showAlertView(title: String, message: String) {
        let alert = UIAlertController(title: title, message: message, preferredStyle: UIAlertController.Style.alert)
        alert.addAction(UIAlertAction(title: "Close", style: UIAlertAction.Style.default, handler: nil))
        self.present(alert, animated: true, completion: nil)
    }
   
}

// AppDelegate.swift
import UIKit
import OAuthSwift

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
    
    func application(_ application: UIApplication, open url: URL, sourceApplication: String?, annotation: Any) -> Bool {
        applicationHandle(url: url)
        return true
    }
}

extension AppDelegate {
    
    func applicationHandle(url: URL) {
        if (url.host == "oauth-callback") {
            OAuthSwift.handle(url: url)
        } else {
            // Google provider is the only one wuth your.bundle.id url schema.
            OAuthSwift.handle(url: url)
        }
    }
}

# platform :ios, '10.0'

target 'KoeDeZaim' do
  # Comment the next line if you're not using Swift and don't want to use dynamic frameworks
  use_frameworks!
  
  # Pods for KoeDeZaim
  pod 'OAuthSwift'

  target 'KoeDeZaimTests' do
    inherit! :search_paths
    # Pods for testing
  end

  target 'KoeDeZaimUITests' do
    inherit! :search_paths
    # Pods for testing
  end

end

試したこと

• デリゲートメソッドを以下に変えても呼ばれませんでした。

// AppDelegate.swift
 func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey  : Any] = [:]) -> Bool {
        if (url.host == "oauth-callback") {
            OAuthSwift.handle(url: url)
        }
        return true
    }

• 認証完了画面で左上の「完了」ボタンを押してアプリに戻っても特に変わりません。
• getURLHandler()内で必ずOAuthSwiftOpenURLExternally.sharedInstanceを返すようにし、Safariで認証を行ってもうまくいきませんでした。
• OAuthSwiftのDemoで以下すべてのパターンでうまくいきませんでした。

・external web browser
・internal web browser
・SFSafariViewController

補足情報（FW/ツールのバージョンなど）

• Xcode10.1
• Swift4.2
• Depleyment Target: iOS 12.1
• OAuthSwift: 1.2.2

完成イメージ
https://soh335.hatenablog.com/entry/2013/03/03/004306

Comments

[fuzzball]

Q1. 「AppDelegateのメソッドが呼ばれません」というの application(_:open:options:) のことですよね？呼ばれていないことをどうやって確認しましたか？

Q2. Safariで KoeDeZaim:// を開くとアプリが起動しますか？

[maztak]

ありがとうございます！
Q1. そうです。BreakPointを`func`, `if`の行に設定しましたが一度もそこで止まることはありませんでした。
Q2. 「このページをKoeDeZaimで開きますか？」のメッセージの後、「開く」を押すと起動してくれました！そしてQ1の`if`でBreakしますがその後、中には入ってきてくれず`return true`しちゃいます。

[fuzzball]

ということはURL Schemeは正しく設定されているということですね。
Zaim側が認識できていないか、認識できているのに呼び出されていないか。

参考記事の「アプリケーションの登録」で「サービスのURL」を登録していますが、ここは何を設定しましたか？

[maztak]

OAuth1Swift.swiftのauthorize(callbackURL: success: failure)の中で止めてみると、SafariでZaimの認証画面に行く前にsuccessでは止まらずfailure側にきました。

[fuzzball]

これは何の話ですか？

[maztak]

サービスのURLは私のドメインのhttps://right-apps.com/koedezaimとしています。参考記事だとcallbackURLと同じにしていましたが、ここは何でもいいという記述だったので上記に変えた次第です。

2番目はOAuthSwiftのライブラリの中でBreakpointを設定してみて、挙動から原因を探ってみたという話でした。OAuthSwiftの認証メソッドの結果が失敗しているようだ、という話でした。余計でしたでしょうか…。続けて記載したつもりが（ページリロードのタイミング差で）意味不明なお返事を返した形になってしまってました…。失礼いたしました…。

[fuzzball]

>>OAuth1Swift.swiftのauthorize(callbackURL: success: failure)の中で〜
って、ViewController.swiftのことですかね。ライブラリ内部の話をしているのかと思いましたが‥。
failureになっているならエラーが表示されているんですよね？
それを書いてもらえませんか。

[maztak]

すみません????‍♂️混乱して勘違いしてしまっておりました…。

ViewController.swiftのauthorize(callbackURL: success: failure)ではsuccessにもfailureにも降りてきてませんで、ライブラリ内部の話で合っております。

OAuth1Swift.swiftの中の以下3行でBreakPointを設定した際に①→③→①→②の順で止まりました。

①self.postOAuthRequestToken
②self.observeCallback
③return self（ここで止まったのをfailureに来たと勘違いしてしまった）

```
open func authorize(withCallbackURL callbackURL: URL, success: @escaping TokenSuccessHandler, failure: FailureHandler?) -> OAuthSwiftRequestHandle? {
self.postOAuthRequestToken(callbackURL: callbackURL, success: { [unowned self] credential, _, _ in
self.observeCallback { [weak self] url in
　　　　　// 省略
}
// 2. Authorize
// 省略
}, failure: failure)

return self
}
```

ViewController.swift側のprint(error.localizedDescription)は呼ばれないのですが、SafariでZaimの認証画面に遷移後、以下の内容がコンソールにでます。

```
2019-03-26 15:48:26.693416+0900 KoeDeZaim[20424:4021157] [BoringSSL] nw_protocol_boringssl_get_output_frames(1301) [C1.1:2][0x151b0ab70] get output frames failed, state 8196
2019-03-26 15:48:26.694251+0900 KoeDeZaim[20424:4021157] [BoringSSL] nw_protocol_boringssl_get_output_frames(1301) [C1.1:2][0x151b0ab70] get output frames failed, state 8196
2019-03-26 15:48:26.695169+0900 KoeDeZaim[20424:4021157] TIC Read Status [1:0x0]: 1:57
2019-03-26 15:48:26.695232+0900 KoeDeZaim[20424:4021157] TIC Read Status [1:0x0]: 1:57
2019-03-26 15:48:27.458230+0900 KoeDeZaim[20424:4021054] Could not load IOSurface for time string. Rendering locally instead.
```

stack overflowでは同じエラーで回答なしの人がいたり、Storyboardを使っていて「tableview.registerでなくreuseIdentifierを使え」とアドバイスされている方がいましたが今回とは無関係そうです…。ややこしくすみません????‍♂️

[fuzzball]

実際に試さないと私には分かりそうにないので、この辺で撤収します。

[maztak]

分かりました。お時間とご尽力ありがとうございました！

Answer 1

ブラウザアプリを選択後、Zaim側のドキュメントに以下の文言があったので、サービスURLとcallbackURLを同じにすると認証画面にいき、無事コールバックURLが呼ばれトークンが取得できました！

If you select "Browser App", Zaim give you a permission to access only form the domain which you input the "Service URL".

Answer 2

Zaimから回答いただき、クライアントアプリでなくブラウザアプリを選択しないとコールバックしないとのことでした。

しかしブラウザアプリに切り替えて試みると「お客様の端末の設定によりアクセスできません。端末の時間が 5 分以上ずれているとログインできないことがあります。」との画面が出て今度はログインができません。

callbackURLを変えてもこの画面にきたことがあったので、以下のようにいじってみましたがダメでした。
・/zaimを付与（OAuthSwiftがそうしてるので）→変わらず上記の画面
・コロン以下を無くしてみる→そもそもSafariが起動しなくなった

Comments

[maztak]

ブラウザアプリを選択後、Zaim側のドキュメントに以下の文言があったので、サービスURLとcallbackURLを同じにすると認証画面にいき、無事コールバックURLが呼ばれトークンが取得できました！
> If you select "Browser App", Zaim give you a permission to access only form the domain which you input the "Service URL".