Merge branch 'master' into add-integration-tests-for-edit-status-and-…

…edit-poll
andregasser · Apr 6, 2023 · efade7d · efade7d
2 parents 9c3e781 + 83a2548
commit efade7d
Show file tree

Hide file tree

Showing 21 changed files with 96 additions and 58 deletions.
diff --git a/bigbone-rx/src/main/kotlin/social/bigbone/rx/RxAppMethods.kt b/bigbone-rx/src/main/kotlin/social/bigbone/rx/RxAppMethods.kt
@@ -18,7 +18,7 @@ class RxAppMethods(client: MastodonClient) {
     @JvmOverloads
     fun createApp(
         clientName: String,
-        redirectUris: String = "urn:ietf:wg:oauth:2.0:oob",
+        redirectUris: String,
         scope: Scope = Scope(Scope.Name.ALL),
         website: String? = null
     ): Single<Application> {

diff --git a/bigbone-rx/src/main/kotlin/social/bigbone/rx/RxOAuthMethods.kt b/bigbone-rx/src/main/kotlin/social/bigbone/rx/RxOAuthMethods.kt
@@ -18,7 +18,7 @@ class RxOAuthMethods(client: MastodonClient) {
     fun getUserAccessTokenWithAuthorizationCodeGrant(
         clientId: String,
         clientSecret: String,
-        redirectUri: String = "urn:ietf:wg:oauth:2.0:oob",
+        redirectUri: String,
         code: String
     ): Single<Token> {
         return Single.create {
@@ -35,7 +35,7 @@ class RxOAuthMethods(client: MastodonClient) {
         clientId: String,
         clientSecret: String,
         scope: Scope = Scope(Scope.Name.READ),
-        redirectUri: String = "urn:ietf:wg:oauth:2.0:oob",
+        redirectUri: String,
         username: String,
         password: String
     ): Single<Token> {

diff --git a/bigbone/build.gradle b/bigbone/build.gradle
@@ -18,17 +18,13 @@ dependencies {
     api libs.okhttp
     api libs.gson
     implementation libs.kotlin.jdk8
-
     testImplementation libs.junit.jupiter.api
     testImplementation libs.kluent
     testImplementation libs.mockk
     testImplementation libs.mockk.dsl
     integrationTestImplementation libs.junit.jupiter.api
     integrationTestImplementation libs.junit.jupiter.engine
     integrationTestImplementation libs.junit.platform.suite.engine
-    integrationTestImplementation 'ch.qos.logback:logback-core:1.4.6'
-    integrationTestImplementation 'ch.qos.logback:logback-classic:1.4.6'
-    integrationTestImplementation 'org.slf4j:slf4j-api:2.0.7'
 }
 
 tasks.register('integrationTest', Test) {

diff --git a/bigbone/src/integrationTest/kotlin/social/bigbone/TestHelpers.kt b/bigbone/src/integrationTest/kotlin/social/bigbone/TestHelpers.kt
@@ -38,6 +38,7 @@ object TestHelpers {
         return client.oauth.getAccessTokenWithClientCredentialsGrant(
             clientId = application.clientId!!,
             clientSecret = application.clientSecret!!,
+            redirectUri = TestConstants.REDIRECT_URI,
             scope = Scope(Scope.Name.ALL)
         ).execute()
     }

diff --git a/bigbone/src/integrationTest/kotlin/social/bigbone/v300/V300StatusMethodsIntegrationTest.kt b/bigbone/src/integrationTest/kotlin/social/bigbone/v300/V300StatusMethodsIntegrationTest.kt
@@ -50,6 +50,7 @@ class V300StatusMethodsIntegrationTest {
         return client.oauth.getAccessTokenWithClientCredentialsGrant(
             clientId = application.clientId!!,
             clientSecret = application.clientSecret!!,
+            redirectUri = TestConstants.REDIRECT_URI,
             scope = Scope(Scope.Name.ALL)
         ).execute()
     }

diff --git a/bigbone/src/integrationTest/kotlin/social/bigbone/v402/V402StatusMethodsIntegrationTest.kt b/bigbone/src/integrationTest/kotlin/social/bigbone/v402/V402StatusMethodsIntegrationTest.kt
@@ -50,6 +50,7 @@ class V402StatusMethodsIntegrationTest {
         return client.oauth.getAccessTokenWithClientCredentialsGrant(
             clientId = application.clientId!!,
             clientSecret = application.clientSecret!!,
+            redirectUri = TestConstants.REDIRECT_URI,
             scope = Scope(Scope.Name.ALL)
         ).execute()
     }

diff --git a/bigbone/src/main/kotlin/social/bigbone/api/entity/Account.kt b/bigbone/src/main/kotlin/social/bigbone/api/entity/Account.kt
@@ -144,19 +144,19 @@ data class Account(
      * How many statuses are attached to this account.
      */
     @SerializedName("statuses_count")
-    val statusesCount: Int = 0,
+    val statusesCount: Long = 0,
 
     /**
      * The reported followers of this profile.
      */
     @SerializedName("followers_count")
-    val followersCount: Int = 0,
+    val followersCount: Long = 0,
 
     /**
      * The reported follows of this profile.
      */
     @SerializedName("following_count")
-    val followingCount: Int = 0
+    val followingCount: Long = 0
 ) {
     /**
      * Specifies a name-value pair as used in [fields] of the [Account] entity.

diff --git a/bigbone/src/main/kotlin/social/bigbone/api/entity/CustomEmoji.kt b/bigbone/src/main/kotlin/social/bigbone/api/entity/CustomEmoji.kt
@@ -26,5 +26,11 @@ data class CustomEmoji(
      * Whether this Emoji should be visible in the picker or unlisted.
      */
     @SerializedName("visible_in_picker")
-    val visibleInPicker: Boolean = true
+    val visibleInPicker: Boolean = true,
+
+    /**
+     * Used for sorting custom emoji in the picker.
+     */
+    @SerializedName("category")
+    val category: String = ""
 )
diff --git a/bigbone/src/main/kotlin/social/bigbone/api/entity/InstanceStats.kt b/bigbone/src/main/kotlin/social/bigbone/api/entity/InstanceStats.kt
@@ -11,17 +11,17 @@ data class InstanceStats(
      * Total users on this instance.
      */
     @SerializedName("user_count")
-    val userCount: Int = 0,
+    val userCount: Long = 0,
 
     /**
      * Total statuses on this instance.
      */
     @SerializedName("status_count")
-    val statusCount: Int = 0,
+    val statusCount: Long = 0,
 
     /**
      * Total domains discovered by this instance.
      */
     @SerializedName("domain_count")
-    val domainCount: Int = 0
+    val domainCount: Long = 0
 )
diff --git a/bigbone/src/main/kotlin/social/bigbone/api/entity/Poll.kt b/bigbone/src/main/kotlin/social/bigbone/api/entity/Poll.kt
@@ -35,13 +35,13 @@ data class Poll(
      * How many votes have been received.
      */
     @SerializedName("votes_count")
-    val votesCount: Int = 0,
+    val votesCount: Long = 0,
 
     /**
      * How many unique accounts have voted on a multiple-choice poll; integer, or null if [multiple] is false.
      */
     @SerializedName("voters_count")
-    val votersCount: Int? = null,
+    val votersCount: Long? = null,
 
     /**
      * Possible answers for the poll.
@@ -83,6 +83,6 @@ data class Poll(
          * The total number of received votes for this option; integer, or null if results are not published yet.
          */
         @SerializedName("votes_count")
-        val votesCount: Int? = null
+        val votesCount: Long? = null
     )
 }
diff --git a/bigbone/src/main/kotlin/social/bigbone/api/entity/Status.kt b/bigbone/src/main/kotlin/social/bigbone/api/entity/Status.kt
@@ -90,19 +90,19 @@ data class Status(
      * How many boosts this status has received.
      */
     @SerializedName("reblogs_count")
-    val reblogsCount: Int = 0,
+    val reblogsCount: Long = 0,
 
     /**
      * How many favourites this status has received.
      */
     @SerializedName("favourites_count")
-    val favouritesCount: Int = 0,
+    val favouritesCount: Long = 0,
 
     /**
      * How many replies this status has received.
      */
     @SerializedName("replies_count")
-    val repliesCount: Int = 0,
+    val repliesCount: Long = 0,
 
     /**
      * A link to the status’s HTML representation.

diff --git a/bigbone/src/main/kotlin/social/bigbone/api/method/AppMethods.kt b/bigbone/src/main/kotlin/social/bigbone/api/method/AppMethods.kt
@@ -15,16 +15,15 @@ class AppMethods(private val client: MastodonClient) {
     /**
      * Create a new application to obtain OAuth2 credentials.
      * @param clientName A name for your application
-     * @param redirectUris Where the user should be redirected after authorization. Defaults to "urn:ietf:wg:oauth:2.0:oob",
-     *  which will display the authorization code to the user instead of redirecting to a web page.
+     * @param redirectUris Where the user should be redirected after authorization.
      * @param scope Space separated list of scopes. Defaults to all scopes.
      * @param website A URL to the homepage of your app, defaults to null.
      * @see <a href="https://docs.joinmastodon.org/methods/apps/#create">Mastodon apps API methods #create</a>
      */
     @JvmOverloads
     fun createApp(
         clientName: String,
-        redirectUris: String = "urn:ietf:wg:oauth:2.0:oob",
+        redirectUris: String,
         scope: Scope = Scope(Scope.Name.ALL),
         website: String? = null
     ): MastodonRequest<Application> {

diff --git a/bigbone/src/main/kotlin/social/bigbone/api/method/OAuthMethods.kt b/bigbone/src/main/kotlin/social/bigbone/api/method/OAuthMethods.kt
@@ -15,17 +15,14 @@ class OAuthMethods(private val client: MastodonClient) {
     /**
      * Returns a URL that can be used to display an authorization form to the user. If approved,
      * it will create and return an authorization code, then redirect to the desired redirectUri,
-     * or show the authorization code if urn:ietf:wg:oauth:2.0:oob was requested.
+     * or show the authorization code if redirectUri is "urn:ietf:wg:oauth:2.0:oob".
      * The authorization code can be used while requesting a token to obtain access to user-level methods.
      * @param clientId The client ID, obtained during app registration.
      * @param scope List of requested OAuth scopes, separated by spaces. Must be a subset of scopes declared during app registration.
-     * @param redirectUri Set a URI to redirect the user to. Defaults to "urn:ietf:wg:oauth:2.0:oob",
-     *  which will display the authorization code to the user instead of redirecting to a web page.
-     *  Must match one of the redirect_uris declared during app registration.
+     * @param redirectUri Set a URI to redirect the user to. Must match one of the redirect_uris declared during app registration.
      * @see <a href="https://docs.joinmastodon.org/methods/oauth/#authorize">Mastodon oauth API methods #authorize</a>
      */
-    @JvmOverloads
-    fun getOAuthUrl(clientId: String, scope: Scope, redirectUri: String = "urn:ietf:wg:oauth:2.0:oob"): String {
+    fun getOAuthUrl(clientId: String, scope: Scope, redirectUri: String): String {
         val endpoint = "oauth/authorize"
         val params = Parameters()
             .append("client_id", clientId)
@@ -39,17 +36,14 @@ class OAuthMethods(private val client: MastodonClient) {
      * Obtain a user access token using OAuth 2 authorization code grant type. To be used during API calls that are not public.
      * @param clientId The client ID, obtained during app registration.
      * @param clientSecret The client secret, obtained during app registration.
-     * @param redirectUri Set a URI to redirect the user to. Defaults to "urn:ietf:wg:oauth:2.0:oob",
-     *  which will display the authorization code to the user instead of redirecting to a web page.
-     *  Must match one of the redirect_uris declared during app registration.
+     * @param redirectUri Set a URI to redirect the user to. Must match one of the redirect_uris declared during app registration.
      * @param code A user authorization code, obtained via the URL received from getOAuthUrl()
      * @see <a href="https://docs.joinmastodon.org/methods/oauth/#token">Mastodon oauth API methods #token</a>
      */
-    @JvmOverloads
     fun getUserAccessTokenWithAuthorizationCodeGrant(
         clientId: String,
         clientSecret: String,
-        redirectUri: String = "urn:ietf:wg:oauth:2.0:oob",
+        redirectUri: String,
         code: String
     ): MastodonRequest<Token> {
         return client.getMastodonRequest(
@@ -69,9 +63,7 @@ class OAuthMethods(private val client: MastodonClient) {
      * Obtain an access token using OAuth 2 client credentials grant type. To be used during API calls that are not public.
      * @param clientId The client ID, obtained during app registration.
      * @param clientSecret The client secret, obtained during app registration.
-     * @param redirectUri Set a URI to redirect the user to. Defaults to "urn:ietf:wg:oauth:2.0:oob",
-     *  which will display the authorization code to the user instead of redirecting to a web page.
-     *  Must match one of the redirect_uris declared during app registration.
+     * @param redirectUri Set a URI to redirect the user to. Must match one of the redirect_uris declared during app registration.
      * @param scope Requested OAuth scopes. Must be a subset of scopes declared during app registration.
      *  If not provided, defaults to read.
      * @see <a href="https://docs.joinmastodon.org/methods/oauth/#token">Mastodon oauth API methods #token</a>
@@ -81,7 +73,7 @@ class OAuthMethods(private val client: MastodonClient) {
     fun getAccessTokenWithClientCredentialsGrant(
         clientId: String,
         clientSecret: String,
-        redirectUri: String = "urn:ietf:wg:oauth:2.0:oob",
+        redirectUri: String,
         scope: Scope? = null
     ): MastodonRequest<Token> {
         return client.getMastodonRequest(
@@ -105,8 +97,7 @@ class OAuthMethods(private val client: MastodonClient) {
      * @param clientId The client ID, obtained during app registration.
      * @param clientSecret The client secret, obtained during app registration.
      * @param scope Requested OAuth scopes
-     * @param redirectUri Set a URI to redirect the user to. Defaults to "urn:ietf:wg:oauth:2.0:oob",
-     *  which will display the authorization code to the user instead of redirecting to a web page.
+     * @param redirectUri Set a URI to redirect the user to.
      * @param username The Mastodon account username.
      * @param password The Mastodon account password.
      * @see <a href="https://docs.joinmastodon.org/methods/oauth/#token">Mastodon oauth API methods #token</a>
@@ -116,7 +107,7 @@ class OAuthMethods(private val client: MastodonClient) {
         clientId: String,
         clientSecret: String,
         scope: Scope = Scope(Scope.Name.READ),
-        redirectUri: String = "urn:ietf:wg:oauth:2.0:oob",
+        redirectUri: String,
         username: String,
         password: String
     ): MastodonRequest<Token> {

diff --git a/bigbone/src/test/kotlin/social/bigbone/TestConstants.kt b/bigbone/src/test/kotlin/social/bigbone/TestConstants.kt
@@ -0,0 +1,5 @@
+package social.bigbone
+
+object TestConstants {
+    const val REDIRECT_URI = "urn:ietf:wg:oauth:2.0:oob"
+}
diff --git a/bigbone/src/test/kotlin/social/bigbone/api/method/AppMethodsTest.kt b/bigbone/src/test/kotlin/social/bigbone/api/method/AppMethodsTest.kt
@@ -5,6 +5,7 @@ import org.amshove.kluent.shouldBeEqualTo
 import org.junit.jupiter.api.Assertions
 import org.junit.jupiter.api.Test
 import social.bigbone.MastodonClient
+import social.bigbone.TestConstants
 import social.bigbone.api.Scope
 import social.bigbone.api.exception.BigBoneRequestException
 import social.bigbone.testtool.MockClient
@@ -17,7 +18,9 @@ class AppMethodsTest {
 
         val appMethods = AppMethods(client)
         val application = appMethods.createApp(
-            clientName = "bigbone-sample-app", scope = Scope(Scope.Name.ALL)
+            clientName = "bigbone-sample-app",
+            redirectUris = TestConstants.REDIRECT_URI,
+            scope = Scope(Scope.Name.ALL)
         ).execute()
 
         application.clientId shouldBeEqualTo "client id"
@@ -30,7 +33,9 @@ class AppMethodsTest {
             val client = MockClient.ioException()
             val appMethods = AppMethods(client)
             appMethods.createApp(
-                clientName = "bigbone-sample-app", scope = Scope(Scope.Name.ALL)
+                clientName = "bigbone-sample-app",
+                redirectUris = TestConstants.REDIRECT_URI,
+                scope = Scope(Scope.Name.ALL)
             ).execute()
         }
     }