3 add configurable options (#4)

* Add configurable options

* remove unused function

* update typos

Author: jaeyson

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Continuous Integration (CI)
+name: CI
 
 on:
   push:

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## major.minor.patch (yyyy.mm.dd)
 
+## 0.3.0 (2024.12.15)
+
+### Changed
+
+* HTTP request construction in `OpenApiTypesense.Client` to include `options`.
+
+### Added
+
+* `options` in config `config/config.exs`.
+* `get_options/0` function in `Client` to fetch the `options` configuration.
+* tests for `get_options/0` in `ClientTest`.
+
 ## 0.2.1 (2024.12.15)
 
 ### Changed

README.md

@@ -13,7 +13,6 @@ Restful client for Typesense with adherence to Open API spec 3 (formerly Swagger
 ## TODO
 - Custom Http client adapter (currently [`Req`](https://hexdocs.pm/req))
 
-
 ## Installation
 
 If [available in Hex](https://hex.pm/docs/publish), the package can be installed
@@ -22,7 +21,10 @@ by adding `open_api_typesense` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:open_api_typesense, "~> 0.2"}
+    {:open_api_typesense, "~> 0.3"}
+
+    # Or from GitHub repository, if you want the latest greatest from main branch
+    {:open_api_typesense, git: "https://github.com/jaeyson/open_api_typesense.git"}
   ]
 end
 ```
@@ -31,3 +33,42 @@ Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_do
 and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
 be found at <https://hexdocs.pm/open_api_typesense>.
 
+## Getting started
+
+### Adding credentials
+
+Spin up local Typesense instance
+
+```bash
+docker compose up -d
+
+# check if "peer refreshed" in logs
+docker container logs --follow --tail 50 typesense
+```
+
+```elixir
+# e.g. config/runtime.exs
+if config_env() == :prod do # if you'll use this in prod environment
+  config :open_api_typesense,
+    api_key: "xyz",
+    host: "localhost",
+    port: 8108,
+    scheme: "http",
+    options: %{}
+  ...
+```
+
+> **Note**: The `options` key can be used to pass additional configuration options such as custom Finch instance or receive timeout settings. You can add any options supported by Req here. For more details check [Req documentation](https://hexdocs.pm/req/Req.Steps.html#run_finch/1-request-options).
+
+> **Note**: If you use this for adding tests in your app, you might want to add this in `config/test.exs`:
+
+For Cloud hosted, you can generate and obtain the credentials from cluster instance admin interface:
+
+```elixir
+config :open_api_typesense,
+  api_key: "credential", # Admin API key
+  host: "111222333aaabbbcc-9.x9.typesense.net", # Nodes
+  port: 443,
+  scheme: "https",
+  options: %{}
+```

lib/open_api_typesense.ex

@@ -1,8 +1,3 @@
 defmodule OpenApiTypesense do
   @moduledoc false
-
-  @doc false
-  def count_uniq_atom_keys do
-    nil
-  end
 end

lib/open_api_typesense/client.ex

@@ -28,6 +28,10 @@ defmodule OpenApiTypesense.Client do
     Application.get_env(:open_api_typesense, :port)
   end
 
+  @doc since: "0.3.0"
+  @spec get_options :: map()
+  def get_options, do: Application.get_env(:open_api_typesense, :options, %{})
+
   @doc """
   Returns the Typesense's API key
 
@@ -56,15 +60,13 @@ defmodule OpenApiTypesense.Client do
   - `:query`: Request query params (defaults to `%{}`).
 
   ## Examples
-      iex> alias OpenApiTypesense.Client
-
-      iex> connection = %OpenApiTypesense.Connection{
+      iex> alias OpenApiTypesense.{Client,Connection}
+      iex> connection = %Connection{
       ...>   host: "localhost",
       ...>   api_key: "some_api_key",
       ...>   port: "8108",
       ...>   scheme: "http"
       ...> }
-
       iex> opts = %{
       ...>   args: [],
       ...>   call: {OpenApiTypesense.Health, :health},
@@ -73,13 +75,12 @@ defmodule OpenApiTypesense.Client do
       ...>   response: [{200, {OpenApiTypesense.HealthStatus, :t}}],
       ...>   opts: opts
       ...> }
-
       iex> Client.request(connection, opts)
       {:ok, %OpenApiTypesense.HealthStatus{ok: true}}
   """
   @doc since: "0.2.0"
-  @spec request(Connection.t(), list()) :: response()
-  def request(conn, opts \\ []) do
+  @spec request(Connection.t(), map()) :: response()
+  def request(conn, opts) do
     # Req.Request.append_error_steps and its retry option are used here.
     # options like retry, max_retries, etc. can be found in:
     # https://hexdocs.pm/req/Req.Steps.html#retry/1
@@ -122,6 +123,7 @@ defmodule OpenApiTypesense.Client do
         decode_json: [keys: :atoms]
       ]
       |> Req.new()
+      |> Req.Request.merge_options(Map.to_list(get_options()))
       |> Req.Request.put_header("x-typesense-api-key", api_key())
       |> Req.Request.run_request()
 

mix.exs

@@ -3,7 +3,7 @@ defmodule OpenApiTypesense.MixProject do
 
   @source_url "https://github.com/jaeyson/open_api_typesense"
   @hex_url "https://hexdocs.pm/open_api_typesense"
-  @version "0.2.1"
+  @version "0.3.0"
 
   def project do
     [

mix.lock

@@ -9,7 +9,7 @@
   "hpax": {:hex, :hpax, "1.0.1", "c857057f89e8bd71d97d9042e009df2a42705d6d690d54eca84c8b29af0787b0", [:mix], [], "hexpm", "4e2d5a4f76ae1e3048f35ae7adb1641c36265510a2d4638157fbcb53dda38445"},
   "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
   "makeup": {:hex, :makeup, "1.2.1", "e90ac1c65589ef354378def3ba19d401e739ee7ee06fb47f94c687016e3713d1", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "d36484867b0bae0fea568d10131197a4c2e47056a6fbe84922bf6ba71c8d17ce"},
-  "makeup_elixir": {:hex, :makeup_elixir, "1.0.0", "74bb8348c9b3a51d5c589bf5aebb0466a84b33274150e3b6ece1da45584afc82", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "49159b7d7d999e836bedaf09dcf35ca18b312230cf901b725a64f3f42e407983"},
+  "makeup_elixir": {:hex, :makeup_elixir, "1.0.1", "e928a4f984e795e41e3abd27bfc09f51db16ab8ba1aebdba2b3a575437efafc2", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "7284900d412a3e5cfd97fdaed4f5ed389b8f2b4cb49efc0eb3bd10e2febf9507"},
   "makeup_erlang": {:hex, :makeup_erlang, "1.0.1", "c7f58c120b2b5aa5fd80d540a89fdf866ed42f1f3994e4fe189abebeab610839", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "8a89a1eeccc2d798d6ea15496a6e4870b75e014d1af514b1b71fa33134f57814"},
   "mime": {:hex, :mime, "2.0.6", "8f18486773d9b15f95f4f4f1e39b710045fa1de891fada4516559967276e4dc2", [:mix], [], "hexpm", "c9945363a6b26d747389aac3643f8e0e09d30499a138ad64fe8fd1d13d9b153e"},
   "mint": {:hex, :mint, "1.6.2", "af6d97a4051eee4f05b5500671d47c3a67dac7386045d87a904126fd4bbcea2e", [:mix], [{:castore, "~> 0.1.0 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: true]}, {:hpax, "~> 0.1.1 or ~> 0.2.0 or ~> 1.0", [hex: :hpax, repo: "hexpm", optional: false]}], "hexpm", "5ee441dffc1892f1ae59127f74afe8fd82fda6587794278d924e4d90ea3d63f9"},

test/client_test.exs

@@ -0,0 +1,34 @@
+defmodule ClientTest do
+  use ExUnit.Case, async: true
+
+  alias OpenApiTypesense.Client
+
+  setup do
+    # Backup the original configuration
+    original_config = Application.get_env(:open_api_typesense, :options, %{})
+
+    on_exit(fn ->
+      # Restore the original configuration after each test
+      Application.put_env(:open_api_typesense, :options, original_config)
+    end)
+  end
+
+  describe "get_options/0" do
+    @tag ["27.1": true, "26.0": true, "0.25.2": true]
+    test "returns the configured options" do
+      Application.put_env(:open_api_typesense, :options, %{
+        finch: MyApp.CustomFinch,
+        receive_timeout: 5_000
+      })
+
+      assert Client.get_options() == %{finch: MyApp.CustomFinch, receive_timeout: 5_000}
+    end
+
+    @tag ["27.1": true, "26.0": true, "0.25.2": true]
+    test "returns an empty map if options is not configured" do
+      Application.delete_env(:open_api_typesense, :options)
+
+      assert Client.get_options() == %{}
+    end
+  end
+end