Merge pull request #24 from ContentChef/release/v1.3.0

Release/v1.3.0

Author: e-papa

.github/workflows/deploy.yml

@@ -34,15 +34,17 @@ jobs:
         base64 -d -i secretKeyRing.gpg.b64 > "$CONTENT_CHEF_SIGNING_SECRET_KEY_RING_FILE"
       env:
         CONTENT_CHEF_SIGNING_SECRET_KEY_RING_FILE: ${{ secrets.CONTENT_CHEF_SIGNING_SECRET_KEY_RING_FILE }}
-        CONTENT_CHEF_SIGNING_SECRET_KEY_RING_FILE_CONTENT: ${{ secret.CONTENT_CHEF_SIGNING_SECRET_KEY_RING_FILE_CONTENT }}
+        CONTENT_CHEF_SIGNING_SECRET_KEY_RING_FILE_CONTENT: ${{ secrets.CONTENT_CHEF_SIGNING_SECRET_KEY_RING_FILE_CONTENT }}
     - name: Build with Gradle
       run: ./gradlew clean build
     - name: Publish to MavenCentral
-      run: ./gradlew publishReleasePublicationToSonatypeRepository --max-workers 1 closeAndReleaseSonatypeStagingRepository
+      run: ./gradlew publishReleasePublicationToSonatypeRepository --max-workers 1
       env:
-        CONTENT_CHEF_SIGNING_KEY_ID: ${{ secret.CONTENT_CHEF_SIGNING_KEY_ID }}
-        CONTENT_CHEF_SIGNING_PASSWORD: ${{ secret.CONTENT_CHEF_SIGNING_PASSWORD }}
-        CONTENT_CHEF_SIGNING_SECRET_KEY_RING_FILE: ${{ secret.CONTENT_CHEF_SIGNING_SECRET_KEY_RING_FILE }}
-        CONTENT_CHEF_OSSRH_USERNAME: ${{ secret.CONTENT_CHEF_OSSRH_USERNAME }}
-        CONTENT_CHEF_OSSRH_PASSWORD: ${{ secret.CONTENT_CHEF_OSSRH_PASSWORD }}
-        CONTENT_CHEF_SONATYPE_STAGING_PROFILE_ID: ${{ secret.CONTENT_CHEF_SONATYPE_STAGING_PROFILE_ID }}
+        CONTENT_CHEF_SIGNING_KEY_ID: ${{ secrets.CONTENT_CHEF_SIGNING_KEY_ID }}
+        CONTENT_CHEF_SIGNING_PASSWORD: ${{ secrets.CONTENT_CHEF_SIGNING_PASSWORD }}
+        CONTENT_CHEF_SIGNING_SECRET_KEY_RING_FILE: ${{ secrets.CONTENT_CHEF_SIGNING_SECRET_KEY_RING_FILE }}
+        CONTENT_CHEF_OSSRH_USERNAME: ${{ secrets.CONTENT_CHEF_OSSRH_USERNAME }}
+        CONTENT_CHEF_OSSRH_PASSWORD: ${{ secrets.CONTENT_CHEF_OSSRH_PASSWORD }}
+        CONTENT_CHEF_SONATYPE_STAGING_PROFILE_ID: ${{ secrets.CONTENT_CHEF_SONATYPE_STAGING_PROFILE_ID }}
+    - name: Remember to release to MavenCentral
+      run: echo "Remember to release on MavenCentral from https://s01.oss.sonatype.org"

CHANGELOG.md

@@ -2,6 +2,11 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [1.3.0] - 2021-05-14
+### Added
+- A `Locale` can now be provided to `getPreviewChannel` and `getOnlineChannel` to retrieve localized content
+### Fixed
+- Fix `NullPointerException` when a 404 response happens. Now `ContentNotFoundException` it's correctly used 
 
 ## [1.2.2] - 2021-04-30
 ### Added

README.md

@@ -99,7 +99,30 @@ Preview all the contents with definition as *default-header* in a given future d
       println("onError $it")  
     })
 
