Merge pull request #26 from OpenCageData/15-add-user-agent-header

feat: 🎸 adds the header User-Agent

Author: tsamaya

build.gradle

@@ -41,6 +41,20 @@ test {
 	systemProperties = System.properties
 }
 
+jar {
+	manifest {
+		attributes(
+			'Specification-Title': 'Java Client for the OpenCage REST API',
+			'Specification-Vendor': 'OpenCage GmbH',
+			'Specification-Version': archiveVersion,
+			'Implementation-Title': 'Java Client for the OpenCage REST API',
+			'Implementation-Vendor': 'OpenCage GmbH',
+			'Implementation-Version': archiveVersion,
+		)
+	}
+}
+
+
 publishing {
 	publications {
 		mavenJava(MavenPublication) {

src/main/java/com/opencagedata/jopencage/JOpenCageGeocoder.java

@@ -40,19 +40,26 @@ public class JOpenCageGeocoder {
     private String path = OPENCAGE_PATH;
     private String format = "json";
     private String apiKey;
+    private String userAgent;
 
     /**
      * JOpenCageGeocoder
-     * 
+     *
      * @param apiKey your Opencage Data API Key
      */
     public JOpenCageGeocoder(String apiKey) {
         this.apiKey = apiKey;
+        String packageVersion = this.getClass().getPackage().getImplementationVersion();
+        StringBuilder userAgentBuilder = new StringBuilder("jOpenCage/");
+        if (packageVersion != null) {
+            userAgentBuilder.append(packageVersion);
+        }
+        this.userAgent = userAgentBuilder.toString();
     }
 
     /**
      * forward geocoding
-     * 
+     *
      * @param request the request
      * @return JOpenCageResponse
      */
@@ -62,7 +69,7 @@ public JOpenCageResponse forward(JOpenCageForwardRequest request) {
 
     /**
      * reverse geocoding
-     * 
+     *
      * @param request the request
      * @return JOpenCageResponse
      */
@@ -108,6 +115,7 @@ private JOpenCageResponse sendRequest(JOpenCageRequest jOpenCageRequest) {
         if (url != null) {
             try (CloseableHttpClient httpclient = HttpClientBuilder.create().build()) {
                 HttpGet getRequest = new HttpGet(url);
+                getRequest.setHeader("User-Agent", this.userAgent);
 
                 HttpClientResponseHandler<JOpenCageResponse> rh = new AbstractHttpClientResponseHandler<JOpenCageResponse>() {
                     @Override
@@ -151,7 +159,7 @@ public JOpenCageResponse handleEntity(HttpEntity entity) throws IOException {
 
     /**
      * Is HTTPS enabled?
-     * 
+     *
      * @return boolean
      */
     public boolean isHttpsEnabled() {
@@ -160,7 +168,7 @@ public boolean isHttpsEnabled() {
 
     /**
      * Toggle HTTPS usage
-     * 
+     *
      * @param httpsEnabled enable or disable the HTTPS usage
      */
     public void setHttpsEnabled(boolean httpsEnabled) {
@@ -169,7 +177,7 @@ public void setHttpsEnabled(boolean httpsEnabled) {
 
     /**
      * API Host
-     * 
+     *
      * @return host
      */
     public String getHost() {
@@ -178,7 +186,7 @@ public String getHost() {
 
     /**
      * Set API Host
-     * 
+     *
      * @param host the host
      */
     public void setHost(String host) {
@@ -187,7 +195,7 @@ public void setHost(String host) {
 
     /**
      * API path
-     * 
+     *
      * @return String the path
      */
     public String getPath() {
@@ -196,7 +204,7 @@ public String getPath() {
 
     /**
      * Set API path
-     * 
+     *
      * @param path the path
      */
     public void setPath(String path) {
@@ -205,7 +213,7 @@ public void setPath(String path) {
 
     /**
      * API Key
-     * 
+     *
      * @return String the API Key
      */
     public String getApiKey() {

src/main/resources/META-INF/MANIFEST.MF

@@ -1,3 +1,6 @@
 Manifest-Version: 1.0
-Main-Class: com.byteowls.jopencage
+Specification-Title:  Java Client for the OpenCage REST API
+Specification-Vendor: OpenCage GmbH
+Implementation-Title: Java Client for the OpenCage REST API
+Implementation-Vendor: OpenCage GmbH
 

src/test/java/com/opencagedata/jopencage/JOpenCageTestUtils.java

@@ -6,7 +6,7 @@ public abstract class JOpenCageTestUtils {
 
     public static void freeTrailSleep() {
         try {
-            Thread.sleep(1000); // free trial accounts are limited to 1 request/second
+            Thread.sleep(100); // free trial accounts are limited to 1 request/second, put back 1000 if running tests returns 429 errors
         } catch (InterruptedException ignore) {}
     }