Merge pull request #264 from adamint/dev

add more builder methods

Author: adamint

README.md

@@ -193,18 +193,18 @@ the code challenge used to authorize the user.
 
 This library contains helpful methods that can be used to simplify the PKCE authorization process.
 This includes `getSpotifyPkceCodeChallenge`, which SHA256 hashes and base64url encodes the code 
-challenge, and `getPkceAuthorizationUrl`, which allows you to generate an easy authorization url for PKCE flow.
+challenge, and `getSpotifyPkceAuthorizationUrl`, which allows you to generate an easy authorization url for PKCE flow.
 
 Please see the [spotifyClientPkceApi builder docs](https://adamint.github.io/spotify-web-api-kotlin-docs/spotify-web-api-kotlin/com.adamratzman.spotify/spotify-client-pkce-api.html) for a full list of available builders.
 
 **Takeaway**: Use PKCE authorization flow in applications where you cannot secure the client secret.
 
-To get a PKCE authorization url, to which you can redirect a user, you can use the `getPkceAuthorizationUrl`
+To get a PKCE authorization url, to which you can redirect a user, you can use the `getSpotifyPkceAuthorizationUrl`
 top-level method. An example is shown below, requesting 4 different scopes.
 ```kotlin
 val codeVerifier = "thisisaveryrandomalphanumericcodeverifierandisgreaterthan43characters"
 val codeChallenge = getSpotifyPkceCodeChallenge(codeVerifier) // helper method
-val url: String = getPkceAuthorizationUrl(
+val url: String = getSpotifyPkceAuthorizationUrl(
     SpotifyScope.PLAYLIST_READ_PRIVATE,
     SpotifyScope.PLAYLIST_MODIFY_PRIVATE,
     SpotifyScope.USER_FOLLOW_READ,

src/androidMain/kotlin/com/adamratzman/spotify/auth/SpotifyDefaultCredentialStore.kt

@@ -1,3 +1,4 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.auth
 
 import android.annotation.SuppressLint
@@ -20,7 +21,6 @@ import com.adamratzman.spotify.spotifyClientPkceApi
 import com.adamratzman.spotify.spotifyImplicitGrantApi
 import com.adamratzman.spotify.utils.logToConsole
 
-
 /**
  * Provided credential store for holding current Spotify token credentials, allowing you to easily store and retrieve
  * Spotify tokens. Recommended in most use-cases.
@@ -57,7 +57,6 @@ public class SpotifyDefaultCredentialStore(
         public var activityBackOnImplicitAuth: Class<out Activity>? = null
     }
 
-
     public var credentialTypeStored: CredentialType? = null
 
     /**
@@ -100,7 +99,6 @@ public class SpotifyDefaultCredentialStore(
         get() = encryptedPreferences.getString(SpotifyRefreshTokenKey, null)
         set(value) = encryptedPreferences.edit().putString(SpotifyRefreshTokenKey, value).apply()
 
-
     /**
      * Get/set the Spotify [Token] obtained from [spotifyToken].
      * If the token has expired according to [spotifyTokenExpiresAt], this will return null.
@@ -197,4 +195,4 @@ public enum class CredentialType {
 @RequiresApi(Build.VERSION_CODES.M)
 public fun Application.getDefaultCredentialStore(clientId: String, redirectUri: String): SpotifyDefaultCredentialStore {
     return SpotifyDefaultCredentialStore(clientId, redirectUri, applicationContext)
-}
+}

src/androidMain/kotlin/com/adamratzman/spotify/auth/implicit/AbstractSpotifyAppCompatImplicitLoginActivity.kt

@@ -1,3 +1,4 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.auth.implicit
 
 import android.app.Activity
@@ -17,16 +18,14 @@ public abstract class AbstractSpotifyAppCompatImplicitLoginActivity : SpotifyImp
     public override val activity: Activity = this
     public override val useDefaultRedirectHandler: Boolean = true
 
-
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
 
         triggerLoginActivity()
     }
 
-
     override fun onActivityResult(requestCode: Int, resultCode: Int, intent: Intent?) {
         super.onActivityResult(requestCode, resultCode, intent)
         processActivityResult(requestCode, resultCode, intent)
     }
-}
+}

src/androidMain/kotlin/com/adamratzman/spotify/auth/implicit/AbstractSpotifyAppImplicitLoginActivity.kt

@@ -1,3 +1,4 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.auth.implicit
 
 import android.app.Activity
@@ -17,16 +18,14 @@ public abstract class AbstractSpotifyAppImplicitLoginActivity : SpotifyImplicitL
     public override val activity: Activity = this
     public override val useDefaultRedirectHandler: Boolean = true
 
-
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
 
         triggerLoginActivity()
     }
 
-
     override fun onActivityResult(requestCode: Int, resultCode: Int, intent: Intent?) {
         super.onActivityResult(requestCode, resultCode, intent)
         processActivityResult(requestCode, resultCode, intent)
     }
-}
+}

src/androidMain/kotlin/com/adamratzman/spotify/auth/implicit/ImplicitAuthUtils.kt

@@ -1,3 +1,4 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.auth.implicit
 
 import android.app.Activity
@@ -46,4 +47,3 @@ public fun <T> Activity.guardValidImplicitSpotifyApi(
         null
     }
 }
-

src/androidMain/kotlin/com/adamratzman/spotify/auth/implicit/SpotifyImplicitLoginActivity.kt

@@ -1,3 +1,4 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.auth.implicit
 
 import android.app.Activity
@@ -52,7 +53,6 @@ public interface SpotifyImplicitLoginActivity {
      */
     public fun onFailure(errorMessage: String)
 
-
     /**
      * Override this to define what to do after [onSuccess] has run.
      * The default behavior is to finish the activity, and redirect the user back to the activity set on [SpotifyDefaultCredentialStore.activityBackOnImplicitAuth]
@@ -90,7 +90,7 @@ public interface SpotifyImplicitLoginActivity {
                     val token = Token(
                         response.accessToken,
                         response.type.name,
-                        response.expiresIn,
+                        response.expiresIn
                     )
                     val api = spotifyImplicitGrantApi(
                         clientId = clientId,
@@ -101,7 +101,7 @@ public interface SpotifyImplicitLoginActivity {
                     redirectAfterOnSuccessAuthentication()
                 }
                 // AuthorizationResponse.Type.CODE -> TODO()
-                //AuthorizationResponse.Type.UNKNOWN -> TODO()
+                // AuthorizationResponse.Type.UNKNOWN -> TODO()
                 AuthorizationResponse.Type.ERROR -> {
                     logToConsole("Got error in authorization... executing error handler")
                     onFailure(response.error ?: "Generic authentication error")
@@ -113,7 +113,5 @@ public interface SpotifyImplicitLoginActivity {
             }
             activity.finish()
         }
-
     }
-
-}
+}

src/androidMain/kotlin/com/adamratzman/spotify/auth/pkce/AbstractSpotifyPkceLoginActivity.kt

@@ -1,3 +1,4 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.auth.pkce
 
 import android.content.Intent
@@ -15,13 +16,13 @@ import com.adamratzman.spotify.SpotifyScope
 import com.adamratzman.spotify.SpotifyUserAuthorization
 import com.adamratzman.spotify.auth.SpotifyDefaultCredentialStore
 import com.adamratzman.spotify.auth.getDefaultCredentialStore
-import com.adamratzman.spotify.getPkceAuthorizationUrl
+import com.adamratzman.spotify.getSpotifyPkceAuthorizationUrl
 import com.adamratzman.spotify.getSpotifyPkceCodeChallenge
 import com.adamratzman.spotify.spotifyClientPkceApi
 import com.adamratzman.spotify.utils.logToConsole
 import com.spotify.sdk.android.auth.AuthorizationResponse
-import kotlinx.coroutines.runBlocking
 import kotlin.random.Random
+import kotlinx.coroutines.runBlocking
 
 /**
  * This class hooks into spotify-web-api-kotlin to provide PKCE authorization for Android application. Paired with [SpotifyDefaultCredentialStore] to easily store credentials.
@@ -59,7 +60,7 @@ public abstract class AbstractSpotifyPkceLoginActivity : AppCompatActivity() {
     /**
      * Get the authorization url that the client will be redirected to during PKCE authorization.
      */
-    public fun getAuthorizationUrl(): Uri = getPkceAuthorizationUrl(
+    public fun getAuthorizationUrl(): Uri = getSpotifyPkceAuthorizationUrl(
         *scopes.toTypedArray(),
         clientId = clientId,
         redirectUri = redirectUri,
@@ -162,7 +163,6 @@ public abstract class AbstractSpotifyPkceLoginActivity : AppCompatActivity() {
                             IllegalArgumentException("API token was blank")
                         )
                     }
-
                 } catch (exception: Exception) {
                     setProgressBarInvisible()
                     logToConsole("Got error in authorization... executing error handler")
@@ -182,5 +182,4 @@ public abstract class AbstractSpotifyPkceLoginActivity : AppCompatActivity() {
     private fun setProgressBarVisible() {
         findViewById<FrameLayout>(R.id.progress_overlay).visibility = View.VISIBLE
     }
-
-}
+}

src/androidMain/kotlin/com/adamratzman/spotify/auth/pkce/PkceAuthUtils.kt

@@ -1,3 +1,4 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.auth.pkce
 
 import android.app.Activity
@@ -6,8 +7,8 @@ import android.os.Build
 import androidx.annotation.RequiresApi
 
 public fun Intent?.isSpotifyPkceAuthIntent(redirectUri: String): Boolean {
-    return this != null
-            && (dataString?.startsWith("$redirectUri/?code=") == true || dataString?.startsWith("$redirectUri/?error=") == true)
+    return this != null &&
+            (dataString?.startsWith("$redirectUri/?code=") == true || dataString?.startsWith("$redirectUri/?error=") == true)
 }
 
 /**
@@ -19,4 +20,4 @@ public fun Intent?.isSpotifyPkceAuthIntent(redirectUri: String): Boolean {
 public fun Activity.startSpotifyClientPkceLoginActivity(spotifyLoginImplementationClass: Class<out AbstractSpotifyPkceLoginActivity>) {
     val intent = Intent(this, spotifyLoginImplementationClass)
     startActivity(intent)
-}
+}

src/androidMain/kotlin/com/adamratzman/spotify/notifications/AbstractSpotifyBroadcastReceiver.kt

@@ -1,3 +1,4 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.notifications
 
 import android.content.BroadcastReceiver
@@ -43,7 +44,6 @@ public abstract class AbstractSpotifyBroadcastReceiver : BroadcastReceiver() {
                 )
             )
         }
-
     }
 
     /**
@@ -80,7 +80,6 @@ public abstract class AbstractSpotifyBroadcastReceiver : BroadcastReceiver() {
     public companion object {
         public const val BaseSpotifyNotificationId: String = "com.spotify.music"
     }
-
 }
 
 /**
@@ -122,7 +121,7 @@ public data class SpotifyMetadataChangedData(
  * A playback state change is sent whenever the user presses play/pause, or when seeking the track position. It uses the intent action com.spotify.music.playbackstatechanged.
  *
  * @param playing True if playing, false if paused.
- * @param positionInMs    The current playback position in milliseconds.
+ * @param positionInMs The current playback position in milliseconds.
  * @param timeSentInMs When the notification was sent.
  */
 public data class SpotifyPlaybackStateChangedData(

src/androidMain/kotlin/com/adamratzman/spotify/notifications/SpotifyBroadcastReceiverUtils.kt

@@ -1,3 +1,4 @@
+/* Spotify Web API, Kotlin Wrapper; MIT License, 2017-2021; Original author: Adam Ratzman */
 package com.adamratzman.spotify.notifications
 
 import android.app.Activity
@@ -24,4 +25,4 @@ public fun Context.registerSpotifyBroadcastReceiver(
     notificationTypes.forEach { filter.addAction(it.id) }
 
     registerReceiver(receiver, filter)
-}
+}

src/androidMain/kotlin/com/adamratzman/spotify/utils/PlatformUtils.kt

@@ -26,7 +26,6 @@ public actual typealias ConcurrentHashMap<K, V> = java.util.concurrent.Concurren
 
 public actual fun <K, V> ConcurrentHashMap<K, V>.asList(): List<Pair<K, V>> = toList()
 
-
 // safeLet retrieved from: https://stackoverflow.com/a/35522422/6422820
 private fun <T1 : Any, T2 : Any, T3 : Any, R : Any> safeLet(p1: T1?, p2: T2?, p3: T3?, block: (T1, T2, T3) -> R?): R? =
     if (p1 != null && p2 != null && p3 != null) block(p1, p2, p3) else null
@@ -41,4 +40,4 @@ internal fun toast(context: Context?, message: String?, duration: Int = Toast.LE
 
 internal fun logToConsole(message: String) {
     Log.i("spotify-web-api-kotlin", message)
-}
+}