incident_api: generalized the code based on DRY

MikaelFangel · Apr 30, 2024 · 0230cf1 · 0230cf1
1 parent dac67fb
commit 0230cf1
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 28 deletions.
diff --git a/lib/incident_api.ex b/lib/incident_api.ex
@@ -1,5 +1,6 @@
 defmodule LogpointApi.IncidentApi do
-  alias LogpointApi.Credential, as: Credential
+  alias LogpointApi.Credential
+  alias LogpointApi.IncidentApi.{Incident, IncidentComment, IncidentCommentData, IncidentIDs, TimeRange}
 
   defmodule TimeRange do
     @derive {Jason.Encoder, only: [:version, :ts_from, :ts_to]}
@@ -42,13 +43,9 @@ defmodule LogpointApi.IncidentApi do
     do: get_incident_information(ip, "/incident_states", credential, time_range)
 
   @spec get_users(String.t(), Credential.t()) :: {:ok, map()} | {:error, String.t()}
-  def get_users(ip, %Credential{} = credential) do
-    params = %{
-      "username" => credential.username,
-      "secret_key" => credential.secret_key
-    }
-
-    make_request(ip, "/get_users", :get, params)
+  def get_users(ip, credential) do
+    payload = make_payload(credential)
+    make_request(ip, "/get_users", :get, payload)
   end
 
   @spec add_comments(String.t(), Credential.t(), IncidentCommentData.t()) ::
@@ -80,37 +77,26 @@ defmodule LogpointApi.IncidentApi do
 
   @spec update_incident_state(String.t(), String.t(), Credential.t(), map()) ::
           {:ok, map()} | {:error, String.t()}
-  defp update_incident_state(ip, path, %Credential{} = credential, request_data) do
-    payload = %{
-      "username" => credential.username,
-      "secret_key" => credential.secret_key,
-      "requestData" => request_data
-    }
-
+  defp update_incident_state(ip, path, credential, request_data) do
+    payload = make_payload(credential, request_data)
     make_request(ip, path, :post, payload)
   end
 
   @spec get_incident_information(String.t(), String.t(), Credential.t(), map()) ::
           {:ok, map()} | {:error, String.t()}
-  defp get_incident_information(ip, path, %Credential{} = credential, request_data) do
-    payload = %{
-      "username" => credential.username,
-      "secret_key" => credential.secret_key,
-      "requestData" => request_data
-    }
-
+  defp get_incident_information(ip, path, credential, request_data) do
+    payload = make_payload(credential, request_data)
     make_request(ip, path, :get, payload)
   end
 
-  @spec make_request(String.t(), String.t(), atom(), map()) :: {:ok, map()} | {:error, String.t()}
+  @spec make_request(String.t(), String.t(), atom(), String.t()) :: {:ok, map()} | {:error, String.t()}
   defp make_request(ip, path, method, payload) do
     url = build_url(ip, path)
     headers = [{"Content-Type", "application/json"}]
-    body = Jason.encode!(payload)
     # On-prem uses self signed certificates and we thus need to disable the verification.
     options = [ssl: [{:verify, :verify_none}]]
 
-    case HTTPoison.request(method, url, body, headers, options) do
+    case HTTPoison.request(method, url, payload, headers, options) do
       {:ok, %HTTPoison.Response{status_code: 200, body: body}} ->
         {:ok, Jason.decode!(body)}
 
@@ -124,4 +110,23 @@ defmodule LogpointApi.IncidentApi do
 
   @spec build_url(String.t(), String.t()) :: String.t()
   defp build_url(ip, path), do: "https://" <> ip <> path
+
+  @spec make_payload(Credential.t(), map()) :: String.t()
+  defp make_payload(%Credential{} = credential, request_data) do
+    %{
+      "username" => credential.username,
+      "secret_key" => credential.secret_key,
+      "requestData" => request_data
+    }
+    |> Jason.encode!()
+  end
+
+  @spec make_payload(Credential.t()) :: String.t()
+  defp make_payload(%Credential{} = credential) do
+    %{
+      "username" => credential.username,
+      "secret_key" => credential.secret_key,
+    }
+    |> Jason.encode!()
+  end
 end
diff --git a/lib/search_api.ex b/lib/search_api.ex
@@ -22,7 +22,8 @@ defmodule LogpointApi.SearchApi do
    - `get_search_result/3` : Retrieves search results for a given search ID.
   """
 
-  alias LogpointApi.Credential, as: Credential
+  alias LogpointApi.Credential
+  alias LogpointApi.SearchApi.{Query, SearchID}
 
   @allowed_types ["user_preference", "loginspects", "logpoint_repos", "devices", "livesearches"]
 
@@ -88,13 +89,13 @@ defmodule LogpointApi.SearchApi do
   @spec build_url(String.t(), String.t()) :: String.t()
   defp build_url(ip, path), do: "https://" <> ip <> path
 
-  @spec get_allowed_data(String.t(), Credential.t(), String.t()) :: {:ok, map()} | {:error, String.t()} 
+  @spec get_allowed_data(String.t(), Credential.t(), String.t()) :: {:ok, map()} | {:error, String.t()}
   defp get_allowed_data(ip, credential, type) when type in @allowed_types do
     payload = build_payload(credential, %{"type" => type})
     make_request(ip, "/getalloweddata", payload)
   end
 
-  @spec get_search_logs(String.t(), Credential.t(), map()) :: {:ok, map()} | {:error, String.t()} 
+  @spec get_search_logs(String.t(), Credential.t(), map()) :: {:ok, map()} | {:error, String.t()}
   defp get_search_logs(ip, credential, request_data) do
     payload = build_payload(credential, %{"requestData" => Jason.encode!(request_data)})
     make_request(ip, "/getsearchlogs", payload)