Studyplusクラスの改善, ドキュメント追加

Author: koji-1009

studyplus-android-sdk2/src/main/java/jp/studyplus/android/sdk/Studyplus.kt

@@ -3,66 +3,90 @@ package jp.studyplus.android.sdk
 import android.app.Activity
 import android.content.Context
 import android.content.Intent
+import android.util.Log
 import io.reactivex.android.schedulers.AndroidSchedulers
-import jp.studyplus.android.sdk.internal.auth.AuthTransit
-import jp.studyplus.android.sdk.internal.api.ApiClient
-import jp.studyplus.android.sdk.internal.api.notNull
-import jp.studyplus.android.sdk.record.StudyRecord
 import io.reactivex.schedulers.Schedulers
+import jp.studyplus.android.sdk.internal.api.ApiClient
 import jp.studyplus.android.sdk.internal.api.CertificationStore
+import jp.studyplus.android.sdk.internal.auth.AuthTransit
+import jp.studyplus.android.sdk.record.StudyRecord
 
-class Studyplus
-private constructor() {
-    companion object {
-        interface OnPostRecordListener {
-            fun onResult(success: Boolean, recordId: Long?, throwable: Throwable?)
-        }
-
-        @JvmStatic
-        val instance by lazy { Studyplus() }
-    }
+class Studyplus private constructor() {
 
     private var consumerKey: String? = null
     private var consumerSecret: String? = null
 
+    /**
+     * ConsumerKey, ConsumerSecretKeyをStudyplus SDKに設定
+     *
+     * @since 2.0.0
+     */
     fun setup(consumerKey: String, consumerSecret: String) {
         this.consumerKey = consumerKey
         this.consumerSecret = consumerSecret
     }
 
-    fun isAuthenticated(context: Context): Boolean {
-        return CertificationStore.create(context).isAuthenticated()
-    }
+    /**
+     * [setup]で設定されたConsumerKeyがすでに認証済みかどうかを判定
+     *
+     * @return true: 認証済み、 false: 未認証
+     * @since 2.0.0
+     */
+    fun isAuthenticated(context: Context): Boolean =
+            CertificationStore.create(context.applicationContext).isAuthenticated()
 
+    /**
+     * [setup]で設定されたConsumerKey, ConsumerSecretKeyによるStudyplus連携認証
+     *
+     * @since 2.0.0
+     */
     fun startAuth(activity: Activity, requestCode: Int) {
-        notNull(consumerKey, consumerSecret) { consumerKey, consumerSecret ->
-            AuthTransit(consumerKey, consumerSecret).apply {
-                start(activity, requestCode)
-            }
+        if (consumerKey == null || consumerSecret == null) {
+            throw IllegalStateException("Please call setup method before this method call.")
         }
+
+        AuthTransit(consumerKey!!, consumerSecret!!).start(activity, requestCode)
     }
 
+    /**
+     * [startAuth]の結果をStudyplusSDKに保存
+     *
+     * @since 2.0.0
+     */
     fun setAuthResult(context: Context, data: Intent?) {
-        data?.also {
-            CertificationStore.create(context).update(it)
+        if (data == null) {
+            Log.e("StudyplusSDK", "The data is null. Please check your code. If the received data is already null, please contact Studyplus Dev team.")
+            return
         }
+
+        CertificationStore.create(context.applicationContext).update(data)
     }
 
+    /**
+     * Studyplusとの認証情報を利用して学習記録をStudyplusへ投稿
+     *
+     * @since 2.0.0
+     */
     fun postRecord(context: Context, studyRecord: StudyRecord, listener: OnPostRecordListener?) {
+        if (!isAuthenticated(context)) {
+            throw IllegalStateException("Please check your application's authentication before this method call.")
+        }
+
         ApiClient.apiClient.postStudyRecords(context, studyRecord)
                 .subscribeOn(Schedulers.newThread())
                 .observeOn(AndroidSchedulers.mainThread())
                 .subscribe(
-                        { response ->
-                            listener?.apply {
-                                onResult(true, response.recordId, null)
-                            }
-                        },
-                        { throwable ->
-                            listener?.apply {
-                                onResult(false, null, throwable)
-                            }
-                        }
+                        { listener?.onResult(success = true, recordId = it.recordId) },
+                        { listener?.onResult(success = false, throwable = it) }
                 )
     }
+
+    companion object {
+        interface OnPostRecordListener {
+            fun onResult(success: Boolean, recordId: Long? = null, throwable: Throwable? = null)
+        }
+
+        @JvmStatic
+        val instance by lazy { Studyplus() }
+    }
 }