Update Keys API for Meilisearch v.28

src/main/java/com/meilisearch/sdk/Client.java

@@ -8,6 +8,8 @@
 import com.meilisearch.sdk.exceptions.MeilisearchException;
 import com.meilisearch.sdk.json.JsonHandler;
 import com.meilisearch.sdk.model.Key;
+import com.meilisearch.sdk.model.KeyUpdate;
+import com.meilisearch.sdk.model.KeysQuery;
 import com.meilisearch.sdk.model.Results;
 import com.meilisearch.sdk.model.Stats;
 import com.meilisearch.sdk.model.Task;
@@ -263,7 +265,7 @@ public void waitForTask(int uid) throws MeilisearchException {
      * https://docs.meilisearch.com/reference/api/keys.html#get-one-key
      *
      * @param uid Identifier of the requested Key
-     * @return Key Instance
+     * @return Meilisearch API response as Key Instance
      * @throws MeilisearchException if an error occurs
      */
     public Key getKey(String uid) throws MeilisearchException {
@@ -273,18 +275,29 @@ public Key getKey(String uid) throws MeilisearchException {
     /**
      * Retrieves list of keys https://docs.meilisearch.com/reference/api/keys.html#get-all-keys
      *
-     * @return List of keys in the Meilisearch client
+     * @return Results containing a list of Key from the Meilisearch API
      * @throws MeilisearchException if an error occurs
      */
     public Results<Key> getKeys() throws MeilisearchException {
         return this.keysHandler.getKeys();
     }
 
+    /**
+     * Get list of all API keys https://docs.meilisearch.com/reference/api/keys.html#get-all-keys
+     *
+     * @param params query parameters accepted by the get keys route
+     * @return Results containing a list of Key from the Meilisearch API
+     * @throws MeilisearchException if an error occurs
+     */
+    public Results<Key> getKeys(KeysQuery params) throws MeilisearchException {
+        return this.keysHandler.getKeys(params);
+    }
+
     /**
      * Creates a key https://docs.meilisearch.com/reference/api/keys.html#create-a-key
      *
      * @param options Key containing the options of the key
-     * @return Key Instance
+     * @return Meilisearch API response as Key Instance
      * @throws MeilisearchException if an error occurs
      */
     public Key createKey(Key options) throws MeilisearchException {
@@ -296,10 +309,10 @@ public Key createKey(Key options) throws MeilisearchException {
      *
      * @param key String containing the key
      * @param options String containing the options to update
-     * @return Key Instance
-     * @throws Exception if client request causes an error
+     * @return Meilisearch API response as Key Instance
+     * @throws MeilisearchException if an error occurs
      */
-    public Key updateKey(String key, Key options) throws Exception {
+    public Key updateKey(String key, KeyUpdate options) throws MeilisearchException {
         return this.keysHandler.updateKey(key, options);
     }
 

src/main/java/com/meilisearch/sdk/KeysHandler.java

@@ -2,6 +2,8 @@
 
 import com.meilisearch.sdk.exceptions.MeilisearchException;
 import com.meilisearch.sdk.model.Key;
+import com.meilisearch.sdk.model.KeyUpdate;
+import com.meilisearch.sdk.model.KeysQuery;
 import com.meilisearch.sdk.model.Results;
 
 /**
@@ -29,20 +31,29 @@ public class KeysHandler {
      * @throws MeilisearchException if client request causes an error
      */
     Key getKey(String uid) throws MeilisearchException {
-        String urlPath = "/keys/" + uid;
-        return httpClient.get(urlPath, Key.class);
+        return httpClient.get(new KeysQuery().toQuery(uid), Key.class);
     }
 
     /**
      * Retrieves keys from the client
      *
-     * @return List of key instance
+     * @return Results containing a list of Key instance
      * @throws MeilisearchException if client request causes an error
      */
     Results<Key> getKeys() throws MeilisearchException {
         String urlPath = "/keys";
-        Results<Key> result = httpClient.get(urlPath, Results.class, Key.class);
-        return result;
+        return httpClient.get(urlPath, Results.class, Key.class);
+    }
+
+    /**
+     * Retrieves keys from the client
+     *
+     * @param params accept by the keys route
+     * @return Results containing a list of Key instance
+     * @throws MeilisearchException if client request causes an error
+     */
+    Results<Key> getKeys(KeysQuery params) throws MeilisearchException {
+        return httpClient.get(params.toQuery(params), Results.class, Key.class);
     }
 
     /**
@@ -63,11 +74,10 @@ Key createKey(Key options) throws MeilisearchException {
      * @param key String containing the key
      * @param options String containing the options of the key
      * @return Key Instance
-     * @throws Exception if client request causes an error
+     * @throws MeilisearchException if client request causes an error
      */
-    Key updateKey(String key, Key options) throws Exception {
-        String urlPath = "/keys/" + key;
-        return httpClient.patch(urlPath, options, Key.class);
+    Key updateKey(String key, KeyUpdate options) throws MeilisearchException {
+        return httpClient.patch(new KeysQuery().toQuery(key), options, Key.class);
     }
 
     /**
@@ -77,7 +87,6 @@ Key updateKey(String key, Key options) throws Exception {
      * @throws MeilisearchException if client request causes an error
      */
     void deleteKey(String key) throws MeilisearchException {
-        String urlPath = "/keys/" + key;
-        httpClient.delete(urlPath, String.class);
+        httpClient.delete(new KeysQuery().toQuery(key), String.class);
     }
 }

src/main/java/com/meilisearch/sdk/json/GsonJsonHandler.java

@@ -2,6 +2,9 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonNull;
+import com.google.gson.JsonObject;
 import com.google.gson.JsonSyntaxException;
 import com.google.gson.reflect.TypeToken;
 import com.meilisearch.sdk.exceptions.JsonDecodingException;
@@ -26,9 +29,20 @@ public String encode(Object o) throws MeilisearchException {
             return (String) o;
         }
         // TODO: review later
+        // This is a workaround to encode the Key class properly
         if (o != null && o.getClass() == Key.class) {
             GsonBuilder builder = new GsonBuilder();
-            this.gson = builder.serializeNulls().setDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").create();
+            this.gson = builder.setDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").create();
+
+            Key key = (Key) o;
+            if (key.getExpiresAt() == null) {
+                JsonElement jsonElement = gson.toJsonTree(o);
+                JsonObject jsonObject = jsonElement.getAsJsonObject();
+                jsonObject.add("expiresAt", JsonNull.INSTANCE);
+                o = jsonObject;
+                this.gson =
+                        builder.serializeNulls().setDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").create();
+            }
         }
         try {
             return gson.toJson(o);
@@ -52,7 +66,7 @@ public <T> T decode(Object o, Class<?> targetClass, Class<?>... parameters)
                 return gson.<T>fromJson((String) o, targetClass);
             } else {
                 TypeToken<?> parameterized = TypeToken.getParameterized(targetClass, parameters);
-                return gson.fromJson((String) o, parameterized.getType());
+                return gson.<T>fromJson((String) o, parameterized.getType());
             }
         } catch (JsonSyntaxException e) {
             throw new JsonDecodingException(e);

src/main/java/com/meilisearch/sdk/model/Key.java

@@ -12,11 +12,17 @@
  */
 @Getter
 public class Key {
+    @Setter
+    @Accessors(chain = true)
+    protected String name = null;
+
     @Setter
     @Accessors(chain = true)
     protected String description = null;
 
-    protected String key = "";
+    protected String uid = null;
+
+    protected String key = null;
 
     @Setter
     @Accessors(chain = true)

src/main/java/com/meilisearch/sdk/model/KeyUpdate.java

@@ -0,0 +1,23 @@
+package com.meilisearch.sdk.model;
+
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+/**
+ * Data structure for updating a Key
+ *
+ * <p>https://docs.meilisearch.com/reference/api/keys.html
+ */
+@Getter
+public class KeyUpdate {
+    @Setter
+    @Accessors(chain = true)
+    protected String name = null;
+
+    @Setter
+    @Accessors(chain = true)
+    protected String description = null;
+
+    public KeyUpdate() {}
+}

src/main/java/com/meilisearch/sdk/model/KeysQuery.java

@@ -0,0 +1,35 @@
+package com.meilisearch.sdk.model;
+
+import com.meilisearch.sdk.http.URLBuilder;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+/**
+ * Data structure of the query parameters for the keys routes
+ *
+ * <p>https://docs.meilisearch.com/reference/api/keys.html#query-parameters
+ */
+@Setter
+@Getter
+@Accessors(chain = true)
+public class KeysQuery {
+    private int offset = -1;
+    private int limit = -1;
+
+    public KeysQuery() {}
+
+    public String toQuery(String key) {
+        URLBuilder urlb = new URLBuilder();
+        urlb.addSubroute("keys").addSubroute(key);
+        return urlb.getURL();
+    }
+
+    public String toQuery(KeysQuery param) {
+        URLBuilder urlb = new URLBuilder();
+        urlb.addSubroute("keys")
+                .addParameter("limit", param.getLimit())
+                .addParameter("offset", param.getOffset());
+        return urlb.getURL();
+    }
+}