SDK-1560 Revoke Token (#9)

Add revoke token feature

Also contract tests runs are splitter into two: required and optional. 
Only required can fail the build

Co-authored-by: Serhii Mamontov <[email protected]>
Co-authored-by: Lukasz Klich <[email protected]>

Author: 3 people

.github/workflows/run_acceptance_tests.yml

@@ -20,21 +20,31 @@ jobs:
         uses: ./client-engineering-deployment-tools/actions/mock-server
         with:
           token: ${{ secrets.GH_TOKEN }}
-      - name: Run acceptance tests
+      - name: Run acceptance tests (optional)
         run: |
           export pubKey=somePubKey
           export subKey=someSubKey
           export pamPubKey=somePamPubKey
           export pamSubKey=somePamSubKey
           export pamSecKey=someSecKey
-          export featuresDir=sdk-specifications/features/access
-          export cucumberTags=@feature=access
           export serverHostPort=localhost:8090
           export serverMock=true
-          ./gradlew cucumber
+          ./gradlew cucumber --tests RunBetaCucumberTest  -Dcucumber.features="sdk-specifications/features/" -i
+        continue-on-error: true
+      - name: Run acceptance tests (required)
+        run: |
+          export pubKey=somePubKey
+          export subKey=someSubKey
+          export pamPubKey=somePamPubKey
+          export pamSubKey=somePamSubKey
+          export pamSecKey=someSecKey
+          export serverHostPort=localhost:8090
+          export serverMock=true
+          ./gradlew cucumber --tests RunMainCucumberTest  -Dcucumber.features="sdk-specifications/features/" -i
       - name: Expose acceptance tests reports
         uses: actions/upload-artifact@v2
+        if: always()
         with:
           name: acceptance-test-reports
           path: ./build/reports/cucumber-reports
-
+          retention-days: 7

.pubnub.yml

@@ -1,9 +1,9 @@
 name: kotlin
-version: 6.2.0
+version: v6.3.0
 schema: 1
 scm: github.com/pubnub/kotlin
 files:
-  - build/libs/pubnub-kotlin-6.2.0-all.jar
+  - build/libs/pubnub-kotlin-6.3.0-all.jar
 sdks:
   - 
       type: library
@@ -23,8 +23,8 @@ sdks:
             -
               distribution-type: library
               distribution-repository: git release
-              package-name: pubnub-kotlin-5.1.1-all
-              location: https://github.com/pubnub/kotlin/releases/download/v5.1.1/pubnub-kotlin-5.1.1-all.jar
+              package-name: pubnub-kotlin-6.3.0
+              location: https://github.com/pubnub/kotlin/releases/download/v6.3.0/pubnub-kotlin-6.3.0-all.jar
               supported-platforms:
                 supported-operating-systems:
                   Android:
@@ -135,8 +135,8 @@ sdks:
             -
               distribution-type: library
               distribution-repository: maven
-              package-name: pubnub-kotlin-5.1.2
-              location: https://repo.maven.apache.org/maven2/com/pubnub/pubnub-kotlin/5.1.2/pubnub-kotlin-5.1.2.jar
+              package-name: pubnub-kotlin-6.3.0
+              location: https://repo.maven.apache.org/maven2/com/pubnub/pubnub-kotlin/6.3.0/pubnub-kotlin-6.3.0.jar
               supported-platforms:
                 supported-operating-systems:
                   Android:
@@ -233,6 +233,11 @@ sdks:
                   license-url: https://github.com/stleary/JSON-java/blob/20210307/LICENSE
                   is-required: Required
 changelog:
+  - date: 2021-12-16
+    version: v6.3.0
+    changes:
+      - type: feature
+        text: "Add revoke token feature."
   -
     version: v6.2.0
     date: 2021-10-06
@@ -382,6 +387,7 @@ features:
     - ACCESS-GRANT-TOKEN
     - ACCESS-PARSE-TOKEN
     - ACCESS-SET-TOKEN
+    - ACCESS-REVOKE-TOKEN
   channel-groups:
     - CHANNEL-GROUPS-ADD-CHANNELS
     - CHANNEL-GROUPS-REMOVE-CHANNELS

CHANGELOG.md

@@ -1,3 +1,9 @@
+## v6.3.0
+December 16 2021
+
+#### Added
+- Add revoke token feature.
+
 ## [v6.2.0](https://github.com/pubnub/kotlin/releases/tag/v6.2.0)
 October 6 2021
 

README.md

@@ -23,13 +23,13 @@ You will need the publish and subscribe keys to authenticate your app. Get your
      <dependency>
         <groupId>com.pubnub</groupId>
         <artifactId>pubnub-gson</artifactId>
-        <version>6.2.0</version>
+        <version>6.3.0</version>
      </dependency>
      ```
 
    * for Gradle, add the following dependency in your `gradle.build`:
      ```groovy
-     implementation 'com.pubnub:pubnub-kotlin:5.0.2'
+     implementation 'com.pubnub:pubnub-kotlin:6.3.0'
      ```
 
 2. Configure your keys:

build.gradle

@@ -13,7 +13,7 @@ plugins {
 }
 
 group = 'com.pubnub'
-version = '6.2.0'
+version = '6.3.0'
 
 repositories {
     mavenCentral()
@@ -42,46 +42,8 @@ configurations {
     testFixturesImplementation { extendsFrom allTest }
     integrationTestImplementation { extendsFrom allTest }
     testImplementation { extendsFrom allTest }
-    cucumberRuntime { extendsFrom testImplementation }
 }
 
-task cucumber() {
-    dependsOn assemble, testClasses
-    group = "verification"
-    doLast {
-        javaexec {
-            Properties localProperties = new Properties()
-            try {
-                localProperties.load(new FileInputStream(rootProject.file("src/test/resources/config.properties")))
-            }
-            catch (Exception e) {
-                localProperties.putAll(System.getenv())
-            }
-
-            main = "io.cucumber.core.cli.Main"
-            classpath = configurations.cucumberRuntime + sourceSets.main.output + sourceSets.test.output
-
-            if (localProperties['cucumber.tags'] != null) {
-                args = ['--tags', localProperties['cucumberTags'],
-                        '--plugin', 'pretty',
-                        '--plugin', 'json:build/reports/cucumber-reports/Cucumber.json',
-                        '--plugin', 'junit:build/reports/cucumber-reports/Cucumber.xml',
-                        '--plugin', 'html:build/reports/cucumber-reports/Cucumber.html',
-                        '--glue', 'com.pubnub.contract',
-                        localProperties['featuresDir']]
-            } else {
-                args = ['--plugin', 'pretty',
-                        '--plugin', 'json:build/reports/cucumber-reports/Cucumber.json',
-                        '--plugin', 'junit:build/reports/cucumber-reports/Cucumber.xml',
-                        '--plugin', 'html:build/reports/cucumber-reports/Cucumber.html',
-                        '--glue', 'com.pubnub.contract',
-                        localProperties['featuresDir']]
-            }
-        }
-    }
-}
-
-
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
 
@@ -123,8 +85,15 @@ shadowJar {
     }
 }
 
+task cucumber(type: Test) {
+    systemProperty "cucumber.filter.tags", System.getProperty("cucumber.filter.tags")
+    systemProperty "cucumber.features", System.getProperty("cucumber.features")
+    systemProperty "cucumber.plugins", System.getProperty("cucumber.plugins")
+}
+
 test {
     failFast = true
+    exclude '**/contract/*.class'
 }
 
 dokka {

src/main/kotlin/com/pubnub/api/PubNub.kt

@@ -9,6 +9,7 @@ import com.pubnub.api.endpoints.MessageCounts
 import com.pubnub.api.endpoints.Time
 import com.pubnub.api.endpoints.access.Grant
 import com.pubnub.api.endpoints.access.GrantToken
+import com.pubnub.api.endpoints.access.RevokeToken
 import com.pubnub.api.endpoints.channel_groups.AddChannelChannelGroup
 import com.pubnub.api.endpoints.channel_groups.AllChannelsChannelGroup
 import com.pubnub.api.endpoints.channel_groups.DeleteChannelGroup
@@ -86,7 +87,7 @@ class PubNub(val configuration: PNConfiguration) {
 
     private companion object Constants {
         private const val TIMESTAMP_DIVIDER = 1000
-        private const val SDK_VERSION = "6.2.0"
+        private const val SDK_VERSION = "6.3.0"
         private const val MAX_SEQUENCE = 65535
     }
 
@@ -876,6 +877,24 @@ class PubNub(val configuration: PNConfiguration) {
         channelGroups = channelGroups
     )
 
+    /**
+     * This function generates a grant token for PubNub Access Manager (PAM).
+     *
+     * Permissions can be applied to any of the three type of resources:
+     * - channels
+     * - channel groups
+     * - uuid - metadata associated with particular UUID
+     *
+     * Each type of resource have different set of permissions. To know what's possible for each of them
+     * check ChannelGrant, ChannelGroupGrant and UUIDGrant.
+     *
+     * @param ttl Time in minutes for which granted permissions are valid.
+     * @param meta Additional metadata
+     * @param authorizedUUID Single uuid which is authorized to use the token to make API requests to PubNub
+     * @param channels List of all channel grants
+     * @param channelGroups List of all channel group grants
+     * @param uuids List of all uuid grants
+     */
     fun grantToken(
         ttl: Int,
         meta: Any? = null,
@@ -894,6 +913,18 @@ class PubNub(val configuration: PNConfiguration) {
             uuids = uuids
         )
     }
+
+    /**
+     * This method allows you to disable an existing token and revoke all permissions embedded within.
+     *
+     * @param token Existing token with embedded permissions.
+     */
+    fun revokeToken(token: String): RevokeToken {
+        return RevokeToken(
+            pubnub = this,
+            token = token
+        )
+    }
     //endregion
 
     //region Miscellaneous

src/main/kotlin/com/pubnub/api/PubNubError.kt

@@ -179,6 +179,11 @@ enum class PubNubError(private val code: Int, val message: String) {
     PUSH_TOPIC_MISSING(
         164,
         "Push notification topic is missing. Required only if push type is APNS2."
+    ),
+
+    TOKEN_MISSING(
+        168,
+        "Token missing"
     );
 
     override fun toString(): String {

src/main/kotlin/com/pubnub/api/endpoints/access/RevokeToken.kt

@@ -0,0 +1,41 @@
+package com.pubnub.api.endpoints.access
+
+import com.pubnub.api.Endpoint
+import com.pubnub.api.PubNub
+import com.pubnub.api.PubNubError
+import com.pubnub.api.PubNubException
+import com.pubnub.api.enums.PNOperationType
+import com.pubnub.api.models.server.access_manager.v3.RevokeTokenResponse
+import java.net.URLEncoder
+import retrofit2.Call
+import retrofit2.Response
+
+class RevokeToken(
+    pubnub: PubNub,
+    private val token: String
+) : Endpoint<RevokeTokenResponse, Unit>(pubnub) {
+    override fun validateParams() {
+        super.validateParams()
+        if (!pubnub.configuration.isSecretKeyValid()) {
+            throw PubNubException(PubNubError.SECRET_KEY_MISSING)
+        }
+        if (token.isBlank()) {
+            throw PubNubException(PubNubError.TOKEN_MISSING)
+        }
+    }
+
+    override fun doWork(queryParams: HashMap<String, String>): Call<RevokeTokenResponse> {
+        return pubnub.retrofitManager
+            .accessManagerService
+            .revokeToken(pubnub.configuration.subscribeKey, repairEncoding(token), queryParams)
+    }
+
+    override fun createResponse(input: Response<RevokeTokenResponse>): Unit = Unit
+
+    override fun operationType(): PNOperationType = PNOperationType.PNAccessManagerRevokeToken
+    override fun isAuthRequired(): Boolean = false
+
+    private fun repairEncoding(token: String): String {
+        return URLEncoder.encode(token, "utf-8").replace("+", "%20")
+    }
+}

src/main/kotlin/com/pubnub/api/enums/PNOperationType.kt

@@ -63,6 +63,7 @@ sealed class PNOperationType(open val queryParam: String? = null) {
     object PNManageMemberships : ObjectsOperation()
 
     object PNAccessManagerGrantToken : PAMV3Operation()
+    object PNAccessManagerRevokeToken : PAMV3Operation()
 
     object PNAddMessageAction : MessageActionsOperation()
     object PNGetMessageActions : MessageActionsOperation()

src/main/kotlin/com/pubnub/api/models/server/access_manager/v3/RevokeTokenResponse.kt

@@ -0,0 +1,4 @@
+package com.pubnub.api.models.server.access_manager.v3
+
+data class RevokeTokenResponse(val status: Int, val data: RevokeTokenData, val service: String)
+data class RevokeTokenData(val message: String, val token: String)

src/main/kotlin/com/pubnub/api/services/AccessManagerService.kt

@@ -3,8 +3,10 @@ package com.pubnub.api.services
 import com.pubnub.api.models.server.Envelope
 import com.pubnub.api.models.server.access_manager.AccessManagerGrantPayload
 import com.pubnub.api.models.server.access_manager.v3.GrantTokenResponse
+import com.pubnub.api.models.server.access_manager.v3.RevokeTokenResponse
 import retrofit2.Call
 import retrofit2.http.Body
+import retrofit2.http.DELETE
 import retrofit2.http.GET
 import retrofit2.http.POST
 import retrofit2.http.Path
@@ -24,4 +26,11 @@ internal interface AccessManagerService {
         @Body body: Any?,
         @QueryMap options: Map<String, String>
     ): Call<GrantTokenResponse>
+
+    @DELETE("/v3/pam/{subKey}/grant/{token}")
+    fun revokeToken(
+        @Path("subKey") subKey: String,
+        @Path("token", encoded = true) token: String,
+        @QueryMap queryParams: Map<String, String>
+    ): Call<RevokeTokenResponse>
 }

src/test/kotlin/com/pubnub/api/legacy/PubNubTest.kt

@@ -71,7 +71,7 @@ class PubNubTest : BaseTest() {
     fun getVersionAndTimeStamp() {
         val version = pubnub.version
         val timeStamp = pubnub.timestamp()
-        assertEquals("6.2.0", version)
+        assertEquals("6.3.0", version)
         assertTrue(timeStamp > 0)
     }
 }

src/test/kotlin/com/pubnub/contract/ContractTestConfig.kt

@@ -21,6 +21,8 @@ object ContractTestConfig {
     val pamSubKey by config.StringSetting()
     val pamPubKey by config.StringSetting()
     val pamSecKey by config.StringSetting()
+    val pubKey by config.StringSetting()
+    val subKey by config.StringSetting()
     val serverHostPort by config.StringSetting()
     val serverMock by config.BooleanSetting(true)
 }

src/test/kotlin/com/pubnub/contract/RunMainCucumberTest.kt

@@ -0,0 +1,19 @@
+package com.pubnub.contract
+
+import io.cucumber.junit.Cucumber
+import io.cucumber.junit.CucumberOptions
+import org.junit.runner.RunWith
+
+@RunWith(Cucumber::class)
+@CucumberOptions(
+    tags = "not @skip and not @na=ruby and not @beta",
+    plugin = ["pretty", "summary", "junit:build/reports/cucumber-reports/main.xml"]
+)
+class RunMainCucumberTest
+
+@RunWith(Cucumber::class)
+@CucumberOptions(
+    tags = "not @skip and not @na=ruby and @beta",
+    plugin = ["pretty", "summary", "junit:build/reports/cucumber-reports/beta.xml"]
+)
+class RunBetaCucumberTest