-Look at *sampleapp* and *sampleapp-android* in the source code for more examples.
+Retrieve localized content as *localized-header* from the _live_ environment:
+
+```kotlin
+val enOnlineChannel = contentChef.getOnlineChannel(ONLINE_API_KEY, PUBLISHING_CHANNEL, locale = Locale.ENGLISH)
+val itOnlineChannel = contentChef.getOnlineChannel(ONLINE_API_KEY, PUBLISHING_CHANNEL, locale = Locale.ITALY)
+
+val localizedHeaderOnlineContentRequestData = OnlineContentRequestData(
+    "localized-header"
+)
+
+enOnlineChannel.getContent(localizedHeaderOnlineContentRequestData, {
+    println("onSuccess $it")
+}, { 
+    println("onError $it") 
+})
+
+itOnlineChannel.getContent(localizedHeaderOnlineContentRequestData, {
+    println("onSuccess $it")
+}, {
+    println("onError $it") 
+})
+```
+
+Look at *sample-java*, *sample-kt* and *sample-android* in the source code for more examples.
 
 ## Installation
 

contentchef-jvm-callback-common/src/main/java/io/contentchef/callback/common/CallbackContentChef.kt

@@ -3,6 +3,7 @@ package io.contentchef.callback.common
 import io.contentchef.common.configuration.ContentChefEnvironment
 import io.contentchef.common.configuration.ContentChefEnvironmentConfiguration
 import io.contentchef.common.network.RequestFactory
+import java.util.Locale
 
 /**
  * Exposes methods used to retrieve contents from ContentChef's backend
@@ -15,35 +16,40 @@ internal class CallbackContentChef constructor(
 
     override fun getPreviewChannel(
         previewApiKey: String,
-        publishingChannel: String
+        publishingChannel: String,
+        locale: Locale?
     ): PreviewChannel {
         return AbstractChannel(
             contentChefEnvironmentConfiguration.generateWebserviceURL(
                 ContentChefEnvironmentConfiguration.Companion.WebService.PREVIEW_CONTENT,
-                publishingChannel
+                publishingChannel,
+                locale
             ),
             contentChefEnvironmentConfiguration.generateWebserviceURL(
                 ContentChefEnvironmentConfiguration.Companion.WebService.PREVIEW_SEARCH,
-                publishingChannel
+                publishingChannel,
+                locale
             ),
             previewApiKey,
             requestFactory,
             requestExecutor
         )
     }
 
-    override fun getOnlineChannel(onlineApiKey: String, publishingChannel: String): OnlineChannel {
+    override fun getOnlineChannel(onlineApiKey: String, publishingChannel: String, locale: Locale?): OnlineChannel {
         require(contentChefEnvironmentConfiguration.contentChefEnvironment == ContentChefEnvironment.LIVE) {
             "Online channel can only be used with LIVE environment setup"
         }
         return AbstractChannel(
             contentChefEnvironmentConfiguration.generateWebserviceURL(
                 ContentChefEnvironmentConfiguration.Companion.WebService.ONLINE_CONTENT,
-                publishingChannel
+                publishingChannel,
+                locale
             ),
             contentChefEnvironmentConfiguration.generateWebserviceURL(
                 ContentChefEnvironmentConfiguration.Companion.WebService.ONLINE_SEARCH,
-                publishingChannel
+                publishingChannel,
+                locale
             ),
             onlineApiKey,
             requestFactory,

contentchef-jvm-callback-common/src/main/java/io/contentchef/callback/common/ContentChef.kt

@@ -4,6 +4,7 @@ import io.contentchef.common.request.OnlineContentRequestData
 import io.contentchef.common.request.PreviewContentRequestData
 import io.contentchef.common.request.SearchOnlineRequestData
 import io.contentchef.common.request.SearchPreviewRequestData
+import java.util.Locale
 
 /**
  * Exposes methods used to retrieve contents from ContentChef's backend
@@ -14,15 +15,17 @@ interface ContentChef {
      * Using the [PreviewChannel] you can retrieve contents which are in in both stage and live state and even contents that are not visible in the current date
      * [previewApiKey] is the api key required for the [PreviewChannel]
      * [publishingChannel] chosen publishingChannel
+     * [locale] used to retrieve localized content
      */
