Add support for authorization headers, closes #26

davidmezzetti · davidmezzetti · commit 866435adde37 · 2023-12-27T16:30:20.000-05:00
diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@ Jitpack is the recommended way to integrate txtai with Java. See [this link](htt
 The following is an example adding txtai to a project's `build.gradle` file. The same attributes can be ported to other build systems per the JitPack link above.
 
 ```gradle
-implementation 'com.github.neuml:txtai.java:v6.2.0'
+implementation 'com.github.neuml:txtai.java:v6.3.0'
 ```
 
 txtai can also be manually built from GitHub.
diff --git a/build.gradle b/build.gradle
@@ -17,5 +17,5 @@ java {
 
 jar {
     archiveBaseName = "txtai"
-    archiveVersion = "6.2.0"
+    archiveVersion = "6.3.0"
 }
diff --git a/src/main/java/txtai/API.java b/src/main/java/txtai/API.java
@@ -30,16 +30,21 @@ public IndexResult(int id, double score) {
     /**
      * Creates a new Retrofit API instance.
      * 
-     * @param url base url
+     * @param url API url
+     * @param token API token
      * @param type service interface class
      * @return instance of type
      */
-    public static <T> T create(String url, Class<T> type) {
+    public static <T> T create(String url, String token, Class<T> type) {
+        // Default url and token to environment variables, if empty
+        url = url != null ? url : System.getenv("TXTAI_API_URL");
+        token = token != null ? token : System.getenv("TXTAI_API_TOKEN");
+
         // Configure API instance
         Retrofit retrofit =
             new Retrofit.Builder()
                 .baseUrl(url)
-                .client(API.client())
+                .client(API.client(token))
                 .addConverterFactory(GsonConverterFactory.create())
                 .build();
 
@@ -51,14 +56,21 @@ public static <T> T create(String url, Class<T> type) {
      * Builds a custom http client that raises an Exception when calls are not
      * successful.
      * 
+     * @param token API token
      * @return client instance
      */
-    public static OkHttpClient client() {
+    public static OkHttpClient client(String token) {
         return new OkHttpClient.Builder()  
             .addInterceptor(new Interceptor() {
                 @Override
                 public Response intercept(Chain chain) throws IOException {
                     Request request = chain.request();
+
+                    // Add authorization header
+                    if (token != null) {
+                        request = request.newBuilder().addHeader("Authorization", "Bearer " + token).build();
+                    }
+
                     Response response = chain.proceed(request);
 
                     if (!response.isSuccessful()) {
diff --git a/src/main/java/txtai/Embeddings.java b/src/main/java/txtai/Embeddings.java
@@ -17,7 +17,6 @@
  */
 @SuppressWarnings("rawtypes")
 public class Embeddings {
-    private String url;
     private Remote api;
 
     /**
@@ -94,15 +93,33 @@ public SearchResult(String id, double score) {
         }
     }
 
+    /**
+     * Creates an Embeddings instance.
+     */
+    public Embeddings() {
+        // Create API instance
+        this.api = API.create(null, null, Remote.class);
+    }
+
     /**
      * Creates an Embeddings instance.
      * 
-     * @param url base url of txtai API
+     * @param url API url
      */
     public Embeddings(String url) {
         // Create API instance
-        this.url = url;
-        this.api = API.create(this.url, Remote.class);
+        this.api = API.create(url, null, Remote.class);
+    }
+
+    /**
+     * Creates an Embeddings instance.
+     * 
+     * @param url API url
+     * @param token API token
+     */
+    public Embeddings(String url, String token) {
+        // Create API instance
+        this.api = API.create(url, token, Remote.class);
     }
 
     /**
diff --git a/src/main/java/txtai/Extractor.java b/src/main/java/txtai/Extractor.java
@@ -13,7 +13,6 @@
  */
 @SuppressWarnings("rawtypes")
 public class Extractor {
-    private String url;
     private Remote api;
 
     /**
@@ -75,15 +74,33 @@ public String toString() {
         }
     }
 
+    /**
+     * Creates an Extractor instance.
+     */
+    public Extractor() {
+        // Create API instance
+        this.api = API.create(null, null, Remote.class);
+    }
+
     /**
      * Creates an Extractor instance.
      * 
-     * @param url base url of txtai API
+     * @param url API url
      */
     public Extractor(String url) {
         // Create API instance
-        this.url = url;
-        this.api = API.create(this.url, Remote.class);
+        this.api = API.create(url, null, Remote.class);
+    }
+
+    /**
+     * Creates an Extractor instance.
+     * 
+     * @param url API url
+     * @param token API token
+     */
+    public Extractor(String url, String token) {
+        // Create API instance
+        this.api = API.create(url, token, Remote.class);
     }
 
     /**
diff --git a/src/main/java/txtai/Labels.java b/src/main/java/txtai/Labels.java
@@ -15,7 +15,6 @@
  */
 @SuppressWarnings("rawtypes")
 public class Labels {
-    private String url;
     private Remote api;
 
     /**
@@ -29,15 +28,33 @@ public interface Remote {
         Call<List<List<IndexResult>>> batchlabel(@Body HashMap params);
     }
 
+    /**
+     * Creates a Labels instance.
+     */
+    public Labels() {
+        // Create API instance
+        this.api = API.create(null, null, Remote.class);
+    }
+
     /**
      * Creates a Labels instance.
      * 
-     * @param url base url of txtai API
+     * @param url API url
      */
     public Labels(String url) {
         // Create API instance
-        this.url = url;
-        this.api = API.create(this.url, Remote.class);
+        this.api = API.create(url, null, Remote.class);
+    }
+
+    /**
+     * Creates a Labels instance.
+     * 
+     * @param url API url
+     * @param token API token
+     */
+    public Labels(String url, String token) {
+        // Create API instance
+        this.api = API.create(url, token, Remote.class);
     }
 
     /**
diff --git a/src/main/java/txtai/Segmentation.java b/src/main/java/txtai/Segmentation.java
@@ -15,7 +15,6 @@
  */
 @SuppressWarnings("rawtypes")
 public class Segmentation {
-    private String url;
     private Remote api;
 
     /**
@@ -29,15 +28,33 @@ public interface Remote {
         Call<List<Object>> batchsegment(@Body HashMap params);
     }
 
+    /**
+     * Creates a Segmentation instance.
+     */
+    public Segmentation() {
+        // Create API instance
+        this.api = API.create(null, null, Remote.class);
+    }
+
     /**
      * Creates a Segmentation instance.
      * 
-     * @param url base url of txtai API
+     * @param url API url
      */
     public Segmentation(String url) {
         // Create API instance
-        this.url = url;
-        this.api = API.create(this.url, Remote.class);
+        this.api = API.create(url, null, Remote.class);
+    }
+
+    /**
+     * Creates a Segmentation instance.
+     * 
+     * @param url API url
+     * @param token API token
+     */
+    public Segmentation(String url, String token) {
+        // Create API instance
+        this.api = API.create(url, token, Remote.class);
     }
 
     /**
diff --git a/src/main/java/txtai/Similarity.java b/src/main/java/txtai/Similarity.java
@@ -15,7 +15,6 @@
  */
 @SuppressWarnings("rawtypes")
 public class Similarity {
-    private String url;
     private Remote api;
 
     /**
@@ -29,15 +28,33 @@ public interface Remote {
         Call<List<List<IndexResult>>> batchsimilarity(@Body HashMap params);
     }
 
+    /**
+     * Creates a Similarity instance.
+     */
+    public Similarity() {
+        // Create API instance
+        this.api = API.create(null, null, Remote.class);
+    }
+
     /**
      * Creates a Similarity instance.
      * 
-     * @param url base url of txtai API
+     * @param url API url
      */
     public Similarity(String url) {
         // Create API instance
-        this.url = url;
-        this.api = API.create(this.url, Remote.class);
+        this.api = API.create(url, null, Remote.class);
+    }
+
+    /**
+     * Creates a Similarity instance.
+     * 
+     * @param url API url
+     * @param token API token
+     */
+    public Similarity(String url, String token) {
+        // Create API instance
+        this.api = API.create(url, token, Remote.class);
     }
 
     /**
diff --git a/src/main/java/txtai/Summary.java b/src/main/java/txtai/Summary.java
@@ -15,7 +15,6 @@
  */
 @SuppressWarnings("rawtypes")
 public class Summary {
-    private String url;
     private Remote api;
 
     /**
@@ -29,15 +28,33 @@ public interface Remote {
         Call<List<String>> batchsummary(@Body HashMap params);
     }
 
+    /**
+     * Creates a Summary instance.
+     */
+    public Summary() {
+        // Create API instance
+        this.api = API.create(null, null, Remote.class);
+    }
+
     /**
      * Creates a Summary instance.
      * 
-     * @param url base url of txtai API
+     * @param url API url
      */
     public Summary(String url) {
         // Create API instance
-        this.url = url;
-        this.api = API.create(this.url, Remote.class);
+        this.api = API.create(url, null, Remote.class);
+    }
+
+    /**
+     * Creates a Summary instance.
+     * 
+     * @param url API url
+     * @param token API token
+     */
+    public Summary(String url, String token) {
+        // Create API instance
+        this.api = API.create(url, token, Remote.class);
     }
 
     /**
diff --git a/src/main/java/txtai/Textractor.java b/src/main/java/txtai/Textractor.java
@@ -15,7 +15,6 @@
  */
 @SuppressWarnings("rawtypes")
 public class Textractor {
-    private String url;
     private Remote api;
 
     /**
@@ -29,15 +28,33 @@ public interface Remote {
         Call<List<Object>> batchtextract(@Body HashMap params);
     }
 
+    /**
+     * Creates a Textractor instance.
+     */
+    public Textractor() {
+        // Create API instance
+        this.api = API.create(null, null, Remote.class);
+    }
+
     /**
      * Creates a Textractor instance.
      * 
-     * @param url base url of txtai API
+     * @param url API url
      */
     public Textractor(String url) {
         // Create API instance
-        this.url = url;
-        this.api = API.create(this.url, Remote.class);
+        this.api = API.create(url, null, Remote.class);
+    }
+
+    /**
+     * Creates a Textractor instance.
+     * 
+     * @param url API url
+     * @param token API token
+     */
+    public Textractor(String url, String token) {
+        // Create API instance
+        this.api = API.create(url, token, Remote.class);
     }
 
     /**
diff --git a/src/main/java/txtai/Transcription.java b/src/main/java/txtai/Transcription.java
diff --git a/src/main/java/txtai/Translation.java b/src/main/java/txtai/Translation.java
diff --git a/src/main/java/txtai/Workflow.java b/src/main/java/txtai/Workflow.java

Original file line number	Diff line number	Diff line change
`@@ -17,5 +17,5 @@ java {`
`17`	`17`
`18`	`18`	`jar {`
`19`	`19`	`archiveBaseName = "txtai"`
`20`		`- archiveVersion = "6.2.0"`
	`20`	`+ archiveVersion = "6.3.0"`
`21`	`21`	`}`