Merge pull request #185 from commercetools/142-Add-lib-info-in-client-headers

142: add lib info in client headers

Author: heshamMassoud

docs/RELEASE_NOTES.md

@@ -46,6 +46,9 @@ are breaking changes. If there are, then a migration guide should be provided.
 [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/v1.0.0-M5/) | 
 [Jar](https://bintray.com/commercetools/maven/commercetools-sync-java/v1.0.0-M5)
 
+**Build Tools** (1)
+- **Commons** - Append library name and version to User-Agent headers of JVM SDK clients using the library. [#142](https://github.com/commercetools/commercetools-sync-java/issues/142)
+
 **Doc Fixes** (1)
 - **Build Tools** - Adds Snyk vulnerabilities badge to repo README. [#188](https://github.com/commercetools/commercetools-sync-java/pull/188)
 -->
@@ -54,7 +57,7 @@ are breaking changes. If there are, then a migration guide should be provided.
 [Javadoc](https://commercetools.github.io/commercetools-sync-java/v/v1.0.0-M4/) | 
 [Jar](https://bintray.com/commercetools/maven/commercetools-sync-java/v1.0.0-M4)
 
-**Bug Fixes** (1)
+**Hotfix** (1)
 - **Product Sync** - Fixes an issue with `replaceAttributesReferencesIdsWithKeys` which nullifies localized text attributes due 
 to JSON parsing not throwing exception on parsing it to reference set. [#179](https://github.com/commercetools/commercetools-sync-java/issues/179)
 

gradle-scripts/package.gradle

@@ -1,6 +1,12 @@
 /**
  * Package sources to JARs
  */
+jar {
+    manifest {
+        attributes("Implementation-Title": rootProject.name, "Implementation-Version": rootProject.version)
+    }
+}
+
 task sourcesJar(type: Jar, dependsOn: classes) {
     classifier = 'sources'
     from sourceSets.main.allSource

src/main/java/com/commercetools/sync/commons/utils/SyncSolutionInfo.java

@@ -0,0 +1,30 @@
+package com.commercetools.sync.commons.utils;
+
+import io.sphere.sdk.client.SolutionInfo;
+
+import static java.lang.String.format;
+import static java.util.Optional.ofNullable;
+
+public class SyncSolutionInfo extends SolutionInfo {
+    /**
+     * Extends {@link SolutionInfo} class of the JVM SDK to append to the User-Agent header with information of the
+     * commercetools-sync-java library
+     *
+     * <p>A User-Agent header with a solution information looks like this:
+     * {@code commercetools-jvm-sdk/1.4.1 (AHC/2.0) Java/1.8.0_92-b14 (Mac OS X; x86_64)
+     * {@code implementationTitle}/{@code implementationVersion}
+     * (+https://github.com/commercetools/commercetools-sync-java; +ps-dev@commercetools.com)}</p>
+     *
+     */
+    public SyncSolutionInfo() {
+        final String libraryName = "commercetools-sync-java";
+        final String implementationTitle = ofNullable(getClass().getPackage().getImplementationTitle())
+            .orElse(libraryName);
+        final String implementationVersion = ofNullable(getClass().getPackage().getImplementationVersion())
+            .orElse("DEBUG-VERSION");
+        setName(implementationTitle);
+        setVersion(implementationVersion);
+        setWebsite(format("https://github.com/commercetools/%s", libraryName));
+        setEmergencyContact("ps-dev@commercetools.com");
+    }
+}

src/main/resources/META-INF/services/io.sphere.sdk.client.SolutionInfo

@@ -0,0 +1 @@
+com.commercetools.sync.commons.utils.SyncSolutionInfo