-    fun getPreviewChannel(previewApiKey: String, publishingChannel: String): PreviewChannel
+    fun getPreviewChannel(previewApiKey: String, publishingChannel: String, locale: Locale? = null): PreviewChannel
 
     /**
      * Using the [OnlineChannel] you can retrieve contents which are in live state and which are actually visible
      * [onlineApiKey] is the api key required for the [OnlineChannel]
      * [publishingChannel] chosen publishingChannel
+     * [locale] used to retrieve localized content
      */
-    fun getOnlineChannel(onlineApiKey: String, publishingChannel: String): OnlineChannel
+    fun getOnlineChannel(onlineApiKey: String, publishingChannel: String, locale: Locale? = null): OnlineChannel
 
 }
 

contentchef-jvm-common/src/main/java/io/contentchef/common/configuration/ContentChefEnvironmentConfiguration.kt

@@ -1,5 +1,7 @@
 package io.contentchef.common.configuration
 
+import java.util.Locale
+
 /**
  * Used to configure a [ContentChef] instance using a [ContentChefProvider]
  * [contentChefEnvironment] chosen ContentChef environment
@@ -28,10 +30,18 @@ constructor(
         }
     }
 
-    fun generateWebserviceURL(webService: WebService, publishingChannel: String): String {
+    fun generateWebserviceURL(webService: WebService, publishingChannel: String, locale: Locale? = null): String {
         val finalUrl = contentChefBaseUrl.plus(webService.urlTemplate)
-        return finalUrl.replace(ENVIRONMENT_PLACEHOLDER, contentChefEnvironment.urlPathValue)
+        finalUrl.replace(ENVIRONMENT_PLACEHOLDER, contentChefEnvironment.urlPathValue)
             .replace(SPACE_ID_PLACEHOLDER, spaceId)
             .replace(PUBLISHING_CHANNEL_PLACEHOLDER, publishingChannel)
+            .run {
+                return if (locale != null) {
+                    val localeString = locale.toString()
+                    plus("/$localeString")
+                } else {
+                    this
+                }
+            }
     }
 }

contentchef-jvm-common/src/main/java/io/contentchef/common/network/ConnectionStreamReader.kt

@@ -1,6 +1,7 @@
 package io.contentchef.common.network
 
 import java.io.BufferedReader
+import java.io.InputStream
 import java.io.InputStreamReader
 import java.net.HttpURLConnection
 
@@ -13,12 +14,21 @@ object ConnectionStreamReader {
      * Returns the content read from [httpURLConnection] as [String]
      */
     fun getContentAsString(httpURLConnection: HttpURLConnection): String {
-        val br = if (httpURLConnection.responseCode in 200..299) {
-            BufferedReader(InputStreamReader(httpURLConnection.inputStream))
-        } else {
-            BufferedReader(InputStreamReader(httpURLConnection.errorStream))
+        return when (httpURLConnection.responseCode) {
+            in 200..299 -> {
+                readStreamAsString(httpURLConnection.inputStream)
+            }
+            404 -> {
+                ""
+            }
+            else -> {
+                readStreamAsString(httpURLConnection.errorStream);
+            }
         }
-        return br.useLines {
+    }
+
+    private fun readStreamAsString(inputStream: InputStream): String {
+        return BufferedReader(InputStreamReader(inputStream)).useLines {
             it.joinToString(separator = "")
         }
     }

publish_scripts/publish-module.gradle

@@ -27,7 +27,7 @@ artifacts {
 }
 
 def PUBLISH_GROUP_ID = 'io.contentchef'
-def PUBLISH_VERSION = '1.2.2'
+def PUBLISH_VERSION = '1.3.0'
 group = PUBLISH_GROUP_ID
 version = PUBLISH_VERSION
 

sample-android/src/main/java/io/contentchef/android/sample/MainActivity.kt

@@ -25,6 +25,10 @@ class MainActivity : AppCompatActivity() {
     private lateinit var onlineChannel: OnlineChannel
     private lateinit var previewChannel: PreviewChannel
 
+    //LOCALIZED CHANNELS
+    private lateinit var enOnlineChannel: OnlineChannel
+    private lateinit var itOnlineChannel: OnlineChannel
+
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
@@ -143,6 +147,26 @@ class MainActivity : AppCompatActivity() {
                 SampleHeader(it.getString("header"))
             })
 
+            //LOCALIZED CONTENT EXAMPLE
+            enOnlineChannel = contentChef.getOnlineChannel(ONLINE_API_KEY, PUBLISHING_CHANNEL, locale = Locale.ENGLISH)
+            itOnlineChannel = contentChef.getOnlineChannel(ONLINE_API_KEY, PUBLISHING_CHANNEL, locale = Locale.ITALY)
+
+            val localizedHeaderOnlineContentRequestData = OnlineContentRequestData(
+                "test-localized-header"
+            )
+
+            enOnlineChannel.getContent(localizedHeaderOnlineContentRequestData, {
+                println("onSuccess $it")
+            }, {
+                println("onError $it")
+            })
+
+            itOnlineChannel.getContent(localizedHeaderOnlineContentRequestData, {
+                println("onSuccess $it")
+            }, {
+                println("onError $it")
+            })
+
         }
     }
 

