Reduce code redunancy (#29)

Author: jaeyson

CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## major.minor.patch (yyyy.mm.dd)
 
+## 1.0.0 (2025.05.31)
+
+### Changed
+
+* Passing `conn` as part of `opts` when calling a function, as this reduces code duplication. [Issue #26](https://github.com/jaeyson/open_api_typesense/issues/26) [PR #29](https://github.com/jaeyson/open_api_typesense/pull/29)
+
+### Chore
+
+* Bumped dev dependencies
+
 ## 0.7.1 (2025.04.06)
 
 ### Fixed

README.md

@@ -17,6 +17,22 @@ Restful client for Typesense with adherence to Open API spec 3 (formerly Swagger
 [![Hex.pm](https://img.shields.io/hexpm/l/open_api_typesense)](https://hexdocs.pm/open_api_typesense/license.html)
 [![Latest Typesense compatible](https://img.shields.io/badge/Latest%20Typesense%20compatible-v28.0-%230F35BC)](https://typesense.org/docs/28.0/api)
 
+> #### Upgrading to v1 {: .warning}
+>
+> The breaking change here is `conn` is now part of `opts`
+> when calling functions, see example below:
+
+```elixir
+# pre-v1
+Collections.get_collections(conn, opts)
+
+# v1
+Collections.get_collections(conn: conn)
+
+# another way (v1)
+opts = [limit: 1, conn: conn]
+Collections.get_collections(opts)
+```
 ## Installation
 
 If [available in Hex](https://hex.pm/docs/publish), the package can be installed
@@ -25,7 +41,7 @@ by adding `open_api_typesense` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:open_api_typesense, "~> 0.7"}
+    {:open_api_typesense, "~> 1.0"}
 
     # 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"}
@@ -93,7 +109,16 @@ config :open_api_typesense,
   scheme: "https"
 ```
 
-## Using a another HTTP client
+## Using another connection via maps
+
+You might be using a connection that changes dynamically. You can pass it as a map:
+
+```elixir
+custom_conn = %{api_key: "xyz", host: "localhost", port: 8108, scheme: "http"}
+OpenApiTypesense.Health(conn: conn)
+```
+
+## Using another HTTP client
 
 In order to use another HTTP client, OpenApiTypesense has a
 callback function ([Behaviours](https://hexdocs.pm/elixir/typespecs.html#behaviours))

lib/open_api_typesense/client.ex

@@ -11,7 +11,7 @@ defmodule OpenApiTypesense.Client do
   A callback function for custom HTTP client
   """
   @doc since: "0.2.0"
-  @callback request(conn :: map(), params :: keyword()) :: response()
+  @callback request(params :: map()) :: response()
 
   @typedoc since: "0.2.0"
   @type response() ::
@@ -64,15 +64,22 @@ defmodule OpenApiTypesense.Client do
       {:ok, %OpenApiTypesense.HealthStatus{ok: true}}
   """
   @doc since: "0.2.0"
-  @spec request(map() | Connection.t(), map()) :: response()
-  def request(conn, opts) do
+  @spec request(map()) :: response()
+  def request(params) do
+    conn =
+      if params.opts[:conn] do
+        Connection.new(params.opts[:conn])
+      else
+        Connection.new()
+      end
+
     client = Map.get(conn, :client)
 
     if client do
-      client.request(conn, opts)
+      client.request(conn, params)
     else
-      req_client = build_req_client(conn, opts)
-      req_request(req_client, opts)
+      req_client = build_req_client(conn, params)
+      req_request(req_client, params)
     end
   end
 
@@ -113,9 +120,9 @@ defmodule OpenApiTypesense.Client do
   defp encode_body(opts) do
     if opts[:request] do
       [content_type] = opts[:request]
-      parse_content_type(content_type, opts[:body])
+      parse_content_type(content_type, opts[:args][:body])
     else
-      Jason.encode_to_iodata!(opts[:body])
+      Jason.encode_to_iodata!(opts[:args][:body])
     end
   end