Merge pull request ably#633 from ably/release/1.2.3

Release/1.2.3

Author: QuintinWillison

CHANGELOG.md

@@ -1,5 +1,34 @@
 # Change Log
 
+## [v1.2.3](https://github.com/ably/ably-java/tree/v1.2.3)
+
+[Full Changelog](https://github.com/ably/ably-java/compare/v1.2.2...v1.2.3)
+
+**Enhancements and Bug Fixes:**
+
+- Add connectionKey attribute missing from the Message object [\#630](https://github.com/ably/ably-java/pull/630) ([vzhikserg](https://github.com/vzhikserg)), fixing [\#614](https://github.com/ably/ably-java/issues/614)
+- Improve error messages for channel attach when realtime is not active [\#627](https://github.com/ably/ably-java/pull/627) ([vzhikserg](https://github.com/vzhikserg)), fixing [\#594](https://github.com/ably/ably-java/issues/594)
+- Add verbose logs in push notification related code [\#623](https://github.com/ably/ably-java/pull/623) ([QuintinWillison](https://github.com/QuintinWillison))
+- Defaults: Generate environment fallbacks [\#618](https://github.com/ably/ably-java/pull/618) ([vzhikserg](https://github.com/vzhikserg)), fixing [\#603](https://github.com/ably/ably-java/issues/603)
+- Rest.publishBatch: support overloaded method that takes params [\#604](https://github.com/ably/ably-java/pull/604) ([SimonWoolf](https://github.com/SimonWoolf))
+
+**Code Quality Improvements:**
+
+- Refactor unit tests related to hosts and environmental fallbacks [\#629](https://github.com/ably/ably-java/pull/629) ([vzhikserg](https://github.com/vzhikserg)), fixing [\#628](https://github.com/ably/ably-java/issues/628)
+- Move tests for EventEmitter to unit tests [\#626](https://github.com/ably/ably-java/pull/626) ([vzhikserg](https://github.com/vzhikserg))
+- Adopt more Groovy conventions in Gradle scripts [\#625](https://github.com/ably/ably-java/pull/625) ([QuintinWillison](https://github.com/QuintinWillison))
+- Gradle conform and reformat [\#624](https://github.com/ably/ably-java/pull/624) ([QuintinWillison](https://github.com/QuintinWillison))
+- Fix param and return javadoc statements [\#622](https://github.com/ably/ably-java/pull/622) ([vzhikserg](https://github.com/vzhikserg))
+- Make Ably version more robust [\#619](https://github.com/ably/ably-java/pull/619) ([vzhikserg](https://github.com/vzhikserg))
+- Remove unnecessary calls to the toString method [\#617](https://github.com/ably/ably-java/pull/617) ([vzhikserg](https://github.com/vzhikserg))
+- Update EditorConfig [\#616](https://github.com/ably/ably-java/pull/616) ([QuintinWillison](https://github.com/QuintinWillison))
+- Upgrade Gradle wrapper to version 6.6.1 [\#615](https://github.com/ably/ably-java/pull/615) ([QuintinWillison](https://github.com/QuintinWillison))
+- Checkstyle: AvoidStarImport [\#613](https://github.com/ably/ably-java/pull/613) ([QuintinWillison](https://github.com/QuintinWillison))
+- Checkstyle: UnusedImports [\#612](https://github.com/ably/ably-java/pull/612) ([QuintinWillison](https://github.com/QuintinWillison))
+- Convert tabs to spaces in all Java source files [\#610](https://github.com/ably/ably-java/pull/610) ([QuintinWillison](https://github.com/QuintinWillison))
+- Introduce Checkstyle [\#609](https://github.com/ably/ably-java/pull/609) ([QuintinWillison](https://github.com/QuintinWillison))
+- Remove redundant public keywords in the interfaces' definitions [\#608](https://github.com/ably/ably-java/pull/608) ([vzhikserg](https://github.com/vzhikserg))
+
 ## [v1.2.2](https://github.com/ably/ably-java/tree/v1.2.2) (2020-09-17)
 
 [Full Changelog](https://github.com/ably/ably-java/compare/v1.2.1...v1.2.2)

README.md

@@ -30,13 +30,13 @@ Reference the library by including a compile dependency reference in your gradle
 For [Java](https://bintray.com/ably-io/ably/ably-java/_latestVersion):
 
 ```
-compile 'io.ably:ably-java:1.2.2'
+compile 'io.ably:ably-java:1.2.3'
 ```
 
 For [Android](https://bintray.com/ably-io/ably/ably-android/_latestVersion):
 
 ```
-compile 'io.ably:ably-android:1.2.2'
+compile 'io.ably:ably-android:1.2.3'
 ```
 
 The library is hosted on the [Jcenter repository](https://bintray.com/ably-io/ably), so you need to ensure that the repo is referenced also; IDEs will typically include this by default:
@@ -616,15 +616,15 @@ Configuration of Run/Debug configurations for running the unit tests on Android
 
 This library uses [semantic versioning](http://semver.org/). For each release, the following needs to be done:
 
-1. Create a branch for the release, named like `release/1.2.2`
+1. Create a branch for the release, named like `release/1.2.3`
 2. Replace all references of the current version number with the new version number (check this file [README.md](./README.md) and [common.gradle](./common.gradle)) and commit the changes
 3. Run [`github_changelog_generator`](https://github.com/skywinder/Github-Changelog-Generator) to update the [CHANGELOG](./CHANGELOG.md):
-    * This might work: `github_changelog_generator -u ably -p ably-java --header-label="# Changelog" --release-branch=release/1.2.2 --future-release=v1.2.2`
-    * But your mileage may vary as it can error. Perhaps more reliable is something like: `github_changelog_generator -u ably -p ably-java --since-tag v1.2.1 --output delta.md` and then manually merge the delta contents in to the main change log
+    * This might work: `github_changelog_generator -u ably -p ably-java --header-label="# Changelog" --release-branch=release/1.2.3 --future-release=v1.2.3`
+    * But your mileage may vary as it can error. Perhaps more reliable is something like: `github_changelog_generator -u ably -p ably-java --since-tag v1.2.2 --output delta.md` and then manually merge the delta contents in to the main change log
 4. Commit [CHANGELOG](./CHANGELOG.md)
 5. Make a PR against `main`
 6. Once the PR is approved, merge it into `main`
-7. Add a tag and push to origin - e.g.: `git tag v1.2.2 && git push origin v1.2.2`
+7. Add a tag and push to origin - e.g.: `git tag v1.2.3 && git push origin v1.2.3`
 8. Create the release on Github including populating the release notes (needed so JFrog can pull them in)
 9. Assemble and Upload ([see below](#publishing-to-jcenter-and-maven-central) for details) - but the overall order to follow is:
 	1. Upload to Bintray and use the pushed tag, which will pull in the associated release notes
@@ -652,18 +652,18 @@ We publish to:
 
 The `java` release process goes as follows:
 
-* Go to the home page for the package; eg https://bintray.com/ably-io/ably/ably-java. Select Add a version, enter the new version such as "1.2.2" in name and save
+* Go to the home page for the package; eg https://bintray.com/ably-io/ably/ably-java. Select Add a version, enter the new version such as "1.2.3" in name and save
 * Run `./gradlew java:assembleRelease` locally to generate the files
-* Open local relative folder in Finder, such as `./java/build/release/1.2.2/io/ably/ably-java/1.2.2`
-* Go to the new version in JFrog Bintray; eg https://bintray.com/ably-io/ably/ably-java/1.2.2, then click on the link to upload via the UI in the "Upload files" section
+* Open local relative folder in Finder, such as `./java/build/release/1.2.3/io/ably/ably-java/1.2.3`
+* Go to the new version in JFrog Bintray; eg https://bintray.com/ably-io/ably/ably-java/1.2.3, then click on the link to upload via the UI in the "Upload files" section
 * Drag in the files from Finder, just the `.jar` files and the `.pom` file. JFrog will fill in the "Target Path" box after you drop the files in. Click the "Upload" button.
 * You will see a notice something like "4 unpublished files in your version. Will be deleted in 6 days and 22 hours. Publish all or Delete all unpublished files.", make sure you click "Publish all". Wait a few minutes and check that what's uploaded looks like what was uploaded for previous releases. The `maven-metadata` files are created by JFrog.
 * Update the README text in Bintray (version number needs incrementing).
 
 Similarly for the `android` release at https://bintray.com/ably-io/ably/ably-android:
 
 * Run `./gradlew android:assembleRelease` locally to generate the files, and drag in the files in
-`./android/build/release/1.2.2/io/ably/ably-android/1.2.2`.
+`./android/build/release/1.2.3/io/ably/ably-android/1.2.3`.
 * In this case upload the `.jar` files, the `.pom` file and the `.aar` file.
 
 #### Releasing to Maven Central (Sonatype Nexus)

common.gradle

@@ -4,7 +4,7 @@ repositories {
 }
 
 group = 'io.ably'
-version = '1.2.2'
+version = '1.2.3'
 description = 'Ably java client library'
 
 tasks.withType(Javadoc) {

lib/src/test/java/io/ably/lib/test/realtime/RealtimeHttpHeaderTest.java

@@ -91,7 +91,7 @@ public void realtime_websocket_param_test() {
              * Defaults.ABLY_LIB_PARAM, as ultimately the request param has been derived from those values.
              */
             assertEquals("Verify correct lib version", requestParameters.get("lib"),
-                    Collections.singletonList("java-1.2.2"));
+                    Collections.singletonList("java-1.2.3"));
 
             /* Spec RTN2a */
             assertEquals("Verify correct format", requestParameters.get("format"),

lib/src/test/java/io/ably/lib/test/rest/HttpHeaderTest.java

@@ -84,7 +84,7 @@ public void header_lib_channel_publish() {
              */
             Assert.assertNotNull("Expected headers", headers);
             Assert.assertEquals(headers.get("x-ably-version"), "1.2");
-            Assert.assertEquals(headers.get("x-ably-lib"), "java-1.2.2");
+            Assert.assertEquals(headers.get("x-ably-lib"), "java-1.2.3");
         } catch (AblyException e) {
             e.printStackTrace();
             Assert.fail("header_lib_channel_publish: Unexpected exception");