sample-java/src/main/java/io/contentchef/sample/Main.java

@@ -2,6 +2,7 @@
 
 import java.util.Collections;
 import java.util.Date;
+import java.util.Locale;
 
 import io.contentchef.callback.CallbackContentChefProvider;
 import io.contentchef.callback.common.Channel;
@@ -42,8 +43,8 @@ public static void main(String[] args) {
                 ), true
         );
 
-        Channel<OnlineContentRequestData, SearchOnlineRequestData> onlineChannel = contentChef.getOnlineChannel(ContentChefConfiguration.ONLINE_API_KEY, ContentChefConfiguration.PUBLISHING_CHANNEL);
-        Channel<PreviewContentRequestData, SearchPreviewRequestData> previewChannel = contentChef.getPreviewChannel(ContentChefConfiguration.PREVIEW_API_KEY, ContentChefConfiguration.PUBLISHING_CHANNEL);
+        Channel<OnlineContentRequestData, SearchOnlineRequestData> onlineChannel = contentChef.getOnlineChannel(ContentChefConfiguration.ONLINE_API_KEY, ContentChefConfiguration.PUBLISHING_CHANNEL, null);
+        Channel<PreviewContentRequestData, SearchPreviewRequestData> previewChannel = contentChef.getPreviewChannel(ContentChefConfiguration.PREVIEW_API_KEY, ContentChefConfiguration.PUBLISHING_CHANNEL, null);
 
         PreviewContentRequestData previewContentRequestData = new PreviewContentRequestData(
                 "new-header", new Date()
@@ -151,6 +152,26 @@ public static void main(String[] args) {
                 jsonObject -> new SampleHeader(jsonObject.getString("header"))
         );
 
+        //LOCALIZED CONTENT EXAMPLE
+        Channel<OnlineContentRequestData, SearchOnlineRequestData> enOnlineChannel = contentChef.getOnlineChannel(ContentChefConfiguration.ONLINE_API_KEY, ContentChefConfiguration.PUBLISHING_CHANNEL, Locale.ENGLISH);
+        Channel<OnlineContentRequestData, SearchOnlineRequestData> itOnlineChannel = contentChef.getOnlineChannel(ContentChefConfiguration.ONLINE_API_KEY, ContentChefConfiguration.PUBLISHING_CHANNEL, Locale.ITALY);
+
+        OnlineContentRequestData localizedHeaderOnlineContentRequestData = new OnlineContentRequestData(
+                "test-localized-header"
+        );
+
+        enOnlineChannel.getContent(
+                localizedHeaderOnlineContentRequestData,
+                jsonObjectContentChefItemResponse -> printSuccess(jsonObjectContentChefItemResponse),
+                throwable -> printError(throwable)
+        );
+
+        itOnlineChannel.getContent(
+                localizedHeaderOnlineContentRequestData,
+                jsonObjectContentChefItemResponse -> printSuccess(jsonObjectContentChefItemResponse),
+                throwable -> printError(throwable)
+        );
+
     }
 
 }